Professional Documents
Culture Documents
GFK-1180K (Base System User Manual)
GFK-1180K (Base System User Manual)
Base System
User's Manual
Warning notices are used in this publication to emphasize that hazardous voltages, currents,
temperatures, or other conditions that could cause personal injury exist in the equipment or
may be associated with its use.
In situations where inattention could cause either personal injury or damage to equipment, a
Warning notice is used.
Caution provides information when careful attention must be taken in order to avoid
damaging results.
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.
GFK-1180K iii
Chapter 19. Configuring Alarm Strings: Explains how to configure alarm strings.
Chapter 20. Configuing Alarms: Explains how to configure alarms.
Chapter 21. Using 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. Configuring the Alarm Printer: Shows you how to configure a printer to record alarm
messages.
Chapter 24. Configuring Roles: Explains how to configure roles.
Chapter 25. Configuring Users: 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 CimView: Explains the features of the graphic screen viewer.
Chapter 30. Using the Point Control Panel: Shows you how to use the Point Control Panel to
display point information.
Chapter 31. Using Measurement Units: Explains measurement units and how to configure them.
Chapter 32. System Utilities: Describes the Show Users and Program Control features of the System
Utilities option.
Chapter 33. 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.
Appendix A. Using Global Parameters: Describes how to use the Global Parameters application and
lists and defines the global parameters for CIMPLICITY.
Appendix B. Using the CIMPLICITY to Windows Server (DDE): Discusses how to use CWSERV
with third-party software such as Microsoft Excel spreadsheets.
Appendix C: Using CIMPLICITY HMI with CIMPLICITY Control: Shows you how to import
variables from a Control folder into points in an HMI project.
Appendix D: Viewing CIMPLICITY Machine Edition Point Data: Describes how CIMPLICITY
HMI displays data collected from CIMPLICITY Machine Edition.
Appendix E. Import/Export Configuration: Documents the Import/Export utility.
GFK-1180K v
Contents
Welcome to CIMPLICITY HMI Plant Edition 1-1
Welcome ................................................................................................................................ 1-1
Distributor Telephone Numbers............................................................................................. 1-1
Customer Support................................................................................................................... 1-2
GFK-1180K Contents-vii
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-9
Enabling the Project Wizard through the New Project Dialog Box ......................... 3-9
Enabling the Project Wizard Though the Workbench............................................ 3-10
Project Shortcut in the Windows Start Menu ....................................................................... 3-11
CIMPLICITY Options ......................................................................................................... 3-12
Opening the CIMPLICITY Options Dialog Box ................................................... 3-12
Setting CIMPLICITY Projects Options ................................................................. 3-12
Setting Startup Options .......................................................................................... 3-15
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
Index i
Welcome
Congratulations for selecting GE Fanuc Automation's CIMPLICITY® HMI Plant Edition
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's–Operation 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.
GFK-1180K 1-1
Customer Support
GE Fanuc takes pride in the high quality of CIMPLICITY HMI software. Great emphasis
has been placed on ensuring the quality of this system throughout development and
testing. However, the tremendous power that the software offers may cause you to
encounter problems or questions for your specific configuration.
If your CIMPLICITY software system is under warranty or is covered by a valid support
contract, you may obtain assistance and report problems to the CIMPLICITY Technical
Support Hotline at one of the following numbers:
USA and Canada (800) GE-FANUC or (800) 433-2682
All others (804) 978-6036
The CIMPLICITY HMI Hotline is available from 8 A.M. to 8 P.M. Eastern Time,
Monday through Friday, except for regularly scheduled USA holidays.
GFK-1180K 2-1
Opening the Workbench
You open the Workbench the same way you open any Windows 98, 2000 and NT
application.
Screens
Points
Objects in
application
Application
Folder
Expand
the tree
Collapse
the tree
Status bar
Fields chosen for display
Files or records
associated with object
Tip: Place the cursor over any object in the Workbench to display a brief description of
what it does.
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.
Click to collapse
the tree.
Click to expand
the tree.
Tree
Detail
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.
CIMPLICITY displays a list of all the existing records or files for the selected icon
when you use either method.
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.
Method 2
A. Place the cursor in the right pane.
B. Click the right mouse button.
C. Select Search on the popup menu.
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.
Points
Ports
Devices
Roles
Misc.
Click a Browse button when it appears at the right of a field. The appropriate
browser will open.
A Windows 98, 2000 and NT Explorer window opens and displays the open
project’s directory.
4. Use the Windows 98, 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 Workbench’s list.
5. Place the Windows 98, 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.
Method 2
A. Click the right mouse button in the right pane.
C. Select Field Chooser from the popup menu.
Popup for Points
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.
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
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.
Project name on
Workbench title bar.
3 Click OK.
4. Click OK.
Result: The project will appear on the Start menu in the folder you selected.
§ 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
To do a configuration update:
Method 1
1. Click Project on the Workbench menu bar.
Project Menu
Important: There are some configuration procedures that have restricted functionality
in Dynamic Update mode. They are:
To do dynamic configuration:
Method 1
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.
Choose the
menu item For To Display
Edit
Screens CimEdit screen
Properties
Points Properties – Point dialog box
Devices Device dialog box
Ports Port Properties dialog box
Users User properties dialog box
Roles Roles dialog box
Resources Resource Definition dialog box
Measurement Units Measurement Unit Configuration
window
Event Editor Event Editor window
Alarm Sound Manager Alarm Sound Manager dialog box
Script Script window
Open
Project status log Notepad
System status log Microsoft Excel
Database Logger Microsoft Access
Action Calendar Action Calendar
Popups
2. Double click it or use any of the other methods available to open a runtime
window. See page 2-33 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.
Quick Trend
CimView
To view runtime data by dragging and dropping points into the Point
Control Panel:
1. Select Points in the Workbench’s 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
Project Opened
You can open a CIMPLICITY project through:
§ The CIMPLICITY\HMI Start Menu on the Windows Taskbar or
§ An open Workbench.
GFK-1180K 3-1
Procedure to Open a Project through the Workbench
Use the Project Properties dialog box to choose or change General properties and Options
for a project.
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.
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.
2
2 An error message
appears if the user's
role does not have
Workbench privileges.
The Settings tab of the Project Properties dialog box enables you to enter general settings
for each application on the displayed list of applications.
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
Method 3
Press Ctrl+W on the keyboard.
Result: The CIMPLICITY Project Wizard opens when you use any method.
4. Click OK.
Result: The project will appear on the Start menu in the folder you selected.
.
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.
The local
computer name
displays.
1 Click Start
Viewer.
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.
Note: To delete a project from the list, select the project, and click Delete. The project
is removed from the list.
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.
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.
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.
Important: The /rstart and /rstop options only work on Windows NT/2000.
About Points
CIMPLICITY HMI collects or calculates point data that 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 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 and/or have assigned security levels equal to or below the role's security
level. See "Setpoint Security" page 4-5 in this chapter for more information.
GFK-1180K 4-1
Categorizing Points
CIMPLICITY HMI provides you with the tools to configure any point to exactly your
specifications. Even though there are several options during configuration, your starting
choices for any given point are very simple.
The point value:
§ Comes from one of two Point (Source) Types.
§ Is classified as one of three Point Classes.
Point 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.
1
2
3
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.
.
1. Connect a device to a server.
OPERATOR INTERFACE
F1 F2
BATT. M SG .
F1
F2
ESC ^ v SW1 SW 2
RUN I O SW 5 SW 6
STO P
SET C R SW 7 SW 8
7 8 9
ABC DEF G HI SW 9 SW 10
4 5 6
JKL M NO PQ R SW 1 1 SW 12
1 2 3
STU VWX YZ-
SW13 SW14
0 ENTER O N / O FF
+/
IBM Compatible
4. Configure a
device point.
GFK-1180J 5-1
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.
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
installation CD to add the protocol.
3. Open the New Device dialog box. Two of the several methods are:
Method 1–Using the mouse
Double click the left mouse button.
Method 2–Using the keyboard
Click Ctrl+N on the keyboard.
The New Device dialog box opens.
Recently selected
ports.
1. (If you need to create a port protocol) Click the Popup menu button to the
right of the Port field.
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.
Protocol tab
depends on specific
protocol.
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.
5. Click OK.
Result: A filled in New Device dialog box appears.
1. Click OK when the New Device dialog box has the device and port filled in.
The Device dialog box appears.
Device Proeprties Dialog Box: S90 Ethernet Example
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.
GFK-1180K 6-1
New Device Points
When you create a new device point you select the:
§ Point type
§ Device for the point
§ Classification of the point
Note: Values read from or written to a device point will be forced into the specified type.
Example
Reading an SINT point value, which is 8-bits, from a 16-bit register will truncate the
high order byte, and the sign will not be maintained.
Writing an INT point, which is 16-bits, to an 8-bit register will do the same.
§ DINT
§ INT
§ REAL Array= Check to prohibit
§ SINT More than 1 setpoint use
§ UDINT
§ UINT
§ USINT
§ 3D_BCD
§ 4D_BCD
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.
§ BOOL
§ BYTE
§ WORD Array= Check to prohibit
§ DWORD More than 1 setpoint use
§ STRING
§ STRING_20
§ STRING_8 Array= Check to prohibit
§ STRING_80 More than 1 setpoint use
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.
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).
Availability depends on
protocol:
§ On Change
§ On Scan
§ On Demand On Scan
§ On Demand On Change
§ Unsolicited
§ Poll Once
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.
Example
A digital point is located in the third (3rd) 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 Data–if the address you enter is for a device point.
B. Diagnostic Data–if the address you enter is for a diagnostic point
See "Entries for Diagnostic Points Used with Devices".
C. Ethernet Global Data–if the address you enter is for Ethernet global 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.
Entry Choices
For UDINT
$TRANSMISSIONS
$RESPONSES
$FAILURES
$RETRIES
For BOOL
$DEVICE_DOWN
$DEVICE_UP
Note: Standard addressing is very rarely used. However, if it is the Addressing box
changes to the Domain Address box.
Note: Use the following values to configure diagnostic data for devices with standard
addressing:
Data Domain
Description Type Domain Type 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
To put the General tab of the Point Properties dialog box in advanced
mode:
Click Advanced on the basic General tab. When the tab is in advanced view, the
Basic button displays.
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.
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
Max Duration The amount of most recent time to be saved. Select one of
the following:
Seconds
Minutes
Hours
Days
Max Count The number of n values to be saved
You may select either option, or both. If you select both, the Max Count takes
precedence over Max Duration in determining the number of values saved in
the buffer..
Point buffering lets you allocate a buffer for a point and save a number of the
most recent values. This feature is currently being supported only for the
Trending option.
Example:
Point ABC is scanned every 5 seconds
If you define a:
Max Duration of 1 minute, the buffer contains the 12 most recent values
for ABC at any given time.
Max Count of 10, the buffer contains the 10 most recent values (that is, the
values for the last 50 seconds).
Max Duration and Max Count, the buffer contains the 10 most recent
values.
1. Click the Browse button to the right of the Attribute Set field.
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.
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.
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.
2. Click Ok or Apply.
Result: When point level setpoint security is enabled a project user can set the
point only if the user's assigned role has a corresponding level that is equal to or
higher than the point level.
Tip: Enable point level setpoint security in the Point Setup dialog box.
To open the Point Setup dialog box:
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
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
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 point’s
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.
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.
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.
A1:
110
105
100
103 100 104 105 105 107 110 105 102 104 106
D1:
0 1 1 0 0 1 1 0 1 0 0
Time: 0 3 6 9 12 15 18 21 24 27 30
= A1 value is read.
A1:
110
105
100
100 105 107 105 102 104
D1:
0 1 1 0 0 1 1 0 1 0 0
Time: 0 3 6 9 12 15 18 21 24 27 30
= A1 value is read.
In other words, CIMPLICITY reads A1 at the 3, 9, 15, 21, 24 and 27 second marks
because the value of D1 changed at those times. Note that any transitions that occur
between scans (such as those between the 15 and 18 second marks) do not count.
A1:
110
105
100
100 104 107 110 102
D1:
0 1 1 0 0 1 1 0 1 0 0
Time: 0 3 6 9 12 15 18 21 24 27 30
= A1 value is read.
In other words, CIMPLICITY 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: Because the trigger point in this example is Boolean, Greater than 0 behaves the
same as specifying Equal to 1.
At run-time, PLC1 will only be updated while the point PLC1_READY is equal to 1.
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.
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.
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.
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 Pop-up Menu button to the right of the Unit field.
2. Select New.
The New Measurement dialog box opens.
Linear Conversion
When you use linear conversion, you specify base and converted values that
CIMPLICITY HMI uses to calculate runtime conversions..
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.
where:
EU value = the Engineering Units value
Custom Conversion
Custom conversion provides you with the ability to specify specific forward and
backward conversion expressions.
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.
3. Click OK.
A Point Enumeration dialog box opens.
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.
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.
Important: The values that you enter in the text field are case sensitive. Anyone
working with those values must enter them exactly as configured.
4. Click the Browser button to the right of the Point enumeration field.
7. Click OK.
Result: The point is now an enumerated point.
See "Using the Point Control Panel" in this manual for details about the Point
Control Panel.
See the CimEdit Operation Manual GFK-1396 for details about configuring color
animation.
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-1180K 7-1
New Virtual Points
When you create a new virtual point you select the:
§ Point type
§ Classification of the point
M DINT
M INT
Array= Check to prohibit
M REAL
More than 1 setpoint use
M SINT
M UDINT
M UINT
M USINT
M DINT
M INT
M REAL
M SINT
M UDINT
BOOL
BYTE
WORD Array= Check to prohibit
DWORD More than 1 setpoint use
Text Points
General Tab–Basic View–Text Point
STRING
STRING_20
STRING_8 Array= Check to prohibit
STRING_80 More than 1 setpoint use
Note: You specify an array in the Point Properties dialog box, General tab, Element
field.
1 = Single Point
Important: Array points are not supported by all CIMPLICITY software functions.
Support for array points is as follows:
None
Initialized
Saved Analog point
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.
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.
Recommended:
De-select after configuration
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
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.
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
1. Click the Browse button to the right of the Attribute Set field.
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.
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.
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.
2. Click Ok or Apply.
Result: When point level setpoint security is enabled a project user can set the
point only if the user's assigned role has a corresponding level that is equal to or
higher than the point level.
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.
Selections (and associated entries) provide criteria for virtual point updates.
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.
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.
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.
Expression
dialog
Point menu
Point browser
menu
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'
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.
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 formula’s calculation:
999+(1000 + 1) - 999 + 20 = 1022
Point browser
menu
If you do not specify a Rollover value, the size of the data type for the Delta
Accum point determines the default Rollover value.
Note: If the source expression is a floating or Boolean point, rollover is not applied.
Expression
dialog
Point menu
Point browser
menu
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.
Expression
dialog
Point menu
Point browser
menu
Expression
dialog
Point menu
Point browser
menu
Note: When a
Expression
dialog
Point menu
Point browser
menu
Expression
dialog
Point menu
Point browser
menu
Expression
dialog
Point menu
Point browser
menu
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 The Current
w/Override Point value of the The Equation w/Override
Value is Expression is 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
Point browser
menu
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)
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.
Point browser
menu
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:
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.
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.
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
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.
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>.
IF…ELSE 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.
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.
Note: The IF…ELSE statement is not available from the operation keys. However, you
can enter it manually.
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)
GFK-1180K 8-1
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.
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.
Note: For integer point types, Decimal is the only format type.
Guide for enabling analog display configuration: When you configure an object
that uses the point in CimView, you have to enable the Justification and Width
configuration in CimEdit. You do this on the Text tab of the Object Properties dialog box
in CimEdit, in the Display Format field. See "CIMPLICITY HMI CimEdit Manual"
GFK-1396 for more information.
Example of Analog Point Display
1254387
Important: Make sure the display limits are within range limits that you set. See
"Configuring Range Limits" in this chapter.
Exclude
meaningless data.
Values below the low range limit and above the high range limit will display as
the point unavailable value.
Example
A PLC gives raw data in counts from 0 to 1000.
The raw data represents temperatures between -500 °C and +500 °C.
Values above 200 °C or below -200 °C are considered to be out of range.
If a user enters a value below the low setpoint limit or above the high setpoint limit, the
value will not be accepted.
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.
Boolean point
A detailed alarm definition can be entered or changed and be given an assigned Alarm
Class and string index.
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 folder.
Alarm Definition
You can configure a basic I/O alarm message in the Alarm tab’s 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.
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.
2 The associated
text appears
as the Alarm
Limits
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
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.
3
Blink colors
1
4
2
Beep
specifications
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.
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.
Each time the point's value is updated, its current value is compared with the
alarm values. An alarm is generated when the point's value transitions from one
Alarm State to another.
The transitions are:
State Description
Alarm High Point value ≥ Alarm High value.
Warning High Alarm High value > Point value ≥ Warning High
value
Normal Warning High value > Point value > Warning
Low value
Warning Low Warning Low value ≥ Point value > Alarm Low
value
Alarm Low Point value ≤ Alarm Low value
If the point is in normal state, 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.
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.
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.
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.
2. Select Rate of Change in the Alarm Type field on the advanced Limits tab.
Rate of Change
value is ...
Alarm Limit Limit Value 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
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.
Note: Delay alarm is not available when Rate of Change criteria is selected.
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.
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.
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.
Result: Users assigned the selected role can now view alarms generated by the
point.
Result: Users assigned the selected role can no longer view alarms generated by
the point.
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.
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.
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.
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.
GFK-1180K 9-1
Method 2
A. Place the cursor in the right pane.
B. Click the right mouse button.
C. Select AutoFill from the popup menu if there is no check mark on its left
side.
CIMPLICITY HMI displays a list of all the existing points when you use either
method.
Note: Points with a $ as the first character in the name are system points and cannot be
changed or removed.
Method 3
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.
Display
filters.
Double-click
to select.
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.
Popup
Method 3
Fields that will not display Fields that will display Moves field further
right in the pane
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.
7. Use the Move Up and Move Down buttons change a selected field’s place in
the list.
Move on the list Moves the field’s column to the:
Up Left of the fields beneath it
Down Right of the field’s above it
8. Click OK. The fields display from left to right in the order you specified.
Note: The Remove button will be disabled if the field is required. The Move Down or
Move Up button will be disabled if a field that will be affected by the move has to
appear in the furthest left position.
GFK-1180K 10-1
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.
Example
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.
Popup menu
Keyboard
Ctrl+N
3. Click the Popup button to the right of the Attribute Set field.
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.
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.
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
Base System User's Manual (GFK-1180).
.
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).
Popup menu
Properties button
Keyboard
Alt+Enter
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.
The Attribute Set dialog box associated with the selected attribute set opens.
Continue in the open Attribute Set dialog box
Point
expanded.
Tree under
point.
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
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
1–The point is in an alarm state.
0–The point is not in an alarm state
QUALITY.DISABLE_WRITE (Attribute)
Associated Point Type Device or Virtual
Access Write–for 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.
1–Writing is disabled.
0–Writing 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.
1–The point is available.
0–The point is not available.
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
$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).
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.
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_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
Note: If the value in the Hi-2 field is
0: ALARM_HIGH is 0.
Empty: ALARM_HIGH is Empty.
ALARM_LOW
Associated Point Type All
Value Type 10 characters
Access Read only
CIMPLICITY Field Name Alarm Low
Description Low alarm limit
Note: If the value in the Low-2 field is
0: ALARM_LOW is 0.
Empty: ALARM_LOW is Empty.
ALARM_LOW_N
Associated Point Type All
Value Type REAL
Access Read only
CIMPLICITY Field Name Alarm Low
Description Low alarm limit
Note: If the value in the Low-2 field is
0: ALARM_LOW_N is 0.
Empty: ALARM_LOW_N is 0.
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.
Note: If the value in the Analog
Deadband field is
0: ANALOG_DEADBAND is 0.
Empty: ANALOG_DEADBAND is Empty.
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.
Note: If the value in the Analog
Deadband field is
0: ANALOG_DEADBAND_N is 0.
Empty: ANALOG_DEABAND_N is 0.
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
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_N
Associated Point Type All
Value Type REAL
Access Read only
CIMPLICITY Field Name Alarm Deadband
Description Tolerance around alarm limits.
Note: If the value in the Alarm Deadband
field is
0: DEADBAND_N is 0.
Empty: DEADBAND_N is 0.
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
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.
Note: If the value in the Disp. Limit (hi)
field is
0: DISPLAY_LIM_HIGH is 0.
Empty: DISPLAY_LIM_HIGH is Empty.
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.
Note: If the value in the Disp. Limit (hi)
field is
0: DISPLAY_LIM_HIGH_N is 0.
Empty: DISPLAY_LIM_HIGH_N is 0.
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.
Note: If the value in the Disp. Limit (low)
field is
0: DISPLAY_LIM_LOW_N is 0.
Empty: DISPLAY_LIM_LOW_N is 0.
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_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_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.
LEVEL
Associated Point Type All point types
Value Type Integer
Access Read only
CIMPLICITY Field Name Level
Description Role security level value that was entered
for the selected point in its Point Properties
dialog box.
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.
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_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.
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_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.
Note: If the value in the Range high field
is
0: RANGE_HIGH_N is 0.
Empty: RANGE_HIGH_N is 0.
RANGE_LOW
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_VALUE
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.
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.
Note: If the value in the Setpoint high
field is
0: SETPOINT_HIGH is 0.
Empty: SETPOINT_HIGH is Empty.
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 value in the Setpoint low field
is
0: SETPOINT_LOW is 0.
Empty: SETPOINT_LOW is Empty.
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 value in the Setpoint low field
is
0: SETPOINT_LOW_N is 0.
Empty: SETPOINT_LOW_N is 0.
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
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
Note: If the value in the Warning High
field is
0: WARNING_HIGH is 0.
Empty: WARNING_HIGH is Empty.
WARNING_HIGH_N
Associated Point Type All
Value Type Real
Access Read only
CIMPLICITY Field Name Warning High
Description High warning limit
Note: If the value in the Warning High
field is
0: WARNING_HIGH_N is 0.
Empty: WARNING_HIGH_N is 0.
WARNING_LOW_N
Associated Point Type All
Value Type REAL
Access Read only
CIMPLICITY Field Name Warning Low
Description High warning limit
Note: If the value in the Warning Low
field is
0: WARNING_LOW_N is 0.
Empty: WARNING_LOW_N is 0.
Note: A custom help file can be created with third party tools and
also associated with the class.
GFK-1180K 11-1
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 four 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 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-79 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.
1. A class includes the tools to create a template that incorporates a wide variety of
CIMPLICITY features.
Class
CIMPLICITY
Numeric
String Exp.=String Attributes
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.
End of example.
End of example.
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-46.
Step 6. Configure class actions. See page 11-50.
Step 7. Configure class events. See page 11-57.
Step 8. Create a class CimEdit screen. See page 11-64.
Step 9. Create a class help file. See page 11-77.
Step 10. Export or import a class. See page 11-78.
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
1
Class
§ Multiple processing
tanks.
§ Identical data to be
collected from
processing tanks.
§ Identical data
calculations.
§ Consistent PLC layout.
End of example.
4
1 1 Level.
2 Average input flow rate.
3 Average output flow rate.
4 Average temperature.
2 3
End of example.
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.
PLC Addresses Mapped in Two Contiguous Blocks
1. Level %R100
4. Temperature %R103
2 3 %R104
5. Level
Block 1: PLC
9 10 6. Input flow rate %R105 Addressing
8. Temperature %R107
5
8
9. Input valve %Q0
End of example.
4
1 1 Alarm High/Low.
2 Average input flow rate.
3 Average output flow rate.
4 Average temperature.
2 3
Press
Ctrl+N.
The New Class dialog box opens using any of the above methods.
§ 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.
Note: CIMPLICITY also provides numeric data item attributes that can be used for
numeric expressions. See page 11-36 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
CIMPLICITY
Custom String Numeric
Class
Attributes Expressions Expressions
Attributes
CimEdit Screen
CIMPLICITY
String Exp.=String Numeric
Expressions Attributes
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.
Note: You can configure both CIMPLICITY and custom class attributes. CIMPLICITY
attribute features that cannot be modified display in read-only fields.
CIMPLICITY
attributes
begin with $.
Custom
attributes.
Open a New
Attribute dialog
box.
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 an object
designer when creating an object from the class.
Read-only for
CIMPLICITY
class attributes.
1 Class
Enter and
define an
attribute value
in the Attribute
dialog box.
2 Object
End of example.
Task 4. Configure the attribute's field that displays in the Object dialog 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
Alarm Class
Resource
Device
Role
Point
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.
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.
1 Class
$DEVICE_ID
(CIMPLICITY Attribute)
Attribute definition
(previous task).
2 Object
Field for
$DEVICE_ID
Attribute
End of example.
Class
CIMPLICITY
Custom String Numeric
Class
Attributes Expressions Expressions
Attributes
CimEdit Screen
CIMPLICITY
Numeric
String Exp.=String
Attributes
Expressions
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-32.
3C. Numeric expressions in data item fields. See page 11-36.
3D. Address adjustment expressions. See page 11-41.
1 Class
AVERAGE_INFLOW
Data item
2 Object
A
AVERAGE_INFLOW
Point
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:
§ Just-in-Time device point type and
§ Delay-Load device point type.
See page 11-44 for details.
Point for
object will be
as selected.
Note: You can also duplicate an existing data item and modify it.
Data Item Dialog Box: Device Analog Point Example Unique for data items.
Class
CIMPLICITY
Custom String Numeric
Class
Attributes Expressions Expressions
Attributes
CimEdit Screen
CIMPLICITY
Numeric
String Exp.=String Attributes
Expressions
1 Class
A Create a class
attributte if it
doesn't
currently exist..
A
B Enter the
attribute in a
Data Item field
that allows
string
expressions.
End of example.
Class
CIMPLICITY
Custom String Numeric
Class
Attributes Expressions Expressions
Attributes
CimEdit Screen
CIMPLICITY CIMPLICITY
String Exp.=String Variables Numeric
Expressions Attributes
1 Class
A Create a class
attributte if it
doesn't
currently exist..
A
B Enter the
attribute in a
Data Item field
that allows
string
expressions.
End of example.
Class
CIMPLICITY
Custom String Numeric
Class
Attributes Expressions Expressions
Attributes
CimEdit Screen
CIMPLICITY
Numeric
String Exp.=String Attributes
Expressions
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.
The Expression dialog box opens.
Configured Expression Dialog Box: GefTank Example
1 Create a New
Expression
B Select a
CIMPLICITY
numeric attribute A
to create a new
expression.
3 Configure
the
Expression
A
A Class attribute
options for the
expression
operands come
from the
Attributes tab in B
the Class dialog
box.
B Expression
operands can
be class
attributes or B
numbers.
C The
CIMPLICITY
numeric
attribute
appears in the C
point's
configured
expression list.
End of example.
4. Temperature %R103 3
2 3 %R104 4
5. Level
Block 1: PLC
9 10 6. Input flow rate %R105 5 Addressing
8. Temperature %R107 7
5
8
9. Input valve %Q0
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.
Example
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.
Example
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.
Class
5
Scripts Actions Events
Attributes Data Items
String String
Exp. Exp.
CIMPLICITY
Custom String Numeric
Class
Attributes Expressions Expressions
Attributes
CimEdit Screen
CIMPLICITY
String Exp.=String Numeric
Expressions Attributes
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-48.
Task 2. Write a class script through the Scripts tab. See page 11–49.
1 Class
Create a script in the
CIMPLICITY Program
Editor through the
Class dialog box. A
2 Class/Object
The script is
associated with the
class in the Scripts
folder. B
End of example.
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.
Open a New
Script Name
dialog box.
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.
Class
6
Scripts Actions Events
Attributes Data Items
String String
Exp. Exp.
CIMPLICITY
Custom String Numeric
Class
Attributes Expressions Expressions
Attributes CimEdit Screen
CIMPLICITY
String Exp.=String Numeric
Expressions Attributes
1 Class
A Open an
Action dialog
box through
the Class
dialog box.
B Configure the
action.
A
A
B
End of example.
3. Click OK.
The New Action dialog box opens.
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.
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.
Class
7
Scripts Actions Events
Attributes Data Items
String String
Exp. Exp.
CIMPLICITY
Custom String Numeric
Class
Attributes Expressions Expressions
Attributes CimEdit Screen
CIMPLICITY
String Exp.=String Numeric
Expressions Attributes
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-59.
Task 2. Configure class events. See page 11-60.
1 Class
A Open an Event
dialog box
through the
Class dialog
box.
B Configure the
event.
End of example.
Note: You can also duplicate an existing event and modify it.
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).
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.
Class
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:
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.
Tip: Configure the other Before you configure a Class CimEdit screen, configure the
Text
Trend ActiveX
Tank group
object from the
Object Explorer
Text
End of example.
Selecting
objects in
CimEdit.
Object
group
1 Enter an
Object name.
2 Click Apply.
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-32 for details about
$OBJECT.
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.
B Object
The name displays
on the Class Object
tab in the object's
Properties dialog
box.
2 Object Name
A Class
Enter $OBJECT on
the Variables tab in
the source object's
Properties dialog A
box.
B Object
The object name
displays on the
Variables tab in the
object's Properties
dialog box.
End of example.
Container toolbar
1 Class
A Apply class
attributes and data
items to CimEdit
object expression
fields in the source
Properties dialog
box.
A
2 Object
Configuration is:
B Not visible in the
class object
dialog box.
C Controls the
CimView display.
B
C
End of example.
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.
1 Class
A Configure A
objects on
class CimEdit
screen.
Object Name:
Output Valve
Object Name:
Object
B Select Output
Valve as the B
default graphic.
A The default
CimEdit object
appears when
a class object
is dragged to a
new screen. A
B Object
designers
can select a
different
graphic on B
the Class
Object tab.
End of example.
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.
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.
Class Scripts
Configuration
Data Items Actions
Attributes Events
.soc File
.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.
Class Scripts
Configuration
Data Items Actions
Attributes Events
.soc File
.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.
Although class object features behave the same as their non-class counterparts,
CIMPLICITY makes it easy for the object designer (or any project designer) to locate
features for any class object. CIMPLICITY attaches the object name to the front of the
feature name.
GFK-1180K 12-1
Example–Parts of a Class Object Point Name
Two points that display in the Workbench Points folder are:
Tank_1.TANK_LEVEL
Tank_2.TANK_LEVEL
Where
Tank_1 is a class object and
Important: Before you can configure a class object, a class must be created. If the class
exists, but is not in the current project, you simply need to import it into the project.
Note: The exceptions to the rule are data items that have the Just-in-Time (JIT) option
checked: JIT points are not created until requested by an application.
See page 12-5 for details about importing a class into a project.
See "Configuring Point Classes" for information and instructions about creating a class
and about Just-in-Time points.
Result: The class appears in the Class folder. Scripts that have been written for the
class appear in the Scripts folder.
Press
Ctrl+N.
The New Object dialog box displays when you use any of the above methods.
Note: If a class must be created, click and select New from the popup menu.
See the "Configuring Classes" chapter in this manual for details about creating
a class.
4. Click OK.
Result: The Object properties dialog box displays.
Alarm Class
Resource
Device
Role
Point
User
Port
Important: You will not be able to complete a tab's configuration until you fill in all of
the required fields. If you try, an error message appears telling you that a value for an
attribute is required. This message continues to appear when you attempt to exit the
dialog box until all required fields are filled in.
4
3
Note: CIMPLICITY puts scripts in the Scripts folder when written during class
configuration.
End of example.
Selected class
object graphic
(read/write).
Tip: Click the Browser button to the right of the Object ID field to
display a list of all of the objects in the class.
B. (Optional) Select any class graphic in the Graphic Name field if you want
to use a class graphic that is different from the default.
The Graphic Name field contains a list of all of the graphics that have
been developed for the class. Any graphic can potentially be applied to any
object in the class.
8. Click OK.
Result: The graphic will adhere to your specifications as follows:
1. During runtime the graphic will represent the values of the selected class
object.
2. The graphic will change to the graphic you selected, if it is different from
the default, as soon as you close the Properties - Class Object dialog box.
End of example.
GFK-1180K 13-1
$ALARM.ACKED
Point Type Server Point
Data Type UDINT
Access Read only
Description Total Alarms acknowledged
$ALARM.ACTIVE
Point Type Server Point
Data Type UDINT
Access Read only
Description Total active alarm count
$ALARM.TOTAL
Point Type Server Point
Data Type UDINT
Access Read only
Description Total alarm count
$ALARM.UNACKED
Point Type Server Point
Data Type UDINT
Access Read only
Description Total alarms unacknowledged
$LOCAL.COMPUTER
Point Type Local Point
Data Type STRING (15)
Access Read only
Description Local computer name
$LOCAL.DATE.DAY
Point Type Local Point
Data Type USINT
Access Read only
Description Current day in the month (1-31)
$LOCAL.DATE.DAYOFWEEK
Point Type Local Point
Data Type USINT
Access Read only
Description Current day in the week (1-7); 1=Sunday
$LOCAL.DATE.DAYOFYEAR
Point Type Local Point
Data Type UINT
Access Read only
Description Current day in the year (1-366)
$LOCAL.DATE.HOUR
Point Type Local Point
Data Type USINT
Access Read only
Description Current hour in the day (0-23)
$LOCAL.DATE.HOUR12
Point Type Local Point
Data Type USINT
Access Read only
Description Current hour in the day (1-12)
$LOCAL.DATE.MINUTE
Point Type Local Point
Data Type USINT
Access Read only
Description Minutes past the hour (0-59)
$LOCAL.DATE.SECOND
Point Type Local Point
Data Type USINT
Access Read only
Description Second past the minute (0-59)
$LOCAL.DATE.SECONDOFDAY
Point Type Local Point
Data Type UDINT
Access Read only
Description Second past midnight (0-86399)
$LOCAL.DATE.WEEK
Point Type Local Point
Data Type USINT
Access Read only
Description Current week in the year (1-52)
$LOCAL.DATE.YEAR
Point Type Local Point
Data Type UINT
Access Read only
Description Current year (1970-2039)
$LOCAL.DATETIME
Point Type Local Point
Data Type UDINT
Access Read only
Description Local date and time in seconds from 1/1/1970
$LOCAL.WINUSER
Point Type Local Point
Data Type STRING (20)
Access Read only
Description Local Windows user name
$PROJECT.AVAILABLE
Point Type Local Point
Data Type BOOL
Access Read only
Description Project availability
0=Not Available
1=Available
$PROJECT.COMPUTER
Point Type Server Point
Data Type STRING (15)
Access Read only
Description Project computer name
$PROJECT.DATE.AMPM
Point Type Server Point
Data Type BOOL
Access Read only
Description 0=AM; 1=PM
$PROJECT.DATE.DAY
Point Type Server Point
Data Type USINT
Access Read only
Description Current day in the month (1-31)
$PROJECT.DATE.DAYOFWEEK
Point Type Server Point
Data Type USINT
Access Read only
Description Current day in the week (1-7); 1=Sunday
$PROJECT.DATE.HOUR
Point Type Server Point
Data Type USINT
Access Read only
Description Current hour in the day (0-23)
$PROJECT.DATE.HOUR12
Point Type Server Point
Data Type USINT
Access Read only
Description Current hour in the day (1-12)
$PROJECT.DATE.MINUTE
Point Type Server Point
Data Type USINT
Access Read only
Description Minutes past the hour (0-59)
$PROJECT.DATE.MONTH
Point Type Server Point
Data Type USINT
Access Read only
Description Current month (1-12); 1=January
$PROJECT.DATE.SECOND
Point Type Server Point
Data Type USINT
Access Read only
Description Second past the minute (0-59)
$PROJECT.DATE.SECONDOFFDAY
Point Type Server Point
Data Type UDINT
Access Read only
Description Second past midnight (0-86399)
$PROJECT.DATE.YEAR
Point Type Server Point
Data Type UINT
Access Read only
Description Current year (1970-2039)
$PROJECT.DATETIME
Point Type Server Point
Data Type UDINT
Access Read only
Description Server date and time in seconds from 1/1/1970
$PROJECT.DEVICES
Point Type Server Point
Data Type UDINT
Access Read only
Description Number of devices online
$PROJECT.LOGGEDIN
Point Type Local Point
Data Type BOOL
Access Read/Write
Description Login status
0=Logged out || !$PROJECT.AVAILABLE
1=Logged in && $PROJECT.AVAILABLE
$PROJECT.USERS
Point Type Server Point
Data Type UDINT
Access Read only
Description Number of users
$ROLE.LEVEL
Point Type Server Point
Data Type DINT
Access Read only
Description Role's security level.
$USER
Point Type Server Point
Data Type String (32)
Access Read only
Description User identification.
$USER.ALARMS
Point Type Local Point
Data Type UDINT
Access Read only
Description Alarm count by user
GFK-1180K 14-1
Opening the Point Cross Reference Window
The Point Cross Reference window has its own icon in the
Workbench.
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.
Selected substystems
selected
List of points
Text only
Full view
Tree view
Note: A list of points displays in the left pane for all views.
Valid point
Point ID
type
Point count
To re-sort the lists in the left pane of the Point Cross Reference window:
Click the title bar on top of the list that you want as the primary sort.
The list you select will be sorted in ascending order. Information on the other two lists
will stay with the associated items in the primary sort.
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 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 Type–Whether 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 Count–Numeric order based on how many times
the point appears in the PtXRef database
Point ID–Alphabetical 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.
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.
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 Tree view Subsystem Point use
Note: If the object you select has no properties, that selection will not be available when
you click the right mouse button.
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.
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.
Selected substystems
selected
1. Click the Open button– –on the Point Cross Reference toolbar.
An Open dialog box appears.
2. Select the project you want to open.
3. Build the PtXRef database, if it does not exist.
Method 2
1. 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.
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.
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.
GFK-1180K 15-1
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
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.
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.
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 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.
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.
GFK-1180K 16-1
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.
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.
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.
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.
GFK-1180K 17-1
Port Configuration
The Workbench displays a project's existing ports in the right pane.
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.
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.
GFK-1180K 18-1
Alarm Class Configuration
Step 1. Open the Alarm Class Configuration dialog box.
Step 2. Enter alarm class specifications.
Step 3. Configure sound for an alarm class.
New alarm
class being
configured.
(read-write)
Existing alarm
class being
modified.
(write only)
Task 2. Select colors and blink rates for the alarm states:
1. Select, for each alarm state, a :
§ Foreground (font) color for each alarm state and
§ Different color for the Background for alarms to which the class is
assigned.
Alarm states to which you can assign colors are:
§ Normal State
§ Alarm State
§ Acknowledged State
Note: Default colors are White for the text and Black for the background.
2. Enter a Blink rate for each alarm state in which you want the alarm to blink.
Value Rate/Second
0 Blinking does not occur.
1 1/10th or 10 times per second
2 2/10th or 5 times per second
20 20/10th or 1/2 time per second (1 per 2 seconds)
N 1/10th*N per second.
3. Enter a foreground and background color that will alternate with the other
foreground and background colors selected for that state.
Result: The primary colors will:
§ Display per your alarm state specifications.
§ Alternate with the blink colors at the specified rate to create a blink.
3
Blink colors
1
4
2
Note: You can open the Alarm Class Configuration dialog box and configure the audio
for a point alarm through the Point Properties dialog box.
You can also use a special variable called WIN_DIR, which expands to the Windows
NT/98 directory.
Beep
specifications
Important: Sounds only play if the CIMPLICITY® Alarm Sound Manager is running.
Wave files
Note: You configure how to stop the alarm sound in the CIMPLICITY® Alarm Sound
Manager dialog box.
Important: The file that is used to display colors is the file for the project in which
Alarm Viewer or CimView was started in, not the file for the project where the alarm
classes or CimView screens were configured.
Example–am_colors.cfg file
GFK-1180K 19-1
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.
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.
A higher severity
number gives
thealarm a higher
the priority.
Alarm String
configuration 1
CimView
AMV Alarm Control
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.
GFK-1180J 20-1
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.
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.
§ 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.
Note: A reason to leave the field blank is that the alarm does not require a
variable. For example, if the alarm is created to alert users to "The
system is down." you can leave this field blank.
Always select $CIMBASIC if you are creating the alarm to be used as an
Alarm Look-up action for an event.
See the CIMPLICITY HMI Integrator's Toolkit Operation Manual (GFK-1461)
for detailed information about Alarm Types.
See the CIMPLICITY Basic Control Engine Event Editor and BCEUI Operation
Manual, GFK-1282, for details about Alarm Look-up actions.
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.
Tip: You can also enter alarm logging specifications in the Database Logger.
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.
Alarm Definition
dialog box
Point Properties
dialog box
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.
Event alarm
Point alarm
Event alarm
Point alarm
Important: You configure the sound (.wav file or beeps) for projects in each class'
Alarm Classes Configuration dialog box. The Alarm Sound Manager only deals with
classes for which sound is configured. As a result, the Alarm Sound Manager does not
report alarms associated with classes for which no sound is configured.
GFK-1180K 21-1
Alarm Audio Support Configuration
Steps to configure alarm audio support include:
Step 1. Configure sound for relevant alarm classes.
Step 2. Open the CIMPLICITY® Alarm Sound Manager dialog box.
Step 3. Add projects to a sound manager profile.
Step 4. Configure runtime sound options.
Step 5. Auto-start the Alarm Sound Manager.
Step 6. Use the Alarm Sound Manager.
B. Either:
§ Select a setup from the list or
§ Create a new setup. See the "Configuring Alarm Viewer Fields and
Buttons" chapter in the Alarm Viewers Operation Manual, GFK-1993
for details.
C. Click OK.
The selected setup displays in the Add Project dialog box.
7. Repeat adding projects until all of the projects that should have sound for alarms
appear in the Projects list.
Note: Select a project in the list and click Delete if you want to delete it.
Tip: Click Load profile… on any tab in the CIMPLICITY® Sound Manager dialog box
to load any of the profiles you saved.
You have three projects, each with two Alarm Classes as follows:
Project Alarm Class 1 Alarm Class 2
Project Priority Class 1 Priority Class 2 Priority
PROJ_A 3 ALM_A 1 ALM_B 2
PROJ_B 2 ALM_A 1 ALM_B 2
PROJ_C 1 ALM_A 1 ALM_B 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:
Alarm Sound Alarm
Order Project Class
1 PROJ_C ALM_A
2 PROJ_B ALM_A
3 PROJ_A ALM_A
4 PROJ_C ALM_B
5 PROJ_B ALM_B
6 PROJ_A ALM_B
End of example.
1 4
1 Check to repeat the sound for the highest priority alarm until
the stop condition (2) is met.
Uncheck to rotate sound among alarms.
2 Stop a single alarm's sound when the stop condition is met.
3 Mute the sound.
4 Alarm Sound Manager removes muting when a new alarm
sounds.
Tip: Click Load profile… on any tab in the CIMPLICITY® Sound Manager dialog box
to load any of the profiles you saved.
A. Click the Open dialog box button at the right of the Use profile
field.
The Open dialog box opens.
B. Find and select the profile.
C. Click OK.
Result: The Alarm Sound Manager starts when Windows starts.
Projects in the selected profile that are running display as connected.
Projects in the selected profile that are not running display as not connected.
Tip: Select projects to start when Windows starts on the Startup Options tab in the
CIMPLICITY® Options dialog box.
To open the CIMPLICITY® Options dialog box:
1. Click Start on the Windows task bar.
2. Select Programs>CIMPLICITY>HMI>CIMPLICITY Options.
Tip: Click Load profile… on any tab in the CIMPLICITY® Sound Manager dialog box
to load any of the profiles you saved.
Note: When the Clear mute on new alarm checkbox on the Options tab is checked, the
Alarm Sound Manager unchecks Mute and resumes alarm sounds when a new alarm is
triggered. See page 21-9 for details about specifying sound conditions.
The icon displays as follows to alert you when the sound is mute. (The Mute checkbox is
checked on any tab in the CIMPLICITY® Alarm Sound Manager dialog box.)
Tip: Click the Alarm Sound Manager task bar icon to open the CIMPLICITY® Alarm
Sound Manager dialog box.
GFK-1180K 22-1
Assigning Alarms
CIMPLICITY HMI software generates two types of alarms; point alarms and
system alarms. Each point alarm is uniquely identified by its Alarm ID. Each
system alarm is uniquely identified by its Alarm ID and Resource ID.
For example:
• For point XYZ, the unique Alarm ID is XYZ.
• Each unique instance of the $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.
2. Expand Alarms .
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.
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.
Important: Before you start, make sure that the printer is not configured in Windows.
GFK-1180K 23-1
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.
Note: You can also configure redundant alarm printers if your project supports the Host
Redundancy option.
When you are finished defining the alarm printer properties, click OK to close the Alarm
Printer dialog and create the new alarm printer, or click Cancel to close the property
sheet without creating the new alarm printer.
Specifications include:
Alarm Logging Options
Log Events
Select this check box if you want to log events to the printer.
Note: If you uncheck this check box, the Alarm logging options are grayed out.
§ Click the Pop-up Menu button to create a new Alarm Class, edit the
current Alarm Class, or browse for an Alarm Class.
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 (e.g. alarms.fil).
If you do not enter a file extension, none is automatically provided. The file is
placed in the project directory (not in the project's log directory) .
Example
If a project name is systest, the file is placed in the systest folder:
I:\testplans\systest
§ Enter the path for a network printer (e.g. \\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 (e.g. \\nt001\proj1\alarms).
Tip: 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, clear the Print header field in the
Layout tab of the Alarm Printer dialog box.
Specifications include:
Print Headers
Check 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, uncheck this check box. When you uncheck 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.
Page Width
Enter the number of characters that can be printed on a line. The number must be an
integer between 80 and 157.
Redundant Alarm Printing
This field is enabled if your project has the Host Redundancy option.
Check this check box if you want both the Master and Slave computers to print alarms.
Uncheck this check box if you only want the Master computer to print alarms.
§ If you enter LPT1 in the Output field and check Redundant alarm printing,
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 uncheck Redundant alarm printing,
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.
2. For 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 check Redundant alarm
printing, 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.
Note: Check Redundant alarm printing on the Layout tab in the Alarm Printer dialog
box if you want both the master and slave computers to print alarms. See page 23-7.
Note: 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.
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
GFK-1180K 24-1
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.
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.
3B
3A
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.
Delete alarms Delete alarms from the Alarm Viewer.
Modify alarm setups Modify alarm setups in Alarm Viewer.
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.
Configuration access
denied.
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.
GFK-1180K 25-1
User Configuration
When you enter specifications for a user you
Step 1. Begin user configuration by adding a new user or modifying an existing user.
Step 2. Configure User general (security) requirement.
Step 3. Configure User resource availability.
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.
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.
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.
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 user’s 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: If you change a user's resources dynamically, the user must log out then log back
in to access the changed resources.
Note: You can also use the Shift and Ctrl keys in combination with the mouse to select
more than one resource for deletion.
GFK-1180K 26-1
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.
Important: (For SQL Server) insert triggers fire only if bulk insertion is disabled.
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.
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.
1 Open
the Database Logger 2 External
Configuration window. Application
Report specific to
Configure application
Database Logger
defaults in a Properties
dialog box at this level.
2 Open
individual For For For For For
Logging Alarms Event Alarms Points Point Groups Event Management
Tables based Open Open Open a Open a Configure
on what needs ALARM_LOG EVENT_LOG Data log table Group log table EM_LOG
to be logged.
Report created
on site.
3 Add
Alarm IDs or
Point IDs to the
table.
Add Add
Configure Add Add
Alarm IDs Alarm IDs
tables and items Point IDs Point IDs
Values logged Values logged
in a Properties
individually. in parallel.
dialog box at
each level.
4 Use
provided Excel
reports (or create
reports) to display
selected data. Trend Report
Alarm Report Data Report and Chart
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.
4. Click OK.
Result: The new table ID appears in the list of tables. You can now configure it as
you would any table.
4. Click OK.
Result: The new table ID appears in the list of tables.
3. Click OK.
Result: The selected table is deleted.
Tip: To display all the items in the table, enter an asterisk (*) in the <Type> 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.
Red
Red
Red
Black
Enabled if looking at
All others are Green. * indexes not updated from a
5.0 or older data log.
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.
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-42 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.
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.
To enter Database Logger defaults for alarm, event and application 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.
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.
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.
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-25 in this chapter for details.
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.
2 Double-click
DATA_LOG to open
the table.
3 Configure:
§ Table properties.
§ Logging conditions
for single point.
Note: Data logged for points includes: Point ID, Time the point value was logged
(timestamp), Resource, Value and other optional attributes that you select.
Attribute fields
_ALRM string Alarm state of the point .
_ENG string Engineering units label of the point.
_PREV As configured. Previous logged value of the point for the
Default is string same logging event.
_QUALITY number Point quality flags.
_RAW As configured. Raw value of the point.
Default is string
_RES string CIMPLICITY Resource associated with the
point.
_TIME date/time Previous time the point was logged for the
same logging event.
_USER number Value of the user defined flags.
_VAL As configured. Value of the point.
Default is string
Optional fields
project string Name of the CIMPLICITY project
msec number Actual number of milliseconds in the
timestamp
Option 1.
Add Points to Log Tables via a Point Properties Dialog Box
6. Click OK or Apply.
Result: CIMPLICITY adds the point to its default DATA_LOG. You can apply
more specifications in the Database Logger.
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.
2 Click OK.
Note: For a CIMPLICITY data log table, you can change the table's default logging
conditions for an individual point in the (Database Logger’s) Point Properties dialog box.
See page 26-50 for details.
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.
iii. Use the Deadband option if you want to filter out changes in the value
of the selected point type before triggering a logging event–for 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.
Example
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.
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.
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.
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.
Example
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
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.
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.
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.
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.
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.
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.
Important: (For SQL Server) insert triggers fire only if bulk insertion is disabled.
3. Select the logging conditions that apply to the selected point. See page 26-36 for
details about logging conditions.
4. Click OK.
Result: The selected point will be logged when its logging conditions occur.
high
low
transition
high
low
transition
high
low
transition
high
low
transition
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.
2 Double-click
GROUP_LOG to
display the table.
3 Configure:
§ Table properties.
§ Attributes for a point.
Note: The maximum number of columns a table can have is SBMS specific. Consult
your DBMS documentation to ensure that your Group table does not exceed these limits.
Default MSDE DBMS is 1024 columns, 8060 Bytes per row.
Important: Since the Microsoft Access and Oracle 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, unless you
have enabled millisecond logging.
2 Click OK.
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.
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-36 for details.
4. Check On point alarm state to log point values when a specified point goes
into one or more selected alarm states.
Note: You can also specify that selected attributes be logged for individual points in the
group table. See page 26-68 for details.
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.
2. Specify events the same way you specify them for a data log table. See page 26-
41 for the procedure.
2. Specify actions the same way you specify them for a data log table. See page 26-
43 for the procedure.
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 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 -45 for the procedure.
2. Do advanced configuration the same way you do for a data log table. See page
26-48 for the procedure.
Important: (For SQL Server) insert triggers fire only if bulk insertion is disabled.
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 Logger’s) 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.
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.
2 Double-click
ALARM_LOG to
display the table.
3 Configure
§ Table Properties.
§ Logging conditions
for an alarm.
Optional fields
project string Name of the CIMPLICITY project
msec number Actual number of milliseconds in the
timestamp
Option 1.
Add Point Alarms to the ALARM_LOG Table via a Point
Properties Dialog Box
6. Click OK or Apply.
Result: CIMPLICITY adds the point to its default ALARM_LOG. You can apply
more specifications in the Database Logger.
2 Click OK.
Note: You can change the conditions you specify in the ALARM_LOG Table Properties
for a single alarm. See page 26-83 for details.
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.
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.
2. Specify events the same way you specify them for a data log table See page 26-
41 for the procedure.
2. Configure the maintenance actions the same way you configure maintenance
actions for a CIMPLICITY data table. See page 26-43 for the procedure.
2. Do advanced configuration the same way you do for a data log table. See page
26-48 for the procedure.
Important: (For SQL Server) insert triggers fire only if bulk insertion is disabled.
2 Double-click
EVENT_LOG to
display the table.
3 Configure:
§ Table properties.
§ Logging conditions
for an event alarm.
Optional fields
project string Name of the CIMPLICITY project
msec number Actual number of milliseconds in the
timestamp
Option 1.
Add Point Alarms to the EVENT_LOG via a 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.
Tip: Click Table attributes… to open the Event Log’s 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. .
2 Click OK.
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.
2. Specify events the same way you specify them for an DATA_LOG. See page
26-41 for the procedure.
2. Configure the maintenance actions the same way you configure maintenance
actions for a data log table. See page 26-43 for the procedure.
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 2–Specifya 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-45
for the procedure.
2. Do advanced configuration the same way you do for a data log table. See page
26-48 for the procedure.
Important: (For SQL Server) insert triggers fire only if bulk insertion is disabled.
Optional fields
project string Name of the CIMPLICITY project
msec number Actual number of milliseconds in the
timestamp
8. Click OK.
Result: When the selected event triggers the action, the Event Manager sends the
data to the Database Logger.
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.
2. Specify events the same way you specify them for a data log table. See page 26-
41 for the procedure.
2. Configure the maintenance actions the same way you configure maintenance
actions for the data log table. See page 26-43 for the procedure.
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 2–Specify 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-45
for the procedure.
2. Do advanced configuration the same way you do for a data log table. See page
26-48 for the procedure.
Important: (For SQL Server) insert triggers fire only if bulk insertion is disabled.
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-100 for details.
Step 3a. Install the Sample Reports using Microsoft Excel 5.0
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.
Tip: Save your spreadsheet after setting the report parameters if you want the parameters
to be set the next time you run the report.
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
PROJECT 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.
Tip: Save your spreadsheet after setting the report parameters if you want the parameters
to be set the next time you run the report.
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..
<prefix>_<attrib><index> .Value of an attribute.
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.
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.
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.
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.
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.
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:
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.
GFK-1180K 27-1
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.
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.
Select:
§ (local) for the local machine
§ Computer name for a remote
machine.
B. Click Next.
A second Microsoft SQL Server DSN Configuration wizard opens.
E. Click Next.
9. Finish configuration leaving the defaults on the remaining dialog boxes.
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.
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.
Support for an Oracle database is provided via Microsoft ODBC for Oracle. This driver
comes as part of the Microsoft MDAC, which gets installed when you install
CIMPLICITY.
CIMPLICITY support for Oracle also includes using the MERANT DataDirect Connect
ODBC driver for Oracle. MERANT can be contacted at 1-800-443-1601.
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.
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
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.
Note: The DB_CONN_DOWN alarm is not stacked by default, but you can change it in
Alarm Configuration.
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.
Note: You specify the maximum number of stored records on the Connection tabs in the
Database Logger Logging Properties dialog box.
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.
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-1180K 28-1
Continue
1. Enter the name of the computer for the new client.
2. Select OK.
Result: The Client Properties dialog box opens.
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.
About CimView
CimView is a runtime, interactive graphical user interface through which you can monitor
and control your facility. CimView displays screens that were created in CimEdit for
specific applications.
As a result, the appearance, purpose and interactive capability of the CimView screen
being viewed is the result of a system administrator, applications engineer and/or screen
designer's planning and configuration. (This chapter references these individuals as
system administrators.)
The system administrator also has control over whether or not an operator can access
several of CimView's available functions. Therefore, the features that are described in this
chapter may not be available on your CimView screens.
Example
CimView has a feature that, when functioning, enables a user to find and open a
selected screen. An applications engineer may design a CimView screen that runs
when a viewer boots up. The CimView screen contains buttons that enable an
operator to open pre-determined screens. However, the system administrator disables
the CimView File>Open capability. As a result an operator cannot open any other
screens.
This chapter describes CimView features that enable you to:
§ Perform typical Windows application tasks, including:
è Open CimView (next section).
è Open other CimView screens through an open CimView screen (See page
29-4).
è Flush cached screens (See page 29-5),
è Distribute copies of the screen or screen file (See page 29-5).
è Select whether or not to display the toolbar, menu and/or status bar (See
page 29-7).
è Go back to the previous screen or an Overview (home) screen, if there is
one (See page 29-8).
è Change the size of (zoom) the CimView screen and window that you are
viewing (See page 29-9).
GFK-1180K 29-1
§ Access other CIMPLICITY runtime features, including:
è Point Control Panel (See page 29-11) and
è Quick Trends (See page 29-12).
This chapter also explains how to:
§ Perform basic procedures for using objects with setpoint actions. See page 29-
13.
§ Find help for a selected object. See page 29-16.
To find information about configuration for CimView, see the CIMPLICITY CimEdit
Operation Manual, GFK-1396.
CimView Opened
Because CimViewer is a runtime application, you can open it on either a:
§ Configuration or
§ Runtime
server or viewer.
Popup.
Note: You can also open CimView through the Windows Start menu.
1. Click Start on the Windows task bar.
2. Select Programs>CIMPLICITY>HMI>CimView.
3. Select the .cim screen from the Open dialog box.
Note: The features and behavior described are the default settings. You system may vary
due to customized configuration.
Note: Select Print Setup on the File menu to configure the printer.
3. Enter the email address and message to the recipient as you would when sending
any other email.
Result: A copy of the file that displays is sent to the recipient. The file may be a
CimView.cim or CimView.cimrt (runtime only) file.
Tip: You can email a captured picture of the current screen contents by using the
Windows Print Screen tools.
1. Press Alt+Print Screen on the keyboard while the CimView screen is the
active window.
2. Display the email message in which you want to paste the picture of the screen.
3. Press Ctrl+V (or use one of the other paste methods for your email application).
Result: A copy of the display at the time you pressed Alt+Print Screen appears on
the email message ready to be sent.
Check to display
standard toolbar.
Status Bar
1. Click View on the CimView menu bar.
2. Check Status bar.
Menu/Title Bar
Method 1
1. Click View on the CimView menu bar.
2. Check Menu/Title Bar.
Method 2
1. Right-click the CimView screen.
2. Check Menu/Title Bar on the popup menu.
Tip: You can position the toolbar anywhere you want on the CimView screen.
1. Click and hold down the right mouse button.
2. Grab the toolbar along the edge.
3. Drag it to another location.
Note: The Status bar provides information about objects and values. The Title bar
displays the screen file name.
Previous screen, the last screen that was opened before the
current screen.
Note: These methods are for display in CimView. To change the display of the CimView
screen, enter the screen dimensions on the Geometry tab of the Properties dialog box.
§ Zoom 100 button to zoom the screen to the size it in which it was saved
in CimEdit.
§ Full Screen button to use the entire monitor screen for display.
Note: Press ESC on the keyboard to return to the CimView window
environment.
Method 2. Use the zoom percents on the CimView View menu
1. Click View on the CimView menu bar.
2. Either:
A. Select Full Screen to use the entire monitor screen for display, or
B. Select the percent you want the display to zoom from one of the percent
choices.
View Menu
Use entire
monitor screen
for display.
Choose percent
screen will zoom
(or to best fit).
Opens Zoom
dialog box.
Percent screen
zoom
Screen expands
or contracts to fit
workspace
Enter an exact
percent zoom
3. Either:
A. Select one of the zoom choices.
B. Enter a precise zoom percent in the Percent field.
To make the CimView screen the best fit for the window size:
Screen selected.
Object selected.
Object selected.
Screen selected.
Setpoint Actions
Your CimView screen may provide you with the capability to set point values. If it does
following are some guidelines for using the method that is provided on the screen.
Methods include:
§ Execute slider setpoints.
§ Enter a value for the setpoint.
The method you use to execute a Slider setpoint depends on whether you selected the
object with the:
§ Mouse or
§ Keyboard.
Note: When you use a Slider setpoint, you may be setting different points in the
horizontal and vertical directions.
Note: If the object is also configured with action when the mouse is clicked down or up,
the actions execute as configured.
1 CimView
just
opened.
2 Setpoint
being
changed.
3 Setpoint
changed.
Tip: Selecting Help on the CimView toolbar or pressing F1 displays the CimView help
file.
You can also use the Help button to view Help for toolbar buttons, menu items and other
CimView features.
GFK-1180K 30-1
Procedure to Open the Point Control Panel
The Point Control Panel is a runtime application that initially connects to one running
project. Therefore, the Point Control Panel will enable you to specify the connected
project (if no project or more than one project is running when the Point Control Panel is
being opened).
Result: The file displays in the Point Control Panel with the configuration you
saved.
Example: Saved Point Control Panel File
Note: By default, Point Control Panel documents are placed in the main CIMPLICITY
HMI directory, but you can select another directory.
3. Select the folder in which the shortcut should appear, e.g., Desktop.
4. Click OK
Note: You can also change the printer specifications before you print the document.
Note: An Invalid Point icon will appear to the left of the Point ID if the point is not
valid. This can happen, for example, if you add a point to a Point Control Panel file, save
the file, close it, then delete the point from the project when you are working in the
Workbench. The next time you open the Point Control Panel file an Invalid Point icon
will appear next to that Point ID.
Tip: A quick way to add points is to open an existing file that contains some or all of the
points you want to work with. See "Opening an Existing Point Control Panel File" in this
chapter.
To add points to the Point Control Panel using the Select a Point Browser:
1. Do one of the following:
Method 1
A. Click Edit on the Point Control Panel menu bar.
B. Select Add Points…
Method 2
Click the Add Point button on the Point Control Panel toolbar.
Method 3
Press Ctrl+A on the keyboard.
To add points to the Point Control Panel directly from the Workbench:
1. Position a Point Control Panel window near the Workbench.
2. Click Points in the left pane of the Workbench.
3. Select the points you want in the right pane of the Workbench.
4. Either:
Method 1
Drag the selected points into the Point Control Panel.
Method 2
A. Click Edit on the Workbench menu bar.
B. Select Copy.
C. Click Edit on the Point Control Panel menu bar.
D. Select Paste.
Method 3
A. Select the Workbench.
B. Press Ctrl+C while the Workbench is active.
C. Select the Point Control Panel.
Tip: You can drag the points from the Point Control Panel to a CimEdit Screen. They
become text objects in CimEdit.
To add Point IDs into one Point control Panel file from another:
1. Select the Point ID or Point IDs in a Point Control Panel file that you want to
paste into another.
2. Do one of the following.
Method 1
A. Click Edit on the Point Control Panel menu bar.
B. Select Copy.
3. Open the Point Control Panel file into which the Point IDs will be copied.
4. Do one of the following.
Method 1
A. Click Edit on the Point Control Panel menu bar.
B. Select Paste.
Method 2
Press Ctrl+V on the keyboard.
Result: The Point IDs appear in the second Point Control Panel.
2 Click OK.
Click the Delete Point button on the Point Control Panel toolbar.
Method 3
Press Delete on the keyboard.
Method 4
A. Right-click a point that displays in the Point Control Panel.
B. Select Delete from the popup menu.
A Point Control Panel dialog box appears asking you to confirm deletion.
2. Either
A. Click Yes to delete the points, or
B. Click No to cancel deletion.
Result: The points will be removed or not according to your specifications.
Note: If you do not save the Point Control Panel file after you delete the points, they will
reappear the next time you open the file.
Note: A user needs to have a role in which Modify Attributes is checked in the Roles
dialog box in order to work with manual mode points.
Example
A temperature sensor that reports temperatures, which are acted upon by CIMPLICITY
HMI applications to initiate temperature control actions, fails. To continue the high
temperature setting, a user with Modify Manual Mode privilege places the point that
reflects the errant sensor in manual override mode. The user then sets a value that causes
the application to cease the unnecessary temperature control procedures. This allows
users who are knowledgeable of their CIMPLICITY HMI application implementation to
make emergency, temporary adjustments to their system’s operation. Consequently, the
application does not have to anticipate and provide for handling of all possible failures in
its implementation.
When temperature sensor is fixed, the user disables manual mode. Point data collection
resumes.
2. Select the project in which the Point Control Panel should find manual mode
points.
If you have access to that project, the Point Control Panel looks for manual
mode points and provides a message stating how many it found.
2. Click OK.
Result: the Point Control Panel displays all of the manual mode points that are in
the selected project.
A Manual Mode icon appears to the left of each of the Point IDs.
See "Enabling and Disabling Manual Mode: in this chapter for more information
about Manual Mode points in the Point Control Panel.
Click the Enable Manual Mode button on the Point Control Panel
toolbar.
The point is no longer reporting data from the PLC.
Click the Disable Manual Mode button on the Point Control Panel toolbar.
Result: Data collection from the PLC resumes for the point. The icon to the left of
the Point ID disappears.
Using the Detail Tab in the (PCP) Point Properties Dialog Box
The Point Control Panel's (PCP) Point Properties dialog box provides you with summary
information about a selected Point ID and enables you to change runtime point alarm
values.
During runtime, you can quickly:
§ Review summary details about a point.
§ Change a point's value.
You do this on the Detail tab of the (PCP) Point Properties dialog box.
Note: A user needs to have a role in which Setpoint is checked in the Roles dialog box
in order to set points.
To use the Detail tab of the (PCP) Point Properties dialog box:
1. Select the Point ID.
2. Do one of the following:
Method 1
A. Right-click the mouse.
B. Select Properties from the popup menu.
Method 2
Read-only details about the point provide you with a quick overview of the
point's properties. The property specifications were entered in the point's full
Point Properties dialog box.
3. Change the value of the point in the Set value field, if you need to.
Either the point's value will be changed or a message will display informing you
that it can't be changed and why.
To open a point's Point Properties dialog box through the Point Control
Panel:
Method 1
1. Click Edit on the Point Control Panel menu bar.
2. Select Edit Point.
Method 2
1. Right-click the point.
Click the Edit Point button on the Point Control Panel toolbar.
Result: The point's Point Properties dialog box opens.
To add points with disabled or modified alarms to the Point Control Panel:
1. Click Edit on the Point Control Panel menu bar.
2. Select Add Modified Alarms…
An Add Disabled/Modified Alarms dialog box appears.
6. Click OK.
Result: the Point Control Panel displays all of points with modified and/or disabled
alarms that are in the selected project.
An Alarm Limit Changed icon appears to the left of each Point ID that has a
modified alarm. A Disabled Alarm icon appears to the left of each Point ID that
has a disabled alarm.
Note: Points with On Update alarms do not have an Alarm tab in the (PCP) Point
Properties dialog box.
To use the Alarm tab in the (PCP) Point Properties dialog box:
1. Open a point's (PCP) Point Properties dialog box.
See the section, "Detail Tab Summary of Point Properties," in this chapter for
the methods to open the (PCP) Point Properties dialog box.
2. Select the Alarm tab.
The contents of the Alarm tab depend on whether you are viewing an Analog or
Boolean point type.
Point Type Tab Displays
Analog Whether alarming is enabled for the point, and
The configured and current alarm and warning limits.
Boolean Whether alarming is enabled for this point, and
The configured alarm state.
(PCP) Point Properties Dialog Box: Alarm Tab
Tip: You can also restore a selected point's alarm limits by clicking the Restore Alarm
Note: If the point has no alarming or has On update alarming, the Alarm tab does not
appear in the dialog box.
Click the Disable Alarm button on the Point Control Panel toolbar.
Result: The point's alarms are disabled and a Disabled Alarm icon appears next
to the Point ID.
Click the Enable Alarm button on the Point Control Panel toolbar.
Result: The point's alarms are enabled. The Disabled Alarm icon next to the
Point ID disappears.
To use the Array tab in the (PCP) Point Properties dialog box:
1. Open a point's (PCP) Point Properties dialog box.
See the section, "Detail Tab Summary of Point Properties," in this chapter for
the methods to open the (PCP) Point Properties dialog box.
2. Select the Array tab.
3. Double click the value you want to change in the Set Value column.
4. Enter the new value.
5. Either:
§ Click Apply to apply the changes and keep the (PCP) Point Properties
dialog box open, or
§ Click OK to save the changes and return to the Point Control Panel
window, or
§ Click Cancel to discard the changes and return to the Point Control Panel
window.
Result: The Point Control Panel updates to reflect your changes.
Note: You can open the array's detailed Point Properties dialog box to make other
modifications. See the section "Opening a Point's Detailed Point Properties Dialog Box"
in this chapter.
GFK-1180K 31-1
To setup for a project wide conversion, you need to:
§ Configure measurement systems and units.
§ Specify an active measurement system for the project to use at run-time.
§ Follow a few guidelines.
When the setup is completed and the configuration is updated, the project data
automatically displays the correct units and labels for the specified measurement system.
To make the measurement system the active system when the project
starts:
1. Enter an optional description in the Description field.
2. Enter an optional display label in the Display label field.
3. Check the Use at runtime check box if you want this measurement system to
be the active system when the project starts.
4. Click Enter.
The tab for the new measurement system is added in the right pane.
If Unit IDs exist in the left pane, you will see default values in the Equivalent Unit ID,
Forward Equation, Reverse Equation, Justification and Type fields.
4. Enter the name of the new measurement system in the Destination field.
5. Click OK.
Result: A new measurement system tab will be created with the name you
specified.
If there are existing Unit IDs in the left pane, you will see default values in the
Equivalent Unit ID, Forward Equation, Reverse Equation, Justification and Type
fields for the new measurement system.
4. Enter the new name of the measurement system in the Destination field.
5. Click OK
Result: The measurement system tab will change to the name you specify.
2. Enter the name of your base unit in the Unit ID field and click OK.
Result: The Measurement Unit Properties dialog box opens.
You can edit any of the following fields in the right pane or in the dialog box:
Equivalent Unit ID
Enter the Unit ID you want to use when the measurement system is active. The Unit ID
may or may not match any other Unit IDs in the configuration.
Forward Equation
Enter the equation to be used by Point Management to convert the base value to its
equivalent in this measurement system.
For example, if point XYZ's base value is in inches and you want to display it in
centimeters, use the forward expression %P*2.54001.
If the point's base value is the same as its converted value, just put %P in the field.
Reverse Equation
Enter the equation to be used by Point Management to convert the equivalent in this
measurement system to its base value.
For example, if point XYZ's base value is in inches and its equivalent value is in
centimeters, use the reverse expression %P/2.54001.
If the point's base value is the same as its converted value, just put %P in the field.
Width
This field represents the number of spaces you want to dedicate to the display of the point
value.
By default, the project uses the display width you specify when you configure a point.
If you want to use a different display width for all points that use this Unit ID, enter it in
this field.
Precision
This field represents the number of digits to be displayed to the right of the decimal point.
By default, the project uses the precision you specify when you configure a point.
If you want to use a different precision for all points that use this Unit ID, enter it in this
field.
Type
This field determines the format type used when the point value is displayed.
By default, the project uses the display type you specify when you configure a point.
If you want to use a different display for all points that use this Unit ID, enter it in this
field. Use the drop-down list button to select one of the following:
Fixed All points that use the Unit ID are displayed in fixed format using
the Width and Precision information you specify. If you do not
specify the Precision, the default is 6.
For example, if you specify a Width of 7 and Precision of 3, the point
display uses 7 places and there are 3 places after the decimal point. In this
case, 10 displays as 10.000.
Scientific All points that use the Unit ID are displayed in scientific format
using the Width and Precision information you specify. If you do
not specify the precision, the default is 6.
Compact All points that use the Unit ID are displayed in Fixed or Scientific
format based on Precision, which determines the exponent to start
displaying in Scientific format.
For example, if you specify a Precision of 5, the value 100,000 displays as
1e+005 and 10,000 displays as 10000.
The Compact type also truncates trailing zeros to the right of the decimal
point. For example, 10.0 displays as 10 and 10.10 displays as 10.1.
4. Enter the name of the new measurement unit in the Destination field.
5. Click OK.
Result: The Measurement Unit Properties dialog box opens.
6. Fill in the description label for the new measurement unit.
7. Click OK.
A new measurement unit will be created with the name you specified.
Equivalent measurement units are also created for each measurement system in the right
pane.
4. Enter the new name of the measurement unit in the Destination field.
5. Click OK
Result: The measurement unit name in the left pane will change to the name you
specify.
4. Click Yes.
Result: The measurement unit is deleted.
4. (Optional) Click the drop-down list button to the right of the Active
Measurement System field and select a new active measurement system.
When you select the measurement system, its Use at runtime check box in the
Measurement Systems Properties dialog box is selected, and the check boxes for
all other measurement systems are cleared.
If you select <None>, only the base conversions are used
5. Click OK.
CimView Scripts
CimView uses Basic scripts, which can, among many other things, use the runtime value
of a point.
When you use point values within scripts, the values correspond to the active
measurement system. Therefore, if you compare or manipulate values with other values
that are constant, you will most likely run into trouble if you switch active measurement
systems. This is because your constant numbers will stay the same, but the point values
will most likely change due to unit equivalence.
GFK-1180K 32-1
About Show Users
Show Users is an interactive process that lets you show the users on the various
CIMPLICITY HMI projects running on your network.
Review:
§ Steps for using Show Users.
§ Show Users window menu and tools.
A. Select a project.
Option 2. Open a Project in the Show Users window that was not recently
opened:
1. Do one of the following:
Option 1
A. Click Project on the Show Users window menu bar.
B. Select Open.
Option 2
Press Ctrl+O on the keyboard.
Note: If a project is already open the newly opened project displays in a second sub-
window.
2. Fill in any single or combination of fields to search the list of users in a project.
§ User ID,
§ Role,
§ Node, and/or
§ Process.
Note: You can use the drop-down list buttons to the right of each field to
display and select previous search filters.
3. Click Find.
The first user that matches the criteria in the active sub-window's list is
highlighted.
Tip: CimLogin and CimLogout Basic Control Engine API's are available for use in
CimView, e.g. to have a logout button on the screen.
Important: A CIMPLICITY project or Viewer must be running for the Login Panel to
start.
For each project that users on this computer are logged into the Login Panel displays
the:
§ Node ID for the project,
§ Project ID,
§ User name,
§ Login status, and
§ Type.
The dialog box displays the current project and your User ID.
3. Enter the current password in the Old password field.
Asterisks display as you type.
4. Enter the new password in the New Password field.
Asterisks display as you type.
5. Enter the new password again in the Confirm field.
Asterisks display as you type.
2. Click Add.
The Add Saved Login dialog box opens.
3. Select the project you want to apply the login to in the Project field.
Tip: Use the drop-down list button to display the list of available projects in
your enterprise.
4. Enter the username for the login in the User field.
6. Either:
§ Click OK to activate the new saved login, or
§ Click Cancel to exit this dialog box without saving the information you
entered.
Result: The new entry appears in the Saved Logins list. After you activate the new
saved login, whenever you open a screen in this project, you are automatically
logged in to the project.
2. Click Remove.
Result: The login information no longer dispalys in the list and is deleted from the
Registry.
If you are currently displaying any screens that require this login, they are not
affected. If you exit a screen that requires the login, then try to reopen it, the
CIMPLICITY Login dialog box opens and you are asked for a username and
password.
All runtime applications that you are logged into will be no longer update data.
For example, all CimView screens that have animation objects that use points
from this project will disable the objects.
If you are not logged into any runtime applications, the Login Panel removes the User
line.
Result: CIMPLICITY HMI software logs you back into the project. The status
changes to Logged in.
All runtime applications to which you have been logged in that are still open will
resume updating data. All CimView screens connected to this project will now have
their animation objects enabled.
Note: The screen itself may change if visibility animation has been enabled for objects
and keyed to User ID and Role ID information.
A. Select a project.
B. Click either:
Start or
Start as Viewer.
When you start the project, the normal startup dialogs are displayed.
Result: When CIMPLICITY processes a saved login or the login just entered,
the CIMPLICITY Process Control dialog box displays with the list of process
names and statuses for the project you selected.
Important: This is not the recommended way to start or stop CIMPLICITY HMI
software. You should only use CIMPLICITY Program Control to start and stop
processes if you have been instructed to do so by GE Fanuc support personnel, or if you
are testing an API application. In the latter case, you should only be starting and stopping
your API application.
GFK-1180K 33-1
Logical Names
Logical names are used to override default values in the log_names.cfg file for the
CIMPLICITY HMI Base System and options.
Note: Do not confuse logical names with environment variables. Logical names are
found in the log_names.cfg file, while environment variables are accessed through
the Control Panel.
SNP Communications
Logical names that can be modified in the log_names.cfg file for SNP
Communications are:
BSM$SNP_T1_TIME Controls the time between SNP messages.
BSM$SNP_ATTACH_DELAY Controls the time delay before SNP attach messages.
where:
<logical_name> is the name of the logical
<type> is the type of logical (usually set to P for project)
<length> is the number of characters in <value>
<value> is the value to be assigned to the logical name.
You may use Notepad to edit the file.
5. Find the parameter you want to change, and make the change.
6. Exit the Notepad.
7. Type exit to exit the Command Prompt window.
Note: When you are ready to implement the change in the runtime system, you will have
to stop and restart CIMPLICITY software.
After CIMPLICITY software has been removed from your computer (either manually or
via the Uninstall utility on Windows NT or the Add/Remove applet on Windows NT), it
may be necessary for you to remove registry information. The following sections detail
what you need to do to accomplish this for Windows 95 and Windows NT systems.
1. Run Regedit.exe.
2. Open HKEY_CURRENT_USERS
3. Open Software
4. Delete GE Fanuc Automation.
1. Open HKEY_CLASSES_ROOT
2. Delete the following:
• .AMV
• .cim
• .CLG
• .GEF
• CFGCab Document
• CimEdit
• CimEdit.Documents
• All file types starting with CIMPLICITY
• CimView
• CimView.Documents
• Default Device Property Sheet
• SNPDevice Property Sheet
• TCP IP Device Property Sheet
• VME Device Property Sheet
Once a package has been sent to a target site, the package is distributed to servers at the
target site. The SMS Despooler at the target site decompresses the compressed package
file into the package source directory's original files and directory structure, and places
these files on the distribution servers in a subdirectory of the
SMS\LOGON.SRV\PCMPKG.SRC directory. The package source directory is shared so
that the client can have access to the directory.
Note: If you have already created the Application Source Directory and copied the
platform files to it, simply open the Select CIMPLICITY Options dialog box, run
SMSSETUP.BAT in the Application Source Directory, and go to Step 4 of these
instructions.
8. Check the Upgrade box if you want to allow an upgrade during installation.
9. Do the following for each product you want to install:
A. Select the product type in the Select Options for field.
All options for that product will be displayed in the Select Options for
box.
B. Check the CIMPLICITY options you want to install. Each product that has
been modified will have an asterisk (*) in front of its name
C. Click Apply.
D. Click Close after you have selected all the product options to be updated.
10. Share the Application Source Directory with the same name (for example, the
share name for c:\cimpsms is CIMPSMS).
5. Click Import.
The File Browser dialog box opens.
9. Enter the location of the Application Source Directory in the Source Directory
field,
You can use the Browser button to the right of the box to find it.
10. Click Close.
Setpoint Downloads
A user can download setpoints from:
• CimView screens
• The Point Control Panel
• Recipes
Setpoints can also be downloaded from Basic Control Engine scripts
The $DOWNLOAD alarm is generated when a user downloads a setpoint or a recipe.
The alarm message contains the following information:
<point_id> <value> <user_id> (<OS_user> @ <computer_name>)
Project Login/Logout
The $LOGIN_FAILURE alarm is generated when a user fails to log in to a
CIMPLICITY HMI project correctly and the number of consecutive login errors has been
reached. The alarm message contains the following information:
User ID <user_id> disabled, computer <computer_name>
The $LOGIN alarm is generated when a user successfully logs in to a CIMPLICITY HMI
project. The alarm message contains the following information:
User ID <user_id> @ <computer_name> logged on
The $LOGOUT alarm is generated when a user logs out of a CIMPLICITY HMI project.
The alarm message contains the following information:
User ID <user_id> @ <computer_name> logged out
Note: Click Cancel to exit OEM Key without stopping the running projects.
You can
• Leave the dialog box open or minimize it while OEM Key is running.
• Check the Show status window check box to display the time left. This status
window displays on top of all the windows on your screen.
Note: If you exit the dialog box or click Quit, the OEM Key terminates immediately.
Note: Use the Workbench Field Chooser to remove or display any of the available fields,
except the Project. The Project is required. All of the fields in the Remote Project dialog
box are available to display in the Workbench. 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 Remote Project list is initially sorted by Project. You can click on any of the other
column titles at the top of the list to sort the list by that attribute.
Enter the name of the remote project in the Project Name field and click OK. The
Remote Project dialog box opens. This dialog box consists of two tabs.
• Use the General tab to enter general information about the project.
• Use the Enterprise tab to configure data and alarm collection for an enterprise
project.
In the General property tab of the Remote Project dialog box, enter information in the
following fields:
User ID
Enter the CIMPLICITY User ID that will be accepted for the remote project login.
Password
Enter a password, if you want to require one, for the remote project login.
Reenter Password
If you are entering a password, re-enter it here to confirm it.
Enable
Check Enable to enable the login.
If you clear the check box, the login will not be made.
Resident Process Use Only
Check Resident Process Use Only if you only want resident processes to automatically
log in to remote projects. Users will still have to log in at the Application level.
If you uncheck this check box, users will not have to log in at the Application level, and
they are automatically given the same privileges as the CIMPLICITY User ID for the
remote login.
If you want to use your current project as an Enterprise Server, you must define a remote
project for each project in your enterprise from when you want to concentrate data or
alarm information.
In the Enterprise tab, the Resource and Device are pre-configured. Users who want to
view point and alarm information from a remote project on an Enterprise Server must
have the remote projects Resource configured in their view.
Enter the following information:
Collect points Check this check box to collect point information from the
provider project. All points on the remote project that have
been configured as Enterprise Points are available to the
current project.
Points from remote projects are identified by Remote ID and
Point ID as \\<remote_id>\<point_id> for CimView and Point
Control Panel windows.
Collect alarms Check this check box to collect alarm information from the
provider project.
Only one level of concentration is supported. In other words, if you are connecting to a
remote project that has local and concentrated points, you will only be able to collect
local points from the remote project.
Note: Diagnostic points are not available for the Point Bridge.
A Global Parameter:
§ Defines parameters for the CIMPLICITY Base System and options that override
default parameters in the software.
§ Controls either:
è The system or
è A project.
§ Can be changed in one of the following ways:
è Through user interfaces in CIMPLICITY Configuration functions.
è Through the Workbench in the System or Project section.
GFK-1180K A-1
CIMPLICITY software stores the project's global parameter values in a
global_parms.idt file. This interface enables you to avoid opening and editing the
file. As a result, the Workbench application saves you time and helps you avoid
accidental errors. However, even with this tool, you should only edit global parameters
when it is absolutely necessary.
Warning: Improper global parameter configuration can cause adverse system effects.
Do not add, modify or delete global parameters unless specifically instructed to by the
documentation or a GE Fanuc Automation representative.
3 Update the
configuration.
7. Click OK.
8. Do the following if you selected a system global parameter and want the
parameter to be changed for the current project. Otherwise, go to 9.
A. Select Project in the Workbench left pane.
B. Check to see if the global parameter appears in the right pane.
C. If the global parameter:
i. Does not exist, go to 9.
ii. Does exist, change the value the same way you did for the system
global parameter.
9. Update the CIMPLICITY configuration as follows.
Method 1
Important: A global parameter applies to either the project or the system. It is important
that you add the parameter to the correct folder. If you add it to the wrong folder, it will
not be workable.
5. Click OK.
7. Click OK.
9. Update the CIMPLICITY configuration as follows.
Method 1
5. Click Yes.
6. Click OK if you are sure you want to delete the global parameter.
The global parameter is deleted from the list.
7. Update the CIMPLICITY configuration. See page 1-5 for details about updating
the CIMPLICITY configuration.
Result: The global parameter is deleted from the list and de-activated in the
CIMPLICITY system and/or project.
See Page in
Parameter For Chapter 1:
ACK_TOUT Points and Alarms 14
ALARM_SAVE_COMMENTS Alarms 14
ALLOW_UPDATE_WHEN_DISABLED Ports 15
AM_OLD_POINT_RESET Alarm Manager 15
AM_RESET_ACK_STATE Alarm Management 16
AMLP_HIGHWATERMARK Alarm Line Printer 16
AMLP_LOSTALARMSPAGE Alarm Line Printer 16
AMLP_LOWWATERMARK Alarm Line Printer 17
AMLP_MAX_QUEUE Alarm Line Printer 17
AMLP_USE_GEN_TIME Alarm Line Printer 17
AMLP_USE_RESET_TIME Alarm Line Printer 18
BIND_ADDR Router 18
CE_MAX_DELAY Basic Control Engine 19
CE_MAX_THREADS Basic Control Engine 19
CE_THREAD_TIMEOUT Basic Control Engine 19
CLR_TOUT Alarm Management 19
CONNECT_DROP_PERIOD Login 20
CONNECT_RETRY_PERIOD Login 20
DARP_LVV_USECURRENT Historical Data Analyzer 20
DARP_STARTUP_INTERVAL Historical Data Analyzer 21
DB_CLOCK_ADJUSTMENT_MONITOR Database Logger 21
DB_COMPACT_QUEUE_SIZE Database Logger 21
DB_COUNTER_FIELD Database Logger 22
DB_DBMS_QUEUE_SIZE Database Logger 22
DB_DEBUG Database Logger 23
DB_ENABLE_MSEC Database Logger 23
DB_ENABLE_TRANSACTIONS Database Logger 25
DB_MSEC_FIELD Database Logger 25
DB_POINT_ID_FIELD Database Logger 26
DB_PROJECT_FIELD Database Logger 26
DB_QUEUE_OVERFLOW_DELAY Database Logger 27
DB_QUEUE_SIZE Database Logger 27
DB_STATUS_LOG_OFF Database Logger 27
DB_TABLE_FAILURE_RETRY Database Logger 28
DB_TIME_FORMAT Database Logger 28
DB_TIMESTAMP_FIELD Database Logger 29
DB_TIMESTAMP_FILTER Database Logger 30
DB_TIMESTAMP_PRECISION Database Logger 30
DBDL_DEVICE_CHECK_PERIOD Database Logger 31
DC_RETRY_ONE_DEVICE Device Communications 31
ACK_TOUT
For: Points and Alarms
Project
Purpose: To specify the default time in minutes before an alarm is automatically
acknowledged by the Alarm Management Resident Process.
Default for: Acknowledge Timeout field in the Alarm Options Properties dialog
box for points and alarms.
Value: Number (of minutes).
Default Value: 0 (no automatic timeout).
Record Format: ACK_TOUT|3|<minutes>
ALARM_SAVE_COMMENTS
For: Alarms
Project
Purpose: To instruct the Alarm Viewer to remove or store alarm comments.
Default for: Store alarm comments checkbox in the Alarm Properties dialog box.
Value: Enter one of the following:
NO Available only while an Alarm ID appears in the Alarm
Viewer. When the Alarm ID has been reset, deleted, or
automatically removed, the comment ceases to exist, or
YES Stores comments until 20 comments have been listed for one
Alarm ID, regardless of whether the alarm has been
acknowledged, reset, deleted, etc. When 20 comments have
accumulated, the first comment entered is deleted to make
room for the newest comment.
Default Value: NO
Record Format: ALARM_SAVE_COMMENTS|1|<option>
AM_OLD_POINT_RESET
For: Alarm Manager
Project
Purpose: To update the time when an alarm is generated from the generated time
to the reset time.
The updated value can be viewed in the Alarm Viewer.
Value: Enter one of the following.
Y Update the generated time to the reset time.
N Do not update the generated time to the reset time.
Default Value: N
Record Format: AM_OLD_POINT_RESET|1|<Y or N>
AMLP_HIGHWATERMARK
For: Alarm Line Printer
Project
Purpose: To stop spooling alarm messages if more than a certain number of
alarm messages are in the job queue for the alarm printer. When this
global parameter is set to its default value, all alarm messages go to the
spooler for the alarm printer. If you enter a number greater than zero
(0), the AMLP program will spool alarm messages to the printer until
the high watermark is reached. Subsequent alarm messages will be
dropped until the low watermark, defined by
AMLP_LOWWATERMARK, is reached.
Value: Number (of jobs in the print spooler)
Default Value: 0 (no high watermark)
Record Format: AMLP_HIGHWATERMARK|1|<number>
AMLP_LOSTALARMSPAGE
For: Alarm Line Printer
Project
Purpose: To print a page indicating that alarm messages were dropped because
the AMLP program detected a high watermark for the print spooler.
This global parameter is used only when
AMLP_HIGHWATERMARK is set to a non-zero value. The page is
printed when the AMLP program detects a low watermark and resumes
sending messages to the print spooler.
Value: Enter one of the following:
Y Print a page indicating that alarms have been dropped
N Do not print a page when alarms are dropped.
Default Value: N
Record Format: AMLP_LOSTALARMSPAGE|1|<flag>
AMLP_MAX_QUEUE
For: Alarm Line Printer
Project
Purpose: 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
AMLP_MAX_QUEUE global parameter can restrict the size of the
alarm message 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.
Value: Maximum number of messages in the queue.
Default Value: None
Record Format: AMLP_MAX_QUEUE|3|<number>
AMLP_USE_GEN_TIME
For: Alarm Line Printer
Project
Purpose: To specify whether an acknowledged or deleted alarm should be
printed at the generation time or the time of the Acknowledge or Delete
action.
Value: Enter one of the following:
YES The generation time is printed.
NO The time of the action (acknowledge or delete) is printed.
Default Value: YES
Record Format: AMLP_USE_GEN_TIME|1|<option>
BIND_ADDR
For: Router
System
Purpose: To specify which IP address to use on a computer that has multiple IP
addresses, and is not using Cabling Redundancy.
You will also need to enter the same IP address for the computer in the
cimhosts.txt file.
Value: Enter a valid IP address used by the computer.
Example
BIND_ADDR|1|3.26.7.240
Default Value: None
Record Format: BIND_ADDR|1|<ip address>
CE_MAX_THREADS
For: Basic Control Engine
Project
Purpose: To specify the maximum number of simultaneous scripts allowed.
Value: Number (of scripts).
Default Value: 30
Record Format: CE_MAX_THREADS|3|<time>
CE_THREAD_TIMEOUT
For: Basic Control Engine
Project
Purpose: To specify the idle cache time in seconds before the threads are freed.
Value: Number (of seconds).
Default Value: 900
Record Format: CE_THREAD_TIMEOUT|3|<seconds>
CLR_TOUT
For: Alarm Management
Project
Purpose: To specify a default time in minutes before an alarm is automatically
reset by the Alarm Management Resident Process.
Default for: Reset Timeout field in the Alarm Options Properties dialog box for
points and alarms
Value: Number (of minutes).
Default Value: 0
Record Format: CLR_TOUT|3|<minutes>
CONNECT_RETRY_PERIOD
For: Login
System
Purpose: To specify the time interval for between retrying the connection to a
remote project.
Value: Number (of seconds).
Default Value: 90 (Equals 1½ minutes)
Record Format: CONNECT_RETRY_PERIOD|3|<seconds>
DARP_LVV_USECURRENT
For: Historical Data Analyzer
Project
Purpose: Defines whether the previous or current row in the source table should
be used for the LVV calculation.
Value: Enter one of the following:
Y Use the current row in the source table for the LVV
calculation.
N Use the previous row in the source table for the LVV
calculation.
Default Value: N
Record Format: DARP_LVV_USECURRENT|3|<value>
DB_CLOCK_ADJUSTMENT_MONITOR
For: Database Logger
Project
Purpose: Defines the rate at which system clock adjustments are checked. All
synchronized timed events are adjusted when a system clock
adjustment occurs.
Value: Number (of seconds). Enter a value between 1 and 3600
Default For: Clock adjustment monitor rate in the Database Logging Properties
dialog box.
Default Value: 60
Record Format: DB_CLOCK_ADJUSTMENT_MONITOR|1|<seconds>
DB_COMPACT_QUEUE_SIZE
For: Database Logger
Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose: For Microsoft Access databases, the compact queue holds the database
requests. This global parameter defines the queue size for maintenance
actions.
Value: Number
Default Value: 1000
Record Format: DB_COMPACT_QUEUE_SIZE|1|<number>
DB_DBMS_QUEUE_SIZE
For: Database Logger
Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose: Defines the database's queue size for non-table requests. For example,
connect requests are non-table requests
Value: Enter the queue size. The minimum size is 5.
Default Value: 1000
Record Format: DB_BMS_QUEUE_SIZE|1|<number>
DB_ENABLE_MSEC
For: Database Logger
System or
Project
Purpose: To create a separate column in which the CIMPLICITY Data Logger
will store the sub-second portion of the timestamps to the nearest
millisecond.
This capability can be important when a database is not capable of
storing time values with a timestamp accuracy of 1/1000 of a second,
which is the accuracy that CIMPLICITY Data Logger achieves. In fact,
most databases can only handle storing time values to the nearest
second. Therefore when timestamps are inserted into the database, their
values are either truncated or rounded, by the database, to a value that
complies with the database's storage capabilities.
Important
DB_MSEC_FIELD
For: Database Logger
System or
Project
Purpose: To alter the default name that CIMPLICITY uses to refer to a field that
reports the sub-second portion of timestamps in the database. See page
1-23 for details about the associated DB_ENABLE_MSEC global
parameter.
Value: String that will be the fractional portion of timestamps field name.
Default Value: msec
Record Format: DB_MSEC_FIELD|1|<field name>
Important
1. If you want to enable DB_MSEC_FIELD, create or enable the parameter before you
create any tables in the database.
CIMPLICITY creates the field as part of a table's primary key when it creates the
table. CIMPLICITY creates tables when you start your project for the first time or
reconcile a table through the Database Logger Configuration program. Therefore,
you will have to drop any table that exists before you create or enable
DB_MSEC_FIELD so CIMPLICITY can recreate them with the new field.
2. If you are logging data from multiple projects to the same database then all projects
must have the feature identically configured.
3. Only Point Logging, Alarm Logging and Trending clients fully support this feature.
DB_PROJECT_FIELD
For: Database Logger
Project
Purpose: To change the name of the project field in the following Database
Logger tables:
§ Alarm Management (ALARM_LOG and EVENT_LOG)
§ Event Manager table(EM_LOG)
§ Point Management tables (data and group log tables)
§ SPC tables
§ HDA tables
§ Tracker tables
Value: You can define a field name of up to 80 characters, or the maximum
supported by your database.
Note: when you use the DB_PROJECT_FIELD global parameter,
make sure that you drop all affected tables before running the HMI
project. Otherwise, the Database Logger will not be able to recreate the
tables with the new project field specified by the
DB_PROJECT_FIELD global parameter
Default Value: project (as a lowercase string)
Record Format: DB_PROJECT_FIELD|1|<field name>
Purpose: To specify the delay in seconds between logging overflow errors for the
Database Logger.
Value: Number (in seconds).
This timeout must be configured to be:
§ Greater than 5 seconds and
§ Less than 86400 seconds (1 day).
Default Value: 30
Record Format: DB_QUEUE_OVERFLOW_DELAY|1|<seconds>
DB_QUEUE_SIZE
For: Database Logger
System
Purpose: To specify a default queue size that supports the worst-case logging
during database table's logging activity bursts.
Default for: Database queue size field in the Database Logging Properties dialog
box.
Value: Number (for queue size).
Default Value: 20
Record Format: DB_QUEUE_SIZE|1|<size>
DB_STATUS_LOG_OFF
For: Database Logger
Project
Purpose: To turn on or off the database logging messages in the Status Log. If
this parameter is not defined or set to zero (0), the messages are logged.
Value: Enter one of the following:
0 Database Logger messages are logged in the Status Log
1 Database Logger messages are not logged in the Status Log
Default Value: 0
Record Format: DB_STATUS_LOG_OFF|1|<number>
DB_TIME_FORMAT
For: Database Logger
Project
Purpose: To define the timestamp format for your database so that time and date
fields will be written correctly in the Store and Forward files. This
parameter is for a database that does not use the default Microsoft
Access and SQL Server timestamp format, which is used by
CIMPLICITY.
Value: Timestamp (is case sensitive):
§ Uppercase
Y Year
M Month
H Hour
§ Lowercase
d Day
m Minutes
s Seconds
t Ticks (100 ticks=1 second)
Default Value: Microsoft Access and SQL Server timestamp format.
Record Format: DB_TIME_FORMAT|1|<timestamp>
Example
DB_TIME_FORMAT|1|dd\MMM\YYYY HHHH:mm:ss
DB_TIMESTAMP_PRECISION
For: Database Logger
Project
Caution: Do not create or modify this option unless instructed to by GE Fanuc support
personnel.
DC_RETRY_ONE_DEVICE
For: Device Communications
Project or System
Purpose: When an enabled device fails to respond to a read or write request from
a device communications driver for several consecutive attempts, it is
said to be down and will be polled at the Retry interval rate until it
responds.
By default, a device communication driver tries all down devices at
each Retry interval. You can use this global parameter to change the
behavior so that the driver will retry only one down device per Retry
interval. The down devices are retried using a Round Robin algorithm
(at the first Retry interval, the first down device is retried, at the next
interval, the second down device is tried, etc.). This reduces the
elapsed time for the Retry interval and is useful when many enabled
devices are down.
Value: Enter one of the following:
TRUE Poll one device per Retry interval
FALSE Poll all devices at each Retry interval
Default Value: FALSE
Record Format: DC_RETRY_ONE_DEVICE|1|<value>
DEL_OPT
For: Alarms
Project
Purpose: To specify the default requirements for alarm deletion.
Default For: Deletion requirements on the Alarm Options tab of the Alarm
Definition dialog box.
Value: Enter one of the following:
A Acknowledged only
R Reset only
AR Acknowledge and reset
Default Value: AR
Record Format: DEL_OPT|1|<option>
DONT_VERIFY_ESPOINT_FRID
For: Enterprise Server Points
Project
Purpose: To change the behavior of Setpoint Security for Enterprise Server
points.
Value: Enter one of the following:
Y Setpoint Security for all points from a given provider are enforced
against the Resource IDs as configured on the provider.
This means that a setpoint against any of these points with
resources not configured on the Enterprise Server project will
always fail since a resource that is not configured cannot be in a
user's view.
N If an Enterprise Server project contains the same Resource IDs as a
given provider, then Setpoint Security for points from the provider
are enforced against the Enterprise Server Resource IDs.
If a resource for a given point is not configured on the Enterprise
Server, then Setpoint Security for that point is enforced against the
remote project's resource.
Default Value: N
Record Format: DON’T_VERIFY_ESPOINT_FRID|1|<value>
DT_UPD_INTERVAL
For: Date/Time Points
Project
Purpose: To set the interval in seconds to update a Project’s Date & Time system
points.
Value: Number (of seconds).
Default Value: 1
Record Format: DT_UPD_INTERVAL|3|<seconds>
FIRST_WEEK_DAYS
For:
System
Purpose: To set the minimum number of days in a week in the current year
required to qualify for the first week of the year. This global parameter
is used for the $PROJECT.DATE.WEEK system point.
Value: Number (of days).
Default Value: 1
Record Format: FIRST_WEEK_DAYS|3|<days>
GSM_ANNUN_ALARM_H2
For: CimView
System or Project
Purpose: To specify the color and blink state to be displayed when the alarm
state for an analog point is High.
Value: Color Number and Blink option
Format is <color_number><blink> with:
Color A number from 0 to 15.
Blink either:
Y Blink or
N No blink.
Example
13Y (Fuschia, Blink)
Note: The color associated with each number is defined in the
RGB.DAT file. See "RGB.dat Files" in the "Applying Inanimate Visual
Features" chapter in the CIMPLICITY CimEdit Manual, GFK-1396.
Default Value: 15N (Yellow, No Blink)
Record format: GSM_ANNUN_ALARM_H2|1|<color_number><blink>
GSM_ANNUN_ALARM_L2
For: CimView
System or Project
Purpose: To specify the color and blink state to be displayed when the alarm
state for an analog point is Low.
Value: Color Number and Blink option
Format is <color_number><blink> with:
Color A number from 0 to 15.
Blink either:
Y Blink or
N No blink.
Example
4Y (Maroon, Blink)
Note: The color associated with each number is defined in the
RGB.DAT file. See "RGB.dat Files" in the "Applying Inanimate Visual
Features" chapter in the CIMPLICITY CimEdit Manual, GFK-1396.
Default Value: 13N (Fuchsia No Blink)
Record format: GSM_ANNUN_ALARM_L2|1|<color_number><blink>
GSM_ANNUN_DIG_ON
For: CimView
System or Project
Purpose: To specify the color and blink state to be displayed when the Boolean
point is 1.
Value: Color Number and Blink option
Format is <color_number><blink> with:
Color A number from 0 to 15.
Blink either:
Y Blink or
N No blink.
Example
6N (Purple No Blink)
Note: The color associated with each number is defined in the
RGB.DAT file. See "RGB.dat Files" in the "Applying Inanimate Visual
Features" chapter in the CIMPLICITY CimEdit Manual, GFK-1396.
Default Value: 7N (White, No Blink)
Record Format: GSM_ANNUN_DIG_ON|1|<color_number><blink>
GSM_ASC_FONT_SIZES
For: CimEdit/CimView (Classic ASCII File Imports)
System or Project
Purpose: To allow manipulation of (non-scalable) font sizes when a screen is
imported from the Classic system to CimView.
GSM_ASC_FONT_SIZES uses a list of the 16 values to use for the 16
text sizes in an ASCII (.ASC) file (GRE text sizes 0 to 15, which are
stored in the .ASC file as -1 to 14).
Value: An increase or decrease of one or all default values to increase or
decrease the font display.
Example
You want the fonts to display 25% larger on a CimView screen that
you imported from the Classic system.
Enter values that are 25% larger than the default values as the
GSM_ASC_FONT_SIZES value.
140, 175, 210, 350, 455, 700, 753, 753, 753, 753, 753, 753, 753, 753,
753, 753
Default Value: 112, 140, 168, 280, 364, 560, 602, 602, 602, 602, 602, 602, 602,
602, 602, 602.
Record Format: GSM_ASC_FONT_SIZES|1|<list>
GSM_CACHE_SIZE
For: CimView
System or Project
Purpose: To increase the cache size if you require faster screen repaint times
when switching between screens.
Value: Number (of screens that should be kept in cache memory).
Default Value: 8
Record Format: GSM_CACHE_SIZE|1|<number>
Note: Increasing this number uses additional memory and may have a
negative effect on the performance of other transactions.
GSM_GLOBAL_SCRIPT
For: CimEdit/CimView
System or Project
Purpose: To load and compile the specified scripts when CimEdit or CimView
starts. You can specify multiple files in the global parameter by
separating they with semicolons (;). Any script that fails to compile
will not be available after startup.
Value: String (of files that can be loaded and compiled)
Example
GSM_GLOBAL_SCRIPT|1|"D:\SCR\MISCR.TXT;D|\SCR\TKSETS.T
XT"
Default Value: None
Record Format: GSM_GLOBAL_SCRIPT|1|"<script list>"
Note: Increasing this number uses additional memory and may have a negative effect on
the performance of other transactions.
GSM_OVERRIDE_POINT_FMT
For: CimEdit/CimView
System or Project
Purpose: To adjust the format used to display point values. This is used in most,
but not all, parts of CimView. The format is specified using a "printf"
style format string, just like in the Custom display format of a text
object in CimEdit.
Value: A "printf" style format string.
Example
GSM_OVERRIDE_POINT_FMT|1|%-8.3e
Default Value: nothing (does not override the display)
Record Format: GSM_OVERRIDE_POINT_FMT|1|<string>
Note: If you select a default that is not available in the dialog box, CimView uses OK as
the default button.
GSM_STALE_COLOR_KEY
For: CimView
System or Project
Purpose: To display a last available data value in a color rather than display the
default text if a point being displayed in a Text object on a CimView
screen is unavailable and there is last available data. If no last available
data exists, the default text is displayed.
Value: Numbers to specify RGB color indices.
Format is:
RGB(<red>,<green>,<blue>)
where
<red>, <green>, and <blue> are the red, green, and blue color indices
from 0 to 255.
Example
RGB(0,0,0) is black and
RGB(255,255,255) is white.
See "Dealing with the RGB Index" in the "Applying Inanimate Visual
Features" chapter in the CIMPLICITY CimEdit Manual, GFK-1396.
Default Value: The Text object displays the default text when the point is unavailable,
regardless of whether a last available value exists or not.
Record Format: GSM_STALE_COLOR_KEY|1|RGB(<red>,<green>,<blue>)
GSM_UNAVAIL_COLOR_KEY
For: CimView
System or Project
Purpose: To specify the color index number (0 to 255) used to indicate an
unavailable point value on CimView screens.
Value: Number from 0 (Black) to 255 (White)
The color associated with each number is defined in the RGB.DAT file.
See "RGB.dat Files" in the "Applying Inanimate Visual Features"
chapter in the CIMPLICITY CimEdit Manual, GFK-1396.
Default Value: 0
Record format: GSM_UNAVAIL_COLOR_KEY|1|<number>
GSM_UNAVAILABLE_TIMELIMIT
For: CimEdit/CimView
System or Project
Purpose: To adjust how long CimView waits before displaying unknown points
as unavailable.
Value: Number (of milliseconds to wait)
Default Value: 2000 (or 2 seconds)
Record Format: GSM_UNAVAILABLE_TIMELIMIT|1|<number>
IPC_BCAST_INTERVAL
For: Router
System and Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose: To specify the Router (IPC) System Name Broadcast Period in seconds.
Value: Number (of seconds).
Default Value: 75
Record Format: IPC_BCAST_INTERVAL|1|<number>
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
LOG_OPT
For: Database Logging
Project
Purpose: To define the default logging conditions for an alarm. You can choose
any of the following:
Value: Enter any combination of the following:
G Alarm is generated
A Alarm is acknowledged
R Alarm is reset
D Alarm is deleted by a user.
Default Value: No logging options
Record Format: LOG_OPT|1|<options>
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose: To specify the retry period in seconds for connecting to a project whose
User Registration program is down.
Value: Number (of seconds).
Default Value: 15 (seconds)
Record Format: LOGIN_RETRY_PERIOD|3|<number>
MAX_TREND_BUF
For: Trending
Project
Purpose: To specify the maximum number of point values a point buffers for
Trending. Point buffering is used when a chart is first displayed and
there is some initial data.
Value: Number (of point values).
Default Value: 200
Record Format: MAX_TREND_BUF|3|<number>
MULTICAST_HOSTNAME
For: IP Address Traffic
System
Purpose: To change the name used in the DNS lookup.
Value: Enter the name of the multicast IP address.
Default Value: CIMPMULTIP
Record Format: MULTICAST_HOSTNAME|?|=<name>
Caution: If you change the address, make sure that you change it on all the machines, in
order to insure that they will continue "talking" with each other.
PB_DIAGS
For: Point Bridge
Project
Purpose: To enable or disable Point Bridge diagnostics.
Value: Numeric values in the following format:
<num1>,<num2>,<num3>,DUMPPOINT
where:
<num1> controls the amount/detail of diagnostic output. The value
ranges from 0 to 9, where 0 means no debugging output, and 9
means the maximum amount of debugging output.
<num2> is a value for NT operating systems that may handle output
files in a manner that prohibits multiple process access (as
sometimes occurs with NT on DEC Alpha platforms). This
value controls approximately how often the output file will
actually be closed/re-opened, in seconds. A value of 0 (zero)
means that this period closing will not occur. Any non-zero
value of less than 60 will be forced to 60.
<num3> provides a number of seconds for an internal timer that
rechecks the parameters in the Global Parameters file. This
value cannot be less than zero. The default value is equivalent
to five minutes.
DUMPPOINT initiates a one-time dump of the Point Bridge internal
information regarding the state of points it is servicing.
This parameter is only acted upon once when any of the other
arguments are changed, and the resulting change leaves LEVEL with a
non-zero value.
Default Value:
Record Format:
PB_DIAGS|1|LEVEL=<num1>,FILECLOSE=<num2>,DBGCHK_SECS=<num3>,DUMPPOI
NT
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
PROWLER_CACHE_SIZE
For: WebView/ThinView
System or Project
Purpose: To set the cache size for WebView or ThinView. This is equivalent to
GSM_CACHE_SIZE but this parameter is used instead of that for
WebView and ThinView sessions.
Value: Number (of screens that can be kept in cache memory)
Default Value: 0
Record Format: PROWLER_CACHE_SIZE|1|<number>
PTDL_ENABLE_MEASUREMENTS
For: Measurement System (Data logging)
Project
Purpose: To specify whether point values are to be logged in the currently active
measurement system.
Default For: Enable measurement systems field on the Parameters tab of the
Logging Properties dialog box.
Value: Enter one of the following:
0 Don't use a measurement system
1 Use the currently active measurement system
Default Value: 0
Record Format: PTDL_ENABLE_MEASUREMENTS|1|<num>
PTMDP_DO_EU_CONV
For: Point Configuration
Project
Purpose: To automatically convert Virtual Point ID values that you use in the
Expression Editor to engineering units without having to use the
EU_CONV(<point_id>) function.
Value: Enter one of the following:
0 Do not automatically convert Point ID values to engineering units
in expressions.
1 Automatically convert Point ID values to engineering units in
expressions.
Default Value: 0
Record Format: PTMDP_DO_EU_CONV|3|<option>
PTMDP_DO_SAVEPOINT_CACHE
For: Point Configuration
System and Project
Purpose: To define when virtual point values will be stored.
Default For: Store values radio buttons in the Point Setup dialog box.
Value: Enter one of the following:
0 Point values will be stored on point update.
1 Point values will be stored on project shutdown
Default Value: 1
Record Format: PTMDP_DO_SAVEPOINT_CACHE|1|<flag>
PTMRP
For: Point Management
Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose: To define the default Point Manager to be used for point processing.
Value: Name (of the default Point Manager).
Default Value: MASTER_PTM0_RP
Record Format: PTMRP|1|<name>
PTX_MAX_CACHED_POINTS
For: Point Translation
Project
Purpose: To limit the size of the Point Translation cache on systems that have a
large number of points. Point Translation adds points to the cache
when Point Management applications (for example, scripts, CimView
windows, Point Control Panel, etc.) requests point information.
Caution: If the applications on a project are likely to cycle through all the points,
limiting the cache size may cause point information to update more slowly than expected.
Value: Enter 0 (zero), or delete the global parameter if you do not want to limit
the cache size. Otherwise, enter the number of points to be put into the
cache.
Default Value: 0
Record Format: PTX_MAX_CACHED_POINTS|3|<value>
REPEAT_TOUT
For: Alarm Management
Project
Purpose: To specify the time in minutes before an alarm is automatically
repeated to all interested processes by the Alarm Management Resident
Process.
Default for: Minutes field in the Alarm Options tab of the Alarm Definition dialog
box when Auto repeat is set to Timed.
Value: Number (of minutes)
Default Value: 0 (alarms are not repeated).
Record Format: REPEAT_TOUT|3|<minutes>
RTR_ACCEPT_CONN
For: Network Options
System
Purpose: To specify whether or not you want to connect to other projects in your
enterprise and you want other projects to connect to this project.
Default for: Use the Accept Connections field in the CIMPLICITY® Options
dialog box.
Value: Enter one of the following:
Y Accept the connections.
N Stand alone.
Default Value: Y
Record Format: RTR_ACCEPT_CONN|1|<option>
RTR_MAX_OUTMESSAGE_COUNT
For: Router
System
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
To activate SECURE_SOCKETS:
1. Open Microsoft Notepad (or another text editor).
2. Enter the following two lines.
[ROUTER]
SECURE_SOCKETS=Y
Where
Y = Yes, activate encryption
Important: Only computers that have CIMPLICITY 4.01 service pack 2 or higher
installed will be able to communicate with a SECURE_SOCKET encrypted PC.
SHORT_FILENAMES
For: Filenames
Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
STARTUP_TIMEOUT
For: Project
Project
Purpose: To set the number of minutes to wait before timing out when starting
up a project.
Value: Number (of minutes).
Default Value: 10
Record Format: STARTUP_TIMEOUT|3|<minutes>
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose: To set the number of retries waiting for an external service to start up.
Value: Number (of retries).
Default Value: 30
Record Format: SVC_RETRY_COUNT|1|<number>
SVC_RETRY_DELAY
For: External Services
Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose: To set the delay in ticks between retries waiting for an external service
to start up.
Value: Number (of ticks).
(100 ticks=1 second)
Default Value: 100
Record Format: SVC_RETRY_DELAY|1|<number>
SYSNAME
For: Project
Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
TERMSERV_ALLOW_SETPOINTS
For: Points using Terminal Services
System or Project
Purpose: To disallow setpoints from CIMPLICITY Terminal Services clients.
Value: F, FALSE, T, TRUE, Y, YES, N, or NO
Default Value: TRUE
Record format: GSM_TERMSERV_CACHE_SIZE|1|<value>
Note: The Global Parameters file that is used on a Viewer is located in the
CIMPLICITY installation directory in a subdirectory called data (e.g.,
c:\cimplicity\hmi\data
GFK-1180K B-1
Microsoft Excel Example
The syntax for a CWSERV command in a Microsoft Excel spreadsheet, is:
=cwserv|point!<point_id>.<attribute>[n:mD]
where:
<point_id> is the CIMPLICITY Point ID whose data is being retrieved.
You may enter an unqualified or fully qualified (by project or
node name) Point ID.
<attribute> is the point attribute of interest. If you do not enter an attribute,
CWSERV uses "VALUE" as the default.
n:m is the range of array elements desired . If you do not enter a
range, CWSERV uses "[0]" as the default.
Enter "[n]" to specify a single element of an array.
D If you have requested a range of elements, use this field to
specify the display format. Enter "C" to display the elements in
a column, or "R" to display the elements in a row. If you do
not enter a display format, CWSERV uses "C" as the default.
Note: Consult the CIMPLICITY Help Desk for updated examples.
VALUE
Displays the converted (EU) value of the point. If there is no conversion, the
raw value is displayed. If you do not enter an attribute in the CWSERV
command, this is the default attribute that is displayed.
RAW_VALUE
Displays the raw value of the point.
STATE
Displays the current state of the point.
The point's current state depends on its point class and alarm conditions.
For all point classes, the states that can be displayed are:
NORMAL The point's value is within normal limits, and no alarms
are outstanding.
UNAVAILABLE If the point is a device point, communications with the
device have failed, and the point can no longer be read.
If the point is a virtual point, one or more of the source
points that comprise this point is unavailable.
For Analog and APPL point classes, the additional states that can be displayed
are:
ALARM HIGH The point's value is greater than the high alarm limit.
ALARM LOW The point's value is less than the low alarm limit.
WARNING HIGH The point's value is greater than the warning high limit
and less than the alarm high limit.
TYPE
Displays the point's type. You will see one of the following:
• BOOLEAN
• BITSTRING
• OCTETSTRING
• CHARACTERSTRING
• UNSIGNED INTEGER 1
• UNSIGNED INTEGER 2
• UNSIGNED INTEGER 4
• INTEGER 1
• INTEGER 2
• INTEGER 4
• FLOATING POINT
• STRUCTURE
Note
OCTETSTRING points are not currently supported by CWSERV. If you try to
display such a point's VALUE or RAW_VALUE attribute, "#NAME?" will be
displayed on the Excel spreadsheet.
LENGTH
Displays the length of the point. This field is only meaningful for the following
point types:
• BITSTRING
• OCTETSTRING
ELEMENTS
Displays the number of elements contained in the point.
SIZE
Displays the size of the data.
DISP_FORMAT
Displays the format used when displaying the point's value in Alarm Viewer,
Status Log messages, or CimView.
ALARM_HIGH
Displays the Alarm High value for the point. This field is only valid for the
following point types:
• ANALOG
• APPL
If the point's value exceeds this number, the point is in ALARM HIGH state.
ALARM_LOW
Displays the Alarm Low value for the point. This field is only valid for the
following point types:
• ANALOG
• APPL
If the point's value is less than this number, the point is in ALARM LOW state.
WARNING_HIGH
Displays the Warning High value for the point. This field is only valid for the
following point types:
• ANALOG
• APPL
If the point's value is greater than this number, but less than the Alarm High
number, the point is in WARNING HIGH state.
WARNING_LOW
Displays the Warning Low value for the point. This field is only valid for the
following point types:
• ANALOG
• APPL
If the point's value is less than this number, but greater than the Alarm Low
number, the point is in WARNING LOW state.
DISP_HIGH
Displays the high limit for the display value for this point. This field is only
valid for the following point types:
• ANALOG
• APPL
DISP_LOW
Displays the low limit for the display value for this point. This field is only valid
for the following point types:
• ANALOG
• APPL
ALARM_ENABLED
Indicates whether high/low alarms are enabled or disabled for this point. You
will see one of the following values:
0 High/Low alarm messages are disabled for the point.
1 High/Low alarm messages are enabled for the point.
WARN_ENABLED
Indicates whether high/low warnings are enabled or disabled for this point.
0 High/Low warning messages are disabled for the point
1 High/Low warning messages are enabled for the point.
This dialog box will also be displayed if you open a spreadsheet that contains
CWSERV commands and the CWSERV server is not active.
Click Yes to start CWSERV.
This dialog box will appear every time you open the spreadsheet:
Enter your CIMPLICITY username and password and click OK. Your
spreadsheet will now start to display the CIMPLICITY data you requested in the
CWSERV commands.
CWSERV Icon
While the server is active, you will see this icon on your terminal screen:
Macro Format
The format for a Microsoft Excel macro that performs a setpoint is:
• Enter the macro name on the first line.
• Enter channel=INITIATE("cwserv","point") on the
second line to open the CWSERV channel.
• Enter =POKE(channel, "<point_id>.<attribute>",
<sheet location> for each setpoint you want to perform.
• Enter =TERMINATE(channel) to close the channel.
• Enter =RETURN() to terminate the macro.
An example of such a macro is:
set_point
channel=INITIATE("cwserv","point")
=POKE(channel,"cwserv_virt.value",Sheet1!R17C3)
=TERMINATE(channel)
=RETURN()
Performance Considerations
When you perform a large number of DDE POKE requests from an application
such as Microsoft Excel, the DDE server application may fall behind. Under
Excel, this will cause some requests to timeout and fail.
To change the setpoint, enter the new point value in cell R19C3, then click Set.
Array Point Example
The following spreadsheet was configured to
§ Display the raw values for CWSERV_ARRAY, an array point with
ten (10) elements, and
§ Let a user perform a setpoint on the array:
To change the setpoint, enter the new values in R5C4 through R14C4, and click
Set.
Formats
CWSERV currently supports the CF_TEXT format.
To display format information on a Microsoft Excel spreadsheet:
1. Select one (1) cell in the spreadsheet.
2. Type the following formula in the cell and press Enter:
=cwserv|system!formats
The resulting display should look like this:
CF_TEXT
System Items
CWSERV currently supports four system items - Formats, Help, SysItems, and
Topics.
To display system item information on a Microsoft Excel spreadsheet:
1. Select four (4) rows in one column in the spreadsheet.
2. Type the following formula in the first cell and press
Ctrl+Shift+Enter.
=cwserv|system!sysitems
The resulting display should look like this:
Formats
Help
SysItems
Topics
Topics
CWSERV currently supports two topics - Point and System.
To display topic information on a Microsoft Excel spreadsheet:
1. Select two (2) rows in one column in the spreadsheet.
2. Type the following formula in the first cell and press
Ctrl+Shift+Enter.
=cwserv|system!topics
The resulting display should look like this:
System
POINT
0
This server provides clients with access to current CIMPLICITY point data.
The topics supported include SYSTEM and POINT.
0
The SYSTEM topic gives information about this server.
Supported items under the SYSTEM topic include the following:
Formats: Lists all supported formats.
SysItems: Lists all items supported under the SYSTEM topic.
Topics: Lists all supported Topics.
Help: Provides information about this server.
0
The items under the POINT topic are in the following format:
point_id.attr[start:endR]
point_id = tag name of the point [REQUIRED],
attr = type of point data desired [default = VALUE],
start and end = beginning and ending indices of an array point [default = 0], and
R = Row formatting for array elements (tab deliminated) [default = Column (<CR><LF> deliminated)].
0
Supported items under the POINT topic include the following:
VALUE: Point data value. (converted).
RAW_VALUE: Point raw data value (non-converted).
STATE: Current state of the point.
TYPE: Data type.
LENGTH: Length of point data.
ELEMENTS: Number of elements in the point for an array point.
SIZE: Size of point data.
DISP_FORMAT: Display format.
EU_LABEL: Engineering units label.
ALARM_HIGH: High alarm limit.
ALARM_LOW: Low alarm limit.
WARN_HIGH: High warning limit.
WARN_LOW: Low warning limit.
DISP_HIGH: High display limit.
DISP_LOW: Low display limit.
INIT_STATE: Initial state of point.
ALARM_ENABLED:1 if the alarm is currently enabled.
WARN_ENABLED: 1 if the warning limits are currently enabled.
GFK-1180K C-1
Supported Device Protocols
Any device protocol that supports Series 90 PLCs includes Control configuration
options when the software is properly installed. These protocols are:
• Series 90 TCP/IP
• Series 90 TCP/IP Redundancy
• SNP
Device Properties
To import variables as device points into a project, you must create an
association between the project’s devices and Control folders. A device can
have associations with multiple folders. However, a folder can only be
associated with one of the project’s devices because a folder is seen by the
project as being a device itself.
When you create a new device that is supported by CIMPLICITY Control, a
property page called Control is displayed in the device properties. Use this
property page to configure and control imports from CIMPLICITY Control for
that device.
Actions
Select Import now to perform an exchange of data. The import is performed
regardless of whether it is needed. See Import Rules for a detailed explanation
of how imports are performed.
Select Associate with folders... to associate CIMPLICITY Control folders
with CIMPLICITY HMI devices. When you select this option the CIMPLICITY
Association Server dialog box opens.
This dialog box shows you the current associations and lets you:
• Create new associations
• Edit existing associations
• Delete associations
Enter the CIMPLICITY HMI project path name in the PROJECT PATH field.
Enter the CIMPLICITY Control folder path name in the FOLDER PATH field.
Enter the CIMPLICITY HMI device name in the DEVICE NAME field.
Editing an Association
To edit an association:
1. Select the association in the CIMPLICITY Association Server
dialog box.
2. Select EDIT.
The Edit Association dialog box opens
Use this dialog box to change the project path, folder path, or device name.
Deleting an Association
To edit an association:
1. Select the association in the CIMPLICITY Association Server
dialog box.
2. Select DELETE.
The Delete Association dialog box opens, prompting you to confirm your
request.
Select Yes to delete the association, or select No to cancel the delete request.
Import Rules
CIMPLICITY HMI always assumes that the information in a Control folder is
the most up to date. During a configuration update, all devices with Control
configuration that have the On Configuration Update option selected are verified
to see if they need an import. An import is needed for those folders that have
changed since their last import.
There are three categories used to classify points during import:
New A point is considered new if it does not exist in the project.
Modifiable A point is considered modifiable if it exists in the project and it
belongs to the device associated with the folder being imported.
Removable A point is considered removable if it exists in the project and it
belongs to the device associated with the folder being imported but
was not imported during the current import session.
The import process retrieves exportable information from each association and
uses the following algorithm to import the points:
1. If a point is new and the configuration of the device associated with
the folder being imported has the new option selected, it is added
into the project.
Further imports will then consider this point modifiable unless its
device is changed through point configuration.
2. If a point is modifiable and the device configuration has the modify
option selected, the point is modified using the imported
information.
If the device configuration has the use common properties on
modify option selected, common properties are also modified. Any
other point property is left intact (for example, alarm, display,
engineering units, etc.)
3. If a point is removable and the device configuration has the delete
option selected, it is deleted from the project.
To solve the conflict, you can take one of the following actions:
• Don't import the point
• Rename it using a Point ID considered new or modifiable.
The action always defaults to Do not import.
Previously imported points with new point conflicts will always have new point
conflicts unless the point is renamed using the CIMPLICITY Control
Workbench.
To solve the conflict, you can take one of the following actions:
• Don't import the point.
• Correct the point's information.
If you rename the point you must use a Point ID considered new or modifiable.
The dialog box ensures that you do so.
The conflict action normally defaults to Do not import. However, for
previously imported points with incorrect information, their last imported
information is placed in the conflict correction dialog and the conflict action
defaults to Correct.
Example
For example, given the following two computers:
ComputerA HMI and Control installed
Drive E: mapped to \\ComputerB\C$
Contains C:\project\project.gef
Configured associations:
C:\project\project.gef with
E:\folder\folder.ef7
Example
Point Control Panel
displaying a
Machine Edition project's
point data.
GFK-1180K D-1
Machine Integration Architecture
CIMPLICITY HMI Plant Edition integration of CIMPLICITY Machine Edition point data
supports two types of architecture:
1. Enterprise Server connectivity.
2. Viewer connectivity.
Machine Edition
View
CIMPLICITY HMI
Plant Edition Machine Edition
Enterprise View
Server
Plant Edition
Server
Point Data
The CIMPLICITY Enterprise Server (ES) serves data from one or more CIMPLICITY
Machine Edition projects. At startup the ES obtains a list of exported Machine Edition points
and adds those to the points it is serving. Similarly, whenever the Machine Edition node is
restarted, the ES will resynchronize the list of points. Whenever an ES point goes into demand
(e.g. a viewer starts using it), the ES will start collecting that data from the Machine Edition
node.
An important feature of the CIMPLICITY Enterprise server is that the architecture provides
scalability. Therefore, the server can handle data distribution to hundreds of viewers while
limiting the impact on the CIMPLICITY View to one request per point.
CIMPLICITY HMI
Machine Edition
Plant Edition
View
Viewer
Plant Edition
Server
Integrated Functionality
CIMPLICITY HMI Plant Edition provides you with the tools to easily work with Machine
Edition point data through the Plant Edition interface.
However, the two applications are designed to fulfill different requirements and, therefore,
have some differences in design functionality.
Following are details about:
§ How point data integration handles product variations.
§ Setting up Machine Edition for data point integration.
In addition to reading and writing information in the CIMPLICITY HMI point database
and CSV files, Import/Export uses information in the Import/Export configuration files to
determine default field data, and writes informational, warning, and error messages to a
log file.
GFK-1180K E-1
Import/Export Data File Format
The file and record formats used by the Import/Export Utility give you the ability to
transfer configuration data between the CIMPLICITY HMI point database and third-party
software.
Import/Export reads and writes text files that use the CSV (Comma Separated Value)
format. Each record in a CSV file begins on a new line and continues until the next
newline character is encountered. Each field in a record is separated by a comma. You
can process CIMPLICITY HMI point configuration data in any third-party application
that can read or write files in CSV format.
The CSV files used by Import/Export consist of a number of records. These records use
the SNF (Shared Name File) format. In an SNF file, the first record, called the Field
Names record, lists of the names of all the variables contained in each subsequent record.
In addition, the SNF format used by Import/Export has the following conventions:
§ For import, if a field is empty, and the point already exists, the current value of
the field is preserved.
§ For import, if a field is empty, the point is a new point and a default is defined in
ie_deflds.cfg, the default is entered in the field in the database.
§ Comment lines are indicated by two-pound signs at the beginning of the line.
§ The field names must be from the list of supported fields and are case
insensitive. Any invalid fields will be identified as an error and ignored.
§ You do not need to enter two double quotes if you want a double quote to be a
part of a data string. For example:
When you import data into the CIMPLICITY HMI point configuration, any fields in an
import record that do not contain data, and that correspond to default fields in
ie_deflds.cfg, will have their values set to the default values contained in
ie_deflds.cfg.
Note: The internal format contains all the fields in the Full Set plus additional
unsupported fields.
Import Procedure
To import data:
1. Log in and start up a command shell in the project where you want to import
data.
2. At the system prompt, invoke the following command:
$ clie import <file> [-D <device_id>] [-R <resource_id>]
[-Pa <prefix>] [-y]
Where
<file> is a required argument, and is the full path of import file to be read. The
file may be in any directory, but the project's Data subdirectory is
recommended. You should always use the .CSV extension with this
filename.
Important: Option names are case sensitive and must be entered as defined.
imports the point data from MYFILE.CSV and use RESOURCE1 as the Resource ID for
any records that do not have a Resource ID defined.
The CIMPLICITY Login dialog box will ask you to log into the project if you have not
done so.
If you attempt a dynamic import while the project is not running, the import will continue
in static mode and display the following warning message:
Project must be running to use dynamic configuration.
Important: Option names are case sensitive and must be entered as defined.
exports the data fields defined by "My Set" in ie_formats.cfg to MYFILE.CSV and
MYFILE.ROL, and strips off any prefixes on the Point IDs.
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.
Where
<point_id> is the Point ID you want to delete. You can use the wildcard
characters ? and * to delete sets of Point IDs.
The optional argument for the delete command is:
Argument Description
/NOCONFIRM Deletes the requested points without prompting you to confirm
the deletion.
If you choose to confirm the deletion, you are prompted like this:
> clie delete D?I*
Starting Import/Export - logging to LOG_PATH:IC169.log
>
Note: There are no implied wildcards. If you do not include or terminate your Point ID
string with an asterisk, only those Point Ids that match your request exactly will be
deleted.
Wild cards do not work with the -sp option.
Note: Some of the optional fields are specific to points of a particular origin. The Point
Origin column identifies the type of point defined by the record. The point types are:
§ All
§ Device
§ Global (virtual)
§ Derived (virtual)
All field names and enumerated data are case insensitive.
ACCESS_FILTER
Point Type All
Maximum Field Length Byte
CIMPLICITY Field Name Enterprise Point
Description Indicates whether the Enterprise Server has
access to the point. Valid values are:
E = Enterprise Server can access
B or blank = Enterprise Server cannot access
ACK_TIMEOUT
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Acknowledge Timeout
Description Time in minutes before the point's alarm is
automatically acknowledged. Valid values
are:
-1 = No auto acknowledge
0 = Acknowledge immediately
>0 = Minutes to wait for automatic
acknowledge
ADDR
Point Type Device
Maximum Field Length 32 characters
CIMPLICITY Field Name Memory Type or Address
Description Actual address of the point within the
device. For devices with memory types, this
field contains the memory type. Otherwise,
the actual point address is used.
ADDR_TYPE
Point Type Device
Maximum Field Length 2 characters
CIMPLICITY Field Name Address Type
Description For MMS Ethernet devices only. The type
of address. Valid values are:
VN = Variable Name
FQ = Fully qualified
LG = Logical
UC = Unconstrained
AI = Array Index
SI = String Index
ALM_CLASS
Point Type All
Maximum Field Length 5 characters
CIMPLICITY Field Name Alarm Class
Description The Alarm Class ID to be used for the
point's alarms. The Alarm Class ID must
already be defined in the CIMPLICITY
database.
ALM_CRITERIA
Point Type All
Maximum Field Length 3 characters
CIMPLICITY Field Name Alarm Criteria
Description Method to be used for evaluating alarm
conditions. Valid options are:
ABS = Absolute
DEV = Deviation
ROC = Rate of Change
ONU = On Update
ALM_DELAY
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Delay Alarms
Description Determine if the generation of alarms by the
point should be delayed. Valid values are:
0 = Alarms are not delayed
1 = Alarms are delayed by the length of time
specified by SAMPLE_INTV and
SAMPLE_INTV_UNIT.
ALM_HIGH_1
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Warning High
Description High warning limit
ALM_HIGH_2
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Alarm High
Description High alarm limit
ALM_HLP_FILE
Point Type All
Maximum Field Length 10 characters
CIMPLICITY Field Name Help File
Description Name of the help text file. ".HLP" will be
added to the name. Help files are located in
%SITE_ROOT%\am_help
ALM_LOW_2
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Alarm Low
Description Low alarm limit
ALM_MSG
Point Type All
Maximum Field Length 54 characters
CIMPLICITY Field Name Alarm message
Description Text displayed when the alarm is set. See
Alarm Message Variables for the list of
variable information that can be used in the
text.
ALM_ROUTE_OPER
Point Type All
Maximum Field Length Boolean
CIMPLICITY Field Name Alarm Routing: OPER
Description Determines if alarm information is sent to
users with OPER role. Valid values are:
0 = Do not sent alarm to OPER role
1 = OPER role can display the alarm.
ALM_ROUTE_SYSMGR
Point Type All
Maximum Field Length Boolean
CIMPLICITY Field Name Alarm Routing: SYSMGR
Description Determines if alarm information is sent to
users with SYSMGR role. Valid values are:
0 = Do not sent alarm to SYSMGR role
1 = SYSMGR role can display the alarm.
ALM_STR
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Alarm String Index
Description Alarm string index to be applied for alarms.
Must be a valid index.
ALM_TYPE
Point Type All
Maximum Field Length 2 characters
CIMPLICITY Field Name Alarm Type
Description Determines which log is written to. Valid
values are:
AL = Alarm Log
EV = Event Log
ANALOG_DEADBAND
Point Type Device
Maximum Field Length Integer
CIMPLICITY Field Name Analog Deadband
Description Used to filter changes in raw value of point.
The raw value must change at least this
much to update the value of the point.
BFR_COUNT
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Point Buffering Max Count
Description The maximum number of point values to
buffer for Trending. If left zero, then the
number of values is not used as a limiting
factor when buffering data.
BFR_EVENT_PERIOD
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name
Description Not currently implemented
BFR_EVENT_PT_ID
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name
Description Not currently implemented.
BFR_EVENT_TYPE
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name
Description Not currently implemented.
BFR_EVENT_UNITS
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name
Description Not currently implemented.
BFR_GATE_COND
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name
Description Not currently implemented.
CALC_TYPE
Point Type Derived (virtual)
Maximum Field Length 3 characters
CIMPLICITY Field Name Calc Types
Description Method for determining the derived point
value. Valid values are:
EQU = Equation
DAC = Delta Accumulator
VAC = Value Accumulator
AVG = Average
MAX = Maximum
MIN = Minimum
T_C = Timer/Counter
HST = Histogram
T_H = Transition High Accumulator
EWO = Equation with Override
CONV_LIM_HIGH
Point Type Device
Maximum Field Length Integer
CIMPLICITY Field Name Converted Value (second)
Description Second converted value used for linear
conversion.
CONV_LIM_LOW
Point Type Device
Maximum Field Length Integer
CIMPLICITY Field Name Converted Value (first)
Description First converted value used for linear
conversion.
DELETE_REQ
Point Type All
Maximum Field Length 2 characters
CIMPLICITY Field Name Deletion Requirement
Description Determines when alarm occurrence should
be deleted. Valid values are:
A = Acknowledge only
R = Reset only
AR = Acknowledge and Reset
DESC
Point Type All
Maximum Field Length 40 characters
CIMPLICITY Field Name Description
Description Description of point
DEVIATION_PT
Point Type All
Maximum Field Length 32 characters
CIMPLICITY Field Name Deviation Point
Description Point that current point will be compared to
when checking for deviation alarm. Must be
a configured Point ID.
DEVICE_ID
Point Type Device
Maximum Field Length 32 characters
CIMPLICITY Field Name Device ID
Description Device where the point data originates.
Must be a configured Device ID.
DISP_TYPE
Point Type All / Real Data type Only
Maximum Field Length CHAR
CIMPLICITY Field Name Display Type
Description Determines if the value displayed is Fixed,
Scientific or compact. Valid values are:
f = fixed
g = Compact
e = Scientific.
DISP_WIDTH
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Display Width
Description Number of spaces for display of point value
in CimView.
ELEMENTS
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Elements
Description Number of discrete elements in the point's
data array. This is determined by the point's
configured data type.
ENG_UNITS
Point Type All
Maximum Field Length 8 characters
CIMPLICITY Field Name Eng. Units
Description Units that the data represents.
FW_CONV_EQ
Point Type Device
Maximum Field Length 72 characters
CIMPLICITY Field Name Eng. Conversion Expression
Description Arithmetic expression used to convert raw
data to engineering units value. See
Equation Operations for the list of valid
operators.
GR_SCREEN
Point Type All
Maximum Field Length 16 characters
CIMPLICITY Field Name Graphic Screen
Description CimView screen to display when the Get
Screen Hot Key is pressed for this point on
the Point List or Alarm Page.
INIT_VAL
Point Type Derived (virtual)/Global (virtual)
Maximum Field Length Number
CIMPLICITY Field Name Initial Value
Description Value for point at initialization before any
data is generated by its component point(s).
Use if PT_TYPE is G, or PT_TYPE is D
and CALC_TYPE is ACC, MIN, or MAX.
LEVEL
Point Type All
Maximum Field Length DINT
CIMPLICITY Field Name Level
Description Role's security level.
LOCAL
Point Type Derived (virtual)/Global (virtual)
Maximum Field Length Boolean
CIMPLICITY Field Name Local Value
Description Determines if value is reported to Point
Manager. Valid values are:
0 = Report value
1 = Do not report value
LOG_ACK
LOG_ACK is not currently supported.
LOG_DEL
LOG_DEL is not currently supported.
LOG_GEN
LOG_GEN is not currently supported.
LOG_RESET
LOG_RESET is not currently supported.
MEASUREMENT_UNIT_ID
Point Type All
Maximum Field Length 32 characters
CIMPLICITY Field Name Measurement Unit ID
Description The base measurement unit ID configured
for the point.
POLL_AFTER_SET
Point Type Device
Maximum Field Length Boolean
CIMPLICITY Field Name Poll After Set
Description Determines if polling should be done after a
setpoint. Valid values are:
0 = Do not poll (default)
1 = Scan immediately
PRECISION
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Precision
Description Number of decimal places in display.
PROC_ID
Point Type Derived (virtual)/Global (virtual)
Maximum Field Length 14 characters
CIMPLICITY Field Name Virtual Proc ID
Description The Derived Point process that will calculate
the value of this point. Must be a valid
PTDP_RP Process ID.
Format is: <node_id>_PTDP_RP
PT_ENABLED
Point Type Device
Maximum Field Length Boolean
CIMPLICITY Field Name Enabled
Description Determines if the point is enabled or
disabled. Valid values are:
0 = Disabled
1 = Enabled
PT_ORIGIN
Point Type All
Maximum Field Length 1 characters
CIMPLICITY Field Name No field defined
Description Code indicating the origin of this point.
Valid values are:
D = Device Point
R = Derived Virtual Point
G = Global Virtual Point
I = Device Internal Point
A = Device Always Poll Point
PT_SET_INTERVAL
Point Type Device
Maximum Field Length Time.
The format is HH:MM:SS for the interval,
where:
HH=Hour
MM=Minutes
SS=Seconds
CIMPLICITY Field Name Interval
Description The interval at which the Timer/Counter
point will be updated while the Expression
value remains HIGH.
PT_TYPE
Point Type All
Maximum Field Length 16 characters
CIMPLICITY Field Name Type
Description Identifies type and length of point data.
Must be a configured point type.
RANGE_HIGH
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Range Limit (hi)
Description The maximum value allowed for this point.
RANGE_LOW
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Range Limit (low)
Description The minimum value allowed for this point.
RAW_LIM_HIGH
Point Type Device
Maximum Field Length Integer
CIMPLICITY Field Name Raw Value (second)
Description Second raw value used for linear conversion.
RAW_LIM_LOW
Point Type Device
Maximum Field Length Integer
CIMPLICITY Field Name Raw Value (first)
Description First raw value used for linear conversion.
RESET_ALLOWED
Point Type All
Maximum Field Length Boolean
CIMPLICITY Field Name Reset Allowed
Description Determines if a user can reset the point's
alarm. Valid values are:
0 = User cannot reset the alarm
1 = User can reset the alarm
RESET_COND
Point Type Derived (virtual)/Global (virtual)
Maximum Field Length 2 characters
CIMPLICITY Field Name Reset/Startup Cond
Description Search sequence for source of initial value.
Valid values are:
UN = Unavailable
IN = Use INIT_VAL
SA = Use saved value
SI = Saved and init
RESET_PT
Point Type Derived (virtual)
Maximum Field Length 32 characters
CIMPLICITY Field Name Reset Point
Description Point that will cause this derived point to
reset. Must be a configured Point ID.
RESOURCE_ID
Point Type All
Maximum Field Length 16 characters
CIMPLICITY Field Name Resource ID
Description Resource ID for this point. Must be a
configured Resource ID.
REV_CONV_EQ
Point Type Device
Maximum Field Length 72 characters
CIMPLICITY Field Name Reverse Engineering Expression
Description Arithmetic expression used to convert
engineering units value to raw data for
setpoints. See Equation Operations for the
list of valid operators.
ROLLOVER_VAL
Point Type Derived (virtual)
Maximum Field Length Integer
CIMPLICITY Field Name Rollover
Description For Delta Accumulator virtual points, the
value of a point at which it rolls over to a
zero value when incremented by one unit.
SAMPLE_INTV
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Alarm Delay Interval (value)
Description For Rate of Change alarms, the frequency
with which the point will be sampled for
Rate of Change alarming.
For Absolute alarms, the length of delay
before the alarm is reported if Delay Alarms
is set to Y.
SAMPLE_INTV_UNIT
Point Type All
Maximum Field Length 3 characters
CIMPLICITY Field Name Alarm Delay Interval (units)
Description The type of units for SAMPLE_INTV.
Valid values are:
SEC = Seconds
MIN = Minutes
HR = Hours
SCAN_RATE
Point Type Device
Maximum Field Length Integer
CIMPLICITY Field Name Scan Rate
Description Frequency of point sampling. This is a
multiple of the base scan rate set for the
system.
SETPOINT_LOW
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Setpoint Limit (low)
Description The minimum value a point is allowed to be
set.
TIME_OF_DAY
TIME_OF_DAY is not currently supported.
TRIG_CK_PT
Point Type All
Maximum Field Length 32 characters
CIMPLICITY Field Name Availability Trigger
Description The point serving as the availability trigger
for this point.
If the Availability Trigger is TRUE (non-
zero) this point value is available.
If the Availability Trigger is FALSE (zero),
this point value is unavailable.
TRIG_PT
Point Type Device/Derived (virtual)
Maximum Field Length 32 characters
CIMPLICITY Field Name Trigger
Description The point serving as the trigger for this
point. Use differs if device or derived point.
Must be a configured Point ID.
For device points the trigger point must be
on the same device as the points it triggers.
For derived points, the trigger point must be
processed by the same Derived Point
Process as the points it triggers.
TRIG_VAL
Point Type Device
Maximum Field Length 16 characters
CIMPLICITY Field Name Value
Description Value the trigger is compared with to
determine if the TRIG_REL condition is
met.
UPDATE_CRITERIA
Point Type Device
Maximum Field Length 2 characters
CIMPLICITY Field Name Update Criteria
Description Value determining when point data is passed
to the CIMPLICITY point database after the
device is read. Valid values are:
UN = Unsolicited
OC = On Change
OS = On Scan
DS = On Demand On Scan
DC = On Demand On Change
PO = Poll Once
VARS
Point Type All
Maximum Field Length Integer
CIMPLICITY Field Name Vars
Description Number of process variables represented by
this point.
GFK-1180K F-1
About the Examples in this Document
The example in this document uses the following:
• A Server computer, named ALNT32, with:
• Microsoft Windows NT V4.0
• CIMPLICITY HMI Server software
• Modem
• Ethernet IP address of 3.26.5.134
• Two consecutive IP addresses - 3.26.5.143 and 3.26.5.144 - to be
used for the Remote Access Service configuration.
• A Client computer, named ALW085, with:
• Microsoft Windows 98.
• CIMPLICITY HMI Viewer software
• Modem
Pictorially, the configuration looks like this:
1. Click Configure....
For the Server, the minimum selection for Port Usage is Receive
calls only.
• Select the port usage you want for the modem.
• Click OK to return to the Remote Access Setup dialog box.
2. Click Network. The Network Configuration dialog box opens.
Make sure that NetBEUI and TCP/IP are selected for Server
Settings.
Note
If you selected Dial out and Receive calls in the Configure Port Usage dialog
box, make sure that NetBEUI and TCP/IP are also selected for Dial out
Protocols.
1. Click Configure....
For the Client, the minimum selection for Port Usage is Dial out
only
• Select the port usage you want for the modem.
• Click OK to return to the Remote Access Setup dialog box.
2. Click Network. The Network Configuration dialog box opens.
Make sure that NetBEUI and TCP/IP are selected for Dial out
Protocols.
Note
If you selected Dial out and Receive calls in the Configure Port Usage dialog
box, make sure that NetBEUI and TCP/IP are also selected for Server Settings.
You will also need to configure the NetBEUI and TCP/IP configurations.
3. Click OK to close the Network Configuration dialog box and return to
the Remote Access Setup dialog box.
4. In the Remote Access Setup dialog box, click Continue... to return to
the Network dialog box.
5. Click OK to close the Network dialog box. The system will finish
configuring the Remote Access Server and reboot the computer.
Ping
After dialing in to the Server from the Client and establishing the connection, you
should be able to perform the following tests successfully.
Client Tests
You should be able to ping the Server computer by address from the Client computer.
For example:
C:\WINDOWS>ping 3.26.5.134
C:\WINDOWS>
C:\WINDOWS>
Networking Considerations
If the IP addresses used by the RAS server are for a different network than the one
for the server on which the CIMPLICITY HMI project is running, you may need to
establish routes from the CIMPLICITY HMI project computer to the RAS link
network. You can use the Windows NT route.exe program to do this. For more
information on using the Windows NT route.exe command, refer to the Windows
NT Command Reference section of the Windows NT Help file (WINHLP32.EXE).
You can create Web documents containing textual CIMPLICITY HMI data
values. Users accessing these documents can view data and perform setpoints.
The security features of CIMPLICITY HMI restrict access to data and to the
setpoint capabilities of Internet connections as they do with standard multi-user
systems.
GFK-1180K G-1
Installing the CIMPLICITY HMI WebGateway
The CIMPLICITY HMI WebGateway consists of an extension module for your
Web Server and a Java applet for your Web Browser computers.
The installation program installs both of these modules on your Web Server
computer. The Java applet is automatically downloaded to Web Browser
computers as needed.
Installation Procedure
To install the CIMPLICITY HMI WebGateway on your Web Server:
1. Shut down all active processes before starting.
2. Insert the CIMPLICITY HMI CD in your CD-ROM drive.
If you have AutoPlay configured, the CIMPLICITY HMI
Installation Setup screen opens automatically. When you are asked
if you want to continue or cancel the installation, select Cancel.
3. Open the Windows NT Explorer.
4. Open the main folder for the CD-ROM.
5. Double-click the websetup icon in the main CD-ROM folder.
The Setup screen for the CIMPLICITY HMI WebGateway
installation opens with the Welcome dialog box.
6. Select Next to continue. The Software Evaluation License
Agreement dialog box opens.
7. Select Yes to accept the terms and conditions of the software
license. The Choose Destination Location dialog box opens.
8. Select the directory where you want to install the CIMPLICITY
HMI WebGateway (IIS) software. You should accept the default
directory. Select Next.
9. If you have not installed CIMPLICITY HMI software, you will be
asked where you want to install your CIMPLICITY HMI Viewer
software.
2. Follow the directions on the Web document to perform the first set
of tests.
3. After you verify that the first set of tests work, proceed to the
second set of tests.
Error Messages
The first part of the error string contains one of the following error codes.
#ERROR!ARRAYNOTALLOWED
This error is returned if you try to use an element of an array point with the
PointSet method.
#ERROR!ARRAYOUTOFBOUNDS
This error usually indicates that the index specified for an array point was not
valid. It will also be returned if you specify an index for a non-array point or if
you fail to specify an index for an array point. In some cases, additional
information will be available following this message.
#ERROR!BADSERVERRESPONSE
This error is returned if the CimData applet could not parse the response from
the CimGate extension. Examining the value of the DiagRawResponse property
will reveal the cause of the error.
#ERROR!CIMPLICITYNOTRUNNING
This error indicates that the CIMPLICITY HMI Viewer could not be started by
the CimGate extension.
#ERROR!NOTIMPLEMENTED
This error is returned by CimGate server when the PointMonitor method (which
is not implemented) is called.
#ERROR!NOTLICENSED
This error is returned when the CIMPLICITY HMI WebGateway is not licensed.
The CIMPLICITY HMI Gateway must be licensed to use it beyond the trial
period. Run the CIMPLICITY HMI Registration program.
#ERROR!POINTIDSYNTAX
This error is returned when the string passed to PointGet or PointSet could not
be properly parsed as a point ID.
#ERROR!POINTUNAVAILABLE
This error is returned when the point may be unavailable for any number of
reasons. Generally, there will be additional information following this message
indicating why the point is unavailable. You may also want to look at the
CIMPLICITY HMI Status Log on the Web Server computer to help understand
why the point is unavailable.
#ERROR!SERVERNEEDSRESTART
This error indicates a condition in the CimGate server that requires the Web
Server to be restarted. Typically this occurs when the CIMPLICITY HMI
Viewer (or project) on the Web Server computer is shut down.
#ERROR!URLEXCEPTION
This error indicates a problem with the URL constructed from the Web Server
name, point IDs, and values supplied. One such problem might be that the Web
Server specified is not the same as the host from which the Java data applet was
loaded, which is a security requirement imposed by many web browsers.
setCaption (Method)
Syntax setCaption(String capString)
Description Places a specified string in the applet's text area.
Parameters capString – the string to display
Comments The caption is useful to display while testing pages.
Example Using JavaScript:
document.MyApplet.setCaption("Paint Shop Data")
getCaption (Method)
Syntax String getCaption()
Description Retrieves a string from the applet's text area.
Return Value The current contents of the applet’s caption text area.
Comments The raw input and output are displayed in the appet’s text area, and can be retrieved for diagnostic
purposes using this method.
Example Using JavaScript:
myText = document.MyApplet.getCaption()
appendCaption (Method)
Syntax appendCaption(String capString)
Description Adds a specified string to the end of the text in the applet's text area.
Parameters capString – the string to display
Comments The caption is useful to display while testing pages. This method adds informative text without
removing any existing caption information.
Example Using JavaScript:
document.MyApplet.appendCaption("Paint Shop Data")
document.MyApplet.clearPoints();
document.MyApplet.setPointID(0, “\\\\proj\\temp)
document.MyApplet.setPointID(1, “\\\\proj\\speed”)
document.MyApplet.pointGet("mycomputer/Scripts")
if (getPointStatus(0) = “E”) {
alert “Error: “ + document.MyApplet.getPointValue(0);
}
else {
document.MyForm.temp.value = document.MyApplet.getPointValue(0);
}
if (getPointStatus(1) = “E”) {
alert “Error: “ + document.MyApplet.getPointValue(1);
pointSet (Method)
Syntax String pointSet(String cimGate, String pointID, String pointValue)
Description Sets the specified CIMPLICITY point to the specified value.
Parameters Parameter Description
cimGate A String containing the location of the CimGate extension. The format of this
string is "computer/directory". For example, mycomputer/Scripts.
pointID A String containing the Point ID.
pointValue The String representation of the value to be assigned.
Return Value The point status string generated by the operation.
Comments Since the CimGate extension only supports setting one point at a time, only a single-point form of
this method is required. Note that this method clears any proir content of the applet’s internal storage
before proceeding. See pointGet for error reporting information.
See Also pointGet
clearPoints (Method)
Syntax clearPoints()
Description Empties the applet’s internal point ID and value storage.
Comments The WebGateway Data Applet’s internal storage holds point IDs and values, allowing you to specify
more than one point before invoking a transaction with the WebGateway. Making one server
request for multiple values is generally more efficient than retrieving values with separate
transactions. Use this method to clear the applet’s storage before specifying point IDs to retrieve.
See Also setPointID, getPointID, setPointValue, getPointValue
setPointID (Method)
Syntax setPointID(int pointIndex, String pointID)
Description Stores a point ID for subsequent transaction(s).
Parameters Parameter Description
pointIndex the zero-based integer storage index at which to store the point ID
pointID the point ID to place in the applet’s internal storage
Comments Call this method repeatedly, with consecutive integer indices for each point ID, to load the applet’s
internal storage before making a transaction.
See Also pointGet
getPointStatus (Method)
Syntax String getPointStatus(int pointIndex)
Description Use this method to retrieves a status string from the applet’s internal storage after a transaction. The
status string for a point requested, referred to by pointIndex, contains “E” if the transaction was
unsuccessful for that point. See pointGet for more details.
Parameters Parameter Description
pointIndex the zero-based integer storage index of the point status string to retrieve
Return Value The status string corresponding to the supplied index.
See Also pointGet
Important: Once you register CIMPLICITY, the registration files, *.key, *.rst,
*.41s and *.ent, must stay in the same place on the hard disk. If you use a utility (e.g.
defragmentation) that changes the location of these files, you will lose your registration.
Consult the utility documentation for possible ways to protect these files.
GFK-1180K H-1
CIMPLICITY First Time Registration
You will supply GE Fanuc Automation with a generated system key code when you
register CIMPLICITY.
You can easily:
Step 1. Prepare for registration to obtain the generated system key code (next).
Step 2. Complete first time registration. See page H-7.
GFK-1180K H-3
Step 1. Prepare for CIMPLICITY Registration
Task 3. Enter User Information
1. Enter company contact name, company name, address, telephone number, fax
number and email address in the CIMPLICITY® Registration: User Information
dialog box.
When you request your System Authorization Code you will need to furnish
your GE Fanuc Automation representative with the information that you enter.
Note: The license is issued to a company, not to an individual.
2. Click Next.
Result: The CIMPLICITY® Registration: Serial Numbers dialog box appears.
1. Enter the serial number for your base system in the Serial no. field in the
CIMPLICITY® Registration: Serial Numbers dialog box.
You can find the serial number in the CIMPLICITY registration envelope that is
included in the CIMPLICITY system package.
2. Click Next
Result: The CIMPLICITY® Registration: Authorization screen opens.
GFK-1180K H-5
Step 1. Prepare for CIMPLICITY Registration
Task 5. View a Generated System Key Code
When a correct base serial number is entered CIMPLICITY registration generates a
system key code that displays on the CIMPLICITY® Registration: Authorization screen.
You will supply the GE Fanuc Automation representative with this code.
Automatically
generated when
correct serial
number is
entered.
Click Next.
Result: The CIMPLICITY® Registration System Authorization Code dialog
box opens.
Obtain from
GE Fanuc by
phone or fax.
GFK-1180K H-7
7. Click Next
The CIMPLICITY® Registration: Authorization screen opens.
8. Click Next
The CIMPLICITY® Registration: System Authorization Code dialog box opens.
9. Enter the Authorization Code you received from GE Fanuc.
Obtained from
GE Fanuc
through the
Internet or by
phone or fax.
Important: Do not change the base serial number when you enter new options through
the CIMPLICITY® Registration: Welcome dialog box.
3. Click Add.
The Product Serial Number dialog box opens.
4. Enter the serial number that appears on the option's License sheet in the Serial
number field.
The name of the option appears in the Product field.
5. Click OK.
GFK-1180K H-9
The product option, with an unlicensed status, appears in the Options and
Versions upgrades list in the CIMPLICITY® Registration: Welcome dialog box.
6. Click Next
The CIMPLICITY® Registration: License Agreement screen appears.
7. Click Yes.
The CIMPLICITY® Registration: Finish screen appears.
8. Reboot your computer.
Result: If you display the CIMPLICITY® Welcome dialog box after you reboot
you will see that the option's status has changed to Licensed.
4. Enter the applicable serial number for the base system you are registering.
5. Click Next
GFK-1180K H-11
The CIMPLICITY® Registration: Authorization dialog box opens.
Automatically
generated when
correct serial
number is entered
6. Contact GE Fanuc with the new base serial number and System Key Code to
obtain a new System Authorization Code.
7. Click Next
8. Enter the new System Authorization Code in the CIMPLICITY®
Registration: System Authorization Code dialog box.
Obtained from
GE Fanuc
through the
Internet or by
phone or fax.
9. Click Next
The CIMPLICITY® Registration: Finish screen appears.
10. Reboot your computer.
Result: If you display the CIMPLICITY® Registration: Welcome dialog box after
you reboot you will see that the upgrade's status has changed to Licensed.
Note: If you current installation is CIMPLICITY 4.01 in the 90-day warranty period, the
version upgrade is provided at no charge.
If your current version is out of the 90-day warranty period, you must purchase the
version upgrade.
You will receive an upgrade license (either from your distributor or directly from GE
Fanuc) when you purchase an upgrade. Use the Registration program to add the new
license to your current set of installed licenses.
Note: If you are upgrading from version 3.0 of CIMPLICITY software, you do not need
to contact GE Fanuc for a new System Authorization Code.
Important: Do not change the base serial number when you enter new options through
the CIMPLICITY® Registration: Welcome dialog box.
GFK-1180K H-13
5. A CIMPLICITY® Registration: Welcome dialog box opens.
Important: Do not change the number in the Serial no. field.
6. Click Add.
The Product Serial Number dialog box opens.
7. Add your upgrade serial number in the Serial number field.
8. Click OK.
The new version, with an unlicensed status, appears in the Options and Versions
upgrades list in the CIMPLICITY® Registration: Welcome dialog box.
9. Click Next
The CIMPLICITY® Registration: License Agreement screen appears.
10. Click Yes.
The CIMPLICITY® Registration: Finish screen appears.
11. Reboot your computer.
Result: If you display the CIMPLICITY® Registration: Welcome dialog box after
you reboot you will see that the version's status has changed to Licensed.
Important: If you are upgrading from a version prior to v3.0, you must contact GE
Fanuc for a new serial number and, during installation, for a System Authorization Code.
7. Click Add.
The Product Serial Number dialog box opens.
8. Add the new serial number in the Serial number field.
GFK-1180K H-15
9. Click OK.
The new version, with an unlicensed status, appears in the Options and Versions
upgrades list in the CIMPLICITY® Registration: Welcome dialog box.
10. Click Next.
The CIMPLICITY® Registration: Authorization dialog box opens.
Automatically
generated when
correct serial
number is entered
Note: If you want to add additional options to the functional upgrade, you do not need to
contact GE Fanuc. Simply enter a valid serial number for each option you have purchased
and want to enable. See page H-15 for details.
GFK-1180K H-17
CIMPLICITY License Transfer via the Network
You can transfer licenses from one computer to another via the network.
CIMPLICITY HMI software must be installed on your target computer before you
transfer the licenses.
4. Click Next.
The CIMPLICITY® Registration: License Agreement screen appears.
5. Click Yes.
The CIMPLICITY® Registration: Transfer dialog box opens.
6. Check Transfer via Network.
GFK-1180K H-19
Result: In the following order:
1. A message informs you that authorization is being transferred.
2. A CIMPLICITY® Registration: Finish dialog box appears informing you that
the license is transferred.
5. Click Next.
The CIMPLICITY® Registration: License Agreement screen appears.
GFK-1180K H-21
6. Click Yes
The CIMPLICITY® Registration: User Information screen appears.
7. Enter user information the same as you would for a new registration.
8. Click Next.
The CIMPLICITY® Registration: Transfer screen appears.
9. Check Transfer Using Floppy Diskette.
2. Click Next.
The CIMPLICITY® Registration: Register diskette screen appears.
3. Click Register me.
Click
GFK-1180K H-23
A Select Diskette Drive dialog box appears.
Note: Leave the CIMPLICITY® Registration: Register diskette screen displaying on the
target computer.
5. Click Next.
The CIMPLICITY® Registration: License Agreement screen appears.
6. Click Yes.
The CIMPLICITY® Registration: Transfer screen appears.
7. Check Transfer using Floppy Diskette.
8. Click Next .
The CIMPLICITY® Registration: Transfer Using Floppy Diskette dialog box
appears.
9. Check Source System.
GFK-1180K H-25
10. Check Step 2. Authorize the Diskette.
Click
GFK-1180K H-27
Tip: Click View license status on the CIMPLICITY® Registration: Finish screen to
make sure that the source computer is now unlicensed.
Important: If you wish to continue to run fully functional CIMPLICITY software on the
source computer, contact your distributor to purchase additional licenses.
3. Click Next.
The CIMPLICITY® Registration: Authorization from the diskette screen
appears.
GFK-1180K H-29
4. Click Authorized disk .
Click
6. Click Finish.
7. Reboot the newly licensed computer for the changes to take affect.
Result: The target computer can now function as the registered CIMPLICITY
HMI source.
GFK-1180K H-31
CIMPLICITY with No License
You can run CIMPLICITY software without a license in order to demonstrate or test
CIMPLICITY software.
You will be able to:
§ Run the CIMPLICITY Demo project or any other existing project for two (2)
hours.
§ Create and view screens using CimEdit and CimView.
The following runtime restrictions also apply:
§ You cannot create, modify, copy or delete points in any project.
§ On an unlicensed Server or Viewer node, you cannot communicate with
CIMPLICITY applications on other computers.
§ An unlicensed device communications enabler (devcom) will run for only two
hours regardless of whether the base system has been licensed or not.
5. Click Yes if you are certain you want to remove the CIMPLICITY registration.
Result: CIMPLICITY registration is removed from your system. If you need to re-
register, contact GE Fanuc.
GFK-1180K I-1
Removing CIMPLICITY from Windows NT and Windows 2000
CIMPLICITY HMI software is removed from a Windows NT or Windows 2000 system
the same way any other software is removed.
GFK-1180K J-1
Using the Status Log Viewer
To display a Status Log, you can do one of the following:
• Select the Status Log icon from the CIMPLICITY HMI menu.
• In a project cabinet, select Status Log from the Tools menu.
• In a project cabinet, press Ctrl+L.
The CIMPLICITY Log Viewer window opens.
Remember that the Status Log file that is displayed depends on whether you
initiated the CIMPLICITY Log Viewer from a project or the CIMPLICITY HMI
main menu.
The CIMPLICITY Log Viewer screen displays the following information for each
record that it finds in the status log file:
Date/Time The date and time the message was logged.
Status The type of message. This can be "Failure", "Warning" or
"Success".
Process The name of the process that generated the log message.
Procedure The name of the procedure that generated the log message.
Source A symbolic name for the error class.
Code The primary value used by software for expressing the type of error.
Reference A number (shown as a decimal integer) that can be used to
determine the location of the condition that caused the error.
Message An explanation of the condition that caused the log message.
The Status Log Viewer can display CIMPLICITY HMI Status Log files of type
.CLG. You can search the directory structure on any drive you are connected to
for log files.
The default Status Log file name is COR_RECSTAT.CLG. Status Log files are
generally found in the log file for your main CIMPLICITY HMI log directory,
and in each of your project's log directories.
To display a log file:
1. Locate the file in your CIMPLICITY HMI main log directory or a
project log directory.
2. Click OK.
3. The dialog box closes, and the file you selected is displayed in the
CIMPLICITY Log Viewer window.
To create a text file, select a pathname and file name for the text file and click
OK.
The first line of the text file shows the computer name and the full path name for
the Status Log file.
For example, if you are searching Down and you are already at the end of the
message list, when you activate the search, you will not be asked if you wish to
continue from the beginning of the list.
To close the dialog box without finding a message, click Cancel.
To clear the filters, click Clear, and then click OK.
GFK-1180K Index-i
$PROJECT.DATE.DAY 13-5 %LIMIT 8-15
$PROJECT.DATE.DAYOFWEEK 13-5 %STATE 8-15
$PROJECT.DATE.DAYOFYEAR 13-6 %VAL 8-15
$PROJECT.DATE.HOUR 13-6
$PROJECT.DATE.HOUR12 13-6 .
$PROJECT.DATE.MINUTE 13-6
$PROJECT.DATE.MONTH 13-6 .soc File
$PROJECT.DATE.SECOFDAY 13-6 Imported into a project 12-5
$PROJECT.DATE.SECOND 13-6 .wav
$PROJECT.DATE.WEEK 13-7 Alarm hardware requirements 21-1
$PROJECT.DATE.YEAR 13-7 Stop for an alarm 21-9
$PROJECT.DATETIME 13-7
$PROJECT.DEVICES 13-7 _
$PROJECT.LOGGEDIN 13-7
$PROJECT.USERS 13-7 _ENG
$RANGE_HIGH In Data Report 26-117
Numeric data item 11-37 _PREV
$RANGE_LOW In Data Report 26-117
Numeric data item 11-37 _RAW
$RAW_LIMIT_HIGH In Data Report 26-117
Numeric data item 11-37 _RES
$RAW_LIMIT_LOW In Data Report 26-117
Numeric data item 11-37
$RAW_VALUE {
Point attributes 10-22
$REDUND_DEV_DOWN 20-3 {Procedure
$RESOURCE_ID Quick enable of a protocol for a project 5-2
Class attribute 11-17
$ROLE 13-8 3
$ROLE.LEVEL 13-8
$RTR_LINK_DOWN 20-3 3D_BCD 6-4
$SCREEN_ID
Class attribute 11-17 4
$SETPOINT_HIGH
Numeric data item 11-37 4D_BCD
$SETPOINT_LOW Device point 6-4
Numeric data item 11-37
$TREND_DURATION A
Numeric data item 11-37
About
$TREND_SAMPLES
Alarm audio support 21-1
Numeric data item 11-37
Alarm blocking 22-1
$USER 13-8
Alarm classes 18-1
$USER.ALARMS 13-8
Alarm printer configuration 23-1
$WARNING_HIGH
Alarms 20-1
Numeric data item 11-37
CIMPLICITY HMI and Control C-1
$WARNING_LOW
CIMPLICITY HMI log files J-1
Numeric data item 11-37
Classes 11-1
Client configuration 28-1
% Database logging, Managing 27-1
%% 8-15 Devices 15-1
%DEV_AMT 8-15 Measurement units 31-1
%DEV_VAL 8-15 Microsoft System Management Server 33-10
%EU 8-15 Point control panel 30-1
%ID 8-15 Ports 17-1