Académique Documents
Professionnel Documents
Culture Documents
CIMPLICITY HMI
Base System
Users Manual
GFK-1180H
March 1999
GFL-002
Warning
Warning notices are used in this publication to emphasize that hazardous voltages, currents, temperatures, or other
conditions that could cause personal injury exist in the equipment or may be associated with its use.
In situations where inattention could cause either personal injury or damage to equipment, a Warning notice is used.
Caution
Caution notices are used where equipment might be damaged if care is not taken.
Note
Notes merely call attention to information that is especially significant to understanding and operating the equipment.
This document is based on information available at the time of publication. While efforts have been made to be accurate,
the information contained herein does not purport to cover all details or variations in hardware or software, not to provide
for every possible contingency in connection with installation, operation, or maintenance. Features may be described
herein which are not present in all hardware and software systems. GE Fanuc Automation assumes no obligation of
notice to holders of this document with respect to changes subsequently made.
GE Fanuc Automation makes no representation of warranty, expressed, implied, or statutory with respect to, and assumes
no responsibility for the accuracy, completeness, sufficiency, or usefulness of the information contained herein. No
warranties of merchantability or fitness for purpose shall apply.
Preface
GFK-1180H
iii
Chapter 9: Changing the Workbench Point Display: Describes the many ways to
change the point information displayed in the Workbench
Chapter 10: Using System Points: Describes the several points that are included in
CIMPLICITY HMI and can be used to display system information, including dates
and time.
Chapter 11: Point Cross Reference: Describes the CIMPLICITY HMI tool that
facilitates keeping track of where and how points are used.
Chapter 12. Device Configuration: Explains how to configure devices.
Chapter 13. Resource Configuration: Explains how to configure resources.
Chapter 14. Port Configuration: Explains how to configure ports.
Chapter 15. Alarm Class Configuration: Explains how to configure alarm classes.
Chapter 16. Alarm String Configuration: Explains how to configure alarm strings.
Chapter 17. Alarm Configuration: Explains how to configure alarms.
Chapter 18 Alarm Audio Support: Shows you how to configure audible alarms.
Chapter 19 Alarm Blocking: Shows you how to implement hierarchical alarm
blocking.
Chapter 20. Alarm Printer Configuration: Shows you how to configure a printer
to record alarm messages.
Chapter 21. Role Configuration: Explains how to configure roles.
Chapter 22. User Configuration: Explains how to configure users.
Chapter 23. Database Logger: Discusses the Database Logger option and how to
configure tables and reports.
Chapter 24. Managing Database Logging: Discusses the installation of ODBC and
Oracle drivers and data sources, how to manage the database for SQL Server, how to
control database disconnect recovery, and how to use the global parameters for the
Database Logger
Chapter 25. Client Configuration: Shows you how to configure default logins for
CIMPLICITY HMI Viewers on client computers.
Chapter 26: Using CIMPLICITY HMI with CIMPLICITY Control: Shows you
how to import variables from a Control folder into points in an HMI project.
Chapter 27. Configuration Import/Export: Documents the Import/Export utility.
Chapter 28. Using the Alarm Viewer OCX: Documents how to use the Alarm
Viewer OCX in CimView to display alarm information.
Chapter 29. Alarm Viewer OCX Methods: Documents the methods you can use in
CimEdit and CimView in conjunction with the Alarm Viewer OCX.
Chapter 30. Using the Stand-Alone Alarm Viewer: Shows you how to use the
stand-alone Alarm Viewer to display alarm information.
Chapter 31. Using CimView: Explains the features of the graphic screen viewer.
Chapter 32. Using the Point Control Panel Shows you how to use the Point
Control Panel to display point information.
Chapter 33. Using the CIMPLICITY to Windows Server (DDE): Discusses how
to use CWSERV with third-party software such as Microsoft Excel spreadsheets.
iv
GFK-1180H
Chapter 34. System Utilities: Describes the Show Users and Program Control
features of the System Utilities option.
Chapter 35. UsingMeasurement Units: Explains measurement units and how to
configure them.
Chapter 36. System Management: Discusses system management functions such as
Global Parameters and Logical Names: Changing them
CIMPLICITY HMI Software: Removing the software from a computer.
Security Features: Setting a Login Password, Role Privileges, Setpoint
Security, Setpoint Password and Security Audit Trail.
OEM Key: Using the OEM key to temporarily convert a Runtime license to a
Development license
Remote Projects, Point Bridge and Enterprise Server: Configuring remote
projects, point bridges to remote projects and enterprise server projects.
Site Wide Installation: Using the Microsoft Systems Management Server
(SMS) for site-wide installations of CIMPLICITY HMI software.
Chapter 37. Using CIMPLICITY HMI with Remote Access: Shows you how to
use the Remote Access features of Windows NT and Windows 95 to let users with
CIMPLICITY HMI Viewer software access project data through modems.
Chapter 38. CIMPLICITY HMI Web Gateway: Shows you how to use this
feature to let users access your CIMPLICITY HMI data over the Internet.
Appendix A. System Administrative Issues: Describes how to transfer
CIMPLICITY HMI licenses from one computer to another, do a floppy disk
installation and remove CIMPLICITY HMI from a system.
Appendix B. Resolving Problems: Discusses how to use the Status Log Viewer and
system log files to find an resolve problems.
GFK-1180H
Preface
Contents
Welcome to CIMPLICITY HMI
1-1
2-1
3-1
GFK-1180H
vii
Understanding Points
4-1
5-1
6-1
7-1
viii
GFK-1180H
8-1
9-1
10-1
GFK-1180H
Contents
ix
11-1
Device Configuration
12-1
GFK-1180H
Resource Configuration
13-1
Port Configuration
14-1
15-1
16-1
Alarm Configuration
17-1
18-1
GFK-1180H
Contents
xi
19-1
20-1
Role Configuration
21-1
User Configuration
22-1
Database Logger
23-1
xii
GFK-1180H
GFK-1180H
Contents
xiii
24-1
xiv
GFK-1180H
Client Configuration
25-1
26-1
Configuration Import/Export
27-1
Introduction.......................................................................................................................... 27-1
Import/Export Data File Format........................................................................................... 27-2
Sample Data File.................................................................................................... 27-2
Editing CSV Files in Notepad................................................................................ 27-3
Editing CSV Files in Excel .................................................................................... 27-3
Import/Export Configuration Files ....................................................................................... 27-4
Import Field Defaults (ie_deflds.cfg)..................................................................... 27-4
Export Field Formats (ie_formats.cfg)................................................................... 27-5
Import/Export Log File ........................................................................................................ 27-6
Import/Export Log File Name................................................................................ 27-6
Import/Export Log File Format.............................................................................. 27-6
Importing Configuration Data .............................................................................................. 27-7
Import Procedure ................................................................................................... 27-7
Importing in Dynamic Mode.................................................................................. 27-8
Importing Additional Roles.................................................................................... 27-9
Exporting Configuration Data ............................................................................................ 27-10
Export Procedure ................................................................................................. 27-10
Deleting Configuration Data .............................................................................................. 27-12
Specifying Wildcards for Delete.......................................................................... 27-12
Import/Export Field Names................................................................................................ 27-13
Required Fields .................................................................................................... 27-13
Optional Fields..................................................................................................... 27-13
Logicmaster 90 Support ..................................................................................................... 27-34
Sample Logicmaster File...................................................................................... 27-34
GFK-1180H
Contents
xv
28-1
xvi
GFK-1180H
29-1
30-1
GFK-1180H
Contents
xvii
Using CimView
31-1
32-1
xviii
GFK-1180H
33-1
System Utilities
34-1
GFK-1180H
Contents
xix
35-1
System Management
36-1
xx
GFK-1180H
37-1
38-1
GFK-1180H
Contents
xxi
A-1
B-1
Index
xxii
GFK-1180H
GFK-1180H
(800) 648-2001
Europe
(352) 727979-1
Asia Pacific
(65) 566-4919
Latin America
(610) 437-7932
Mexico
(800) 989-1244
1-1
Customer Support
GE Fanuc takes pride in the high quality of CIMPLICITY HMI software. Great
emphasis has been placed on ensuring the quality of this system throughout
development and testing. However, the tremendous power that the software offers
may cause you to encounter problems or questions for your specific configuration.
If your CIMPLICITY software system is under warranty or is covered by a valid
support contract, you may obtain assistance and report problems to the CIMPLICITY
Technical Support Hotline at one of the following numbers:
USA and Canada
All others
(804) 978-6036
The CIMPLICITY HMI Hotline is available from 8 A.M. to 8 P.M. Eastern Time,
Monday through Friday, except for regularly scheduled USA holidays.
1-2
GFK-1180H
GFK-1180H
Configure any area of your project by quickly opening the appropriate dialog
box to:
Point Control Panel into which you can drag and drop
selected points from the Workbench whenever you
want to quickly monitor them
2-1
Workbench at a Glance
Within the Windows NT and 95/98 familiar environment, CIMPLICITY HMIs
Workbench provides you with all the unique CIMPLICITY HMI Power Tools you
need to create and manage your project with maximum efficiency.
2.
Select Programs.
3.
Select CIMPLICITY.
4.
2-2
GFK-1180H
Tip: For quick access to the Workbench, place a shortcut of your projects .GEF file
on the Windows NT and 95/98 desktop.
Left to right:
w Configuration update
w Status log
w Project properties Right pane
views
w Project wizard
Help
Search
Field
Properties chooser
Screens
Points
Application Folder
Objects in application
Expand the tree
Status bar
Files or records
associated with object
CIMPLICITY applications appear as folders in the left pane. You can open
or close the folders, to view or hide their contents.
When you open the folder you will see the icon for an application. You can
expand any icon with subordinate icons to display them also.
When you select an icon in the left pane, one or more of its records or files
display in the right pane. You control what the list displays including the:
GFK-1180H
Files or records
You can access many of the Workbenchs Power Tools on its tool bar. In
addition, you will find them in its menus, both on the menu bar, and popup
menus.
2-3
Tip: Place the cursor over any object in the Workbench to display a brief description
of what it does.
The status bar provides you with information that includes how many records are
retrieved, if the project is running, and if a specified task has been completed.
2.
Select New.
3.
Select Window.
When the Workbench is open on more than one screen you can keep your screen upto-date by refreshing the window.
To refresh the Workbench window:
Method 1
Press F5.
Method 2
2-4
1.
2.
Select Refresh.
GFK-1180H
Simple lists
Large icons
Click to
expand the tree
Click to
collapse the tree
GFK-1180H
1.
2.
2-5
Large icons
2.
Large Icons
List
Details
Tree
Method 2
Press the standard Windows NT and 95/98 button on the Workbench toolbar.
From left to right: List, Detail, Large
Icons and Tree View
The right pane view changes to reflect your choice.
2-6
GFK-1180H
Large Icon
Tree
In addition, you will find several tools to help you specify the required records or
files.
Note: Whether you view a list of records or of files depends on the icon you select in
the left pane.
For example, if you select Points in the left pane, you will view a list of records in
the right. If you select Screens in the left, you will view a list of files in the right.
GFK-1180H
2-7
2.
CIMPLICITY HMI displays a list of all the existing records or files for the
selected icon when you use either method.
Note: Whether you view a list of records or of files depends on the icon you select in
the left pane.
For example, if you select Points in the left pane, you will view a list of records in
the right. If you select Screens in the left, you will view a list of files in the right.
To view selected records (or files) for a selected icon:
1.
2.
The Search dialog box associated with the selected icon appears.
2-8
GFK-1180H
3.
Opens a Browser
window
Enter the name or associated information for the record(s) or file that you
want to display. What format the information (records, files) is in depends
on what you select in the left pane.
The records or files you specify will display in the right pane until you change
your specifications.
Alarms
Devices
Points
Ports
Roles
Resources
Users
Workbenchs Explore tool for all search windows that request a file name
GFK-1180H
2-9
A Windows NT and 95/98 Explorer window opens and displays the open
projects directory.
2-10
GFK-1180H
4. Use the Windows NT and 95/98 Explorer to find the type of files you are
looking for.
A. Open the folder with the file you are looking for. For
example, open the Screens folder for CimEdit files.
B. Select the file to include in the Workbenchs list.
5. Place the Windows NT and 95/98 Explorer window next to the Workbench.
6. Open the Search dialog box.
7. Type the name of the file in the Filename field.
The appropriate entry appears in the right pane of the Workbench.
2.
Use any of the following methods to open the Field Chooser dialog box.
Method 1
A. Click the right mouse button in the right pane.
C. Select Field Chooser from the popup menu.
Popup
GFK-1180H
2-11
Method 2
A. Select View on the Workbench menu bar.
C. Select Field Chooser.
View Drop Down Menu
Method 3
Press the Field Chooser button
The appropriate Field Chooser dialog box opens when you use any of these
methods.
Step 2: Select the fields to display (or remove from display) in the
Workbench right pane.
Example: Three Field Chooser Dialog Boxes
Field Choosers for:
Users
Devices
Points
2-12
GFK-1180H
3.
Select a field in the Available field column that you want to add to your
display.
4.
Press Add. The field will move over to the Display fields column.
4.
Select any field in the Display fields column that you do not want to display.
5.
Press Remove. The field will move over to the Available field column.
6.
Use the Move Up and Move Down buttons change a selected fields place in
the list.
7.
Up
Down
Right of the fields above it
Press OK. The fields display from left to right in the order you specified.
Note: The Remove button will be disabled if the field is required. The Move
Down or Move Up button will be disabled if a field that will be affected by the
move has to appear in the furthest left position.
GFK-1180H
2-13
Project Status
You can easily open, start, stop and do dynamic configuration for any of several
projects through the CIMPLICITY HMI Workbench.
The following procedures deal with these tasks:
Open a project
2-14
2.
Select New.
3.
Select Project.
GFK-1180H
Enter a unique
project name
Selected options
display in the
Configuration
Cabinet
4.
Open Network
configuration dialog
box
5.
6.
7.
Press Create.
GFK-1180H
2-15
2.
Select Open.
3.
Select Project.
Method 2
1.
2.
2-16
GFK-1180H
1. Select the
project folder
2. Select the
.GEF file
GFK-1180H
1.
Select the folder that contains the project you want to open.
2.
3.
2-17
Configure new points for the devices in your system / remove points from
your system
2.
3.
Method 2
Press Ctrl+W on the keyboard.
The Project Wizard opens when you use either method. Follow the steps you need
to configure. At any point when you are finished, press Finish.
2-18
GFK-1180H
GFK-1180H
2-19
Method 2
1.
2.
Select Run.
Method 3
Press Ctrl+R on the keyboard.
Method 4
1.
2.
Press R.
Press OK.
The project starts running when you use any of these methods.
2.
3.
Select a project
2-20
GFK-1180H
2.
Select Stop.
Method 3
1.
2.
Press S.
Dynamic Configuration
2.
Open the Field Chooser dialog box. See Right Pane Field Selection in this
chapter.
GFK-1180H
2-21
3.
4.
To do a configuration update:
Method 1
1.
2.
Method 2
1.
2.
Press C.
Dynamic Configuration
If your user role has been assigned the option, dynamic update option is an efficient
way to make certain changes in project and have the project automatically updated.
The Workbench provides you with:
2-22
GFK-1180H
Point Configuration
Cannot change:
Port Configuration
Remote Projects
Retry count
To do dynamic configuration:
Method 1
Method 2
1.
2.
Select Dynamic.
Method 3
1.
2.
Press D.
If a password is required a password dialog box will open when you use any of these
methods. If a password is not required or if you enter the correct password, you will
be able to dynamically configure the project.
When you activate Dynamic Configuration, CIMPLICITY HMI updates your
projects configuration automatically. You dont have to return to the Workbench and
do a project update in order for your changes to take affect.
GFK-1180H
2-23
What Opens
Screens
A new screen
The following:
2-24
Script
Script window
Notepad
Microsoft Excel
Scripts
Microsoft Access
Options
GFK-1180H
2.
GFK-1180H
2-25
Method 3
A. Press ALT+F.
The drop down File menu opens.
B. Press N.
C. Press O.
Method 3
Press Ctrl+N on the keyboard.
A new screen or appropriate new dialog box opens when
you use any of these methods.
Tip: If you want to use only the keyboard, you can also press the Arrow Up and/or
Arrow Down key to select the icon in the left pane of the Workbench.
2.
Method 1
Press Alt+Enter on the keyboard.
Method 2
2-26
3.
4.
Select Properties.
GFK-1180H
Method 3
3.
Press Alt+E.
4.
Select Properties.
Method 4
3.
4.
To display
Edit
Screens
CimEdit screen
Properties
Points
Devices
Ports
Users
Roles
Resources
Measurement Units
Event Editor
Open
Script
Script window
Notepad
Microsoft Excel
Database Logger
Microsoft Access
Action Calendar
Action Calendar
Popups
GFK-1180H
2-27
Runtime Access
The Workbench provides you with access to all of CIMPLICITY HMI runtime
monitoring tools.
This includes letting you
Review the status of a selected point from several different vantage points,
including a:
Point Control panel. When it is opened you can deal
with it the same way you would any open Point
Control Panel when it is opened.
Take advantage of its drag and drop capability by opening a Point Control
Panel and dragging and dropping selected points from the Workbench to
monitor in the panel.
Open the associated window for any runtime monitoring tools, including:
2-28
GFK-1180H
Make sure your project is running. See Starting a CIMPLICITY HMI Project
earlier in this chapter.
2.
3.
4.
GFK-1180H
2-29
Method 3
A. Click the right mouse button.
B. Select Open from the popup menu.
Method 4
Press Crt+O on the keyboard.
The CimView screen you selected opens when you use any method.
Alarm Viewer
Login Panel
Show Users
Select the runtime icon in the left pane that you want to monitor.
2.
Double click it or use any of the other methods available to open a runtime
window. See Opening the CimView Screen in this chapter.
The icons window opens displaying the data from the project that was
opened last.
3.
2-30
Review the information or change the project through the windows File
menu.
GFK-1180H
Point Control panel that displays the selected point (if you have user access).
Once opened, you can deal with it the same as you would any open Point
Control Panel.
CimView screen which was selected in the Point Properties dialog box.
Quick Trend
GFK-1180H
2-31
2.
3.
4.
Quick Trends
*.cim screens
2.
3.
4.
Hold the mouse button down and drag the selected items into the blank
window.
If any of the dragged items already exist in the open window, the Workbench
displays a message and does not duplicate them.
5.
2-32
GFK-1180H
Example: Dragging Points from the Configuration Cabinet into an Open Control Panel
2
Select points in the Configuration Cabinet.
Drag them into the Point Control panel
GFK-1180H
2-33
The project creation procedure displays a series of dialog boxes that let you:
When the creation procedure is complete, select Install from the File menu to install
the project in a folder.
GFK-1180H
3-1
Project Name
New Subdirectory
Options
Protocols
Project Path
When you have entered your information, select Create... to create the new project or
select Cancel to cancel the create request.
When you select Create..., the Workbench for the project is created, and the Project
Properties dialog box opens to display the Options properties.
3-2
GFK-1180H
Opening a Project
When you select a CIMPLICITY projects shortcut menu option from the Start
menu, the CIMPLICITY Workbench for the project opens.
You can use the menu options in the Workbench to create a new project, open a
project, delete a project, display project settings, start/stop a project, update project
configuration, open the Project Wizard, enable/disable the Toolbar and Status bar,
enable/disable dynamic configuration update, open an MS-DOS window, display
status logs, start configuration functions, and display Help information.
GFK-1180H
3-3
Open
Copy Project
Dynamic
Stop
Run
Configuration Update
Settings
Project Wizard
3-4
Ctrl+N
Ctrl+O
Ctrl+C
Ctrl+R
Ctrl+W
Ctrl+L
Alt+Spacebar
Alt+F4
Ctrl+Esc
GFK-1180H
Create a new project, and you select Create... from the New Project
dialog box.
Use the Project Properties dialog box to choose or change general properties and
options for a project.
After you have modified the properties, you can select OK to accept the
modifications, or select Cancel to close the Project Properties dialog box without
accepting any changes.
General Properties
GFK-1180H
Project Type
Project 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
3-5
Options Properties
Computer name
Startup timeout
3-6
GFK-1180H
Create a new project, and you select OK from the Program Groups
dialog box.
You can use the Project Wizard to define ports, devices, and points for a project.
Select Close to close the Project Wizard and make no further changes.
Select Finish to close the Project Wizard and accept all changes.
Select the protocol you want to select from the Available Protocols list.
2.
Select Add->.
The New Port dialog box opens for the port you are adding. For more information
on adding a port, see Creating A New Port.
GFK-1180H
3-7
Removing A Port
Note
You will not be allowed to delete a port unless all points and devices for that port
have been deleted.
To remove a currently configured port from the project configuration:
1.
Select the port you want to delete from the Configured Ports list.
2.
Select Remove. You will be asked if you want to delete the selected
object.
3.
Modifying A Port
To modify a currently configured port:
1.
Select the port you want to modify from the Configured Ports list.
2.
Select Modify.
The Port Properties dialog box for the selected port opens. For more information on
modifying port properties, see the Port Properties for the particular protocol you
selected.
3-8
Select Close to close the Project Wizard and make no further changes.
Select Finish to close the Project Wizard and accept all changes.
GFK-1180H
Select the port you want to select from the Available Protocols list.
2.
Select Add->.
The New Device dialog box opens for the device you are adding. For more
information on adding a device, see Creating A New Device.
Removing A Device
Note
You will not be allowed to delete a device unless all points for that device have been
deleted.
To remove a currently configured device from the project configuration:
1.
Select the device you want to delete from the Configured Devices list.
2.
Select Remove. You will be asked if you want to delete the selected
object.
3.
Modifying A Device
To modify a currently configured device for the project:
1.
Select the port you want to modify from the Configured Ports list.
2.
Select Modify.
The Device Properties dialog box for the selected device opens. For more
information on modifying device properties, see the Device Properties for the
particular protocol you selected.
GFK-1180H
3-9
Select Close to close the Project Wizard and make no further changes.
Select Finish to close the Project Wizard and accept all changes.
Select the device you want to select from the Available Devices list.
2.
Select Add->.
The New Point dialog box opens for the point you are adding. For more information
on adding a device, see Creating A New Point.
Removing A Point
To remove a currently configured point from the project configuration:
1.
Select the point you want to delete from the Configured Points list.
2.
Select Remove. You will be asked if you want to delete the selected
object.
3.
Modifying A Point
To modify a currently configured point for the project:
1.
Select the point you want to modify from the Configured Ports list.
2.
Select Modify.
The Point Properties dialog box for the selected point opens. For more information
on modifying point properties, see Creating A New Point.
3-10
GFK-1180H
Installing A Project
Once you create a project, you will want to install it in a folder for easy access. In
the Workbench for your project:
1.
2.
Select Install.
The Create Shortcut dialog box opens and lets you select the folder where you want
to install the shortcut to the project.
Select the folder where you want to place the shortcut. You can also use the New
Folder... button to create a new folder for the shortcut.
GFK-1180H
3-11
Use the Projects property page to display, start, and stop projects on a computer.
3-12
GFK-1180H
When you open the CIMPLICITY Options dialog box, it is connected to your
computer and shows you the currently running projects as well as the projects
available for running.
You can:
Start as a Viewer.
Start as a Viewer
To start as a Viewer, select Start Viewer.
Click the drop-down list button to the right of the Computer Name
field.
2.
Select the computer you want to connect to from the list of computers
that are currently running CIMPLICITY software.
If the computer name does not appear in the list, you can type it in the
Computer Name field (the computer name is not visible if no projects
are running).
3.
Select Connect.
The projects that are currently running on that computer are displayed in the Running
Projects field.
2.
3.
Select Yes to confirm that you want to proceed with the shutdown.
After the project is halted, the project is removed from the Running projects list.
GFK-1180H
3-13
2.
Use the Open dialog box to search for the project (.gef) file you want.
When you find it, select OK.
2.
Select Start.
3.
The project you select is started. When startup is complete, the project name is listed
in the Running projects list.
3-14
GFK-1180H
Network Options
You can select one of the following options:
Stand alone
Accept connections
Use this dialog box to browse for projects to add to the list of projects to be started at
system boot. When you locate a project, select OK to add it to the list and close the
CIMPLICITY Default Project dialog box. Select Cancel to close the dialog box
without selecting a project.
To delete a project from the list, select the project, and then select Delete. The
project is removed from the list.
You can also select the one of the following:
GFK-1180H
None
Select this option if you do not want any of the projects in the
list to start at system boot.
Start as viewer
Select this option if you want to start a Viewer (that is, only
start the Router) on this computer when the computer reboots.
Start at boot
3-15
3-16
1.
2.
Open the Control Panel and select the Passwords icon. The Passwords
Properties dialog box opens.
GFK-1180H
GFK-1180H
3.
4.
Enter the old Password (or leave it blank if you never entered a
password). Leave the New Password and Confirm New Password
fields blank, and select OK. The Change Windows Password dialog
box closes.
5.
6.
Select the Network icon in the Control Panel. The Network properties
dialog box opens.
7.
8.
Select OK. You are prompted to reboot your system so that changes
will take effect. After you have rebooted, you will no longer be
prompted to log on.
3-17
2.
In the Network Options box, select whether you want to start a standalone project, or accept connections from other projects in your
enterprise.
3.
3-18
GFK-1180H
C. Enter the starting CimView screen in the Screen field. You can
also select Browse to the right of this field to search for the screen
you want.
D. Set the Start at boot field if you want the CimView screen to be
started automatically when the system boots.
E. Set the following check boxes as needed to define the screens
startup options:
Always Maximized
This option always maximizes the initial window to fill
the users terminal screen.
The user cannot resize the primary window, and the
window will not rise to the top when a user clicks on it
(this prevents it from obscuring other windows on the
terminal screen).
No Exit
This option does not let the user exit the primary
CimView window.
The Exit menu item is removed from the File menu, and
the Close menu item and Alt+F4 shortcut key are
removed from the Control menu. In addition, the Close
Screen action is ignored in the primary window.
Keypad
This option opens the popup keypad whenever the user
needs to enter data for Variable setpoints.
This option is required for systems with no keyboard or
keypad.
Zoom to Best Fit
This option sizes the CimView screen to best fit the
window in which it is displayed.
No Menu/Title
This option removes the Menu and Title bars from the
primary CimView window and all subsequent windows.
GFK-1180H
3-19
No Open
This option prevents users from opening CimView
screens not explicitly identified in Open Screen or
Overlay Screen procedures.
Open and Open Window menu items are removed from
the File menu and the File Open toolbar button is
disabled.
No Resize
This option prevents users from resizing CimView
windows that are displayed.
Captive Mode
This option displays the primary CimView window in
captive state. When the use opens this CimView
screen, the Explorer shuts down. Other screens are
displayed on top of the primary window and the user
will not be able to go below the primary window.
Touch Active
Keeps CimView screens currently being displayed
swapped in. Without this flag, only documents in the
cache are touched periodically to keep them swapped
into memory.
Touch Dynamic
Keeps CimView screens with many dynamic objects
swapped into memory.
Touch Static
Keeps CimView screens with many static objects
swapped into memory.
No Point Targets
Prevents the point target, e.g. point control panel and
quick trends, from being available from point view or
the right mouse menu
For more information about these options, see the CIMPLICITY
HMI for Windows NT and Windows 98/95 CimEdit Operation
Manual (GFK-1396).
F.
If you want to pre-load the screen cache with selected files, enter
the name of the cache file in the Cache File field. You can also
select Browse to the right of this field to search for the cache file
you want.
3-20
GFK-1180H
Whats Running
A CIMPLICITY project has two layers of programs:
User Application
Resident Process
The User Application layer consists of the Alarm Viewer, CimView, CimEdit,
and CWSERV programs. These programs are started by user request and remain
running until the user exits them.
The Resident Process layer consists of a set of programs that are started when you
start your CIMPLICITY project, and that remain running until your CIMPLICITY
project is shut down.
If you are on a Server, the Resident Process layer consists of such programs as the
Router, device drivers, Point Management, Point Data Logger, Alarm Management
Resident Process.
If you are on a Viewer, the only process running in the Resident Process layer is the
Router.
GFK-1180H
3-21
2.
Select Configuration Update from the Project menu for the project
or click the Configuration Update button on the Toolbar. Note that
the menu option and Toolbar button are disabled if the project is
running.
3.
Dynamic Update
The Dynamic Update option is available only if your user role has been assigned that
option.
If you have permission to use Dynamic Update, you can enable or disable Dynamic
Update from your project, or from individual configuration functions by either of the
following methods:
3-22
GFK-1180H
Point Configuration
If you are modifying a point in Dynamic Update mode, you cannot change:
Port Configuration
In Dynamic Update mode, you may only modify:
Retry count
Remote Projects
You cannot create or modify remote projects in Dynamic Update mode.
GFK-1180H
3-23
Logging In
Two levels of logins are available when you use CIMPLICITY software.
1.
2.
You have a great deal of flexibility in determining when and how users will log in to
CIMPLICITY software. The basic rules are:
After a user exits all open CIMPLICITY applications, the login remains
active for a certain period of time (determined by the CIMPLICITY
system manager). If a user opens a CIMPLICITY application during
this period of time, the user will not need to log in and the previous
username and password remain active. If a user opens a CIMPLICITY
application after this period of time expires, the user will have to log in
again.
When you log in to CIMPLICITY software, you will be asked for a username and
password, and whether you want to save the username and password for future
logins. If you are on a Viewer, and are connecting to a project on another
CIMPLICITY for Windows NT computer in your network, you will also be asked if
you want to automatically connect to the selected project whenever the Viewer is
rebooted.
If you set the Save Username + Password check box, whenever you select any
documents in the project, you will automatically be logged in to the project with the
saved username and password.
If you set the Reconnect at Startup check box, you are automatically connected
to the project used by the document whenever CIMPLICITY software is started on
your computer.
3-24
GFK-1180H
If you are creating operator Help files for alarms, put them in this
directory.
arc
If you are using the Database Logger option, archive files are put
in this directory.
data
lock
log
All status log files, and program error files reside in this directory.
master
screens
scripts
All Basic Control Engine scripts for this project reside in this
directory by default.
Using the Windows Explorer, locate the project directory for the
project you want to back up.
2.
To save space on your diskette, you should delete all log files from the
projects \log directory before making the backup.
If the project is running, some files in this directory may be locked and
will not be deleted.
3.
This method works well for small projects. For large projects, consider zipping the
project and saving the zipped file or backing up the project directories to tape rather
than diskette.
GFK-1180H
3-25
3-26
GFK-1180H
Understanding Points
About Points
CIMPLICTIY HMI collects or calculates point data which it distributes to:
CimView screens
Alarm printers
Logging tables
The collection and distribution of point data is handled by the Point Management subsystem.
Its primary functions are to:
Note: You can limit a users ability to set point to only those points whose resources are in
the users view. See "Setpoint Security" in this chapter for more information.
GFK-1180H
4-1
Categorizing Points
CIMPLICITY HMI provides you with the tools to configure any point to exactly your
specifications. Even though there are several options during configuration, your starting
choices for any given point are very simple.
The point value:
Point Class
Points can be one of three classifications. You select the class based on how the point will be
used. The point classes are:
4-2
Boolean
Text
GFK-1180H
Naming Points
Each point you create in your project has a unique Point ID. A Point ID may contain:
Up to 32 characters
There are some reserved words and reserved characters, which you are better off not using. If
you decide to use reserved words or characters for a Point ID:
You must enclose the Point ID in single quotes when you use it in an expression or
equation.
File names for Alarm Help files will be difficult to correlate to Point IDs. These file
names are usually automatically generated by CIMPLICITY software and are based
on the Point/Alarm ID.
GFK-1180H
Understanding Points
4-3
Reserved Characters
Guidelines for reserved characters in Point IDs include:
Do not use
| $
Brackets ( [ ] )
Avoid using
Use carefully
Use freely
4-4
GFK-1180H
Setpoint Security
You can limit a users ability to set points to only those points whose resources are in
the users view. You do this in the Project Properties dialog box.
2.
Select Properties.
Method 2
1.
2.
Press P.
The Point Setup dialog box opens when you use either method.
GFK-1180H
Understanding Points
4-5
(Optional) Select Set Point Security to enable Set Point Security for all users who
access your project.
If Set Point Security is enabled a user can perform setpoints on only those points
whose resources are in the users view.
Example
RESOURCE_1 is an authorized resource for USER_X.
2.
If:
Then:
If :
Then:
USER_X cannot perform setpoints on POINT_A.
(Optional) Configure Enable Setpoint Password to restrict access to the setpoint
functions. The CIMPLICITY HMI default is unrestricted access.
A. Select Set Point Password.
B. Enter the password that will be used to perform setpoint
actions in the Password input field.
C. Re-enter the password in the Confirm Password input field
to confirm it.
4-6
GFK-1180H
2.
3.
4.
Note: These procedures are meant to help you quickly set up a device. Other chapters in the
CIMPLICITY HMI Base Users Manual provide depth descriptions of each part of the
process.
GFK-1180H
5-1
F1
BATT.
F2
M SG .
ESC
F1
XFER
SRCH
RUN
STO P
SET
ABC
4
JKL
DEF
5
M NO
STU
VWX
+/
F2
v
SW1
M O N SW3
O
R
9
G HI
6
PQ R
3
YZ-
ENTER
SW 5
SW 2
SW 4
SW 6
SW 7
SW 8
SW 9
SW 10
SW 1 1
SW 12
SW13 SW14
O N / O FF
IBM Compatible
4. Configure a
device point.
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.
2.
Select Properties.
The Project dialog box opens.
3.
5-2
GFK-1180H
4.
Scroll up and/or down in the Protocols box to find the protocol that will be used.
5.
Note: If the protocol does not appear in the Protocol box, use the CIMPLICITY HMI
installation CD to add the protocol.
You can also quickly add a device to a project in two to four steps.
Step 1: Open the New Device dialog box.
Step 2: Select a protocol for the devices port. (If a port doesnt already exist.)
Step 3: Configure the devices port. (If a port doesnt already exist.)
Step 4: Configure the device.
GFK-1180H
5-3
2.
3.
Open the New Device dialog box. Two of the several methods are:
Method 1Using the mouse
Double click the left mouse button.
Method 2Using the keyboard
Click Ctrl+N on the keyboard.
The New Device dialog box opens.
4.
5.
5-4
GFK-1180H
1.
2.
Select New.
The New Port dialog box appears.
3.
4.
Select another port, if the one that appears is not the one you want.
5.
Click OK.
The Port Properties dialog box opens.
GFK-1180H
5-5
2.
3.
Enter the interval length between scans in the Scan Rate field. The time type options
are:
Seconds
Minutes
Hours
Enter the number of times CIMPLICITY HMI should retry scanning the device if a
communications error is encountered in the Retry Count field.
If communications cannot be established, devices on this port are considered to be
down, and a $DEVICE_DOWN alarm is generated for each device.
Once a device is down, periodic attempts are made to resume communications to the
device.
4.
5.
Click OK.
A filled in New Device dialog box appears.
5-6
GFK-1180H
1.
Click OK when the New Device dialog box has the device and port filled in.
The Device dialog box appears.
Example: Device PropertiesDialog Box with TCP/IP Protocol
Protocol tab depends on selected protocol
$SYSTEM
$MAC_FR
$PTM_FR
Included in
CIMPLICITY HMI
2.
3.
GFK-1180H
4.
Select the type of device from the Model Type drop-down list. The list of available
model types depends on the protocol.
5.
5-7
6.
7.
Either:
Now you can configure device points that collect data from and/or send data to the device that
is now enabled in your CIMPLICITY HMI project. See the "Configuring Device Points" chapter
in this manual.
5-8
GFK-1180H
2.
3.
4.
Configure alarms
This chapter provides information for 1-4. See the Configuring Point Limits, Views and Alarms
chapter in this manual to do the configuration listed in 4.
Note: CIMPLICITY HMI provides you with a Manual Mode feature that enables a user to
disconnect a points values from a device and set them manually. See the "Device Point Quality
Support at Runtime" section in this chapter for details about this feature.
GFK-1180H
6-1
Point type
2.
Method 2
1.
2.
Select File.
3.
Select New.
4.
Select Object.
Method 3
1.
2.
Method 4
1.
2.
3.
The New Point dialog box opens when you use any method.
New Device point
Device name
6-2
Device popup
Device browser
GFK-1180H
4.
5.
6.
7.
8.
Analog
Boolean
Text
Press OK.
Note: Values read from or written to a device point will be forced into the specified type.
Example
Reading an SINT point value, which is 8-bits, from a 16-bit register will truncate the high
order byte, and the sign will not be maintained.
Writing an INT point, which is 16-bits, to an 8-bit register will do the same.
To enter general basic information for a device point:
GFK-1180H
1.
2.
Displays when you position the cursor over the point in the
Workbench
Can be entered in the Point browser when you want to find and
display or use the point
6-3
3.
Select one Data Type from the drop down list that appears for the point type you
selected:
Analog Points
General TabBasic ViewAnalog Point
w DINT
w INT
w REAL
w SINT
w UDINT
w UINT
w USINT
w 3D_BCD
w 4D_BCD
Array=
More than 1
Check to prohibit
setpoint use
DINT
INT
REAL
Floating-point numbers.
SINT
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.
6-4
GFK-1180H
Boolean Points
BOOL
BYTE
8-bits of data
WORD
16 bits of data
DWORD
32 bits of data
Text Points
General TabBasic ViewText Point
w STRING
w STRING_20
w STRING_8
w STRING_80
4.
Array=
More than 1
Check to prohibit
setpoint use
STRING
A one-character alphanumeric
STRING_20
STRING_8
STRING_80
Enter:
5.
GFK-1180H
Check the Read Only check box to prohibit the ability to use the point as a setpoint.
6-5
Using Arrays
CIMPLICITY software lets you define single points and array points. Using array points is
one way to provide more efficient data collection. An array point can represent one instance
of several process variables, or several instances of one process variable.
Note: You specify an array in the Point Properties dialog box, General tab, Element field.
Important: Array points are not supported by all CIMPLICITY software functions. Support
for array points is as follows:
6-6
CimEdit
CimView
Alarm Viewer
Database Logger
GFK-1180H
Maximum size
Virtual
1600 bytes
CCM2
250 bytes
Genius datagram
128 bytes
Series 90 TCP/IP
950 bytes
200 bytes
Allen-Bradley Communications
1000 bytes
1000 bytes
Applicom
250 bytes
DDE
1000 bytes
FloPro/FloNet
240 bytes
Johnson Controls N2
16 bytes
1000 bytes
Mitsubishi TCP/IP
512 bytes
Modbus Plus
1000 bytes
Modbus RTU
1000 bytes
Modbus TCP/IP
512 bytes
1000 bytes
OMRON TCP/IP
1000 bytes
Seriplex
480 bytes
Sharp TCP/IP
1000 bytes
Siemens TI
250 bytes
250 bytes
Square D SY/MAX
250 bytes
The Smarteye and DDE Client protocols do not support array points.
Values read from or written to a device point are forced into the correct type of the point.
This may affect the array size. For example, if you have defined an analog point with type
INT for a point on a CCM2 device in Register memory, the maximum array size will be 125
elements because each point in the array is put into a separate 16-bit register. Check the
appropriate Device Communications documentation for further information.
GFK-1180H
6-7
Note: Addressing is used for most GE Fanuc device communications options, and for devices
created via the Device Communications Toolkit API that use custom addressing.
This section describes criteria for customized addressing. There is another type of addressing,
standard addressing. However, it is rarely used. For further information on addressing for the
protocol and device, see the CIMPLICITY HMI for Windows NT and Windows 95 Device
Communications Manual (GFK-1181).
Boolean
points only
Entry depends on
protocol
Availability depends on
protocol:
On Change
On Scan
On Demand On Scan
On Demand On Change
Unsolicited
Poll Once
2.
6-8
Enter the Address that is consistent with the selected protocol. For further
information on addressing for the protocol and device, see the CIMPLICITY HMI for
Windows NT and Windows 95 Device Communications Manual (GFK-1181).
GFK-1180H
3.
(For Boolean points only) Enter an Address Offset (bit offset) if the first bit of the
points data is not the first bit of the address. Address offsets start at 0, which is the
least significant bit.
Example
A digital point is located in the third (3rd) bit of Register 5 on a Series 90-70
The Address is "%R5"
4.
Specify the Update Criteria when data for the point is passed from the device
communications processor to the point database. Available selections depend on the
protocol you are using.
Point is updated when
On Change (Default
Data Collected:
At a regular interval.
The interval equals the base scan rate for the port on
which the device is located multiplied by the scan rate
for the point.
Value Updated:
On Scan
Data Collected:
At a regular interval.
The interval equals the base scan rate for the port on
which the device is located multiplied by the scan rate
for the point.
Value Updated:
On Demand On Scan
GFK-1180H
Data Collected:
Value Updated:
6-9
On Demand On Change
Data Collected:
Value Updated:
Unsolicited
Value Updated:
Unsolicited On Change
Value Updated:
Poll Once
Data Collected:
6-10
GFK-1180H
Responses
Retries
Failures
Device status
Current device state
Each device communication enabler may also provide protocol-specific data.
Note: Diagnostic points are not available for the Point Bridge.
To view diagnostic data, configure device points that correspond to the diagnostic locations in
the enabler. These diagnostic points are like device data points in all ways, except that they
are always available when the enabler is running (points containing device data are
unavailable if communication with the device fails). Diagnostic points may be scanned at any
appropriate multiple of the ports base scan rate, displayed in CimView screens, trended,
logged, alarmed, etc.
Important: You cannot write to diagnostic points. Always configure them for Read access.
GFK-1180H
6-11
2.
Enter one of the following values as the text address of the diagnostic data in the
Address field.
Address
$TRANSMISSIONS
$RESPONSES
$FAILURES
$RETRIES
$DEVICE_DOWN
$DEVICE_UP
Data Type
UDINT
UDINT
UDINT
UDINT
BOOL
BOOL
Description
Number of messages sent
Number of messages received
Number of communication failures
Number of retries
Device up status
Device down status
6-12
1.
Select the Domain Type that represents the type of device memory from which the
point is coming.
2.
Enter the starting address for the point in the Domain Offset field. The address
depends on the addressing conventions for the individual device.
3.
(Active only for Bool points) Enter Bit Offset if the first bit of the points data is
not the first bit of the address. Address offsets start at "0", and are numbered from
right to left.
4.
GFK-1180H
This section describes what to enter for these advanced device point specifications.
See "Setting Point Limits and Alarms" in this manual for information on how to enter the advanced
specifications that unleash the spectrum of CIMPLICITY HMI monitoring powers.
Configure alarms
Enabling the point or associated alarm See "Setting Point Limits and Alarms" in this
chapter for information about configuring an alarm.
GFK-1180H
6-13
The available selections on the General tab depend on what point type you are configuring.
The following procedure begins with entries for any point type and continues through entries
for the analog/Boolean point types only.
6-14
GFK-1180H
Enable Point
Enable Alarm
Enable Enterprise
3.
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
Available and
evaluates to a non-zero value
Permitted
Available and
evaluates to zero
Not permitted
Unavailable
Not permitted
GFK-1180H
6-15
Availability Triggers
An Availability Trigger determines the validity of the point you are configuring and provides
a "device healthy" signal for points that are tied to intermediate devices during runtime. You
can select an Availability Trigger on the General tab of the Point Properties dialog box
At runtime if the:
Availability Trigger
Configured Point is
Available
Evaluates to zero
Unavailable
Trend History
For Analog and Boolean points on the General tab of the Point Properties dialog box
CIMPLICITY HMI can compile a trend history for analog and Boolean points. All you have
to do is specify the amount of time that data should be retained and the maximum number of
samples that should be included.
To make specifications for trending data:
Enter the Trend History specifications for checked Max Duration and/or Max Count
check boxes to have CIMPLICITY HMI save information as follows.
Max Duration
Max Count
The number of n values to be saved
You may select either option, or both. If you select both, the Max Count takes
precedence over Max Duration in determining the number of values saved in the
buffer..
6-16
GFK-1180H
Point buffering lets you allocate a buffer for a point and save a number of the most
recent values. This feature is currently being supported only for the Trending option.
Example:
Point ABC is scanned every 5 seconds
If you define a:
Max Duration of 1 minute, the buffer contains the 12 most recent values for
ABC at any given time.
Max Count of 10, the buffer contains the 10 most recent values (that is, the
values for the last 50 seconds).
Max Duration and Max Count, the buffer contains the 10 most recent values.
Note: Point buffering is not supported for Enterprise Server points.
Check the Log Data and/or Log Alarm check boxes in the Logging box.
2.
3.
Select the table to which the data will be logged. See the "Database Logger" chapter in
this manual for information about configuring log tables.
GFK-1180H
6-17
Trigger settings
Scan rate
Analog deadband
Important: Domains for programmable controllers in CIMPLICITY HMI software are sized
when the project starts. If you dynamically reconfigure domain sizes on the programmable
controller, you must restart the project to access points at the new domain offsets.
6-18
GFK-1180H
If the update needs to be hourly, but the device is being scanned every quarter hour
for other purposes:
Use a device Trigger Point that is configured with a one-hour scan rate. See "On
Scan" in the "Configuring Device Points" chapter in this manual.
Enter the Point ID, in the Trigger Point field, of the device point that serves as the
trigger for this point. The Trigger Point must be on the same device as the point
you are defining.
Select a Point
Point popup
browser
2.
None
Equal
Greater Than
Greater Than Equal
Less Than Equal
Less Than
On Change
Select, in the Relation field, how the trigger point will be evaluated.
Your choices are:
GFK-1180H
Choice
None
Equal
Equals Value.
Greater Than
Less Than
6-19
3.
On Change
Whenever the Trigger Point is changed.
Enter the Value the Trigger Point will be compared with to determine if the trigger
condition has been met.
The trigger condition is evaluated each time the trigger point is polled, so effectively, this
point is polled at the trigger points scan rate while the trigger condition is true.
Scan Rate
Enter the frequency at which the CIMPLICITY device communications option will read this
points data, based on the ports Base Rate.
The Base Rate is the minimum rate at which device points can be polled on the port. The
Scan Rate is a multiple of the Base Rate.
Example
The Base Rate is 5 seconds
The Scan Rate is set to "3"
The point is scanned every 15 seconds.
When you define Trigger Settings for a point, enter 0 (zero) in the Scan Rate field.
Analog Deadband
An Analog Deadband filters out changes in the raw value of this point. The raw value must
change by at least this value before the point value is updated in the CIMPLICITY point
database.
Therefore, the Analog Deadband can make CIMPLICITY software ignore small fluctuations
in the value of a point. For example, if you have a point ranging from 0 to 10,000, and you
enter 5 in this field, any point fluctuations of less than 5 are ignored.
Check
Clear
Important: The Point Bridge does not support Poll After Set. If you are defining a Point
Bridge point, clear this check box.
6-20
GFK-1180H
The trigger point must be on the same port as the points it is triggering. The points
may be on different devices, but the devices must be on the same port.
Make the system more efficient by reducing the amount of data that needs to be
managed by the data collection functions.
The Update Criteria for the trigger point determines when triggered reads take place. The
criteria can either be when the trigger point value changes or when it is scanned.
GFK-1180H
6-21
6-22
GFK-1180H
Option 2: Update Criteria for D1 is set to On Scan, and A1 is configured so that it is a triggered
point that will be read when D1 is HIGH, CIMPLICITY HMI reads:
A1 as follows:
In other words, CIMPLICITY HMI reads A1 at the 3, 6, 15, 18, and 24 second marks because
the value of D1 was HIGH at those times.
GFK-1180H
6-23
Option 3: When the Update Criteria for D1 is set to On Change, the values for A1 will vary as
follows:
In other words, CIMPLICITY HMI reads A1 at the 3, 15, and 24 second marks, because they
are the only places where the scanned value of D1 transitions from LOW to HIGH. Note that
any transitions that occur between scans (such as those between the 15 and 18 second marks)
do not count.
At run-time, PLC1 will only be updated while the point PLC1_READY is equal to 1.
6-24
GFK-1180H
The trigger settings and scan rate for each of the digital points should be configured as
follows:
If the trigger point (ANA_INP_20) does not change frequently, this gives a performance
benefit, because the digital points will only be updated when the analog point changes.
GFK-1180H
6-25
Point Conversions
CIMPLICITY HMI software lets you select the base engineering units for an analog device
point and then specify a linear or custom conversion. You do this on the Conversion tab that
appears in the Advanced General tab group.
6-26
1.
2.
Select the Conversion tab that appears if you are configuring an analog point.
GFK-1180H
Click the Popup Menu button to the right of the Unit field.
2.
Select the name of the base engineering units from the list of available measurement
units. When you do this, the label for the unit is automatically put in the Label field.
Method 2
Click the Browser button to the right of the Unit field to find the measurement unit in the
Select A Measurement Unit Browser
GFK-1180H
6-27
Method 3
1.
Click the Pop-up Menu button to the right of the Unit field.
2.
Select New.
The New Measurement dialog box opens.
3.
4.
5.
Enter the label that will appear when the measurement unit is selected.
6.
Press Apply.
The new unit is added to the list of available units.
6-28
GFK-1180H
Method 4
Leave the base units for the point blank and enter your own label in the Label field.
The unit appears in the Unit field when you use Methods 13.
Note: If you select a unit of measurement on the Conversion tab, and the project has an active
measurement system at runtime, the base engineering units for the point are automatically
converted to the corresponding units in the active measurement system.
If there is no active measurement system, the base engineering units are used. If the project
has an active measurement system at runtime, no further point conversion takes place.
Example
The point's value represents degrees F.
You leave the Unit field blank.
The active measurement system uses metric units.
No conversion from degrees F to degrees C takes place at runtime.
CIMPLICITY HMI supports the following types of Engineering Unit (EU) conversions for
analog points.
None
No conversion is performed.
Linear
Custom
GFK-1180H
6-29
Linear
Custom
Linear Conversion
When you use linear conversion, you specify base and converted values that CIMPLICITY
HMI uses to calculate runtime conversions..
To configure linear conversion:
1.
2.
Select Linear.
3.
Enter two valid Raw values in the First and Second fields.
4.
Enter two Converted values in the First and Second fields. These are engineering
unit values that correspond to the first and second raw values you entered.
CIMPLICITY HMI uses these four values to calculate the linear conversion for the point. The
conversion formula is:
where:
EU value = the Engineering Units value
R1 = First raw value
R2 = Second raw value
C1 = First converted value
C2 = Second converted value
Raw value = the value read from the device.
CIMPLICITY HMI uses the inverse of this expression to convert Setpoint values entered by
users to raw values for downloading to the device.
6-30
GFK-1180H
Custom Conversion
Custom conversion provides you with the ability to specify specific forward and backward
conversion expressions.
To configure custom conversion for a device points:
1.
2.
Select Custom.
3.
Enter a Forward expression that CIMPLICITY HMI will use to convert the raw
data to engineering units
Use the placeholder %P to indicate the point value in the expression. %P is the raw
value of the point.
4.
Enter a Reverse expression that CIMPLICITY HMI will use to convert setpoint
values from engineering units to raw data
Use the placeholder %P to indicate the point value in the expression. %P is the
engineering units value of the point.
+ - / * (
Logical operators
Bitwise operators
Relational operators
Example
A conversion calls for the raw data to be divided by 10.0 then multiplied by 2.5.
The Forward expressions is: (%P/10.0)*2.5
The Reverse expression is:
(%P/2.5)*10.0
Important: The numeric operands you use in the Forward expression are assumed to be
integers unless you include decimal points in them. Once the expression processor sees an
operand with a decimal point, it will process the rest of the expression using floating-point
arithmetic
GFK-1180H
6-31
Example
A conversion that calls for the raw data to be divided by 2, then multiplied by 10.
The raw value for the point is 3.
You could enter any one of the following expressions. However, the Expression Processor
interprets each expression differently, as follows:
Expression
Result
(%P/2)*10
(3/2)*10 = (1)*10 = 10
Because integer arithmetic was used in the first operation of these two
expressions, the operation (3/2) gives the result 1 instead of 1.5.
(%P/2.0)*10
6-32
GFK-1180H
That came from the PLC and was not reset in manual mode
CIMPLICITY HMI allows access to manual mode wherever you can reference an attribute for
a device point. Access includes:
Turning manual mode on and off in the CIMPLICITY HMI Point Control Panel
See "Using the Point Control Panel" chapter in this manual for a description.
Scripts
See the "Monitoring Point Attributes" chapter in the "CIMPLICITY HMI CimEdit Operation
Manual" GFK-1396 for details about the manual mode point attributes.
GFK-1180H
6-33
2.
3.
4.
Configure alarms
This chapter provides information for 1-3. See the Configuring Point Limits, Views and Alarms
chapter in this manual to do the configuration listed in 4.
GFK-1180H
7-1
Point type
2.
Method 2
1.
2.
Select File.
3.
Select New.
4.
Select Object.
Method 3
1.
2.
Method 4
1.
2.
3.
The New Point dialog box opens when you use any method.
New Virtual Point
4.
7-2
GFK-1180H
5.
6.
Analog
Boolean
Text
Press OK.
GFK-1180H
1.
2.
Displays when you position the cursor over the point in the
Workbench
Can be entered in the Point browser when you want to find and
display or use the point
7-3
3.
Select one Data Type from the drop down list that appears for the point type you
selected:
Analog Points
General TabBasic ViewAnalog Point
w DINT
w INT
w REAL
w SINT
w UDINT
w UINT
w USINT
Array=
More than 1
Check to prohibit
setpoint use
DINT
INT
REAL
Floating-point numbers.
SINT
UDINT
UINT
USINT
Boolean Points
General TabBasic ViewBoolean Point
7-4
BOOL
BYTE
WORD
DWORD
Array=
More than 1
Check to prohibit
setpoint use
BOOL
BYTE
8-bits of data
WORD
16 bits of data
DWORD
32 bits of data
GFK-1180H
Text Points
General TabBasic ViewText Point
4.
STRING
STRING_20
STRING_8
STRING_80
Array=
More than 1
Check to prohibit
setpoint use
STRING
A one-character alphanumeric
STRING_20
STRING_8
STRING_80
Enter:
5.
Check the Read Only check box to prohibit the ability to use the point as a setpoint.
Using Arrays
CIMPLICITY software lets you define single points and array points. Using array points is
one way to provide more efficient data collection. An array point can represent one instance
of several process variables, or several instances of one process variable.
Note: You specify an array in the Point Properties dialog box, General tab, Element field.
Important: Array points are not supported by all CIMPLICITY software functions. Support
for array points is as follows:
GFK-1180H
CimEdit
CimView
Alarm Viewer
Database Logger
7-5
None
Initialized
Saved
Saved or Initialized
Basic selection
2.
Specify the source for the initial value of this point when the software is started up or
reset. Choices include:
None
Initialized
Saved
Saved or Initialized
See "Specifying How Virtual Points are Stored", in this chapter, if you choose Saved as the
initialization value.
7-6
GFK-1180H
3.
(Displays if Initialized is selected in the Initialization field) Enter the Initial Value
for the point at initialization, before any data is generated by its component point(s).
4.
2.
None
Initialized
Saved
Saved or Initialized
Specify the source for the initial value of this point when the software is started up or
reset. Choices include:
None
Initialized
Saved
Saved or Initialized
See "Specifying How Virtual Points are Stored", in this chapter, if you choose Saved as the
initialization value.
GFK-1180H
7-7
3.
(Displays if Initialized is selected in the Initialization field) Enter the Initial Value
for the point at initialization, before any data is generated by its component point(s).
For multi-character strings,
Each element in the array is initialized to the Initial Value.
Example
A String array:
Is an array of 4
Is an array of 8
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.
2.
Select Properties.
Method 2
7-8
1.
2.
Press P.
GFK-1180H
The Point Setup dialog box opens when you use either method.
On point update
On project shutdown
2.
GFK-1180H
7-9
This section describes what to enter for these advanced virtual point specifications.
See "Setting Point Limits and Alarms" in this manual for information on how to enter the advanced
specifications that unleash the spectrum of CIMPLICITY HMI monitoring powers.
Configure alarms
7-10
GFK-1180H
The available selections on the General tab depend on what point type you are configuring.
The following procedure begins with entries for any point type and continues through entries
for the analog/Boolean point types only.
GFK-1180H
Enable Point
Enable Alarm
Enable Enterprise
7-11
2,
Enter the Resource ID associated with the point. Users who have this Resource ID
assigned to their Role ID will be able to see any alarms generated for this point on
their Alarm Viewer screens.
Safety Points
The status of a safety point controls whether or not a setpoint is permitted. You can select a
safety point on the advanced General tab of the Point Properties dialog box.
To specify a safety point:
Select a point for the Safety Point field. The point can be:
A. Digital or analog
B. Device or virtual
At runtime if the:
Safety Point is
Available and
evaluates to a non-zero value
Permitted
Available and
evaluates to zero
Not permitted
Availability Triggers
An Availability Trigger determines the validity of the point you are configuring and provides
a "device healthy" signal for points that are tied to intermediate devices during runtime.
To specify an availability trigger:
Select a point for the Availability Trigger field. The point can be digital or analog.
At runtime if the:
7-12
Availability Trigger
Configured Point is
Available
Evaluates to zero
Unavailable
GFK-1180H
Trend History
CIMPLICITY HMI can compile a trend history for analog and Boolean points. All you have
to do is specify the amount of time that data should be retained and the maximum number of
samples that should be included.
To make specifications for trending data:
Enter the Trend History specifications for checked Max Duration and/or Max Count
check boxes to have CIMPLICITY HMI save information as follows.
Max Duration
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:
GFK-1180H
7-13
Check the Log Data and/or Log Alarm check boxes in the Logging box.
2.
3.
Select the table to which the data will be logged. See the "Database Logger" chapter in
this manual for information about configuring log tables.
7-14
GFK-1180H
Delta Accum
Value Accum
Average
Max Capture
Min Capture
Trans-High Accum
Timer/Counter
Histogram
Equation w/ Override
Tip: A Local checkbox displays on the advanced Virtual tab for every calculation choice
except none. Check the Local check box to tell CIMPLICITY HMI not to report the value of
the point to the Point Management process. This is useful for points that are only used to hold
intermediate values in calculations. For such points, setting the Local flag eliminates the
overhead of reporting to the Point Management process. Local points cannot be shared with
other applications.
Notes: Almost all of the calculations allow you to enter a trigger point.
For Equation points, you only need Saved and Initial values for Delta Accum and Delta
Value points. This is because all other Equation points are validated at startup and any
saved or initial value is immediately overwritten.
A Trigger point minimizes the system resources that are required for calculating virtual points
when it is not necessary to keep virtual points current with the points used to calculate their
values.
Example
You are configuring a point that requires an update for logging purposes.
GFK-1180H
7-15
Equation Points
Equation points are available for both analog and Boolean virtual points.
CIMPLICITY HMI uses the expression you specify in the Expression field to
update the points value.
To configure an equation point:
1.
3.
Enter an Expression that calculates the value of the Equation point. The
expression may contain one or more Point IDs as well as constant values, operations
and functions.
7-16
GFK-1180H
3.
Defined
Not defined
4.
And:
The Current
An Initial Equation
value of the
Point value is
Expression is
When the Trigger Point is not defined
Then:
1 Not defined
Available
2 Defined
Unavailable
3 Defined
Available
4 Not defined
Unavailable
When the Trigger Point is defined
Current value
Initial value
Current value
Zero (0)
1
2
Initial value
Zero (0)
Defined
Not defined
Adds the difference between the current and previous values of the expression that you
specify in the Expression field to the current value of the Delta Accum point.
Delta Accum =
Else
Delta Accum =
GFK-1180H
Is first updated after the first two expression updates are received.
7-17
Example
Note: A rollover value, which is used in this example, is the maximum acceptable value
for a Delta Accum point. When this value is incremented by one (1) unit, the Delta
Accum point rolls over to zero (0).
1.
A Delta Accum configured with a Rollover value of 1000 receives a change from 100 to
999.
The current value of the Delta Accum point is 899 based on the formula described
above.
(1000) + 999 100 = 899
2.
2.
(Required) Enter an expression that calculates the value of the Delta Accum point.
The expression may contain one Point ID along with constant values, operations, and
functions.
Note: When the expression for a Delta Accum point goes unavailable, and then
comes back as available, the delta between the value right before the point went
unavailable and the value right after it comes back as available is not accumulated.
3.
(Required) Enter the maximum acceptable delta value that can be added to the Delta
Accum point value in the Variance field.
If the delta value is greater than the Variance value, the:
A. Delta Accum point continues counting.
B. Current delta value is not added.
C. System logs the following message to the Status Log with
Success status:
4.
7-18
GFK-1180H
5.
(Optional) Enter the maximum acceptable value for the Delta Accum point in the
Rollover field. When this value is incremented by one (1) unit, the Delta Accum
point rolls over to zero (0)
6.
(Optional) Specify a Trigger point. The Delta Accum point updates whenever the
Trigger Point is updated.
7.
Defined
Not defined
The source point in the Expression field is updated.
(Optional) Enter the Point ID of a Reset point.
Updating a Reset point causes the Delta Accum point value to be reset.
At runtime, the value of the Delta Accum point is reset as follows:
If:
And:
Then:
An Initial Delta
Accum Point
Value is
The Current
value of the
Expression is
Not defined
Defined
Defined
Not defined
Available
Unavailable
Available
Unavailable
Zero (0)
Initial value
Initial value
Zero (0)
Initial value
Zero (0)
Specified value of 99
Current value of 97
GFK-1180H
7-19
The first element of the array adds the difference between the current and previous
values of the source Point ID that you specify in the Expression field to the current
value of the element.
Each additional element of the array is used to store the delta accumulator value for a
different subgroup of the array.
A selector point, which is defined in the Safety Point field, determines which subgroup
element of the array is updated. The selector point must have a value from 1 to N-1, where N
is the number of elements in the array.
Example
An array Delta Accum point tacks production counts for the
The Delta Accum array point is called COUNTS with 9 Elements (one for the total shift
count, and one for each hour of the shift). The elements are defined as follows:
Element
Description
COUNTS[0]
COUNTS[1]
COUNTS[2]
COUNTS[3]
COUNTS[4]
COUNTS[5]
COUNTS[6]
COUNTS[7]
COUNTS[8]
A Safety Point called HOUR:
Determines which subgroup element gets updated along with COUNTS[0]. For
example, if HOUR=4, COUNTS[0] and COUNTS[4] are updated.
If HOUR is less than 1 or greater than 8, no elements in the array are updated.
7-20
GFK-1180H
2.
Enter an Expression that calculates the value of the Value Accum point. The
expression may contain one or more Point IDs along with constant values,
operations, and functions.
3.
Enter the Point ID of a Trigger Point that will cause the Value Accum point to be
updated at run-time.
The Value Accum point updates whenever the Trigger Point is updated.
If you do not define a Trigger Point, the Value Accum point updates whenever
the value of the source point in the Expression field changes.
4.
And:
The Current
value of the
Expression is
Then:
The Value Accum point
value is reset to the:
Not defined
Defined
Defined
Not defined
Available
Unavailable
Available
Unavailable
Zero (0)
Initial value
Initial value
Zero (0)
GFK-1180H
Not defined
Defined
Zero (0)
Initial value
7-21
Average Points
An Average point maintains the average value for the source Point ID that you specify in the
Expression field. This virtual point can be a signed or unsigned integer, or a floating-point
number.
The average is calculated as the accumulation of the deviation from the average point data,
divided by the number of samples taken. The calculation is:
average - average + (source - average) / sample_count
The average is calculated as an eight-byte floating-point data type, then the result is converted
into the data type you specify for the average point.
Note: For integer type points, the resulting data is rounded. This may result in a loss of
accuracy. It is suggested that you use the Real point type for your Average point.
To configure an average calculation:
1.
2.
Enter an expression that calculates the value of the Average point. The expression
may contain one or more Point IDs as well as constant values, operations, and
functions.
(Optional) Enter a Point ID for a Trigger Point.
7-22
Trigger Point
Defined
Not defined
GFK-1180H
3.
And:
The Current
value of the
Expression is
Then:
The Average point value
is reset to the:
Not defined
Defined
Defined
Not defined
Available
Unavailable
Available
Unavailable
Current value
Initial value
Average
Zero (0)
Defined
Not defined
Initial value
Zero (0)
GFK-1180H
1.
2.
(Required) Enter an expression that calculates the value of the Max Capture point.
The expression may contain one or more Point IDs along with constant values,
operations, and functions.
7-23
3.
Defined
Not defined
4.
And:
The Current
value of the
Expression is
Then:
The Max Capture point
value is reset to the:
Not defined
Defined
Defined
Available
Unavailable
Available
Not defined
Unavailable
Current value
Initial value
Whichever has the Max
value
Smallest possible value
for the point type. e.g.
for INT the value is 32768
Defined
Not defined
Initial value
Smallest possible value
for the point type. e.g.
for INT the value is 32768
Note: When a
Then the Max Capture point will only reset to the equation value after the reset point is
activated, followed by the trigger point being activated.
7-24
GFK-1180H
Select Min Capture in the Calculation Type field on the Virtual tab.
2.
(Required) Enter an expression that calculates the value of the Min Capture point.
The expression may contain one or more Point IDs as well as constant values,
operations, and functions.
3.
Defined
Not defined
4.
GFK-1180H
7-25
At runtime, when the Reset Point updates, the value of the Min Capture point is
reset as follows:
If:
An Initial Min
CaptureValue is
And:
The Current
value of the
Expression is
Then:
The Min Capture point
value is reset to the:
Not defined
Defined
Available
Unavailable
Defined
Available
Not defined
Unavailable
Current value
Max possible value for
the point type. E.g. for
INT the value is +32767
Whichever has the Min
value
Initial value
Defined
Not defined
Initial value
Max possible value for
the point type. E.g. for
INT the value is
+32767for INT the value
7-26
If the Trans-High Accum point type is DINT and the Expression uses floating
point arithmetic, the result of the calculation is rounded to the nearest integer. For
example, a value of 0.1 is considered to be zero, and a value of 0.6 is considered to
be non-zero.
If the Trans-High Accum point type is FLOAT and the Expression uses floating
point arithmetic, then a transition from 0 to 0.1 is considered to be a transition from a
zero to a non-zero value.
GFK-1180H
Select Trans_High Accum in the Calculation Type field on the Virtual tab.
2.
3.
Defined
Not defined
4.
And:
The Current
value of the
Expression is
Then:
The Trans High Accum
point value is reset to
the:
Not defined
Defined
Defined
Not defined
Available
Unavailable
Available
Unavailable
Zero (0)
Initial value
Initial value
Zero (0)
GFK-1180H
Defined
Not defined
Initial value
Zero (0)
7-27
Timer/Counter Points
A Timer/Counter point records the following data in three array elements:
A count of the number of times the Expression has transitioned from the LOW
state to the HIGH state since the project started or since the Timer/Counter point
was reset.
The Expression is in its:
Time is stored in the number of seconds since 00:00:00 on January 1, 1970 GMT (Greenwich
Mean Time). If you computers clock is set for another time zone, this value is translated
accordingly. For example, if your computers clock is set for Eastern Standard Time, the base
time is 19:00:00 31 December 1969.
To configure a Timer/Counter point:
1.
2.
3.
4.
7-28
GFK-1180H
5.
6.
7.
8.
Enter the time Interval between the Timer/Counter point updates while the
Expression value remains HIGH. The format is hh_ss_mm where hh is the
number of hours, mm is the number of minutes, and ss is the number of seconds.
Example
Three Timer/Counter points are updating every 15 seconds
You can define their start times as follows to distribute system load:
Point ID
Start Time
Point1
00:00:05
Point2
00:00:10
Point3
00:00:15
You want to update the Timer/Counter point every ten minutes while the
expression is in the HIGH state.
Enter 00:10:00 in the Interval field to update each Timer/Counter every ten minutes
from the time it started.
Point ID
Point1
00:00:05
Point2
00:00:10
Point3
00:00:15
When the Expression value goes HIGH, the values in the Timer/Counter point
are updated. After that, the updates are done every ten minutes.
GFK-1180H
7-29
9.
Histogram Points
A Histogram point records the frequency at which the value of the source point, identified in
the Expression field, occurs within specified range intervals. This information is typically
displayed graphically as a histogram.
Each time the source point is updated, the counter whose range encompasses the source point
value is incremented.
You must configure a Histogram point as an array point. The number of elements in the
array will be:
the number of range intervals you desire + 6
The extra six elements are used to maintain the:
Number of sample values that were less than the lower limit of the point range
(underflow bucket)
Number of sample values that were greater than the upper limit of the point range
(overflow bucket)
Use the Display Limits fields to specify the lower and upper range values within which the
point values are expected to occur. The range intervals are automatically calculated based on
the Display High and Display Low limits and the number of Elements you specify.
To configure a Histogram:
7-30
1.
2.
(Required) Enter an expression that calculates the value of the Histogram point.
The expression may contain one or more Point IDs along with constant values,
operations, and functions.
GFK-1180H
3.
Defined
Not defined
4.
And:
The Current
value of the
Expression is
Then:
Each Array element of
the Histogram is reset
to:
Not defined
Defined
Defined
Not defined
Available
Unavailable
Available
Unavailable
Zero (0)
Initial value
Initial value
Zero (0)
50
Display High
100
Elements
11
Expression
CYCLE_TIME
The eleven elements of this point contain the following information, where X is the number of
point value samples:
GFK-1180H
7-31
Element
Contents
HIST_CYCLE_TIME[0]
X<50
HIST_CYCLE_TIME[1]
60<X50
HIST_CYCLE_TIME[2]
70<X60
HIST_CYCLE_TIME[3]
80<X70
HIST_CYCLE_TIME[4]
90<X80
HIST_CYCLE_TIME[5]
100X90
HIST_CYCLE_TIME[6]
100<X
HIST_CYCLE_TIME[7]
Number of samples
HIST_CYCLE_TIME[8]
HIST_CYCLE_TIME[9]
HIST_CYCLE_TIME[10]
(underflow bucket)
(overflow bucket)
2.
7-32
GFK-1180H
Defined
Not defined
4.
And:
The Current
value of the
Expression is
Then:
The Equation
w/Override point value
is reset to the:
Not defined
Defined
Defined
Not defined
Available
Unavailable
Available
Unavailable
Current value
Current value
Current value
Zero (0)
GFK-1180H
Defined
Not defined
Initial value
Zero (0)
7-33
7-34
GFK-1180H
GFK-1180H
7-35
1.
2.
Select the Conversion tab that appears if you are configuring an analog point.
7-36
1.
Click the Popup Menu button to the right of the Unit field.
2.
Select the name of the base engineering units from the list of available measurement
units. When you do this, the label for the unit is automatically put in the Label field.
GFK-1180H
Method 2
Click the Browser button to the right of the Unit field to find the measurement unit in the
Select A Measurement Unit Browser
Method 3
1.
Click the Pop-up Menu button to the right of the Unit field.
2.
Select New.
The New Measurement dialog box opens.
3.
4.
5.
Enter the label that will appear when the measurement unit is selected.
6.
Press Apply.
The new unit is added to the list of available units.
GFK-1180H
7-37
Method 4
Leave the base units for the point blank and enter your own label in the Label field.
The unit appears in the Unit field when you use Methods 13.
Note: If you select a unit of measurement on the Conversion tab, and the project has an active
measurement system at runtime, the base engineering units for the point are automatically
converted to the corresponding units in the active measurement system.
If there is no active measurement system, the base engineering units are used. If the project
has an active measurement system at runtime, no further point conversion takes place.
Example
The point's value represents degrees F.
You leave the Unit field blank.
The active measurement system uses metric units.
No conversion from degrees F to degrees C takes place at runtime.
CIMPLICITY HMI supports the following types of Engineering Unit (EU) conversions for
analog points.
None
No conversion is performed.
Linear
Custom
When you specify Linear or Custom conversion, you must enter the values for the Raw and
Converted Limits.
7-38
GFK-1180H
Method 2
Select Edit Expression from the Pop-up menu
Either method opens the Edit Expression dialog box.
Continue
1.
2.
Insert a Point ID or variable either after the operator or between parentheses, if they
appear with an operator.
Input box
Point ID
popup
Points
Configuration
dialog box
New Point
dialog box
Double click an
available
operator
GFK-1180H
7-39
Tip: Use the Point IDs..., Edit Point and New Point buttons to browse through
existing points, edit a selected point or create a new point.
Operations are divided into the following areas:
Alarm functions
Arithmetic
Bitwise
Conversion
Logical
Relational
Scientific
Alarm Functions
Alarm functions supported by the Expression Editor are:
AL
A1 or WARNING
A2 or ALARM
AH1 or WARNING_HIGH
AH2 or ALARM_HIGH
AL1or WARNING_LOW
AL2 or ALARM_LOW
ANA or ALARM_NOT_ACKED Returns True if the point is in alarm and the alarm has not
been acknowledged.
Format is ANA(<point id>)
7-40
GFK-1180H
Arithmetic Operations
Arithmetic operations supported by the Expression Editor are:
+
Addition
Subtraction
Multiplication
Division
The result of dividing two integers in an expression will
be an integer. If you want a floating point result, multiply
the numerator by 1.0 before dividing.
For example, POINTA is set to 6 and POINTB is set to 4.
The result of the expression POINTA/POINTB is 1,
while the result of the expression
(POINTA*1.0)/POINTB is 1.5.
SQR
ABS
MIN
MAX
MOD
RND
TRUNC
FLR
GFK-1180H
7-41
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
BOR
BNOT
BXOR
SHL
SHR
7-42
GFK-1180H
Conversion Operation
VAL
Logical Operations
You can use Boolean, integer or floating point numbers for logical operations. If an
expression has a non-zero value, it is TRUE; if the value is zero (0), it is FALSE.
Logical operations supported by the Expression Editor are:
AND
OR
NOT
XOR
Relational Operations
Relational operations supported by the Expression Editor are:
LT
GT
EQ
Equal To
Format is (expr1) EQ (expr2).
LE
GE
NE
Not Equal To
Format is (expr1) NE (expr2).
GFK-1180H
7-43
Scientific Operations
The scientific operations supported by the Expression Editor are:
SIN
COS
TAN
ASIN
ACOS
ATAN
X^Y
EXP
LOG
LOG10
7-44
GFK-1180H
Point <point_id>
The value of the virtual point becomes unavailable and remains that way until the Expression
once more evaluates to a valid value.
All other calculation types keep their last available value
If the enabler uses standard addressing, do the following to specify a diagnostic point:
1.
2.
3.
Enter the correct offset for the point in the Domain offset field.
Use the following values to configure diagnostic data for devices with standard addressing:
Description
Number of messages sent
Number of messages received
Number of communication failures
Number of retries
Device up status
Device down status
GFK-1180H
Data
Type
UDINT
UDINT
UDINT
UDINT
BOOL
BOOL
Domain Type
Standard Diag. Double Words
Standard Diag. Double Words
Standard Diag. Double Words
Standard Diag. Double Words
Standard Diagnostic Bits
Standard Diagnostic Bits
Domain
Offset
0
1
2
3
0
1
7-45
Associate a CimView screen with any point so you can quickly review its status
through the Workbench.
Point Limits
GFK-1180H
An alarm delay
A help file
8-1
Point View
For any point that you configure, you can select a CimView screen name that will appear on
that points popup menu in the Workbench.
You can also configure analog point display characteristics for CIMPLICITY HMI
application such as CimView.
You do this on the View tab of the Point Properties dialog box.
2.
Boolean, text
analog
3.
8-2
Select a Screen from the selection in the drop down menu. Your options include
CimView screens that are in the project directory.
The name of the screen you select will appear on the points
popup menu in the Workbench. The screen will appear when it
is selected.
The screen will display when a user selects this point in the
Alarm Viewer and clicks Screen.
GFK-1180H
2.
You can specify an analog points justification when it displays in standard CIMPLICITY
HMI software, such as CimView.
To select an analog points justification:
Select the left, right or zero radio button. :
LeftPoint display is left justified
RightPoint display is right justified
ZeroPoint display is right justified and zero filled
GFK-1180H
8-3
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
Fixed
Scientific
Compact
8-4
GFK-1180H
Note: For integer point types, Decimal is the only format type.
Guide for enabling analog display configuration: When you configure an object that
uses the point in CimView, you have to enable the Justification and Width configuration in
CimEdit. You do this on the Text tab of the Object Properties dialog box in CimEdit, in the
Display Format field. See "CIMPLICITY HMI CimEdit Manual" GFK-1396 for more information.
Horizontal/Vertical movement
Rotation/Fill
Horizontal/Vertical scaling
If you have a single point expression in any of the above expressions and you do not specify a
minimum or maximum limit for the expression, the points display limits are used instead. If
these limits are not specified either, default values of 0 (minimum) and 100 (maximum) are
used.
Trending uses the graphics limits to determine the Y-axis limits for the point.
GFK-1180H
8-5
The display limits must be within the range limits you specify on the Limits properties page.
Limit
Enter the:
Display High
Display Low
Important: Make sure the display limits are within range limits that you set. See "Range
Limits" in this chapter.
Point Limits
You can specify range and setpoint limits for both device and virtual analog points on the
Limits tab that appears in the Advanced General tab group.
1.
2.
Select the Limits tab that appears if you are configuring an analog point.
Limits Tab
Exclude
meaningless data
Define range for
allowed setpoints
8-6
GFK-1180H
3.
Enter the low and high limits for the converted value of the point.
Values below the low range limit and above the high range limit will display as the
point unavailable value.
Example
A PLC gives raw data in counts from 0 to 1000.
The raw data represents temperatures between -500 C and +500 C.
Values above 200 C or below -200 C are considered to be out of range.
GFK-1180H
8-7
2.
If a user enters a value below the low setpoint limit or above the high setpoint limit, the value
will not be accepted.
8-8
GFK-1180H
Alarms
You can set alarms for analog and Boolean points.
Point Management provides you with a
Basic Alarm tab option if you want to do a quick basic alarm configuration.
An advanced alarm configuration in which you can precisely specify what messages
should display, when and who has access. The tabs for the configuration are
Alarm Routing
Alarm Options
GFK-1180H
2.
Enter a basic Alarm Message. See "Basic Alarm Message" in this section.
3.
8-9
Note: Using several of the available variables can involve advanced configuration.
To enter a basic alarm message:
Enter an Alarm Message in the Alarm Message field.
You can type in the variables or select them from the fields popup menu. See "Alarm Definition"
in this chapter.
Boolean point
8-10
GFK-1180H
Alarm Routing
Alarm Options
2.
button.
A detailed alarm definition can be entered or changed and be given an assigned Alarm Class
and string index.
GFK-1180H
8-11
An alarm delay
A help file
Alarm Definition
You can configure a basic I/O alarm message in the Alarm tabs basic view. It is in the
advanced view that you enter a definition that CIMPLICITY HMI uses to trigger exactly the
alarm message you want based on calculated criteria. The Definition box includes specifying
an alarm:
8-12
Class
String
GFK-1180H
Enter a message in the Alarm Message field that will be displayed with the alarm in
Alarm Viewer. This message may contain text plus the following variable
information that is determined when the alarm is generated.
Entries
%ID
%VAL
%EU
%STATE
%LIMIT
%DEV_ID
%DEV_VAL
%DEV_AMT
You can type in the variables or select them from the fields popup menu. Type them all as
capital letters (CAPS).
2.
Variable
Displays the:
%ID
Point ID
% LIMIT
%VAL
%EU
% STATE
%DEV_ID
%DEV_VAL
%DEV_AMT
%%
Actual percent sign in the message.
Enter an Alarm Class to group alarms with similar characteristics. An alarms class
determines the order in which it appears relative to other alarms in Alarm Viewer.
You can prioritize classes in the Alarm Class Configuration dialog box.
GFK-1180H
Enter a String Index number to identify the alarm text, if you are using %STATE
in your alarm message.
8-13
2. The associated
text appears
as the Alarm
Limits
2.
3.
8-14
GFK-1180H
4.
5.
6.
Select a priority number in the Order field. CIMPLICITY HMI gives alarms with a
one-(1) order number the highest priority.
GFK-1180H
Normal State
Alarm State
Acknowledged State
8-15
Beep
specifications
Test
2.
3.
B. Find the .WAV file you want to use in the Windows Open
dialog box.
8-16
GFK-1180H
Beep
Alarm Criteria
You can select one of the following methods for evaluating the alarm values:
GFK-1180H
Alarm Criteria
Used to
Absolute
Deviation
On Update
Rate of Change
8-17
Absolute Alarming
Absolute alarms are used to detect when the value of a point is too high or too low.
To configure absolute alarming:
1.
Select Absolute in the Alarm Type field on the advanced Alarm tab.
2.
Enter at least one and up to four values in the Alarm Limits fields.
Each time the points value is updated, its current value is compared with the alarm
values. An alarm is generated when the points value transitions from one alarm state
to another.
The transitions are:
State
Description
Alarm High
Warning High
Normal
Warning Low
Alarm Low
Point value Alarm Low value
If the point is in normal state, the Point Manager resets alarms for the point.
8-18
GFK-1180H
Deviation Alarming
Deviation alarming is used to detect when the value of a point deviates too far from that of a
second point.
To configure deviation alarming:
1.
Select Deviation in the Alarm Type field on the advanced Alarm tab.
2.
Define the values in the Alarm Limits fields based on the deviation from the norm:
The text definition depends on the string you select in the String Index field on the
same tab. Make sure that:
Empty is larger
than Almost
The point is scanned at its normal Scan Rate, but is evaluated for alarming at the Alarm
Delay rate (also known as the sample interval).
An alarm is generated when the difference between the current value of the point and the
current value of the Deviation Point exceeds an alarm limit. This difference is calculated
whenever the value of the point or the Deviation Point changes.
On Update Alarming
On Update alarming is used to generate an alarm whenever the points value is updated.
If you choose the On Update alarm criteria, you cannot define Alarm Values. Each time the
points value is updated, an alarm is generated.
GFK-1180H
8-19
Select Rate of Change in the Alarm Type field on the advanced Limits tab.
2.
3.
Seconds
Minutes
Hours
Enter the length of the interval between sampling the point for Rate of Change
alarming.
If the difference between the current value of the point and the value at the last
sample time exceeds alarm limits, an alarm message will be generated
4.
5.
An alarm is generated when the difference between the current value of the point and its value
at the last sample interval exceeds an alarm limit. The current point is not evaluated for an
alarm condition each time the value changes. An alarm is generated under these conditions:
Alarm
Alarm High
Warning High
Alarm Low
Warning Low
In the Alarm Limits, you can specify:
8-20
To check for:
Positive
Increasing values
Negative
Decreasing values.
GFK-1180H
Rate of Change
value is ...
Alarm High
Alarm High
Warning High
Warning High
Warning Low
Warning Low
Alarm Low
Alarm Low
Limit Value
Positive
Negative
Positive
Negative
Positive
Negative
Positive
Negative
Define an upper and lower alarm limit and an upper and lower
warning limit for the point value.
Rate of Change
Deviation
Lo-1 is larger
than Lo-2
GFK-1180H
Deviation
Empty is larger
than Almost
8-21
Alarm Delay
Alarm Delay delays the display of the alarm on Alarm Viewers and other Alarm Management
Interested Processes unless the point remains in an alarm state for the configured interval.
The Alarm Delay feature is only available when you select Absolute alarming. If you select
the Delay Alarms check box, the Interval fields represent the length of the delay before the
alarm is reported.
When an alarm condition is
detected for a point and if:
No Alarm delay is configured Immediately to the Alarm Manager and all other Point
Management Interested Processes such as CimView and
the Event Manager.
An Alarm delay is configured: After the delay time generates the Alarm Delay. This
means that Alarm Delay applies to all the Point
Management Interested Processes such as CimView, Point
Control Panel and the Event Manager, the Alarm Viewer
and other Alarm Management Interested Processes, such
as the Alarm Printer, that are serviced by the Alarm
Manager.
To specify the length of an alarm delay:
1.
2.
Seconds
Minutes
Hours
3.
4.
8-22
Point Manager sends the information immediately to the Alarm Manager and all
other Point Management Interested Processes such as CimView and the Event
Manager.
Alarm Manager generates the Alarm Delay. This means that Alarm Delay only
applies to the Alarm Viewer and other Alarm Management Interested Processes, such
as the Alarm Printer, that are serviced by the Alarm Manager
GFK-1180H
Deadband
A deadband defines the tolerance for alarm conditions.
The deadband cushions the generation of alarms when a point value fluctuates at an alarm
limit.
Example
A high alarm limit is 100.
A deadband is 5.
The point goes into the alarm state when its value reaches 100, and stays in the alarm state
until its value drops below 95.
When a point transitions from an alarm state into a warning state of the same type, the alarm
status switches from Alarm to Warning only if the point value is more than the deadband away
from the alarm limit.
Example
A point has a:
Deadband of 2
Falls below 98, the state changes to Warning High (the alarm limit minus the
deadband).
Help File
Enter the name of a text file that users can display when they click the Help button in the
Alarm Viewer. You can enter a filename of up to 8 characters.
The actual file is in the ALARM_HELP directory in your project. The actual filename is the
name given in this field, followed by ".HLP".
Alarm Help files are ASCII text files of up to sixty (60) lines. Each line can have a maximum
of 70 characters. Files are located in the %SITE_ROOT%\alarm_help directory.
If you wish, you may use the same Help File for several points.
GFK-1180H
8-23
Routing Alarms
The Alarm Routing properties let you select the Roles that can view any alarms generated by
this point.
You can:
Assign available roles to view alarms.
Remove roles from viewing alarms
Create new roles to select.
Select the Alarm Routing tab in the Point Properties dialog box.
2.
Select a user role in the Available Roles column that can view the alarms.
3.
Press Add. The role will move over to Configured Roles For Alarm column.
4.
Select any roles in the Configured Roles for Alarm column that should not view the
alarms.
8-24
1.
Select the Alarm Routing tab in the Point Properties dialog box.
2.
Press Remove. The role will move over to the Available Roles column.
3.
Press OK. The fields display from left to right in the order you specified.
GFK-1180H
Press New.
The New Role dialog box opens.
2.
3.
Select OK.
The Role Properties dialog box opens if the Role ID you entered is valid.
4.
5.
Select OK to create the new Role and return to the Alarm Routing properties.
GFK-1180H
Automatic actions
Deletion requirements
8-25
You have the ability in CIMPLICITY HMI to enter your specifications for each stage in the
sequence.
Important: If you have not defined an alarm for the point, any information you enter on this
page is not saved when you select OK.
Automatic Actions
Automatic actions on the Alarm Options tab include:
Alarm Repeats
Automatic acknowledgements
Automatic reset
Alarm Repeats
Auto repeat, on the Alarm Options tab, is the time (in minutes) that the Alarm Manager waits
before repeating the alarm to all interested processes. The alarm will continue to be repeated
until it is acknowledged, reset, or deleted.
In particular, the Alarm Line Printer (AMLP) is an interested process. Setting a repeat
timeout will cause the points alarm to be reprinted on the Alarm Line Printer until it is
cleared.
8-26
GFK-1180H
Note: The actual number of minutes that the Alarm Manager will wait before repeating the
alarm may be greater than this number. The maximum time will be the number you enter in
this field plus the number of minutes configured for the timer for processing automatic alarms
in the Alarm Manager configuration file (alarm_mgr.dat). The default for this timer is 5
minutes.
Alarm Acknowledgements
An alarm can be acknowledged manually or automatically
Alarm acknowledgement is configured on the Alarm Options tab of the points Properties
dialog box.
To configure automatic alarm acknowledgement:
Select None, Immediate or Timed to specify how the Alarm Manager should react to
an alarm.
None
There is no automatic acknowledgement. Instead a user has to manually reset the alarm.
Immediate
CIMPLICITY HMI immediately acknowledges the alarm.
Timed
Enter the number of minutes, in the minutes field that appears, that the Alarm Manager
should wait before automatically acknowledging the alarm .
Note: The actual number of minutes that the Alarm Manager will wait before acknowledging
the alarm may be greater than this number. The maximum time will be the number you enter
in this field plus the number of minutes configured for the timer for processing automatic
alarms in the Alarm Manager configuration file (alarm_mgr.dat). The default for this timer
is 5 minutes.
GFK-1180H
8-27
Reset Procedures
An alarm can be reset:
Manually
Automatically
Because the condition causing the alarm no longer exists, and the process that
detected the alarm condition automatically reset the alarm.
Alarm reset configuration is done on the Alarm Options tab of the points Properties dialog
box.
To allow the alarm reset to be reset manually:
Check the Manual Reset Allowed checkbox.
To configure automatic alarm reset:
Select None, Immediate or Timed in the Auto Reset field.:
None
The alarm can only be manually reset.
Immediate
The Alarm Manager immediately resets the alarm. If you select this option, the alarm will not
repeat.
Timed
Enter the number of minutes, in the minutes field that appears, that the Alarm Manager should
wait before automatically resetting the alarm .
Alarm Deletion
The Deletion Requirements are the conditions that must exist in order for an alarm to be
deleted (removed from the system).
If you select both check boxes on the Alarm Options tab of the points Properties dialog box,
the alarm will not be deleted until it is acknowledged and reset (these actions may occur in
any order).
8-28
GFK-1180H
GFK-1180H
8-29
Note: You can also use the Workbench to monitor runtime behavior, including:
Open the Point Control Panel to monitor and control runtime point behavior
2.
Tell CIMPLICITY HMI to automatically display all the points by either of the
following methods:
Method 1
A. Select View on the Workbench menu bar.
B. Select Autofill if there is no check mark on its left side.
GFK-1180H
9-1
Method 2
A. Place the cursor in the right pane.
B. Click the right mouse button.
C. Select Autofill from the popup menu if there is no check mark
on its left side.
CIMPLICITY HMI displays a list of all the existing points when you use either method.
Note: Points with a $ as the first character in the name are system points and cannot be
changed or removed.
2.
9-2
GFK-1180H
Specify what
point to list
Opens a
Browser window
3.
After
Before
Between
Begin and end with the entered characters, e.g. F*1
Enter a ? to display any points that contain the characters you enter, in addition to one
character per ?, in the position that the ? is entered, e.g. ?_Tank?
The point or points you specify will display in the right pane until you change your
specifications.
GFK-1180H
9-3
Click the Browser button to the right of the Device ID, Resource or Point Type field
in the Point Search dialog box.
The appropriate Browser window opens.
Enter criteria to
filter the display
2.
3.
9-4
GFK-1180H
Note: Two useful fields that display the point status are:
Needs Update
Modified
Field Selection
Use the Field Chooser dialog box to select the point fields that will display in the right pane of
the Workbench.
To select the point fields to display in the right pane:
1.
2.
Use any of the following methods to open the Field Chooser dialog box.
Method 1
A. Click the right mouse button in the right pane.
B. Select Field Chooser from the popup menu.
Popup
GFK-1180H
9-5
Method 2
A. Select View on the Workbench menu bar.
B. Select Field Chooser.
View Drop Down Menu
Method 3
Press the Field Chooser button
The Field Chooser dialog box for points opens when you use any of these methods.
Example: Field Chooser Dialog Box for Points
9-6
3.
Select a field in the Available field column that you want to add to your display.
4.
Press Add. The field will move over to the Display Fields column.
5.
Select any field in the Display fields column that you do not want to display.
6.
Press Remove. The field will move over to the Available field column.
GFK-1180H
7.
8.
Use the Move Up and Move Down buttons change a selected fields place in the list.
Move on the list
Up
Down
Right of the fields above it
Press OK. The fields display from left to right in the order you specified.
Field Definitions
Most of the field names state exactly what the field is. However, for reference, following is a
brief explanation of all the fields available for display.
Field
To Display
Access Filter
Address
Address Offset
Alarm High
Alarm Low
Data Length
Data Type ID
Point type used for the point from one of the following
values:
0Boolean type point
1Integer type point
2APPL type point
3Text type point
4Unsigned 8-bit integer type point
5Unsigned 16-bit integer type point
6Unsigned 32-bit integer type point
7Signed 8-bit integer type point
8Signed 16-bit integer type point
9Signed 32-bit integer type point
10Floating point type point
Description
Device ID
GFK-1180H
9-7
Display Format
Elements
Has EU
Modified
Need Update
Displays either:
1the point has been modified and the project needs a
configuration update.
0the project is up to date.
Point Class
Point Origin
Point Type
Resource
Warning High
Warning Low
Note: The Remove button will be disabled if the field is required. The Move Down or
Move Up button will be disabled if a field that will be affected by the move has to appear in
the furthest left position.
9-8
GFK-1180H
Event Manager
CimEdit
CimView
Each system point, which is Read Only, is automatically updated by CIMPLICITY HMI.
The default update time is every 60 seconds. To see the value of any one, all you have to do is
select it for display.
The points are:
$LOCAL.COMPUTER
Point Type
Local Point
Data Type
STRING (15)
Access
Read Only
Description
$LOCAL.WINUSER
GFK-1180H
Point Type
Local Point
Data Type
STRING (20)
Access
Read Only
Description
10-1
$PROJECT.COMPUTER
Point Type
Server Point
Data Type
STRING (15)
Access
Read Only
Description
$PROJECT
Point Type
Server Point
Data Type
STRING (20)
Access
Read Only
Description
Project name
$PROJECT.AVAILABLE
Point Type
Local Point
Data Type
BOOL
Access
Read Only
Description
$PROJECT.LOGGEDIN
Point Type
Local Point
Data Type
BOOL
Access
Read Write
Description
Login status
0: Logged out || !$PROJECT.AVAILABLE
1: Logged in && $PROJECT.AVAILABLE
$PROJECT.DEVICES
10-2
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
GFK-1180H
$PROJECT.USERS
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
Number of users
$PROJECT.DATETIME
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
$PROJECT.DATE.YEAR
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
$PROJECT.DATE.MONTH
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
$PROJECT.DATE.DAY
GFK-1180H
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
10-3
$PROJECT.DATE.WEEKDAY
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
$PROJECT.DATE.DAYOFYEAR
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
$PROJECT.DATE.WEEK
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
$PROJECT.DATE.HOUR
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
$PROJECT.DATE.HOUR12
10-4
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
GFK-1180H
$PROJECT.DATE.MINUTE
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
$PROJECT.DATE.SECOND
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
$PROJECT.DATE.SECOFDAY
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
$PROJECT.DATE.AMPM
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
0- AM, 1- PM
$LOCAL.DATETIME
GFK-1180H
Point Type
Local Point
Data Type
Integer
Access
Read Only
Description
10-5
$LOCAL.DATE.YEAR
Point Type
Local Point
Data Type
Integer
Access
Read Only
Description
$LOCAL.DATE.MONTH
Point Type
Local Point
Data Type
Integer
Access
Read Only
Description
$LOCAL.DATE.DAY
Point Type
Local Point
Data Type
Integer
Access
Read Only
Description
$LOCAL.DATE.WEEKDAY
Point Type
Local Point
Data Type
Integer
Access
Read Only
Description
$LOCAL.DATE.DAYOFYEAR
10-6
Point Type
Local Point
Data Type
Integer
Access
Read Only
Description
GFK-1180H
$LOCAL.DATE.WEEK
Point Type
Local Point
Data Type
Integer
Access
Read Only
Description
$LOCAL.DATE.HOUR
Point Type
Local Point
Data Type
Integer
Access
Read Only
Description
$LOCAL.DATE.HOUR12
Point Type
Local Point
Data Type
Integer
Access
Read Only
Description
$LOCAL.DATE.MINUTE
Point Type
Local Point
Data Type
Integer
Access
Read Only
Description
$LOCAL.DATE.SECOND
GFK-1180H
Point Type
Local Point
Data Type
Integer
Access
Read Only
Description
10-7
$LOCAL.DATE.SECOFDAY
Point Type
Local Point
Data Type
Integer
Access
Read Only
Description
$LOCAL.DATE.AMPM
Point Type
Local Point
Data Type
Integer
Access
Read Only
Description
0- AM, 1- PM
$USER.ALARMS
Point Type
Local Point
Data Type
Integer
Access
Read Only
Description
$ALARM.TOTAL
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
Alarm count
$ALARM.ACKED
10-8
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
Alarms acknowledged
GFK-1180H
$ALARM.UNACKED
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
Alarms unacknowledged
$ALARM.ACTIVE
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
Server Point
Data Type
Integer
Access
Read Only
Description
GFK-1180H
Point Type
Server Point
Data Type
Integer
Access
Read Only
Description
10-9
Database Logger
Event Manager
Point Configuration
Scripts
When you open the Point Cross Reference window for the first time you need to build a
PtXRef database for the points in the project you are running
When that is done, the three basic issues to address are how you:
1.
2.
3.
Make modifications
If you need to work with a different CIMPLICITY HMI project from the one that is currently
open, you can easily open the other CIMPLICITY HMI project through the Point Cross
Reference window.
GFK-1180H
11-1
2.
2.
Select CIMPLICITY.
3.
4.
The result of using either method depends on the status of the projects PtXref database.
If the PtXRef database has:
Been built and all of its subsystems are up-to-date, the Point Cross Reference
window opens, displaying the list of points in the PtXRef database.
Been built but all of its subsystems are not up-to-date, an Update PtXRef Database
dialog box appears.
11-2
GFK-1180H
To update the PtXRef Database before the PtXRef Point Explorer window
opens:
Simply press the Yes button.
Method 2
1.
2.
Select Build.
GFK-1180H
1.
2.
Press OK.
11-3
CIMPLICITY HMI builds a PtXRef database of all the points in your project that appear
in the subsystems you select.
Build PtXref Database Dialog Box
Selected substystems
selected
List of points
Text only
Full view
Tree view
11-4
GFK-1180H
The left pane displays a list of points in the project. You can view:
All points
The right pane can display both a tree and text view or each alone. When you select a point in
the list of points and look at the:
Tree View
A tree displays:
Note: A list of points displays in the left pane for all views.
GFK-1180H
11-5
Point ID
Valid point
type
Title bar
Point ID
Point count
To re-sort the lists in the left pane of the Point Cross Reference window:
Click the title bar on top of the list that you want as the primary sort.
The list you select will be sorted in ascending order. Information on the other two lists will
stay with the associated items in the primary sort.
11-6
GFK-1180H
Method 2
1.
2.
Select Options.
In either case, the Views tab of the Options dialog box appears.
Views Tab in Options Dialog Box
Select how you want the Point Cross Reference window to display information.
The options are:
Sort on
GFK-1180H
When checked, the left pane displays only the points that
are currently being used in your project
11-7
2.
3.
4.
Check the check box to the left of each subsystem you want to include.
Build PtXRef Database Dialog Box
Event Manager
selected
Scripts not selected
Screen Refresh
If more than one location can make changes to points, these changes may be made when you
are using the Point Cross Reference window. You can refresh the view periodically to keep it
up to date.
To refresh the view in the Point Cross Reference window:
1.
2.
Select Refresh.
CIMPLICITY HMI scans the point table and displays the current information.
11-8
GFK-1180H
View where it is located in the PtXRef database and look at the display in the right
pane to see how it is being used.
Point Review
Once you have selected which views (Tree and/or text) in which you want information
displayed in the Point Cross Reference dialog box, you can easily review that information by
simply selecting the appropriate Point ID.
Views Tab in Options Dialog Box
Selected point
GFK-1180H
Tree view
Subsystem
Point use
Text view
11-9
Select the point in the left pane of the Point Cross Reference window.
Method 1
2.
Right click the object that represents the point instance you want to review in the
right pane of the Point Cross Reference window.
3.
Method 2
2.
3.
Select Properties.
Method 3
Press Alt+Enter on the keyboard.
Note: If the object you select has no properties, that selection will not be available when you
click the right mouse button.
Using Text View to review information
In Text view, scroll through the list in the right pane of the Point Cross Reference window to
view the information. Depending on where the point is being used, you will see:
11-10
Points
Scripts
Event
Screens
GFK-1180H
Point Modification
When you decide to modify a point or an instance where the point is being used, you can open
the appropriate window to do this.
To make modifications through the Point Cross Reference window:
1.
Select the point you want to modify in the left pane of the Point Cross Reference
window.
2.
3.
4.
Select Open.
The related window that contains the information you want to modify opens, as follows:
Selected Instance
Events
Events as Actions
Events as Events
Scripts
Specific Script
Points
PointsDerived
Screens
CimEdit screen
Specific Screen
Database Logger
GFK-1180H
1.
2.
3.
11-11
Method 2
1.
2.
Select Build.
3.
4.
CIMPLICITY HMI adds and displays the selected subsystems when you use either method.
Build PtXref Database Dialog Box
Selected substystems
selected
2.
If the PtXRef database needs to be rebuilt, the following dialog box appears providing you
with the rebuild status.
11-12
GFK-1180H
3.
Method 2
1.
2.
Select Open.
An Open dialog box appears.
3.
4.
Note: You can find and open a CIMPLICITY HMI project from the last databases you
opened listed on the Project drop menu.
GFK-1180H
11-13
Device Configuration
About Devices
A device is anything that can communicate point data to CIMPLICITY HMI
software. CIMPLICITY HMI software can read data from and write data to devices.
Examples of devices are programmable controllers such as the GE Fanuc Series 90.
Use this function to configure devices and specify their characteristics.
Configuration requirements for devices vary depending on the type of device and
communications protocol being used. See the CIMPLICITY HMI Device
Communications Manual (GFK-1181) for detailed information on configuring a
device for a particular protocol.
Configuring Devices
To configure devices, double-click the Devices icon in your projects Workbench.
If you have selected the Display search criteria at startup option, the Device
Search dialog box opens. Select the filtering criteria you want and then select OK to
open the Configuration - Device window with the filtered list of devices.
If you have not selected the Display search criteria at startup option, the
Configuration - Device window opens with a list of all configured devices.
GFK-1180H
12-1
The Configuration - Device window always displays the following attribute for each
device:
Device ID
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
The list of devices is initially sorted by Device ID. You may click on any of the
other attribute buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
12-
Modify a device.
Delete a device.
GFK-1180H
Press Ctrl+N.
After you initiate the request, the New Device dialog box opens.
Port
Select OK to continue configuring the new device. The Device Properties dialog
box for the new device opens. You will need to enter information for the General
and device-specific properties.
When you are finished defining the device properties, select OK to close the Device
Properties dialog box and create the new device, or select Cancel to close the dialog
box without creating the new device.
GFK-1180H
Device Configuration
12-3
The General properties let you define the following for a new device:
Port
Description
Resource
Model Type
12-
Select the type of device from the drop-down list. The list of
model types depends on the protocol.
GFK-1180H
Device-Specific Properties
The device-specific properties depend on the type of device you are configuring. See
the CIMPLICITY HMI Device Communications Manual (GFK-1181) for detailed
information.
For devices used by both CIMPLICITY HMI and CIMPLICITY Control, see "Using
CIMPLICITY HMI with CIMPLICITY Control" for detailed information.
Modifying A Device
To modify a device, you can double-click the Device you want to modify.
Alternatively, you can select the Device you want to modify, then do one of the
following:
Press Ctrl+M.
After you initiate the request, the Device Properties dialog box opens. The
properties contain the devices current configuration information. You can modify
any of these properties.
Select OK to close the Device Properties dialog box and modify the information for
the selected Device.
Select Cancel to close the Device Properties dialog box without modifying the
Device.
GFK-1180H
Device Configuration
12-5
Resource Configuration
About Resources
Resources are the physical or conceptual units that comprise your facility. They can
be devices, machines, or stations where work is performed, or areas where several
tasks are carried out. Resource configuration plays an important role in your
CIMPLICITY HMI project by routing alarms to specific users and filtering the data
users receive.
CIMPLICITY HMI software uses resources in the following ways:
Each 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.
Configuring Resources
To configure resources, double-click the Resources icon from your projects
Workbench.
If you have selected the Display search criteria at startup option, the Resource Search
dialog box opens. Select the filtering criteria you want, then select OK to open the
Configuration - Resource window with the filtered list of resources.
If you have not selected the Display search criteria at startup option, the
Configuration - Resource window opens with a list of all configured resources.
GFK-1180H
13-1
The Configuration - Resource window always displays the following attribute for
each resource:
Resource
Resource Type
Alarm Mgr
The list of resources is initially sorted by Resource. You may click any of the other
attribute buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
13-2
Modify a resource.
Delete a resource.
GFK-1180H
Press Ctrl+N.
After you initiate the request, the New Resource dialog box opens.
Enter the name of the new resource in the Resource ID field and select OK. The
system verifies that the Resource ID does not already exist, and that no invalid
characters have been used.
If the Resource ID you entered is valid, the Resource Definition dialog box for the
new resource opens.
Resource Definition
The Resource Definition dialog box lets you define the following for a new resource:
Description
GFK-1180H
Resource Configuration
The list of users that can view alarm or point information for
this resource.
13-3
The users currently assigned this resource are displayed in the Users for this
Resource box. Users currently not assigned this resource are displayed in the
Available Users box. You can add users, delete users, view and modify user
properties, or create new users.
When you are through entering information, you can select OK to close the dialog
box and create the new resource, or you can select Cancel to close the dialog box
without creating the new resource.
2.
Select Add.
The new user appears in the Users for this Resource box.
2.
Select Remove.
Select the user in either the Available Users or Users for this
Resource box.
2.
Select Properties.
The User Properties dialog box for the selected user opens. You can view and
modify the General and Resources properties for the selected user.
13-4
1.
2.
3.
Select OK. The User Properties dialog box for the new user will be
displayed.
4.
Enter the General and Resources properties for the new user.
GFK-1180H
Port Configuration
About Ports
A port is a communication "socket" that connects one or more factory devices such
as PLCs to the computer.
Use this function to configure ports and specify their characteristics. Configuration
requirements for ports vary depending on the type of port and communications
protocol being used. See the CIMPLICITY HMI Device Communications Manual
(GFK-1181) for detailed information on configuring ports for your specific device.
Configuring Ports
You can create a maximum of sixteen (16) ports per project. If you attempt to create
more ports after that, the following message displays:
To configure ports, double-click the Ports icon from your projects Workbench.
If you have selected the Display search criteria at startup option, the Port Search
dialog box opens. Select the filtering criteria you want, then select OK to open the
Configuration - Port window with the filtered list of ports.
GFK-1180H
14-1
If you have not selected the Display search criteria at startup option, the
Configuration - Port window opens with a list of all configured ports.
The Configuration - Port window always displays the following attribute for each
port:
Port
Description
The list of ports is initially sorted by Port. You may click on any of the other
attribute buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
14-2
Modify a port.
Delete a port.
GFK-1180H
Press Ctrl+N.
After you initiate the request, the New Port dialog box opens.
If Node is not grayed out, you will need to select the node name of
the computer where the port is located.
To select a node, click the drop-down list button the right of the input
field to display the list of available nodes, then click the name of the
node where the port is located.
Protocol
The protocols available to you will depend on the node you select,
and the device communication protocols available on that node.
To select a protocol, click the drop-down list button to the right of
the input field to display the list of available protocols, then click the
protocol you want to use.
Port
The ports available to you will depend on the node and protocol you
select.
To select a port, click the drop-down list button to the right of the
input field to display the list of available ports for the protocol, then
click the port you want to use.
Select OK to continue configuring the new port. The Port Properties dialog box for
the new port opens. You will need to enter information for the General and portspecific properties.
When you are finished defining the port properties, select OK to close the Port
Properties dialog box and create the new port, or select Cancel to close the dialog
box without creating the new port.
GFK-1180H
Port Configuration
14-3
The General properties let you define the following for a new port:
Description
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
Enable
Port-Specific Properties
The port-specific properties depend on the type of port you are configuring. See the
CIMPLICITY MMI and MES/SCADA Products Device Communications Manual
(GFK-1181) for detailed information.
14-4
GFK-1180H
GFK-1180H
1.
If you plan to re-use the same point data, export the point data for the
port using the Import/Export utility.
2.
3.
4.
5.
6.
7.
If you exported the point data, then use the Import/Export utility to
import the point data. Otherwise, define new points.
Port Configuration
14-5
GFK-1180H
15-1
If you have not selected the Display search criteria at startup option, the
Configuration - Alarm Class window opens with a list of all configured alarm
classes.
The Configuration - Alarm Class window always displays the following attribute for
each Alarm Class:
Class ID
Order
Alarm State BG
Alarm State FG
Normal State BG
Normal State FG
Ack State BG
Ack State FG
The list of classes is initially sorted by Class ID. You may click any of the other
title buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
Copy the information for a selected alarm class to a new alarm class.
Note that the colors are displayed by number rather than name in this window.
15-2
GFK-1180H
Press Ctrl+N.
After you initiate the request, the Alarm Class dialog box opens.
Select OK to close the Alarm Class dialog box and create the new Alarm Class.
Select Cancel to close the Alarm Class dialog box without creating a new Alarm
Class.
Enter the following information to create a new Alarm Class:
Class ID
Enter the name of the new Alarm Class. The class name can be up to five (5)
characters in length. Each class name must be unique.
Note that you cannot use the $ or | characters in a Class ID.
Description
Enter a description of the Alarm Class. The description can be up to 64 characters in
length.
Order
Enter the Alarm Class order (priority). This must be a number between 0 and 99.
The lower the number you enter, the higher the priority of the class.
GFK-1180H
15-3
Normal State
You can select the foreground (text) and background colors for displaying alarms in
this class in Alarm Viewer that are in the Normal state.
Default colors are White for the text and Black for the background.
Alarm State
You can select the foreground (text) and background colors for displaying alarms in
this class in Alarm Viewer that are in the Alarm state.
Default colors are White for the text and Black for the background.
Acknowledged State
You can select the foreground (text) and background colors for displaying alarms in
this class in Alarm Viewer that are in the Acknowledged state.
Default colors are White for the text and Black for the background
Audio Support
You can configure an alarm class to use audio alarming whenever an alarm in that
class is generated.
For details on configuring and using this feature, see Using Alarm Audio Support.
15-4
GFK-1180H
GFK-1180H
Red
Green
Blue
Color
Black
255
Red
255
Lime
255
Blue
128
Maroon
128
Green
128
128
Purple
255
255
255
White
128
128
Teal
128
128
128
Gray
10
128
128
Olive
11
32
64
64
Dark
12
224
176
160
Rose
13
255
255
Fuchsia
14
255
255
Aqua
15
255
255
Yellow
15-5
You want to add more colors to the default table (indexes 96 through
255 are available for this purpose)
You are importing screens from a CIMPLICITY System-I/U, -D/V, H/U or -RS/U system that do not used the default color mappings.
you need to be aware that indexes 0 through 15 in the RGB.DAT file are the default
colors used by Alarm Class configuration, Alarm State animation and Color Index
animation. If you change the colors in indexes 0 through 15 of the RGB.DAT file,
you need to change to colors displayed in the Alarm Class dialog box to match them.
To change the colors, create an AM_COLORS.CFG file in the same directory as
your RGB.DAT file. The first line in the file must contain only the |-* characters.
Each succeeding line contains an index number (0 through 15) followed by a vertical
bar ( | ) and the color name.
The following is an example of an AM_COLORS.CFG file (the colors listed in this
sample file match the default colors):
|-*
0|Black
1|Red
2|Lime
3|Blue
4|Maroon
5|Green
6|Purple
7|White
8|Teal
9|Gray
10|Olive
11|Dark
12|Rose
13|Fuchsia
14|Aqua
15|Yellow
Use the same RGB.DAT and AM_COLORS.CFG files for all projects. The file that
is used to display colors is the file for the project that Alarm Viewer or CimView
was started in, not the file for the project where the Alarm Classes or CimView
screens were configured.
15-6
GFK-1180H
When the points value is greater than or equal to the Alarm High
value, it is in the Alarm High state, and the Alarm High Msg will be
displayed in the %State field.
When the points value is greater than or equal to the Warning High
value, and less than the Alarm High value, it is in the Warning High
state, and the Warning High Msg will be displayed in the %State
field.
When the points value is less than or equal to the Warning Low
value, and greater than the Alarm Low value, it is in the Warning Low
state, and the Warning Low Msg will be displayed in the %State
field.
When the points value is less than or equal to the Alarm Low value, it
is in the Alarm Low state, and the Alarm Low Msg will be displayed
in the %State field.
When the points value is less than the Warning High value and
greater than the Warning Low value it is in the Normal state, and
"NORMAL" will be displayed in the %State field.
For digital points, only one alarm state can be defined. That is, a digital point is in
alarm when it is either "1" or "0". Otherwise, the points value is in the Normal state.
Also, note the following:
GFK-1180H
If the alarm value is "1", the Alarm High Msg is displayed in the
%State field when the point is in alarm.
If the alarm value is "0", the Warning High Msg is displayed in the
%State field when the point is in alarm.
16-1
For example, the following alarm message has been configured for an analog point:
Temp Alarm - Temp: %STATE
Warning High
Warning Low
Alarm Low
VERY HOT
HOT
COLD
VERY COLD
and has values defined for the Alarm High, Warning High, Warning Low, and
Alarm Low alarm limits.
If the value of the analog point is above the Alarm High value, the text of the Alarm
message will be
Temp Alarm - Temp: VERY HOT
Each set of alarm strings is identified by an index number that is specified when the
set is defined. Up to 99 sets, numbered 1 through 99, can be configured. When a
point is configured, an appropriate set of alarm strings may be selected for inclusion
in the alarm message.
The default configuration includes a set of alarm strings for Index number 1. This is
the default Alarm String Index that is used when you add a device point. This string
may be modified but should never be deleted.
16-2
GFK-1180H
The Configuration - Alarm String window always displays the following attribute for
each Alarm String Index:
Index
The list of alarm strings is initially sorted by Index. You may click any of the other
attribute buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
Copy the information for a selected alarm string to a new alarm string.
Press Ctrl+N.
After you initiate the request, the Alarm String Index dialog box opens.
GFK-1180H
16-3
Enter information in the in this dialog box to create a new Alarm String Index.
Select OK to close the Alarm String Index dialog box and create a new Alarm String
Index.
Select Cancel to close the Alarm String Index dialog box without creating a new
Alarm String Index.
Alarm High
Enter the alarm string to be displayed when a point using this Alarm String is in the
Alarm High state. The string can contain up to 16 characters.
Warning High
Enter the alarm string to be displayed when a point using this Alarm String is in the
Warning High state. The string can contain up to 16 characters.
Warning Low
Enter the alarm string to be displayed when a point using this Alarm String is in the
Warning Low state. The string can contain up to 16 characters.
Alarm Low
Enter the alarm string to be displayed when a point using this Alarm String is in the
Alarm Low state. The string can contain up to 16 characters.
16-4
GFK-1180H
Alarm Configuration
About Alarms
CIMPLICITY HMI software generates alarms for points that are in an alarm state. It
also generates alarm messages about system events, such as device failures, program
terminations, system startups, and system shutdowns.
To configure or modify alarms for
points, use the Configure Points
function.
Use Configure Alarm Definitions to configure alarm definitions for alarms generated
by custom software or to modify alarms for CIMPLICITY HMI system events or
product options.
Description
%ID
%VAL
%EU
%LIMIT
%STATE
%DEV_ID
%DEV_VAL
%DEV_AMT
Displays the difference between the current point value and the
deviation point value.
%%
The contents of each variable message field are determined when the alarm is
generated.
Note
You may see alarms in the list whose messages include variables such as %d, %s, or
%o. These alarms are system alarms whose messages may not be modified.
GFK-1180H
17-1
Standard Alarms
A set of standard event alarms is included in your base configuration. These alarms
are not associated with any CIMPLICITY Point IDs. They may be modified, but
they should never be deleted. They are:
$ALARM_DISABLED
Alarm is disabled for the specified point.
$ALARM_ENABLED
Alarm is enabled for the specified point
$ALARM_MODIFIED
Alarm is modified for the specified point.
$ALARM_RAWLIM
Alarm raw limits modified for the specified point.
$ALARM_RESTORED
Alarm limits restored for the specified point.
$AM_STATUS
Alarm Management status message used to analyze system performance. This
message is issued every half-hour and shows the number of alarms generated, the
count of alarms acknowledged, reset and deleted, and the average number of
seconds required to log an alarm.
$DEVICE
Alarm message for specified device.
$DEVICE_DOWN
Device failure message for specified device.
$DEVICE_FAILOVER
Reserved for future use.
$DL_FILE_FULL
Log file full message for specified log file.
$DOWNLOAD
Setpoint was downloaded to specified device.
$DYN_CFG
The specified entity has been changed dynamically
$GMR_DEV_DOWN
Device down message for Series 90 TCP/IP PLC redundancy.
$GMR_POINT_DISCREPANCY
Point discrepancy alarm for Series 90 TCP/IP PLC redundancy.
17-2
GFK-1180H
$LOGIN_FAILURE
Specified user failed to log in to the specified CIMPLICITY project.
$LOGON
Specified user has logged in to a specified CIMPLICITY project.
$LOGOUT
Specified user has logged out from a specified CIMPLICITY project.
$REDUND_DEV_DOWN
Alarm message for PLC redundancy.
$RTR_LINK_DOWN
Router link has been lost to specified node.
AMSI_ALARM
Reserved for future use.
DB_CONN_DOWN
Process has lost connection to specified logging database.
DB_START_FORWARD
Process is forwarding data to specified logging database.
MCP_PROC_DOWN
Specified CIMPLICITY process has terminated unexpectedly.
GFK-1180H
Alarm Configuration
17-3
Click the Alarm icon in your projects Workbench, hold down the right
mouse key and select Setup from the drop-down menu.
The Store alarm comments option lets you enable or disable the saving of alarm
comments beyond the actual life of the alarm. If you want to save alarm comments
beyond the actual life of alarms, select the Store alarm comments check box. If
you do not want to save alarm comments, clear the check box.
Click OK to close the dialog box and save your changes, or click Cancel to close
the dialog box without implementing any changes.
17-4
If you intend to use the Store alarm comments option, make sure
that the alarm_help directory is writable.
GFK-1180H
Configuring Alarms
To configure an alarm, double-click the Alarms icon in your projects Workbench.
If you have selected the Display search criteria at startup option, the Alarm
Definitions Search dialog box opens. Select the filtering criteria you want, and then
select OK to open the Configuration - Alarm Definitions window with the filtered
list of alarms.
If you have not selected the Display search criteria at startup option, the
Configuration - Alarm Definitions window opens with a list of all configured alarms.
The Configuration - Alarm Definitions window always displays the following for
each alarm:
Alarm ID
Alarm Type
The type of alarm format used for this alarm. This field is
display only. An Alarm Type will be assigned by
CIMPLICITY HMI software to an alarm if it contains variable
run-time parameters (see page 17-1).
Description
Message
Fixed text and run-time parameters that are displayed when the
alarm is generated.
You can control the amount of data presented, and the order in which it is presented.
Select Attributes... from the View menu, or click Attributes on the Toolbar to
open the Configure Display Attributes dialog box and make your changes.
GFK-1180H
Alarm Configuration
17-5
The Alarm Definition list is initially sorted by Alarm ID. You may click on any of
the other title buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
Modify an alarm.
Delete an alarm.
Press Ctrl+N.
After you initiate the request, the New Alarm dialog box opens.
Enter the name of the new alarm in the Alarm ID field and click OK. The system
verifies that the Alarm ID does not already exist, and that no invalid characters have
been used.
If the Alarm ID you entered is valid, the Alarm Definition dialog box for the new
alarm opens. You will need to enter information on the following property pages:
17-6
Alarm Definition
Alarm Routing
Alarm Options
GFK-1180H
The Alarm Definition properties for a non-point alarm let you define the following
for an alarm:
Description
Enter an optional description of the alarm.
Alarm Class
Enter a valid Alarm Class ID in this field. Alarms with similar characteristics can be
grouped by class and classes can be prioritized. When a user sorts alarms by Class in
the Alarm Viewer, the alarms class determines the order in which this alarm appears
relative to other alarms.
You can click the Browser button - to the right of the input field to
use the Select an Alarm Class Browser to select the Class ID.
You can click the Pop-up menu button - to browse for an Alarm
Class, edit an existing Alarm Class or create a new Alarm Class for the
alarm.
Alarm Type
Select a valid alarm type from the drop-down list. The alarm type you select
determines the alarm message format.
For detailed information on Alarm Types, see the CIMPLICITY HMI Integrators
Toolkit Operation Manual (GFK-1461).
GFK-1180H
Alarm Configuration
17-7
Help Files
Enter the name of an optional Help file that users can display in the Alarm Viewer
by clicking Help. You can enter a file name of up to eight (8) characters. If you
wish, you may use the same Help File for several alarms.
The Help file is a text file you create with a text editor (for example, Notepad). The
file can contain up to sixty (60) lines of ASCII text. Each line can have a maximum
of 70 characters. The Help file must be in the projects alarm_help directory.
Alarm Message
Enter the text of the alarm message in this field. An alarm message consists of any
combination of fixed text, and variable run-time parameters (see page 17-1). The
total display length for all fixed text and variable parameters is 80 characters.
Logging
If Database Logging is installed on your computer, you can select the Log Alarm
check box to enable logging for this alarm. If you enable logging, you can then click
Settings... to define the logging parameters for the alarm. Clear the Log Alarm
check box to disable logging for this alarm.
17-8
GFK-1180H
The Alarm Definition properties for point alarms let you define the following for an
alarm:
Definition
This input box lets you define the alarm class and message that will be used when
this points value goes into an alarm state.
Alarm Class
Alarm Message
GFK-1180H
Alarm Configuration
17-9
17-10
GFK-1180H
Alarm Criteria
You can select one of the following methods for evaluating the alarm values:
See Types of Alarming in Chapter 5, "Point Configuration", for details on Alarm
Criteria.
Absolute
On Change
Rate of Change
Deviation
Alarm Values
Enter the values you want for alarm limits in these fields. The evaluation of alarm
limits depends on the Alarm Criteria you select.
GFK-1180H
For Absolute alarming, you can define an upper and lower alarm limit
and an upper and lower warning limit for the point value.
For Rate of Change alarming the high values are used to detect faster
than expected changes, and the low limits are used to detect slower than
expected changes. Specify positive alarm limits to check for increasing
values and negative alarm limits to check for decreasing values.
For Deviation alarming, you can define an upper and lower alarm limit
and an upper and lower warning limit for the difference between the
value of this point and the Deviation point.
For digital points, you can choose to alarm when the point value is 0 or 1.
Alarm Configuration
17-11
Alarm Delay
The Alarm Delay feature is only available when you select Absolute alarming. If
you set the Delay Alarms check box, the Interval fields represent the length of the
delay before the alarm is reported. This means an alarm will not be generated unless
the point remains in an alarm state for the configured interval.
Deadband
Enter a value defining the tolerance for alarm conditions in this field.
The deadband cushions the generation of alarms when a point value fluctuates at an
alarm limit. For example, if a high alarm limit is defined as 100, the points alarm
state changes each time the point value goes from 99 to 100 or 100 to 99. If a
deadband of 5 is defined, the point will go into the alarm state when its value reaches
100, and will stay in the alarm state until the value drops below 95.
Help File
Enter the name of a text file that users can display when they click the Help button in
the Alarm Viewer. You can enter a filename of up to 8 characters.
The actual file is in the projects alarm_help directory in your project. The actual
filename is the name given in this field, followed by ".HLP".
Alarm Help files are ASCII text files of up to sixty (60) lines. Each line can have a
maximum of 70 characters. You can use Notepad to create an Alarm Help file.
If you wish, you may use the same Help File for several points.
17-12
GFK-1180H
The Alarm Routing properties let you choose the roles to which this alarm will be
routed. All the currently available roles are listed in the Available Roles box. All
the roles currently configured for this alarm are listed in the Configured Roles for
Alarm box.
You can:
Adding A Role
To add a role to the Configured Roles for Alarms list:
1.
2.
Click Add.
Removing A Role
To remove a role from the Configured Roles for Alarms list:
1.
2.
Click Remove.
Modifying A Role
To view (and possibly modify) the properties for a particular role:
1.
2.
Click Properties. The Role Properties dialog box for the selected
role opens.
GFK-1180H
1.
2.
3.
Click OK. The Role Properties dialog box for the selected role opens.
4.
5.
Click OK to create the new role and close the Role Properties dialog
box.
Alarm Configuration
17-13
The Alarm Options properties let you define the Repeat, Acknowledge, Delete, and
Reset requirements for the alarm.
Use Repeat Timeout to control how often the alarm will be re-sent to
alarm printers.
Select the Manual Reset Allowed check box if you want to let users
manually reset the alarm. The alarm can also be reset by the
application that detected the alarm condition and by the Alarm Manager
when an Automatic Reset is defined.
If you clear the Manual Reset Allowed check box, the alarm can
only be reset by the application detecting the alarm condition or by the
Alarm Manager when an Automatic Reset is defined.
17-14
GFK-1180H
Repeat Timeout
If you have configured an Alarm Printer, use these fields to control how the message
for this alarm will be sent to the Alarm Printer:
Time
The actual number of minutes that the Alarm Manager will wait before repeating the
alarm may be greater than this number. The maximum time will be the number you
enter in this field plus the number of minutes configured for the timer for processing
automatic alarms in the Alarm Manager configuration file (alarm_mgr.dat). The
default for this timer is 5 minutes.
Immediate
Never
Select this radio button if you do not want to send the alarm
message to any interested processes.
Deletion Requirements
The Deletion Requirements determine the conditions under which the alarm may be
deleted from the system. You can choose one or both of the following:
Acknowledge
Reset
If you select both check boxes, the alarm will not be deleted until it has been
acknowledged and reset.
GFK-1180H
Alarm Configuration
17-15
Acknowledge Timeout
Use these fields to control how the alarm will be acknowledged.
Time
Select this radio button and enter the number of minutes in the
Minutes input field for the Alarm Manager to wait before
automatically acknowledging the alarm.
The user may acknowledge the alarm before the time period
expires.
Note
The actual number of minutes that the Alarm Manager will wait before automatically
acknowledging the alarm may be greater than this number. The maximum time will
be the number you enter in this field plus the number of minutes configured for the
timer for processing automatic alarms in the Alarm Manager configuration file
(alarm_mgr.dat). The default for this timer is 5 minutes.
Immediate
Never
Reset Timeout
Use these fields to control how the alarm will be reset.
Time
Select this radio button and enter the number of minutes in the
Minutes input field for the Alarm Manager to wait before
automatically resetting the alarm.
The alarm may also be reset by the application detecting the
alarm condition or manually by a user (if manual reset is
allowed) before the time interval expires.
Note
The actual number of minutes that the Alarm Manager will wait before automatically
resetting the alarm may be greater than this number. The maximum time will be the
number you enter in this field plus the number of minutes configured for the timer for
processing automatic alarms in the Alarm Manager configuration file
(alarm_mgr.dat). The default for this timer is 5 minutes.
17-16
Immediate
Never
GFK-1180H
To generate an audio alarm with the beep, your computer needs the system beep (you
can also generate a beep from a sound card, but it is not required). If you do have a
sound card, you can configure the frequency, duration and number of beeps. If you
do not have a sound card:
For Windows NT, you can configure the frequency, duration and
number of beeps.
Audio alarms are prioritized by two keys, alarm class priority and project priority.
You can select one of these keys to be the primary key for prioritization.
GFK-1180H
The sound for first alarm for the highest priority Alarm Class is played
first.
If alarms exist for the same Alarm Class in more than one project, then
the highest priority alarm for the highest priority project is played first.
18-1
If more than one project has the highest priority, then the order in which
the projects are displayed in the Alarm Sound Manager window
determines the project priority.
When you prioritize alarms by Project priority, the determination of the highest
priority alarm is:
The sound for the alarm with highest priority Alarm Class in the highest
priority project is played first.
If more than one project has the highest priority, then the order in which
the projects are displayed in the Alarm Sound Manager window
determines the project priority.
Examples
Suppose you have three projects, each with two Alarm Classes as follows:
Project
Priority
PROJ1
ALM1A
ALM1B
PROJ2
ALM2A
ALM2B
PROJ3
ALM3A
ALM3B
Alarm Class
Priority
Alarm Class
Priority
In addition, you currently have one alarm generated for each class in each project.
If you prioritize audio alarms by Alarm Class, the alarm order is:
ALM3A, ALM2A, ALM1A, ALM3B, ALM2B, ALM1B
If you prioritize audio alarms by Project priority, the alarm order is:
ALM3A, ALM3B, ALM2A, ALM2B, ALM1A, ALM1B
18-2
GFK-1180H
2.
Select the Alarm Class for which you want to configure Alarm Audio
support from the list of Alarm Classes.
3.
Open the Alarm Class Configuration dialog box for the Alarm Class.
4.
Set the Audio support check box if you want audio support for the alarm class.
You can configure two types of sounds:
Wave file
Beep
GFK-1180H
Select OK to save all changes made and close the Alarm Class
Configuration dialog box.
Select Apply to save all changes made and leave the dialog box open.
Select Cancel to close the Alarm Class dialog box without saving
changes.
18-3
Click the Wave file radio button to use a wave (.WAV) file when the
alarm sounds.
2.
Enter the name of the save file in the File name field. You can use the
browser button to browse for a wave file for this field.
You can specify logical names in the file name, such as SITE_ROOT and BSM_ROOT
in the path name for the wave file. These are expanded into actual directory names
when the file is used. For example, SITE_ROOT:\sounds\high.wav refers to
the file high.wav in the sounds directory within the HMI projects directory.
You can also use a special variable called WIN_DIR, which expands to the Windows
NT/98/95 directory.
Beep Configuration
To configure a beep for audio alarming:
1.
Click the Beep radio button if you want to use a beep sound.
On computers with sound cards, this is the default sound event.
On computers without sound card, this is the default system beep.
2.
18-4
Use the Delay field to enter the delay between the beeps in
milliseconds. Select a value between 0 and 10000 milliseconds.
GFK-1180H
You can click on the icon to open the Alarm Sound Manager window.
GFK-1180H
18-5
The items on the lower part of the Alarm Sound Manager window are available at all
times.
They include:
You can use the Projects, Options, and Startup pages to select the projects whose
alarms you want to display, the priority of concurrent alarms, start the Alarm Sound
Manager at startup and select a default profile file.
18-6
GFK-1180H
Projects Properties
The Projects page lets you add and remove broadcasting projects to the current
session.
While you are displaying this property page, you still have access to the alarm
information at the bottom of the window.
Adding a project
To add a project, click on the Add button. The Add Project dialog box opens.
Use the drop-down list button to the right of the Project field to select a project to
add.
Select the project priority by specifying a number greater or equal to zero (0). The
higher the number, the lower the priority (which means that zero (0) is the highest
priority).
The project is placed in the list of projects according to its priority. If more than one
project has the same priority, then they are displayed in the order that they were
added to the list.
GFK-1180H
18-7
Examples:
For example, if you connect to PROJ1 with priority 3, PROJ2 with priority 2, and
PROJ3 with priority 1, then the list of projects looks like this:
PROJ3
PROJ2
PROJ1
If you connect to PROJ1 with priority 3, PROJ2 with priority 1 and PROJ3 with
priority 1, then the list of projects looks like this:
PROJ2
PROJ3
PROJ1
This project ordering is used by the Alarm Sound Manager to help determine which
sound plays first at run-time.
Deleting a project
To delete a project, select it and click on the Delete button.
18-8
GFK-1180H
Option Properties
Specify the alarm sound/beep stop condition. You can select one of the
following:
Reset only - the alarm sound/beep stops when the alarm is reset.
Both Ack and Reset - the alarm sound/beep stops when the
alarm is acknowledged and reset.
GFK-1180H
18-9
While you are displaying this property page, you still have access to the alarm
information at the bottom of the window.
Startup Properties
The Startup page lets you configure the Alarm Sound Manager to start up at boot
time, and specify a default profile to use whenever the Alarm Sound Manager starts.
While you are displaying this property page, you still have access to the alarm
information at the bottom of the window.
To start the Alarm Sound Manager at boot, set the Start at Windows startup
check box.
To specify a profile file to be used by the Alarm Sound Manager when it starts, enter
the name of the file in the Use profile field. You can use the browser button to the
right of the input field to search for a profile file.
18-10
GFK-1180H
Each Alarm Blocking group works independently. This means that the high priority
alarms in one group do not block the high priority alarms in another group.
Before you implement Alarm Blocking, you need to plan how you want to group and
prioritize your alarms for your project. You need to decide:
Alarms that you do not assign to Alarm Blocking groups are not affected by Alarm
Blocking.
GFK-1180H
19-1
Assigning Alarms
CIMPLICITY HMI software generates two types of alarms; point alarms and system
alarms. Each point alarm is uniquely identified by its Alarm ID. Each system alarm
is uniquely identified by its Alarm ID and Resource ID.
For example:
For Alarm Blocking, you can assign a uniquely identified alarm to only one group.
This means:
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.
If you select Peer Blocking mode, only the first alarm in a set of alarms
with equal priority displays.
If you select Non-Peer Blocking mode, all alarms in a set of alarms with
equal priority display.
19-2
GFK-1180H
If there is a current alarm with higher priority in the group, the newly
generated alarm is blocked.
For Peer Blocking, if there is a current alarm with equal priority in the
group, the newly generated alarm is blocked. In other words, only one
alarm in a set of alarms with equal priority displays at any given time.
For Non-Peer Blocking, all current alarms with equal priority display at
any given time.
For Peer Blocking, if alarms of equal priority exist, the oldest one
displays and becomes the new blocking alarm.
For Non-Peer Blocking, all alarms with the next lower priority display
and become the new blocking alarms.
If lower priority alarm is the current blocking alarm and a higher priority alarm is
generated, the lower priority alarm remains on the list of alarms and the higher
priority alarm becomes the new blocking alarm.
If an alarm already exists in Normal state and it returns to Alarm state, the alarm is
not blocked.
GFK-1180H
19-3
The Alarm Blocking Group - Configuration window always displays the following
attribute for each Alarm Class:
Group ID
Peer block
The list of groups is initially sorted by Group ID. You may click any of the other
title buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
19-4
GFK-1180H
Press Ctrl+N.
After you initiate the request, the Alarm Blocking dialog box opens.
You can resize the width of the Alarm ID, Priority and Resource ID fields to suit
your needs.
Enter the following information to create a new Alarm block group:
Group ID
Description
Peer block
GFK-1180H
19-5
Alarms
Select OK to close the Alarm Blocking dialog box and create the new Alarm block
group. Select Cancel to close the Alarm Blocking dialog box without creating a new
Alarm block group.
Adding an Alarm
You can enter the name of an Alarm ID in the Alarm ID field in any of the following
ways:
You can select Add to open the Browser dialog box and browse for the
Alarm ID you want.
You can click the Browser button to the right of the input field to open
the Browser dialog box and browse for the Alarm ID you want.
You can click the Pop-up menu button to the right of the input field to
create a new Alarm ID, modify the current Alarm ID or browse for an
Alarm ID.
Enter the priority of the Alarm ID in the Priority field. This can be a number from 0
to 32767. The higher the number you enter, the higher the blocking priority for the
alarm. For example, if you have alarm XXX with priority set to 10 and alarm YYY
with priority set to 100 in the same group, when alarm YYY generates, it blocks
alarm XXX.
If the Alarm ID does not have a Point ID, you must assign a Resource ID to the
alarm. You can click the Browser button to the right of the input field to open the
Browser dialog box and browse for the Resource ID you want. You can also use the
Pop-up menu button to create a new Resource ID, modify the current Resource ID or
browse for a Resource ID. Remember that each Alarm ID/Resource ID combination
must be unique within a group and across all groups.
Removing an Alarm
To remove an alarm from an Alarm block group:
1.
2.
Press Delete.
19-6
GFK-1180H
Modifying an Alarm
You can modify an alarms name, priority and Resource ID in the list. All you need
to do is:
1.
2.
If you are changing an Alarm ID or Resource ID, you can also use the Browser and
Pop-up Menu buttons in the field to search for a new one.
You can also set a number of alarms to the same priority and/or Resource ID at the
same time. To do this:
1.
Select the alarms whose priority and/or Resource ID you want to set.
You can use the Shift and Ctrl keys while making your selection.
2.
3.
Enter the new priority and/or Resource ID for the alarms and select
OK. All the selected alarms will be assigned the new priority. Nonpoint alarms will be assigned the new Resource ID.
Press Ctrl+M.
After you initiate the request, the Alarm Blocking dialog box opens. The fields
contain the groups current configuration information. You can:
Select OK to close the Alarm Blocking dialog box and modify the information for the
selected Alarm group.
Select Cancel to close the Alarm Blocking dialog box without modifying the Alarm
group.
GFK-1180H
19-7
GFK-1180H
20-1
The Alarm Log Printer - Configuration window always displays the following for
each printer:
Name
Destination
Page Width
Page Length
The list of alarm printers is initially sorted by Name. You may click on any of the
other title buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
Press Ctrl+N.
After you initiate the request, the New Alarm Log Printer dialog box opens.
Enter the name of the new alarm printer, or the name of the file you want to write
alarms to in the Name field and select OK. You may enter a maximum of 16
characters. The system verifies that the alarm printer name does not already exist,
and that no invalid characters have been used.
If the alarm printer name you entered is valid, the Alarm Printer properties dialog
box for the new alarm printer opens.
20-2
GFK-1180H
General Properties
The AMLP Configuration property page let you define the following for a new alarm
printer:
Log Events
Select this check box if you want to log events to the printer.
Log Alarms
Select this check box if you want to log alarms to the printer.
If you clear this check box, the Alarm logging options are grayed out.
GFK-1180H
20-3
20-4
Click the Browser button - to the right of the input field to display
the Select Alarm Class browser and use it to select the Alarm Class.
Click the Pop-up Menu button - to create a new Alarm Class, edit
the current Alarm Class, or browse for an Alarm Class.
GFK-1180H
Output
Enter the device name for the alarm printer. You can:
Enter the name of a local port on the projects computer (for example LPT1 or COM1) where you have attached the alarm printer.
Note
If you are connecting to serial port COM10 and above, the format is \\.\COM<n>.
Enter a file name to write alarms to a file. If you wish, you may also
enter a period followed by a three character file extension (for example,
alarms.fil).
If you do not enter a file extension, none is automatically provided.
The file is placed in the projects \log directory.
If the printer is connected locally on your computer, use the local port name instead
of the network path.
You can associate more than one alarm printer with a network printer or file on a
network disk. If you use a network printer or file, you should clear the Print
header field in the Layout property page.
GFK-1180H
20-5
Layout Properties
The Layout property page lets you determine whether a header should be printed at
the top of a page. Enter information in the following fields:
Print Headers
Set this check box if you want to print a header at the top of each page.
If you have more than one alarm printer process sending messages to the same printer
or file, clear this check box. When you clear the check box, the Page length field
is disabled.
20-6
GFK-1180H
Page Length
Enter the number of lines per page that can be printed. The number must be an
integer between 1 and 999.
Page Width
Enter the number of characters that can be printed on a line. The number must be an
integer between 80 and 132.
Date/Time Format
Use the Date/Time Format properties to choose how the alarm printer will print the
date and time.
You can define the following:
Header Date
Select the format you want to use to print the date on the alarm printer page header.
This field is not available if you are not printing a page header. A sample for the
format you choose displays in the Sample field in this box. You may select one of
the formats from the list, or construct your own format.
GFK-1180H
20-7
Alarm Date/Time
Select the format you want to use to print the date and time of each alarm. A sample
for the format you choose displays in the Sample field in this box. You may select
one of the formats from the list, or construct your own format.
mm
mmm
mmmm
dd
ddd
dddd
Last two digits of year. For digits 00 through 09, only the last digit is
displayed.
yy
Last two digits of year. For digits 00 through 09, both digits are displayed.
yyyy
For example, if you enter dddd dd mmmm yyyy, the sample date will be
Saturday 05 March 1994.
You may use spaces, dashes, slashes or any other delimiter of your choice to separate
the date fields.
To construct time formats, use the following information:
H
HH
HHH
HHHH
MM
SS
TT
P, A, p, or a
AM/PM indicator.
20-8
GFK-1180H
If you enter LPT1 in the Output field and select the Redundant
alarm printing check box, the Master project on COMP1 sends alarm
messages to LPT1 on COMP1 and the Slave project on COMP2 sends
alarm messages that it generates while in standby mode to LPT1 on
COMP2.
When the project on COMP2 becomes the Master project, it continues
to send alarm printer messages to LPT1 on COMP2.
If you enter LPT1 in the Output field and clear the Redundant
alarm printing check box, the Master project on COMP1 sends
alarms to LPT1 on COMP1. The Slave project on COMP2 sends no
alarms until it becomes the Master project.
When the project on COMP2 becomes the Master project, it sends
alarm messages to LPT1 on COMP2.
GFK-1180H
20-9
where
<port>
<rate>
<set>
<n>
<m>
For example, if you have a printer on COM1: port that communicates at 9600 baud,
no parity, 8 data bits and 1 stop bit, the file would look like this:
@echo off
mode COM1: baud=9600 parity=n data=8 stop=1
If you have more than one serial printer, you will need one mode line per printer.
To create this file:
20-10
1.
2.
3.
GFK-1180H
2.
3.
Type amlp_flush.exe.
The alarms will be printed.
You can also initiate amlp_flush.exe from scripts within the CIMPLICITY HMI
environment. This will trigger printing whenever the specified conditions (for
example an alarm going off) are met.
is generated.
To return to the default queue size, remove the AMLP_MAX_QUEUE record from
the Global Parameters file.
GFK-1180H
20-11
20-12
GFK-1180H
Role Configuration
About Roles
In CIMPLICITY HMI software, a role is the mechanism for granting users access to
privileged functions. Each user is assigned one role. Conversely, one role may be
assigned to several users.
The default configuration includes the following three roles:
SYSMGR
USER
OPER
For each role defined in CIMPLICITY HMI project, you can specify whether users
assigned that role can:
GFK-1180H
21-1
Configuring Roles
To configure a role, double-click the Roles icon in your projects Workbench.
If you have selected the Display search criteria at startup option, the Role
Search dialog box opens. Select the filtering criteria you want, and then select OK
to open the Configuration - Role window with the filtered list of roles.
If you have not selected the Display search criteria at startup option, the
Configuration - Role window opens with a list of all configured roles.
The Configuration - Role window always displays the following attribute for each
role:
Role ID
The list of Roles is sorted by Role ID. You may click on the title button to sort the
list.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
21-2
Modify a role.
Delete a role.
GFK-1180H
Press Ctrl+N.
After you initiate the request, the New Role dialog box opens.
Enter the name of the new role in the Role ID field and select OK. The system
verifies that the Role ID does not already exist, and that no invalid characters have
been used.
If the Role ID you entered is valid, the Role Properties dialog box for the new role
will be displayed. You will need to enter information in the following categories:
Privileges
When you are finished defining the roles properties, select OK to close the dialog
box and create the new role, or select Cancel to close the dialog box without
creating the new role.
Role Properties
The Privileges properties let you define the privileges for a new role. Check the
check box for each privilege you want to assign to a role.
GFK-1180H
Role Configuration
21-3
Role
General Privileges
Dynamic Configuration
Process Control
Script Control
Alarms Privileges
Delete Alarms
Points Privileges
Set Point
Point by Address
21-4
GFK-1180H
User Configuration
About Users
The Users function lets you configure users for your CIMPLICITY HMI project. A
user is an individual person working with a CIMPLICITY HMI project. Each
CIMPLICITY HMI user has the following attributes:
Security
Roles and
Privileges
View of
Resources
A users view determines the resource data to which the user has
access. Alarms for resources outside a users view will not appear
on the users Alarm Viewer window.
The default user does not require a password to access CIMPLICITY HMI project
functions.
Configuring Users
To configure a user, double-click the Users icon in your projects Workbench.
If you have selected the Display search criteria at startup option, the User
Search dialog box opens. Select the filtering criteria you want, and then select OK
to open the Configuration - User window with the filtered list of alarms.
If you have not selected the Display search criteria at startup option, the
Configuration - User window opens with a list of all configured alarms.
GFK-1180H
22-1
The Configuration - User window always displays the following attribute for each
user:
User ID
In addition to User ID, you can choose to display the following attributes for each
user:
Enabled
Password
Role ID
User Name
The list of Users is initially sorted by User ID. You may click on any of the other
attribute buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
22-2
Modify a user.
Delete a user.
GFK-1180H
Click the Users icon in your projects Workbench, hold down the right
mouse key and then select Setup from the drop-down menu.
Select Setup from the Edit menu in the Configuration - User window.
2.
Enter the number of failed login attempts before disabling the account.
Select OK to close the dialog box and save your changes, or select Cancel to close
the dialog box without implementing any changes.
GFK-1180H
1.
2.
3.
User Configuration
22-3
Press Ctrl+N.
After you initiate the request, the New User dialog box opens.
Enter the name of the new user in the User ID field and select OK. The system
verifies that the User ID does not already exist, and that no invalid characters have
been used.
If the User ID you entered is valid, the User Properties dialog box for the new user
opens. You will need to enter information in the following categories:
General
Resources
Defines the resources for which the user can view data.
When you are finished defining the users properties, select OK to close the dialog
box and create the new user, or select Cancel to close the dialog box without
creating the new user.
22-4
GFK-1180H
The General properties let you define the following for a new user.
Note
If you change a users configuration dynamically, the user must log out then log back
in for the changes to take effect.
Role
Enter the users role in this field.
You can click the Browser button - to the right of the input field to display the
Select A Role Browser and use it to select the role.
You can also use the Pop-up Menu button role, or Browser for another role.
Password Needed
Set this check box to require the user to enter a password at login. Clear this check
box if the user does not need to enter a password.
GFK-1180H
User Configuration
22-5
A user can change the password from the CIMPLICITY Login Panel.
User Name
Enter the users name or descriptive text about the user.
Enabled
Set this check box to enable the user account.
If you clear this check box, the account is disabled and is not available for user login.
If you disable an account dynamically, currently logged in users will not be logged
out; however, new login attempts will be rejected.
Password Expires
Enter the number of days until the users password expires or enter zero if the
password never expires.
After the elapsed number of days, the user will be required to change the password
prior to logging in.
In s Server Redundancy configuration, Automatic Password Expiration is not
supported.
22-6
GFK-1180H
The Resources properties let you define the resources for which the user can view
alarms. The resources currently assigned to the user are displayed in the
Resources box. You can add or delete resources.
Note
If you change a users resources dynamically, the user must log out then log back in
to access the changed resources.
Enter a valid Resource ID in the input box. You can click the Browser
button - to the right of the input field to use the Select A Resource
Browser and use it to select the Resource ID. You can also use the
Pop-up Menu button - to create a new Resource ID, edit the
current Resource ID, or browse for another Resource ID.
2.
Select Add.
GFK-1180H
User Configuration
22-7
Deleting A Resource
To delete a resource from the users list:
1.
2.
Select Delete.
22-8
GFK-1180H
Database Logger
GFK-1180H
Alarm Logging
Event Logging
Data Logging
Group Logging
Application Logging
23-1
Alarm Logging
Alarm Logging lets you log alarm information in the Alarm Log table. You can
specify alarms to be logged as they are generated, cleared, acknowledged, and/or
deleted.
The following system alarms are recorded in the Alarm Log table:
Alarm ID
Description
23-2
$DEVICE
$DEVICE_DOWN
$DEVICE_FAILOVER
$GMR_DEV_DOWN
$GMR_POINT_DISCREPANCY
$REDUND_DEV_DOWN
AMSI_ALARM
DB_CONN_DOWN
DB_START_FORWARD
MCP_PROC_DOWN
GFK-1180H
Event Logging
Event Logging lets you log system and user-defined events in the Event Log table.
The following system events are recorded in the Event Log table:
Event ID
Description
$ALARM_DISABLED
$ALARM_ENABLED
$ALARM_MODIFIED
$ALARM_RESTORED
$AM_STATUS
$DL_FILE_FULL
$DOWNLOAD
$DYN_CFG
$LOGIN_DISABLED
$LOGON
$LOGOUT
$RTR_LINK_DOWN
DEMO_SPEED
Data Logging
Data logging lets you log point data in a variety of ways.
You can log points:
Whenever point data is logged, the entry in the log file includes the Point ID, a
timestamp, and other optional attributes that you select.
GFK-1180H
Database Logger
23-3
Group Logging
Group logging lets you log information on a group of points in parallel. This method
gives better performance and uses disk space more efficiently than Data logging.
Each entry in a Group log table contains a timestamp and the information you select
for each point.
Group data can be logged as follows:
In response to an event.
Application Logging
Certain CIMPLICITY HMI applications, such as the Basic Control Engine, allow
you to log actions. To take advantage this feature, you must configure an
Application Table for the product option.
The application chooses what data to log and when to log it.
23-4
GFK-1180H
Creating Tables
When a project is started, the Database Logger creates any tables you have
configured for that project based on the attributes you have specified. This means
you dont have to know anything about databases to log data from your
CIMPLICITY project.
Specifically, when a project starts, the Database Logger will:
There are no implied wildcards. If you do not include or terminate your search string
with an asterisk, only those items that match your request exactly will be returned.
If a Browser button is available to the right of an input field, you can click it and use
the Browser to select the filter.
If you are calling ODBC functions directly, you cannot use the * and ? wildcards.
The underscore ( _ ) character is the only available wildcard. Use it to search for any
character in this place in a string.
If you are calling SQL functions directly, you can use the * and ? wildcards.
GFK-1180H
Database Logger
23-5
Table Characteristics
The Database Logger tables have the following characteristics:
Column Definitions
A table can have, at most, 250 columns. The following columns are defined for each
type of log file:
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.
The number of columns you can actually have in a group table depends on the type
of data you are storing. A record being added to the database can have at most 2 KB
of data. With overhead, 2 KB amounts to approximately 222 8-byte floating-point
numbers. (Points with Engineering Units conversion are stored in floating point
format.)
If you are storing a number of floating-point numbers or long text strings in a group
record, it is recommended that you verify that the 2 KB limit is not being exceeded.
23-6
GFK-1180H
Key Definitions
The following keys are defined for each type of log file:
Data logging tables have a primary key index on the joined timestamp
and Point ID columns, and a secondary index on the timestamp alone.
If you have selected the project name table attribute, the primary key
index also includes the project name column.
Alarm, Event, and Application logging tables have a primary key index
on the joined timestamp and sequence number columns, and a
secondary index on the timestamp alone. If you have selected the
project name table attribute, the primary key index also includes the
project name column.
Important
GFK-1180H
Database Logger
23-7
When you select Log Data, the point is automatically added to the
DATA_LOG table with the default point Logging Conditions for that
table. You can customize your point logging by selecting Settings....
The Point Logging dialog box opens.
When you select Log Alarm, the points alarm is automatically added
to the ALARM_LOG table with the default alarm Logging Conditions
for that table. You can customize your alarm logging by selecting
Settings.... The Alarm Logging dialog box opens.
Point Logging
When you select Settings... for Log Data, the Point Logging dialog box opens.
This dialog box lists the tables where the point you selected is currently being
logged. If the list is empty, the point is not being logged in any table.
Use this dialog box to add the point to logging tables, modify logging tables, or
remove the point from one or more logging tables.
23-8
GFK-1180H
Select Add....
2.
The Table Browser dialog box opens. Select the table or tables where
you want to add the point, then select OK to return to the Point
Logging dialog box.
3.
When you return to the Point Logging dialog box, the table(s) that you
selected are added to the list. You must confirm the additions in order
to have them take effect. Select Cancel to cancel the additions, or
select OK to confirm them.
2.
Select Modify....
3.
The Table Properties dialog box for the point opens. Make your
modifications, and then select OK to return to the Point Logging dialog
box.
4.
When you return to the Point Logging dialog box, the modifications
you have made to the point have already taken place. Note that the
Cancel button has changed to a Close button to indicate that you
cannot undo the modifications.
Select the tables from which you want to remove the point. The tables
that you select will be highlighted.
2.
Select Remove.
3.
4.
When you return to the Point Logging dialog box, the table(s) that you
selected are deleted from the list. You must confirm the deletions in
order to have them take effect. Select Cancel to cancel the deletions,
or select OK to confirm them.
GFK-1180H
1.
2.
3.
When you return to the Point Logging dialog box, all logging tables
that contain the point are deleted from the list. You must confirm the
deletions in order to have them take effect. Select Cancel to cancel
the deletions, or select OK to confirm them.
Database Logger
23-9
Alarm Logging
When you select Settings... for Log Alarm, the Alarm Logging dialog box opens.
The Alarm Logging dialog box shows you the table the point alarm is being currently
logged to along with the states that are being logged.
If the alarm is not currently being logged, the default setting is ALARM_LOG and
the default ALARM_LOG point properties are selected.
If the alarm is currently being logged, the initial settings will indicate which table is
being used, and which states are being logged.
You can log an alarm to the ALARM_LOG table or to the EVENT_LOG table. An
alarm can only be logged to one of these tables, not both. If, for example, an alarm
is currently being logged to the EVENT_LOG table, and you select the
ALARM_LOG table in this dialog box, the alarm is automatically removed from the
EVENT_LOG table when you select OK.
Logging an Alarm
To log an alarm:
1.
2.
If you have selected the ALARM_LOG table, select the alarm events to
log. You may choose any combination of events.
3.
Select OK to confirm your changes and close the dialog box, or select
Cancel to cancel your proposed changes and close the dialog box.
23-10
1.
Select Table attributes. The Table Properties dialog box for the
selected table opens. Make your modifications, and then select OK to
return to the Alarm Logging dialog box.
2.
When the Alarm Logging dialog box redisplays, the table has been
modified. Note that the Cancel button has changed to a Close button
to indicate that you cannot cancel the modification of the table.
3.
Select Close to close the dialog box without making any other
changes. Before you select OK, make sure that you are logging the
alarm to the correct table.
GFK-1180H
Use the Table Browser dialog box to select a table to display a filtered list of logging
tables, add a point to one or more tables, create a new logging table, or modify the
properties of an existing table.
You can set the Auto Browse check box to have the current list of tables displayed
automatically when you open the browser.
Enter information in the Table Identifier field. You can leave this
field blank, or you can enter a full or partial table name. If you are
entering a partial table name, you can use the following wildcards:
? - Matches exactly one character.
* - Matches zero or more arbitrary characters.
2.
Select a Table Type. You can display all table names, or you can
select a particular type of table. When you click the Select button for
this field, your choices are:
ALL - displays all group and data table names.
DATA - displays all data table names.
GROUP - displays all group table names.
3.
GFK-1180H
Database Logger
23-11
2.
The New Table dialog box opens. Make your modifications, and then
select OK to return to the Table Browser dialog box.
3.
When the Table Browser dialog box redisplays, the new table has been
created and appears in the table list. Note that the Cancel button has
changed to a Close button to indicate that you cannot undo the
creation of the table.
23-12
1.
2.
3.
The Table Properties dialog box for the selected table opens. Make
your modifications, and then select OK to return to the Table Browser
dialog box.
4.
When the Table Browser dialog box redisplays, the table has been
modified. Note that the Cancel button has changed to a Close button
to indicate that you cannot undo the modification of the table.
GFK-1180H
The CIMPLICITY Database Logger Configuration window displays a list of all the
currently configured group and data tables, as well as the Alarm Log and Event Log
tables. The icon to the left of each table indicates its type as follows:
Alarm Log table or Event Log table
Data Log table
Group Log table
Application table
You can use the Menu functions, Toolbar buttons and shortcut keys to:
GFK-1180H
Open a table.
Add points to a table.
Database Logger
23-13
Open Table...
Copy Table...
Delete Table
Exit
Add Alarms...
Add Points...
Reconcile Table...
23-14
GFK-1180H
Status Bar
Filter...
GFK-1180H
Help Topics
Database Logger
23-15
With no tables selected, hold down the right mouse button. You can
then select the general menu options.
Select a table and hold down the right mouse button. You can then
select general or table related menu options.
New...
Opens the New Table dialog box and lets you create a
new table.
Rename...
Opens the Rename Table dialog box and lets you rename
the table.
Delete
Copy...
Properties...
Add Points...
23-16
GFK-1180H
Open Table
Delete Table
Copy Table
Add Item
Table Properties
Logging Properties
Filter Items
Dynamic Configuration
GFK-1180H
Ctrl+N
Ctrl+C
Ctrl+O
Database Logger
23-17
Modify logging conditions in data log tables. This includes the default
logging conditions in the table and the logging conditions of individual
points.
Modify table and point logging attributes in group log tables. This
includes the default point attributes in the table and the point attributes
of individual points.
23-18
GFK-1180H
Enter the name of the new table in the Table identifier input field.
The name can contain alphanumeric characters (A thorough Z, 0
through 9) and underscores ( _ ). The name should be no longer than
16 characters. If you enter more than 16 characters, the name will
automatically be truncated to the first 16 characters when you select
OK. You cannot use the name of a currently existing table when you
create a new table.
2.
3.
You can only create new group and data log tables. Only one Alarm table (called
ALARM_LOG) and one Event table (called EVENT_LOG) table exist in the Data
Logger. You cannot delete these tables, and you cannot create additional Alarm or
Event tables.
GFK-1180H
Database Logger
23-19
Table Properties
Five properties can be associated with the property dialog box for a table. They are
Logging Conditions, Logging Attributes, Maintenance Events, Maintenance Actions
and Logging Properties.
Logging Conditions determine when data will be put into the log table.
Maintenance Actions define the type of actions that take place when a
Maintenance Event occurs.
Logging Properties define the database connection and the Store and
Forward properties for the table.
The number of properties, and the information on them depends on the type of table
you are looking at.
For a data table, you can define or modify default Logging Conditions,
Logging Attributes, Maintenance Events, Maintenance Actions and
Logging Properties.
To display a particular property page, move the cursor to its name tab in the Table
Properties dialog box and click the left mouse button. Before that page is displayed,
any changes that you have made on the current property page are validated. If any
problems are found during validation, you must correct them before the next
property page is displayed.
When you select OK, information on all the properties in the dialog box are applied
to the table.
When you select Cancel, none of the information on any of the properties is applied
to the table.
23-20
GFK-1180H
The Default Logging Conditions property page for the ALARM_LOG table displays
the current default logging criteria for alarms being logged into the table. These
criteria are:
Generate
Acknowledge
Reset
Delete
GFK-1180H
1.
Set the check box for each event that you want to log.
2.
Clear the check box for each event that you do not want to log.
3.
Select OK.
Database Logger
23-21
The Logging Conditions property page for a group or data table displays the current
logging conditions for the table. You can have logging to the table occur under any
combination of the following:
Timed/gated logging
Select Use Defaults to reset the Logging Conditions to their default values. The
default is to log data periodically every 5 minutes.
The Point and Point Alarm fields have a Browser button and a Pop-up Menu
button.
23-22
GFK-1180H
2.
You can combine data triggered logging with alarm triggered logging.
If you do not define any logging conditions under Timed/Gated Logging, then data
will only be logged into the table when the trigger occurs.
2.
Set the check box for each alarm state that you want to trigger logging.
3.
Enter the Point ID of the trigger point in the Point alarm field.
For this option to work successfully, you must define alarm limits for the trigger
point. For example, if you select a Point ID and choose its Alarm High state, logging
in the table will occur each time the point enters the Alarm High state.
You can combine alarm triggered logging with data triggered logging.
If you do not define any logging conditions under Timed/Gated Logging, then data
will only be logged into the table when the trigger occurs.
Combining Triggers
You can combine triggers. When you combine triggers, logging occurs when either
of the triggers occurs. For example, if you want to log a set of points when
POINT_A is updated or when POINT_B is in Alarm High state:
GFK-1180H
1.
2.
3.
4.
5.
Database Logger
23-23
Set this check box when you want to log data into the
table at regular intervals.
Enter the time value in the input field, and select the time
interval.
Valid intervals are DAYS, HOURS, MINUTES,
SECONDS, or TICKS (100 ticks = 1 second).
Synchronized
On digital point state Set this check box if you want to log data while a digital
point is in a certain state.
Select the state to check for and enter the digital Point ID
in the input field. Valid states are HIGH, LOW, and
TRANSITION
You can combine timed events. For example, if you want to log a set of points every
hour on the half-hour, do the following:
1.
Set the Periodic check box, and enter 1 HOUR in the data fields.
2.
Set the Synchronized check box and enter 12:30 AM in the data
fields.
23-24
GFK-1180H
If you select or unselect the project name table attribute you must drop
the table so that it is properly recreated with or without the new project
field as part of the primary key. Failing to do so can cause the
database logger to fail to log data into the table.
GFK-1180H
Database Logger
23-25
The Logging Attributes property page for a group or data table displays the current
point attributes that will be logged to the table. You can define the following
attributes to be logged:
Point attributes
Table Attributes
Select Use Defaults to reset the Logging Attributes to their default values. The
default is to log Point Value and the Project Name.
23-26
Point Value
Previous Value
Raw Value
Alarm State
Resource
Log the time the point was last logged in this table.
Engineering Units
GFK-1180H
If you select or unselect the project name table attribute you must drop
the table so that it is properly recreated with or without the new project
field as part of the primary key. Failing to do so can cause the
database logger to fail to log data into the table.
The Maintenance Events property page for a table displays the current maintenance
events for the table. Maintenance actions will occur when any of the events that you
configure on this property sheet occur. You can select:
Triggered maintenance
Timed/gated maintenance
Select Use Defaults to reset the Maintenance Events to their default values. The
default is to perform maintenance actions every day at midnight.
The Point field has a Browser button and a Pop-up Menu button.
GFK-1180H
Database Logger
23-27
Logging count
Synchronized
23-28
GFK-1180H
Timed/gated events for both maintenance and logging contain three options that can
be used either separately or combined. The following is a summary of the behavior
for each possible combination.
Periodic only
Synchronized only
LOW
TRANSITION
Periodic/Synchronized
GFK-1180H
HIGH
LOW
Database Logger
23-29
TRANSITION
LOW
TRANSITION
23-30
HIGH
LOW
TRANSITION
GFK-1180H
The Maintenance Actions property page for a table displays the current maintenance
actions for a table. Every maintenance action for a table will be performed whenever
any of its maintenance events occurs. You can select:
Export actions
Purge actions
Command actions
Select Use Defaults to reset the Maintenance Actions to their default values. The
default maintenance action is to purge all records except for those entered in the
table for the last day.
Export Actions
Export actions let you export data from the table to a CSV (Comma Separated
Value) format file when a maintenance event occurs.
To select this option:
1.
2.
GFK-1180H
All
By Count
By Time
Data entered in the table for the last <n> days, hours, or
minutes is exported.
Database Logger
23-31
Purge Actions
Purge actions let you delete data from the table when a maintenance event occurs.
To select this option:
1.
2.
3.
By Count
By Time
Delete all but the records entered in the table for the
last <n> days, hours, or minutes.
If you want to save the data to be purged from the table to a CSV
format file before removing it from the table, then set the Save
deleted in file check box and enter the name of the CSV file.
Command Actions
Command actions let you perform more complicated actions when maintenance
events occur. You can select one or both of these actions:
Execute SQL command
Run program
Compact database
Use the Compact database action with great caution. Compacting a Microsoft
Access database requires the database file not be used by any process, otherwise the
action fails and waits to be executed during the next maintenance event. Due to this
restriction, the Database Logger terminates all communication with the Microsoft
Access database while the compact action occurs. This means that the logger queues
may overflow depending on how fast items are being logged and the size of the
logger queue.
23-32
GFK-1180H
The Logging Properties property page for a table displays the current database
connection and the parameters used by Store and Forward for the table.
Connect Information
You can select an ODBC data source for each table that you create in the Database
Logger. To connect to a table, enter the following information:
ODBC data source
Select the data source to receive logged data for this table.
This field displays the list of currently configured ODBC
data sources. In general, it will consist of a list of one or
more Microsoft Access or SQL Servers.
The default data sources are:
CIMPLICITY Alarm Logging
A Microsoft Access data source that logs data to the
CIMPLOG.MDB file in the ARC directory of your
CIMPLICITY HMI project.
CIMPLICITY Point Logging
A Microsoft Access data source that logs data to the
POINTLOG.MDB file in the ARC directory of your
CIMPLICITY HMI project.
GFK-1180H
Database Logger
23-33
Password
Reconnect wait period Enter the amount of time the Database Logger waits
between reconnect attempts when the connection to the
database is lost. The default is 30 seconds.
Enter a value between 0 (continuous retries) and 24 hours.
23-34
GFK-1180H
Use this dialog box to filter the list of logging tables by Table Identifier and/or Table
Type.
To filter the table list:
1.
Enter a full or partial Table ID in the Table Identifier input field. You
can use the ? and * wildcards to perform partial string searches.
2.
Select the Table Type you want to filter for. Valid selections are
ALARM, ALL, DATA, EXTERNAL, or GROUP.
3.
To display all the tables, put an asterisk (*) in the Table Identifier field, and select
ALL for the Table Type.
GFK-1180H
Database Logger
23-35
Copying a Table
Important
You cannot copy the Alarm (ALARM_LOG), Event (EVENT_LOG) or
External tables.
To copy the attributes, actions, and contents of a selected group or data table to a
new table, select the table you want to copy, then do one of the following:
Press Ctrl+C
Enter the new table name in the input field. You must enter a new name. The Data
Logger will not let you use a current table name for a new table.
Select OK to create the table, or select Cancel to cancel the copy function.
Renaming A Table
To rename a data or group table, select the table, and then do one of the following:
Press Ctrl+R.
Enter the new table name in the input field. You must enter a new name. The
Database Logger will not let you use a current table name when you rename a table.
Select OK to create the table, or select Cancel to cancel the rename function.
Note
You cannot rename the Alarm (ALARM_LOG), Event (EVENT_LOG) or External
tables.
23-36
GFK-1180H
Deleting A Table
To delete a group, data or external table, select the table, and then do one of the
following:
GFK-1180H
Database Logger
23-37
Reconciling a Table
You can use the Reconcile option on the Edit menu to show the differences
between the current CIMPLICITY HMI table configuration and the logging
database.
When you select Reconcile from the Edit menu, the Reconcile Table dialog box
opens.
The dialog box lists all the fields in the table configuration, and any fields in the
table in the database that are not in the configuration. Each field has one of the
following icons:
Field is in the Database Logger configuration and database
table
Field is in the Database Logger configuration and database
table, but types dont match
Field is in the database table, but not in the Database Logger
table configuration (unused).
Field is in the Database Logger configuration, but not in the
database table (uncreated).
Field has been removed from the Database Logger
configuration and the database table.
23-38
GFK-1180H
You can use this dialog box to remove unused fields from the database table or
create fields in the database table for new fields in the configuration.
Important
You can use this dialog box to remove fields from Microsoft Access
databases. Fields in SQL Server and Oracle databases must be
removed manually.
2.
Select Create.
After the fields are created in the database, their icons change to:
2.
Select Remove.
After the unused fields are removed from the database, their icons change to:
2.
3.
4.
Copy the data from the temporary table to the new table.
5.
Consult your SQL Server or Oracle documentation for details on how to do this.
GFK-1180H
Database Logger
23-39
3.5 writes/second
Parameters
23-40
GFK-1180H
The Parameters page displays the current disk scan rate, data table queue size, data
logging scan rate, and maintenance action export path. When you open the ODBC
Configuration page, or select OK to close the property sheet, information on the
page will be validated. You can define the following parameters:
GFK-1180H
Data Tables
Group Tables
Database Logger
23-41
The Alarm Logging page shows the ODBC configuration that will be used when
logging data to the ALARM_LOG, EVENT_LOG and Application tables. The Point
Logging page shows the ODBC configuration that will be used when logging data to
Data and Group tables.
You can define the following parameters:
23-42
GFK-1180H
If additional information is required to connect to the database you selected, you will
be prompted for it during validation. Validation occurs when you select OK, or
select the Parameters page. Information needed varies from database to database.
In general:
If the Data Logger is unable to connect to the selected database, validation fails.
Connect Information
Enter information in the following fields:
ODBC Data Source
GFK-1180H
Database Logger
23-43
Password
23-44
GFK-1180H
Displaying A Table
To display the contents of a table, you can double-click on the table name in the
CIMPLICITY Database Logger Configuration window.
Alternatively, you can select the table in the CIMPLICITY Database Logger
Configuration window then:
Press Ctrl+O.
The CIMPLICITY Database Logger Configuration window for the selected table
opens.
You can use the Menu functions, Toolbar buttons and shortcut keys to:
GFK-1180H
Close the table and return to the main Data Logging window.
Database Logger
23-45
Add Alarms...
Remove Point
Remove Alarm
Close Table
23-46
Point Properties...
Alarm Properties...
Table Properties...
Reconcile Table...
GFK-1180H
Status Bar
Filter...
GFK-1180H
Help Topics
Database Logger
23-47
With no items selected, hold down the right mouse button. You can
then select the table related menu options.
Select an item in the table and hold down the right mouse button. You
can then select item or table related menu options.
Properties...
Add Points...
Add Alarms...
Table Properties...
Close
23-48
Close Table
Remove Items
Add Item
Item Properties
Table Properties
Filter Items
GFK-1180H
2.
Select Remove Point from the File menu or click the "Remove
Point" button on the Toolbar. A confirmation message box opens.
3.
Select OK in the confirmation message box to verify that you want the
point removed or select Cancel to cancel your request.
The point list updates after the confirmation message box closes.
GFK-1180H
For points in group tables, you can modify each points Logging
Attributes.
For points in data tables, the Alarm Log table, and the Event Log table,
you can modify each points Logging Conditions.
Database Logger
23-49
The Logging Attributes property page for a point in a group table displays the current
attributes assigned to the point. You can have point logging occur under any
combination of the following:
Point Attributes
Select Use Defaults to reset the Logging Attributes to their default values. The
default is to log point values.
23-50
Point Value
Previous Value
Alarm State
Engineering Units
Raw Value
Resource
GFK-1180H
The Logging Conditions property page for a point displays the current logging
conditions for that point. You can have point logging occur under any combination
of the following:
Timed/gated logging
Note
If device point is configured as OnScan, point value is updated on every scan even
though its value remains unchanged.
GFK-1180H
Database Logger
23-51
Select Use Defaults to reset the Logging Conditions to their default values. The
default is to log data periodically every 5 minutes.
The Point and Point Alarm fields have a Browser button and a Pop-up Menu
button.
Combining Triggers
You can combine triggers. When you combine triggers, logging occurs when either
of the triggers occurs. For example, if you want to log a set of points when
POINT_A updates or while POINT_B is in Alarm High state, do the following:
23-52
1.
2.
3.
4.
5.
GFK-1180H
Synchronized
You can combine timed events. For example, if you want to log a set of points every
hour on the half-hour, do the following:
GFK-1180H
1.
Set the Periodic check box, and enter 1 HOUR in the data fields.
2.
Set the Synchronized check box and enter 12:30 AM in the data
fields.
Database Logger
23-53
The Logging Conditions property sheet for an alarm in the ALARM_LOG table
displays the current default logging criteria for that alarm. These criteria are:
Generate
Acknowledge
Reset
Delete
23-54
1.
Set the check box for each event that you want to log.
2.
Clear the check box for each event that you do not want to log.
3.
Select OK. The points logging conditions update, and the dialog box
closes.
GFK-1180H
The Filter Points dialog box lets you filter the list of points in a data or group table
by Point ID and/or Point Type.
To filter the point list:
1. Enter a full or partial Point ID in the Point Identifier input field. You
can use the ? and * wildcards to perform partial string searches.
2. Select the Point Type you want to filter for. Valid selections are ALL,
ANALOG, APPL, DIGITAL, or TEXT.
3. Select OK to filter the list according to the information youve entered.
Select Cancel to cancel the filter function.
To display all the points in the table, put an asterisk (*) in the Point Identifier field,
and select ALL for the Point Type.
The Filter Alarms dialog box lets you filter the list of alarms in the alarm or event
table by Alarm ID.
To filter the alarm list:
1. Enter a full or partial Alarm ID in the Alarm Identifier input field. You
can use the ? and * wildcards to perform partial string searches.
2. Select OK to filter the list according to the information youve entered.
Select Cancel to cancel the filter function.
To display all the alarms in the table, put an asterisk (*) in the Alarm Identifier
field.
GFK-1180H
Database Logger
23-55
Reporting
Because the CIMPLICITY HMI Database Logger option writes to ODBC-compliant
databases, you may use database-specific reporting mechanisms to generate custom
reports for your site. Both the Microsoft Access and SQL Server databases provide
methods for reporting which you may find useful. Alternately, you may use any
ODBC-compliant application to generate reports.
Three sample reports are provided with the CIMPLICITY HMI Database Logger
product option. These reports are written in Microsoft Excel version 5.0 format, and
are stored in the report subdirectory of your CIMPLICITY HMI distribution
directory. The report files are:
SQLALARM.XLS
SQLDATA.XLS
SQLGROUP.XLS
There is also a Microsoft Excel 97 version of each report. The files are:
SQLALARM97.XLS
SQLDATA97.XLS
SQLGROUP97.XLS
For ad-hoc reporting, you will find that these samples are fully functional as shipped.
They may be used with either Access or SQL Server to report on any tables you may
have configured. In addition, you may copy and modify these reports to meet your
specific needs. Data in these reports is ordered by timestamp.
From Excel, you may save generated reports to disk for later use, print them, or
perform further analysis on your data.
2.
3.
If you do not do this, a "Path not found" error message displays when you attempt to
open any of the report files.
23-56
GFK-1180H
2.
3.
4.
5.
6.
If you do not do this, a Path not found error message displays when you attempt to
open any of the report files.
2.
3.
4.
If you do not do this, a Path not found error message displays when you attempt to
open any of the report files.
GFK-1180H
Database Logger
23-57
2.
3.
4.
5.
Repeat these steps for all three report files. You will need to do this only once for
each report.
23-58
GFK-1180H
Alarm Report
This report provides the ability to report on the ALARM_LOG and EVENT_LOG
tables. You may filter the report by Alarm Class or timestamp.
When you open the SQLALARM.XLS spreadsheet in Microsoft Excel, the Control
worksheet is displayed initially.
This worksheet displays the current report parameters and status. From this
worksheet, you can:
GFK-1180H
Set parameters.
Database Logger
23-59
Alarm Class
Start Time
End Time
Data Source
To save your parameters, click OK. To cancel your changes, click Cancel.
If you save your spreadsheet after setting the report parameters, the parameters will
be available the next time you run the report.
23-60
GFK-1180H
Alarm ID
alarm_class
resource
logged_by
reference
prev_state
log_action
final_state
The final state of the alarm after the trigger event. This
may be G (generated), A (acknowledged), R (reset), or D
(deleted).
alarm_message
If you save your spreadsheet after generating a report, the data will be available the
next time you view the report.
GFK-1180H
Database Logger
23-61
Data Report
This report provides the ability to report on Data tables that you have configured,
including the default DATA_LOG table. Because Data tables contain individual
points on each row, you may filter the report by Point ID to view only the point you
wish to see. In addition, you may filter the report by timestamp.
When you open the SQLDATA.XLS spreadsheet in Microsoft Excel, the Control
worksheet is displayed initially.
This worksheet displays the current report parameters and status. From this
worksheet, you can:
23-62
Set parameters.
GFK-1180H
Point ID
Start Time
End Time
Data Source
To save your parameters, click OK. To cancel your changes, click Cancel.
If you save your spreadsheet after setting the report parameters, the parameters will
be available the next time you run the report.
GFK-1180H
Database Logger
23-63
POINT_ID
project
_ALRM
_ENG
_PREV
_VAL
_TIME
_RAW
_RES
If you save your spreadsheet after generating a report, the data will be available the
next time you view the report.
23-64
GFK-1180H
Trend Report
This report provides similar functionality to the Data report for use with Group
tables. In addition, it provides a static trend representation of the point values in the
report.
When you open the SQLGROUP.XLS worksheet, spreadsheet in Microsoft Excel,
the Control worksheet is displayed initially.
This worksheet displays the current report parameters and status. From this
worksheet, you can:
GFK-1180H
Set parameters.
Database Logger
23-65
The table for which to generate the report. Enter the name of
a CIMPLICITY Group table.
Start Time
End Time
Data Source
To save your parameters, click OK. To cancel your changes, click Cancel.
If you save your spreadsheet after setting the report parameters, the parameters will
be available the next time you run the report.
23-66
GFK-1180H
project
_ALRM
_ENG
_PREV
_VAL
_TIME
_RAW
The raw value of the point being logged. If the point does not
have engineering units conversion, it is the same as the current
value.
_RES
In addition to the collection of data into the Data worksheet, this data will be
graphed on the Chart worksheet.
If you save your spreadsheet after generating a report, the data and chart will be
available the next time you view the report.
GFK-1180H
Database Logger
23-67
2.
3.
2.
3.
4.
In the Service dialog box, under Log On As:, select This Account:.
5.
6.
If the account requires a password, enter the password and confirm it.
7.
Select OK to accept your changes and close the Service dialog box.
8.
9.
If no one is logged in to the account you select here, when the script executes, no
printers will be available. The report will be generated, but it will not be printed.
23-68
GFK-1180H
Creating a Script
You will need to create a script to open the Microsoft Excel spreadsheet for your
report, generate the report and print it.
The following script opens the SQLALARM.XLS spreadsheet, generates a report,
and prints it. You can use it as a template for creating your own scripts:
Sub Main ()
--------------------------------------------------------------------------------------- This section sets REPORT_TRIGGER back to 0 so that the script doesnt continue to run.
This is not needed if the report is triggered directly from a CimView screen or by a
TIMED event in the Database Logger or Event Manager.
To create a script:
GFK-1180H
1.
2.
Create the script to run the report and print it. You can use the sample
script as a template.
3.
Database Logger
23-69
2.
3.
On the Maintenance Events page for the table, specify the event(s) you
want to trigger the script.
4.
On the Maintenance Actions page for the table, check Run program,
then enter the fill path and name of the executable you created from the
script.
5.
The report automatically generates and prints whenever any of the maintenance
events you specified occur.
2.
3.
The report automatically generates and prints whenever the event occurs.
Using a CimView screen:To let users trigger a report from a CimView screen:
Open the screen in CimEdit.
1.
2.
3.
4.
In the Edit Script window, enter a script that will trigger the report.
You can generate the report directly, or trigger an event that invokes an
action that generates the report.
5.
6.
7.
8.
9.
23-70
GFK-1180H
Table characteristics
GFK-1180H
24-1
ODBC Configuration
By default, the CIMPLICITY HMI Database Logger uses the Microsoft Access
ODBC driver to write to Access format (.MDB) files. This is automatically
configured during CIMPLICITY HMI installation. You do not need to purchase or
configure additional software to use this driver.
For improved performance and network extensibility, you may wish to log to a thirdparty database product such as Microsoft SQL Server or Oracle.
ODBC Drivers
ODBC Applications use an ODBC driver to communicate with database
applications. The drivers supported for use with the CIMPLICITY HMI Database
Logger are:
Microsoft Access
Oracle
24-2
GFK-1180H
If a driver is not supported for a particular platform, data sources will not be
configured for it.
Note
If you change the attributes of a data source, after you have configured Database
Logging to use that data source, you will need to go to the Logging Properties dialog
box and reselect the data source.
Moving Projects
If you copy a project to another computer, the ODBC configuration associated with
that project will not be automatically copied.
If the project uses the default Microsoft Access data sources, you do
not need to make any changes to your configuration.
If the project uses the SQL Server data source, you must configure a
new database and user account on the new target computer, then reopen the Database Logger to rewrite the connect string.
GFK-1180H
Use only supported ODBC drivers. Other drivers may not meet the
data requirements of CIMPLICITY software.
Remember that data sources are not part of your CIMPLICITY project,
and will not automatically follow a project that is taken to a different
node.
24-3
2.
3.
4.
Select the Microsoft Access Driver from the list, and click OK.
5.
6.
7.
8.
9.
24-4
GFK-1180H
2.
You are now ready to register your SQL Server, construct a SQL device, construct a
SQL database, and create a SQL user.
To register your SQL Server:
1.
From the SQL Server menu, run the SQL Enterprise Manager.
2.
Select Register Server from the Server menu to register your server
node. In the dialog box, enter the node name in the Server field. You
can use a Login ID of sa with the standard security option.
3.
2.
3.
Enter the name, drive, path, and size of your database device.
2.
3.
Enter the name, device, and log device for your new database.
2.
Create a new user for CIMPLICITY logging, and make your new
database the default for that user.
3.
GFK-1180H
24-5
From the Configuration cabinet, use the right button to obtain the
popup menu for the Database Logger product option. Select Logging
Properties.
2.
3.
Specify the SQL Server User ID and password in the space provided.
4.
5.
Note that you may use the same SQL Server Data Source for both pages of this
dialog.
Remember to select TCP/IP Networking on your SQL Server client computers (GE
Fanuc recommends that you use TCP/IP networking to connect to the remote SQL
Server database).
You will also need to purchase a SQL Server Client license for each computer where
you install the SQL Server Client Utilities.
Finally, you will need to configure the remote SQL Server data sources for each of
these computers.
24-6
1.
2.
In the Data Sources dialog, select System DSN. The System Data
Sources dialog box opens
3.
4.
Select Setup. The ODBC SQL Server Setup dialog box opens.
5.
GFK-1180H
Select Options.
6.
7.
8.
2.
In the Data Sources dialog, select System DSN. The System Data
Sources dialog opens
3.
In the System Data Sources dialog, select Add. The Add Data Source
dialog opens.
4.
In the Add Data Source dialog, select the ODBC driver for the data
source.
5.
Select OK. The ODBC SQL Server Setup dialog box opens.
6.
In the ODBC SQL Server Setup dialog, enter the name of the data
source in the Data Source Name field.
7.
8.
9.
If you are logging to a specific database name rather than the default:
Select Options.
GFK-1180H
24-7
Oracle Configuration
Requirements
You must purchase the INTERSOLV DataDirect ODBC driver for Oracle.
Oracle databases can be supported on Intel-compatible computers with Microsoft
Windows NT v4.0 or Microsoft Windows 98/95.
The INTERSOLV ODBC driver and Oracle client software must be installed in the
same computer as the CIMPLICITY HMI software.
For Microsoft Windows NT v4.0, you must have the Allow Service to Interact
with Desktop option turned on for the CIMPLICITY HMI service. If you do not,
logging to the Oracle database will not work. To enable this option:
1.
2.
Open Services.
3.
4.
In the Service dialog box, make sure that the System Account and
Allow Service to Interact with Desktop options are selected.
2.
3.
4.
5.
6.
7.
8.
24-8
GFK-1180H
In the ODBC data source for Oracle, enter the alias name in the Server
name field.
All three of the Oracle services must be started on the Oracle server
node.
2.
From the Server menu, select SQL Server, then Configure. The
Server Configuration/Options dialog opens.
3.
4.
5.
6.
Select OK.
7.
The change takes place the next time the SQL Server is restarted.
GFK-1180H
24-9
2.
3.
4.
5.
6.
Select OK.
7.
The change takes place the next time the SQL Server is restarted.
2.
3.
4.
5.
6.
7.
This change takes place the next time you update the projects configuration and then
restart the project.
24-10
GFK-1180H
Creating Tables
When a project is started, the Database Logger creates any tables you have
configured for that project based on the attributes you have specified. This means
you dont have to know anything about databases to log data from your
CIMPLICITY project.
Specifically, when a project starts, the Database Logger will:
Table Characteristics
The Database Logger tables have the following characteristics:
Column Definitions
A table can have, at most, 250 columns. The following columns are defined for each
type of log file:
GFK-1180H
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.
24-11
Key Definitions
The following keys are defined for each type of log file:
Data logging tables have a primary key index on the joined timestamp
and Point ID columns, and a secondary index on the timestamp alone.
If you have selected the project name table attribute, the primary key
index also includes the project name column.
Alarm, Event, and Application logging tables have a primary key index
on the joined timestamp and sequence number columns, and a
secondary index on the timestamp alone. If you have selected the
project name table attribute, the primary key index also includes the
project name column.
Important
24-12
GFK-1180H
You can use the Reconnect wait period to define the amount of time to wait
between connection requests whenever the Database logger loses its connection to
the database. Each time a reconnect request fails, a DB_CONN_DOWN alarm is
generated.
You can define a separate wait period for the Alarm Logging and Point Logging.
After the database connection is reestablished, if you have also enabled the Store
and forward feature, all of the stored data is automatically forwarded to the
database.
GFK-1180H
24-13
If the Database Logger cannot process a SQL statement in a storage file, it generates
a log file with the same name as the storage file and the extension .LOG. The log
file contains the statement forwarded to the database and the error message returned
by the database.
If the Database Logger encounters no problems when forwarding data, no .LOG file
is generated.
Note
If you have Store and Forward enabled and storage files exist when you shut
down the Database Logger and you then disable Store and Forward, the Database
Logger will not forward records from the storage files when it restarts.
You can open a storage file and examine its contents in, for example, Notepad.
The records are stored in one or more files in a storage directory. The number of
files depends on the maximum number of records you select and the maximum
number of records per file.
where <dbms_id> is the databases DBMS ID, <date_stamp> is the date and
<time_stamp> is the time the file was created. For example:
POINT_960916_053151.SQL
24-14
GFK-1180H
After the Database Logger loses its connection to the database, it stores
five records and logs the "Number of stored records exceeded" message
to the Status Log:
The Database Logger will now store three records and log the "Number
of stored records exceeded" message to the Status Log:
If the Database Logger is shut down, and there are still records in the storage files,
when the Database logger restarts, these records are not counted against the
maximum. Under these conditions, you can have more than the maximum number
of records stored to disk.
2.
Note that the Alarm Logging and Point Logging databases have
separate records.
GFK-1180H
24-15
3.
To define a new path for the stored records for a database, enter the
pathname in the store_path field for the database. You can set a
different path for each database.
4.
5.
6.
Enter the following commands to regenerate the data file and close the
command window:
scpop dbsm_def
exit
In order for this change to take effect, you must shut down your project, perform a
Configuration Update, and then restart the project.
24-16
GFK-1180H
DB_DEBUG
DB_ENABLE_TRANSACTIONS
DB_TIME_FORMAT
DB_TIMESTAMP_FIELD
DB_TIMESTAMP_FILTER
2.
3.
4.
5.
6.
At the end of the file, add the correct line for the global parameter you
are adding.
Example
DB_TIMESTAMP_FIELD|1|field name
where field name is the name you want to give to the timestamp field
(e.g. DATETIME if you want the field to be uppercase).
Note: Refer to your database documentation for any field naming restrictions.
7.
8.
9.
GFK-1180H
24-17
DB_DEBUG
You can enable the dumping of diagnostic information for the Database Logger to
the MAC_DL.out and MAC_PTDL.out files in your projects log directory.
The record format is:
DB_DEBUG|1|<value>
4096
If you do not define DB_DEBUG, the default is to print the full syntax of ODBC
error messages. Since ODBC errors should happen infrequently, this is unlikely to
cause problems with disk space.
You must explicitly specify a value of 0 (zero) to stop dumping diagnostic
information to the log files.
If you need additional information, a value of 7 (1+2+4) is recommended.
If you also want to keep the Store and Forward files after loading them, a value of 15
(1+2+4+8) is recommended.
There are additional undocumented values that should only be used by GE Fanuc
engineers as they send a great number of messages to the MAC_DL.out and
MAC_PTDL.out that could quickly fill your available disk space.
DB_ENABLE_TRANSACTIONS
If specified, this global parameter overrides the default database functionality as
requested by ODBC.
The record format is:
DB_ENABLE_TRANSACTIONS|1|<flag>
where <flag> is Y if you want to force logging to use transactions, or N if you want
to force logging to not use them.
If you are using SQL Server and have configured an Insert Trigger on a database
table, you will need to set this value to N.
DB_TIME_FORMAT
CIMPLICITY software uses the default Microsoft Access and SQL Server
timestamp format for your locale when it writes SQL statements.
If you are using Store and Forward and your database does not use the default
timestamp format, you need to define this global parameter. Enter the timestamp
format for your database so that time and date fields will be written correctly in the
Store and Forward files.
The record format is:
24-18
GFK-1180H
DB_TIME_FORMAT|1|<timestamp>
where <timestamp> is the timestamp format for your database. The format is
case sensitive:
The year (Y), month (M) and hour (H) indicators must be in uppercase.
The day (d), minutes (m), seconds (s) and ticks (t) indicators must be in
lower-case.
For example:
DB_TIME_FORMAT|1|dd\MMM\YYYY HHHH:mm:ss
To return to the default format, remove this record from the file.
DB_TIMESTAMP_FIELD
By default, all database logger tables have a timestamp field, which specifies the date
and time of each logged transaction. This field is unique, as it is part of the tables
primary key. The name of this field defaults to timestamp for all database logger
tables.
timestamp is a lower case string.
Certain database client applications have problems accessing lowercase field names
from an Oracle DBMS. The DB_TIMESTAMP_FIELD global parameter can be used in
a CIMPLICITY HMI project to override the default timestamp field name used by
the database logger. This allows you to specify an uppercase field name for the
timestamp field.
Since DB_TIMESTAMP_FIELD is a global parameter, it only affects the HMI project
where it is configured.
When you use the DB_TIMESTAMP_FIELD global parameter, make sure that you
drop all affected tables before running the HMI project. Otherwise, the database
logger will not be able to recreate them with the new timestamp field name specified
by the DB_TIMESTAMP_FIELD global parameter.
Using DB_TIMESTAMP_FIELD modifies the timestamp field in the following tables
for the project where DB_TIMESTAMP_FIELD is used:
1.
2.
3.
4.
SPC tables
5.
HDA tables
6.
Tracker tables
where field name is the name you want to give to the timestamp field
(e.g. DATETIME if you want the field to be uppercase).
GFK-1180H
24-19
DB_TIMESTAMP_FILTER
DB_TIMESTAMP_FILTER that allows either rounding or truncation of all
timestamps in records logged by database logging. This includes the Point , Alarm
and Event Logging, SPC, Tracker and the Historical Data Analyzer.
The format for DB_TIMESTAMP_FILTER is either:
DB_TIMESTAMP_FILTER|1|A
Actual Timestamp
Logged Timestamp
3/1/99 12:22:37.730
3/1/99 12:22:30.000
3/1/99 14:37:24.102
3/1/99 14:37:30.000
3/1/99 23:59:51.107
3/2/99 00:00:00.000
24-20
Actual Timestamp
Logged Timestamp
3/1/99 12:22:37.730
3/1/99 12:22:30.000
3/1/99 14:37:24.102
3/1/99 14:37:00.000
3/1/99 23:59:51.107
3/1/99 23:59:30.000
GFK-1180H
Client Configuration
GFK-1180H
25-1
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
Modify a client.
Delete a client.
Press Ctrl+N.
After you initiate the request, the New Client dialog box opens.
Enter the name of the computer for the new client, then select OK. The Client
Properties dialog box opens.
25-2
GFK-1180H
Client Properties
If you enter just the Default User ID, all users from the Client
computer are automatically logged in with the default User ID.
If you just set the Trusted check box, only those users whose
Windows Logon Username match a CIMPLICITY User ID in the
project are automatically logged in. All other users will have to enter a
User ID and Password (if required) in the CIMPLICITY Login dialog
box.
When you are finished defining the client properties, select OK to close the Client
Properties dialog box and create the new client properties, or select Cancel to close
the dialog box without creating the new client properties.
Default User ID
Enter the optional default username for users on the Client computer. Users on the
Client computer will automatically be logged in to the CIMPLICITY HMI project
with this User ID.
You can click the Browser button - to the right of the input field to open the
Select A User Browser and use it to select the User ID.
You can also use the Window Pop-up menu or the Pop-up menu button create a new user or browse for an existing user.
- to
Trusted
Set this check box if you want the project to accept the Windows Logon Username
on the Client computer as the CIMPLICITY User ID and automatically log the user
into the project. The project must have a CIMPLICITY User ID configured that
matches the Windows Logon Username.
Clear this check box if you want users on the Client computer to manually log in to
CIMPLICITY HMI project.
GFK-1180H
Client Configuration
25- 3
GFK-1180H
26-1
Series 90 TCP/IP
SNP
Device Properties
To import variables as device points into a project, you must create an association
between the projects devices and Control folders. A device can have associations
with multiple folders. However, a folder can only be associated with one of the
projects devices because a folder is seen by the project as being a device itself.
When you create a new device that is supported by CIMPLICITY Control, a property
page called Control is displayed in the device properties. Use this property page to
configure and control imports from CIMPLICITY Control for that device.
26-2
GFK-1180H
Import Options
You can select various options that customize the import of points from Control.
You can customize the following:
Point ID Prefix
The format of a point ID imported from CIMPLICITY Control can take the form
<prefix><PointID>. Use the radio buttons to select the prefix you want to use
for points you are importing.
Select Custom and enter the character string you want to create a
custom prefix.
If the prefix exceeds this limit for a Point ID, it will be truncated before
it is added to the Point ID.
Add
Select this check box to create new points in the CIMPICITY HMI database. For
each device, any exportable variables from the associated folders that do not exist as
points in the project are created using the variable properties and the common point
properties.
Modify
Select this check box to modify points in the CIMPLICITY HMI database. For each
device, any exportable variables from the associated folders that exist as points in the
project are modified using the variable properties if the existing points belong to the
device. Common properties are also modified if you also set the Use common
point properties on modify check box.
Delete
Select this check box to delete points in the CIMPLICITY HMI database. For each
device, any previously exported point belonging to the device that was not exported
from an associated folder is deleted.
Note
Only previously exported points from existing associations are deleted. Previously
exported points from folder associations that no longer exist are not removed from
the project.
GFK-1180H
26-3
On configuration update
Select this check box to import points for all devices associated with Control folders
during configuration update for those folders that have changed since the last import.
Use common point properties on modify
Select this check box to use common point properties during a modify operation or
keep the common point properties that the point already has in the HMI project.
Actions
Select Import now to perform an exchange of data. The import is performed
regardless of whether it is needed. See Import Rules for a detailed explanation of
how imports are performed.
Select Associate with folders... to associate CIMPLICITY Control folders with
CIMPLICITY HMI devices. When you select this option the CIMPLICITY
Association Server dialog box opens.
26-4
GFK-1180H
This dialog box shows you the current associations and lets you:
Delete associations
Enter the CIMPLICITY HMI project path name in the PROJECT PATH field.
Enter the CIMPLICITY Control folder path name in the FOLDER PATH field.
Enter the CIMPLICITY HMI device name in the DEVICE NAME field.
Remember that a device can have associations with multiple folders, but a folder can
only be associated with one of the projects devices.
GFK-1180H
26-5
Select OK to add the association to the list of associations. The dialog box closes
and the list in the CIMPLICITY Association Server dialog box updates.
Editing an Association
To edit an association:
1.
2.
Select EDIT.
Use this dialog box to change the project path, folder path, or device name.
Deleting an Association
To edit an association:
1.
2.
Select DELETE.
The Delete Association dialog box opens, prompting you to confirm your request.
Select Yes to delete the association, or select No to cancel the delete request.
26-6
GFK-1180H
Import Process
When you select Import now from the Control property page of a supported device
or when you perform a configuration update, the CIMPLICITY Control Point Import
process starts.
During the import process a status dialog box displays and informs you the state of
the import process. This is done to give you positive feedback because the import
process can be quite lengthy.
Import Rules
CIMPLICITY HMI always assumes that the information in a Control folder is the
most up to date. During a configuration update, all devices with Control
configuration that have the On Configuration Update option selected are verified to
see if they need an import. An import is needed for those folders that have changed
since their last import.
There are three categories used to classify points during import:
New
Modifiable
Removable
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.
3.
GFK-1180H
26-7
4.
If a point exists in the project but it is a virtual point or does not belong
to the device associated with the folder being imported, a new point
conflict occurs.
5.
Please note that the import process only identifies point conflicts between folders and
projects. It does not identify conflicts between folders associated with the same
device.
Example:
A device can be associated with folders A and B. Both folders can contain the same
exportable variables. When the import occurs, the last folder to be imported
modifies the imported information from the previous folder because the points are
considered modifiable since they belong to the same device. To prevent this situation
from happening you can use the folder name prefix option to add a prefix to each
Point ID thus preventing folder to folder conflicts from occurring.
26-8
GFK-1180H
To display the Resolve Conflict dialog box for a point and resolve a point conflict, do
one of the following:
To solve the conflict, you can take one of the following actions:
GFK-1180H
26-9
To solve the conflict, you can take one of the following actions:
If you rename the point you must use a Point ID considered new or modifiable. The
dialog box ensures that you do so.
The conflict action normally defaults to Do not import. However, for previously
imported points with incorrect information, their last imported information is placed
in the conflict correction dialog and the conflict action defaults to Correct.
26-10
GFK-1180H
Remote Configuration
Control configuration options are only supported in the computer where associations
are created. This is because the Association Servers storage is local to the computer.
In order to perform point imports from remote computers you need to configure
associations properly in each remote computer.
Example
For example, given the following two computers:
ComputerA
ComputerB
GFK-1180H
26-11
You can make HMI changes to the project from either machine because they both
have HMI installed. You can make changes to the folder from either machine
because they both have Control installed.
If you open the project from ComputerA and perform a point import, it will be
performed because the computer has the projects associations configured.
If you open the project from ComputerB and perform a point import, it will also be
performed because the computer has the projects associations configured.
Note that if ComputerB had its association configured as follows:
F:\project\project.gef with C:\folder\folder.ef7
the import will be performed but it will end up assuming that the folder is a different
folder.
26-12
GFK-1180H
Configuration Import/Export
Introduction
You can use the Import/Export Utility to:
Create and modify CIMPLICITY HMI point data using third party
software.
You can use the same point information to configure more than one system. For
example, you can use a spreadsheet to create and modify point data, then import the
data into both the CIMPLICITY HMI database and Logicmaster 90 software.
The following is a quick overview of how Import/Export passes data between the
CIMPLICITY HMI point database and third party applications.
Third Party
Applications
Import/Export
Point/Alarm
Configuration
Files
Import/Export
Configuration
Files
CSV Files in
SNF format
Log File
GFK-1180H
27-1
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.
27-2
GFK-1180H
If you want to enter a blank character field, use " " (a double-quote,
followed by any number of spaces, followed by a double-quote) for the
field entry.
If you want initial blanks at the start of the field, enclose the field
(including the blanks) in double quotes. For example:
...,"
Initial blanks",...
You must enclose between double quotes any fields that contain a
comma as part of the data. For example:
...,"Comma, example",...
You must enter two double quotes if you want a double quote to be part
of a data string. For example
...,"Quotes ""example"" ",...
GFK-1180H
If you want to enter a blank character field, use " " (a double-quote,
followed by any number of spaces, followed by a double-quote) for the
field entry.
Initial blanks at the start of a field are ignored. If you want initial
blanks, you must edit the file with Notepad and enclose the field in
double quotes.
You do not need to enter two double quotes if you want a double quote
to be a part of a data string. For example:
Configuration Import/Export
27-3
You may modify these configuration files through any text editor, independent of
Import/Export.
The ie_deflds.cfg file defines default values for selected fields based on point
of origin and point type. You may configure default information for analog, digital
and text point types for both device and virtual (derived) points.
Important
Do not change information in the PT_ID, PT_ORIGIN, or PT_TYPE fields
of records in this file.
When you import data into the CIMPLICITY HMI point configuration, any fields in
an import record that do not contain data, and that correspond to default fields in
ie_deflds.cfg, will have their values set to the default values contained in
ie_deflds.cfg. For example, if a new digital device point is being imported,
and the ACCESS field in the import file is left blank, the import function will
substitute the default ACCESS value used for IE_DEV_DIGITAL.
27-4
GFK-1180H
Type a comma at the end of the Field Name list, and add the field name.
2.
Type a comma at the end of each data record in the file, and add the
field value. If the field is empty, just type a comma.
The default file contains two formats: Full Set and Logicmaster Export.
The Logicmaster Export format contains the four fields of interest to the
Logicmaster 90 (LM90).
Select one of the formats in this file when you export data. If you do not select a
format, an internal format is used.
GFK-1180H
Configuration Import/Export
27-5
1.
2.
Enter the name of the new format, followed by a comma. Make sure
that the format name is unique.
3.
Enter the list of field names that you want to export. Use a comma to
separate the names.
You can modify an existing format by either adding or deleting field names from its
definition record.
27-6
GFK-1180H
The INFO message tells you when the application (in this case, import)
started.
The WARNING message tells you that the prefix that you are adding to
the beginning of each Point ID will cause the identified Point ID to be
truncated. For example, GEF_DEMO_REAL_REAL_LONG_NAME
will be truncated to
XXXXXXXX_GEF_DEMO_REAL_REAL_LONG.
The ERROR message tells you that you do not have a DEVICE_ID for
a given point. This is categorized as an error, because this point data
will not be imported unless you add a Device ID.
Import Procedure
To import data, do the following:
1.
Log in and start up a command shell in the project where you want to
import data.
2.
where:
<file> is a required argument, and is the full path of import file to be read. The
file may be in any directory, but the projects data subdirectory is recommended.
You should always use the .csv extension with this filename.
GFK-1180H
Configuration Import/Export
27-7
Description
-D <device_id>
-R <resource_id>
-Pa <prefix>
-y
For example:
clie import myfile.csv -R RESOURCE1
imports the point data from MYFILE.CSV and use RESOURCE1 as the Resource ID
for any records that do not have a Resource ID defined.
The CIMPLICITY Login dialog box will ask you to log into the project if you have
not done so.
If you attempt a dynamic import while the project is not running, the import will
continue in static mode and display the following warning message:
Project must be running to use dynamic configuration.
27-8
GFK-1180H
2.
Add one line in <filename>.rol for each point that you are routing
to roles other than SYSMGR, USER, or OPER. The format of the line
will be the Point ID followed by a list of roles. Separate each field with
a comma.
3.
Run the Import utility as usual. The utility will automatically search for
a .rol file whose name matches that of the .csv file, and process the
additional role information.
GFK-1180H
Configuration Import/Export
Ver.
1.0
27-9
Export Procedure
To export configuration data, do the following:
1.
Log in and start a command shell in the project from which you want to
export data.
2.
where:
<file> is a required argument, and is the full path of export file to be written. The
file may be in any directory, but the projects data subdirectory is recommended.
You should always use the .csv extension with this filename.
Option names are case sensitive and
must be entered as defined.
Description
-Pr
-Ef <format>
-Sp <point_id>
27-10
GFK-1180H
-Sd <device_id>
Export data for Point IDs whose Device IDs match the
string you specify.
-So <origin_id>
Export data for Point IDs whose Origin IDs match the
string you specify. Specify one of the following:
D - device point
G - global virtual point
R - derived virtual point
-St <type>
-Sr <resource_id> A full or partial Resource ID. You can use the * and ?
wildcard characters when specifying a partial Resource
ID.
Export data for Point IDs whose Resource IDs match the
string you specify.
Two export files will be generated by the Export utility: <filename>.csv and
<filename>.rol. The .rol file will contain information on additional roles
configured for alarm routing. If there are no roles other than SYSMGR, USER and
OPER, the file will still be generated, but will contain no information.
For example:
clie export myfile.csv -Pr -Ef "My Set"
There are no implied wildcards. If you do not include or terminate your search string
with an asterisk, only those items that match your request exactly will be returned.
GFK-1180H
Configuration Import/Export
27-11
Start a command shell in the project from which you want to export
data.
2.
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
If you choose to confirm the deletion, you are prompted like this:
> clie delete D?I*
Starting Import/Export - logging to LOG_PATH:IC169.log
Do you want to DELETE <DRIVE_CONVEY1>
(Y)es (N)o (A)ll
y
Do you want to DELETE <DRIVE_CONVEY2>
n
Number of points Deleted = 1
Successful completion - Review LOG_PATH:IC169.log log file for
messages.
>
27-12
GFK-1180H
Required Fields
The PT_ID field is required in every file. This should preferably be the first field in
the record.
Here is some more detailed information about the field:
Maximum Field Length
32 characters
Point ID
Description
Optional Fields
Any of the fields listed below may be specified in a data file for Import/Export.
None are absolutely required, but, when specifying new points to be imported into
the CIMPLICITY database, certain fields may be required.
Points are device points, derived points, or global points.
A derived point gets its data from an equation, and cannot be set with a
setpoint.
Some of the optional fields are specific to points of a particular origin. The Point
Origin column identifies the type of point defined by the record. The point types
are:
All
Device
Global (virtual)
Derived (virtual)
All field names and enumerated data are case-insensitive.
GFK-1180H
Configuration Import/Export
27-13
BFR_SYNC_TIME
PT_SET_INTERVAL
ACCESS_FILTER
CALC_TYPE
PT_SET_TIME
ACK_TIMEOUT
CONV_LIM_HIGH
PT_TYPE
ADDR
CONV_LIM_LOW
RANGE_HIGH
ADDR_OFFSET
CONV_TYPE
RANGE_LOW
ADDR_TYPE
DELETE_REQ
RAW_LIM_HIGH
ALM_CLASS
DESC
RAW_LIM_LOW
ALM_CRITERIA
DEVIATION_PT
REP_TIMEOUT
ALM_DEADBAND
DEVICE_ID
RESET_ALLOWED
ALM_DELAY
DISP_LIM_HIGH
RESET_COND
ALM_HIGH_1
DISP_LIM_LOW
RESET_PT
ALM_HIGH_2
DISP_WIDTH
RESET_TIMEOUT
ALM_HLP_FILE
ELEMENTS
RESOURCE_ID
ALM_LOW_1
ENG_UNITS
REV_CONV_EQ
ALM_LOW_2
EQUATION
ROLLOVER_VAL
ALM_MSG
FW_CONV_EQ
SAFETY_PT
ALM_ROUTE_OPER
GR_SCREEN
SAMPLE_INTV
ALM_ROUTE_SYSMGR
INIT_VAL
SAMPLE_INTV_UNIT
ALM_ROUTE_USER
JUSTIFICATION
SCAN_RATE
ALM_STR
LOCAL
SETPOINT_HIGH
ALM_TYPE
MAX_STACKED
SETPOINT_LOW
ANALOG_DEADBAND
MEASUREMENT_UNIT_ID
TRIG_CK_PT
BFR_COUNT
POLL_AFTER_SET
TRIG_PT
BFR_DUR
PRECISION
TRIG_REL
BFR_EVENT_PERIOD
PROC_ID
TRIG_VAL
BFR_EVENT_PT_ID
PTMGMT_PROC_ID
UPDATE_CRITERIA
BFR_EVENT_TYPE
PT_ENABLED
VARIANCE_VAL
BFR_EVENT_UNITS
PT_ORIGIN
VARS
BFR_GATE_COND
27-14
GFK-1180H
ACCESS
Point Type
Device
2 characters
Access
Description
ACCESS_FILTER
Point Type
All
Byte
Enterprise Point
Description
ACK_TIMEOUT
Point Type
All
Integer
Acknowledge Timeout
Description
ADDR
GFK-1180H
Point Type
Device
32 characters
Description
Configuration Import/Export
27-15
ADDR_OFFSET
Point Type
Device
Integer
Address Offset
Description
ADDR_TYPE
Point Type
Device
2 characters
Address Type
Description
ALM_CLASS
Point Type
All
5 characters
Alarm Class
Description
ALM_CRITERIA
Point Type
All
3 characters
Alarm Criteria
Description
27-16
GFK-1180H
ALM_DEADBAND
Point Type
All
Integer
Alarm Deadband
Description
ALM_DELAY
Point Type
All
Integer
Delay Alarms
Description
ALM_HIGH_1
Point Type
All
Integer
Warning High
Description
ALM_HIGH_2
Point Type
All
Integer
Alarm High
Description
ALM_HLP_FILE
GFK-1180H
Point Type
All
10 characters
Help File
Description
Configuration Import/Export
27-17
ALM_LOW_1
Point Type
All
Integer
Warning Low
Description
ALM_LOW_2
Point Type
All
Integer
Alarm Low
Description
ALM_MSG
Point Type
All
54 characters
Alarm message
Description
ALM_ROUTE_OPER
Point Type
All
Boolean
Description
ALM_ROUTE_SYSMGR
Point Type
All
Boolean
Description
27-18
GFK-1180H
ALM_ROUTE_USER
Point Type
All
Boolean
Description
ALM_STR
Point Type
All
Integer
Description
ALM_TYPE
Point Type
All
2 characters
Alarm Type
Description
ANALOG_DEADBAND
Point Type
Device
Integer
Analog Deadband
Description
BFR_COUNT
GFK-1180H
Point Type
All
Integer
Description
Configuration Import/Export
27-19
BFR_DUR
Point Type
All
Integer
Description
BFR_EVENT_PERIOD
Point Type
All
Integer
BFR_EVENT_PT_ID
Point Type
All
Integer
BFR_EVENT_TYPE
Point Type
All
Integer
BFR_EVENT_UNITS
Point Type
All
Integer
BFR_GATE_COND
Point Type
All
Integer
27-20
GFK-1180H
BFR_SYNC_TIME
Point Type
All
Integer
CALC_TYPE
Point Type
Derived (virtual)
3 characters
Calc Types
Description
CONV_LIM_HIGH
Point Type
Device
Integer
Description
CONV_LIM_LOW
GFK-1180H
Point Type
Device
Integer
Description
Configuration Import/Export
27-21
CONV_TYPE
Point Type
Device
2 characters
Conversion Type
Description
DELETE_REQ
Point Type
All
2 characters
Deletion Requirement
Description
DESC
Point Type
All
40 characters
Description
Description
Description of point
DEVIATION_PT
Point Type
All
32 characters
Deviation Point
Description
DEVICE_ID
27-22
Point Type
Device
32 characters
Device ID
Description
GFK-1180H
DISP_LIM_HIGH
Point Type
All
Integer
Description
DISP_LIM_LOW
Point Type
All
Integer
Description
DISP_WIDTH
Point Type
All
Integer
Display Width
Description
ELEMENTS
Point Type
All
Integer
Elements
Description
ENG_UNITS
GFK-1180H
Point Type
All
8 characters
Eng. Units
Description
Configuration Import/Export
27-23
EQUATION
Point Type
Derived (virtual)
72 characters
Equation
Description
FW_CONV_EQ
Point Type
Device
72 characters
Description
GR_SCREEN
Point Type
All
16 characters
Graphic Screen
Description
INIT_VAL
27-24
Point Type
Number
Initial Value
Description
GFK-1180H
JUSTIFICATION
Point Type
All
Boolean
Justification
Description
LOCAL
Point Type
Boolean
Local Value
Description
MAX_STACKED
Point Type
All
Integer
Description
MEASUREMENT_UNIT_ID
GFK-1180H
Point Type
All
32 characters
Measurement Unit ID
Description
Configuration Import/Export
27-25
POLL_AFTER_SET
Point Type
Device
Boolean
Description
PRECISION
Point Type
All
Integer
Precision
Description
PROC_ID
Point Type
14 characters
Virtual Proc ID
Description
PTMGMT_PROC_ID
Point Type
14 characters
Point Manager
Description
PT_ENABLED
Point Type
Device
Boolean
Enabled
Description
27-26
GFK-1180H
PT_ORIGIN
Point Type
All
1 characters
No field defined
Description
PT_SET_INTERVAL
Point Type
Device
Time.
The format is HH:MM:SS for the interval,
where:
HH=Hour
MM=Minutes
SS=Seconds
Interval
The interval at which the Timer/Counter point
will be updated while the Expression value
remains HIGH.
PT_SET_TIME
Point Type
Derived (virtual)
Time.
The format is HH:MM:SS for the base start time,
where:
HH=Hour
MM=Minutes
SS=Seconds
GFK-1180H
Configuration Import/Export
Set Time
Base start time for the Timer/Counter point
interval.
27-27
PT_TYPE
Point Type
All
16 characters
Type
Description
RANGE_HIGH
Point Type
All
Integer
Description
RANGE_LOW
Point Type
All
Integer
Description
RAW_LIM_HIGH
Point Type
Device
Integer
Description
RAW_LIM_LOW
27-28
Point Type
Device
Integer
Description
GFK-1180H
REP_TIMEOUT
Point Type
All
Integer
Repeat Timeout
Description
RESET_ALLOWED
Point Type
All
Boolean
Reset Allowed
Description
RESET_COND
Point Type
2 characters
Reset/Startup Cond
Description
RESET_PT
GFK-1180H
Point Type
Derived (virtual)
32 characters
Reset Point
Description
Configuration Import/Export
27-29
RESET_TIMEOUT
Point Type
All
Integer
Reset Timeout
Description
RESOURCE_ID
Point Type
All
16 characters
Resource ID
Description
REV_CONV_EQ
Point Type
Device
72 characters
Description
ROLLOVER_VAL
27-30
Point Type
Derived (virtual)
Integer
Rollover
Description
GFK-1180H
SAFETY_PT
Point Type
All
32 characters
Safety Point
Description
SAMPLE_INTV
Point Type
All
Integer
Description
SAMPLE_INTV_UNIT
Point Type
All
3 characters
Description
SCAN_RATE
GFK-1180H
Point Type
Device
Integer
Scan Rate
Description
Configuration Import/Export
27-31
SETPOINT_HIGH
Point Type
All
Integer
Description
SETPOINT_LOW
Point Type
All
Integer
Description
TRIG_CK_PT
Point Type
All
32 characters
Availability Trigger
Description
TRIG_PT
Point Type
Device/Derived (virtual)
32 characters
Trigger
Description
27-32
GFK-1180H
TRIG_REL
Point Type
Device
2 characters
Relation
Description
TRIG_VAL
Point Type
Device
16 characters
Value
Description
UPDATE_CRITERIA
Point Type
Device
2 characters
Update Criteria
Description
VARIANCE_VAL
GFK-1180H
Point Type
Derived (virtual)
Number
Variance value
Description
Configuration Import/Export
27-33
VARS
Point Type
All
Integer
Vars
Description
Logicmaster 90 Support
Logicmaster fields map to the following field names in the Shared Name File:
Logicmaster
Field
Field Name
reference
ADDR
nickname
PT_ID
description
DESC
length
ELEMENTS
type
PT_TYPE
27-34
3.
Header
}Field Names
Records
GFK-1180H
Configuration Overview
When you configure Alarm Viewer OCX controls in CimEdit you can:
GFK-1180H
Select the projects from which you want users to view alarms.
Specify the alarm count layout, date format, fonts, and colors to be
used.
28-1
Run-Time Overview
At run-time, you can open a CimView screen containing an Alarm Viewer OCX
and:
Filter the alarm list to display only those alarms that have certain
characteristics.
28-2
GFK-1180H
On the Tools toolbar, click the OLE button, or select OLE Object
from the Tools menu, then:
1.
Select the position of the upper left corner of the Alarm Viewer
OCX control and click the left mouse button to fix it. The Insert
Object dialog box opens.
2.
3.
GFK-1180H
28-3
Click once on the control to activate its borders. You can now resize
the control or move it using the borders. You can also click the right
mouse button to display and select items from a pop-up menu.
Click outside the control to deactivate its border, and then double-click
on the control to display the CIMPLICITY AMV Control Properties
dialog and configure the Alarm Viewer. You can also click the right
mouse button to display and select items from a pop-up menu.
Click outside the control to deactivate its border, and then double-click
the Alarm Viewer OCX control.
Select the Alarm Viewer OCX control, then select CIMPLICITY AMV
Control Object from the Edit menu. This shows a cascading menu.
Select Properties from the cascading menu.
Select the Alarm Viewer OCX control, click the right mouse button,
and then select CIMPLICITY AMV Control Object from the pop-up
menu. This shows a cascading menu. Select Properties from the
cascading menu.
If you do any of the following, you will display the Object Properties dialog box for
the Alarm Viewer OCX control:
From the pop-up menu displayed when you click the right mouse
button, select Properties.
The CIMPLICITY AMV Control Properties dialog box includes the following tabbed
pages:
Tab
Fields
Buttons
Projects
Sort/Display
Count Layout
Date Format
Fonts
Colors
28-4
Description
Selects the fields you want to display in an alarm message and
the order in which you want to display them.
Changes the button layout and captioning.
Defines the projects the control connects to.
Defines the run-time sort order and display options.
Selects the count information to be displayed and the order and
orientation in which to display it.
Chooses how the date and time will be displayed in alarm
messages.
Selects the font type, style and size used for alarm, button,
count, date, and status text.
Defines the colors used by all elements in the control.
GFK-1180H
Fields
Use the Fields properties to select the fields you want to display in alarm messages
and the order in which you want to display them.
The list of fields depends on whether you are configuring a Static Alarm List or a
Dynamic Alarm List.
If any field titles have been modified, the modified title appears in parentheses to the
right of the field name (for example, "(Ack)" appears to the right of "Ack State").
Select the check box for each field you want to display.
Once you select a field, you can:
Use Row Up and Row Down to configure its row in the alarm
message.
Use Modify to configure its length and title in the Alarm Viewer OCX.
Position Left
Select the Alarm List field you want to move, then click Position Left to move it
toward the front of the current message row.
Position Right
Select the Alarm List field you want to move, then click Position Right to move it
toward the end of the current message row.
GFK-1180H
28-5
Row Up
Minimum row number is 1.
Select the Alarm List field you want to move, then click Row Up to move it up a
row in the message. The field will be placed at the start of the message row.
Row Down
Maximum row number is 10.
Select the Alarm List field you want to move, then click Row Down to move it
down a row in the message. The field will be placed at the start of the message row.
Modify
Select the Alarm List field you want to modify, then click Modify. The Field
Properties dialog box opens.
The current field length is displayed in the Length input field. To change the length
of a field:
1.
2.
Click OK.
Note
Field length is based on the average size of characters in the font you have chosen.
Thus, a length of 6 may be sufficient to display the string "IIIIII", but may be too
short to display "WWWWWW". To ensure that the length is always adequate, select
a fixed pitch font (such as Courier New) for your alarm page display.
The current field title is displayed in the Title input field. To change the title of a
field:
1.
2.
Click OK.
When you change the title of a field, its original title appears next to the check box in
the Fields list, and the modified title appears to the right in parentheses.
28-6
GFK-1180H
Buttons
Use the Buttons properties to change the button layout and captioning used for the
Alarm List.
The list of buttons depends on whether you are configuring a Static Alarm List or a
Dynamic Alarm List.
Select the check box for each button you want to use.
You may need to use the vertical scroll bar to the right of the list to see all of the
buttons. The following is a complete list:
GFK-1180H
Button
Description
Help
Displays the help file for an alarm. See page 28-23 for more
information.
Setup
Displays the Alarm Setup dialog. See page 28-23 for more
information.
Refresh
Updates the alarm list. See page 28-23 for more information.
View Stack
Displays the stacked alarms for the selected alarm. See page
28-24 for more information.
Comments
Toggle
Ack
28-7
Reset
Resets the currently selected alarms. See page 28-26 for more
information.
Delete
Ack First
Acknowledge first alarm in the alarm list. See page 28-27 for
more information.
Ack All
Acknowledge all alarms in the alarm list. See page 28-27 for
more information.
CimView Screen
Custom1-8
Lets you define up to eight custom buttons that you can use to
integrate external applications with the Alarm Viewer. See
page 28-20 for more information.
All buttons are available for the Static display. For the Dynamic display, only the
Refresh and Help buttons are not available.
Once you select a button, you can:
Use Row Up and Row Down to configure its row in the button pane.
Use Position Left and Position Right to configure its position in the
row.
Position Left
Select the Alarm List button you want to move, then click Position Left to move it
toward the front of the current row.
Position Right
Select the Alarm List button you want to move, then click Position Right to move
it toward the end of the current row.
Row Up
Minimum row number is 1
Select the Alarm List button you want to move, then click Row Up to move it up a
row. The button will be placed at the start of the row.
Row Down
Maximum row number is 10
Select the Alarm List button you want to move, then click Row Down to move it
down a row. The button will be placed at the start of the row.
28-8
GFK-1180H
Modify
Select the Alarm List button that you want to modify, then click Modify. The Button
Caption dialog box opens.
To modify a button:
1.
Enter the new caption in the Button Caption input field. You may
enter up to 100 characters.
2.
3.
If you have selected a custom button, enter the command string you
want to be executed when the button is selected in the Command
String field (this field is not available for the standard buttons).
4.
Click OK.
For standard buttons, the button name in the Buttons field of the Button Layout
window does not change - just the caption that is displayed in the button at run-time.
For custom buttons, the caption displayed in the button at run-time changes, and
when a user clicks the button, the command string you specified will be executed.
GFK-1180H
28-9
Projects
Use the Projects properties to select the projects from which you want to view
alarms.
You can add projects to the list, remove projects from the list, connect to the local
project and specify the alarm setup for each project in the list.
Adding a Project
To add a project to the list:
1.
2.
In the Select Project dialog box opens, select the project you want from
the list of available projects.
3.
Click OK. The Select Project dialog box closes and the project is
added to the list in the Projects properties.
Deleting a Project
To delete a project from the list:
1.
2.
3.
28-10
GFK-1180H
2.
Enter the Alarm Setup filter name you want to use in the Alarm setup
field.
3.
Click OK to close the Project Settings dialog box and return to the
Projects properties.
Sort/Display
Use the Sort/Display properties to define the sort order of alarms, and toggle the
display of the field titles, status box, and beginning display mode. You can also
enable/disable access to the popup runtime context menu via the right mouse button,
and enable/disable primary sort key changes with the left mouse button in the title bar
area.
GFK-1180H
28-11
Sort Alarms
You can use these fields to select the primary and secondary sort parameters for the
Alarm List.
For the primary sort key:
By
Click the drop-down list button to the right of the input field
and select the primary sort key.
Ascending
Select this option button if you want to sort the primary key in
ascending order.
Descending
Select this option button if you want to sort the primary key in
descending order.
28-12
Then
Click the drop-down list button to the right of the input field
and select the secondary sort key.
Ascending
Select this option button if you want to sort the primary key in
ascending order.
Descending
Select this option button if you want to sort the primary key in
descending order.
GFK-1180H
Project
Class
Resource
State
Time
Message
Ack state
Stacked
Comment
Alarm ID
Duration
Reference
The default sort key is Time descending. If an order is not established between
two alarms after applying the selected key criteria, Time descending will be used
to try to establish an order.
Select the sort criteria you want from the drop-down list boxes, and choose a desired
direction with the corresponding radio buttons.
If you select Allow title bar sort changes, run-time users can click on a field in
the title bar to sort the list of alarms by that criteria.
GFK-1180H
28-13
Display
You can toggle the display of the following:
Field Titles
Select this check box to display the field titles at the top of the
alarm list.
Clear the check box to eliminate the display.
Status Box
Begin in Static
28-14
If the column selected is already the primary key, the direction of the
sort will be reversed.
GFK-1180H
Count Layout
Use the Count/Layout properties to select the alarm count information to be
displayed and the order and orientation in which to display it.
Position
Use these check boxes to position the alarm count information:
Clear both check boxes to position the alarm count on the lower lefthand corner of the Alarm Viewer.
Select the Top of Screen check box to display the alarm information
in the upper left corner of the Alarm Viewer.
Select the Top of Screen and Center Count check boxes to display
the alarm information centered at the top of the Alarm Viewer.
Orientation
You can choose to display the alarm count information fields horizontally or
vertically.
Fields
You can choose whether or not to display:
Alarm count
Alarm date
Alarm time
Use the Move Up and Move Down buttons in this area to order the count, date,
and time display to your liking.
GFK-1180H
28-15
Date Format
Use the Date Format properties to choose how the date and time will be displayed in
alarm messages.
Date
Select the format you want to use to display the date of an alarm on the list. A
sample for the format you choose displays in the Sample field in this box. You may
select one of the formats from the list, or construct your own format using the
following information:
m
mm
mmm
mmmm
dd
ddd
dddd
Last two digits of year. For digits 00 through 09, only the last
digit is displayed.
yy
Last two digits of year. For digits 00 through 09, both digits
are displayed.
yyyy
For example, if you enter dddd dd mmmm yyyy, the sample date will be
Saturday 05 March 1994.
You may use spaces, dashes, slashes or any other delimiter of your choice to separate
the date fields.
28-16
GFK-1180H
Time
Select the format you want to use to display the time of an alarm on the list. A
sample for the format you choose displays in the Sample field in this box. You may
select one of the formats from the list, or construct your own format using the
following information:
H
HH
HHH
HHHH
MM
SS
TT
TTT
P, A, p, or a
AM/PM indicator.
GFK-1180H
28-17
Fonts
Use the Fonts properties to change the font type, style and size used for text displays
in the Alarm List.
All of the text fields are shown in the list box, along with their current font types and
sizes.
To change the font information for a text field:
28-18
1.
2.
Click Font.
3.
The Font dialog box opens and shows you the current attributes for the
font in the Font, Font style, Size, Effects, and Script fields.
4.
5.
Click OK to save your changes or click Close to close the Font dialog
box and return to the CIMPLICITY AMV Control Properties dialog
box.
GFK-1180H
Colors
Use the Colors properties to change the colors of properties in the control.
First, select the property you want to change in the Property Name field. You can
change the color of any of the following:
Button background
Count background
Status background
Status text
To select a color for the property, you can choose a default system color from the
System Color list, or select one of the 16 colors from the palette.
GFK-1180H
28-19
2.
Click Modify....
3.
In the Command: field, enter the command line you wish to execute
when the button is pressed.
4.
Click OK.
You may include any of the following parameter, which will be substituted with
characteristics of the selected alarm, in your command:
Parameter
Value
%DATETIME
%DT
same as %DATETIME
%DATE
%TIME
%ID
%CLASS
%RESOURCE
%RES
same as %RESOURCE
%REFERENCE
%REF
same as %REF
%MESSAGE
%MSG
same as %MESSAGE
%STATE
%ACK
The following additional parameters do not require the user to select an alarm:
28-20
Parameter
Value
%%
%USER
%PRODUCT
%CIM
same as %PRODUCT
%DIRECTORY
%DIR
same as %DIRECTORY
%PROJECT
%PRJ
same as %PROJECT
GFK-1180H
Example
By default, Alarm Comments are only available for the duration of an instance of an
alarm. You can use a Custom Button to create a set of long-term notes, describing
the historical conditions surrounding past alarm conditions in a factory.
To do this:
1.
2.
3.
4.
5.
When a user clicks this button, a new Notepad window opens for a file in the NOTES
subdirectory of the CIMPLICITY HMI project directory. The filename is
determined by the Alarm ID of the selected alarm.
GFK-1180H
28-21
The Ack First and Ack All buttons are active if any alarms are
displayed.
28-22
To select a single alarm, move the mouse to the alarm and click on it.
To select a series of individual alarms, hold down the Ctrl key, then
move to each alarm in turn and click on it.
To select a group of alarms, click on the first alarm in the group, then
hold down the Shift key, move the mouse to the last alarm in the group
and click on it. All alarms in the list between the first alarm and last
alarm will be selected.
GFK-1180H
If you click on an active button, the action associated with the button
executes.
If you move your mouse off the Alarm Viewer button without releasing
the mouse button, the action associated with the Alarm Viewer button
will not be invoked.
2.
Click Help.
The Alarm Operator Help dialog box displays all the information associated with the
alarm at the top of the dialog. If a help file has been defined for the alarm, the
contents of the file will be displayed in a scrolling region.
Click Done to close the dialog box.
GFK-1180H
28-23
2.
The Stacked Alarms dialog box opens. Information about the selected alarm is
displayed at the top of the screen. The alarm stack displays the state information
with the most recent state change at the top of the list.
Click Done to close the dialog box.
2.
Click Comments.
The Alarm Comments dialog box opens. You can use this dialog box to view the
current list of comments, add comments, or delete comments.
Click Done to close the Alarm Comments dialog box.
If you are adding comments for the first time to a Static alarm list, click Refresh to
update the list and display the letter C in the Comment field.
28-24
GFK-1180H
2.
3.
When you are through, click OK to close the dialog box and return to
the Alarm Comments dialog box.
Your comment now appears at the top of the list of comments along with the time
and date that the comment was entered.
2.
Note that you need the Delete Alarms privilege to use the Delete Comment
button.
Acknowledging an Alarm
You can acknowledge an alarm to inform other users that you have seen the alarm
and, if necessary, are working on resolving the condition that set off the alarm.
If an alarm is not listed as acknowledged, the condition may still exist and should be
investigated.
To acknowledge an alarm (or a group of alarms):
1.
2.
Click Ack.
When you acknowledge an alarm, its acknowledge state changes from N to Y. The
alarm remains in the alarm list until its deletion requirements have been met.
GFK-1180H
28-25
Resetting an Alarm
You can manually reset an alarm to indicate to the system that you are manually
overriding the alarm condition. If you do this, the alarm will not be generated again
until the condition that triggered the alarm returns to within its acceptable limits and
then goes back out of the acceptable limits.
The system automatically resets an alarm if the condition that triggered the alarm
returns to within acceptable limits.
To reset an alarm (or a group of alarms):
1.
2.
Click Reset.
When you reset an alarm, its state changes from ALARM to NORMAL. The alarm
remains in the alarm list until its deletion requirements have been met.
Deleting an Alarm
Deletion requirements are defined
during alarm configuration.
Normally, alarms are automatically deleted when their deletion requirements have
been met. An alarm will have one of the following deletion requirements:
Acknowledge
Reset
If your CIMPLICITY User role has been given the Alarm Delete privilege, you can
force alarms to be deleted without the deletion requirements being met.
To delete an alarm (or a group of alarms):
1.
2.
Click Delete.
When you delete an alarm, it will be removed from the alarm list.
2.
When you acknowledge and reset an alarm, it will be removed from the alarm list.
28-26
GFK-1180H
The alarms acknowledge state changes from N to Y. The alarm remains in the alarm
list until its deletion requirements have been met.
The acknowledge state of all the alarms on the list changes from N to Y. Alarms
remain in the alarm list until their deletion requirements have been met.
GFK-1180H
28-27
Filtering Alarms
You can click the Setup button to open the Alarm Setups and filter alarms. Alarm
filtering lets you look at particular groups of alarms on your alarm list. The Alarm
Setup options let you:
When the Alarm Setups dialog box opens, the first project in the list of projects
whose alarms you are monitoring displays in the Project field, and its current setup
displays in the Setup field.
Note
After you open the CimView screen containing the Alarm Viewer OCX control, the
first time you open the Alarm Setups dialog box, the current Setup for each project
is the default setup.
For more information on default alarm setups, see page 28-35.
28-28
GFK-1180H
The list of setups you can use to filter the projects you are monitoring is displayed
below the Setup field. There are three types of alarm setups:
<<UNFILTERED>> This is the standard default setup. When it is loaded, a user
can view all alarms available to the users CIMPLICITY HMI
User ID.
Project setups
Setups that start with the "$" character are project setups.
Project setups can be loaded and modified by any user logged
in to the project. However, the users role must have the
Modify Alarm Setups privilege to save or delete project
setups.
User setups
Setups that do not start with the "$" characters are only
available to users that log in with the same CIMPLICITY HMI
User ID as the user that created them. These users can modify,
save and delete the setups.
To close the dialog box and return to the Alarm List display, click Done.
Click on the setup in the list that you want to use. The setup name
displays in the Setup field.
2.
Click Load.
The alarm setup loads and the Alarm List is refiltered and redisplayed.
Note
You must load a filter in order to modify it.
GFK-1180H
28-29
The Classes properties displays the list of current alarm classes and indicates which
ones are used in the alarm setup.
Select the check box to the left of a class to include alarms for that class in the Alarm
List. Clear the check box to exclude alarms for that class from the Alarm List. You
can also:
28-30
GFK-1180H
The Resources properties displays the list of current resources, and indicates which
ones are used in the alarm setup.
Select the check box to the left of a resource to include alarms for that resource in the
Alarm List. Clear the check box to exclude alarms for that resource from the Alarm
List. You can also:
GFK-1180H
28-31
The Time and State filter properties display the current status of the Time and State
filters for the alarm setup.
Filter by Time
You can use this option to display all alarms that have occurred since a certain time.
To do this, set the Use Time Filter check box to enable this filter, then enter the
starting date and time for the filter in the Select Alarms Since input fields.
The time and date when you opened the Modify Setup dialog box are used as the
default time and date.
Filter by State
You can use this option to limit the alarms displayed on the Alarm List to only those
that occur in the state you select. The choices are:
State
Ack
Status
Description
Alarm
Alarm
Normal
Select the check box for each state you want to include in the alarm setup.
28-32
GFK-1180H
Select the alarm setup from the list, or use the current alarm setup.
2.
If the alarm setup you want to use is not the current alarm setup:
A. Click Load.
The alarm setup loads and the Alarm Setups dialog box closes.
B. Click Setup again to reopen the Alarm Setups dialog box.
3.
4.
Use the Modify Setup dialog box to set your new filter options
5.
Click OK.
Select the alarm setup you want to use as the basis for your new alarm
setup, or use the current alarm setup.
2.
If the alarm setup you want to use is not the current alarm setup:
A. Click Load.
The filter loads and the Alarm Setups dialog box closes.
B. Click Setup again to reopen the Alarm Setups dialog box.
3.
4.
Use the Modify Setup dialog box to set your new alarm setup options.
5.
Click OK.
6.
On the Alarm Setups dialog box, enter the new alarm setup name in the
Setup field.
7.
If you have the Modify Alarm Setups privilege, you can create a
project setup or a user setup. If you do not have the privilege, you can
only create a user setup.
8.
Click Save.
The new alarm setup will be added to the list of available setups.
GFK-1180H
28-33
Click the setup name in the list in the Alarm Setups dialog box. The
name will appear in the Setup field.
If you have the Modify Alarm Setups privilege, you can delete
project and user setups. If you do not have the privilege, you can only
delete your user setups.
2.
Click Delete. The alarm setup will be removed from the list of
available setups.
You can select a default alarm setup in the Alarm Setups dialog box. This default
alarm setup will be used if:
The default alarm setup for the project in the CIMPLICITY AMV
Control Properties dialog box does not exist in your Alarm Setups list.
Click on the alarm setup in the list in the Alarm Setups dialog box.
2.
28-34
GFK-1180H
If an alarm setup was specified for the Alarm Viewer on the Projects
property page of the CIMPLICITY AMV Control Properties dialog box,
and if the alarm setup exists in the Alarm Setups list for the users
CIMPLICITY User ID, then it is used as the default alarm setup
whenever the user opens the CimView screen.
2.
If an alarm setup was specified for the Alarm Viewer on the Projects
property page of the CIMPLICITY AMV Control Properties dialog box,
and the alarm setup does not exist in the Alarm Setups list for the users
CIMPLICITY User ID, then:
3.
GFK-1180H
If no alarm setup was specified for the Alarm Viewer on the Projects
property page of the CIMPLICITY AMV Control Properties dialog box,
then:
28-35
Name the Alarm Viewer OCX control you want to use for the method.
Create an Invoke Method action for the screen object and select the
Alarm Viewer method you want to invoke.
When a user clicks on the object at run-time, the button function executes.
2.
3.
4.
Enter a name for the Alarm Viewer control in the Object name field.
5.
Select OK to save your changes and close the Object Properties dialog
box.
You can now select the control when you create an Invoke Method action.
GFK-1180H
29-1
Method
Confirmed
None of the Alarm Viewer methods use the advanced features of method invocation.
Therefore, the Advanced... button is disabled for all Alarm Viewer methods.
NotifyAllPropertySinks
DoAckAll
DoAckFirst
DoAcknowledge
DoAckReset
DoCimviewScreen
DoComments
DoCustom<n>
DoDelete
DoHelp
DoRefresh
DoReset
DoSetup
DoToggle
DoViewStack
MoveDownOneAlarm
MoveUpOneAlarm
PageDownAlarms
PageUpAlarms
SelectAllAlarms
SelectPageAlarms
SelectTopAlarm
29-2
GFK-1180H
AboutBox Method
This method displays the Help About dialog box for the CIMPLICITY Alarm Viewer
control. There is no equivalent to this method in the Alarm Viewer control.
When you configure the AboutBox method, the Advanced... button is not
activated because no further parameters are required for the method.
DoAckAll Method
This method acknowledges all alarms in the CIMPLICITY Alarm Viewer controls
alarm list. It is equivalent to the Ack All button in the Alarm Viewer control.
When you configure the DoAckAll method, the Advanced... button is not activated
because no further parameters are required for the method.
DoAckFirst Method
This method acknowledges the first alarm in CIMPLICITY Alarm Viewer controls
alarm list. It is equivalent to the Ack First button in the Alarm Viewer control.
When you configure the DoAckFirst method, the Advanced... button is not
activated because no further parameters are required for this method.
DoAcknowledge Method
This method acknowledges the currently selected alarm(s) in the alarm list on the
CIMPLICITY Alarm Viewer control. It is equivalent to the Ack button in the Alarm
Viewer control.
When you configure the DoAcknowledge method, the Advanced... button is not
activated because no further parameters are required for this method.
DoAckReset Method
This method acknowledges and resets the currently selected alarm(s) in the alarm list
on the CIMPLICITY Alarm Viewer control. It is equivalent to the Ack and Reset
button in the Alarm Viewer control.
When you configure the DoAckReset method, the Advanced... button is not
activated because no further parameters are required for this method.
DoCimviewScreen Method
This method displays the CimView screen configured for the currently selected
alarm in the alarm list on the CIMPLICITY Alarm Viewer control. It is equivalent to
the CimView Screen button in the Alarm Viewer control.
At run-time, the user must select only one alarm for this method to work. If the user
selects more than one alarm, the method will not execute.
When you configure the DoCimviewScreen method, the Advanced... button is
not activated because no further parameters are required for this method.
GFK-1180H
29-3
DoComments Method
This method opens the Alarm Comments dialog box for the currently selected alarm
in the CIMPLICITY Alarm Viewer controls alarm list so that users can view, add, or
delete comments for the alarm. It is equivalent to the Comments button in the
Alarm Viewer control.
At run-time, the user must select only one alarm for this method to work. If the user
selects more than one alarm, the method will not execute.
When you configure the DoComments method, the Advanced... button is not
activated because no further parameters are required for this method.
DoCustom<n> Method
These methods launch user-defined applications from the CIMPLICITY Alarm
Viewer control. They are equivalent to the Custom1 through Custom8 buttons in
the Alarm Viewer control.
When you configure the DoCustom<n> method, the Advanced... button is not
activated because no further parameters are required for this method.
DoDelete Method
If users have the Alarm Delete privilege, this method deletes the currently selected
alarm(s) in the alarm list on the CIMPLICITY Alarm Viewer control. It is equivalent
to the Delete button in the Alarm Viewer control.
When you configure the DoDelete method, the Advanced... button is not activated
because no further parameters are required for this method.
DoHelp Method
This method opens the Alarm Operator Help dialog for the currently selected alarm
in the CIMPLICITY Alarm Viewer controls alarm list. It is equivalent to the Help
button in the Alarm Viewer control.
At run-time, the user must select only one alarm for this method to work. If the user
selects more than one alarm, the method will not execute.
When you configure the DoHelp method, the Advanced... button is not activated
because no further parameters are required for this method.
Important: The DoHelp Method only works in static mode. It does not work in
dynamic mode.
DoRefresh Method
This method refreshes Static Alarm list in the CIMPLICITY Alarm Viewer control
with the latest alarms. It is equivalent to the Refresh button in the Alarm Viewer
control.
When you configure the DoRefresh method, the Advanced... button is not
activated because no further parameters are required for this method.
29-4
GFK-1180H
DoReset Method
This method lets a user reset the currently selected alarm(s) in the CIMPLICITY
Alarm Viewer controls alarm list. It is equivalent to the Reset button in the Alarm
Viewer control. A reset alarm will not be generated again until it returns to its
normal state then goes back to an alarm state.
When you configure the DoReset method, the Advanced... button is not activated
because no further parameters are required for this method.
DoSetup Method
This method opens the Alarm Setups dialog so that users can select the filtering they
want when viewing alarms in the CIMPLICITY Alarm Viewer control. It is
equivalent to the Setup button in the Alarm Viewer control.
When you configure the DoSetup method, the Advanced... button is not activated
because no further parameters are required for this method.
DoToggle Method
This method toggles the CIMPLICITY Alarm Viewer control between the Static
Alarm list and the Dynamic Alarm list. It is equivalent to the Toggle button in the
Alarm Viewer control.
When you configure the DoToggle method, the Advanced... button is not
activated because no further parameters are required for this method.
DoViewStack Method
This method opens the Stacked Alarms dialog for the selected alarm in the
CIMPLICITY Alarm Viewer control. It is equivalent to the View Stack button in
the Alarm Viewer control.
At run-time, the user must select only one alarm for this method to work. If the user
selects more than one alarm, the method will not execute.
When you configure the DoViewStack method, the Advanced... button is not
activated because no further parameters are required for this method.
MoveDownOneAlarm Method
This method highlights the next alarm in the CIMPLICITY Alarm Viewer controls
alarm list. If the current alarm is the last alarm on the page but not the last in the list,
this method moves the list up to highlight the next alarm. It is equivalent to the down
arrow on a users keyboard.
When you configure the MoveDownOneAlarm method, the Advanced... button
is not activated because no further parameters are required for this method.
GFK-1180H
29-5
MoveUpOneAlarm Method
This method highlights the previous alarm in the CIMPLICITY Alarm Viewer
controls alarm list. If the current alarm is the first alarm on the page but not the first
alarm in the list, this method moves the list down to highlight the previous alarm. It
is equivalent to the up arrow on a users keyboard.
When you configure the MoveUpOneAlarm method, the Advanced... button is
not activated because no further parameters are required for this method.
PageDownAlarms Method
If there is more than one page of alarms in the CIMPLICITY Alarm Viewer controls
alarm list, this method displays the next page of alarms. It is equivalent to the Page
Down button on the users keyboard.
When you configure the PageDownAlarms method, the Advanced... button is
not activated because no further parameters are required for this method.
PageUpAlarms Method
If there is more than one page of alarms in the CIMPLICITY Alarm Viewer controls
alarm list, this method displays the previous page of alarms. It is equivalent to the
Page Up button on the users keyboard.
When you configure the PageUpAlarms method, the Advanced... button is not
activated because no further parameters are required for this method.
SelectAllAlarms Method
This method selects all alarms in the CIMPLICITY Alarm Viewer controls alarm
list.
When you configure the SelectAllAlarms method, the Advanced... button is not
activated because no further parameters are required for this method.
SelectPageAlarms Method
This method selects all alarms displayed on the current page in the CIMPLICITY
Alarm Viewer control.
When you configure the SelectPageAlarms method, the Advanced... button is
not activated because no further parameters are required for this method.
SelectTopAlarm Method
This method selects the first alarm from the current page displayed in the
CIMPLICITY Alarm Viewer control and deselects all other selected alarms.
When you configure the SelectTopAlarm method, the Advanced... button is not
activated because no further parameters are required for this method.
29-6
GFK-1180H
Filter the alarm list to display only those alarms that have certain
characteristics.
You can use the stand-alone CIMPLICITY Alarm Viewer to display alarms in two
modes:
In Static display mode, when you open a CIMPLICITY Alarm Viewer document, you
are presented with a current list of alarms. This list remains in the window until you:
GFK-1180H
30-1
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
30-2
GFK-1180H
Open
Save
Save As
Saves the current Alarm View. Use this menu item when you
want to specify the pathname of the saved file.
Install
Print Preview
Print Setup
Defines the printer, page size, and orientation for your print
requests.
Exit
Status Bar
GFK-1180H
30-3
List Layout
Using Help
About AMV
Open
Save
Copy
Help
30-4
Ctrl+N
Ctrl+O
Ctrl+S
Ctrl+P
Ctrl+C
F1
Alt+Spacebar
Alt+Print Screen
GFK-1180H
GFK-1180H
30-5
Clear both check boxes to put the alarm count information in the lower
left-hand corner of the Alarm Viewer.
Set the Alarm at Top of Screen check box to put the alarm count
information in the upper left-hand corner of the Alarm Viewer.
Set the Alarm at Top of Screen and Center Count check boxes to
center the alarm count information on the top of the Alarm Viewer.
Orientation
You can choose to display the fields horizontally or vertically.
Select Horizontal to display the fields side by side in the order you
specify.
Select Vertical to display the fields one on top of the other in the order
you specify.
Fields
You can choose whether or not to display:
Alarm count
Alarm date
Alarm time
You can use the Move Up and Move Down buttons in this area to order the count,
date, and time display to your liking.
30-6
GFK-1180H
You can define the following colors for the alarm count display:
Unseen Alarm Count The color of the alarm count when new alarms are
generated and you have not yet viewed them.
Seen Alarm Count
The color of the alarm count after you have viewed the
current set of alarms.
Background
Click Color... to use the Color dialog box to select the color you want for the
display.
Note
If you select a dithered color, its solid component will be used, not the color you
selected. To see the components of a dithered color, click Define Custom
Colors>> in the Colors dialog box.
GFK-1180H
30-7
30-8
GFK-1180H
The list of fields will depend on whether you are configuring a Static Alarm List or a
Dynamic Alarm List.
If any field titles have been modified, the modified title appears in parentheses to the
right of the field name (for example, "(Ack)" appears to the right of "Ack State").
GFK-1180H
30-9
You can select one or more of the fields in this list. To select a field, set its check
box.
Dynamic Alarm Fields
After you select Dynamic, the list of alarm fields looks like this:
You can select one or more of the fields in this list. To select a field, set its check
box.
Once you have selected a field for display in the alarm list, you can configure which
row of the alarm message the field will be placed in, where in the row it will be
placed, and the length of the display.
Position Left
Select the Alarm List field you want to move, then click Position Left to move it
toward the front of the current message row.
Position Right
Select the Alarm List field you want to move, then click Position Right to move it
toward the end of the current message row.
Row Up
Minimum row number is 1.
Select the Alarm List field you want to move, then click Row Up to move it up a
row in the message. The field will be placed at the start of the message row.
Row Down
Select the Alarm List field you want to move, then click Row Down to move it
down a row in the message. The field will be placed at the start of the message row.
30-10
GFK-1180H
Modify
Select the Alarm List field you want to modify, then click Modify. The Field
Properties dialog box opens.
The current field length is displayed in the Length input field. To change the length
of a field:
1.
2.
Click OK.
Note
Field length is based on the average size of characters in the font you have chosen.
Thus, a length of 6 may be sufficient to display the string "IIIIII", but may be too
short to display "WWWWWW". To ensure that the length is always adequate, select
a fixed pitch font (such as Courier New) for your alarm page display.
The current field title is displayed in the Title input field. To change the title of a
field:
1.
2.
Click OK.
When you change the title of a field, its original title appears next to the check box in
the Fields list, and the modified title appears to the right in parentheses.
GFK-1180H
30-11
Font
The current font name and size are displayed. To change the alarm list font, click
Font... to display the Font dialog box. Use the dialog box to configure the font
type, style, and size to be used for the alarm list.
Background Color
The current background color for the screen is displayed. To change the background
color, click Color... to display the Color dialog box. Use the dialog box to
configure the background color you want for the alarm list.
30-12
GFK-1180H
The list of buttons will depend on whether you are configuring a Static Alarm List or
a Dynamic Alarm List.
You can select one or more of these buttons. To select a button, set its check box.
GFK-1180H
30-13
You will need to use the vertical scroll bar to the right of the table to see all of the
buttons. The following is a complete list:
30-14
Button
Description
Help
Displays the help file for an alarm. See page 30-24 for more
information.
Setup
Displays the Alarm Setup dialog box. See page 30-24 for
more information.
Refresh
Updates the alarm list. See page 30-24 for more information.
View Stack
Displays the stacked alarms for the selected alarm. See page
30-25 for more information.
Comments
Displays the Alarm Comments dialog box. See page 30-25 for
more information.
Toggle
Displays the Dynamic Alarm list. See page 30-24 for more
information.
Ack
Reset
Delete
Ack First
Ack All
CimView Screen
Custom1-8
Lets you define up to eight custom buttons that you can use to
integrate external applications with the Alarm Viewer. See
page 30-20 for more information.
GFK-1180H
You can select one or more of these buttons. To select a button, set its check box.
Toggle
Displays the Static Alarm list. See page 30-24 for more
information.
Setup
Displays the Alarm Setups dialog box. See page 30-24 for
more information.
Once you have selected the buttons for display in the alarm list, you can configure
which button row the button will be placed in, where in the row it will be placed, and
what caption will be displayed.
Position Left
Select the Alarm List button you want to move, then click Position Left to move it
toward the front of the current row.
Position Right
Select the Alarm List button you want to move, then click Position Right to move
it toward the end of the current row.
Row Up
Minimum row number is 1
Select the Alarm List button you want to move, then click Row Up to move it up a
row. The button will be placed at the start of the row.
Row Down
Select the Alarm List button you want to move, then click Row Down to move it
down a row. The button will be placed at the start of the row.
GFK-1180H
30-15
Modify
Select the Alarm List button that you want to modify, then click Modify. The
Button Caption dialog box opens.
To modify a button:
1.
Enter the new caption in the Button Caption field. You may enter up
to 100 characters.
2.
3.
If you have selected a custom button, enter the command string you
want to be executed when the button is selected in the Command
String field (this field is not available for the standard buttons).
4.
Click OK.
For standard buttons, the button name in the Buttons field of the Button Layout
window will not change - just the caption that is displayed in the button at run-time.
For custom buttons, the caption displayed in the button at run-time will be changed,
and when a user clicks the button, the command string you specified will be
executed.
Background Color
The current background color for the screen is displayed. To change the background
color, click Color... to display the Color dialog box. Use the dialog box to
configure the background color you want for the alarm list.
30-16
GFK-1180H
GFK-1180H
30-17
Window Placement
If you do not select these options, other Use these check boxes to define what happens to the Alarm Viewer window when
windows may overwrite the window,
new alarms are received. Your choices are:
and it will not pop to the top when new
alarms are received.
Always On Top
Select this check box if you want the window to always be on top of other
windows.
Pop to Top on new Alarms
Select this check box if you want the window to redisplay on top of other
windows when new alarms are received.
30-18
GFK-1180H
Date
Select the format you want to use to display the date of an alarm on the list. A
sample for the format you choose displays in the Sample field in this box. You
may select one of the formats from the list, or construct your own format using the
following information:
m
mm
mmm
mmmm
d
dd
ddd
dddd
y
yy
yyyy
For example, if you enter dddd dd mmmm yyyy, the sample date will be
Saturday 05 March 1994.
You may use spaces, dashes, slashes or any other delimiter of your choice to separate
the date fields.
Time
Select the format you want to use to display the time of an alarm on the list. A
sample for the format you choose displays in the Sample field in this box. You
may select one of the formats from the list, or construct your own format using the
following information:
H
HH
HHH
HHHH
M
MM
S
SS
TT
T
TTT
P, A, p, or a
GFK-1180H
30-19
2.
Click Modify....
3.
In the Command: field, enter the command line you wish to execute
when the button is pressed.
4.
Click OK.
You may include any of the following parameter, which will be substituted with
characteristics of the selected alarm, in your command:
Parameter
Value
%DATETIME
%DT
same as %DATETIME
%DATE
%TIME
%ID
%CLASS
%RESOURCE
%RES
same as %RESOURCE
%REFERENCE
%REF
same as %REFERENCE
%MESSAGE
%MSG
same as %MESSAGE
%STATE
%ACK
The following additional parameters do not require the user to select an alarm:
30-20
Parameter
Value
%%
%USER
%PRODUCT
%CIM
same as %PRODUCT
%DIRECTORY
%DIR
same as %DIRECTORY
%PROJECT
%PRJ
same as %PROJECT
GFK-1180H
Example
Alarm Comments are only available for the duration of an instance of an alarm. You
can use a Custom Button to create a set of long-term notes, describing the historical
conditions surrounding past alarm conditions in a factory.
To do this:
1.
2.
3.
4.
When a user selects this button, a new Notepad will be executed for a file in the
NOTES subdirectory of the CIMPLICITY HMI project directory. The Alarm ID of
the selected alarm determines the filename.
GFK-1180H
30-21
Enter your CIMPLICITY HMI username in the Username field, and enter your
CIMPLICITY HMI user password (if you have one) in the Password field.
You can also:
When you select the Login! menu option, you may see the Select Project dialog
box. Use this dialog box to select a remote project to log in to.
30-22
GFK-1180H
Selecting Alarms
A number of the functions you can perform require you to select one or more alarms
from the alarm list. There are several ways to do this:
To select a single alarm, move the mouse to the alarm and click on it.
To select a series of individual alarms, hold down the Ctrl key, then
move to each alarm in turn and click on it.
To select a group of alarms, click on the first alarm in the group, then
hold down the Shift key, move the mouse to the last alarm in the group
and click on it. All alarms in the list between the first alarm and last
alarm will be selected.
The Ack First and Ack All buttons are active if any alarms are
displayed.
In the following sections of this chapter, the buttons will be referred to by their
default captions. You may have defined other captions for some or all of your Alarm
List buttons, but the functions they perform do not change.
When you click on a button, a brief description of that button is displayed on the
Status Bar. If you move your mouse off the Alarm Viewer button without releasing
the mouse button, the action associated with the Alarm Viewer button will not be
invoked.
GFK-1180H
30-23
2.
Click Help.
The Alarm Operator Help dialog box displays all the information associated with the
alarm at the top of the dialog box. If a help file has been defined for the alarm, the
contents of the file will be displayed in a scrolling region.
Click Done to close the dialog box and return to the Alarm Viewer screen.
30-24
GFK-1180H
2.
The Stacked Alarms dialog box opens. Information about the selected alarm is
displayed at the top of the screen. The alarm stack displays the state information
with the most recent state change at the top of the list.
Click Done to close the dialog box and return to the Alarm Viewer screen.
2.
Click Comments.
GFK-1180H
30-25
Acknowledging an Alarm
You can acknowledge an alarm to inform other users that you have seen the alarm
and, if necessary, are working on resolving the condition that set off the alarm.
If an alarm is not listed as acknowledged, the condition may still exist and should be
investigated.
To acknowledge an alarm (or a group of alarms):
1.
2.
Click Ack.
Resetting an Alarm
You can manually reset an alarm to indicate to the system that you are manually
overriding the alarm condition. If you do this, the alarm will not be triggered again
until the situation returns to the configured acceptable range and then goes back out
of the acceptable range.
The system automatically resets an alarm if the condition that triggered the alarm
returns to within acceptable limits.
To reset an alarm (or a group of alarms):
1.
2.
Click Reset.
When you reset an alarm, its state changes from ALARM to NORMAL.
Deleting an Alarm
Deletion requirements are defined
during alarm configuration.
Normally, alarms are automatically deleted once they have been successfully
acknowledged and/or reset as long as their deletion requirements have been met.
If you have been given the Alarm Delete privilege, you can force alarms to be
deleted without the deletion requirements being met.
To delete an alarm (or a group of alarms):
1.
2.
Click Delete.
When you delete an alarm, it will be removed from the alarm list.
30-26
GFK-1180H
2.
GFK-1180H
30-27
Filtering Alarms
You can click the Setup button to open the Alarm Setups and filter alarms. Alarm
filtering lets you look at particular groups of alarms on your alarm list. The Alarm
Setup options let you:
When the Alarm Setups dialog box opens, the current setup displays in the Setup
field.
30-28
GFK-1180H
The list of setups you can use to filter the projects you are monitoring is displayed
below the Setup field. There are three types of alarm setups:
<<UNFILTERED>> This is the standard default setup. When it is loaded, a user
can view all alarms available to the users CIMPLICITY HMI
User ID.
Project setups
Setups that start with the "$" character are project setups.
Project setups can be loaded and modified by any user logged
in to the project. However, the users role must have the
Modify Alarm Setups privilege to save or delete project
setups.
User setups
Setups that do not start with the "$" characters are only
available to users that log in with the same CIMPLICITY
HMI User ID as the user that created them. These users can
modify, save and delete the setups.
To close the dialog box and return to the Alarm List display, click Done.
To close the dialog box and return to the Alarm List display, click Done.
Click on the setup in the list that you want to use. The setup name
displays in the Setup field.
2.
Click Load.
The setup loads and the Alarm List is refiltered and redisplayed.
Note
You must load a setup in order to modify it.
GFK-1180H
30-29
The Classes properties displays the list of current alarm classes and indicates which
ones are used in the setup. Set the check box to the left of a class to include alarms
for that class in the Alarm List. Clear the check box to exclude alarms for that class
from the Alarm List.
Click Add All to select all classes.
Click Remove All to clear all classes.
30-30
GFK-1180H
The Resources properties displays the list of current resources, and indicates which
ones are used in the setup. Set the check box to the left of a resource to include
alarms for that resource in the Alarm List. Clear the check box to exclude alarms for
that resource from the Alarm List.
Click Add All to select all resources.
Click Remove All to clear all resources.
GFK-1180H
30-31
The Time/State/Sort properties display the current status of the Time and State filters,
and the Sort Order for the Alarm List.
Filter by Time
You can use this option to display all alarms that have occurred since a certain time.
To do this, set the Use Time Filter check box to enable this filter, then enter the
starting date and time for the filter in the Select Alarms Since input fields.
The time and date when you opened the Modify Setup dialog box are used as the
default time and date.
Filter by State
You can use this option to limit the alarms displayed on the Alarm List to only those
that occur in the state you select. The choices are:
State
Ack
Status
Alarm
Alarm
Normal
Description
Set the check box for each state that you want to filter for.
Sort
You can use this option to select the primary sort parameter for the Alarm List. The
choices are:
Class
Resource
State
Time
The default sort key is Time. If a category other than Time is selected as the
primary sort key, the secondary sort key is Time.
Click the option button next to the sort order you want to use.
30-32
GFK-1180H
Select the setup from the list, or use the current setup.
2.
If the setup you want to use is not the current setup, click Load. The
setup will be loaded and the Alarm Setups dialog box closes. Click
Setup again to reopen the dialog box.
3.
4.
Use the Modify Setup dialog box to set your new setup options, and
click OK.
Select the setup you want to use as the basis for your new setup, or use
the current setup.
2.
If the setup you want to use is not the current setup, click Load. The
setup loads and the Alarm Setups dialog box closes. Click Setup
again to reopen the dialog box.
3.
4.
Use the Modify Setup dialog box to set your new setup options, and
click OK.
5.
On the Alarm Setups dialog box, enter the new setup name in the
Setup field and click Save. The new setup name will be added to the
list of available setups.
Click the setup name in the list. The name will appear in the Setup
field.
2.
Click Delete. The setup name will be removed from the list.
The default setup is the setup that the Alarm Viewer uses to initially display the
Alarm List.
To declare a default setup:
1.
2.
If you want to find out the name of your current default setup, do the following:
1.
2.
Click Setup.
The setup that appears in the Setup field is the default setup.
GFK-1180H
30-33
Printing Alarms
The File menu contains three functions for printing the alarm list.
Print Setup...
Print Preview
Print...
When you click on Print Setup..., the Print Setup dialog box opens. You can use
this dialog box to select the printer, and the format for your alarm list printout.
When you click on Print Preview, the printout that will be generated is displayed.
You can zoom in for a closer look, step through the pages, or view the printout as
one-sided or two-sided. In addition, if you click on the Print... button, you can
access the Print dialog box.
When you click on Print..., the Print dialog box opens. You can use this dialog box
to select the print range, print quality, and number of copies. In addition, you can
click on the Setup... button in this dialog box to access the Print Setup dialog box.
Copying Alarms
The Copy function on the Edit menu lets you copy selected alarms to the clipboard.
Once the alarm is on the clipboard, you can paste it in another window.
For example, if there is an alarm on the list that you want to include in an e-mail
message:
30-34
1.
2.
3.
4.
5.
GFK-1180H
2.
From the File menu, select Install. The Create Shortcut dialog box
opens.
GFK-1180H
3.
4.
30-35
2.
Click the right mouse button to open the Windows pop-up menu.
3.
Select Properties. The Properties dialog box for the screen opens.
4.
If you do not do this, the screen will take a longer time to start, and Alarm Viewer
will be forced to query the user about the project to be used.
2.
Click the right mouse button to open the Windows pop-up menu.
3.
4.
Insert the option (or options) you want between the executable name
and the Alarm Viewer screen name in the Target input field on the
Shortcut properties page.
For example, if you have created an Alarm Viewer screen and you do not want
users to reconfigure the count layout or list layout, you can change the command line
for the screens Alarm Viewer icon from this:
amv.exe C:\cimplicity\projects\proj\view.AMV
to this:
amv.exe /noconfig C:\cimplicity\projects\proj\view.AMV
You can also use the command line to start multiple Alarm Viewer screens from a
single icon.
The following command line arguments are available for your use:
30-36
GFK-1180H
/noopen
Does not allow the user to open any other files from this Alarm Viewer screen.
The New and Open menu items and the file list are removed from the File menu.
The File Open toolbar button is disabled.
Example:
amv.exe /noopen C:\myproj\view.amv
/noconfig
Does not allow the user to configure the count and list layouts on the screen.
The Count Layout and List Layout menu items are disabled on the Configure
menu.
Example:
amv.exe /noconfig C:\myproj\view.amv
GFK-1180H
30-37
Using CimView
About CimView
CimView is an interactive graphical user interface to help you monitor and control
your facility. It displays the screens that were created with CimEdit.
Your data can be displayed and monitored as text or a variety of graphic objects.
Both text and graphic objects can automatically change color, move, and rotate based
on the data collected.
CimView screens can also have a variety of interactive control functions that let you
set point values, display other graphic screens, initiate custom software routines and
start other Windows applications.
Getting Started
There are many ways to start a CimView session. Here are some:
GFK-1180H
You can select a CimView icon that is in your project folder or on the
desktop.
31-1
Window Components
The CimView window has several components that have been labeled in the above
figure.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
Display help.
Depending on the configuration set up by your System Manager, you may not see all
of these window components, and you may not have access to all of these functions.
For example, in many installations the title bar, menu bar, toolbar, and status bar will
be hidden, and the CimView window will occupy the entire terminal screen.
31-2
GFK-1180H
Menu Bar
The Menu Bar displays the menus that you will use to control most of your work in
CimView.
Title Bar
The Title Bar displays the filename of the screen you are currently displaying. You
can also use it to move the CimView window.
When you click the right mouse button in the Title bar, a menu of standard window
functions is displayed. You can use these functions to move, resize, lower, or close
the window.
Window Buttons
When you click on the Minimize button, you will minimize the window.
The minimized window is hidden. To restore the window, click on its button in the
task bar.
When you click on the Maximize button, the window will be resized to take up the
entire terminal screen. When the window is maximized, the Maximize button is
replaced by the Restore button.
When you click on the Restore button, the window will be restored back to its old
size.
Scroll Bars
Use the vertical scroll bar to move the screen up and down if it doesnt fit in the
window.
Use the horizontal scroll bar to move the screen back and forth if it doesnt fit in the
window.
Status Bar
The Status Bar displays information about your current viewing operation, and is
divided into four areas:
Message Area
Cursor Location
Toolbars
A toolbar is a frame containing a set of controls. Generally, toolbars are used to
provide quick access to specific commands or options. These commands or options
are usually also available in the menus. CimView uses a Standard toolbar.
GFK-1180H
Using CimView
31-3
CimView Menus
The Menu Bar displays the menus that you will use to control most of your work in
CimView. The options are:
File
View
Use this menu to display the toolbars, replace the current screen
with the previous or home screen, or change view magnification.
Help
Open Window...
31-4
Print...
Print Setup...
GFK-1180H
Send
Recent screens
Exit
Status Bar
Menu/Title Bar
GFK-1180H
Using CimView
31-5
Full Screen
31-6
Previous Screen
Home Screen
Zoom 50%
Zoom 100%
Zoom 200%
Zoom...
GFK-1180H
On Screen
About CimView
GFK-1180H
Restore
Move
Size
Minimize
Maximize
Close
Using CimView
31-7
Toggles the display of the Menu Bar and Title Bar in the
window. A check mark appears to the left of this option if
the Menu Bar and Title Bar are being displayed.
Full Screen
Help
Properties
31-8
Menu Item
Description
Open Window
Help
Previous
Home Screen
Full Screen
Zoom 100
Zoom to Fit
GFK-1180H
This toolbar is a movable toolbar. You can either display it in a separate window
(also called a floating toolbar), or you can align it to one of the edges of the
CimView window at your discretion (this is also called a docked toolbar).
If you are using a floating toolbar, you can close the Toolbar window by clicking the
Window Menu button on the toolbar.
If you have closed the Toolbar window, you can restore it by clicking Toolbars on
the View menu. When the Options dialog opens, click the Standard toolbar, and
then click OK.
2.
Hold down the mouse button and drag the toolbar to any spot on your
terminal screen that is not a dockable location.
3.
2.
Hold down the mouse button and drag the toolbar to the edge of the
CimView window where you want to put the toolbar.
3.
GFK-1180H
Ctrl+O
Ctrl+P
Alt+Enter
Alt+Print Screen
F1
Alt+Spacebar
Using CimView
31-9
Within CimView:
Click on a screen object that has been configured to let you access
another screen.
Press a key sequence that has been configured to let you access another
screen.
When you look at a screen in CimView, it consists of a set of objects. There are
many types of objects. Among them are:
ActiveX controls.
Objects can be static, or they can be animated. CimView can display objects with
movement, rotation, fill, size, or color change animation.
31-10
GFK-1180H
Close Screen
Execute Command
Home Screen
Invoke Method
Invoke Script
Open Screen
Overlay Screen
Previous Screen
Ramp Setpoint
Relative Setpoint
Toggle Setpoint
Variable Setpoint
Variable Assign
In addition to the actions that may be included in procedures, the Slider action may
be configured for object movement and Text objects may be configured for Setpoint
value animation (also known as in-place edit setpoints).
Consult with your CIMPLICITY system manager or project integrator about the
special features of the screens you will be using.
The object is an OLE object that has a primary verb that does not
modify the object (for example, an embedded sound that you click on to
play).
When you move the mouse around the screen, action objects on the screen are
highlighted with a rectangle when the mouse moves over them.
Alternatively, you may locate action objects by pressing the Tab, Shift+Tab or
arrow keys on the keyboard.
The tab-order of the objects is specified when the screen is created. Consult with
your CIMPLICITY system manager or project integrator about the tab-order.
Use the arrow keys to highlight the closest object in the direction of the
arrow key. Selection occurs only between active action objects.
If you are currently using a Slider setpoint, the arrows affect the
setpoint, not the selection of another action object.
GFK-1180H
Using CimView
31-11
When you press the mouse button or the Enter key, the action
associated with the On mouse down event will be executed.
When you release the mouse button or the Enter key, the action
associated with the On mouse up action will be executed.
2.
Hold down the left mouse button and move the object in the direction
(vertical and/or horizontal) you want for the setpoint value. As you
move the object, the proposed setpoint value will be displayed in the
Status Bar message area.
3.
Release the left mouse button. The new value for the point will be
displayed in the Status Bar.
If the object is also configured with mouse down and mouse up action procedures,
they execute appropriately.
If you want to cancel the Slider setpoint action, move the mouse cursor off the object,
then release the left mouse button, or press the Esc key and release the button.
31-12
GFK-1180H
To activate the arrow keys for the Slider setpoint action, press Enter.
2.
Once the arrow keys are activated for the Slider setpoint action, you
will no longer be able to move the object with the mouse or use the left
mouse button to select other objects.
3.
Use the Up and Down arrows for vertical slider actions, and use the
Left and Right arrows for horizontal slider actions. As you use the
arrow keys, the object will move in the direction you choose, and the
proposed setpoint value will be displayed in the Status Bar message
area.
To move the object by one pixel, press an arrow key. The direction of
the key defines the direction of the movement.
To move the object by ten (10) pixels, hold down the Ctrl key, then
press an arrow key.
4.
5.
Use the Enter key to accept the slider action, and perform the setpoint.
The new value for the point will be displayed in the Status Bar.
Press Enter or click the object with the left mouse button to activate
the object for editing.
2.
3.
GFK-1180H
Press Enter or Tab to perform the setpoint. If you press Tab, the next
action object is automatically highlighted.
Using CimView
31-13
Toolbar to be displayed
To access the Options dialog box, select Toolbars... from the View menu.
Use the Toolbars properties to select the toolbar to be displayed in your CimView
window. You can also toggle the display of color buttons and ToolTips.
The Toolbars input box shows you the special toolbars available for CimView, and
lets you select the ones to display. Note that the only toolbar currently available is
the Standard toolbar.
The Color Buttons check box lets you enable or disable the display of toolbar
buttons in color.
The Show ToolTips check box lets you enable or disable the display of ToolTips
on the toolbars. When ToolTips are enabled and you move the cursor into a button
on the Toolbar, you will see the button name in a box next to the cursor, and a
description of the button in the Status Bar at the bottom of the window.
31-14
GFK-1180H
If the text was placed in a Help file generated by the Help compiler, it
will be displayed in a Help window on your screen.
Or you can:
1.
2.
Move the Help cursor to the screen background (that is, away from any
objects on the screen).
3.
Click the left mouse button. The help information for the screen will be
displayed. If there is no help information for the screen, a "No help
defined for this screen" dialog box is displayed.
Or you can:
GFK-1180H
1.
Move the cursor to the screen background (that is, away from any
objects on the screen).
2.
Click the right mouse button. The window pop-up menu will appear.
3.
Click Help in the pop-up menu. The help information for the screen
will be displayed. If Help is grayed out in the pop-up menu, there is no
help information for the screen.
Using CimView
31-15
2.
3.
Click the left mouse button. The help information for the object will be
displayed. If there is no help information for the object, a "No help
defined for this object" dialog box is displayed.
Or you can:
1.
2.
Click the right mouse button. The window pop-up menu will appear.
3.
Click Help in the pop-up menu. The help information for the object
will be displayed. If Help is grayed out in the pop-up menu, there is no
help available for the object.
Line and fill style, colors, and patterns for the screen.
The list of point defined for the screen and the objects associated with
them.
2.
When you are finished looking at the properties, click OK or Cancel to close the
dialog box and return to your screen.
31-16
GFK-1180H
Animation
Events
Help
You cannot define or modify object properties in CimView, but you can display
them. To display object properties:
1.
2.
3.
When you are finished looking at the properties, click OK or Cancel to close the
dialog box and return to your screen.
For example, if you want to display your CimView screens in a window without a
Menu Bar and Title Bar, the command line would look like this:
cimview.exe /nomenutitle c:\cimplicity\projects\proj\ini.cim
If multiple CimView screens are launched from a single command line and
command line options are used, the first screen in the list is the primary window. For
example, if /alwaysmaximized is used, the first screen in the list will be
maximized, and all other screens will be displayed in their normal windows.
The following command line options can be associated with a CimView icon:
/alwaysmaximized
Displays the primary CimView window in a maximized state. You will not be
allowed to resize the primary window. The window will not rise to the top when you
click on it (this prevents it from obscuring other windows on your terminal screen).
This option is only applied if it is used with the first CimView window opened. This
window is known as the primary window. If used with subsequent open commands,
it will be ignored.
GFK-1180H
Using CimView
31-17
Example:
cimview.exe /alwaysmaximized C:\myproj\scr.cim
/geometry <width>x<height><xoff><yoff>
Sizes and positions the CimView window when it opens. The screen is sized to fit
the window. All fields are in pixels.
The arguments for this command line option are:
<width> specifies the window width.
<height> specifies the window height.
<+xoff> specifies the offset from the left edge of the terminal screen and
<-xoff> specifies the offset from the right edge of the terminal screen.
<+yoff> specifies the offset from the top edge of the terminal screen and
<-yoff> specifies the offset from the bottom of the terminal screen.
Example:
cimview.exe /geometry 200x200+100+200 C:\myproj\scr.cim
opens the screen in a 200x200 window that is 100 pixels from the left side of the
terminal screen and 200 pixels from the top edge of the terminal screen
/keypad
Displays a keypad window on the users screen whenever the user has to perform a
Variable Setpoint action in a procedure. To enter a new setpoint value, the user
clicks on the appropriate keys in the keypad window rather than entering them from a
keyboard.
This option is only applied if it is used with the first CimView window opened. This
window is known as the primary window. If used with subsequent open commands,
it will be ignored.
Example
cimview.exe /keypad C:\myproj\scr.cim
/LoadScript
Enables a common script file to be shared among all screens loaded in CimView.
Functions that are included in this common file will be loaded when CimView is first
run, and will be callable as if they were included in the Basic code for the local
screen.
If the /LoadScript argument is specified for a file after CimView is already
running, its contents will be appended to the list of common functions with the lowest
precedence.
Example:
/LoadScript scriptFileName
where
scriptFileName is a file specification) to specify a common script file. (Multiple
/LoadScript options can be given on the command line.)
See the "Using CimEdit Scripts" chapter in the CIMPLICITY HMI CimEdit
Operation ManualGFK1396 for more information about /LoadScript.
31-18
GFK-1180H
/noexit
Will not let you exit the primary CimView window.
The Exit menu item is removed from the File menu, and the Close menu item and
its Alt+F4 shortcut key are removed from the Control menu. Close Screen actions
are ignored in the primary window.
This option is only applied if it is used with the first CimView window opened. This
window is known as the primary window. If used with subsequent open commands,
it will be ignored.
Example:
cimview.exe /noexit C:\myproj\scr.cim
/nomenutitle
Removes the Menu Bar and Title Bar from the primary CimView window and all
subsequent windows that you open.
This option is applied to the new windows and also any windows that are opened
from within CimView. If a later CimView command is executed without the
option, the option is disabled for those windows and any new windows opened from
within CimView.
Example:
cimview.exe /nomenutitle C:\myproj\scr.cim
/noPointTargets
Prevents the point targets, e.g. Point Control Panel and quick trends, from being
available from Point View or the right mouse menu.
/noopen
Lets you open only the CimView screens that are explicitly mentioned in Open
Screen and Overlay Screen actions. Open Screen and Overlay Screen actions that do
not specify a screen are ignored.
In addition, the Open and Open Window menu items and the file list are removed
from the File menu, and the File Open Toolbar button is disabled.
This option is applied to the new windows and also any windows that are opened
from within CimView. If a later CimView command is executed without the
option, the option is disabled for those windows and any new windows opened from
within CimView.
Example:
cimview.exe /noopen C:\myproj\scr.cim
/noresize
Prevents you from resizing any CimView windows that you display.
This option is applied to the new windows and also any windows that are opened
from within CimView. If a later CimView command is executed without the
option, the option is disabled for those windows and any new windows opened from
within CimView.
Example:
cimview.exe /noresize C:\myproj\scr.cim
GFK-1180H
Using CimView
31-19
/project <name>
Sets the base project to <name>.
The data for all unqualified points on the windows that you display will be requested
from the named project.
This option is applied to the new windows and also to any windows that are opened
from within CimView. If a later CimView command is executed without the
option, the previous value for the default project continues to be used.
Example:
cimview.exe /project myproj C:\myproj\scr.cim
/wait [<time>]
Makes CimView wait for the Router to start before opening the screen. Note that
CimView does not try to start the Router. The Router must be started by another
method. Typically this option is used when configuring CimView to start at boot or
when the user logs in to Windows.
You can specify a time, in seconds, to wait. The screen opens at the end of the time,
regardless of the state of the router. If you do not specify a time, CimView waits
forever.
Example:
cimview.exe /wait 60 C:\myproj\scr.cim
/waitforproject <name>
Makes CimView wait for the project to start before opening the window
Example:
cimview.exe /waitforproject myproj C:\myproj
\scr.cim
/zoomtobestfit
Initially places the primary CimView window in Zoom To Best Fit mode. All
subsequent windows are also displayed in this mode.
This option is applied to the new windows and also any windows that are opened
from within CimView.
Example:
cimview.exe /zoomtobestfit C:\myproj\scr.cim
31-20
GFK-1180H
GFK-1180H
Using CimView
31-21
View the current point values for points in any project in your
enterprise.
Getting Started
To open the Point Control Panel:
1.
2.
Double click Point Control Panel in the left pane or right pane
(when the Point Control Panel is selected in the left pane).
The Point Control Panel opens.
GFK-1180H
32-1
To display a new, empty list, select New from the File menu.
To display a saved Point Control Panel document, select Open from the File menu,
or, if the document is in the list of recent files, just click on the file name in the list.
To print the current state of the Point Control Panel, select Print from the File
menu. If you want to see what your printout will look like, select Print Preview. If
you need to change the printer, paper type or page orientation, select Print Setup.
Point Control Panel
documents are saved with the
extension .PPL
To save a Point Control Panel document, select Save from the File menu. When
the Save As dialog box opens, enter a file name for the file and select OK. By
default, Point Control Panel documents are placed in the main CIMPLICITY HMI
directory, but you can select another directory.
To exit the Point Control Panel, select Exit from the File menu.
To add points to the list, select Add from the Edit menu.
To display the properties of a point, select it, then select Properties from the Edit
menu.
To delete a point from the list, select it and press Delete or select Delete from the
Edit menu.
To change the font colors for point alarming, select Colors from the Font menu.
You may see the following icons displayed next to points in the Point Control Panel:
This icon is displayed if the point is not valid.
This icon is displayed after you successfully disable alarming for a point.
This icon is displayed after you change the current alarms limits for a point.
Displaying Points
When you select Add from the Edit menu or press Ctrl+A, the Select a Point
browser opens.
Select the project from which you want to display points. To request a list of all
points, just select Browse. To refine the list, you can enter search strings for Point
ID, Device ID, Resource, Point Type or Description, then select Browse.
When the list of points displays in the list box, select the ones you want to display,
then select OK.
The Select a Point browser closes and the Point Control Panel redisplays with the
points you selected. All the points you requested are automatically selected in the
Point Control Panel so that you can just look at them, and then delete them from the
view if you wish.
The current value, units and timestamp for each point are displayed in the Point
Control Panel. If a point is in an alarm condition, its text is displayed in the
appropriate color.
You can display point properties for each point in the list. You can also perform a
setpoint, enable/disable alarming and set new alarm limits for each point in the list.
32-2
GFK-1180H
Select the point, then select Properties from the Edit menu.
The Point Properties dialog box opens. Use this dialog box to view point details and
alarm information. You can also perform a setpoint, enable/disable alarming and set
new alarm limits.
Note
If the point has no alarming or has On update alarming, the Alarm property page
does not appear in the dialog box.
Details
This property page shows you the Point Type and Resource for the point, its access,
display limits, current value and units and password.
Use this property page to perform a setpoint on the points value. To do this, enter
the new value in the Set Value field and select Apply or OK. If you select Apply,
the dialog remains open. If you select OK, the dialog closes. In either case, the
Point Control Panel is updated to reflect your changes.
GFK-1180H
32-3
Alarm
The contents of this property page depend on whether you are viewing an Analog or
Boolean point type.
For Analog point types, this property page shows you whether alarming
is enabled for the point and the configured and current alarm and
warning limits.
For Boolean point types, this property page shows you whether
alarming is enabled for this point and the configured alarm state.
Use the Alarm Enabled field to enable or disable alarming for the point. If you
disable alarming, the Disabled icon - - displays next to the point in the Point
Control Panel main window. If the point is already in an Alarm state and you disable
it, the state is reset to Normal. If you enable alarming for a point that is already in an
Alarm state, the alarm is generated.
Use the Current fields in the Alarm Limits section to change alarm limits. If you
change alarm limits, the Modified icon - - displays next to the point in the Point
Control Panel main window.
After you change alarm information on this page, you can select Apply or OK to
have the changes take place. If you select Apply, the dialog box remains open. If
you select OK, the dialog box closes. In either case, the Point Control Panel updates
to reflect your changes.
To return to configured alarm limits, select Restore Alarm Limits.
32-4
GFK-1180H
2.
3.
4.
Enter a new value for the point in the Set Value field.
The point will continue to funciton in the CIMPLICITY HMI using the set value.
GFK-1180H
32-5
2.
3.
You can set the foreground (text) and background colors for the following states:
Normal
Warning
Alarm
To change a color, click the drop-down list button to the right of the color you want
to change. When the palette opens, select the basic color or custom color you want,
and then select OK.
After you have defined your display colors, select OK to close the Font Color dialog
box closes and redisplay the Point Control Panel in the colors you have selected.
Select Cancel to close the dialog box without making any changes.
32-6
GFK-1180H
Enter the file name you want in the File name field, then select the full path name
for the document. Select Save to save the document. The document is saved in the
directory you specify.
You can then select the document and create a shortcut for it on your desktop or in a
start menu.
GFK-1180H
32-7
The topics supported are POINT and SYSTEM. Use the Point topic to
display CIMPLICITY point information. Use the System topic to
display CWSERV system information.
The items supported for the POINT topic correspond to various point
attributes such as value, alarm limits, and point state.
The format of a particular DDE command depends on how it has been implemented
in the application where you are using it.
GFK-1180H
33-1
where:
<point_id>
<attribute>
n:m
This syntax will display the current state of the point "ANALOG_POINT":
=cwserv|point!analog_point.state
This syntax will display the sixth through tenth values of the array point
"ARRAY_POINT" in a row:
=cwserv|point!array_point.value[5:9R]
This syntax will display the value of the point "ANALOG_POINT" in the "TEST"
project:
=cwserv|point!\\test\analog_point.value
33-2
GFK-1180H
VALUE
RAW_VALUE
STATE
TYPE
LENGTH
ELEMENTS
SIZE
DISP_FORMAT
EU_LABEL
ALARM_HIGH
ALARM_LOW
WARN_HIGH
WARN_LOW
DISP_HIGH
DISP_LOW
INIT_STATE
ALARM_ENABLED
WARN_ENABLED
VALUE
Displays the converted (EU) value of the point. If there is no conversion, the raw
value is displayed. If you do not enter an attribute in the CWSERV command, this is
the default attribute that is displayed.
RAW_VALUE
Displays the raw value of the point.
STATE
Displays the current state of the point.
The points current state depends on its point class and alarm conditions.
For all point classes, the states that can be displayed are:
NORMAL
UNAVAILABLE
For Analog and APPL point classes, the additional states that can be displayed are:
GFK-1180H
ALARM HIGH
ALARM LOW
WARNING HIGH
33-3
WARNING LOW
The points value is less than the warning low limit and
greater than the alarm low limit.
OUT OF RANGE
For the Digital (Boolean) point class, the additional states that can be displayed are:
ALARM
WARNING
You will only see this message if Enable Alarms has been
reset, Enable Warning is set, and the points value is in the
alarm state.
TYPE
Displays the points type. You will see one of the following:
BOOLEAN
BITSTRING
OCTETSTRING
CHARACTERSTRING
UNSIGNED INTEGER 1
UNSIGNED INTEGER 2
UNSIGNED INTEGER 4
INTEGER 1
INTEGER 2
INTEGER 4
FLOATING POINT
STRUCTURE
Note
LENGTH
Displays the length of the point. This field is only meaningful for the following point
types:
BITSTRING
OCTETSTRING
ELEMENTS
Displays the number of elements contained in the point.
SIZE
Displays the size of the data.
DISP_FORMAT
Displays the format used when displaying the points value in Alarm Viewer, Status
Log messages, or CimView.
33-4
GFK-1180H
EU_LABEL
Displays the engineering units label for the point. The label can be up to eight (8)
characters long.
ALARM_HIGH
Displays the Alarm High value for the point. This field is only valid for the
following point types:
ANALOG
APPL
If the points value exceeds this number, the point is in ALARM HIGH state.
ALARM_LOW
Displays the Alarm Low value for the point. This field is only valid for the
following point types:
ANALOG
APPL
If the points value is less than this number, the point is in ALARM LOW state.
WARN_HIGH
Displays the Warning High value for the point. This field is only valid for the
following point types:
ANALOG
APPL
If the points value is greater than this number, but less than the Alarm High
number, the point is in WARNING HIGH state.
WARN_LOW
Displays the Warning Low value for the point. This field is only valid for the
following point types:
ANALOG
APPL
If the points value is less than this number, but greater than the Alarm Low number,
the point is in WARNING LOW state.
DISP_HIGH
Displays the high limit for the display value for this point. This field is only valid for
the following point types:
ANALOG
APPL
DISP_LOW
Displays the low limit for the display value for this point. This field is only valid for
the following point types:
GFK-1180H
ANALOG
APPL
33-5
INIT_STATE
Indicates whether the point is enabled or disabled. You will see one of the following
values:
0
ALARM_ENABLED
Indicates whether high/low alarms are enabled or disabled for this point. You will
see one of the following values:
0
WARN_ENABLED
Indicates whether high/low warnings are enabled or disabled for this point.
0
Select the cell where you want the point information to appear.
2.
For example, to display the raw value for the point CWSERV_VIRT, you would
type:
=cwserv|point!cwserv_virt.raw_value
Select a range of cells (horizontal or vertical) where you want the point
information to appear.
2.
Enter the CWSERV formula, and enclose the point information within
single quotes, then press Ctrl+Shift+Enter.
For example, to display the raw values for the ten-item array CWSERV_ARRAY in a
column on your spreadsheet, you would type
=cwserv|point!cwserv_array.raw_value[0:9c]
33-6
GFK-1180H
Starting CWSERV
The first time you enter point information into a spreadsheet, the following dialog
box will be displayed:
This dialog box will also be displayed if you open a spreadsheet that contains
CWSERV commands and the CWSERV server is not active.
Click Yes to start CWSERV.
This dialog box will appear every time you open the spreadsheet:
Click Yes to reconnect to CWSERV to access data. If CWSERV is not running, you
will be asked if you want to start it. Click Yes to start CWSERV.
If you are connecting to the project for the first time, or your login timeout has
expired, the CIMPLICITY Login dialog box for the project is displayed.
Enter your CIMPLICITY username and password and click OK. Your spreadsheet
will now start to display the CIMPLICITY data you requested in the CWSERV
commands.
CWSERV Icon
While the server is active, you will see this icon on your terminal screen:
GFK-1180H
33-7
Macro Format
The format for a Microsoft Excel macro that performs a setpoint is:
This command will take the values in rows 4 through 13 of column 4 of the
spreadsheet and use them to set the first 10 values in the CWSERV_ARRAY point.
Performance Considerations
When you perform a large number of DDE POKE requests from an application such
as Microsoft Excel, the DDE server application may fall behind. Under Excel, this
will cause some requests to timeout and fail.
33-8
GFK-1180H
Implementing A Macro
You will need to do the following to implement a macro that performs a setpoint and
assign it to a button:
1.
2.
If you have not already done so, select Toolbars from the View menu
and activate the Drawing toolbar.
3.
4.
Select Record New Macro from the Record Macro submenu. The
Record New Macro dialog box will open.
5.
Enter your new macro name in the Macro Name input box.
6.
Click Options.
7.
8.
9.
Click OK. A new Macro sheet will be created and the macro name will
be placed in the first cell (R1C1) of the sheet.
GFK-1180H
33-9
33-10
R5C3
=cwserv|point!cwserv_virt.value
R6C3
=cwserv|point!cwserv_virt.state
R7C3
=cwserv|point!cwserv_virt.disp_format
R8C3
=cwserv|point!cwserv_virt.eu_label
R9C3
=cwserv|point!cwserv_virt.alarm_high
R10C3
=cwserv|point!cwserv_virt.warn_high
R11C3
=cwserv|point!cwserv_virt.warn_low
R12C3
=cwserv|point!cwserv_virt.alarm_low
R13C3
=cwserv|point!cwserv_virt.disp_high
R14C3
=cwserv|point!cwserv_virt.disp_low
R15C3
=cwserv|point!cwserv_virt.alarm_enabled
R16C3
=cwserv|point!cwserv_virt.warn_enabled
R17C3
=cwserv|point!cwserv_virt.init_state
GFK-1180H
The following macro is the one associated with the Set button above.
set_point
channel=INITIATE("cwserv","point")
=POKE(channel,"cwserv_virt.value",Sheet1!R19C3)
=TERMINATE(channel)
=RETURN()
To change the setpoint, enter the new point value in cell R19C3, then click Set.
To create the display, cells R5C3 through R14C3 were selected, and the following
formula was entered:
=cwserv|point!cwserv_array.raw_value[0:9c]
To change the setpoint, enter the new values in R5C4 through R14C4, and click Set.
GFK-1180H
33-11
Formats
CWSERV currently supports the CF_TEXT format.
To display format information on a Microsoft Excel spreadsheet:
1.
2.
System Items
CWSERV currently supports four system items - Formats, Help, SysItems, and
Topics.
To display system item information on a Microsoft Excel spreadsheet:
1.
2.
Topics
CWSERV currently supports two topics - Point and System.
To display topic information on a Microsoft Excel spreadsheet:
1.
2.
33-12
GFK-1180H
Help
You can display descriptive information about CWSERV. This information tells you
how to display information, and lists the System and Point topic attributes.
To display information about CWSERV on a Microsoft Excel spreadsheet:
1.
2.
GFK-1180H
33-13
Error Messages
If the VALUE or RAW_VALUE field displays "******", there is a problem reading
the point data from the device.
If a field displays "#N/A", the attribute you requested does not contain a value.
If a field displays "#NAME?", you can have one of several problems; for example:
CWSERV does not support the point type for value displays.
When you see a "#NAME?" error in a field, check your projects Status Log file for
detailed information on the cause of the problem.
33-14
2.
When the DDE Share window opens, select DDE Shares from the
Shares menu.
3.
4.
5.
6.
7.
8.
9.
Select OK.
GFK-1180H
\\nodeName\NDDE$
CWSERV$
GFK-1180H
33-15
System Utilities
Show Users
Login Panel
Program Control
Use Show Users to see what users are logged on to the various CIMPLICITY HMI
projects running on your network.
Use Login Panel to log in and out of CIMPLICITY HMI projects on the computer
and monitor saved logins.
Use Program Control to view, start, and stop processes for a project.
GFK-1180H
34-1
34-2
Access Help.
GFK-1180H
Project Menu
View Menu
Help Menu
Recent Project
Displays the list of recently opened projects and lets you select one.
Exit
GFK-1180H
Toolbar
Status Bar
Options...
System Utilities
34-3
Opens the Contents page for the Show Users help file.
Opens the Index page for the Show Users help file.
Opens the Contents page for the Show Users help file.
About ShowUser...
34-4
Search
Next
Displays the next line of user information that meets the search
criteria.
Previous
GFK-1180H
Tile Horizontally
Tile Vertically
Arrange Icons
Close All
Open Projects
GFK-1180H
Open
Opens a project.
Close
Search
Search Next
Search Previous
Tile Windows
Tile Windows
Cascade Windows
Cascades windows.
System Utilities
34-5
Opens a project.
Ctrl+S
Ctrl+N
Finds the next entry that matches the criteria in the Search
dialog box.
Ctrl+P
Alt+Print Screen
F1
Shift+F1
Alt+F4
Ctrl+Esc
If you set the On user login check box, a sound plays whenever a
user logs in to any CIMPLICITY project that you are viewing.
If you clear the check box, no sound plays when users log in to
CIMPLICITY projects that you are viewing.
If you set the On user logout check box, a sound plays whenever a
users logs out of any CIMPLICITY project that you are viewing.
If you clear the check box, no sound plays when users log out of
CIMPLICITY projects that you are viewing.
When you are through selecting the options you want, select OK to close the dialog
box and save your changes, or select Cancel to close the dialog box without
implementing any changes.
34-6
GFK-1180H
Press Ctrl+O.
When the Open dialog box opens, it displays a list of currently running projects that
are broadcasting.
Enter a project name in the Project field, a node name in the Node
field, and then select Open.
After you select the project, the Open dialog box closes, and you are prompted to log
in to the project.
GFK-1180H
System Utilities
34-7
After you have logged in to the project, a subwindow for the project is displayed in
the Show Users window. The title bar for the subwindow displays the Project name
and node name of the computer on which the project is running.
The subwindow for the project displays the User ID, Role, Node and Process ID of
every CIMPLICITY user that is logged in to that project. The information in the
subwindow updates as users log in and out of the project.
Press Ctrl+S.
The Search dialog box opens with the current search criteria.
34-8
GFK-1180H
User ID
Role
Node
Process
You can use the drop-down list buttons to the right of each field to display and select
previous search filters.
Select Close to close the dialog box and do no further searching.
Select Find to find the first user in the currently active subwindow that matches the
search criteria.
Select Next or press Ctrl+N to find the next user in the currently active subwindow
that matches the search criteria.
Select Previous or press Ctrl+P to find the previous user in the currently active
subwindow that matches the search criteria.
GFK-1180H
System Utilities
34-9
These actions do not require that you exit from any applications that are currently
running. For example, if you are a supervisor, you can now override the login and
privileges of an operator, log out, and return the system back to the operators logged
in state.
When you log out of a project, data collection and background processing continues.
However, any open CIMPLICITY HMI screens will no longer show point status.
For each project that users are logged into on this computer, the Node ID for the
project, Project ID, user name, login status, and type are displayed.
From this window, you can:
34-10
GFK-1180H
File
Project
View
Help
GFK-1180H
Login
Logout
Change Password
System Utilities
34-11
Status Bar
About LoginPanel
Logout
About
Shift+F1
Alt+F4
Ctrl+Esc
34-12
GFK-1180H
Select the project from the list of projects (its status must be "Logged
in").
2.
Select Logout from the Project menu or click the Logout button - on the Toolbar.
CIMPLICITY HMI software logs out the project. All CimView screens that have
animation objects that use points from this project will disable the objects.
Logging in to a Project
To log in to a project:
1.
Select the project from the list of projects (its status must be "Logged
out").
2.
Select Login from the Project menu or click the Login button - on the Toolbar. The CIMPLICITY Login dialog box opens.
3.
Enter the Username and Password for the user you want to be when
viewing screens for the project.
CIMPLICITY HMI software logs you in to the project as the user you designate. All
CimView screens connected to this project will now have their animation objects
enabled.
Note
The screen itself may change if visibility animation has been enabled for objects and
keyed to User ID and Role ID information.
GFK-1180H
System Utilities
34-13
Changing Password
Note
In a Server Redundancy configuration, changing the password is only supported
when the Primary computer is on line.
To change your CIMPLICITY Users Password for a project:
1.
Select the project from the list of projects (its status must be "Logged
in").
2.
The dialog box displays the current project and your User ID.
To change the password:
34-14
1.
Enter the current password in the Old password field. As you type,
asterisks will display.
2.
Enter the new password in the New Password field. As you type,
asterisks will display.
3.
Enter the new password again in the Confirm field. As you type,
asterisks will display.
4.
GFK-1180H
When you are through with this dialog box, select Close to close it and return to the
Login Panel window.
2.
Select the project you want to apply the login to in the Project field.
Use the drop-down list button to display the list of available projects in
your enterprise.
3.
4.
5.
Select OK to activate the new saved login, or select Cancel to exit this
dialog box without saving the information you entered.
After you activate the new saved login, whenever you open a screen in this project,
you are automatically logged in to the project.
GFK-1180H
System Utilities
34-15
2.
Select Remove.
34-16
GFK-1180H
You can use the Browse button to search for a project to start. Once you have
selected a project, you can:
When you start the project, the normal startup dialogs are displayed.
You can also select Cancel to close the dialog box without starting a project. When
the dialog box closes, the Program Control process terminates.
GFK-1180H
System Utilities
34-17
To connect to a project:
1.
Click the drop-down list button to the right of the System input field.
A list of currently running projects that are broadcasting is displayed.
2.
3.
Select Connect.
4.
If you are not currently logged in to the project, you are prompted for a
Username and Password.
The CIMPLICITY Program Control window redisplays with the list of process names
and statuses for the project you selected.
34-18
GFK-1180H
Exit CPC.
Important
GFK-1180H
System Utilities
34-19
DA_RC
DA_RP
DL_RP
DYNCFG
EM_EP
EM_RP
<node>_<port>
<node>_<printer_name>
<node>_PTDP_RP
<node>_PTM<n>_RP
PDC_DS
PRT_DC
PRT_DS
PRT_GRD
PTDL_RP
PTX_RP
UR_RP
2.
3.
When the cpc dialog box opens, select Yes to confirm that you want
this process to start.
If the process starts successfully, its status in the process list changes from "Halted"
to "Running".
34-20
GFK-1180H
2.
3.
When the cpc dialog box opens, select Yes to confirm that you want
this process to stop.
If the process stops successfully, its status in the process list changes from "Running"
to "Halted".
2.
When the cpc dialog box opens, select Yes to confirm that you want all
processes to start.
If the processes start successfully, their status in the process list changes from
"Halted" to "Running".
GFK-1180H
System Utilities
34-21
2.
When the following dialog box opens, select Yes to confirm that you
want all processes to stop.
If the processes halt successfully, their status in the process list changes from
"Running" to "Halted".
2.
3.
Select Connect.
34-22
GFK-1180H
When a project has several points that need to be converted and that
have the same equivalents, you can use Measurement Units to specify
the conversion in one place, at one time, for all the involved points.
GFK-1180H
35-1
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.
35-2
Add a new measurement system (if the one you want does not exist).
Select the correct Base Unit ID for each point in Point Configuration.
GFK-1180H
The left pane displays the current list of base measurement units.
The right pane displays unit equivalent details for the particular
measurement system you are working with. You will see a tab in this
pane for each measurement system configured for this project.
GFK-1180H
35-3
2.
1.
2.
3.
Check the Use at runtime check box if you want this measurement
system to be the active system when the project starts.
4.
Click Enter.
The tab for the new measurement system is added in the right pane.
If Unit IDs exist in the left pane, you will see default values in the Equivalent
Unit ID, Forward Equation, Reverse Equation, Justification and Type
fields.
35-4
GFK-1180H
Move the cursor to the tab of the measurement system you want to
copy.
2.
3.
4.
5.
Click OK.
A new measurement system tab will be created with the name you specified.
If there are existing Unit IDs in the left pane, you will see default values in the
Equivalent Unit ID, Forward Equation, Reverse Equation, Justification
and Type fields for the new measurement system.
Move the cursor to the tab of the measurement system you want to
rename.
2.
3.
4.
5.
Click OK
The measurement system tab will change to the name you specify.
GFK-1180H
35-5
Press Ctrl+N.
In the left pane, click the right mouse button and select New
from the pop-up menu.
2.
Enter the name of your base unit in the Unit ID field and click OK.
The Measurement Unit Properties dialog box opens.
1.
2.
3.
Click Enter.
The new base Unit ID is added to the end of the list in the left pane. Equivalent
entries are also made in each system you currently have in the right pane.
If you currently have measurement systems defined in the right pane, default values
for the new base unit are automatically entered in the Equivalent Unit ID,
Forward Equation, Reverse Equation, Justification and Type fields for all
the measurement systems.
35-6
GFK-1180H
2.
Click twice.
Press Ctrl+P.
In the left pane, select the base unit, click the right mouse button and
select Properties from the pop-up menu.
Click twice in any field in the right pane to edit the field
Press Ctrl+E.
In the right pane, select the equivalent unit, click the right mouse button
and select Equivalence from the pop-up menu.
You can edit any of the following fields in the right pane or in the dialog box:
GFK-1180H
35-7
Equivalent Unit ID
Enter the Unit ID you want to use when the measurement system is active. The Unit
ID may or may not match any other Unit IDs in the configuration.
Forward Equation
Enter the equation to be used by Point Management to convert the base value to its
equivalent in this measurement system.
For example, if point XYZs base value is in inches and you want to display it in
centimeters, use the forward expression %P*2.54001.
If the points base value is the same as its converted value, just put %P in the field.
Reverse Equation
Enter the equation to be used by Point Management to convert the equivalent in this
measurement system to its base value.
For example, if point XYZs base value is in inches and its equivalent value is in
centimeters, use the reverse expression %P/2.54001.
If the points base value is the same as its converted value, just put %P in the field.
Justification
This field is used to align the display of point value.
By default, the project uses the justification you specify when you configure a point.
Select the justification you want to use when displaying the points value on
CimView screens when this measurement system is active, as long as the
Configured option is selected for the CimView object display properties. You can
select one of the following:
Left
Right
Zero
Width
This field represents the number of spaces you want to dedicate to the display of the
point value.
By default, the project uses the display width you specify when you configure a
point.
If you want to use a different display width for all points that use this Unit ID, enter
it in this field.
Precision
This field represents the number of digits to be displayed to the right of the decimal
point.
By default, the project uses the precision you specify when you configure a point.
If you want to use a different precision for all points that use this Unit ID, enter it in
this field.
35-8
GFK-1180H
Type
This field determines the format type used when the point value is displayed.
By default, the project uses the display type you specify when you configure a point.
If you want to use a different display for all points that use this Unit ID, enter it in
this field. Use the drop-down list button to select one of the following:
Fixed
All points that use the Unit ID are displayed in fixed format
using the Width and Precision information you specify. If
you do not specify the Precision, the default is 6.
For example, if you specify a Width of 7 and Precision of 3,
the point display uses 7 places and there are 3 places after the
decimal point. In this case, 10 displays as 10.000.
Scientific All points that use the Unit ID are displayed in scientific
format using the Width and Precision information you
specify. If you do not specify the precision, the default is 6.
Compact
2.
3.
4.
Enter the name of the new measurement unit in the Destination field.
5.
Click OK.
The Measurement Unit Properties dialog box opens.
6.
7.
GFK-1180H
Click OK.
35-9
A new measurement unit will be created with the name you specified.
Equivalent measurement units are also created for each measurement system in the
right pane.
Click the measurement unit in the left pane that you want to rename.
2.
3.
4.
Enter the new name of the measurement unit in the Destination field.
5.
Click OK
The measurement unit name in the left pane will change to the name you specify.
2.
Select Options.
The Options dialog box opens.
3.
4.
Click OK.
Click the measurement unit in the left pane that you want to delete.
2.
3.
35-10
GFK-1180H
4.
Click Yes.
2.
3.
Click OK.
When the project starts, this will be the active measurement system.
GFK-1180H
35-11
2.
3.
4.
35-12
Click OK.
GFK-1180H
Derived Points
CimView Scripts
GFK-1180H
An integer, in order to fit the reverse converted value into the integer
specification, the conversion process rounds off the floating value that
was the result of the reverse conversion to the nearest integer.
A floating point, it will be able to hold the floating value that was the
result of the reverse conversion.
35-13
When the point is displayed, the value is forward converted from the base
measurement unit into the active measurement unit. If the point is:
An integer, the forward conversion will use the rounded value in its
calculations. The displayed value will reflect that rounding.
A floating point will hold the floating value that was the result of the
reverse conversion. The displayed value will equal the value at which
you set the point.
In many cases, the rounding effect is totally acceptable. When it is not, use floatingpoint types.
Guideline
For points that need to have the highest level of precision and use Measurement
Units conversion, use the floating point type instead of the integer point type.
Example
Point XYZ is a point with a base unit ID of inches that requires the highest level of
precision. Its initial value is 10 inches.
You use Metric as the active measurement system. As a result, XYZs value displays
as centimeters.
You want to perform a setpoint on XYZ.
Dont
Define XYZ as an integer.
If you then perform a setpoint on XYZ and set it to 26.924 cm.:
Do
Define XYZ as a floating-point type.
When you then perform a setpoint on XYZ and set it to 26.924 cm., the internal
conversion is able to store 10.6 inches. As a result, the point, which is the same value
it was set to, displays as 26.924 cm.
35-14
GFK-1180H
Derived Points
By default, when a derived point expression uses a device point, it uses the raw
(unconverted) value of the device point.
When a derived point value is calculated:
1.
2.
The base units for all points in the expression are used.
3.
Guideline
Assign a base Unit ID for a derived point that is consistent with the base Unit IDs of
the points in its expression and use constants that are consistent with the base Unit
ID for the derived point.
If you are using Measurement Units and want your derived points to be calculated
correctly, you need to use the Engineering Units (EU) value for device points in your
derived point expressions. You can do this in one of two ways:
Use the EU_CONV function for every device point you use in a
derived point expression to convert the device points to their EU
values.
Example
SOURCE is a device point with a Base Unit ID of inches.
DEST is a derived point with an expression: SOURCE+10.0 (inches).
The value of SOURCE is 1 inch.
You will use Measurement Units conversion to convert the project from inches to
centimeters.
Dont
In either case you are creating an inconsistent condition which may produce
confusing results after conversion.
Do
Assign DEST a base measurement unit of inches in the Point Properties box
Conversion tab.
The expression, SOURCE+10.0, will be calculated as 1 inch +10 (inches) = 11
inches
Because DEST has a base measurement unit of inches, it will be included in the
Measurement Unit conversion and will display as 27.94 centimeters.
GFK-1180H
35-15
Color animation
Movement
Rotation/fill
Scaling
Objects configured for each of these capabilities will take expressions, including
minimum and maximum values. However, when you need to do a conversion, it is
important to take into account how CimView deals with an expressions
minimum/maximum values and their related high/low values.
When CimView processes an objects animation expression, it first looks for
minimum and maximum values specified within the object properties. If it finds
them, it uses them. Because these values are attached to the object, not a point with a
measurement unit, CimView uses the values as entered, independent of the
measurement unit.
Second, if the minimum and maximum fields in the objects Properties dialog box are
blank and the animation expression is a single Point ID, CimView looks for Display
low and Display high values configured in the View tab of the Point Configuration
Properties box. If the Display low and Display high fields:
For more information on display limits see the following chapters in the
CIMPLICITY HMI CimEdit Operation manual:
For more information on display limits see the following chapters in the
CIMPLICITY HMI CimEdit Operation manual:
35-16
GFK-1180H
Guidelines
If you want to guarantee that your animation will properly adjust to measurement
system changes at runtime, make sure that for every animation expression using a
single point ID in your CimView screens, the:
Display low and Display high fields are filled, in the View tab of the
Point Properties dialog box.
Example
Using the U.S. Customary system as the active measurement system, you want to
move an object from a lowest value (0 inches) on the left of the screen to a highest
value (100 inches) on the right of the screen, as the points value changes.
You then change the active measurement system from U.S. Customary to Metric. As
a result, the measurement units are converted from inches to centimeters
Dont
Specify 0 (inches) as the expression minimum value and 100 (inches) as the
expression maximum value in the objects configuration window.
If the point in the animation expression has a base value of 8 inches (displayed as
27.32 cm.), it will cause CimView to incorrectly place the animated object within
the 0-100 limits because it thinks the 0-100 limits are centimeters. Because the range
is incorrect, CimView will display the value too far to the right. (The range should
be 0-254 cm.)
Do
Leave the objects fields blank and enter 0 in the points Display low, 100 in its
Display high field in Point Configuration.
If the point in the animation expression has a value of 8 inches (displayed as 27.32
cm.), CimView will properly place the animated object within the limits, because
they are converted to centimeters. (0-100 is now 0-254.)
CimView Scripts
CimView uses Basic scripts, which can, among many other things, use the runtime
value of a point.
When you use point values within scripts, the values correspond to the active
measurement system. Therefore, if you compare or manipulate values with other
values that are constant, you will most likely run into trouble if you switch active
measurement systems. This is because your constant numbers will stay the same, but
the point values will most likely change due to unit equivalence.
Guidelines
You have to take into consideration that the point values will vary depending on the
active measurement system. Therefore, make sure that values in the script are all
relative; conversely, that there are no absolute values in the script.
GFK-1180H
35-17
Guidelines
When you specify point values in the Event Editor, enter them for the base
measurement unit. The actions you specify will occur when the point value for the
event, such as Point Equals, is reached.
Dont change anything in the Event Manager configuration if you are changing the
active measurement system.
Example
You have a point called WaterLevel and you have an action that gets triggered when
the level reaches 100 inches. Your base unit is inches and the project is converted to
centimeters.
Do
Dont do anything.
When you use the Metric system as the active measurement system, the event will
not get triggered until the level hits 254 centimeters, which is equivalent to 100
inches. The Event Manager internally sees the value as 100 inches and triggers the
event properly.
35-18
GFK-1180H
System Management
Global Parameters
The Global Parameters file is used to define parameters for the CIMPLICITY Base
System and options that override default parameters in the software.
Some global parameters can be changed through user interfaces in CIMPLICITY
HMI Configuration functions. You should not change these parameters manually.
Some global parameters can only be implemented or changed by editing the Global
Parameters file.
Of the global parameters that you implement manually, some are implemented for all
projects on the computer, and some are implemented for individual projects.
GFK-1180H
36-1
2.
Find the parameter you want to change, and make the change.
3.
4.
5.
6.
When you are ready to implement the change in the run-time system, you will have to
stop the project(s), perform a Configuration Update, and restart the project(s).
Note: the Global Parameters file that is used on a Viewer is located in the
CIMPLICITY installation directory in a subdirectory called data (e.g.,
c:\cimplicity\hni\data).
RTR_ACCEPT_CONN
DBDL_DEVICE_CHECK_PERIOD
RTR_DISABLE_BCAST
DOWNLD_PASSWD
RTR_STANDALONE
GMR_HRTBT_TIMER
SETPOINT_SECURITY
GMR_MODE_ADDR
STARTUP_TIMEOUT
PTDL_QUANTIZATION
SYSNAME
DBDL_DEVICE_CHECK_PERIOD
Use the Disk full scan rate (min) parameter in the Logging Properties dialog box
in Database Logging to change this parameter.
36-2
GFK-1180H
DB_QUEUE_SIZE
Use the Database queue size parameter in the Logging Properties dialog box in
Database Logging to change this parameter.
DOWNLD_PASSWD
Use the Set Point Password input area of the Point Properties dialog box in Point
Configuration to change this parameter.
DT_UPD_INTERVAL
Sets the interval in seconds to update a Projects Date & Time system points.
Record format is:
DT_UPD_INTERVAL|3|<seconds>
FIRST_WEEK_DAYS
Sets the minimum number of days in a week in the current year required to qualify
for the first week of the year.
Record format is:
FIRST_WEEK_DAYS|3|<days>
If you do not configure this parameter, the default number of days is 1.
GMR_HRTBT_TIMER
Use the Heartbeat Timer field of the TCP/IP Port Properties for a redundant Series
90 TCP/IP port.
GMR_MODE_ADDR
Use the Mode Address field of the TCP/IP Port Properties for a redundant Series
90 TCP/IP port.
PTDL_QUANTIZATION
Use the Point data logging scan rate input area of the Logging Properties dialog
box in Database Logger to change this parameter.
RTR_ACCEPT_CONN
Use the Accept Connections field of the CIMPLICITY Options dialog in the
CIMPLICITY program group to change this parameter.
RTR_DISABLE_BCAST
Use the Enable Project Broadcast field of the Project Properties dialog box in
the Workbench to change this parameter.
GFK-1180H
System Management
36-3
RTR_STANDALONE
Use the Stand Alone field of the CIMPLICITY Options dialog in the CIMPLICITY
program group to change this parameter.
SETPOINT_SECURITY
Use the Set Point Security field of the Point Properties dialog box in Point
Configuration to change this parameter.
STARTUP_TIMEOUT
Sets the number of minutes to wait before timing out when starting up a project.
Record format is:
STARTUP_TIMEOUT|3|<minutes>
SYSNAME
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
The parameter contains the project name.
Record format is:
SYSNAME|1|<project_name>
36-4
GFK-1180H
IPC_QUEUE_SIZE
CONNECT_RETRY_PERIOD
REDUND_LINK_SLEEP
IPC_BCAST_INTERVAL
RTR_MAX_OUTMESSAGE_COUNT
CONNECT_DROP_PERIOD
The time in seconds before an inactive login connection is dropped by the project.
The time starts when all CIMPLICITY application windows have been exited. A
user who opens a CIMPLICITY application window during this time period will not
be required to log in to CIMPLICITY software again.
Record format is:
CONNECT_DROP_PERIOD|3|<period>
The default time in the distributed Global Parameters file is 600 seconds (10
minutes).
CONNECT_RETRY_PERIOD
Time in seconds to retry connection to a remote project.
Record format is:
CONNECT_RETRY_PERIOD|3|<period>
IPC_BCAST_INTERVAL
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
The Router (IPC) System Name Broadcast Period in seconds.
Record format is:
IPC_BCAST_INTERVAL|1|<number>
GFK-1180H
System Management
36-5
IPC_QUEUE_SIZE
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
The maximum number of messages buffered by the Router in its Router to
application queue. The first time a queue overflows, it logs the following message to
the Status Log:
Router to Application queue overflow on port <port_name>
Further queue overflows on the same port do not result in any more error messages.
When the queue overflows, if the new message is not a response required message, it
is dropped. If it is a response required message, it is enqueued by bumping the queue
size.
Record format is:
IPC_QUEUE_SIZE|1|<number>
REDUND_LINK_SLEEP
For Server Redundancy, you can use this parameter to make the Router wait a period
of time before creating the link to the slave node.
Record format is:
REDUND_LINK_SLEEP|3|<number>
RTR_MAX_OUTMESSAGE_COUNT
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
The maximum number of messages buffered by the Router for a Router to Router
link. If the queue overflows, the Router drops new messages. When it drops the first
message, it logs the following error to the Status Log:
Router dropped offnode message to <remote_node_name>
Further dropping of messages to the same node do not result in additional error
messages as long as the remote node stays active.
If the entry does not exist, a default value of 1000 is used.
Record format is:
RTR_MAX_OUTMESSAGE_COUNT|3|<number>
36-6
GFK-1180H
GSM_ASC_FONT_SIZES
AM_RESET_ACK_STATE
GSM_ASC_SCALE
AMLP_USE_GEN_TIME
GSM_CACHE_SIZE
CE_MAX_DELAY
GSM_EXPONENT_PRECISION
CE_MAX_THREADS
GSM_SPCONFIRM_DEFAULT
CE_THREAD_TIMEOUT
GSM_STALE_COLOR_KEY
CLR_TOUT
GSM_UNAVAIL_COLOR_KEY
DBDL_ABORT_TIMEOUT
LOGIN_NOSAVE
DB_DEBUG
LOGIN_RETRY_PERIOD
DB_ENABLE_TRANSACTIONS
LOG_OPT
DB_QUEUE_OVERFLOW_DELAY
MAX_STACKED
DB_TIMESTAMP_PRECISION
MAX_TREND_BUF
DEL_OPT
PB_DIAGS
DONT_VERIFY_ESPOINT_FRID
PROJECT_ID
EMEP_BUF_SIZE
PTMDP_DO_EU_CONV
GSM_ANNUN_DIG_OFF
PTMRP
GSM_ANNUN_DIG_ON
RAW_LIMIT_ALARM
GSM_ANNUN_ALARM_H2
REPEAT_TOUT
GSM_ANNUN_ALARM_H1
SHORT_FILENAMES
GSM_ANNUN_ALARM_L1
SVC_RETRY_COUNT
GSM_ANNUN_ALARM_L2
SVC_RETRY_DELAY
GSM_ASC_FONT_NAME
ACK_TOUT
The time in minutes before an alarm is automatically acknowledged by the Alarm
Management Resident Process. If this parameter is defined, it is the default used for
Acknowledge Timeout in the Point and Alarm Alarm Options properties. If this
parameter is not defined, zero is used for the default.
Record format is:
ACK_TOUT|3|<minutes>
The default timeout in the distributed Global Parameters file is 0 (no automatic
timeout).
GFK-1180H
System Management
36-7
AM_RESET_ACK_STATE
In Alarm Management, when an alarm with the Acknowledge and Reset deletion
requirement have been acknowledged and transitions back to the Normal state, it is
automatically reset and deleted from the list of alarms. You can use this parameter to
reset the points Acknowledge state to "N" on this transition. This forces the user to
acknowledge the alarm again after it is reset.
Record format is:
AM_RESET_ACK_STATE|1|YES
AMLP_USE_GEN_TIME
For the Alarm Line Printer, when an alarm is acknowledged or deleted, this
parameter determines whether the generation time or the time of the acknowledge or
delete action is printer. If this parameter is not defined, the generation time is printed
by default.
Options are:
Y
CE_MAX_DELAY
For the Basic Control Engine, the maximum delay time in seconds after which a late
event will not be executed. For example, events may be delayed when there is a
heavy load on the system. If this parameter is not defined, the default is 60.
Record format is:
CE_MAX_DELAY|3|<time>
CE_MAX_THREADS
For the Basic Control Engine, the maximum number of simultaneous scripts. If this
parameter is not defined, the default is 30.
Record format is:
CE_MAX_THREADS|3|<number>
CE_THREAD_TIMEOUT
For the Basic Control Engine, the idle cache time in seconds before the threads are
freed. If this parameter is not defined, the default is 900 seconds.
Record format is:
CE_THREAD_TIMEOUT|3|<seconds>
36-8
GFK-1180H
CLR_TOUT
The time in minutes before an alarm is automatically reset by the Alarm Management
Resident Process. If this parameter is defined, it is the default used for Reset
Timeout in the Point and Alarm Alarm Options properties. If this parameter is not
defined, zero is used for the default.
Record format is:
CLR_TOUT|3|<minutes>
The default timeout in the distributed Global Parameters file is 0 (no reset timeout).
DBDL_ABORT_TIMEOUT
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
The delay in ticks before abort drops table in shutdown for the Database Logger
option.
Record format is:
DBDL_ABORT_TIMEOUT|1|<period>
DB_DEBUG
Enables the dumping of diagnostic information for the Database Logger to the
MAC_DL.out and MAC_PTDL.out files in your projects log directory.
Record format is:
DB_DEBUG|1|<value>
4096
If you do not define DB_DEBUG, the default is to print the full syntax of ODBC
error messages. Since ODBC errors should happen infrequently, this is unlikely to
cause problems with disk space.
You must explicitly specify a value of 0 (zero) to stop dumping diagnostic
information to the log files.
If you need additional diagnostic information, a value of 7 (1+2+4) is recommended.
Additional undocumented values should only be used by GE Fanuc engineers as they
send a great number of messages to MAC_DL.out and MAC_PTDL.out that could
quickly fill your available disk space.
GFK-1180H
System Management
36-9
DB_ENABLE_TRANSACTIONS
For the Database Logger, overrides the default database functionality as requested by
ODBC.
Options are:
Y
DB_QUEUE_OVERFLOW_DELAY
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
The delay in minutes between logging overflow errors for the Database Logger
option.
Record format is:
DB_QUEUE_OVERFLOW_DELAY|1|<period>
DB_TIMESTAMP_PRECISION
For the Database Logger, specifies an alternate timestamp precision for ODBC data
sources that do not accept the default provided by the CIMPLICITY Database
Logger.
Important
Do not configure this option unless instructed to by GE Fanuc support
personnel.
Record format is:
DB_TIMESTAMP_PRECISION|1|<timestamp>
where <timestamp> is the timestamp for your database. The timestamp must be
enclosed in single quotes as shown above. The format is case sensitive.
For more information on this parameter, see the Database Logger documentation.
DEL_OPT
The default requirements for alarm deletion. The options are:
A
Acknowledged only
Reset only
AR
36-10
GFK-1180H
DONT_VERIFY_ESPOINT_FRID
Changes the behavior of Setpoint Security for Enterprise Server points.
The options are:
Y
Setpoint Security for all points from a given provider are enforced against
the Resource IDs as configured on the provider.
This means that a setpoint against any of these points with resources not
configured on the Enterprise Server project will always fail since a resource
that is not configured cannot be in a users view.
EMEP_BUF_SIZE
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
For the Basic Control Engine, defines the communications buffer size. This indicates
the count of pending messages that the Basic Control Engine will hold.
Record format is:
EMEP_BUF_SIZE|3|<value>
GSM_ANNUN_DIG_OFF
The color and blink state to be displayed when a digital point is low for Alarm State
color animation.
Record format is:
GSM_ANNUN_DIG_OFF|1|<color_number><blink>
GFK-1180H
System Management
36-11
GSM_ANNUN_DIG_ON
The color and blink state to be displayed when a digital point is high for Alarm State
color animation.
Record format is:
GSM_ANNUN_DIG_ON|1|<color_number><blink>
GSM_ANNUN_ALARM_H2
The color and blink state to be displayed when an analog point is in Alarm High state
for Alarm State color animation.
Record format is:
GSM_ANNUN_ALARM_H2|1|<color_number><blink>
GSM_ANNUN_ALARM_H1
The color and blink state to be displayed when an analog point is in Warning High
state for Alarm State color animation.
Record format is:
GSM_ANNUN_ALARM_H1|1|<color_number><blink>
GSM_ANNUN_ALARM_L1
The color and blink state to be displayed when an analog point is Warning Low state
for Alarm State color animation.
Record format is:
GSM_ANNUN_ALARM_L1|1|<color_number><blink>
36-12
GFK-1180H
GSM_ANNUN_ALARM_L2
The color and blink state to be displayed when an analog point is in Alarm Low state
for Alarm State color animation.
Record format is:
GSM_ANNUN_ALARM_L2|1|<color_number><blink>
GSM_ASC_FONT_NAME
The name of the font to use for text on an ASCII (.ASC) screen. This must be a
TrueType font.
Record format is:
GSM_ASC_FONT_NAME|1|<name>
GSM_ASC_FONT_SIZES
A list of the 16 point sizes to use for the 16 text sizes in an ASCII (.ASC) file (GRE
text sizes 0 to 15, which are stored in the .ASC file as -1 to 14).
Record format is:
GSM_ASC_FONT_SIZES|1|<list>
GSM_ASC_SCALE
A floating-point number that represents the number of document units per world
coordinates when converting ASCII (.ASC) screens to .CIM format.
ASC files store screen information in floating point "world coordinates". The
screens are 100.0 world coordinates wide by 60.0 world coordinates high. Document
units in .CIM files are integers in TWIPS (twentieth of a point, 1440 TWIPS/inch).
Thus, if you want your .ASC screens to be about six inches wide on the display, you
should use a scale factor of (1440 doc. units/inch)*(6 inches/screen)/(100 world
coord./screen) which equals 86.4 doc. units/world coord.
Record format is:
GSM_ASC_SCALE|1|<value>
If this parameter is not defined, the default value is 86.4 doc. units/world coord.
GFK-1180H
System Management
36-13
GSM_CACHE_SIZE
As a default CimView keeps eight (8) prior screens in cache memory for faster
updates. If you require faster screen repaint times when switching between screens,
you can use this parameter to increase the cache size.
Note
Increasing this number uses additional memory and may have a negative effect on the
performance of other transactions.
Record format is:
GSM_CACHE_SIZE|1|<number>
GSM_EXPONENT_PRECISION
If a Text object on a CimView screen has "General" format and the number of digits
exceeds this parameter, then the number is displayed in scientific notation with that
number of significant digits.
For example, if you set GSM_EXPONENT_PRECISION to 3, the number 1234
displays as 1.23e+3.
Record format is:
GSM_EXPONENT_PRECISION|1|<number>
If this parameter is not defined, the default number of digits is 6. That is, if the
number exceeds six digits, it is displayed in scientific notation with 6 significant
digits.
GSM_SPCONFIRM_DEFAULT
Procedure dialog boxes contain two buttons: OK and Cancel. Action dialog boxes
contain three buttons: OK, Skip, and Cancel. The default button for both dialog
boxes is the OK button.
You can use this global parameter to select one of the other buttons to be the default
button in procedure and actin dialog boxes.
Record format is:
GSM_SPCONFIRM_DEFAULT|1|<selection>
36-14
GFK-1180H
GSM_STALE_COLOR_KEY
If a point being displayed in a Text object on a CimView screen is unavailable and
there is last available data, you can set the GSM_STALE_COLOR_KEY parameter
to display the value in that color rather than displaying the default text. If no last
available data exists, the default text is displayed.
Record format is:
GSM_STALE_COLOR_KEY|1|RGB(<red>,<green>,<blue>)
where <red>, <green>, and <blue> are the red, green, and blue color indices
from 0 to 255. For example, RGB(0,0,0) is black and RGB(255,255,255) is
white.
If this parameter is not defined, the Text object displays the default text when the
point is unavailable, regardless of whether a last available value exists or not.
GSM_UNAVAIL_COLOR_KEY
Color index number (0 to 255) used to indicate an unavailable point value on
CimView screens.
Record format is:
GSM_UNAVAIL_COLOR_KEY|1|<number>
where <number> is a number from 0 to 255. The color associated with each
number is defined in RGB.DAT.
If this parameter is not defined, the default is 0 (black).
LOGIN_NOSAVE
Disables the "Save Password" capability on the CIMPLICITY Login dialog.
Options are:
Y
LOGIN_RETRY_PERIOD
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
Retry period in seconds for connecting to a project whose User Registration program
is down.
Record format is:
LOGIN_RETRY_PERIOD|3|<number>
GFK-1180H
System Management
36-15
LOG_OPT
Use this parameter to define the default logging conditions for an alarm. You can
choose any of the following:
G
Alarm is generated
Alarm is acknowledged
Alarm is reset
MAX_STACKED
Use this parameter to define the default maximum number of occurrences of an alarm
that can be stacked in Alarm Viewer.
Record format is:
MAX_STACKED|3|<number>
MAX_TREND_BUF
Use this parameter to change the maximum number of point values a point buffers for
Trending. Point buffering is used when a chart is first displayed and there is some
initial data.
Note
Increasing this parameter will affect system performance.
Record format is:
MAX_TREND_BUF|3|<number>
36-16
GFK-1180H
PB_DIAGS
Use this parameter to enable/disable Point Bridge diagnostics.
Record format is
PB_DIAGS|1|LEVEL=<num1>,FILECLOSE=<num2>,DBGCHK_SECS=<num3>,
DUMPPOINT
where:
<num1> controls the amount/detail of diagnostic output. The value ranges from
0 to 9, where 0 means no debugging output, and 9 means the maximum amount
of debugging output.
<num2> is a value for NT operating systems that may handle output files in a
manner that prohibits multiple process access (as sometimes occurs with NT on
DEC Alpha platforms). This value controls approximately how often the output
file will actually be closed/re-opened, in seconds. A value of 0 (zero) means that
this period closing will not occur. Any non-zero value of less than 60 will be
forced to 60.
<num3> provides a number of seconds for an internal timer that rechecks the
parameters in the Global Parameters file. This value cannot be less than zero.
The default value is equivalent to five minutes.
DUMPPOINT initiates a one-shot dump of the Point Bridge internal information
regarding the state of points it is servicing. This parameter is only acted upon
once when any of the other arguments are changed, and the resulting change
leaves LEVEL with a non-zero value.
PROJECT_ID
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
This parameter is used by the Multiple Projects option and contains the one character
Project ID for the project.
Record format is:
PROJECT_ID|1|<name>
GFK-1180H
System Management
36-17
PTMDP_DO_EU_CONV
In Point Configuration, when you use a device Point ID in the Expression Editor for
virtual points, the raw value of the point is used by default. If you want to use the
engineering units value, you must enter EU_CONV(<point_id>) in the
expression.
Use this parameter to automatically convert Point ID values to engineering units
without having to use the EU_CONV function.
Options are:
0
PTMRP
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
Defines the default Point Manager to be used for point processing.
Record format is:
PTMRP|1|<number>
RAW_LIMIT_ALARM
Use this parameter to enable or disable the generation of alarms for point values that
are outside their raw limits. The options are:
YES
NO
REPEAT_TOUT
The time in minutes before an alarm is automatically repeated to all interested
processes by the Alarm Management Resident Process. If this parameter is defined,
it is the default used for Repeat Timeout in the Point and Alarm Alarm Options
properties. If this parameter is not defined, zero is used for the default.
Record format is:
REPEAT_TOUT|3|<minutes>
The default timeout in the distributed Global Parameters file is 0 (alarms are not
repeated).
36-18
GFK-1180H
SHORT_FILENAMES
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
Enable or disable support for short (8 characters or less) filenames. The options are:
YES
NO
SVC_RETRY_COUNT
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
Sets the number of retries waiting for an external service to start up.
Record format is:
SVC_RETRY_COUNT|1|<number>
The default retry count in the distributed Global Parameters file is 30.
SVC_RETRY_DELAY
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
Sets the delay in ticks between retries waiting for an external service to start up.
Record format is:
SVC_RETRY_DELAY|1|<number>
The default retry delay in the distributed Global Parameters file is 100 ticks.
GFK-1180H
System Management
36-19
ABETH_PLC_REQUEST_TIMEOUT
ABETH_PLC_RESPONSE_TIMEOUT
FLOPRO_STATIC_MODEL
<port>_OMRON_SERVICE
<port>_OMRON_SNA
<port>_TO
GMR_WRITE_ALL
GMR_SKIP_L_DOMAIN
HCT_SKIP_L_DOMAIN
UNSO_TX_AREA_<n>
Smarteye Communications
<port>_LOG_WARNING
<port>_POLL_LIMIT
<port>_MODE
<port>_RESTART_AREA
SE_LABEL_LEN
36-20
GFK-1180H
Sample File
The following is a sample GLB_PARMS.IDT file:
|-* IDT file generated by IDTPOP utility v1.0
* RECORD: GLB_PARMS SYSTEM GLOBAL PARAMETERS
*
*
0 PARM_ID
Global Parameter Identifier
*
1 parm_type
CH-0,S-1,IS-2,I-3,BT-4,WRD-5,LG-6,BL-7
*
2 parm_value Parameter Value up to 80 chars
*
ACK_TOUT|3|0
CLR_TOUT|3|0
CONNECT_DROP_PERIOD|3|600
CONNECT_RETRY_PERIOD|3|90
DBDL_ABORT_TIMEOUT|1|50
DBDL_DEVICE_CHECK_PERIOD|1|30
DB_QUEUE_OVERFLOW_DELAY|1|30
DB_QUEUE_SIZE|1|20
DEL_OPT|1|AR
DOWNLD_PASSWD
DYN_CFG|1|YES
GSM_UNAVAIL_COLOR_KEY|1|0
IPC_BCAST_INTERVAL|1|90
LOGIN_RETRY_PERIOD|3|15
LOG_OPT|1|
MAX_STACKED|3|0
PTDL_QUANTIZATION|1|100
PTMRP|1|MASTER_PTM0_RP
RAW_LIMIT_ALARM|1|YES
REPEAT_TOUT|3|0
RTR_ACCEPT_CONN|1|Y
RTR_DISABLE_BCAST|1|Y
SETPOINT_SECURITY|1|NO
SHORT_FILENAMES|1|NO
SVC_RETRY_COUNT|1|30
SVC_RETRY_DELAY|1|100
SYSNAME|1|MMI_ONE
GFK-1180H
System Management
36-21
Logical Names
Logical names are used to override default values for the CIMPLICITY HMI Base
System and options.
Note
Logical names are not to be confused with environment variables. Logical names are
found in the log_names.cfg file, while environment variables are accessed
through the Control Panel.
Logical names that you may want to consider modifying for the Base System are:
CLIE_MAX_PTS
Logical names that you may want to consider modifying for Allen-Bradley
Communications are:
ALL_UNSO
<port>_ALL_UNSO
PLC2_PROT_WRITE_ALL
PLC2_PROT_WRITE_<port>
ABI_MAXDEF
Logical names that you may want to consider modifying for Modbus Plus
Communications are:
MD_QUERY_ALL
MD_QUERY_<device>
MD_SKIP_GENREF_ALL
MD_SKIP_GENREF_<device>
Logical names that you may want to consider modifying for Mitsubishi TCP/IP
Communications are:
36-22
<prcnam>_UNSO_ALL_TYPES
<prcnam>_UNSO_DEC
<prcnam>_UNSO_EITHER
<prcnam>_UNSO_HEX
GFK-1180H
DC_CONNECT_MS
DC_CONNECT_URETRY_CNT
DC_TCP_POLLS_MS
DCQ_DEAD_TIME
MMAX_SYNC_TICKS
MSYNC_TICKS
Logical names that you may want to consider modifying for SNP Communications
are:
BSM$SNP_T1_TIME
BSM$SNP_ATTACH_DELAY
Where:
<logical_name> is the name of the logical
<type> is the type of logical (usually set to P for project)
<length> is the number of characters in <value>
<value> is the value to be assigned to the logical name.
You may use Notepad to edit the file.
To change a logical name in the Logical Names file for a project, select Command
Prompt from the Tools menu in the Workbench for the project where you want to
change the parameter and do the following:
1.
Type cd data.
2.
3.
Find the parameter you want to change, and make the change.
4.
5.
When you are ready to implement the change in the run-time system, you will have to
stop and restart CIMPLICITY software.
GFK-1180H
System Management
36-23
36-24
GFK-1180H
2.
.AMV
.cim
.CLG
.GEF
CFGCab Document
CimEdit
CimEdit.Documents
All file types starting with CIMPLICITY
CimView
CimView.Documents
Default Device Property Sheet
SNPDevice Property Sheet
TCP IP Device Property Sheet
VME Device Property Sheet
GFK-1180H
System Management
36-25
CFGCab Document
CimEdit
CimEdit.Documents
All file types starting with CIMPLICITY
CimView
CimView.Documents
Default Device Property Sheet
GE Fanuc CIMPLICITY 7.0 Screen
SNPDevice Property Sheet
TCP IP Device Property Sheet
VME Device Property Sheet
2.
36-26
GFK-1180H
GFK-1180H
The second section of this document explains the procedure of site wide
installation. CIMPLICITY HMI software provides some tools for
making site wide installation procedure easier. This section gives step
by step instructions to use them.
System Management
36-27
All these tasks can be done centrally with the SMS Administrator at a Microsoft
Windows NT-based client. The SMS system maintains a database containing system
information and inventory, carries out distribution and installation jobs, monitors the
progress of these jobs, and alerts you to important system events.
SMS lets you centrally manage your entire enterprise. Using SMS you can distribute
and install software on clients and servers across your corporate network, set up
network applications, automatically collect and maintain hardware and software
inventory, provide direct support to clients, and monitor your network.
When you distribute software to a site, the software is distributed to designated
servers at the site called distribution servers. From these distribution servers, users
can manually access and install the software on their clients. Or you can specify
commands to automatically run applications or install software from the distribution
servers to the clients.
When you set up a network application for shared use by groups of users, you
distribute software to the servers from which you want users to access the network
application. You also specify which groups of users have access to the network
application. When you set up the network application, the program item for the
application is automatically set up on the users computers. When users choose the
application, the network application is run from that server.
You can also specify scheduling times for distributing software to maximize the
efficiency of your system.
You can distribute software or set up network applications for the current site where
you have logged on with the SMS Administrator or for any site beneath the current
site. When you target other sites for software distribution or network application
setup, the SMS system can use NetBIOS transport protocols on a LAN, RAS (Async,
X.25, or ISDN communications link), or SNA LU 6.2 links (batch and interactive
mode) to transfer the software and instructions for installing that software to the
target sites. For fault tolerance and efficiency, you can also define alternate LAN,
RAS, or SNA addresses to other sites. You can also set scheduling and priority
management on each type of address.
36-28
GFK-1180H
Send the instructions for running the package command to the target
clients.
All of these tasks can be done with a single Run Command On Workstation job (as
described in this document). Alternatively, you can do each of these tasks
individually using separate Run Command On Workstation jobs.
When a job sends a package, SMS compresses all files and subdirectories in the
packages source directory into a single compressed package file and transfers the
compressed file to the sites containing target clients. The compressed package file is
stored on the site server.
Once a package has been sent to a target site, the package is distributed to servers at
the target site. The SMS Despooler at the target site decompresses the compressed
package file into the package source directorys original files and directory structure,
and places these files on the distribution servers in a subdirectory of the
SMS\LOGON.SRV\PCMPKG.SRC directory. The package source directory is
shared so that the client can have access to the directory.
GFK-1180H
System Management
36-29
The server where the package directory is shared is called the distribution server
because it serves as a distribution point for the package source directory. When a
user selects a package command line using the Package Command Manager, the
Package Command Manager connects to the package share of the distribution server
for the package share. The Package Command Manager then runs the package
command using the package share as the current directory.
Once a package has been distributed to servers at a site, the packages command can
be run at clients in the site. From the list of computers specified in the Job Target for
the job, the Despooler at the target site creates an instruction file for each target client
for running the package command. The SMS Maintenance Manager replicates these
instruction files to all logon servers at the site.
When the user at the client starts the Windows environment or explicitly starts the
Package Command Manager, the Package Command Manager checks a logon server
for package command instructions (the Package Command Manager checks for
incoming jobs at an interval specified in the Options dialog box.). The package
command is made available to the user according to the instructions specified by the
Run Workstation Command settings for the job.
36-30
GFK-1180H
2.
3.
GFK-1180H
1.
2.
3.
System Management
36-31
After the files are copied, the Select CIMPLICITY Options dialog box
opens automatically.
4.
Select the product type in the Select Options for combo box.
All options for that product will be displayed.
Select Apply.
Note
Each product that has been modified will have an asterisk (*) in front of its name in
the Select Options for combo box.
5.
36-32
Share the Application Source Directory with the same name (for
example, the share name for c:\cimpsms is CIMPSMS).
GFK-1180H
2.
3.
4.
Select Import.
The File Browser dialog box opens.
5.
Select OK.
The File Browser dialog box closes and the Package Properties dialog
box redisplays.
GFK-1180H
System Management
36-33
6.
7.
Select Close.
2.
3.
36-34
GFK-1180H
Select Details.
The Job Details dialog box opens.
4.
Select OK.
This will create a job for CIMPLICITY HMI Site wide installation
5.
GFK-1180H
System Management
36-35
Login Password
Role Privileges
Setpoint Security
Setpoint Password
Login Password
When you configure a User in a CIMPLICITY HMI project, you can:
For more information on User Configuration, see that chapter in the CIMPLICITY
HMI for Windows NT and Windows 95 Base System Users Manual (GFK-1180).
Role Privileges
You can assign one Role to each User in a CIMPLICITY HMI project. When you
configure a Role in a CIMPLICITY HMI project, you can grant users assigned the
Role permission to:
For more information on Role Configuration, see that chapter in the CIMPLICITY
HMI for Windows NT and Windows 95 Base System Users Manual (GFK-1180).
36-36
GFK-1180H
Setpoint Security
You can use the Setpoint Security feature to enable or disable Setpoint Security for
all users that access your project. If you enable Setpoint Security, a user can perform
setpoints on only those points whose resources are in the users view.
For an Enterprise Server project, Setpoint Security is enforced against the rescue in
the Enterprise Server project if that project contains the same rescues as the provider
of the point. If the resource is not configured on the Enterprise Server project, then
Setpoint Security for the point is enforced against the remote projects resource.
For more information on Point Configuration, see that chapter in the CIMPLICITY
HMI for Windows NT and Windows 95 Base System Users Manual (GFK-1180).
Setpoint Password
By default, run-time users have unrestricted access to the setpoint functions used by
CIMPLICITY HMI software. If you enable the Setpoint Password option and enter a
password, run-time users will be prompted for this password whenever they invoke a
setpoint function.
Setpoint functions include:
If you include Setpoint functions in Basic Control Engine scripts, and you enable the
Setpoint Password option, you must include the password in the function call.
For more information on Point Configuration, see that chapter in the CIMPLICITY
HMI for Windows NT and Windows 95 Base System Users Manual (GFK-1180).
GFK-1180H
System Management
36-37
These alarms are included in your project configuration. They are all configured for:
Delete on Acknowledge
No Manual Clear
Log on Generate
Acknowledge immediately
No stacking
The $ALARM_MODIFIED alarm is generated when a user modifies the alarm limits
for a point. The alarm message contains the following information:
Alarm limits modified for: <point_id> by <user_id>
(<OS_user> @ <computer_name>)
36-38
GFK-1180H
Setpoint Downloads
A user can download setpoints from:
CimView screens
Recipes
The alarm records the entity type being changed, the entity name being changed, the
CIMPICITY login user name of the user and the computer login user name of the
user.
Project Login/Logout
The $LOGIN_FAILURE alarm is generated when a user fails to log in to a
CIMPLICITY HMI project correctly and the number of consecutive login errors has
been reached. The alarm message contains the following information:
User ID <user_id> disabled, computer <computer_name>
The $LOGOUT alarm is generated when a user logs out of a CIMPLICITY HMI
project. The alarm message contains the following information:
User ID <user_id> @ <computer_name> logged out
GFK-1180H
System Management
36-39
OEM Key
The OEM Key is designed to allow OEMs and Integrators to maintain installed
CIMPLICITY HMI Runtime systems for their customers. It lets you temporarily
convert a CIMPLICITY HMI Runtime System License on a computer to a
CIMPLICITY HMI Development System License.
When you activate OEM Key on a computer, you must stop all projects that are
currently running on the computer.
While OEM Key is active on a computer:
Projects that you start on the computer cannot access data from or
provide data to other CIMPLICITY HMI projects.
OEM Key terminates at the end of two hours. You can terminate it earlier by exiting
the OEM Key application. When OEM Key terminates, all running projects are
stopped.
2.
3.
Run oemkey.exe.
36-40
GFK-1180H
GFK-1180H
If any projects are running, the OEM Key dialog box opens.
If no projects are running, the CIMPLICITY HMI OEM Key dialog box
opens.
System Management
36-41
Select Cancel to exit OEM Key without stopping the running projects.
Select Stop CIMPLICITY HMI to terminate your running projects.
When the Next> button activates, select it to continue activating OEM Key. The
CIMPLICITY HMI OEM Key dialog box opens.
36-42
GFK-1180H
You can leave the dialog box open or minimize it while OEM Key is running.
You can select the Show status window check box to display the time left. This
status window displays on top of all the windows on your screen.
If you exit the dialog box or select Quit, the OEM Key terminates immediately.
It displays a dialog box warning you that it will stop all running
projects.
GFK-1180H
System Management
36-43
Remote Projects
If, when a project starts, the Point Bridge or Point Data Logger need to get points
from projects on other computers running CIMPLICITY projects, you need to define
remote projects.
If your computer is on a network with other CIMPLICITY computers, you can
retrieve point information from projects running on the other computers in a variety
of ways:
If you are using the Database Logger option, you can log points from
projects on other computers.
You have defined points in Point Configuration that use the Point
Bridge to get their values from points in projects on other computers.
You are using the Database Logger option and you are logging points
from projects on other computers.
In other words, if, when the project starts, the Point Bridge or Point Data Logger
need to get points from projects on other computers running CIMPLICITY projects,
you need to define remote projects. This is especially important if you are
configuring a CIMPLICITY project to start at boot time.
To define a remote project, double-click the Remote Projects icon in the Workbench
for your project.
The Configuration - Projects window opens.
36-44
GFK-1180H
Enter the name of the remote project in the Project Name field and select OK. The
Remote Project dialog box opens. This dialog box consists of two pages.
Use the General page to enter general information about the project.
Use the Enterprise page to configure data and alarm collection for an
enterprise project.
When you are through, select OK to save the information, or select Cancel to close
the dialog box without making any changes.
GFK-1180H
System Management
36-45
Password
Reenter Password
Enable
36-46
GFK-1180H
If you want to use your current project as an Enterprise Server, you must define a
remote project for each project in your enterprise from when you want to concentrate
data or alarm information.
In the Enterprise property page, the Resource and Device are pre-configured.
Users that want to view point and alarm information from a remote project on an
Enterprise Server must have the remote projects Resource configured in their view.
Enter the following information:
Collect points
Collect alarms
Only one level of concentration is supported. In other words, if you are connecting
to a remote project that has local and concentrated points, you will only be able to
collect local points from the remote project.
GFK-1180H
System Management
36-47
You will need to do the following to successfully use the Point Bridge:
1.
2.
3.
Define a device for the Point Bridge port and make sure the Device
Name matches the Remote Project name.
4.
Define the points you want to retrieve from the source system. Make
sure that the Point Address matches the source projects point name.
The Point ID on the destination system does not have to match the Point ID on the
source system. The data types and number of elements of the two points do have to
match. When the source point changes value, the point value is updated on the local
system.
Both reading and writing of points are supported. If a point is configured for WRITE
access on both systems, a user on the Point Bridge system can set the value of the
Point Bridge point. The point on the source system is then updated.
Dynamic configuration of Point Bridge points is also supported.
Note
Diagnostic points are not available for the Point Bridge.
36-48
GFK-1180H
The fields described below have configuration values that are unique to or have
special meaning for Point Bridge communications:
Device
Point ID
Access
Specify if the Point Bridge process can set the value of a point
on a source system.
WRITE access is only valid if it is configured for the point on
the Point Bridge system and on the source system.
GFK-1180H
Update Criteria
Address
Clear this check box. Point Bridge does not support this
feature.
System Management
36-49
GFK-1180H
37-1
Modem
Modem
37-2
GFK-1180H
Ethernet installed
A modem
For the CIMPLICITY HMI Viewer (also referred to as the Client computer), you
need:
A modem
For both computers, you need to have the TCP/IP and NetBEUI protocols
configured. Both computers must also have the same version of CIMPLICITY HMI
software installed with valid licenses.
Finally, you will need to get two consecutive TCP/IP addresses from your Network
Administrator. You will be assigning these addresses to the Server and Client
modems when you configure the Remote Access Server.
GFK-1180H
37-3
2.
3.
4.
5.
After the software installation completes, the Remote Access Setup dialog box opens
automatically.
37-4
GFK-1180H
1.
Click Configure....
The Configure Port Usage dialog box opens.
For the Server, the minimum selection for Port Usage is Receive
calls only.
2.
Make sure that NetBEUI and TCP/IP are selected for Server
Settings.
GFK-1180H
37-5
Note
If you selected Dial out and Receive calls in the Configure Port Usage dialog
box, make sure that NetBEUI and TCP/IP are also selected for Dial out
Protocols.
3.
4.
Select the type of client access you want. If the Server does not
have a Network Interface Card (NIC) installed you must select the
This computer only option. Otherwise RAS will fail to start.
37-6
GFK-1180H
Select Use static address pool, and enter the two consecutive
IP addresses you requested from your Network Administrator in
the Begin and End fields. The Begin address is assigned to the
modem on the Server, and the End address is assigned to the
Client.
Note
5.
6.
7.
Click OK to close the Network dialog box. The system will finish
configuring the Remote Access Server and reboot the computer.
2.
3.
4.
GFK-1180H
Click OK to close the dialog box and return to the Services dialog
box.
37-7
2.
If you see the message "Remote Access Service is not started on the selected server",
you need to start up the service.
3.
4.
Make sure that all the users who will be dialing in as clients have
Dialin permission.
37-8
GFK-1180H
2.
3.
4.
5.
After the software installation completes, the Remote Access Setup dialog box opens
automatically.
GFK-1180H
37-9
1.
Click Configure....
The Configure Port Usage dialog box opens.
For the Client, the minimum selection for Port Usage is Dial out
only
2.
Make sure that NetBEUI and TCP/IP are selected for Dial out
Protocols.
Note
If you selected Dial out and Receive calls in the Configure Port Usage dialog
box, make sure that NetBEUI and TCP/IP are also selected for Server Settings.
You will also need to configure the NetBEUI and TCP/IP configurations.
37-10
3.
4.
5.
Click OK to close the Network dialog box. The system will finish
configuring the Remote Access Server and reboot the computer.
GFK-1180H
Open My Computer.
2.
3.
Add an entry for the Remote Access Server you want to connect to.
If the RAS client does not have a Network Interface Card (NIC) be sure to enable the
option Use default gateway on remote network in the phone book
entry for each RAS server that you will connect to.
2.
3.
4.
2.
3.
4.
Select Communications.
Click Details... .
GFK-1180H
1.
Open My Computer.
2.
3.
Add an entry for the Remote Access Server you want to connect to.
37-11
2.
3.
4.
Select TCP/IP -> Dial-Up Adapter and display its properties. You
need to do the following:
5.
Select the Identification tab and enter a name (9 characters or less) for
the computer.
6.
Click OK to close the Network dialog box and save your changes.
37-12
GFK-1180H
If the RAS server does not have a NIC then place the following entry in the
cimhosts.txt file:
127.0.0.1 alnt32
Ping
After dialing in to the Server from the Client and establishing the connection, you
should be able to perform the following tests successfully.
Client Tests
You should be able to ping the Server computer by address from the Client computer.
For example:
C:\WINDOWS>ping 3.26.5.134
Pinging 3.26.5.134 with 32 bytes of data:
Reply
Reply
Reply
Reply
from
from
from
from
3.26.5.134:
3.26.5.134:
3.26.5.134:
3.26.5.134:
bytes=32
bytes=32
bytes=32
bytes=32
time=103ms TTL=128
time=101ms TTL=128
time=101ms TTL=128
time=99ms TTL=128
C:\WINDOWS>
GFK-1180H
37-13
Server Tests
You should be able to ping the Client computer by address from the Server computer.
For example:
C:\WINDOWS>ping 3.26.5.144
Pinging 3.26.5.144 with 32 bytes of data:
Reply
Reply
Reply
Reply
from
from
from
from
3.26.5.144:
3.26.5.144:
3.26.5.144:
3.26.5.144:
bytes=32
bytes=32
bytes=32
bytes=32
time<10ms TTL=32
time=1ms TTL=32
time=1ms TTL=32
time<10ms TTL=32
C:\WINDOWS>
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).
37-14
GFK-1180H
2.
For example, if your LAN is divided into two Class C subnets, 1.1.1.x and 1.1.2.x,
and you configure your computer on the 1.1.1.x subnet to use RAS with the Use
default gateway on remote network option enabled, all packets you send to the
1.1.2.x subnet will be sent via the RAS connection and not your computers NIC.
To route packets correctly, use the Windows NT route.exe command to add a
static route to your TCP/IP route table that will instruct Windows NT to send packets
intended for the 1.1.2.x subnet to a router on the 1.1.1.x subnet. For more
information on using the Windows NT route.exe command, refer to the Windows
NT Command Reference section of the Windows NT Help file (WINHLP32.EXE).
GFK-1180H
You can have only one RAS connection from a RAS client to a RAS
server at a time. A RAS server can handle multiple RAS clients.
37-15
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-1180H
38-1
We strongly recommend that you install and configure the Microsoft Internet
Information Server before you install the CIMPLICITY HMI WebGateway.
Installation Procedure
To install the CIMPLICITY HMI WebGateway on your Web Server:
1.
2.
3.
4.
5.
6.
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.
10. In the Choose Program Group dialog box, select the program group for
the CIMPLICITY HMI WebGateway software, and then select Next.
The software begins to load.
When installation is complete, you are given an opportunity to register your
CIMPLICITY HMI WebGateway software.
For CIMPLICITY HMI WebGateway software to function correctly, you will need to
reboot your computer. The last dialog box gives you the opportunity to reboot your
computer immediately.
38-2
GFK-1180H
\InetPub\Scripts\CimGate.dll
This is the ISAPI extension for the Web Server. It processes requests
for CIMPLICITY point data. This file must exist in a directory to
which the browsing user has execute access.
Your HTML Web pages must refer to this directory, so it is
recommended that you leave the file in this default directory.
\InetPub\wwwroot\CIMPLICITY\HMI\CimData.jar
This is the CIMPLICITY Data Java Applet that makes it easy to access
CIMPLICITY point data from within an HTML Web page using
VBScript or JavaScript. This file must exist in a directory to which the
browsing user has read access.
Your HTML Web pages refer to this directory (using the CODEBASE
attribute of the APPLET tag), so it is recommended that you leave the
file in this default directory.
\InetPub\wwwroot\CIMPLICITY\HMI\*.html
These are sample Web pages you can use.
\CIMPLICITY\HMI\...
This is a subset of the CIMPLICITY HMI Viewer installation.
Project Setup
Before the WebGateway can communicate with a CIMPLICITY HMI project in your
enterprise, you must configure the project to permit access by the WebGateway. To
do this:
GFK-1180H
1.
2.
3.
4.
In the New Client dialog box, enter the name of the computer running
the Web Server, then select OK.
5.
Select OK.
38-3
2.
Display some points from projects where you have declared the
WebGateway a client.
3.
Verify that the points are updating correctly, and that you can perform
setpoints.
If you do this successfully, you know that the connections between the projects and
the WebGateway are working correctly.
Open the
http://<mycomputer>/CIMPLICITY/HMI/Validate.html
URL, where <mycomputer> is the name of the Web Server
computer.
If you have trouble opening the HTTP URL, try opening the file from
the Web Server computer using the fully qualified path name (for
example,
C:\InetPub\wwwroot\CIMPLICITY\HMI\Validate.html).
The Validation document opens at the first set of tests.
38-4
GFK-1180H
GFK-1180H
2.
Follow the directions on the Web document to perform the first set of
tests.
3.
After you verify that the first set of tests work, proceed to the second set
of tests.
38-5
I get the error "Object doesnt support this property or method" when
looking at page in Internet Explorer.
A:
The applet may not been installed. If you wrote your own HTML file, the
method for the applet may be misspelled, or the name for the applet (in the
<APPLET> tag) does not match the name used in your script.
Error Messages
The first part of the error string contains one of the following error codes.
#ERROR!ARRAYNOTALLOWED
This error is returned if you try to use an element of an array point with the PointSet
method.
#ERROR!ARRAYOUTOFBOUNDS
This error usually indicates that the index specified for an array point was not valid.
It will also be returned if you specify an index for a non-array point or if you fail to
specify an index for an array point. In some cases, additional information will be
available following this message.
#ERROR!BADSERVERRESPONSE
This error is returned if the CimData applet could not parse the response from the
CimGate extension. Examining the value of the DiagRawResponse property will
reveal the cause of the error.
#ERROR!CIMPLICITYNOTRUNNING
This error indicates that the CIMPLICITY HMI Viewer could not be started by the
CimGate extension.
38-6
GFK-1180H
#ERROR!INVALIDPOINTID
This error is returned by the CimData applet if you pass an empty string for the point
ID parameter to the PointSet method.
#ERROR!NOTIMPLEMENTED
This error is returned by CimGate server when the PointMonitor method (which is
not implemented) is called.
#ERROR!NOTLICENSED
This error is returned when the CIMPLICITY HMI WebGateway is not licensed.
The CIMPLICITY HMI Gateway must be licensed to use it beyond the trial period.
Run the CIMPLICITY HMI Registration program.
#ERROR!POINTIDSYNTAX
This error is returned when the string passed to PointGet or PointSet could not be
properly parsed as a point ID.
#ERROR!POINTUNAVAILABLE
This error is returned when the point may be unavailable for any number of reasons.
Generally, there will be additional information following this message indicating why
the point is unavailable. You may also want to look at the CIMPLICITY HMI Status
Log on the Web Server computer to help understand why the point is unavailable.
#ERROR!SERVERNEEDSRESTART
This error indicates a condition in the CimGate server that requires the Web Server to
be restarted. Typically this occurs when the CIMPLICITY HMI Viewer (or project)
on the Web Server computer is shut down.
#ERROR!URLEXCEPTION
This error indicates a problem with the URL constructed from the Web Server name,
point IDs, and values supplied. One such problem might be that the Web Server
specified is not the same as the host from which the Java data applet was loaded,
which is a security requirement imposed by many web browsers.
GFK-1180H
38-7
setCaption (Method)
Syntax
setCaption(String capString)
Description
Parameters
Comments
Example
Using JavaScript:
document.MyApplet.setCaption("Paint Shop Data")
getCaption (Method)
Syntax
String getCaption()
Description
Return Value
Comments
The raw input and output are displayed in the appets text area, and can be retrieved for diagnostic
purposes using this method.
Example
Using JavaScript:
myText = document.MyApplet.getCaption()
appendCaption (Method)
Syntax
appendCaption(String capString)
Description
Adds a specified string to the end of the text in the applet's text area.
Parameters
Comments
The caption is useful to display while testing pages. This method adds informative text without
removing any existing caption information.
Example
Using JavaScript:
document.MyApplet.appendCaption("Paint Shop Data")
pointGet (Method)
Syntax
38-8
pointGet(String cimGate)
[buffered form]
GFK-1180H
[unbuffered,
single-point form]
Description
Retrieves value(s) for the specified CIMPLICITY point(s). The first form of pointGet retrieves
values for all point IDs currently held in applet storage, and places the values retrieved into the
applets internal storage. The second form is a shortcut for retrieving a single point value.
Parameters
Parameter
Description
cimGate
A String containing the location of the CimGate extension. The format of this
string is "computer/directory". For example, mycomputer/Scripts.
pointID
Return Value
The first form of this method returns nothing. The second form returns the point status string (see
below).
Comments
Use the second form of this function when you only need to retrieve a single point value. The
second form of this method clears any proir content of the applets internal storage before
proceeding.
If an error occurs during any WebGateway transaction, the point status string (obtainable via
getPointStatus) will be E, and the point value retrieved will be an extended error string. If the
transaction completed normally, the point status string will be a string indicating the points data
type.
You may not specify an array point, but you may specify an element of an array point (for example,
arrPointID(0) = "\\PROJ\ARRAYPT[2]"). Fully qualify the Point ID with a project. Do
not enclose the Point ID in single quotes.
If a point is configured with EU conversion, the converted value (not the raw value) of the point is
returned.
Example
Using JavaScript:
<applet name=MyApplet
archive=CimData.jar
code=com.gefanuc.hmi.CimData.CimDataApplet.class
height=0
width=0>
</applet>
<form name=MyForm>
Temp: <input name=temp type=text value=><br>
Speed: <input name=speed type=text value=><br>
</form>
document.MyApplet.clearPoints();
document.MyApplet.setPointID(0, \\\\proj\\temp)
document.MyApplet.setPointID(1, \\\\proj\\speed)
document.MyApplet.pointGet("mycomputer/Scripts")
if (getPointStatus(0) = E) {
alert Error: + document.MyApplet.getPointValue(0);
}
else {
document.MyForm.temp.value = document.MyApplet.getPointValue(0);
}
if (getPointStatus(1) = E) {
alert Error: + document.MyApplet.getPointValue(1);
}
else {
document.MyForm.speed.value = document.MyApplet.getPointValue(1);
}
GFK-1180H
38-9
See Also
pointSet (Method)
Syntax
Description
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
pointValue
Return Value
Comments
Since the CimGate extension only supports setting one point at a time, only a single-point form of
this method is required. Note that this method clears any proir content of the applets internal storage
before proceeding. See pointGet for error reporting information.
See Also
pointGet
clearPoints (Method)
Syntax
clearPoints()
Description
Comments
The WebGateway Data Applets internal storage holds point IDs and values, allowing you to specify
more than one point before invoking a transaction with the WebGateway. Making one server
request for multiple values is generally more efficient than retrieving values with separate
transactions. Use this method to clear the applets storage before specifying point IDs to retrieve.
See Also
setPointID (Method)
Syntax
Description
Parameters
Parameter
Description
pointIndex
pointID
Comments
Call this method repeatedly, with consecutive integer indices for each point ID, to load the applets
internal storage before making a transaction.
See Also
pointGet
38-10
GFK-1180H
getPointValue (Method)
Syntax
Description
Retrieves a point value or error string from the applets internal storage after a pointGet transaction.
See pointGet for more details.
Parameters
Parameter
Description
pointIndex
Return Value
The point value corresponding to the supplied index, or an extended error string if an error occurred
during the transaction.
See Also
pointGet
getPointStatus (Method)
Syntax
Description
Use this method to retrieves a status string from the applets internal storage after a transaction. The
status string for a point requested, referred to by pointIndex, contains E if the transaction was
unsuccessful for that point. See pointGet for more details.
Parameters
Parameter
Description
pointIndex
the zero-based integer storage index of the point status string to retrieve
Return Value
See Also
pointGet
GFK-1180H
38-11
Appendix A - System
Administrative Issues
About System Administrative Issues
This appendix provides the procedures to:
Through a network
Via diskette
2.
Select HMI.
3.
Select Registration.
.
The Registration Instructions dialog box opens.
GFK-1180H
4.
5.
A-1
You may transfer CIMPLICITY HMI software licenses to another computer without
contacting GE Fanuc for a new System Authorization Code. The Registration program
provides utilities that let you transfer your system licenses, key code, and authorization codes
to another computer via diskette. If you are running Microsoft Windows NT on both
computers, you may transfer the licenses over the network
Important: You must transfer the entire registration (all licenses). Once you complete the
transfer, your source computer becomes an unauthorized system. If you wish to continue to
run fully functional CIMPLICITY software on the source computer, contact your distributor to
purchase additional licenses.
Make sure that you can write to the Windows directory of the target computer.
2.
A-2
GFK-1180H
Select CIMPLICITY on the Windows Start menu of the target computer (the one that
is not yet authorized).
2.
Select HMI.
3.
Select Registration.
.
The Registration Instructions dialog box opens.
5.
5.
6.
Select Register the Diskette in the Registration Transfer Using Floppy Diskette
dialog box
6.
Select Next.
7.
9.
10. Proceed to the Registration Transfer Using Floppy Diskette dialog box.
11. Select Authorize the Diskette in the CIMPLICITY Registration Transfer Using
Floppy Diskette dialog box.
12. Select Next.
13. Remove the diskette from the source computer.
Remember, at this point in the procedure, CIMPLICITY HMI software is no longer
registered on the source computer.
Continue on the target computer:
14. Insert the diskette in the floppy drive.
15. Run the Registration program.
16. Proceed to the Registration Transfer Using Floppy Diskette dialog box.
17. Select Authorize the system from the Authorized diskette.
18. Select Next.
When the utility completes, the target computer is registered to run CIMPLICITY
HMI software.
GFK-1180H
A-3
Important: You can only create distributions for the platform you are on. For example, if
you are on an Intel PC, you can only create Intel distributions.
Before you start, make sure that you have enough pre-formatted diskettes to create the
distribution. To find out how many you need:
1.
2.
Use the File Manager to locate the I386 (if you are on an Intel PC) or ALPHA (if
you are on a DEC Alpha PC).
3.
You will see a number of files named DISKn.ID. The number of files equals the
number of diskettes you will need to create the release (for example, if you see
DISK1.ID through DISK17.ID, you will need 17 diskettes for your floppy
distribution).
Use this argument to create a specific disk from the CIMPLICITY Distribution
CD-ROM, where <disk_no> is the disk number you want to create.
This is useful if you find you have a bad floppy, and want to re-create it. For
example, if you find that the fifth diskette is bad, enter the command DSK2FLPY
-n5 to create a new copy.
-t
The default target floppy drive is A:. Use this argument if your floppy drive is not
A:
For example, if your floppy drive is B:, enter the command DSK2FLPY -tB:.
A-4
GFK-1180H
2.
Use the Explorer to locate DSK2FLPY.EXE in the appropriate directory on the CD.
3.
4.
5.
6.
If you need to enter additional arguments (such as the target floppy drive), include
them on the Command Line, then click OK or press Enter. You will be prompted
to insert each diskette (dont forget to mark the diskette with its sequence number
before inserting it in the floppy drive
2.
Use the Explorer to locate DKS2FLPY.EXE in the correct directory for your
platform.
3.
4.
Make sure you have the correct distribution (Intel or Alpha) for your target platform.
2.
3.
4.
Run setup.exe. You will be prompted to insert the rest of the diskettes as they are
needed.
Note: If you think a diskette is not in the correct sequence, you can verify its order by
displaying the diskette contents in the File Manager. You should find a file named DISK<n>
where <n> is the sequence number of the diskette.
GFK-1180H
A-5
Note: Before you remove CIMPLICITY HMI software from your computer, you should save
any projects that you dont want to lose. You can save them on diskette, or in a nonCIMPLICITY directory.
2.
3.
4.
Select Add/Remove.
5.
A-6
1.
2.
Select Settings.
3.
4.
5.
6.
Select Add/Remove.
7.
GFK-1180H
.OUT and .ERR files for all CIMPLICITY HMI processes other than
user processes
GFK-1180H
B-1
Select the Status Log icon from the CIMPLICITY HMI menu.
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
Status
Process
Procedure
Source
Code
The primary value used by software for expressing the type of error.
Reference
Message
Each entry in the list is preceded by a color-coded dot that corresponds to the Status
field entry. The correlations are:
B-2
Red - Failure
Yellow - Warning
Green - Success
GFK-1180H
The Procedure, Source, Reference, and Code fields are primarily for GE Fanuc
use and should be reported if you are contacting GE Fanuc for troubleshooting
assistance.
The list of messages is initially sorted in descending order (newest to oldest) by
Date/Time. You can click on any of the column title buttons to sort the messages
alphanumerically by that message attribute. For example, if you want to view all the
messages generated by the MAC_PTDL process, click the Process button, and all
the messages generated by MAC_PTDL will be grouped together.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
The system Status Log if you select the Status Log icon from the
CIMPLICITY HMI main menu.
The project Status Log, if you select Status Log from the Tools
menu or press Ctrl+L in the Workbench for a project.
GFK-1180H
If you select the Status Log icon from the CIMPLICITY HMI main
menu, the last Status Log file you looked at (project or system) will
automatically be displayed.
If you select Status Log from the Tools menu or press Ctrl+L in the
Workbench for a project, the projects Status Log file will automatically
be displayed.
B-3
Select Log
Save as Text...
Print...
Print Preview...
Print Setup...
Exit
B-4
All Entries
Filter Entries...
Find...
GFK-1180H
Find Next
Detail...
Live Update
Refresh
Toolbar
Status Bar
Save
GFK-1180H
Ctrl+P
F3
Finds the next Status Log message that fits the search criteria.
Ctrl+D
Ctrl+L
Ctrl+R
B-5
Select View System Log from the Log menu to display the System
Status Log file.
Select Select Log from the Log menu to search for a log file to open.
If you do the latter, the Find CIMPLICITY Log File dialog box opens.
The Status Log Viewer can display CIMPLICITY HMI Status Log files of type
.CLG. You can search the directory structure on any drive you are connected to for
log files.
The default Status Log file name is COR_RECSTAT.CLG. Status Log files are
generally found in the log file for your main CIMPLICITY HMI log directory, and in
each of your projects log directories.
To display a log file:
B-6
1.
2.
Click OK.
3.
The dialog box closes, and the file you selected is displayed in the
CIMPLICITY Log Viewer window.
GFK-1180H
Select the message, and then select Detail from the View menu.
The Detail dialog box opens and displays the details for the message you selected.
GFK-1180H
Date
Time
Status
Code
The primary value used by the software for expressing the type
of error.
PID
Process
Procedure
Source:
Reference
Error Message
B-7
Status
Code
Process
Procedure
Source
Reference
Error Message
Select Next to display the next message in the log file. If you are at the
last message in the file, you will be asked if you want to continue from
the beginning.
Select Previous to display the previous message in the log file. If you
are at the first message in the file, you will be asked if you want to
continue from the end.
Select Close to close the dialog box and return to the Log Viewer
screen.
To create a text file, select a pathname and file name for the text file and click OK.
The first line of the text file shows the computer name and the full path name for the
Status Log file.
B-8
GFK-1180H
Print Range
Copies
Enter the number of copies you want printed in this input field.
Print to file
Set this check box if you want to save the printout in a file in
addition to printing.
GFK-1180H
B-9
To set up your printer configuration, select Print Setup from the Log
menu.
Size
Displays the currently selected paper size. You can click the
drop-down list button to the right of the input field to display
a list of available paper sizes and select one of them.
Source
Orientation
B-10
GFK-1180H
Lets you enable/disable filtering for message status. You may select
one or more status types.
If you select no status types, you will see no messages.
Process
Lets you enable/disable filtering by process name. Click the dropdown list to the right of the input field to display the list of
processes currently in the log file that you can select.
Procedure
Lets you select the procedure name(s) to filter for. You can enter an
entire procedure name, or the first n characters.
Source
Lets you enable/disable filtering by source name. Click the dropdown list to the right of the input field to display the list of sources
currently in the log file that you can select.
Reference
Lets you select a reference number to filter for. You must enter the
exact reference number.
Code
Lets you select a code to filter for. You must enter the exact code.
You may use any combination of filter entries in your filter request.
To filter the Status Log, click OK. The Log Viewer screen redisplays with the
filtered list of messages. If no messages match the filter you requested, the screen is
blank.
To close the dialog box without filtering, click Cancel.
To clear filtering and redisplay all Status Log messages, click Clear, and then click
OK.
GFK-1180H
B-11
Lets you search for messages by status. You may select one or
more status types.
If you select no status types, no messages will be found.
Process
Lets you search for messages by process name. Click the dropdown list to the right of the input field to display the list of
processes currently in the log file that you can select.
Procedure
Lets you search for messages by procedure name. You can enter an
entire procedure name, or the first n characters.
Source
Lets you search for messages by source name. Click the drop-down
list to the right of the input field to display the list of sources
currently in the log file that you can select.
Reference
Lets you search for messages by reference number. You must enter
the exact reference number.
Code
Lets you search for messages by code. You must enter the exact
code.
Direction
You can choose the direction to search in from your current location
in the Status Log. Click Up to search previous messages. Click
Down to search next messages.
You may use any combination of filter entries in your filter request.
B-12
GFK-1180H
To locate the entry in the Status Log, click Find Next. The dialog box closes, and
the next message in the Status Log that matches the filter is highlighted. If no
message is found, the highlight remains at the current message.
Note
The Find and Find Next options will not wrap around the message list when they
reach either end.
For example, if you are searching Down and you are already at the end of the
message list, when you activate the search, you will not be asked if you wish to
continue from the beginning of the list.
To close the dialog box without finding a message, click Cancel.
To clear the filters, click Clear, and then click OK.
B-13
2.
Use the Explorer to check for any non-zero length .ERR and .OUT
files in the main log directory.
3.
B-14
Filename
Associated Process
AB_ETH<n>
COM0<n>
MAC_AM
Alarm Manager
MAC_DL
Data Logger
MAC_DYN
Dynamic Configuration
MAC_EMRP
MAC_PTDL
MAC_PTDP
MAC_PTM
Point Manager
MAC_PTX
Point Translation
MAC_UR
User Registration
PB
Point Bridge
PCIM<n>
TCPIP<n>
GFK-1180H
TCPRD<n>
W32RTR
Message Router
In addition to these files, you may also find files for alarm log printers and device
communication drivers.
To view the contents of an .ERR or .OUT file:
1.
2.
Use the Explorer to check for any non-zero length .ERR and .OUT
files in the projects log directory.
3.
GFK-1180H
B-15
Index
#
#ERROR!ARRAYNOTALLOWED 38-6
#ERROR!ARRAYOUTOF BOUNDS 38-6
#ERROR!BADSERVERRESPONSE 38-6
#ERROR!CIMPLICITYNOTRUNNING 38-6
#ERROR!INVALIDPOINTID 38-7
#ERROR!NOTIMPLEMENTED 38-7
#ERROR!NOTLICENSED 38-7
#ERROR!POINTIDSYNTAX 38-7
#ERROR!POINTUNAVAILABLE 38-7
#ERROR!SERVERNEEDSRESTART 38-7
#ERROR!URLEXCEPTION 38-7
$
$ALARM.ACKED 10-8
$ALARM.ACTIVE 10-9
$ALARM.TOTAL 10-8
$ALARM.UNACKED 10-9
$ALARM_DISABLED 17-2
$ALARM_ENABLED 17-2
$ALARM_MODIFIED 17-2
$ALARM_RAWLIM 17-2
$ALARM_RESTORED 17-2
$AM_STATUS 17-2
$CLASS_<Alarm class name>.ALARMS 10-9
$CLASS_<Alarm class name>.UNACKED 10-9
$DEV_DOWN 17-2
$DEVICE 17-2
$DEVICE_DOWN 17-2
$DEVICE_FAILOVER 17-2
$DL_FILE_FULL 17-2
$DOWNLOAD 17-2
$DYN_CFG 17-2
$GMR_POINT_DISCREPANCY 17-2
$LOCAL.COMPUTER 10-1
$LOCAL.DATE.AMPM 10-8
$LOCAL.DATE.DAY 10-6
$LOCAL.DATE.DAYOFYEAR 10-6
GFK-1180H
$LOCAL.DATE.HOUR 10-7
$LOCAL.DATE.HOUR12 10-7
$LOCAL.DATE.MINUTE 10-7
$LOCAL.DATE.MONTH 10-6
$LOCAL.DATE.SECOFDAY 10-8
$LOCAL.DATE.SECOND 10-7
$LOCAL.DATE.WEEK 10-7
$LOCAL.DATE.WEEKDAY 10-6
$LOCAL.DATE.YEAR 10-6
$LOCAL.DATETIME 10-5
$LOCAL.WINUSER 10-1
$LOGON 17-3
$LOGOUT 17-3
$PROJECT 10-2
$PROJECT.AVAILABLE 10-2
$PROJECT.COMPUTER 10-2
$PROJECT.DATE.AMPM 10-5
$PROJECT.DATE.DAY 10-3
$PROJECT.DATE.DAYOFYEAR 10-4
$PROJECT.DATE.HOUR 10-4
$PROJECT.DATE.HOUR12 10-4
$PROJECT.DATE.MINUTE 10-5
$PROJECT.DATE.MONTH 10-3
$PROJECT.DATE.SECOFDAY 10-5
$PROJECT.DATE.SECOND 10-5
$PROJECT.DATE.WEEKDAY 10-4
$PROJECT.DATE.YEAR 10-3
$PROJECT.DATETIME 10-3
$PROJECT.DDATE.WEEK 10-4
$PROJECT.DEVICES 10-2
$PROJECT.LOGGEDIN 10-2
$PROJECT.USERS 10-3
$REDUND_DEV_DOWN 17-3
$RTR_LINK_DOWN 17-3
$USER.ALARMS 10-8
%
%% 8-13
%DEV_AMT 8-13
%DEV_VAL 8-13
%EU 8-13
%ID 8-13
%LIMIT 8-13
%STATE 8-13
%VAL 8-13
.
.GEF
File 2-16
/
/alwaysmaximized
CimView command line option 31-17
/geometry
CimView command line option 31-18
/keypad
CimView command line option 31-18
/LoadScript
CimView command line option 31-18
/noconfig
Alarm viewer command line options 30-37
/noexit
CimView command line option 31-19
/nomenutitle
CimView command line option 31-19
/noopen
Alarm viewer command line options 30-37
CimView command line option 31-19
/noresize
CimView command line option 31-19
/project <name>
CimView command line option 31-20
/wait 31-20
/waitforproject
CimView command line option 31-20
/zoomtobestfit
CimView command line option 31-20
{
{Procedure
Quick enable of a protocol for a project 5-2
3
3D_BCD 6-4
4
4D_BCD
Device point 6-4
A
About
Alarm audio support 18-1
Alarm blocking 19-1
Alarm printer configuration 20-1
Alarm sound manager 18-5
Alarms 17-1
AMV OCX 28-1
AMV OCX methods 29-1
CIMPLICITY HMI and Control 26-1
CIMPLICITY HMI log files B-1
ii
GFK-1180H
Add
Fields to display 2-13
Subsystems to PtXRef database 11-11
Add project to list
CIMPLICITY options 3-14
Adding
Saved logins 34-15
Adding a new user to a resource 13-4
Adding a user to a resource 13-4
Adding alarm comments
Alarm viewer 30-25
AMV OCX 28-25
Adding an alarm
Alarm block group 19-6
Adding an Alarm printer 20-2
Adding the point to a logging table
Database logger, from point configuration 23-9
ADDR 27-15, 27-34
ADDR_OFFSET 27-16
ADDR_TYPE 27-16
Address
Custom for a diagnostic point 6-12
Specifications for a device point 6-8
Standard domain 6-12
Addressing
Procedure for 6-8
Advance
Device point configuration 6-13
Advanced
Alarm tabs 8-11
Device specifications for device points 6-18, 7-15
General specifications for device points 6-13
General specifications for virtual points 7-10
Virtual point configuration 7-10
Alarm 29-4
Enabled for a device point 6-15
Enabled for a virtual point 7-11
Logs for device points 6-17
Logs for virtual points 7-14
Point control panel, properties 32-4
Alarm assignment
Alarm blocking 19-2
Alarm Attributes
Alarm Id 17-5
Alarm Type 17-5
Class Id 17-5
Description 17-5
Message 17-5
Alarm audio support
About 18-1
Beep configuration 18-4
Configuring 18-3
Prioritizing alarms 18-1
Prioritizing alarms, examples 18-2
Wave file configuration 18-4
GFK-1180H
Index
iii
Alarm Definitions
Standard Alarms 17-2
Alarm filtering
Changing setup parameters 28-23
Alarm list, Filtering
Database logger 23-55
Alarm logging
Database logger properties 23-42
Overview 23-2
Alarm logging dialog box
Database logger, From point configuration 23-10
Alarm message
Variable run-time parameters 17-1
Alarm message date/time format
Alarm viewer 30-18
Alarm Options Properties 17-14
Acknowledge Timeout 17-16
Deletion Requirements 17-15
Repeat Timeout 17-15
Reset Timeout 17-16
Alarm printer configuration 20-1
About 20-1
Adding an alarm printer 20-2
Additional steps for serial printers 20-10
Alarm printer properties 20-3
Date/time format properties 20-7
Date/time formats 20-8
Delete and acknowledge times 20-12
General properties 20-3
Layout properties 20-6
Modifying queue size 20-11
More about redundant alarm printers 20-9
Alarm priorities
Alarm blocking 19-2
Alarm properties
Run-time 17-4
Alarm report
Database logger 23-59
Database logger, Generating 23-61
Database logger, setting parameters 23-60
Alarm Report
Database logger, Clearing error log 23-61
Alarm Routing Properties 17-12
Adding a new Role 17-13
Adding a Role 17-13
Modifying a Role 17-13
Removing a Role 17-13
Alarm setups
Changing at run-time 30-24
Changing sort order 30-32
Creating 28-33
Creating a new setup 30-33
Declaring a default setup 28-34, 30-33
Default for project 28-29
Default, using 28-35
iv
Deleting 28-34
Deleting a setup from the list 30-33
Filtering by state 28-32
Filtering by time 28-32, 30-32
Loading 28-29, 30-29
Modifying 28-30, 30-30
Modifying the class list 28-30, 30-30
Modifying the resource list 28-31, 30-31
Saving 28-33
Saving the current setup 30-33
Alarm setups, Filterying by State 30-32
Alarm sound manager
About 18-5
Adding a project 18-7
Adding a project, Examples 18-8
Deleting a project 18-8
Option properties 18-9
Profile, saving and loading 18-6
Project properties 18-7
Startup properties 18-10
Turning sound on and off 18-6
Using 18-5
Window buttons, using 18-6
Alarm String Configuration 16-1
Creating A New Alarm String 16-3
Alarm Strings
About 16-1
Configuring 16-2
Alarm table point
Point properties 23-54
Alarm triggered logging
Database logger, Logging conditions 23-23
Alarm viewer
Acknowledging all alarms 30-27
Acknowledging an alarm 30-26
Acknowledging the first alarm 30-27
Adding alarm comments 30-25
Alarm message date/time format 30-18
Alarm setups 30-28
Changing setup parameters 30-24
Command line options 30-36
Command line options - /noconfig 30-37
Command line options - /noopen 30-37
Configure menu 30-4
Configuring an alarm view 30-5
Configuring the count color 30-7
Configuring the count font 30-8
Configuring the count layout 30-5
Copying alarms 30-34
Creating a document shortcut 30-35
Creating a new setup 30-33
Creating a shortcut from 30-35
Creating a shortcut from the file manager 30-36
Creating custom buttons 30-20
Creating custom buttons, Example 30-21
GFK-1180H
GFK-1180H
Index
MoveUpOneAlarm 29-6
naming an alarm viewer control 29-1
PageDownAlarms 29-6
PageUpAlarms 29-6
SelectAllAlarms 29-6
SelectPageAlarms 29-6
SelectTopAlarm 29-6
Alarm Viewer OCX See AMV OCX
ALARM_ENABLED 33-6
ALARM_HIGH 33-5
ALARM_LOW 33-5
Alarms
About 17-1
Absolute 8-18
Advanced tab 8-11
Basic limits 8-10
Basic message 8-10
Class and alarm message 8-13
Class configuration 8-14
Configuring 17-5
Deadband 8-23
Define advanced message 8-13
Definition 8-12
Delay 8-22
Deletion 8-28
Deviation 8-19
Help file 8-23
Maximum stack 8-29
On update 8-19
Rate of change 8-20
Removing roles 8-24
Repeats 8-26
Roles assigned to 8-24
Routing 8-24
Setting options 8-25
All subsystems
Option button 11-4
ALM_CLASS 27-16
ALM_CRITERIA 27-16
ALM_DEADBAND 27-17
ALM_DELAY 27-17
ALM_HIGH_1 27-17
ALM_HIGH_2 27-17
ALM_HLP_FILE 27-17
ALM_LOW_1 27-18
ALM_LOW_2 27-18
ALM_MSG 27-18
ALM_ROUTE_OPER 27-18
ALM_ROUTE_SYSMGR 27-18
ALM_ROUTE_USER 27-19
ALM_STR 27-19
ALM_TYPE 27-19
am_colors.cfg 15-6
AM_RESET_ACK_STATE 36-8
amlp_flush.exe 20-11
AMLP_MAX_QUEUE 20-11
AMLP_USE_GEN_TIME 20-12, 36-8
AMSI_ALARM 17-3
AMV OCX
About 28-1
Acknowledging all alarms 28-27
Acknowledging an alarm 28-25
Acknowledging and resetting an alarm 28-26
Acknowledging the first alarm 28-27
Adding alarm comments 28-25
Alarm setups 28-28
Buttons properties 28-7
Changing setup parameters 28-23
Colors properties 28-19
Configuration overview 28-1
Configuring 28-3
Configuring control properties 28-4
Count layout properties 28-15
Creating a new alarm setup 28-33
Creating custom buttons 28-20
Creating custom buttons, Example 28-21
Date format properties 28-16
Deleting alarm comments 28-25
Deleting an alarm 28-26
Displaying user help 28-23
Dynamic mode, About 28-2
Fields properties 28-5
Fonts properties 28-18
Projects properties 28-10
Refreshing the alarm list 28-23
Run-time overview 28-2
Selecting alarms from the list 28-22
Sort/display properties 28-11
Static mode, About 28-2
Toggling between lists 28-23
Using the alarm list buttons 28-23
Viewing alarm comments 28-24
Viewing the alarm list 28-22
Viewing the alarm stack 28-24
AMV OCX methods
About 29-1
Configuring 29-2
AMV OCXViewing the alarms CimView screen 28-25
Analog
Virtual point initialization 7-6
Analog Deadband 6-20
ANALOG_DEADBAND 27-19
appendCaption (Method)
WebGateway, Web data applet 38-8, 38-10
Application logging
Overview 23-4
Application source directory, Creating
Site wide installation 36-31
Arithemtic
Operators and custom conversion 6-31
vi
Arithmetic
Operators for expressions 7-41
Array
Limits for device points 6-7
Array Point Example - CWSERV 33-11
Arrays 6-6
And histogram points 7-30
Device arrays in CimEdit 6-6
Device arrays in CimView 6-6
Device arrays in database logger 6-6
Using for device points 6-6
Using for virtual points 7-5
Virtual arrays in Alarm Viewer 7-5
Virtual arrays in CimView 7-5
Virtual arrays in Database Logger 7-5
Virtual arrays in kCimEdit 7-5
Associate
CimView screen with a point 8-2
Associating folders with devices
CIMPLICITY HMI and Control 26-5
Association, Creating new
CIMPLICITY HMI and Control 26-5
Association, Deleting
CIMPLICITY HMI and Control 26-6
Association, Editing
CIMPLICITY HMI and Control 26-6
Automatic
Reset for an alarm 8-28
Automatic Actions
For alarms 8-26
Availability Triggers
For device points 6-16
For virtual points 7-12
Average Points 7-22
B
Base Engineering Units
For a device point 6-27
For a virtual point 7-36
Base Rate
And scan rate 6-20
Basic
Alarm limits 8-10
Device custom addressing 6-8
Device point configuration 6-3
Virtual point configuration 7-3
Basic Control Engine
Guideline for measurement units 35-18
Beep configuration
Alarm audio support 18-4
Before you start
RAS 37-3
Begin
Point cross reference 11-2
GFK-1180H
BEU
For a device point 6-27
For a virtual point 7-36
BFR_COUNT 27-19
BFR_DUR 27-20
BFR_EVENT_PERIOD 27-20
BFR_EVENT_PT_ID 27-20
BFR_EVENT_TYPE 27-20
BFR_EVENT_UNITS 27-20
BFR_GATE_COND 27-20
BFR_SYNC_TIME 27-21
Bitwise
Operators and custom conversion 6-31
Operators for expressions 7-42
Blank
Point cross reference window 11-3
Blocking modes
Alarm blocking 19-2
Blocking rules
Alarm blocking 19-3
BOOL 6-5
Boolean
Virtual point initialization 7-6
Browse
Open window 2-9
Browser Windows
Point search aids in the Workbench 9-4
Buffering
For device points 6-17
For virtual points 7-13
Build
Point cross reference database 11-3
Button
Build PtXRef database 11-3
View options 11-7
Buttons properties
AMV OCX 28-7
BYTE 6-5
C
CALC_TYPE 27-21
Calculation
Average points 7-22
Delta accum array 7-20
Delta accum points 7-17
Equation 7-16
Equation w/override points 7-32
Historgram 7-30
Max capture point 7-23
Min capture point 7-25
Timer/counter point 7-28
Trans high accum point 7-27
Value accum point 7-21
GFK-1180H
Index
Capabilities
Workbench 2-1
Categorize points 4-2
CE_MAX_DELAY 36-8
CE_MAX_THREADS 36-8
CE_THREAD_TIMEOUT 36-8
Change
Point through point cross reference window 11-11
Project in point cross reference window 11-13
Select existing record or file 2-26
Changing font colors
Point control panel 32-6
Changing the alarm setup
Alarm viewer 30-24
Changing the AMV OCX setup parameters 28-23
Changing view options
Show Users 34-6
Characters
Reserved when naming points 4-4
Check Box
Enable tree text view 11-7
Show only used points 11-7
Sort on 11-7
Choose
Fields 2-11
Cimedit Management of Animated Objects
Guideline for measurement units 35-16
CIMHOSTS.TXT
Configuring for RAS 37-13
CIMPLCIITY HMI and Control
Device properties, Actions 26-4
Device properties, Common point properties 26-4
Device properties, Import options 26-3
CIMPLICITY HMI
Customer support 1-2
Diskette license transfer A-3
Floppy disk installations A-4
Network license transfer A-2
Site wide installation procedure 36-31
CIMPLICITY HMI and Control
About 26-1
Associating folders and devices 26-5
Creating a new association 26-5
Device properties, Control 26-2
Import process 26-7
Import rules 26-7
Point conflicts, Incorrect information 26-10
Point conflicts, New point 26-9
Point conflicts, Resolving 26-8
Remote configuration 26-11
Remote configuration, Example 26-11
Supported device protocols 26-2
CIMPLICITY HMI and CONTROL
Deleting an association 26-6
vii
viii
GFK-1180H
GFK-1180H
Index
startup.exe 3-26
Command Line Options
CimView 31-17
Command Syntax for System Topic 33-12
Formats 33-12
Help 33-13
System 33-12
Topics 33-12
Common point properties
Device properties, CIMPLICITY HMI and Control
26-4
Compact
Width for an analog point 8-4
Components
WebGateway 38-3
Workbench 2-3
Computer
Transfer license from one to another A-1
Configuration
Device point overview 6-1
Dynamic 2-22
Dynamic for port 2-23
Dynamic restrictions for point 2-23
Update 2-22
Virtual point overview 7-1
Configuration Cabinet
Shortcut Keys 3-4
Toolbar Buttons 3-4
Configuration Import/Export See Import/Export
Configuration overview
AMV OCX 28-1
Configure menu
Alarm viewer 30-4
Configuring a stand-alone alarm viewer 30-2
Configuring additional locks
SQL Server 24-9
Configuring alarm audio support 18-3
Configuring alarm blocking 19-4
Configuring Alarm Strings 16-2
Configuring Alarms 17-5
Configuring AMV OCX in CimEdit 28-3
Configuring AMV OCX methods 29-2
Configuring an alarm view
Alarm viewer 30-5
Configuring automatic startup
RAS, Windows NT server 37-7
Configuring devices 12-1
Configuring point bridge points 36-48
Configuring ports 14-1
Configuring Resources 13-1
Configuring roles 21-2
Configuring the count color
Alarm viewer 30-7
Configuring the count font
Alarm viewer 30-8
ix
GFK-1180H
D
Data
Logs for device points 6-17
Logs for virtual points 7-14
Data logging
Overview 23-3
Data report
Database logger 23-62
Database logger, Clearing error log 23-64
Database logger, Generating 23-64
Database logger, Setting parameters 23-63
Data table point
Point properties 23-51
Data triggered logging
Database logger, Logging conditions 23-23
GFK-1180H
Index
Data Type
3D_BCD 6-4
4D_BCD 6-4
Bool 6-5
BYTE 6-5
Device point 6-4
DINT 6-4
DWORD 6-5
INT 6-4
REAL 6-4
SINT 6-4
STRING 6-5
STRING_20 6-5
STRING_8 6-5
UDINT 6-4
UINT 6-4
USINT 6-4
Virtual point 7-4
WORD 6-5
Database
Point cross reference 11-3
Database disconnect recover
Database logger 24-13
Database disconnect recover, Enabling store and
forward 24-14
Database disconnect recover, Reconnect wait
period 24-13
Database disconnect recover, Store and forward 24-13
Database disconnect recover, Store and forward maximum records 24-15
Database disconnect recover, Store and forward
filenames 24-14
Database disconnect recover, Store and forwared changing defaults 24-15
Database logger 23-1, 23-36
About 23-1
Adding points to a table 23-49
Alarm list, Filtering 23-55
Alarm logging, Overview 23-2
Alarm point, Modifying logging conditions 23-54
Alarm point, Point properties 23-54
Alarm report 23-59
Alarm report, Clearing error log 23-61
Alarm report, Generating 23-61
Alarm report, Setting parameters 23-60
Application logging, Overview 23-4
Copying a table 23-36
Creating tables 23-5, 24-11
Creating tables, Column definitions 23-6, 24-11
Creating tables, Key definitions 23-7, 24-12
Creating tables, Microsoft Access note 24-11
Data logging, Overview 23-3
Data point
Timed/gated logging 23-53
Data point, Alarm triggered logging 23-52
xi
xii
GFK-1180H
GFK-1180H
Index
About 24-1
Database management
SQL server 24-9
SQL server, Configuration additional locks 24-9
SQL server, Handling transaction log 24-10
SQL server, Truncating transaction log as
CIMPLICITY maintenance action 24-10
SQL server, Truncating transaction log as system
default 24-10
Database queue size
Database logger, Properties 23-41
Date format properties
AMV OCX 28-16
Date/time format properties
Alarm printer configuration 20-7
Date/time formats
Alarm printer configuration 20-8
DB_CONN_DOWN 17-3
DB_DEBUG 24-17, 36-9
DB_ENABLE_TRANSACTIONS 24-18, 36-10
DB_QUEUE_OVERFLOW_DELAY 36-10
DB_QUEUE_SIZE 36-3
DB_START_FORWARD 17-3
DB_TIME_FORMAT 24-18
DB_TIMESTAMP_PRECISION 36-10
DBDL_ABORT_TIMEOUT 36-9
DBDL_DEVICE_CHECK_PERIOD 36-2
Deadband
And alarms 8-23
Declaring a default alarm setup
AMV OCX 28-34
Declaring a default setup
Alarm viewer 30-33
Default alarm setups
Using 28-35
Default logging conditions
Alarm log table 23-21
Default User 22-1
Defining a resource
Properties 13-3
Defining the alarm count layout
Alarm viewer 30-5
Defining the alarm list layout
Alarm viewer 30-9
DEL_OPT 36-10
Delay
Alarms 8-22
Delete Alarm privilege 21-4
Delete and acknowledge times, Modifying
Alarm printer configuration 20-12
DELETE_REQ 27-22
Deleting a setup from the list
Alarm viewer 30-33
Deleting a table
Database logger 23-37
xiii
xiv
DINT 6-4
Disable
Device point 6-15
Device point alarm 6-15
Virtual point 7-11
Virtual point alarm 7-11
Disabling the Microsoft network login prompt
Windows 95, CimView autostart 3-16
Disk full scan rate
Database logger, Properties 23-41
Diskette
Replacement A-4
DISP_FORMAT 33-4
DISP_HIGH 33-5
DISP_LIM_HIGH 27-23
DISP_LIM_LOW 27-23
DISP_LOW 33-5
DISP_WIDTH 27-23
Display
Advanced group of alarm tabs 8-11
Fields in right pane 2-11
Files 2-7
Options in Workbench 2-5
Records 2-7
View tab 8-3
Workbench 2-3
Display High/Low
Analog point limits 8-6
Displaying a Screen
CimView 31-10
Displaying a table
Database logger 23-45
Displaying a table list
Database logger, from point configuration 23-11
Displaying CimView Help Information 31-15
Displaying CimView Object Help 31-16
Displaying CimView Object Properties 31-17
Displaying CimView Screen Help 31-15
Displaying CimView Screen Properties 31-16
Displaying Point Data with CWSERV 33-6
Displaying point properties
Point control panel 32-3
Displaying point properties, Alarm
Point control panel 32-4
Displaying point properties, Details
Point control panel 32-3
Displaying points
Point control panel 32-2
Displaying status log message details B-7
Displaying table attributes
Database logger, from point configuration 23-10
Displaying user help
Alarm viewer 30-24
AMV OCX 28-23
Distribution
GFK-1180H
GFK-1180H
Index
E
Edit
Point through point cross reference window 11-11
Select existing record or file 2-26
Edit menu
Alarm viewer 30-3
Login panel 34-11
ELEMENTS 27-23, 27-34, 33-4
EMEP_BUF_SIZE 36-11
Empty
Point cross reference window 11-3
Enable
Analog display configuration guide 8-5
Device point 6-15
Device point alarm 6-15
Virtual point 7-11
Virtual point alarm 7-11
Enable Tree Text View
Check box 11-7
ENG_UNITS 27-23
Enterprise properties
Remote project 36-47
Enterprise Server
And Setpoint security guidelines 4-6
Equal
Trigger point 6-19
EQUATION 27-24
Equation Points 7-16
Equation w/override points 7-32
Error log, Clearing
Database logger, Alarm report 23-61
Database logger, Data report 23-64
Database logger, Trend report 23-67
Error messages
WebGateway 38-6
WebGateway,
#ERROR!ARRAYNOTALLOWED 38-6
WebGateway,
#ERROR!ARRAYOUTOFBOUNDS 38-6
WebGateway,
#ERROR!BADSERVERRESPONSE 38-6
WebGateway,
#ERROR!CIMPLICITYNOTRUNNING 38-6
WebGateway, #ERROR!INVALIDPOINTID 38-7
WebGateway, #ERROR!NOTIMPLEMENTED 38-7
WebGateway, #ERROR!NOTLICENSED 38-7
xv
F
Failures 6-11
Field
Chooser 2-11
Need update 2-21
Select for display 2-13
xvi
GFK-1180H
Alarm 7-40
Further configuration
RAS, Windows NT server 37-7
Windows NT client 37-11
FW_CONV_EQ 27-24
G
GE FANUC
Hotline 1-2
General
Basic virtual point information 6-3, 7-3
General configuration information
Alarm viewer 30-17
General properties
Alarm printer configuration 20-3
Device 12-4
Remote project 36-46
getCaption (Method)
WebGateway, Web data applet 38-8
getPointStatus (read only property)
WebGateway, Web data applet 38-11
getPointValue (read only property)
WebGateway, Web data applet 38-11
Getting started
Point control panel 32-1
Getting Started
CimView 31-1
Global parameters 36-1
ACK_TOUT 36-7
AM_RESET_ACK_STATE 36-8
AMLP_USE_GEN_TIME 36-8
CE_MAX_DELAY 36-8
CE_MAX_THREADS 36-8
CE_THREAD_TIMEOUT 36-8
CLR_TOUT 36-9
CONNECT_DROP_PERIOD 36-5
CONNECT_RETRY_PERIOD 36-5
Database logger 24-16
DB_DEBUG 24-17, 36-9
DB_ENABLE_TRANSACTIONS 24-18, 36-10
DB_QUEUE_OVERFLOW_DELAY 36-10
DB_QUEUE_SIZE 36-3
DB_TIME_FORMAT 24-18
DB_TIMESTAMP_PRECISION 36-10
DBDL_ABORT_TIMEOUT 36-9
DBDL_DEVICE_CHECK_PERIOD 36-2
DEL_OPT 36-10
Device communications 36-20
DONT_VERIFY_ESPOINT_FRID 36-11
DOWNLD_PASSWD 36-3
Editing 36-2
EMEP_BUF_SIZE 36-11
GMR_HRTBT_TIMER 36-3
GMR_MODE_ADDR 36-3
GFK-1180H
Index
GSM_ANNUN_ALARM_H1 36-12
GSM_ANNUN_ALARM_H2 36-12
GSM_ANNUN_ALARM_L1 36-12
GSM_ANNUN_ALARM_L2 36-13
GSM_ANNUN_DIG_OFF 36-11
GSM_ANNUN_DIG_ON 36-12
GSM_ASC_FONT_NAME 36-13
GSM_ASC_FONT_SIZES 36-13
GSM_ASC_SCALE 36-13
GSM_CACHE_SIZE 36-14
GSM_EXPONENT_PRECISION 36-14
GSM_SPCONFIRM_DEFAULT 36-14
GSM_STALE_COLOR_KEY 36-15
GSM_UNAVAIL_COLOR_KEY 36-15
IPC_BCAST_INTERVAL 36-5
IPC_QUEUE_SIZE 36-6
LOG_OPT 36-16
LOGIN_RETRY_PERIOD 36-15
MAX_STACKED 36-16
MAX_TREND_BUF 36-16
Modified for all projects 36-5
Modified per project 36-7
Modified through configuration functions 36-2
PROJECT_ID 36-17
PTDL_QUANTIZATION 36-3
PTMDP_DO_EU_CONV 36-18
PTMRP 36-18
RAW_LIMIT_ALARM 36-18
REDUND_LINK_SLEEP 36-6
REPEAT_TOUT 36-18
RTR_ACCEPT_CONN 36-3
RTR_DISABLE_BCAST 36-3
RTR_MAX_OUTMESSAGE_COUNT 36-6
RTR_STANDALONE 36-4
Sample File 36-21
SETPOINT_SECURITY 36-4
SHORT_FILENAMES 36-19
STARTUP_TIMEOUT 36-4
SVC_RETRY_COUNT 36-19
SVC_RETRY_DELAY 36-19
SYSNAME 36-4
GMR_HRTBT_TIMER 36-3
GMR_MODE_ADDR 36-3
GR_SCREEN 27-24
Granting client dial-in permission
RAS, Windows NT server 37-8
Greater Than
Trigger point 6-19
Greater Than Equal
Trigger point 6-19
Group logging
Overview 23-4
Group table point
Point properties 23-50
GSM_ANNUN_ALARM_H1 36-12
xvii
GSM_ANNUN_ALARM_H2 36-12
GSM_ANNUN_ALARM_L1 36-12
GSM_ANNUN_ALARM_L2 36-13
GSM_ANNUN_DIG_OFF 36-11
GSM_ANNUN_DIG_ON 36-12
GSM_ASC_FONT_NAME 36-13
GSM_ASC_FONT_SIZES 36-13
GSM_ASC_SCALE 36-13
GSM_CACHE_SIZE 36-14
GSM_EXPONENT_PRECISION 36-14
GSM_SPCONFIRM_DEFAULT 36-14
GSM_STALE_COLOR_KEY 36-15
GSM_UNAVAIL_COLOR_KEY 36-15
H
Handling transaction log
SQL server 24-10
Help - CWSERV System Topic 33-13
Help File
And alarms 8-23
Help menu
Alarm viewer 30-4
Help Menu
CimView 31-7
Histogram Point 7-30
Hotline
Phone numbers 1-2
How client package distribution works 36-29
How Configuration Updates Are Handled 3-22
Dynamic Update 3-22
I
Icon
Point cross reference 11-2
ie_deflds.cfg 27-4
Changing information in 27-5
ie_formats.cfg 27-5
Changing information in 27-6
Import options
Device properties, CIMPLICITY HMI and Control
26-3
Import procedure
Import/Export 27-7
Import, Process
CIMPLICITY HMI and Control 26-7
Import, Rules
CIMPLCITIY HMI and Control 26-7
Import/Export 27-1
Configuration Files 27-4
Data file format 27-2
Deleting configuration data 27-12
Export field formats file 27-5
Export procedure 27-10
xviii
GFK-1180H
CONV_LIM_HIGH 27-21
CONV_LIM_LOW 27-21
CONV_TYPE 27-22
DELETE_REQ 27-22
DESC 27-22
DEVIATION_PT 27-22
DEVICE_ID 27-22
DISP_LIM_HIGH 27-23
DISP_LIM_LOW 27-23
DISP_WIDTH 27-23
ELEMENTS 27-23
ENG_UNITS 27-23
EQUATION 27-24
FW_CONV_EQ 27-24
GR_SCREEN 27-24
INIT_VAL 27-24
JUSTIFICATION 27-25
LOCAL 27-25
MAX_STACKED 27-25
MEASUREMENT_UNIT_ID 27-25
POLL_AFTER_SET 27-26
PRECISION 27-26
PROC_ID 27-26
PT_ENABLED 27-26
PT_ID 27-13
PT_ORIGIN 27-13, 27-27
PT_SET_INTERVAL 27-27
PT_SET_TIME 27-27
PT_TYPE 27-28
PTMGMT_PROC_ID 27-26
RANGE_HIGH 27-28
RANGE_LOW 27-28
RAW_LIM_HIGH 27-28
RAW_LIM_LOW 27-28
REP_TIMEOUT 27-29
RESET_ALLOWED 27-29
RESET_COND 27-29
RESET_PT 27-29
RESET_TIMEOUT 27-30
RESOURCE_ID 27-30
REV_CONV_EQ 27-30
ROLLOVER_VAL 27-30
SAFETY_PT 27-31
SAMPLE_INTV 27-31
SAMPLE_INTV_UNIT 27-31
SCAN_RATE 27-31
SETPOINT_HIGH 27-32
SETPOINT_LOW 27-32
TRIG_CK_PT 27-32
TRIG_PT 27-32
TRIG_REL 27-33
TRIG_VAL 27-33
UPDATE_CRITERIA 27-33
VARIANCE_VAL 27-33
VARS 27-34
GFK-1180H
Index
J
Job, Creating for CIMPLICITY HMI installation
Site wide installation 36-34
Justification
For an analog point 8-3
JUSTIFICATION 27-25
xix
L
Layout properties
Alarm printer configuration 20-6
Left
Justification for an analog point 8-3
Left Pane
Changing the view 2-5
Create new record or file from 2-25
In point cross reference window 11-6
LENGTH 33-4
Less Than
Trigger point 6-19
Less Than Equal
Trigger point 6-19
License
Transfer A-1
Transfer from one computer to another A-1
Licenses
Diskette transfer A-3
Network Transfer A-2
Limitations
RAS 37-15
Limits
Analog display 8-5
Array limits for device points 6-7
Basic alarm 8-10
Range 8-7
Setpoint 8-8
Tab 8-6
Linear Conversion for a device point 6-30
Linear Conversion for a virtual point 7-36
List
All files for an object 2-8
All points displayed in the Workbench 9-1
All records for an object 2-8
Customize point list in the workbench 9-1
Points in point cross reference 11-6
Resorting in point cross reference 11-6
Select points in the Workbench 9-2
Selected files for an object 2-8
selected records for an object 2-8
Loading an alarm setup
AMV OCX 28-29
Loading an alarm setup for display
Alarm Viewer 30-29
LOCAL 27-25
Log and error files
Viewing B-1
Log file format
Import/Export 27-6
Log file name
Import/Export 27-6
Log files
Types of 23-1
xx
LOG_OPT 36-16
Logging See Database logger
Logging an alarm
Database logger, from point configuration 23-10
Logging attributes
Alarm, event and application tables 23-25
Group and data tables 23-26
Logging conditions, Group and data tables 23-22
Logging in
Alarm viewer 30-22
Logging In 3-24
Logging in to a project
Login panel 34-13
Logging out of a project
Login panel 34-13
Logging properties
All tables 23-33
Logical
Operators and custom conversion 6-31
Operators for expressions 7-43
Logical names 36-22
CLIE_MAX_PTS 36-24
Editing the file 36-23
Logical names, Base system
Descriptions 36-24
Logicmaster 90 support
Import/Export 27-34
Login information
Deleting 36-24
Help Menu 34-12
Login panel 34-10
Edit menu 34-11
File menu 34-11
Help Menu 34-12
Logging in to a project 34-13
Logging out of a project 34-13
Managing saved logins 34-15
Menu options 34-11
Password, changing 34-14
Project Menu 34-11
Shortcut keys 34-12
Starting 34-10
Toolbar buttons 34-12
View Menu 34-12
Login password
Security features 36-36
Login! menu
Alarm viewer 30-3
LOGIN_RETRY_PERIOD 36-15
GFK-1180H
M
Maintain
PtXRef database 11-11
Maintenance action export path
Database logger, Properties 23-42
Maintenance actions
All tables 23-31
Maintenance events
All tables 23-27
Managing saved logins 34-15
Manual
Reset for an alarm 8-28
Manual Mode
Description 6-33
Mapping colors in RGB.DAT
Alarm class configuration 15-6
Max 7-13
Max Capture Point 7-23
Max Count
For a device point trend history 6-16
For a virtual point trend history 7-13
Max Duration
For a device point trend history 6-16
MAX_STACKED 27-25, 36-16
MAX_TREND_BUF 36-16
MCP_PROC_DOWN 17-3
Measurement System
Adding 35-4
Copying 35-5
Defining properties 35-4
Renaming 35-5
Measurement Systems
Configuring 35-2
Measurement Unit
Copying 35-9
Defining properties 35-6
Editing properties 35-7
Equivalent unit definition 35-7
Equivalent unit id 35-8
Forward equation 35-8
Justification 35-8
Precision 35-8
Renaming 35-10
Reverse equation 35-8
Type 35-9
Width 35-8
Measurement Units
About 35-1
Active measurement system, about 35-11
Configuring 35-2
Creating 35-6
Guidelines 35-13
Guidelines, Basic control engine 35-18
GFK-1180H
Index
xxi
N
Name
Finding 2-9
New project 2-15
Naming an alarm viewer control 29-1
Naming Points 4-3
Reserved words 4-3
Need Update
Point field 2-21
Network options
CIMPLICITY options 3-15
Network Printer
Flushing alarms 20-11
Networking considerations
RAS 37-14
RAS, Client has network card configured 37-14
New
Creating new device points 6-2
Creating virtual points 7-2
Project 2-14
Quick device setup 5-3
Record or file 2-25
New point conflicts
CIMPLICITY HMI and Control 26-9
New Project Options 3-1
None
Initialization option 7-6
Trigger point 6-19
xxii
O
Object
Display in left pane 2-5
ODBC configuration 24-2
Custom data sources 24-3
Data sources 24-2
Drivers 24-2
Microsoft Access data sources 24-4
Moving projects 24-3
Remote SQL Server data sources 24-6, 24-7
SQL Server client utilities, Installing 24-6
SQL Server data source, Configuring 24-6
SQL Server, Configuring 24-5
SQL Server, Installation 24-4
OLE Controls in CimView 31-21
On and Off
Manual mode 6-33
On Change
Trigger point 6-20
On Demand On Change 6-10
On Demand On Scan 6-9
On Scan 6-9
On Update alarming 8-19
Open
CIMPLICITY HMI browse windows 2-9
CimView screen 2-29
Different project in point cross reference
window 11-13
Field chooser dialog box 2-11
Multiple windows 2-4
Point cross reference 11-2
Point setup dialog box 4-5
Project 2-16
Quick Trend 2-32
Runtime windows 2-30
Workbench 2-2
Opening a project 3-3
Show Users 34-7
Operations
Overview for expressions 7-40
Operators
Arithmetic for expressions 7-41
Bitwise for expressions 7-42
Conversion for expressions 7-43
Logical for expressions 7-43
Relational
For expressions 7-43
Scientific for expressions 7-44
Valid for custom conversion 6-31
Option Button
All subsystems 11-4
Selected subsystems 11-4
Option properties
Alarm sound manager 18-9
GFK-1180H
Options
For alarms 8-25
Options Button
Select subsystems 11-12
Oracle
Using with database logger 24-8
Oracle configuration
Database logger 24-8
Oracle requirements
Database logger 24-8
Out of Range 7-45
Output and error files
System, Checking B-14
Output and error files, Project
Checking B-14
Overview
Advanced 7-10
Advanced device point configuration 6-13
Advanced device point specifications 6-18, 7-15
Alarm limit values 8-21
Alarms 8-9
Device point configuration 6-1
Expression operations 7-40
Point class 4-2
Point Cross Reference 11-1
Point cross reference window panes 11-4
Point type 4-2
Point View 8-2
Point view - limits and alarms 8-1
Quick device setup 5-1
Runtime access 2-28
Trigger update options for device point example 6-21
Trigger update options for virtual point example 7-34
Understanding points 4-1
Virtual Points 7-1
Workbench 2-1
Workbench point display 9-1
P
PageDownAlarms
Alarm viewer method 29-6
PageUpAlarms
Alarm viewer method 29-6
Pane
Left 2-5
Right 2-6
Panes
In point cross reference window 11-4
Left in point cross reference window 11-6
Workbench 2-3
GFK-1180H
Index
Parameters
Database logger properties 23-41
Database logger, Alarm report 23-60
Database logger, Data report 23-63
Database logger, Trend report 23-66
Password, Changing
Login panel 34-14
Phone numbers
Distributors 1-1
Phone Numbers
Hotline 1-2
Ping
RAS, Testing the connection 37-13
Ping, Client
RAS, Testing the connection 37-13
Ping, Server
RAS, Testing the connection 37-14
Point
Dynamic configuration restrictions 2-23
Invalid 11-6
Monitoring runtime values 2-31
Point alarm triggered logging 23-52
Point attributes to be logged 23-26
Point bridge
Configuring points 36-48
Point configuration details 36-48
Point Bridge
Device point restrictions 6-11
Point by Address privilege 21-4
Point configuration
Configuring point bridge points 36-48
Point bridge point configuration details 36-48
Point Configuration
In point cross reference 11-1
Point conflicts, Incorrect information
CIMPLICITY HMI and Control 26-10
Point conflicts, New point
CIMPLICITY HMI and Control 26-9
Point conflicts, Resolving
CIMPLICITY HMI and Control 26-8
Point control panel
About 32-1
Changing font colors 32-6
Displaying point properties 32-3
Displaying point properties, Alarm 32-4
Displaying point properties, Details 32-3
Displaying points 32-2
Getting started 32-1
Saving the document 32-7
Point Control Panel
Drag points into 2-32
Open 2-32
Point control panel alarm changes
Security audit trail 36-38
Point Cross Reference
xxiii
xxiv
Port Attributes
Description 14-2
Node 14-3
Port Id 14-2, 14-3
Protocol 14-3
Protocol Id 14-2
Port configuration
Changing protocols 14-5
Creating a new port 14-3
Port Configuration 14-1
Port General Properties
Description 14-4
Enable 14-4
Retry Count 14-4
Scan Rate 14-4
Ports
About 14-1
Configuring 14-1
Position
Of field in right pane 2-13
PRECISION 27-26
Print
Alarms on network printer additional steps 20-11
Printing alarms
Alarm viewer 30-34
Printing the status log file B-9
Prioritizing alarms
Alarm audio support 18-1
Prioritizing alarms, examples
Alarm audio support 18-2
PROC_ID 27-26
Procedure
Alarm class configuration 8-14
Associate a CimView screen with a point 8-2
Basic alarm configuration 8-9
Begin dynamic configuration 2-23
Begin dynamic configuration in the Database Logger
23-18
Configrue max capture point calculation 7-23
Configuration update 2-22
Configure a delta accum calculation 7-18
Configure a histogram calculation 7-30
Configure a min capture point calculation 7-25
Configure a timer/counter point 7-28
Configure a transhigh accum point 7-27
Configure absolute alarms 8-18
configure an equation point 7-16
Configure an equation w/override poinst 7-32
Configure automatic alarm acknowledgement 8-27
configure automatic alarm reset 8-28
Configure average calculation 7-22
Configure BEU for a device point 6-27
Configure BEU for a virtual point 7-36
Configure custom conversion for a device point 6-31
Configure deviation alarming 8-19
GFK-1180H
GFK-1180H
Index
xxv
Project Properties
Enable Project Broadcast 3-6
General 3-5
Options 3-5, 3-6
Protocols 3-5
Setting 3-5
Project setup
For WebGateway 38-3
Project Wizard
Adding a new device 3-9
Adding a new point 3-10
Adding a new port 3-7
Devices 3-8
Modifying a device 3-9
Modifying a point 3-10
Modifying a port 3-8
Points 3-10
Protocols and Ports 3-7
Removing a device 3-9
Removing a point 3-10
Step 1 of 3 3-7
Step 2 of 3 3-8
Step 3 of 3 3-10
Using 3-7
Project WIzard
Removing a port 3-8
PROJECT_ID 36-17
Projects properties
AMV OCX 28-10
Properties
Database logger 23-40
Viewing for point 11-10
Protocol
Changing for port 14-5
Quick enable in a project 5-2
PT_ENABLED 27-26
PT_ID 27-13, 27-34
PT_ORIGIN 27-13, 27-27
PT_SET_INTERVAL 27-27
PT_SET_TIME 27-27
PT_TYPE 27-28, 27-34
PTDL_QUANTIZATION 36-3
PTMDP_DO_EU_CONV 36-18
PTMGMT_PROC_ID 27-26
PTMRP 36-18
PtXRef
Add subsystems to 11-11
Build 11-3
Build database again 11-11
Rebuild database 11-12
Refresh point cross reference view 11-8
Staying current 11-11
xxvi
PtXRef Database
Full View 11-5
Text View 11-5
Tree View 11-5
Purge actions
Database logger, Maintenance actions 23-32
Q
Quality
Point support at runtime 6-33
Queue size, Modifying
Alarm printer configuration 20-11
Quick
Device setup 5-1
Port setup for a project 5-3
Quick Trend
Open 2-32
R
R1
And linear conversion 6-30
R2
And linear conversion 6-30
Range
Configuring limits 8-7
Range Low/High
Limits 8-7
RANGE_HIGH 27-28
RANGE_LOW 27-28
RAS
About 37-1
About the example 37-2
CIMPLICITY options, Server 37-14
Client setup, Windows 95 37-11
Client setup, Windows NT 37-9
Configuring automatic startup, Windows NT server
37-7
Configuring the CIMHOSTS.TXT file 37-13
Further configuration, Windows NT client 37-11
Further configuration, Windows NT server 37-7
Granting client dial-in permission, Windows NT
server 37-8
Installing, Windows NT client 37-9
Installing, Windows NT server 37-4
Limitations on support 37-15
Networking considerations 37-14
Requirements 37-3
Server setup, Windows NT 37-4
Testing the connection 37-13
Testing the connection, Ping 37-13
Testing the connection, Ping on client 37-13
Testing the connection, Ping on server 37-14
GFK-1180H
Rate of Change
Alarming 8-20
Raw Value
And linear conversion 6-30
RAW_LIM_HIGH 27-28
RAW_LIM_LOW 27-28
RAW_LIMIT_ALARM 36-18
And range limits 8-7
RAW_VALUE 33-3
REAL 6-4
Rebuild
PtXRef database 11-12
Reconciling a table
Database logger 23-38
Reconciling a table, Creating database fields
Database logger 23-39
Reconciling a table, Removing unused Microsoft
Access fields
Database logger 23-39
Reconciling a table, Removing unused Oracle fields
Database logger 23-39
Reconciling a table, Removing unused SQL Server
fields
Database logger 23-39
Reconnect wait period
Database logger, Database disconnect recover 24-13
Record
Create new 2-25
Finding its name 2-9
Select for display 2-7
Select to change 2-26
REDUND_LINK_SLEEP 36-6
Redundant alarm printers
More about 20-9
Ref Count 11-7
Referencing CWSERV from a Networked NT Client
33-15
Refresh
Screen in point cross reference window 11-8
Workbench window 2-4
Refreshing the alarm list
Alarm viewer 30-24
AMV OCX 28-23
Refreshing the process list 34-22
Registering CIMPLICITY HMI
Diskette license transfer A-3
Network license transfer A-2
Related
Operators and custom conversion 6-31
Relation
And trigger points 6-19
Relational
Operators for expressions 7-43
Releasing the program control connection 34-22
GFK-1180H
Index
xxvii
xxviii
Resources
About 13-1
Configuring 13-1
Responses 6-11
Restrictions
Database logger dynamic configuration 2-23
Device points 6-11, 6-20
Dynamic point configuration 2-23
Dynamic port configuration 2-23
On characters when naming points 4-4
On words when naming points 4-3
Remote project dynamic configuration 2-23
Retries 6-11
REV_CONV_EQ 27-30
Reverse
Custom device point conversion 6-31
Review
Point in point cross reference window 11-10
Right
Justification for an analog point 8-3
Right Pane
Changing the view 2-6
Field selection 2-11
Point cross reference window 11-10
Role Attributes
Role Id 21-2
Role configuration
Creating a new role 21-3
Role properties 21-3
Role Configuration 21-1
Role privileges
Delete Alarm 21-4
Dynamic Configuration 21-4
Modify Alarm Setups 21-4
Point by Address 21-4
Process Control 21-4
Script control 21-4
Security features 36-36
Set Point 21-4
Setpoint Audit Trail 21-4
Trigger event 21-4
Role properties 21-3
Roles
About 21-1
Assigned to view alarms 8-24
Configuring 21-2
Create new for viewing alarms 8-25
Removing from viewing alarms 8-24
ROLLOVER_VAL 27-30
Routing
Alarms 8-24
RTR_ACCEPT_CONN 36-3
RTR_DISABLE_BCAST 36-3
RTR_MAX_OUTMESSAGE_COUNT 36-6
RTR_STANDALONE 36-4
GFK-1180H
Run
CIMPLICITY HMI project 2-20
Runtime
Access overview 2-28
Availability triggers and device points 6-16
Availability triggers and virtual points 7-12
Monitor a points values 2-31
Notes for virtual points 7-45
Opening a CimView window 2-29
Opening windows 2-30
Point quality support 6-33
Unavailable values 8-7
Run-time overview
AMV OCX 28-2
S
Safety Points
For device points 6-15
For virtual points 7-12
SAFETY_PT 27-31
Sample CWSERV Commands 33-2
Sample reports, Install
Database logger 23-58
Sample Spreadsheets and Macros for CWSERV 33-10
Array point example 33-11
Single point example 33-10
SAMPLE_INTV 27-31
SAMPLE_INTV_UNIT 27-31
Saved
Initialization option 7-6
Saved logins
Adding 34-15
Managing 34-15
Removing 34-16
Saved or Initialized
Initialization option 7-6
Saving the current alarm setup
AMV OCX 28-33
Saving the current setup
Alarm viewer 30-33
Saving the document
Point control panel 32-7
Saving the layout
Alarm viewer 30-20
Saving the status log as a text file B-8
Scan Rate
And base rate 6-20
SCAN_RATE 27-31
Scientific
Operators for expressions 7-44
Width for an analog point 8-4
Screen Properties
CimView 31-16
Script control privilege 21-4
GFK-1180H
Index
xxix
xxx
Shortcut keys
Alarm viewer 30-4
Database logger, Main window 23-17
Status log viewer B-5
Shortcut Keys
CimView 31-9
Configuration Cabinet 3-4
Login panel 34-12
Show Users 34-6
Show Only Used Points
Check box 11-7
Help Menu 34-4
Search Menu 34-4
Show Users 34-2
Changing view options 34-6
Closing a project view 34-9
Help Menu 34-4
Menu options 34-3
Opening a project 34-7
Project Menu 34-3
Search Menu 34-4
Searching for user information 34-8
Shortcut keys 34-6
Starting 34-2
Toolbar buttons 34-5
View Menu 34-3
Window Menu 34-5
Window Menu 34-5
Single Point Example - CWSERV 33-10
SINT 6-4
Site wide installation
Creating application source directory 36-31
Creating job for CIMPLICITY HMI
installation 36-34
Creating SMS package for CIMPLICITY HMI
installation 36-33
Introduction 36-27
Site wide installation procedure
CIMPLICITY HMI 36-31
SIZE 33-4
SMS package
Creating for CIMPLICITY HMI site wide
installation 36-33
SNF file format 27-2
Sort
Points in point cross reference view 11-7
Sort/display properties
AMV OCX 28-11
Source
For points 4-2
SQL server
Configuring additional locks 24-9
Database management 24-9
Handling transaction log 24-10
GFK-1180H
GFK-1180H
Index
STARTUP_TIMEOUT 36-4
STATE 33-3
Static alarm list button layout
Alarm viewer 30-13
Static mode, About
AMV OCX 28-2
Status bar
In Workbench 2-4
Status Bar
CimView 31-3
Status log viewer
Displaying message details B-7
Filtering messages B-11
Finding messages B-12
Finding the next message B-13
Help menu B-5
Log menu B-4
Menu options B-4
Printing the log file B-9
Process names B-13
Saving status log as a text file B-8
Selecting a log to view B-6
Selecting a printer B-10
Shortcut keys B-5
Toolbar buttons B-5
Using B-2
View menu B-4
Which status log file gets displayed B-3
Stop
Project 2-21
Stop a project
CIMPLICITY options 3-13
Stopping a running process 34-21
Stopping all running processes 34-22
Store
Virtual point values 7-8
Store alarm comments
More about 17-4
Store and forward
Database logger, Database disconnect recovery 24-13
Database logger, Logging properties 23-34
Database logger, Properties 23-44
Store and forward, Changing defaults, Database
disconnect recovery 24-15
Store and forward, Enabling
Database logger, Database disconnect recovery 24-14
Store and forward, Filenames
Database logger, Database disconnect recovery 24-14
Store and forward, Maximum records
Database logger, Database disconnect recovery 24-15
STRING 6-5
String Index 8-13
STRING_20 6-5
STRING_8 6-5
xxxi
Support
Hotline 1-2
Point quality 6-33
Supported device protocols
CIMPLICITY HMI and Control 26-2
SVC_RETRY_COUNT 36-19
SVC_RETRY_DELAY 36-19
Switch
projects 2-20
SYSNAME 36-4
System - CWSERV System Topic 33-12
System boot options
CIMPLICITY options 3-15
System log and error files B-1
System management 36-1
About 36-1
Deleting login information 36-24
Global parameters See also Global parameters
Device communications 36-20
Modified for all projects 36-5
Modified per project 36-7
Modified through configuration functions 36-2
Global parameters, Editing 36-2
Global parameters, Sample File 36-21
Logical names, Descriptions 36-24
Removing CIMPLICITY Software, Removing
Windows 95 Registry Information 36-25
Removing CIMPLICITY Software, Removing
Windows NT Registry Information 36-26
Removing Registry Information 36-25
System parameters
Logical names See also Logical names
Logical names, Editing the file 36-23
System utilities
Using Program Control See Program control
System Utilities
About 34-1
Login panel See Login panel
Show Users See Show Users
T
Tab
Advanced alarm 8-11
Advanced device 6-18
Advanced general for device points 6-14
Advanced general for virtual points 7-10
Advanced virtual 7-10
Basic alarm 8-9
Basic device 6-8
Basic general for device points 6-3
Basic general for virtual points 7-3
Basic virtual 7-6
Conversion for device points 6-26
Conversion for virtual points 7-36
xxxii
Limits 8-6
View 8-3
Table attributes to be logged 23-25, 23-27
Table browser
Database logger, From point configuration 23-11
Table characteristics
Database logger 23-6, 24-11
Table list, Filtering
Database logger 23-35
Table properties
Database logger 23-20
Table, Adding points
Database logger 23-49
Table, Copying
Database logger 23-36
Table, Creating
Database loger 23-19
Table, Deleting
Database logger 23-37
Table, Reconciling
Database logger 23-38
Table, Removing points
Database loggger 23-49
Table, Renaming
Database logger 23-36
Testing the connection
RAS 37-13
Testing the connection, Ping
RAS 37-13
Testing the connection, Ping on client
RAS 37-13
Testing the connection, Ping on server
RAS 37-14
Testing the connections
WebGateway 38-4
Text
Virtual point initialization 7-7
Text View
In point cross reference 11-5
Review point information in text view pcr
window 11-10
Timed/gated logging
Database logger, Logging conditions 23-24
Timed/Gated Logging
Notes about 23-29
On dgital point state-gated only 23-29
Periodic/Synchronized/On digital point
state-gated 23-30
Synchronized/On digital point state-gated 23-30
Timed/gated maintenance events 23-28
TimedGated Logging
Periodic/On digital point state-gated 23-29
Timer/Counter Point 7-28
Title Bar
CimView 31-3
GFK-1180H
GFK-1180H
Index
U
UDINT 6-4
UINT 6-4
Uninstall A-6
Unsolicited 6-10
Unsolicited On Change 6-10
Update
Criteria for a device point 6-9
Project after a change 2-21
Update Criteria
And trigger function for device points 6-21
And trigger function for virtual points 7-34
UPDATE_CRITERIA 27-33
Used Points
Viewing 11-5
User Attributes
Role Id 22-2
User Id 22-2
User Name 22-2
User configuration 22-1
Creating a new user 22-4
Run-time login failures 22-3
Setting run-time user properties 22-3
User General Properties 22-5
Password 22-6
Password Needed 22-5
Role 22-5
User Name 22-6
User properties
Run-time 22-3
xxxiii
V
Valid
Operators and custom conversion 6-31
validating project connections
WebGateway 38-4
Validating web connections
WebGateway. 38-4
VALUE 33-3
Value Accum Point 7-21
Values
Store for virtual points 7-8
VARIANCE_VAL 27-33
VARS 27-34
View
A point in point cross reference 11-9
All files for an object 2-8
All records for an object 2-8
xxxiv
W
WARN_ENABLED 33-6
WARN_HIGH 33-5
WARN_LOW 33-5
Warning
Update 2-21
Wave file configuration
Alarm audio support 18-4
Web server requirements
WebGateway 38-2
WebGateway
About 38-1
Components 38-3
Error messages 38-6
Error messages,
#ERROR!ARAYNOTALLOWED 38-6
Error messages,
#ERROR!ARRAYOUTOFBOUNDS 38-6
Error messages,
#ERROR!BADSERVERRESPONSE 38-6
Error messages,
#ERROR!CIMPLICITYNOTRUNNING 38-6
Error messages, #ERROR!INVALIDPOINTID 38-7
GFK-1180H
Error messages,
#ERROR!NOTIMPLEMENTED 38-7
Error messages, #ERROR!NOTLICENSED 38-7
Error messages, #ERROR!POINTIDSYNTAX 38-7
Error messages, #ERROR!POINTUNAVAILABLE
38-7
Error messages,
#ERROR!SERVERNEEDSRESTART 38-7
Error messages, #ERROR!URLEXCEPTION 38-7
Installation procedure 38-2
Installing 38-1
Project setup for 38-3
Testing the connections 38-4
Troubleshooting and error messages 38-6
Troubleshoting custom HTML pages 38-6
Validating project connections 38-4
Validating web connections 38-4
Web data applet 38-8
Web data applet, appendCaption (Method) 38-8
Web data applet, clearPoints (Method) 38-10
Web data applet, getCaption (method) 38-8
Web data applet, getPointStatus (read only
property) 38-11
Web data applet, getPointValue (read only
property) 38-11
Web data applet, pointGet (Method) 38-8
Web data applet, pointSet (Method) 38-10
Web data applet, setCaption (method) 38-8
Web data applet, setPointID (Method) 38-10
Web server requirements 38-2
Whats Running 3-21
Which status log file gets displayed B-3
Width
Display for an analog point 8-4
Wild Card Characters
For finding points in the Workbench 9-3
Wildcards
Database logger 23-5
Window
Open browse 2-9
Open multiple 2-4
Point cross reference 11-2
Refresh 2-4
Window buttons
CimView 31-3
Window buttons, using
Alarm sound manager 18-6
Window Components
CimView 31-2
Window Pop-up Menu
CimView 31-8
Windows 95/98
Removing CIMPLICITY software from A-6
Windows NT
Removing CIMPLICITY software from A-6
GFK-1180H
Index
Wizard
Enable 2-18
WORD 6-5
Words
Reserved when naming points 4-3
Z
Zero
Justification for an analog point 8-3
xxxv