Professional Documents
Culture Documents
GE Fanuc Automation: CIMPLICITY HMI Plant Edition Base System
GE Fanuc Automation: CIMPLICITY HMI Plant Edition Base System
July 2001
GFL-005
Following is a list of documentation icons:
Warning notices are used in this publication to emphasize that hazardous voltages, currents,
temperatures, or other conditions that could cause personal injury exist in the equipment or
may be associated with its use.
In situations where inattention could cause either personal injury or damage to equipment, a
Warning notice is used.
Caution provides information when careful attention must be taken in order to avoid
damaging results.
ii
GFK-1180K
Preface
GFK-1180K
iii
Chapter 19. Configuring Alarm Strings: Explains how to configure alarm strings.
Chapter 20. Configuing Alarms: Explains how to configure alarms.
Chapter 21. Using Alarm Audio Support: Shows you how to configure audible alarms.
Chapter 22. Alarm Blocking Configuration: Shows you how to implement hierarchical alarm
blocking.
Chapter 23. Configuring the Alarm Printer: Shows you how to configure a printer to record alarm
messages.
Chapter 24. Configuring Roles: Explains how to configure roles.
Chapter 25. Configuring Users: Explains how to configure users.
Chapter 26. Configuring the Database Logger: Describes the Database Logger features and how to
configure tables and reports.
Chapter 27. Managing Database Logging: Provides ODBC and SQL configuration and management.
Chapter 28. Client Configuration: Shows you how to configure default logins for CIMPLICITY
HMI Viewers on client computers.
Chapter 29. Using CimView: Explains the features of the graphic screen viewer.
Chapter 30. Using the Point Control Panel: Shows you how to use the Point Control Panel to
display point information.
Chapter 31. Using Measurement Units: Explains measurement units and how to configure them.
Chapter 32. System Utilities: Describes the Show Users and Program Control features of the System
Utilities option.
Chapter 33. System Management: Discusses system management functions such as
Logical Names: Changing them
CIMPLICITY HMI Software: Removing the software from a computer.
Security Features: Setting a Login Password, Role Privileges, Setpoint Security,
Setpoint Password and Security Audit Trail.
OEM Key: Using the OEM key to temporarily convert a Runtime license to a
Development license
Remote Projects, Point Bridge and Enterprise Server: Configuring remote projects,
point bridges to remote projects and enterprise server projects.
Site Wide Installation: Using the Microsoft Systems Management Server (SMS) for sitewide installations of CIMPLICITY HMI software.
Appendix A. Using Global Parameters: Describes how to use the Global Parameters application and
lists and defines the global parameters for CIMPLICITY.
Appendix B. Using the CIMPLICITY to Windows Server (DDE): Discusses how to use CWSERV
with third-party software such as Microsoft Excel spreadsheets.
Appendix C: Using CIMPLICITY HMI with CIMPLICITY Control: Shows you how to import
variables from a Control folder into points in an HMI project.
Appendix D: Viewing CIMPLICITY Machine Edition Point Data: Describes how CIMPLICITY
HMI displays data collected from CIMPLICITY Machine Edition.
Appendix E. Import/Export Configuration: Documents the Import/Export utility.
iv
GFK-1180K
Appendix F. 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.
Appendix G. CIMPLICITY HMI Web Gateway: Shows you how to use this feature to let users
access your CIMPLICITY HMI data over the Internet.
Appendix H. Registering and Licensing CIMPLICITY Software: Provides the steps to register
CIMPLICITY software.
Appendix I. Removing CIMPLICITY Software: Describes how to remove CIMPLICITY software
from the Windows Registry.
Appendix J. Resolving Problems: Discusses how to use the Status Log Viewer and system log files to
find an resolve problems.
GFK-1180K
Contents
Welcome to CIMPLICITY HMI Plant Edition
1-1
2-1
GFK-1180K
Contents-vii
3-1
Understanding Points
4-1
5-1
6-1
Contents-viii
GFK-1180K
7-1
8-1
9-1
GFK-1180K
Contents
Contents-ix
10-1
Configuring Classes
11-1
Contents-x
GFK-1180K
12-1
13-1
14-1
Device Configuration
15-1
GFK-1180K
Contents
Contents-xi
Configuring Resources
16-1
Configuring Ports
17-1
18-1
19-1
Configuring Alarms
20-1
Contents-xii
GFK-1180K
21-1
22-1
23-1
GFK-1180K
Contents
Contents-xiii
Configuring Roles
24-1
Configuring Users
25-1
26-1
Contents-xiv
GFK-1180K
27-1
Client Configuration
28-1
GFK-1180K
Contents
Contents-xv
Using CimView
29-1
30-1
Contents-xvi
GFK-1180K
31-1
System Utilities
32-1
GFK-1180K
Contents
Contents-xvii
System Management
33-1
A-1
Contents-xviii
GFK-1180K
B-1
C-1
D-1
About CIMPLICITY HMI Plant Edition Integration of Machine Edition Point Data .......... D-1
Machine Integration Architecture.......................................................................................... D-2
Reviewing Enterprise Server Connectivity ............................................................. D-2
Reviewing Viewer Connectivity ............................................................................. D-3
Integrated Functionality ........................................................................................................ D-3
Reviewing how Point Data Integration Handles Product Variations....................... D-3
Setting up Machine Edition for Data Point Integration........................................... D-5
E-1
GFK-1180K
Contents
Contents-xix
F-1
G-1
Contents-xx
GFK-1180K
H-1
I-1
J-1
Index
GFK-1180K
Contents
Contents-xxi
GFK-1180K
(800) 648-2001
(352) 727979-1
(65) 566-4919
(610) 437-7932
(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
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-1180K
GFK-1180K
Set the Workbench display to meet your needs. See page 2-7.
Configure any record or file in your project by quickly opening the appropriate
dialog box or window. See page 2-28.
Access all runtime information directly through the Workbench. See page 2-32.
2-1
2.
Select Programs.
3.
Select CIMPLICITY.
4.
Expanded to
view all points
2-2
GFK-1180K
Workbench at a Glance
Within the Windows 98, 2000 and NT familiar environment, the CIMPLICITY
Workbench provides you with all the unique CIMPLICITY Power Tools you need to
create and manage your project with maximum efficiency.
Also, you will recognize some of the Workbenchs tools from your Windows 98, 2000
and NT toolbars and file menus.
Quick Overview of the CIMPLICITY Workbench Features
Left to right:
Dynamic
update
Stop project
Start project
Left to right:
Left to right:
Book Reader
Configuration update
Workbench Help
Status log
Right pane
Project properties
views
Project wizard
Search
Properties
Field
chooser
Screens
Points
Objects in
application
Application
Folder
Expand
the tree
Collapse
the tree
Status bar
Fields chosen for display
Files or records
associated with object
CIMPLICITY applications appear as folders in the left pane. You can open or
close the folders, to view or hide their contents.
When you open the folder you will see the icon for an application. You can
expand any icon with subordinate icons to display them also.
When you select an icon in the left pane, one or more of its records or files
display in the right pane. You control what the list displays including the:
Files or records
You can access many of the Workbenchs Power Tools on its tool bar. In
addition, you will find them in its menus, both on the menu bar, and popup
menus.
Tip: Place the cursor over any object in the Workbench to display a brief description of
what it does.
GFK-1180K
2-3
The status bar provides you with information that includes how many records are
retrieved, if the project is running, and if a specified task has been completed.
You can also use various combinations of keystrokes in the Workbench to perform
commonly used functions:
2-4
Ctrl+N
Ctrl+O
Ctrl+C
Ctrl+R
Ctrl+W
Ctrl+L
Alt+Spacebar
Alt+F4
Ctrl+Esc
GFK-1180K
Easily refresh the view in the Workbench in which you are working.
CIMPLICITY makes changes that are made to a project in any Workbench
window in every open version of that project. Refreshing your view insures that
what you are looking at is the current configuration.
2.
Select New>Window.
File Menu
Result: A new Workbench opens with the same project that displayed in the first
Workbench. You can easily open another project.
See page 2-Error! Bookmark not defined. for the procedures to open a CIMPLICITY
project.
GFK-1180K
2-5
2.
Select Refresh.
Result: The Workbench window displays the most current version of the displayed
CIMPLICITY project.
2-6
GFK-1180K
Simple lists.
Large icons.
Click to collapse
the tree.
Click to expand
the tree.
GFK-1180K
1.
2.
2-7
Large icons.
Tree view.
2.
List
Details
Large Icons
Tree
Method 2
Click the standard Windows 98, 2000 and NT button on the Workbench toolbar.
From left to right: List, Detail, Large Icons and Tree
view.
Result: The right pane view changes to reflect your choice.
Different Views in Right Pane
Large icon
List
Tree
Detail
2-8
GFK-1180K
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.
2.
GFK-1180K
2-9
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 displays a list of all the existing records or files for the selected icon
when you use either method.
Note: Whether you select a list of records or of files depends on the icon you select in the
left pane. For example, if you select Points in the left pane, you will select a list of
records in the right. If you select Screens in the left, you will select a list of files in the
right.
To view selected records (or files) for a selected icon:
2-10
1.
2.
GFK-1180K
Method 1
A. Click View on the Workbench menu bar.
B. Select Search.
Method 2
A. Place the cursor in the right pane.
B. Click the right mouse button.
C. Select Search on the popup menu.
GFK-1180K
2-11
Method 3
Click the Search button
The Search dialog box associated with the selected icon appears.
Search Dialog Box Example
This dialog box is for points.
3.
Open 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.
Result: The records or files you specify will display in the right pane until you
change your specifications.
2-12
Alarms
Devices
Points
Ports
Roles
Resources
Users
Workbenchs Explore tool for all search windows that request a file name.
GFK-1180K
CIMPLICITY Browsers
Throughout CIMPLICITY HMI you will find different buttons to open browsers that help
you find names or categories of records associated with a selected icon. They all appear in
the Workbench and are pointed out in the documentation when you need them.
Example
Button
GFK-1180K
2-13
A Windows 98, 2000 and NT Explorer window opens and displays the open
projects directory.
4. Use the Windows 98, 2000 and NT Explorer to find the type of files you are
looking for.
A. Open the folder with the file you are looking for. For example, open the
Screens folder for CimEdit files.
B. Select the file to include in the Workbenchs list.
5. Place the Windows 98, 2000 and NT Explorer window next to the Workbench.
6. Open the Search dialog box.
7. Type the name of the file in the Filename field.
Result: The appropriate entry appears in the Workbench right pane.
2-14
GFK-1180K
Open the Field Chooser dialog box using any one of several methods.
Step 2.
2.
Use any of the following methods to open the Field Chooser dialog box.
Method 1
A. Click View on the Workbench menu bar.
C. Select Field Chooser.
View Menu
Method 2
A. Click the right mouse button in the right pane.
C. Select Field Chooser from the popup menu.
Popup for Points
GFK-1180K
2-15
Method 3
Click the Field Chooser button
The appropriate Field Chooser dialog box opens when you use any of these
methods.
Select a field in the Available field column that you want to add to your display.
2.
Click Add. The field will move over to the Display fields column.
3.
Select any filed in the Display fields column that you do not want to display.
4.
Click Remove. The field will move over to the Available field column.
5.
Use the Move Up and Move Down buttons to change a selected field's place in
the list.
6.
Up
Down
Click OK. The fields display from left to right in the order you specified.
Example: A Points Field Chooser Dialog Box
Note: The Remove button is disabled if the field is required. The Move Down or
Move Up button is disabled if a field that will be affected by the move has to appear in
the furthest left position.
2-16
GFK-1180K
Stop a project.
Method 2
1.
2.
Select Run.
Method 3
Press Ctrl+R on the keyboard.
Method 4
1.
2.
Press R.
Click OK.
Result: The project starts running when you use any of these methods.
GFK-1180K
2-17
2.
3.
Note: Only projects that are running appear on this list. If no project is running, the
running Projects List option does not appear on the File menu.
File Drop Down Menu
Select a project
2-18
GFK-1180K
2.
3.
4.
5.
6.
Enter a name in the New Subdirectory field if you want it to be different from
the name that was automatically entered.
7.
Enter a unique
name
7.
Click to create
the project.
Click Create.
Result: The Workbench copies the existing project's entire configuration to the
new project. You can now open the new project and work with it.
GFK-1180K
2-19
2.
3.
4.
Click OK.
Result: The project's name is changed. The new name appears on the Workbench
title bar.
Rename Project: Example
Project name on
Workbench title bar.
1 Display the General tab
in the Project Properties
dialog box.
3 Click OK.
2-20
GFK-1180K
2.
Select Install.
The Create Shortcut dialog box opens.
3.
Select the folder (or create a new folder) in which you want the CIMPLICITY
HMI project to appear.
4.
Click OK.
Result: The project will appear on the Start menu in the folder you selected.
GFK-1180K
2-21
Method 2
1.
2.
Select Stop.
Method 3
2-22
1.
2.
Press S.
GFK-1180K
Classes.
Devices.
Objects.
Points.
Screens.
Dragging a Device from one Project to another: Example
2.
Select the item(s) you want in the first project's Workbench right pane.
Note: Press Shift to select adjacent multiple items. Press Ctrl to select any
multiple items.
GFK-1180K
2-23
3.
Drag the items to the correct location in the second project's Workbench.
If other points are associated with a dragged device, a message will ask if you
want to copy those items over also.
Example
If you accidentally drag the items to the wrong location, the items will not be
copied and you will see an error message.
Example (Message displayed when copying a screen to an incorrect location)
If you drag an item that has associated items that you have not configured in the
second project, the items will not be copied and a message will explain why.
Example
If points you are dragging already exist in the second project, a message will ask
you if you want to overwrite them.
Example
2-24
GFK-1180K
2.
Dynamic Configuration.
GFK-1180K
2-25
2.
Open the Field Chooser dialog box. See page 2-15 for details about opening the
Field Chooser dialog box.
3.
4.
To do a configuration update:
Method 1
1.
2.
Method 2
1.
2.
Press C.
2-26
GFK-1180K
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:
Important: There are some configuration procedures that have restricted functionality
in Dynamic Update mode. They are:
Application
Point Configuration
Cannot change:
Port Configuration
Retry count.
Remote Projects
Classes
To do dynamic configuration:
Method 1
Click the Dynamic button
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-1180K
2-27
Screens
The following:
Points
Devices
Ports
Users
Roles
Resources
Remote projects
Clients
2-28
Notepad
Microsoft Excel
Scripts
Database Logger
Options
GFK-1180K
2.
GFK-1180K
2-29
Method 3
A. Press ALT+F.
The drop down File menu opens.
B. Press N.
C. Press O.
Method 3
Press Ctrl+N on the keyboard.
Result: A new screen or appropriate new dialog box opens when you use any
of these methods.
Tip: If you want to use only the keyboard, you can also click the Arrow Up and/or
Arrow Down key to select the icon in the left pane of the Workbench.
2.
2-30
GFK-1180K
Method 4
A. Click the right mouse button.
A popup menu displays with menu items that reflect the selected object.
B. Select one of the following menu items:
Choose the
menu item
Edit
For
To Display
Screens
CimEdit screen
Points
Devices
Ports
Users
Roles
Resources
Measurement Units
Event Editor
Alarm Sound Manager
Script
Notepad
Microsoft Excel
Microsoft Access
Action Calendar
Properties
Open
Popups
GFK-1180K
2-31
Runtime Access
The Workbench provides you with access to all of CIMPLICITY HMI runtime
monitoring tools.
This includes letting you:
2-32
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.
GFK-1180K
Make sure your project is running. See page 2-17 for details.
2.
3.
4.
Result: The CimView screen you selected opens when you use either method.
GFK-1180K
Alarm Viewer
Login Panel
Show Users
2-33
Select the runtime icon in the left pane that you want to monitor.
Project is running.
2.
Double click it or use any of the other methods available to open a runtime
window. See page 2-33 for details about opening a CimView screen.
2-34
GFK-1180K
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-1180K
2-35
2.
Select the point in the right pane that you want to track.
3.
4.
Quick Trends
*.cim screens
The object you select opens displaying at least the selected points values.
2.
3.
4.
Hold the mouse button down and drag the selected items into the blank window.
5.
Note: CIMPLICITY HMI does not duplicate any of the dragged points that already exist
in the open Point Control Panel
2-36
GFK-1180K
Dragging Points from the Workbench into an Open Control Panel: Example
GFK-1180K
2-37
Project Opened
You can open a CIMPLICITY project through:
An open Workbench.
2.
Select Programs.
3.
Select CIMPLICITY.
4.
GFK-1180K
3-1
Method 2
1.
2.
Select Open.
Method 3
Press Ctrl+O on the keyboard.
Result: The Open dialog box opens for you to select the project you want to open.
Select CIMPLICITY Project to Open
3-2
GFK-1180K
Project Properties
You can configure properties for a project in the Project Properties dialog box. There are
several methods to open the Project Properties dialog box.
Method 2
1.
2.
Select Properties.
Method 3
Press Alt+P+P on the keyboard.
Result: The Project Properties dialog box opens when you use any method.
Use the Project Properties dialog box to choose or change General properties and Options
for a project.
GFK-1180K
3-3
General
Options
Settings
Important: The project name should be different from the node name.
Options
Select the options you want for this project from the list of available options. Set the
check box to select an option. Otherwise, clear the check box.
Protocols
Select the device communication protocols you want to use for this project from the list of
available protocols. Set the check box to select an option. Otherwise, clear the check
box.
3-4
GFK-1180K
Is only received and processed by computers that are listening for it.
Can potentially go through routers, bridges, bridge routers across the LAN
to some other network.
CIMPLICITY viewers will listen for both the project Broadcast and Multicast.
The default Multicast address is 224.0.0.29.
GFK-1180K
3-5
Caution: When multicasting is checked to operate across a LAN, several network factors
that are outside of CIMPLICITY must be configured correctly e.g. the network router
needs to be capable of and configured to allow multicast. Therefore, it is strongly
recommended that you consult the network administrator before selecting this option.
Note: If this is a redundant project then the Broadcast option will be selected and the
user will not be able to select the Multicast option.
See the "Using Global Parameters" chapter in this manual for global parameters that
can be used for multicasting.
Computer name
Select the Computer name from the drop down menu that the project is to run on when
the project is started.
For all installations, you may run the project on your computer.
Startup timeout
Enter the number of minutes in the Startup timeout field that CIMPLICITY HMI should
wait for the project to start before it times out.
The default is 10 minutes.
Configuration Security
Check Configuration security to restrict user configuration access to any or all of
CIMPLICITY's applications.
Result: CIMPLICITY activates its configuration security feature, as follows.
A Configuration tab appears in the Roles dialog box. This tab enables a user with Roles
configuration privileges to specify what applications users assigned to each role can
configure. See "Assigning Role Configuration Privileges" in the "Role Configuration"
chapter in this manual for more information.
3-6
GFK-1180K
A Configuration Login dialog box appears when a user attempts to open the Workbench.
If the user's role was not granted Workbench privileges, the user is denied access.
Configuration Security is Enabled: Example
1 A Configuration Login dialog box appears when a user
opens the Workbench.
1
2
2 An error message
appears if the user's
role does not have
Workbench privileges.
The Settings tab of the Project Properties dialog box enables you to enter general settings
for each application on the displayed list of applications.
GFK-1180K
3-7
2.
Click Settings.
Alarms
Alarm Properties
Database Logger
Logging Properties
Event Editor
Measurement Units
Points
Point Setup
Users
User Setup
See the appropriate chapter for each of the applications for details about its dialog box.
3-8
GFK-1180K
Workbench
Enabling the Project Wizard through the New Project Dialog Box
To enable the CIMPLICITY Project Wizard through the New Project dialog box:
1.
Choose either:
Method 1
Click the New Project button
Method 2
A. Click File on the Workbench menu bar.
B. Select New>Project.
The New Project dialog box opens when you use either method.
2.
Options
Protocols
GFK-1180K
3-9
Project Path
3.
Click Create
Method 2
1.
2.
Method 3
Press Ctrl+W on the keyboard.
Result: The CIMPLICITY Project Wizard opens when you use any method.
3-10
GFK-1180K
2.
Select Install.
The Create Shortcut dialog box opens.
3.
Select the folder (or create a new folder) in which you want the CIMPLICITY
HMI project to appear.
4.
Click OK.
Result: The project will appear on the Start menu in the folder you selected.
GFK-1180K
3-11
CIMPLICITY Options
CIMPLICITY software supports running multiple projects on a single computer.
You can configure:
Project options.
Startup options.
2.
You do this on the Projects tab in the CIMPLICITY Options dialog box.
3-12
GFK-1180K
2.
3.
Select another computer from the new Computer name drop down menu.
Note: If you type in the computer name click Connect to connect to the
computer.
Result: Projects that are running on the selected computer appear in the Running
projects box. You can now view them through CimView.
Computer Started as Viewer: Example
The local
computer name
displays.
1 Click Start
Viewer.
The router starts.
The local
computer can
now act as a
Viewer.
2 Select a
computer from
the new list.
GFK-1180K
3-13
Click the drop-down list button to the right of the Computer name field.
2.
Select the computer you want to connect to from the list of computers to which
your computer has access and that are currently running CIMPLICITY software.
Note: If the computer name does not appear in the list, type it in the Computer
Name field and click Connect.
Result: The projects that are currently running on the selected computer display in
the Running Projects field.
2.
Click Stop.
If you are connected as a server, a confirmation dialog box opens.
3.
Click Yes to confirm that you want to proceed with the shutdown.
Result: After the project is stopped, CIMPLICITY removes the name from the
Running projects list.
Click Add.
The Open dialog box opens.
2.
Use the Open dialog box to search for the project (.gef) file you want.
3.
Click OK.
2.
Click Start.
3.
Result: The project you select is started. When startup is complete, CIMPLICITY
adds the project name to the Running projects list.
3-14
GFK-1180K
GFK-1180K
3-15
Network Options
To specify network options:
1.
Select the Startup Options tab in the CIMPLICITY Options dialog box.
2.
The local computer can connect to all other projects in the enterprise. Other
computers can connect to running projects on the local computer.
The local computer can connect to only other secure projects in the
enterprise. Only secure computers can connect to running projects on the
local computer.
The local computer will not connect to other projects in the enterprise.
Other computers in cannot connect to projects running on the local
computer.
3-16
GFK-1180K
Display the Startup Options tab in the CIMPLICITY Options dialog box.
2.
At boot Up
None
Viewer
Start projects
3.
Click Add.
The CIMPLICITY Default Project dialog box opens.
4.
5.
GFK-1180K
Click OK.
3-17
6.
Result: CIMPLICITY follows your specifications when the local computer boots
up.
Note: To delete a project from the list, select the project, and click Delete. The project
is removed from the list.
Step 2.
Step 3.
2.
3-18
GFK-1180K
3.
4.
5.
Enter the old Password (or leave it blank if you never entered a password).
6.
Leave the New Password and Confirm New Password fields blank
7.
Click OK.
The Change Windows Password dialog box closes.
8.
GFK-1180K
3-19
2.
4.
Click OK.
Result: You are prompted to reboot your system so that changes will take effect.
After you have rebooted, you will no longer be prompted to log on.
3-20
1.
Display the Startup Options tab in the CIMPLICITY Options dialog box.
2.
3.
Make sure the project(s) you want to start at system boot are listed.
GFK-1180K
4.
Click CimView.
The CimView Setup dialog box opens.
5.
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
GFK-1180K
No Menu/Title
3-21
No Open
No Resize
Captive Mode
Touch Active
Touch Dynamic
Touch Static
No Point Targets
D. (Optional) Enter the name of cache files in the Cache File field, if you
want to pre-load the screen cache with selected files.
Note: You can also click Browse to the right of this field to search for the
cache file you want.
E. Click OK to save your changes and return to the CIMPLICITY Options
dialog box.
6.
Click OK.
Result: The startup options are saved and the CIMPLICITY Options dialog box
closes.
3-22
GFK-1180K
User Application
Resident Process
Alarm Viewer,
CimView,
CimEdit, and
CWSERV.
These programs are started by user request and remain running until the user exits
them.
The Resident Process layer consists of a set of programs that are started when you start
your CIMPLICITY project, and that remain running until your CIMPLICITY project is
shut down.
If you are on a Server, the Resident Process layer includes such programs as the:
Router,
Device drivers,
Point Management,
If you are on a Viewer, the only process running in the Resident Process layer is the
Router.
GFK-1180K
3-23
3-24
GFK-1180K
CIMPLICITY Login
Two levels of logins are available when you use CIMPLICITY software.
1.
2.
The CIMPLICITY login dialog box that is presented when you select a
CIMPLICITY user application, Alarm Viewer, CimEdit, CimView, or
CWSERV.
You have a great deal of flexibility in determining when and how users will log in to
CIMPLICITY software.
Note: The CIMPLICITY Configuration Security feature changes how the login behaves.
Briefly, if configuration security is activated, users are presented with a CIMPLICITY
User Login dialog box when they attempt to open a CIMPLICITY project.
In addition, they will only be allowed access to the CIMPLICITY applications for which
their role is assigned privileges. See "Assigning Role Application Privileges" in the
"Configuring Roles" chapter in this manual for details.
Guidelines for CIMPLICITY login include:
On a server, if you
A. Define a CIMPLICITY username and
password that match the username and
password users enter when they log in
to Microsoft Windows NT/2000 or
Windows 98 or
B. Define a CIMPLICITY username and
password that are different from the
username and password users enter
when they log in to Microsoft Windows
NT/2000 or Windows 98.
GFK-1180K
Then Users
Are automatically logged in to
CIMPLICITY when they log in to
Microsoft Windows NT/2000 or
Windows 98.
3-25
If a User
Checks the Save Username +
Password check box when selecting
any applications in the project
A. Opens a CIMPLICITY application
while the login is active,
(The login remains active for a period
after the user exits all open
CIMPLICITY applications. The length
of time is specified by the system
manager or
B. Opens a CIMPLICITY application after
the login period has expired.
On a Viewer, if a User:
Checks Reconnect at Startup.
Then the:
Viewer is automatically connected to the
project used by the application whenever
CIMPLICITY software is started on the
viewer.
User will be automatically logged into the
project.
3-26
GFK-1180K
Hold
alarm_help
Operator Help files for alarms (that you created and put them in this
directory).
arc
data
lock
log
master
screens
scripts
2.
Locate the project directory for the project you want to back up.
3.
(To save space on your diskette) delete all log files from the project's \log
directory before making the backup.
4.
Note: If the project is running, some files in this directory may be locked and will not be
deleted.
This method works well for small projects. For large projects, consider zipping the
project and saving the zipped file or backing up the project directories to tape rather than
diskette.
If you try to back up a running project, an error message appears telling you there is a
sharing violation.
GFK-1180K
3-27
where the options to display help information for this command line option are:
/help or -help or /? or -?.
Important: The /rstart and /rstop options only work on Windows NT/2000.
/rstart <project> or -rstart <project> <computer> to start a project on a remote
computer.
Example
startup.exe /rstart z:projects\cimpdemo\cimpdemo.gef alnt04
computer.
Example
startup.exe /rstop z:projects\cimpdemo\cimpdemo.gef alnt04
3-28
GFK-1180K
Understanding Points
About Points
CIMPLICITY HMI collects or calculates point data that it distributes to:
CimView screens
Alarm printers
Logging tables
The collection and distribution of point data is handled by the Point Management
subsystem. Point Management's primary functions are to:
Note: You can limit a user's ability to set point to only those points whose resources are
in the user's view and/or have assigned security levels equal to or below the role's security
level. See "Setpoint Security" page 4-5 in this chapter for more information.
GFK-1180K
4-1
Categorizing Points
CIMPLICITY HMI provides you with the tools to configure any point to exactly your
specifications. Even though there are several options during configuration, your starting
choices for any given point are very simple.
The point value:
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:
Boolean, or
Text.
Naming Points
Each point you create in your project has a unique Point ID. A Point ID may contain:
up to 32 characters
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:
4-2
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-1180K
AH1
AL1
ALARM_HIGH
ALARM_NOT_ACKED
BNOT
EQ
GE
NE
SQR
WARNING_HIGH
ANA
GT
WARNING_LOW
If, however, you do use a reserved word for a Point ID and you include such a Point ID in
a point expression or equation, you must enclose the Point ID in single quotes.
GFK-1180K
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-1180K
Setpoint Security
You can limit a user's ability to set points to only those points whose resources
are in the user's view. You do this in the Project Properties dialog box.
2.
Select Properties.
The Project Properties dialog box opens.
3.
4.
Select Points.
5.
Click Settings .
Method 2
1.
2.
Press P.
The Project Properties dialog box opens.
3.
4.
Select Points.
5.
Click Settings .
Result: The Point Setup dialog box opens when you use either method.
GFK-1180K
Understanding Points
4-5
1
2
3
(Optional) Check Enable resource set point security to restrict set point
privileges to only the resources for which a project user has access.
Example
POINT_A has been defined for RESOURCE_1
If:
Then:
If:
(Optional) Check Enable level setpoint security to restrict a project user's point
setpoint privilege to only points that are assigned levels equal to or lower than
the project user's role level.
Example
A Discrete_Oper user is assigned the role Oper in the User Properties
dialog box.
Oper is assigned a Level 10 in the Role Properties dialog box.
The Discrete_Oper user can set only device points that have been assigned a
level that is smaller or equal to 10.
4-6
GFK-1180K
3.
Result: Project users who fulfill the criteria will be able to set points for a selected
resource or device point.
See the following chapters in this manual:
GFK-1180K
Understanding Points
4-7
Step 2.
Step 3.
Note: These procedures are meant to help you quickly set up a device. Other chapters in
the CIMPLICITY HMI Base User's Manual provide depth descriptions of each part of the
process.
Quick Install for a Device Point
F1
BATT.
F2
M SG .
ESC
F1
XFER
SRCH
RUN
STO P
SET
7
C
8
F2
v
SW 5
SW 7
SW 8
SW 9
SW 10
SW 1 1
SW 12
G HI
M NO
2
VWX
+/
SW 2
SW 4
DEF
4
JKL
STU
SW1
M O N SW3
ABC
PQ R
3
YZ-
ENTER
SW 6
SW13 SW14
O N / O FF
IBM Compatible
4. Configure a
device point.
GFK-1180J
5-1
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.
Step 1. Enable a
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
installation CD to add the protocol.
5-2
GFK-1180J
Select a protocol for the device's port. (If a port doesn't already exist.)
Task 3.
Task4.
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.
GFK-1180J
5-3
4.
5.
1.
(If you need to create a port protocol) Click the Popup menu button to the
right of the Port field.
2.
Select New.
The New Port dialog box appears.
3.
4.
Select another port, if the one that appears is not the one you want.
5.
Click OK.
The Port Properties dialog box opens.
5-4
GFK-1180J
Protocol tab
depends on specific
protocol.
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.
GFK-1180J
5-5
1.
Click OK when the New Device dialog box has the device and port filled in.
The Device dialog box appears.
Device Proeprties Dialog Box: S90 Ethernet Example
2.
3.
Choose a Resource.
Note: Three resources that come with CIMPLICITY are
A. $SYSTEMSystem Resource
B. $MAC_FRSystem Events
C. $PTM_FRPoint Management Info
5-6
4.
Select the type of device from the Model Type drop-down list. The list of
available model types depends on the protocol.
5.
GFK-1180J
6.
Either:
7.
Enter the required information on the device's Protocol tab. Required entries
depend on the protocol you are using. See the CIMPLICITY HMI Device
Communications Manual (GFK-1181) for details on the addressing supported
for your particular device and protocol.
Result: Now you can configure device points that collect data from and/or send data to
the device that is now enabled in your CIMPLICITY HMI project.
See the "Configuring Device Points" chapter in this manual.
GFK-1180J
5-7
Configure alarms
This chapter provides information for 1-3. See the Configuring Point Limits, Views and
Alarms chapter in this manual to do the configuration listed in 4.
Note: CIMPLICITY HMI provides you with a Manual Mode feature that enables a user
to disconnect a point's values from a device and set them manually. See the "Device Point
Quality Support at Runtime" section in this chapter for details about this feature.
GFK-1180K
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.
Device name
6-2
Device popup
Device browser
4.
5.
6.
GFK-1180K
7.
8.
Analog
Boolean
Text
Click 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:
1.
2.
3.
GFK-1180K
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
Select one Data Type from the drop down list that appears for the point type
you selected:
6-3
Analog Points
General TabBasic ViewAnalog Point
DINT
INT
REAL
SINT
UDINT
UINT
USINT
3D_BCD
4D_BCD
Array=
More than 1
Check to prohibit
setpoint use
DINT
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-1180K
Boolean Points
General TabBasic ViewBoolean Point
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
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:
GFK-1180K
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-1180K
Maximum size
Virtual
1600 bytes
CCM2
250 bytes
Genius datagram
128 bytes
Series 90 TCP/IP
950 bytes
200 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
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-1180K
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 Device
Communications Manual (GFK-1181).
6-8
Device
Select a Device popup
browser
GFK-1180K
2.
Enter the Address that is consistent with the selected protocol. For further
information on addressing for the protocol and device, see the CIMPLICITY
HMI Device Communications Manual (GFK-1181).
Device TabBasic ViewUpdate Criteria
Entry depends on
protocol
Boolean
points only
Availability depends on
protocol:
On Change
On Scan
On Demand On Scan
On Demand On Change
Unsolicited
Poll Once
3.
(For Boolean points only) Enter an Address Offset (bit offset) if the first bit of
the point's data is not the first bit of the address. Address offsets start at 0, which
is the least significant bit.
Example
A digital point is located in the third (3rd) bit of Register 5 on a Series 90-70
The Address is %R5
The Address Offset is 2.
4.
Choose one of the following (The Addressing box displays one or all choices
depending on the device you select):
A. Device Dataif the address you enter is for a device point.
B. Diagnostic Dataif the address you enter is for a diagnostic point
See "Entries for Diagnostic Points Used with Devices".
C. Ethernet Global Dataif the address you enter is for Ethernet global data.
GFK-1180K
6-9
5.
Specify the Update Criteria when data for the point is passed from the device
communications processor to the point database. Available selections depend
on the protocol you are using.
Point is updated when
On Change (Default)
Data Collected:
At a regular interval.
The interval equals the base scan rate for the port
on which the device is located multiplied by the
scan rate for the point.
Value Updated:
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
Data Collected:
Value Updated:
On Demand On Change
Data Collected:
Value Updated:
Unsolicited
Value Updated:
6-10
GFK-1180K
Unsolicited On Change
Value Updated:
Poll Once
Data Collected:
Once the updated data is in the point database, it is available to all that need it
GFK-1180K
6-11
Responses
Retries
Failures
Device status
Note: Diagnostic points are not available for the Point Bridge.
To view diagnostic data, configure device points that correspond to the diagnostic
locations in the enabler. These diagnostic points are like device data points in all ways,
except that they are always available when the enabler is running (points containing
device data are unavailable if communication with the device fails). Diagnostic points
may be scanned at any appropriate multiple of the port's base scan rate, displayed in
CimView screens, trended, logged, alarmed, etc.
Important: You cannot write to diagnostic points. Always configure them for Read
access.
6-12
GFK-1180K
2.
Enter one of the following values as the text address of the diagnostic data in the
Address field.
Address
Data Type
Description
$TRANSMISSIONS
UDINT
$RESPONSES
UDINT
Number of messages
Number of messages
received
$FAILURES
UDINT
Number of
communication failures
$RETRIES
UDINT
Number of retries
$DEVICE_DOWN
BOOL
$DEVICE_UP
BOOL
Device up status
Entry Choices
For UDINT
$TRANSMISSIONS
$RESPONSES
$FAILURES
$RETRIES
For BOOL
$DEVICE_DOWN
$DEVICE_UP
GFK-1180K
6-13
Select the Domain Type that represents the type of device memory from which
the point is coming.
2.
Enter the starting address for the point in the Domain Offset field. The address
depends on the addressing conventions for the individual device.
3.
(Active only for Bool points) Enter Bit Offset if the first bit of the point's data is
not the first bit of the address. Address offsets start at 0, and are numbered from
right to left.
4.
Note: Use the following values to configure diagnostic data for devices with standard
addressing:
6-14
Description
Data
Type
Domain Type
Domain
Offset
UDINT
UDINT
UDINT
UDINT
BOOL
BOOL
0
1
2
3
0
1
GFK-1180K
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-1180K
6-15
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.
3.
6-16
Enable Point
Enable Alarm
Enable Enterprise
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.
GFK-1180K
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
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
GFK-1180K
6-17
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
You may select either option, or both. If you select both, the Max Count takes
precedence over Max Duration in determining the number of values saved in
the buffer..
Point buffering lets you allocate a buffer for a point and save a number of the
most recent values. This feature is currently being supported only for the
Trending option.
Example:
Point ABC is scanned every 5 seconds
If you define a:
Max Duration of 1 minute, the buffer contains the 12 most recent values
for ABC at any given time.
Max Count of 10, the buffer contains the 10 most recent values (that is, the
values for the last 50 seconds).
Max Duration and Max Count, the buffer contains the 10 most recent
values.
6-18
GFK-1180K
Note: You can conveniently create new attribute sets or edit the selected attribute by
clicking the Popup button and selecting New or Edit from the menu.
See the "User Defined Point Attributes" section of the "Using Point Attributes" chapter in
this manual for details about creating and editing point attribute sets.
2.
Click OK or Apply.
Result: CIMPLICITY adds the point to its default DATA_LOG. You can apply
more specifications in the Database Logger.
See the "Database Logger" chapter in this manual for information about configuring
log tables.
GFK-1180K
6-19
Enter a (positive or negative) number in the Level field; the higher the number,
the more restricted the setpoint access.
2.
Click Ok or Apply.
Result: When point level setpoint security is enabled a project user can set the
point only if the user's assigned role has a corresponding level that is equal to or
higher than the point level.
Tip: Enable point level setpoint security in the Point Setup dialog box.
To open the Point Setup dialog box:
1.
2.
3.
Select Points.
4.
Click Settings.
Trigger settings
Scan rate
Analog deadband
Delay load
6-20
GFK-1180K
GFK-1180K
6-21
Example
You are configuring a point that requires an update for logging purposes.
If the update needs to be hourly, but the device is being scanned every quarter
hour for other purposes:
Use a device Trigger Point that is configured with a one-hour scan rate. See
"Update Criteria for a Device Point" in this chapter.
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:
3.
Choice
None
Equal
Equals Value.
Greater Than
Less Than
On Change
Enter the Value the Trigger Point will be compared with to determine if the
trigger condition has been met.
The trigger condition is evaluated each time the trigger point is polled, so effectively, this
point is polled at the trigger point's scan rate while the trigger condition is true.
6-22
GFK-1180K
Scan Rate
Enter the frequency at which the CIMPLICITY device communications option will read
this point's data, based on the port's Base Rate.
The Base Rate is the minimum rate at which device points can be polled on the port. The
Scan Rate is a multiple of the Base Rate.
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 in the Scan Rate field.
Analog Deadband
An Analog Deadband filters out changes in the raw value of this point. A point value
change less than OR EQUAL TO the deadband value will be ignored. The raw value
must change more than this value before the point value is updated in the CIMPLICITY
point database.
Therefore, the Analog Deadband can make CIMPLICITY software ignore small
fluctuations in the value of a point. For example, if you have a point ranging from 0 to
10,000, and you enter 5 in this field, any point fluctuations of less than 5 are ignored.
Check
Clear
Important: The Point Bridge does not support Poll After Set. If you are defining a
Point Bridge point, clear this check box.
Delay Load
Delay Load is checked when the point will write to the point database, but will not reside
in memory until called into use by an application.
GFK-1180K
6-23
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.
6-24
GFK-1180K
103
100
104
105
105
107
110
105
102
104
106
0
3
Time:
= A1 value is read.
12
15
18
21
24
27
30
D1:
D1:
100
105
107
105
102
104
0
3
Time:
= A1 value is read.
12
15
18
21
24
27
30
In other words, CIMPLICITY reads A1 at the 3, 9, 15, 21, 24 and 27 second marks
because the value of D1 changed at those times. Note that any transitions that occur
between scans (such as those between the 15 and 18 second marks) do not count.
GFK-1180K
6-25
100
104
0
3
Time:
= A1 value is read.
D1:
107
110
102
12
15
18
21
24
27
30
In other words, CIMPLICITY reads A1 at the 3, 15, and 24 second marks, because they
are the only places where the scanned value of D1 transitions from LOW to HIGH.
Note: Because the trigger point in this example is Boolean, Greater than 0 behaves the
same as specifying Equal to 1.
At run-time, PLC1 will only be updated while the point PLC1_READY is equal to 1.
6-26
GFK-1180K
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-1180K
6-27
6-28
Benefits
Disadvantages
Non-Supported Functions
Slower access
Trigger settings and
Alarm options are not
available
Trend buffering
Alarming
Cannot be used within
another point's
configuration, e.g. Safety
point, Trigger,
Availability Trigger
point, etc.
Cannot be used in a
calculation point equation
GFK-1180K
(For an analog device point) Select the base engineering units for an analog
device point and specify a linear or custom conversion for an analog device
point, or
(For an analog virtual point) Select the base engineering units for an analog
virtual point
Or
You do this on the Conversion tab that appears in the Point Properties Advanced General
tab group.
An enumeration point provides the text replacement for the value of a point. You can
configure one or more Point Enumeration sets in the Point Enumeration application and
then associate an analog or digital point with a set on the Conversion tab. See page 6-37
for details.
1.
Either
2.
3.
Or
4.
GFK-1180K
6-29
2.
Select the Conversion tab that appears if you are configuring an analog point.
6-30
GFK-1180K
Note: If you select a unit of measurement on the Conversion tab, and the project has an
active measurement system at runtime, the base engineering units for the point are
automatically converted to the corresponding units in the active measurement system.
However, configured deadbands and analog deadbands will not be converted via
measurement units or otherwise.
If there is no active measurement system, the base engineering units are used. If the
project has an active measurement system at runtime, no further point conversion takes
place.
Select a Measurement
Unit browser
Measurement
popup
Choose any of the following methods to configure engineering units for a point:
Method 1. Use the Popup Menu.
Method 2. Use the Select a Measurement dialog box.
Method 3. Use the New Measurement dialog box.
Method 4. Leave the Base Units field blank.
GFK-1180K
6-31
2.
Select the name of the base engineering unit from the list of available
measurement units.
Result: The unit appears in the Unit field and the label for the unit
automatically displays in the Label field.
Method 2
1.
2.
3.
Click OK.
Result: The unit appears in the Unit field and the label for the unit
automatically displays in the Label field.
6-32
GFK-1180K
Method 3
1.
2.
Select New.
3.
4.
Click OK.
The Measurement Unit Properties dialog box appears.
5.
6.
Enter the Display label that will appear when the measurement unit is selected.
7.
Click Apply.
Result: The new unit is added to the list of available units.
Method 4
Leave the base units for the point blank and enter your own label in the Label field.
Result: You can configure point enumeration for either a virtual or device point.
GFK-1180K
6-33
No conversion is performed.
Linear
The point is converted according to the high and low Raw Limits you
specify on the Conversion page.
Custom
When you specify Linear or Custom conversion, you must enter the values for the Raw
and Converted Limits.
Example
A point's value represents degrees F.
You leave the Unit field blank.
The active measurement system uses metric units.
No conversion from degrees F to degrees C takes place at runtime.
Linear Conversion
When you use linear conversion, you specify base and converted values that
CIMPLICITY HMI uses to calculate runtime conversions..
To configure linear conversion:
6-34
1.
2.
Check Linear.
3.
Enter two valid Raw values in the First and Second fields.
4.
Enter two Converted values in the First and Second fields. These are
engineering unit values that correspond to the first and second raw values you
entered.
GFK-1180K
CIMPLICITY HMI uses these four values to calculate the linear conversion for the point.
The conversion formula is:
where:
EU value = the Engineering Units value
R1 = First raw value
R2 = Second raw value
C1 = First converted value
C2 = Second converted value
Raw value = the value read from the device.
CIMPLICITY HMI uses the inverse of this expression to convert Setpoint values entered
by users to raw values for downloading to the device.
Custom Conversion
Custom conversion provides you with the ability to specify specific forward and
backward conversion expressions.
To configure custom conversion for a device points:
1.
2.
Check Custom.
3.
Enter a Forward expression that CIMPLICITY HMI will use to convert the raw
data to engineering units
Use the placeholder %P to indicate the point value in the expression. %P is the
raw value of the point.
GFK-1180K
6-35
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
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 floatingpoint arithmetic.
A conversion that inverts the sign, (e.g. a FWD Conversion = %P(-1) and REV
Conversion = %P(-1)) will not work correctly if you configure setpoint, range or
alarm limits
Example
A conversion that calls for the raw data to be divided by 2, then multiplied by 10.
The raw value for the point is 3.
You could enter any one of the following expressions. However, the Expression
Processor interprets each expression differently, as follows:
Expression
Result
Because integer arithmetic was used throughout, the result is
an integer.
(%P/2)*10
(3/2)*10 = (1)*10 = 10
6-36
GFK-1180K
(%P/2)*10.0
CimView,
BCE.
Point enumeration is particularly useful for points where a value that is translated into
text is more easily understandable than the numeric value, e.g. ON/OFF vs. 0/1.
If the value of the point does not correspond to a configured enumeration, the point will
be treated as being out of range and will be displayed as unavailable.
Guidelines for enumerated points include:
1.
Analog points of the following base data types may use enumeration sets:
SINT,
USINT,
INT,
UINT,
DINT,
UDINT and
BOOL.
Array points.
Points with EU conversion. The result of their evaluation is a REAL data type,
which does not have discrete values.
3.
4.
A point can be configured so that the value can be set to any of the case-sensitive
enumerated text values.
If the point is set to a value that is not part of the case-sensitive enumeration,
CIMPLICITY generates an error.
GFK-1180K
6-37
Create an enumeration set (if the set does not already exist).
Step 2.
Select the enumeration set that will be associated with the point.
A New Point Enumeration dialog box opens when you use either method.
6-38
GFK-1180K
2.
3.
Click OK.
A Point Enumeration dialog box opens.
4.
5.
Click New.
The New Value dialog box opens.
6.
7.
Click OK.
The Value properties dialog box opens.
8.
GFK-1180K
6-39
9.
10. Click OK
The Point Enumeration dialog box appears displaying the information you just
entered.
11. Continue adding values until the Enumeration set is complete.
Important: The values that you enter in the text field are case sensitive. Anyone
working with those values must enter them exactly as configured.
6-40
1.
2.
Click Advanced on the General tab to put the Point Properties dialog box in
advanced mode.
3.
4.
GFK-1180K
5.
6.
Click OK.
The selected enumeration set displays in the Point field.
7.
Click OK.
GFK-1180K
6-41
Text
UNAVAILABLE
CLOSED
PARTLY CLOSED
HALF OPEN
PARTLY OPEN
OPEN
See page 6-37 for details about configuring an Enumeration Set and enumerated point.
Point Control Panel
During runtime in the Point Control Panel, if the point value:
Equals one of the defined numeric values, the associated text displays in the
Value column.
Can be set, the case-sensitive text value is entered in the Point Control Panel
Point Properties dialog box.
Enumeration Point in Point Control Panel
See "Using the Point Control Panel" in this manual for details about the Point
Control Panel.
6-42
GFK-1180K
CimEdit/CimView
You can use the enumerated values in:
2.
Open the Expression List Attribute Animation dialog box for the valve as
follows:
A. Open the valve's Properties dialog box.
B. Select the Color Animation tab.
C. Click Enter.
4.
Enter the case sensitive enumerated values to display each valve position.
5.
3
1 Place a valve with text
(that allows setpoints) on
a CimEdit screen.
enumerated values to
animate the valve (in
CimEdit).
The valve responds to the
enumerated text (in
CimView).
See the CimEdit Operation Manual GFK-1396 for details about configuring color
animation.
GFK-1180K
6-43
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
Note: A point with manual mode enabled can be changed, regardless of the current value
or state of an associated availability trigger or safety point.
6-44
GFK-1180K
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-1180K
7-1
Point type
Classification of the point
2.
Method 2
1.
2.
3.
4.
Method 3
1.
2.
Method 4
1.
2.
3.
4.
5.
6.
Analog
Boolean
Text
Click OK.
7-2
GFK-1180K
2.
3.
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.
Select one Data Type from the drop down list that appears for the point type
you selected:
Analog Points
General TabBasic ViewAnalog Point
M DINT
M INT
M REAL
M SINT
M UDINT
M UINT
M USINT
M DINT
M INT
M REAL
M SINT
M UDINT
GFK-1180K
Array=
More than 1
Check to prohibit
setpoint use
DINT
INT
REAL
Floating-point numbers.
SINT
UDINT
UINT
USINT
7-3
Boolean Points
General TabBasic ViewBoolean Point
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
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:
7-4
Check the Read Only check box to prohibit the ability to use the point as a
setpoint.
GFK-1180K
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.
Point Properties Dialog Box General Tab
1 = Single Point
Important: Array points are not supported by all CIMPLICITY software functions.
Support for array points is as follows:
GFK-1180K
CimEdit
CimView
Alarm Viewer
Database Logger
7-5
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
3.
4.
GFK-1180K
Boolean point
None
Initialized
Saved
Saved or Initialized
Analog point
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-1180K
7-7
3.
Note: When working with initialization values for string arrays, if:
Too many elements are given in Initial Value, the string truncates at the number
of elements.
The Initial Value does not specify enough elements, the remaining elements of
the string are initialize to the Null character.
Example
A String array:
is an array of 4.
Is an array of 8.
Sets STRING[0] to A
Guidelines: When working with initialization values for string arrays, if:
7-8
Too many elements are given in Initial Value, the string truncates at the number
of elements.
The Initial Value does not specify enough elements, the remaining elements of
the string are initialize to the Null character.
GFK-1180K
Step 2.
2.
Select Properties.
The Project Properties dialog box opens.
3.
4.
Select Points.
5.
Click Settings.
Method 2
1.
2.
Press P.
The Project Properties dialog box opens.
3.
4.
Select Points.
5.
Click Settings.
Result: The Point Setup dialog box opens when you use either method.
GFK-1180K
7-9
Recommended:
De-select after configuration
On point update
On project shutdown
2.
7-10
GFK-1180K
It is recommended that you use this option only while you are developing your
project. Once you have a stable point configuration, it is no longer necessary to
compact the saved virtual point storage.
Recommended:
De-select after configuration
GFK-1180K
7-11
Configure alarms.
This section describes what to enter for these advanced virtual point specifications.
See "Setting Point Limits and Alarms" in this manual for information on how to enter the
advanced specifications that unleash the spectrum of CIMPLICITY HMI monitoring
powers.
Configure alarms
7-12
Enable the point or associated alarm. See "Setting Point Limits and Alarms" in
this chapter for information about configuring an alarm.
GFK-1180K
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-1180K
7-13
2,
Enable Point
Enable Alarm
Enable Enterprise
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:
7-14
Safety Point is
Available and
evaluates to a non-zero value
Permitted
Available and
evaluates to zero
Not permitted
Unavailable
Not permitted
GFK-1180K
Note: You can conveniently create new attribute sets or edit the selected attribute by
clicking the Popup button and selecting New or Edit from the menu.
See the "User Defined Point Attributes" section of the "Using Point Attributes" chapter in
this manual for details about creating and editing point attribute sets.
Availability Triggers
An Availability Trigger determines the validity of the point you are configuring and
provides a "device healthy" signal for points that are tied to intermediate devices during
runtime.
To specify an availability trigger:
Select a point for the Availability Trigger field. The point can be digital or analog.
At runtime if the:
Availability Trigger
Configured Point is
Available or derived
Evaluates to zero
Unavailable
Important: Availability triggers only apply to virtual points that have no calculation
expression.
GFK-1180K
7-15
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
Max Count
Seconds
Minutes
Hours
Days
You may select either option, or both. If you select both, the Max Count takes
precedence over Max Duration in determining the number of values saved in the
buffer.
Point buffering lets you allocate a buffer for a point and save a number of the
most recent values. This feature is currently being supported only for the
Trending option
Example:
Point ABC is scanned every 5 seconds
If you define a:
Max Duration of 1 minute, the buffer contains the 12 most recent values for
ABC at any given time.
Max Count of 10, the buffer contains the 10 most recent values (that is, the
values for the last 50 seconds).
Max Duration and Max Count, the buffer contains the 10 most recent
values.
7-16
GFK-1180K
2.
Click OK or Apply.
Result: CIMPLICITY adds the point to its default DATA_LOG. You can apply
more specifications in the Database Logger.
See the "Database Logger" chapter in this manual for information about configuring
log tables.
Enter a (positive or negative) number in the Level field; the higher the number,
the more restricted the setpoint access.
2.
Click Ok or Apply.
Result: When point level setpoint security is enabled a project user can set the
point only if the user's assigned role has a corresponding level that is equal to or
higher than the point level.
GFK-1180K
7-17
Tip: Enable point level setpoint security in the Point Setup dialog box.
To open the Point Setup dialog box:
1.
2.
3.
Select Points.
4.
Click Settings.
7-18
"Configuring Roles" for details about specifying the role security level.
GFK-1180K
Note: Virtual points are updated on project start based on the results of entries in the
Initialization and Calculation fields that are on the Virtual tab of the Point Properties
dialog box.
Advanced Virtual Tab Initial Value SpecificationAnalog Point: Example
Selections (and associated entries) provide criteria for virtual point updates.
Tip: A Local checkbox displays on the advanced Virtual tab for every calculation choice
except none. Check the Local check box to tell CIMPLICITY HMI not to report the
value of the point to the Point Management process. This is useful for points that are only
used to hold intermediate values in calculations. For such points, setting the Local flag
eliminates the overhead of reporting to the Point Management process. Local points
cannot be shared with other applications.
Note: Almost all of the calculations allow you to enter a trigger point.
GFK-1180K
7-19
For calculation points, you only need Saved and Initial values for Delta Accum,
Timer/Counter and Value Accum points. This is because all other calculation points are
validated at startup and any saved or initial value is immediately overwritten.
Trigger Points
A trigger point minimizes the system resources that are required for calculating virtual
points when it is not necessary to keep virtual points current with the points used to
calculate their values.
Example
You are configuring a point that requires an update for logging purposes.
Equation Points
Equation points are available for both analog and Boolean virtual points.
CIMPLICITY HMI uses the expression you specify in the Expression field to update the
point's value.
Steps to define equation points include:
Step 1.
Step 2.
Step 3.
Step 4.
Point browser
menu
7-20
GFK-1180K
Although this will not cause CIMPLICITY software to fail, it will cause the
Virtual Point Processor to always have work to do. This causes all available
computer time to be consumed, which adversely impacts system
performance.
2.
3.
GFK-1180K
Defined
Not defined
7-21
And:
Then:
An Initial Equation
Point value is
The Current
value of the
Expression is
Not defined
Not defined
Defined
Defined
Available
Unavailable
Unavailable
Available
Current value
Zero
Initial value
Current value
Not defined
Defined
Zero
Initial value
Note: You can also use a Delta Accum point with a global virtual point. However, in
most cases, the virtual point should be configured so that when it reaches the rollover
level it emulates a PLC and rolls over to the initial value.
Steps to define a Delta Accum point are:
7-22
Step 1.
Step 2.
Step 3.
Step 4.
Step 5.
Step 6.
GFK-1180K
Adds the difference between the current and previous values of the expression that
you specify in the Expression field to the current value of the Delta Accum point.
Is first updated after the first two expression updates are received.
Is writeable.
2.
If the source has rolled over so the new source is less than the old source,
New Delta Accum = Old Delta Accum + (Source rollover value +
1) - old source value + new source value
Example
Note: A rollover value, which is used in this example, is the maximum acceptable
value for a source point. When the maximum value is incremented by 1 unit, the
source point rolls over to 0.
A Delta Accum point has a value of 100 and a Rollover value of 1000.
1.
2.
The source next changes from 999 to 20. (The source point has rolled over.)
The new Delta Accum changes to 1022 based on the formulas calculation:
999+(1000 + 1) - 999 + 20 = 1022
Select Delta Accum in the Calculation field on the Virtual tab of the Point
Properties dialog box.
Expression
dialog
Point menu
Point browser
menu
GFK-1180K
7-23
2.
System logs the following message to the Status Log with Success status:
Variance value exceeded for accumulator point : <point_id>
If you do not specify a Rollover value, the size of the data type for the Delta
Accum point determines the default Rollover value.
7-24
GFK-1180K
Example
If the source point has an INT point type, the maximum acceptable value for the
Delta Accum point is 32767.
When the maximum value is exceeded the following message is logged to the
Status Log with Success status:
Rollover occurred for accumulator point : <point_id>
Note: If the source expression is a floating or Boolean point, rollover is not applied.
Defined
Not defined
And:
Then:
An Initial Delta
Accum Point
Value is
The Current
value of the
Expression is
Not defined
Not defined
Defined
Defined
Unavailable
Available
Unavailable
Available
Zero
Zero
Initial value
Initial value
GFK-1180K
Not defined
Defined
Zero
Initial value
7-25
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]
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-26
GFK-1180K
Step 2.
Step 3.
Step 4.
Point browser
menu
GFK-1180K
7-27
Defined
Not defined
And:
Then:
An Initial Value
Accum Point
Value is
The Current
value of the
Expression is
Not defined
Not defined
Defined
Defined
Unavailable
Available
Unavailable
Available
Zero
Zero
Initial value
Initial value
7-28
Not defined
Defined
Zero
Initial value
GFK-1180K
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 floatingpoint number.
The average is calculated as the accumulation of the deviation from the average point
data, divided by the number of samples taken. The calculation is:
average = average + (source - average) / sample_count
or simply as
average + (source - average) / sample_count
The average is calculated as an eight-byte floating-point data type, then the result is
converted into the data type you specify for the average point.
Steps to define an Average point are:
Step 1.
Step 2.
Step 3.
Step 4.
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.
Point browser
menu
GFK-1180K
7-29
Defined
Not defined
And:
Then:
An Initial
Average Point
Value is
The Current
value of the
Expression is
Not defined
Not defined
Unavailable
Available
3
4
Defined
Defined
Unavailable
Available
Zero
Current value of the source
point
Initial value
Average of the source and
initialized value
7-30
Not defined
Unavailable*
Defined
Initial value*
When the trigger point is defined, the result will either be the source value
or the average of the source and initialized value.
GFK-1180K
Step 2.
Step 3.
Step 4.
Point browser
menu
GFK-1180K
7-31
Defined
Not defined
And:
Then:
An Initial Max
Capture Point
Value is
The Current
value of the
Expression is
Not defined
Unavailable
2
3
4
Not defined
Defined
Defined
Available
Unavailable
Available
Not defined
Defined
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-32
GFK-1180K
Step 2.
Step 3.
Step 4.
Point browser
menu
GFK-1180K
7-33
Defined
Not defined
And:
Then:
An Initial Min
Capture Value is
The Current
value of the
Expression is
Not defined
Not defined
Defined
Unavailable
Available
Unavailable
Defined
Available
Initial value
Current value
Max possible value for the
point type. E.g. for INT the
value is +32767
Whichever has the Min value
7-34
Not defined
Defined
GFK-1180K
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.
Step 2.
Step 3.
Step 4.
Point browser
menu
GFK-1180K
7-35
Defined
Not defined
And:
Then:
An Initial
Trans High Accum
Value is
The Current
value of the
Expression is
Not defined
Not defined
Defined
Defined
Unavailable
Available
Unavailable
Available
Zero
Zero
Initial value
Initial value
7-36
Not defined
Defined
Zero
Initial value
GFK-1180K
Step 2.
Step 3.
Step 4.
Point browser
menu
GFK-1180K
7-37
Although this will not cause CIMPLICITY software to fail, it will cause the
Virtual Point Processor to always have work to do. This causes all available
computer time to be consumed, which adversely impacts system
performance.
2.
3.
Step 3. (Optional) Define a trigger point for the Equation w/Override point:
(Optional) Enter a Point ID in the Trigger Point field.
Result: When the value of the equation w/override updates depends on whether or
not you defined the trigger point as follows:
Trigger point
Defined
Not defined
Step 4. (Optional) Define a reset point for the Equation w/Override point:
Result: Based on whether there is an entry in the Reset Point field, at runtime the
Equation /Override point is reset as follows:
If:
And:
Then:
An Initial Equation
w/Override Point
Value is
The Current
value of the
Expression is
Not defined
Not defined
Defined
Defined
Unavailable
Available
Unavailable
Available
Zero
Current value
Current value
Current value
7-38
Not defined
Defined
Zero
Initial value
GFK-1180K
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:
HIGH state, this field contains the time the Expression transitioned to the
HIGH state.
Time is stored in the number of seconds since 00:00:00 on January 1, 1970 GMT
(Greenwich Mean Time). If you computer's clock is set for another time zone, this value
is translated accordingly. For example, if your computer's clock is set for Eastern
Standard Time, the base time is 19:00:00 31 December 1969.
Steps to define a Timer/Counter point are:
Step 1.
Step 2.
Step 3.
Step 4.
Step 5.
2.
3.
GFK-1180K
7-39
When the Expression transitions from its LOW state to its HIGH state:
The third element of the array is set to the current system time
While the Expression remains in its HIGH state, the duration time in its
second element is increased at every Interval.
When the Expression transitions from its HIGH state to its LOW state, the
third array element is set to zero.
While the Expression remains in its LOW state, no elements of the array are
updated.
2.
Point browser
menu
7-40
GFK-1180K
Enter a Start Time that is at least 00:00:01 to be a base start time for the
Interval.
The format is hh:mm:ss
Where
hh is the hour,
mm is the minute, and
ss is the second value.
If you have a large number of Timer/Counter points being updated at a high
frequency, system performance can be adversely affected. You can use Start
Time to distribute their updates to different times and reduce the impact on
system performance
2.
Enter the time Interval between the Timer/Counter point updates while the
Expression value remains HIGH.
The format is hh_ss_mm
Where
hh is the number of hours,
mm is the number of minutes, and
ss is the number of seconds.
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.
GFK-1180K
7-41
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.
Histogram Points
A Histogram point records the frequency at which the value of the source point,
identified in the Expression field, updates within specified range intervals. This
information is typically displayed graphically as a histogram.
Each time the source point is updated, the counter whose range encompasses the source
point value is incremented.
You must configure a Histogram point as an array point. The number of elements in the
array will be:
the number of range intervals you desire + 6
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)
Step 2.
Step 3.
Step 4.
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.
7-42
GFK-1180K
Point browser
menu
GFK-1180K
Trigger point
Defined
Not defined
7-43
And:
Then:
An Initial Histogram
Value is
The Current
value of the
Expression is
Not defined
Not defined
Defined
Defined
Unavailable
Available
Unavailable
Available
Zero
Zero
Initial value
Initial value
Not defined
Defined
Zero
Initial value
A point called CYCLE_TIME is expected to have a value between 50 and 100, and you
want to track the frequency at which values occur within five intervals.
Create a Histogram point called HIST_CYCLE_TIME with:
Display Low
50
Display High
100
Elements
11
Expression
CYCLE_TIME
The eleven elements of this point contain the following information, where X is the
number of point value samples:
Element
Contents
HIST_CYCLE_TIME[0]
X<50
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]
(underflow bucket)
(overflow bucket)
7-44
GFK-1180K
The Update Criteria for the trigger point determines when triggered
reads take place. The criteria can either be when the trigger point value
changes or when it is scanned.
Virtual point
GFK-1180K
7-45
On the Virtual property page for SHIFT_NUMBER, select Global for the Calculation
Type. The value in SHIFT_NUMBER changes whenever a shift ends.
The Virtual properties for WIDGET_COUNT are:
changes.
The Virtual properties for NUT_COUNT are:
(For an analog device point) Select the base engineering units for an analog
device point and specify a linear or custom conversion for an analog device
point, or
(For an analog virtual point) Select the base engineering units for an analog
virtual point
Or
See "Point Conversions and Enumeration" in the "Configuring Device Points" chapter in
this manual for detailed information about available options and configuration.
7-46
GFK-1180K
Method 2
Select Edit Expression from the Pop-up menu
Either method opens the Edit Expression dialog box.
Continue
1.
2.
Tip: When you use a device Point ID in the Expression Editor for virtual points, the raw
value of the point is used by default.
If you want to use the engineering units value, enter EU_CONV(<point_id>) in the
expression.
GFK-1180K
7-47
Input box
Point ID
popup
Point's
Configuration
dialog box
New Point
dialog box
Double click an
available
operator
Tip: Use the Point IDs..., Edit Point and New Point buttons to browse through
existing points, edit a selected point or create a new point.
Operations are divided into the following areas:
7-48
Alarm functions.
Arithmetic.
Bitwise.
Conversion.
Logical.
Relational.
Scientific.
GFK-1180K
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
AL1 or WARNING_LOW
AL2 or ALARM_LOW
ANA or ALARM_NOT_ACKED
GFK-1180K
7-49
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
7-50
GFK-1180K
FLR
CEIL
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
IFELSE
Or
(expr1) ? (expr2) : (expr3)
SHL
GFK-1180K
7-51
SHR
Note: The IFELSE statement is not available from the operation keys. However, you
can enter it manually.
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, it is FALSE.
Logical operations supported by the Expression Editor are:
AND
OR
NOT
XOR
7-52
GFK-1180K
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-1180K
7-53
Scientific Operations
The scientific operations supported by the Expression Editor are:
SIN
COS
TAN
ASIN
ACOS
ATAN
X^Y
EXP
LOG
LOG10
7-54
GFK-1180K
A global point for a selected Point Type, the value rolls over based on the data
type range.
A virtual point, the point keeps its last value and remains as such until the next
valid value (the value that is within range).
Out of range means that the result is not within the range values specified by the Point
Type for the virtual point. For example, an INT point has a range between -32768 and
+32767.
GFK-1180K
7-55
Associate a CimView screen with any point so you can quickly review its status
through the Workbench.
2. Point Limits.
GFK-1180K
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 point's popup menu in the
Workbench.
You do this on the View tab of the Point Properties dialog box.
2.
3.
Select a Screen from the selection in the drop down menu. Your options include
CimView screens that are in the project directory.
The name of the screen you select will appear on the point's popup menu in
the Workbench. The screen will appear when it is selected.
The screen will display when a user selects this point in the Alarm Viewer
and clicks Screen.
Point Properties Dialog Box: View Tab
8-2
GFK-1180K
Justification,
Width and
High/Low limits.
You do this on the View tab of the Point Properties dialog box.
2.
GFK-1180K
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
8-4
GFK-1180K
Compact
Note: For integer point types, Decimal is the only format type.
Guide for enabling analog display configuration: When you configure an object
that uses the point in CimView, you have to enable the Justification and Width
configuration in CimEdit. You do this on the Text tab of the Object Properties dialog box
in CimEdit, in the Display Format field. See "CIMPLICITY HMI CimEdit Manual"
GFK-1396 for more information.
Example of Analog Point Display
A point's point type is UDINT
1 Point Properties dialog box View tab 2 CimEdit Object Properties dialog boxText Tab
Select "Configured" when configuring a text object that
uses the point.
1254387
GFK-1180K
8-5
Horizontal/Vertical movement
Rotation/Fill
Horizontal/Vertical scaling
If you have a single point expression in any of the above expressions and you do not
specify a minimum or maximum limit for the expression, the point's display limits are
used instead. If these limits are not specified either, default values of 0 (minimum) and
100 (maximum) are used.
Trending uses the graphics limits to determine the Y-axis limits for the point.
The display limits must be within the range limits you specify on the Limits properties
page.
Limit
Enter the:
Display High
Upper bound for the display. If the point value is greater than this
value, this Display High value displays.
Display Low
Lower bound for the display. If the point value is less than this value,
this Display Low value displays
Important: Make sure the display limits are within range limits that you set. See
"Configuring Range Limits" in this chapter.
8-6
GFK-1180K
Point Limits
You can specify range and setpoint limits for both device and virtual analog points on the
Limits tab that appears in the Advanced General tab group.
For device and virtual analog points, you can specify:
setpoint limits.
You do this on the Limits tab of the Point Properties dialog box.
Click Advanced on the General tab of the Point Properties dialog box.
2.
Select the Limits tab that appears if you are configuring an analog point.
Exclude
meaningless data.
Define range for
allowed setpoints.
2.
Enter the low and high limits in the Range limits box for the converted value of
the point.
Point Properties Dialog Limits Tab
Values below the low range limit and above the high range limit will display as
the point unavailable value.
GFK-1180K
8-7
Note: Range limits apply to only the first element of n array point.
Example
A PLC gives raw data in counts from 0 to 1000.
The raw data represents temperatures between -500 C and +500 C.
Values above 200 C or below -200 C are considered to be out of range.
8-8
The point value on CimView screens displays the default text until the point
comes back within raw limits.
Point Control Panel displays asterisks (******) for the point value until the
point comes back within raw limits.
The point value on CimView screens displays the default text until the point
comes back within raw limits
Point Control Panel displays asterisks (******) for the point value until the
point comes back within raw limits.
An alarm is generated when a point's value first exceeds its range limits.
When the point value returns to within its range limits, the Alarm State
will be set to Normal.
NO
GFK-1180K
2.
If a user enters a value below the low setpoint limit or above the high setpoint limit, the
value will not be accepted.
GFK-1180K
8-9
Basic Alarm tab option if you want to do a quick basic alarm configuration.
Alarm Routing.
Alarm Options.
Step 2.
Step 3.
8-10
GFK-1180K
Enter a message in the Alarm Message field that will be displayed with the
alarm in Alarm Viewer. This message may contain text plus variable information
that is determined when the alarm is generated.
The Advanced Alarm tab (and associated tabs) displays.
2.
Click Basic to display only the Alarm message and Alarm limits fields.
Result: The Alarm tab converts to basic view, including the Alarm Message and
basic Alarm Limits fields. The associated tab Alarm tabs disappear.
GFK-1180K
8-11
Note: You can type in variables for the alarm message or select them from the field's
popup menu. See "Alarm Definition" in this chapter. However, using several of the
available alarm message variables can involve advanced configuration.
Boolean point
8-12
GFK-1180K
Alarm Routing
Alarm Options
2.
Click Advanced.
The Advanced Alarm tab appears.
A detailed alarm definition can be entered or changed and be given an assigned Alarm
Class and string index.
GFK-1180K
8-13
An alarm delay.
A help file.
Note: You create an event alarm in the Alarms folder. See the "Alarm Configuration"
chapter in this manual for details. You can modify point alarms in both the Point
Properties dialog box and the Alarm Definition dialog box in the Alarms folder.
Alarm Definition
You can configure a basic I/O alarm message in the Alarm 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:
Class.
String.
Point Properties Dialog Box Advanced Alarm Tab
8-14
GFK-1180K
Enter a message in the Alarm Message field that will be displayed with the
alarm in Alarm Viewer. This message may contain text plus the following
variable information that is determined when the alarm is generated. The total
display length for all fixed text and variables is 80 characters.
Alarm TabBasic ViewMessage with Variables
Entries
%ID
%VAL
%EU
%STATE
%LIMIT
%DEV_ID
%DEV_VAL
%DEV_AMT
You can type in the variables or select them from the field's popup menu. Type
them all as capital letters (CAPS).
GFK-1180K
Variable
Displays the:
%ID
Point ID
% LIMIT
%VAL
%EU
%STATE
%DEV_ID
%DEV_VAL
%DEV_AMT
%%
8-15
Example
An alarm string is configured so that the string for
The Alarm High and Warning High limits are 400 and 350 degrees.
The alarm message is:
CONDITION: %STATE - TEMP IS AT %VAL DEGREES
Enter a String Index number to identify the alarm text, if you are using
%STATE in your alarm message.
Select an Alarm
String browser
Alarm String popup
2 The associated
text appears
as the Alarm
Limits
8-16
GFK-1180K
If the temperature reads 353 degrees, an alarm will be generated with the
message:
CONDITION: WARNING - TEMP IS AT 353 DEGREES
If the temperature goes to 402 degrees, the alarm will be updated and the
message will read:
CONDITION: EMERGENCY - TEMP IS AT 402 DEGREES
GFK-1180K
8-17
2.
3.
4.
New
5.
Previously created.
6.
7.
Select a priority number in the Order field. CIMPLICITY gives alarms with a 1order number the highest priority.
Note: CIMPLICITY uses these priorities internally and to prioritize
occurrences, such as alarm sound.
If you assign the same order to more than one class, the classes are alphabetized
within the order.
8-18
GFK-1180K
Example
You assign order 0 to High, Medium and Low alarm classes.
The alphabetized class order is High, Low, Medium. Alarms in these classes
will display in the High, Low, Medium order, when sorted by class in the Alarm
Viewer.
Step 2. Select colors for the Alarm Class:
1.
Different color for the Background for alarms to which the class is
assigned.
Normal State
Alarm State
Acknowledged State
Note: Default colors are White for the text and Black for the background.
2.
3.
Enter a Blink rate for each alarm state in which you want the alarm to blink.
Value
Rate/Second
20
Enter a foreground and background color that will alternate with the other
foreground and background colors selected for that state.
GFK-1180K
Alternate with the blink colors at the specified rate to create a blink.
8-19
1 Font color
2 Class Background
(different) color
3 No blink
4 2 blinks per second
5 10 blinks per second
3
Blink colors
Beep
specifications
8-20
2.
3.
GFK-1180K
Wave files
A. Enter a Frequency between 37 and 32767 on the Audio tab of the Alarm
Class Configuration dialog box. The higher the number the higher the pitch.
B. Enter the Duration of the beeps.
C. Enter the No of beeps that will beep in the duration time.
Test either type of sound with the Test button.
You can edit your class by simply selecting Edit on the popup menu.
Alarm Criteria
You can select one of the following methods for evaluating the alarm values:
Alarm Criteria
Used to
Absolute
Deviation
Detect when the value of a point deviates too far from that of a
second point.
On Update
Rate of Change
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.
GFK-1180K
Select Absolute in the Alarm Type field on the advanced Alarm tab.
8-21
2.
Enter at least one and up to four values in the Alarm Limits fields.
Each time the point's value is updated, its current value is compared with the
alarm values. An alarm is generated when the point's value transitions from one
Alarm State to another.
The transitions are:
State
Description
Alarm High
Warning High
Normal
Warning Low
Alarm Low
If the point is in normal state, the Point Manager resets alarms for the point.
Deviation Alarming
Deviation alarming is used to detect when the value of a point deviates too far from that
of a second point.
To configure deviation alarming:
1.
8-22
Select Deviation in the Alarm Type field on the advanced Alarm tab.
GFK-1180K
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:
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.
Deviation alarming,
Converted value of the deviation point (if the deviation point also has
EU)
If you choose the On Update alarm criteria, you cannot define Alarm Values. Each time
the point's value is updated, an alarm is generated.
GFK-1180K
8-23
Important: Unsigned analogs (UDINT, UINT, USINT, 3D_BCD and 4D_BCD) cannot
have rate of change alarms. If you try to configure a rate of change alarm you will see an
"Invalid point type for rate of change alarm" error message.
Rate of Change alarming detects either a faster or slower than expected change in the
value of a point.
To configure rate of change alarming:
1.
2.
Select Rate of Change in the Alarm Type field on the advanced Limits tab.
3.
4.
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.
Important: The minimum Rate of Change interval is 5 seconds.
5.
8-24
GFK-1180K
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
To check for:
Positive
Increasing values
Negative
Decreasing values.
Alarm Limit
Limit Value
Alarm High
Positive
Alarm High
Alarm High
Negative
Alarm High
Warning High
Positive
Warning High
Warning High
Negative
Warning High
Warning Low
Positive
Warning Low
Warning Low
Negative
Warning Low
Alarm Low
Positive
Alarm Low
Alarm Low
Negative
Alarm Low
Define an upper and lower alarm limit and an upper and lower
warning limit for the point value.
Rate of Change
GFK-1180K
8-25
Deviation
Alarm Delay
Alarm Delay delays the display of the alarm on Alarm Viewers and other Alarm
Management Interested Processes unless the point remains in an alarm state for the
configured interval.
The Alarm Delay feature is only available when you select Absolute or Deviation alarms.
If you select the Delay Alarms check box, the Interval fields represent the length of the
delay before the alarm is reported.
When an alarm condition is
detected for a point and if:
8-26
GFK-1180K
2.
3.
Seconds
Minutes
Hours
Point Manager sends the information immediately to the Alarm Manager and all
other Point Management Interested Processes such as CimView and the Event
Manager.
2.
Note: Delay alarm is not available when Rate of Change criteria is selected.
GFK-1180K
8-27
Check if and when you want an alarm to be logged in the Alarm Logging box on
the Alarm tab. You can select any or all of the options:
Generate
Acknowledge
Delete
Reset
The alarm will be logged when any of the checked actions occur.
2.
Click OK or Apply.
Result: CIMPLICITY adds the point to its default ALARM_LOG. You can apply
these and more specifications in the Database Logger.
See the "Database Logger" chapter in this manual for information about configuring
log tables.
8-28
GFK-1180K
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).
If the point has EU, the EU converted deadband is used for all calculations.
GFK-1180K
8-29
Routing Alarms
The Alarm Routing properties let you select the Roles that can view any alarms generated
by this point.
You can:
Note: You can also configure alarm routing in the point alarm's Alarm Definition dialog
box in the Alarms folder. The configuration displays in both dialog boxes. See the "Alarm
Configuration" chapter in this manual for details about configuring alarms in the Alarms
folder.
Select the Alarm Routing tab in the Point Properties dialog box.
2.
Select a user role in the Available Roles column that can view the alarms.
3.
Click Add. The role will move over to Configured Roles For Alarm column.
4.
Click OK.
Alarm Routing: Add Roles through Point Properties
Result: Users assigned the selected role can now view alarms generated by the
point.
8-30
GFK-1180K
Select the Alarm Routing tab in the Point Properties dialog box.
2.
3.
Click Remove. The role will move over to the Available Roles column.
4.
Click OK.
Alarm Routing: Remove Roles through Point Properties
Result: Users assigned the selected role can no longer view alarms generated by
the point.
GFK-1180K
8-31
Click New.
The New Role dialog box opens.
2.
3.
Click OK.
The Role Properties dialog box opens if the Role ID you entered is valid.
8-32
4.
5.
Click OK to create the new Role and return to the Alarm Routing properties.
GFK-1180K
Automatic actions.
Deletion requirements.
You have the ability in CIMPLICITY HMI to enter your specifications for each stage in
the sequence.
Note: You can also configure alarm options in the point alarm's Alarm Definition dialog
box in the Alarms folder. The configuration displays in both dialog boxes. See the "Alarm
Configuration" chapter in this manual for details about configuring alarms in the Alarms
folder.
Automatic Actions
Automatic actions on the Alarm Options tab include:
GFK-1180K
Alarm Repeats.
Automatic acknowledgements.
Automatic reset.
8-33
Alarm Repeats
Auto repeat, on the Alarm Options tab, is the time (in minutes) that the Alarm Manager
waits before repeating the alarm to all Alarm Line Printer (AMLP) processes. Setting a
repeat timeout will cause the point's alarm to be reprinted on the Alarm Line Printer until
it is acknowledged, reset or deleted.
To specify the auto repeat:
Select None or Timed in the Auto Repeat field.
None
The alarm will not be repeated.
Timed
Select the number of minutes between alarms, in the minutes field that appears.
Note: The actual number of minutes that the Alarm Manager will wait before repeating
the alarm may be greater than this number. The maximum time will be the number you
enter in this field plus the number of minutes configured for the timer for processing
automatic alarms in the Alarm Manager configuration file (alarm_mgr.dat). The
default for this timer is 5 minutes.
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.
8-34
GFK-1180K
Manually.
Automatically.
Because the condition causing the alarm no longer exists, and the process that
detected the alarm condition automatically reset the alarm.
Alarm reset configuration is done on the Alarm Options tab of the point's Properties
dialog box.
To allow the alarm to be reset manually:
Check the Manual Reset Allowed checkbox.
Reset by the process that detected the condition that generated the alarm.
Immediate
The Alarm Manager immediately resets the alarm. If you select this option, the alarm
will not repeat.
Timed
Enter the number of minutes, in the minutes field that appears, that the Alarm Manager
should wait before automatically resetting the alarm .
GFK-1180K
8-35
Alarm Deletion
The Deletion Requirements are the conditions that must exist in order for an alarm to be
deleted (removed from the system).
If you select both check boxes on the Alarm Options tab of the point's Properties dialog
box, the alarm will not be deleted until it is acknowledged and reset (these actions may
occur in any order).
8-36
GFK-1180K
Note: You can also use the Workbench to monitor runtime behavior, to include:
Opening the Point Control Panel to monitor and control runtime point behavior.
Selected points.
2.
Tell CIMPLICITY HMI to automatically display all the points by either of the
following methods:
Method 1
A. Click View on the Workbench menu bar.
B. Select AutoFill if there is no check mark on its left side.
GFK-1180K
9-1
Method 2
A. Place the cursor in the right pane.
B. Click the right mouse button.
C. Select AutoFill from the popup menu if there is no check mark on its left
side.
CIMPLICITY HMI displays a list of all the existing points when you use either
method.
Note: Points with a $ as the first character in the name are system points and cannot be
changed or removed.
2.
9-2
GFK-1180K
Method 2
A. Place the cursor in the Workbench right pane.
B. Click the right mouse button.
C. Select Search.
Method 3
Click the Search button
The Point search dialog box appears when you use any method.
3.
Open a
Browser
window.
One or more criteria.
GFK-1180K
9-3
After
Before
Between
The point or points you specify will display in the right pane until you change your
specifications.
9-4
GFK-1180K
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.
Resource browser
Display
filters.
Double-click
to select.
2.
3.
GFK-1180K
9-5
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
9-6
GFK-1180K
Method 2
A. Click View on the Workbench menu bar.
B. Select Field Chooser.
View Drop Down Menu
Method 3
Click Field Chooser
The Field Chooser dialog box for points opens when you use any of these
methods.
Indicates if point has
changed and project
needs configuration
update
3.
Select a field in the Available field column that you want to add to your display.
4.
Click Add. The field will move over to the Display Fields column.
5.
Select any field in the Display fields column that you do not want to display.
6.
Click Remove. The field will move over to the Available field column.
7.
Use the Move Up and Move Down buttons change a selected fields place in
the list.
8.
GFK-1180K
Up
Down
Click OK. The fields display from left to right in the order you specified.
9-7
To Display
Access Filter
Address
Address Offset
Alarm High
Alarm Low
Data Length
Data Type ID
Description
Device ID
point.
$DERIVEDIndicates that the point is a Calculated
derived point.
9-8
GFK-1180K
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.
GFK-1180K
9-9
User defined.
Runtime.
Quality.
Configuration.
Event Editor,
BCE scripts.
CIMPLICITY lists the attributes that are available to each point in the Select a Point
Browser. You can open the Select a Point Browser from any expression field. See page
10-11 for details.
GFK-1180K
10-1
Create several user defined fields, (attribute definitions) within a set, then
2.
Associate the attribute set with a point. (The same attribute set can be associated
with more than one point.), then
3.
Event Editor,
BCE scripts.
Example
The processes for a machine point called MACH_TEMP are different depending on
whether or not a man is online. You:
1.
2.
3.
Associate the attribute set PROC with the machine's MACH_TEMP point.
4.
Create a CimView screen object that displays the value of the MOL field.
During runtime, the CimView screen will alert users whether or not a man is online
for the point MACH_TEMP provided your application has set the attribute.
USER_FLAGS (Attribute)
A CIMPLICITY HMI provided attribute, USER_FLAGS, enables any point to access its
entire 16-bit user set at once. This capability does not require additional configuration.
Associated Point Type
Device or Virtual
Access
Read only
Value Type
UINT
Expression Syntax
PointID.USER_FLAGS
The value of USER_FLAGS can be logged. See the "Configuring the Database Logger"
chapter in this manual for details about logging point attributes.
10-2
GFK-1180K
2.
Result: The Workbench right pane displays the list of Point attribute sets in the right
pane.
Step 2.
Step 3.
Step 4.
Step 5.
2.
GFK-1180K
10-3
Method 5
A. Right-click an attribute set in the Workbench right pane.
A Popup menu appears.
B. Select New.
Open a New Attribute Set Dialog Box
Drop down menu
Popup menu
Keyboard
Ctrl+N
Select the General tab in the Point Properties dialog box for the point you are
configuring.
2.
3.
4.
Result: The New Attribute Set dialog box opens when you use any method.
10-4
GFK-1180K
Enter the name of the new attribute set in the Set Name field.
The name can:
2.
Be up to 32 characters long.
Click OK
Result: The system verifies that the attribute set name does not already exist, and that
no invalid characters have been used.
If the attribute set name you entered is valid, an Attribute Set dialog box for the new
attribute set opens.
2.
GFK-1180K
Be up to 16 characters long.
Have alphanumeric characters and underscores only:
10-5
3.
Enter the bit position at which the attribute should start in the Start field.
You can choose from 0 through 15.
4.
5.
When checked
Save on shutdown
Read only
6.
Click OK .
The Attribute Field dialog box closes and the Attribute Sets dialog box displays
the Field Name with its Field Start and Size information.
10-6
GFK-1180K
7.
Continue to add attributes until you have listed all the attributes that should be
associated with a selected point.
Note: Step 4 (next) assumes that you know how to configure points. For in depth
information about configuring points, see the points chapters in the CIMPLICITY HMI
Base System User's Manual (GFK-1180).
Open the Properties dialog box for the point with which you want to associate
the point set.
2.
3.
Enter the Attribute Set name that you want to associate with the point in the
Attribute Set field.
.
Result: The point now has an associated attribute set. Each field in the set can be used
to associate additional information with the point.
Note: Step 5 (next) assumes that you know how to configure CimEdit screens. For in
depth information about configuring CimEdit, see the CIMPLICITY HMI CimEdit
Manual (GFK-1396).
GFK-1180K
10-7
Open the CimEdit screen on which the attribute set will be used.
2.
3.
Display the relevant expression field in the object's Properties dialog box.
4.
Result: During runtime, the object will reflect the field value and will adhere to the
field characteristics that were specified in the Attribute Field dialog box.
10-8
GFK-1180K
2.
3.
Popup menu
Properties button
Keyboard
Alt+Enter
GFK-1180K
1.
Select the General tab in the Point Properties dialog box for the point you are
configuring..
2.
3.
4.
Click the Popup button to the right of the Attribute Set field.
10-9
5.
The Attribute Set dialog box associated with the selected attribute set opens.
Continue in the open Attribute Set dialog box
1.
2.
3.
Click OK.
Result: The Attribute Field dialog box closes and the field is changed.
10-10
GFK-1180K
Attributes Applied
CIMPLICITY provides four categories of point attributes:
User
Quality
Runtime
Configuration
Where
<point ID> is a normally configured point ID
<point attribute> is one of the point attributes described in this chapter
You can also use the CIMPLICITY Point browser to simply select an attribute that is
available for a selected point and apply it to the application in which you are working.
Example
You have a device point called, for example, S90_550.
You want to review the point's values and the time that the values are read on a CimView
screen. See page 10-21 for details about the TIMESTAMP attribute.
The following steps enable you to easily configure the point attribute.
GFK-1180K
Step 1.
Step 2.
Step 3.
10-11
2.
Place the cursor on the screen where you want the text object to appear.
The Properties - Object dialog box opens.
3.
4.
5.
7.
10-12
GFK-1180K
GFK-1180K
10-13
2.
Place the cursor on the screen where you want the text object to appear.
The Properties - Object dialog box opens.
3.
4.
5.
Point
expanded.
Tree under
point.
10-14
GFK-1180K
7.
Result: The text Point Time appears under Point Value on the CimEdit screen.
GFK-1180K
10-15
Result: The Point value displays; the time the value was read displays below.
10-16
GFK-1180K
Quality Attributes
CIMPLICITY provides attributes that enable a user to assess the quality of a point in
order to evaluate the quality of the data it sends or receives.
The quality attributes are:
QUALITY
QUALITY.MANUAL_MODE
QUALITY.ALARMED
QUALITY.ALARMS_ENABLED
QUALITY.DISABLE_WRITE
QUALITY.IS_IN_RANGE
QUALITY.LAST_UPD_MAN
QUALITY.STALE_DATA
QUALITY (Attribute)
QUALITY is not configuration data, as with value attributes, but is used to dynamically
change the behavior of a point, or dynamically reflect runtime information about the
point.
QUALITY is the sum of all its current binary values in decimal format.
Associated Point Type
Device
Access
Read Only
Value Type
UINT
Expression Syntax
PointID.QUALITY
QUALITY can also be configured to display the state of each of its individual indicators.
Following are the CIMPLICITY HMI read-only indicators located at each of the 16 bit
positions.
GFK-1180K
Indicator
Bit Position
MANUAL_MODE
0x01
LAST_UPD_MAN
0x02
IS_AVAILABLE
0x04
IS_IN_RANGE
0x08
STALE_DATA
0x10
ALARMS_ENABLED
0x20
DISABLE_WRITE
0x40
ALARMED
0x80
10-17
QUALITY.MANUAL_MODE (Attribute)
QUALITY.MANUAL_MODE can be used as an attribute that references the QUALITY
indicator called MANUAL_MODE.
QUALITY.MANUAL_MODE enables a user to take a device point that may or may not be
currently available and put it in manual mode. The user can then set the point's value.
This is particularly useful if a point is attached to equipment that is known to be
malfunctioning and, as a result, creates a problem in other areas of the system. This
indicator enables a user to separate the point from that equipment and set the point to a
known good value that preserves the system's integrity.
Example
A temperature sensor that reports temperatures, which are acted upon by CIMPLICITY
HMI applications to initiate temperature control actions, fails. To continue the high
temperature setting, a user with Modify attributes privilege places the point that reflects
the errant sensor in manual override mode. The user then sets a value that causes the
application to cease the unnecessary temperature control procedures. This allows users
who are knowledgeable of their CIMPLICITY HMI application implementation to make
emergency, temporary adjustments to their systems operation. Consequently the
application does not have to anticipate and provide for handling of all possible failures in
its implementation.
Associated Point Type
Device
Access
Value Type
Boolean
Expression Syntax
PointID.QUALITY.MANUAL_MODE
Description
QUALITY.ALARMED (Attribute)
Associated Point Type
Access
Read only
Value Type
Boolean
Expression Syntax
PointID.QUALITY.ALARMED
Description
10-18
GFK-1180K
QUALITY.ALARMS_ENABLED (Attribute)
Associated Point Type
Device or Virtual.
Access
Write
Value Type
Boolean
Expression Syntax
PointID.QUALITY.ALARMS_ENABLED
Description
QUALITY.DISABLE_WRITE (Attribute)
Associated Point Type
Device or Virtual
Access
Value Type
Boolean
Expression Syntax
PointID.QUALITY.DISABLE_WRITE
Description
QUALITY.IS_AVAILABLE (Attribute)
Associated Point Type
Device or Virtual
Access
Read only
Value Type
Boolean
Expression Syntax
PointID.QUALITY.IS_AVAILABLE
Description
GFK-1180K
10-19
QUALITY.IS_IN_RANGE (Attribute)
Associated Point Type
Device or Virtual
Access
Read only
Value Type
Boolean
Expression Syntax
PointID.QUALITY.IS_AVAILABLE
Description
QUALITY.LAST_UPD_MAN (Attribute))
Associated Point Type
Access
Value Type
Expression Syntax
Description
Returned Values
Device or Virtual
Read Only
Boolean
PointID.LAST_UPD_MAN
QUALITY.STALE_DATA (Attribute)
Associated Point Type
Device or Virtual
Access
Read only
Configured on the General tab of the Port
Properties dialog box.
Value Type
Boolean
Expression Syntax
PointID.STALE_DATA
Description
Returned Values
10-20
GFK-1180K
Runtime Attributes
CIMPLICITY provides you with an attribute that enables you to view the date and time a
point's value is updated.
TIMESTAMP
Associated Point Type
Device
Access
Read only
Value Type
System generated
Expression Syntax
PointID.TIMESTAMP
Description
Default Display
MM/DD/YY HHHH:MM:SS:TTT A
Note: TTT = milliseconds; A = AM or PM
GFK-1180K
10-21
Configuration Attributes
Following is a list of configuration attributes.
$RAW_VALUE
ACCESS_FLAG
ACK_TOUT
ADDR
ADDR_OFFSET
ALARM_CIRTERIA
ALARM_DELAY
ALARM_HIGH
ALARM_HIGH_N
ALARM_LOW
ALARM_LOW_N
ALARM_STATE
ANALOG_DEADBAND
ANALOG_DEADBAND_N
CALCULATION_TYPE
CLR_TOUT
CONV_TYPE
DEADBAND
DEADBAND_N
DEL_OPT
DESCRIPTION
DEVIATION_PTID
DEVICE_ID
DISPLAY_LIM_HIGH
DISPLAY_LIM_HIGH_N
DISPLAY_LIM_LOW
DISPLAY_LIM_LOW_N
DP_FLAG
EU_LABEL
EU_EXPRESSION
EU_REV_EXP
EXTRA
FLAGS
FORMAT_WID
FORMAT_PREC
FR_ID
INIT_VALUE
LEVEL
LOCAL
MEASUREMENT_UNIT_ID
PROCESS_ID
PTMGMT_PROCESS_ID
POINT_SET_TIME
POINT_SET_INTERVAL
POINT_STATE
RATE_TIME_INTERVAL
RANGE_HIGH
RANGE_HIGH_N
RANGE_LOW
RANGE_LOW_N
REP_TOUT
RESET_POINT_ID
ROLLOVER_VALUE
SCAN_POINT
SCAN_RATE
SETPOINT_HIGH
SETPOINT_HIGH_N
SETPOINT_LOW
SETPOINT_LOW_N
SETPT_CHECK_PTID
TRIGGER_POINT
TRIGGER_TYPE
TRIGGER_VALUE
VARIANCE_VALUE
WARNING_HIGH
WARNING_HIGH_N
WARNING_LOW
WARNING_LOW_N
$RAW_VALUE
10-22
All
Value Type
Access
Raw Value
Description
GFK-1180K
ACCESS_FLAG
Associated Point Type
All
Value Type
1 character
Access
Read only
Access
Description
Returned values
0 = Read only
2 = Read/Write
ACK_TOUT
Associated Point Type
All
Value Type
Integer
Access
Read only
Acknowledge Timeout
Description
Returned Values
-1=Acknowledge immediately
0=No auto acknowledge
>0=Minutes to wait for automatic
acknowledge
ADDR
Associated Point Type
Device
Value Type
256 characters
Access
Read only
Address
Description
ADDR_OFFSET
GFK-1180K
Device
Value Type
Integer
Access
Read only
Address Offset
Description
10-23
ALARM_CRITERIA
Associated Point Type
All
Value Type
Integer
Access
Read only
Alarm Criteria
Description
Returned Values
1=Absolute
2 = Deviation
4 = Rate of Change
16 = On Update
ALARM_DELAY
Associated Point Type
All
Value Type
Integer
Access
Read only
Delay Alarms
Description
Returned Values
ALARM_HIGH
Associated Point Type
All
Value Type
10 characters
Access
Read only
Alarm High
Description
ALARM_HIGH is 0.
10-24
GFK-1180K
ALARM_HIGH_N
Associated Point Type
All
Value Type
REAL
Access
Read only
Alarm High_N
Description
ALARM_HIGH_N is 0.
Empty: ALARM_HIGH_N is 0.
ALARM_LOW
Associated Point Type
All
Value Type
10 characters
Access
Read only
Alarm Low
Description
ALARM_LOW is 0.
ALARM_LOW_N
Associated Point Type
All
Value Type
REAL
Access
Read only
Alarm Low
Description
ALARM_LOW_N is 0.
Empty: ALARM_LOW_N is 0.
GFK-1180K
10-25
ALARM_STATE
Associated Point Type
All
Value Type
2 bytes
Access
Read only
Enable Alarm
Description
Enable/Disable alarm.
Returned Values
0 = Disable
1 = Enable
ANALOG_DEADBAND
Associated Point Type
Device
Value Type
10 characters
Access
Read only
Analog Deadband
Description
ANALOG_DEADBAND is 0.
ANALOG_DEADBAND_N
Associated Point Type
Device
Value Type
REAL
Access
Read only
Analog Deadband
Description
ANALOG_DEADBAND_N is 0.
Empty: ANALOG_DEABAND_N is 0.
10-26
GFK-1180K
CALCULATION_TYPE
Associated Point Type
Derived (Virtual)
Value Type
1 character
Access
Read only
Calc Types
Description
Returned Values
0 = Equation
1 = Delta Accumulator
2 = Value Accumulator
3 = Average
4 = Maximum
5 = Minimum
7 = Transition High Accumulator
8 = Equation with Override
9= Timer/Counter
10 = Histogram
CLR_TOUT
Associated Point Type
All
Value Type
Integer
Access
Read only
Reset Timeout
Description
Returned Values
CONV_TYPE
Associated Point Type
Device
Value Type
2 bytes
Access
Read only
Conversion Type
Description
Returned Values
0 = None
1 = Linear conversion
2 = Custom conversion
GFK-1180K
10-27
DEADBAND
Associated Point Type
All
Value Type
10 characters
Access
Read only
Alarm Deadband
Description
DEADBAND is 0.
DEADBAND_N
Associated Point Type
All
Value Type
REAL
Access
Read only
Alarm Deadband
Description
DEADBAND_N is 0.
Empty: DEADBAND_N is 0.
DEL_OPT
Associated Point Type
All
Value Type
2 characters
Access
Read only
Deletion Requirements
Description
Returned Values
= Acknowledge
= Reset
DESCRIPTION
10-28
All
Value Type
40 characters
Access
Read only
Description
Description
Description of point
GFK-1180K
DEVIATION_PTID
Associated Point Type
All
Value Type
32 characters
Access
Read only
Deviation Point
Description
DEVICE_ID
Associated Point Type
Device
Value Type
32 characters
Access
Read only
Device ID
Description
DISPLAY_LIM_HIGH
Associated Point Type
All
Value Type
10 characters
Access
Read only
Description
DISPLAY_LIM_HIGH is 0.
DISPLAY_LIM_HIGH_N
Associated Point Type
All
Value Type
REAL
Access
Read only
Description
DISPLAY_LIM_HIGH_N is 0.
Empty: DISPLAY_LIM_HIGH_N is 0.
GFK-1180K
10-29
DISPLAY_LIM_LOW
Associated Point Type
All
Value Type
10 characters
Access
Read only
Description
DISPLAY_LIM_LOW is 0.
DISPLAY_LIM_LOW_N
Associated Point Type
All
Value Type
REAL
Access
Read only
Description
DISPLAY_LIM_LOW_N is 0.
Empty: DISPLAY_LIM_LOW_N is 0.
DP_FLAG
Associated Point Type
Value Type
1 character
Access
Read only
Startup Condition
Description
Returned Values
0 = Not Applicable
1 = Init
2 = Saved
3 = Saved or Init
EU_LABEL
10-30
All
Value Type
8 characters
Access
Read only
Eng. Units
Description
GFK-1180K
EU_EXPRESSION
Associated Point Type
Device
Value Type
300 characters
Access
Read only
Description
EU_REV_EXP
Associated Point Type
Device
Value Type
300 characters
Access
Read only
Description
EXTRA
Associated Point Type
All
Value Type
Access
Read only
Extra info
Description
FLAGS
Associated Point Type
Device
Value Type
1 character
Access
Read only
Description
Returned Values
GFK-1180K
10-31
FORMAT_WID
Associated Point Type
All
Value Type
2 Bytes
Access
Read only
Display Width
Description
FORMAT_PREC
Associated Point Type
All
Value Type
2 Bytes
Access
Read only
Display Precision
Description
All
Value Type
32 characters
Access
Read only
Resource ID
Description
FR_ID
INIT_VALUE
Associated Point Type
Value Type
32 characters
Access
Read only
Initial Value
Description
LEVEL
10-32
Value Type
Integer
Access
Read only
Level
Description
GFK-1180K
LOCAL
Associated Point Type
Value Type
Boolean
Access
Read only
Local Value
Description
Returned Values
0 = Report value
1 = Do not report value
MEASUREMENT_UNIT_ID
Associated Point Type
All
Value Type
32 characters
Access
Read only
Measurement unit ID
Description
PROCESS_ID
Associated Point Type
Value Type
32 characters
Access
Read only
Virtual Proc ID
Description
PTMGMT_PROCESS_ID
Associated Point Type
Value Type
32 characters
Access
Read only
Point Manager
Description
GFK-1180K
10-33
POINT_SET_TIME
Associated Point Type
Value Type
8 characters
Access
Read only
Start Time
Description
POINT_SET_INTERVAL
Associated Point Type
Value Type
8 characters
Access
Read only
Interval
Description
POINT_STATE
Associated Point Type
Device
Value Type
Boolean
Access
Read only
Enabled
Description
Returned Values
0 = Disabled
1 = Enabled
RATE_TIME_INTERVAL
10-34
All
Value Type
Integer
Access
Read only
Interval
Description
GFK-1180K
RANGE_HIGH
Associated Point Type
All
Value Type
10 characters
Access
Read only
Range high
Description
RANGE_HIGH is 0.
RANGE_HIGH_N
Associated Point Type
All
Value Type
REAL
Access
Read only
Range high
Description
RANGE_HIGH_N is 0.
Empty: RANGE_HIGH_N is 0.
RANGE_LOW
Associated Point Type
All
Value Type
10 characters
Access
Read only
Range low
Description
RANGE_LOW is 0.
GFK-1180K
10-35
RANGE_LOW_N
Associated Point Type
All
Value Type
REAL
Access
Read only
Range low
Description
RANGE_LOW_N is 0.
Empty: RANGE_LOW_N is 0.
REP_TOUT
Associated Point Type
All
Value Type
Integer
Access
Read only
Repeat Timeout
Description
Returned Values
0= Never
>0= Minutes before automatic re-send
RESET_POINT_ID
Associated Point Type
Value Type
32 characters
Access
Read only
Reset Point
Description
ROLLOVER_VALUE
10-36
Derived (Virtual)
Value Type
Integer
Access
Read only
Rollover
Description
GFK-1180K
SCAN_POINT
Associated Point Type
Device
Value Type
2 bytes
Access
Read only
Update Criteria
Description
Returned Values
0 = Unsolicited
1 = On Change
2 = On Scan
4 = On Demand On Scan
5 = On Demand On Change
6 = Unsolicited On Change
7 = Poll Once On Change
8 = On Demand Unsolicited
9 = On Demand Poll Once
10 = On Demand Unsolicited On Change
11 = On Demand Poll Once On Change
SCAN_RATE
Associated Point Type
Device
Value Type
2 bytes
Access
Read only
Scan Rate
Description
SETPOINT_HIGH
Associated Point Type
All
Value Type
10 characters
Access
Read only
Setpoint high
Description
SETPOINT_HIGH is 0.
GFK-1180K
10-37
SETPOINT_HIGH_N
Associated Point Type
All
Value Type
REAL
Access
Read only
Setpoint high
Description
SETPOINT_HIGH_N is 0.
Empty: SETPOINT_HIGH_N is 0.
SETPOINT_LOW
Associated Point Type
All
Value Type
10 characters
Access
Read only
Setpoint low
Description
SETPOINT_LOW is 0.
SETPOINT_LOW_N
Associated Point Type
All
Value Type
REAL
Access
Read only
Setpoint low
Description
SETPOINT_LOW_N is 0.
Empty: SETPOINT_LOW_N is 0.
10-38
GFK-1180K
SETPT_CHECK_PTID
Associated Point Type
All
Value Type
32 characters
Access
Read only
Safety Point
Description
TRIGGER_POINT
Associated Point Type
Device/Derived (Virtual)
Value Type
32 characters
Access
Read only
Trigger
Description
TRIGGER_TYPE
Associated Point Type
Device
Value Type
2 bytes
Access
Read only
Relation
Description
Returned Values
0 = No Trigger
1 = On Change
2 = Equal
3 = Less Than
4 = Greater Than
5 = Less Than or Equal
6 = Greater Than or Equal
GFK-1180K
10-39
TRIGGER_VALUE
Associated Point Type
Device
Value Type
16 characters
Access
Read only
Value
Description
VARIANCE_VALUE
Associated Point Type
Derived (Virtual)
Value Type
Integer
Access
Read only
Variance value
Description
WARNING_HIGH
Associated Point Type
All
Value Type
10 characters
Access
Read only
Warning High
Description
WARNING_HIGH is 0.
WARNING_HIGH_N
Associated Point Type
All
Value Type
Real
Access
Read only
Warning High
Description
WARNING_HIGH_N is 0.
Empty: WARNING_HIGH_N is 0.
10-40
GFK-1180K
WARNING_LOW
Associated Point Type
All
Value Type
10 characters
Access
Read only
Warning Low
Description
WARNING_LOW is 0.
WARNING_LOW_N
Associated Point Type
All
Value Type
REAL
Access
Read only
Warning Low
Description
WARNING_LOW_N is 0.
Empty: WARNING_LOW_N is 0.
GFK-1180K
10-41
Configuring Classes
Classes and Class Objects Overview
Instead of repeating configuration, which may include creating complex
CimEdit/CimView screens, for several objects that have similar requirements, you can
now do the basic configuration once and use it over and over.
2 One or more
Attributes
Data Items
Actions
Scripts
Events
Attributes
Points
Actions
Scripts CimEdit
Events Screen
Class
Attributes
Points
Actions
Scripts CimEdit
Events Screen
CimEdit
Screen
Attributes
Points
Actions
Scripts CimEdit
Events Screen
objects can be
created from the
class.
Object 1
Object 2
Object N
Note: A custom help file can be created with third party tools and
also associated with the class.
GFK-1180K
11-1
See page 11-79 for the procedure to import a class (.soc) file into a project.
Note: In the next chapter, "Configuring Class Objects," the sample class is used as a
basis for a sample point object.
11-2
1.
2.
3.
Map out the layout of how memory is stored in the devices from which data is
collected.
4.
5.
Determine the CIMPLICITY features, e.g. points, scripts, actions and events,
required to collect and calculate data.
July 2001
GFK-1180K
Use
Attributes (variables)
Data items
Numeric Expressions
String Expressions
Scripts
Events
Actions
Help File
GFK-1180K
Configuring Classes
11-3
A class includes the tools to create a template that incorporates a wide variety of
CIMPLICITY features.
Class
Scripts
Attributes
CIMPLICITY
Class
Attributes
String Exp.=String
Expressions
2.
Custom
Attributes
Actions
Events
String
Exp.
String
Exp.
Data Items
String
Expressions
Numeric
Expressions
CimEdit Screen
CIMPLICITY
Numeric
Attributes
You have access to these tools through a Class dialog box and CimEdit.
Associate a
CimEdit screen
Access to Class configuration tools.
Help file
Note: One exception, custom help, is created with third party documentation tools.
End of example.
11-4
July 2001
GFK-1180K
End of example.
When an object designer clicks OK in an Object Properties dialog CIMPLICITY creates
an instance of the object. At this point, the features that have been configured for the
class are attached to the object, with values the class designer entered in the Object dialog
box and read-only values that were configured at the class level.
CIMPLICITY displays the object's features, which you can access, in their respective
application folders throughout the Workbench.
If the object designer has associated the class CimEdit screen with the object, the object's
values replace any class variables and can be viewed in CimView.
Example: An object instantiated
GFK-1180K
Configuring Classes
11-5
B
For an instantiated object
(e.g. Tank_1)
1 Configuration features
appear associated with
the object in the
Workbench.
2 Values display in
CimView.
End of example.
11-6
July 2001
GFK-1180K
Class Configuration
You can configure a class and create objects from the class through two convenient
dialog boxesthe Class dialog box and the Object dialog boxand through CimEdit.
A key to insuring a smooth transition from class to objects is to anticipate the objects'
requirements. Once you have determined the application for the class and the possible
range of values that will be required by objects created from the class, the configuration
is straightforward and similar to configuration you have done for other the CIMPLICITY
applications.
Important: You can modify a class before and after it has been applied. However, you
cannot change the class dynamically.
What you configure for the class depends on the purpose for the class. In general, once
you have mapped out a plan you can configure the options for the class in any order.
The steps for a standard class configuration are as follows. The order of these steps is
designed to take advantage of all the options for the class, e.g. scripts are used in actions;
actions are used in events.
Step 1.
Step 2.
Step 3.
Step 4.
Step 5.
Step 6.
Step 7.
Step 8.
Step 9.
Step 10.
Step 11.
Before you configure a class, you should be familiar with how to configure each of the
features in a CIMPLICITY application.
Information appears throughout the CIMPLICITY documentation. Specific references
include:
Base System User's Manual, GFK-1180
"Configuring Device Points"
"Configuring Virtual Points"
"Configuring Point View, Limits and Alarms"
CimEdit Operation Manual, GFK-1396
Basic Control Engine Event Editor Operation Manual, GFK-1282
Basic Control Engine Reference Manual, GFK-1283
GFK-1180K
Configuring Classes
11-7
Class
Scripts
Attributes
CIMPLICITY
Class
Attributes
Custom
Attributes
String Exp.=String
Expressions
Actions
Events
String
Exp.
String
Exp.
Data Items
String
Expressions
Numeric
Expressions
CimEdit Screen
CIMPLICITY
Numeric
Attributes
11-8
Task 1.
Task 2.
Task 3.
(Where applicable) Map out the layout of how memory is stored in the
devices from which data is collected. See page 11-10.
Task 4.
Determine the basic calculations needed for the data. See page 11-11.
Task 5.
Determine the CIMPLICITY features, e.g. points, scripts, actions and events,
required to collect and calculate data. See page 11-12.
July 2001
GFK-1180K
There are several objects (processes) that appear to have similar requirements.
End of example.
4
1
1
2
3
4
Level.
Average input flow rate.
Average output flow rate.
Average temperature.
End of example.
GFK-1180K
Configuring Classes
11-9
Block 2
Information from each of the tanks is mapped in the same order. Because there is a
standard convention for mapping information, address adjustment expressions can be
used to offset data item addresses.
PLC Addresses Mapped in Two Contiguous Blocks
2
9
3
10
1. Level
%R100
%R101
%R102
4. Temperature
%R103
5. Level
%R104
%R105
%R106
8. Temperature
%R107
9. Input valve
%Q0
%Q1
%Q2
%Q3
Block 1: PLC
Addressing
6
11
7
12
Block 2: PLC
Addressing
End of example.
11-10
July 2001
GFK-1180K
1
2
3
4
Alarm High/Low.
Average input flow rate.
Average output flow rate.
Average temperature.
Feature
Required for
Device Points
Input value
Output value
Temperature
Tank level
Virtual Points
End of example.
GFK-1180K
Configuring Classes
11-11
2
3
2
Low.
Input flow rate action.
Output flow rate action.
Feature
Required for
Events
Actions
Script
Generated,
Acknowledged and
Reset.
Run a script.
End of example.
11-12
July 2001
GFK-1180K
Open the New Class dialog box using any of the following methods:
Method 1. File menu
A. Click the Classes icon in the Workbench directory.
B. Click File on the menu bar.
C. Select New>Object.
Method 2. Popup menu
A. Right-click the Classes icon in the Workbench left pane.
B. Select New from the popup menu.
Method 3.Quickest
Double-click the Classes icon in the Workbench left pane.
Methods to Open the New Class Dialog Box
Press
Ctrl+N.
The New Class dialog box opens using any of the above methods.
GFK-1180K
Configuring Classes
11-13
2.
3.
Is limited to 32 characters.
Alphanumeric characters.
Underscores.
Click OK.
11-14
July 2001
GFK-1180K
Note: CIMPLICITY also provides numeric data item attributes that can be used for
numeric expressions. See page 11-36 for details.
See the "Configuring Device Points," "Configuring Virtual Points" and "Configuring
Point View, Limits and Alarms" chapters in the Base System User's Manual, GFK-1180
for information about configuring points, which will be created from data items.
Class
Scripts
Attributes
CIMPLICITY
Class
Attributes
Custom
Attributes
Actions
Events
String
Exp.
String
Exp.
Data Items
String
Expressions
Numeric
Expressions
CimEdit Screen
String Exp.=String
Expressions
CIMPLICITY
Numeric
Attributes
Optional
The attribute has a default value in the class, which the user
can override for the object being created. The attribute does
not have to be explicitly specified to create the object.
Static
The attribute has a default static value in the class. The value
appears in a read-only field during object configuration. All
objects in this class have the same value for this attribute.
Tabs and layout for the Object dialog box in which a object designer enters the
information.
GFK-1180K
CIMPLICITY class attributes, which display in the Attributes tab of the Class
dialog box. CIMPLICITY class attributes can be edited, duplicated, or deleted as
needed to configure your class.
Configuring Classes
11-15
Task 2.
Task 3.
Task 4.
Configure the attribute's field for the Object dialog box. See page 11-21.
Default
CIMPLICITY
attributes begin
with a $.
When a class developer enters a value for the attribute, the value serves as the default for
the corresponding data item(s) and/or in the Object dialog box in which a object designer
enters values.
CIMPLICITY class attributes are:
Class Attribute
Provides the:
$ADDRESS
$ALARM_CLASS
11-16
$DESCRIPTION
$DEVICE_ID
$EU_LABEL
July 2001
GFK-1180K
$LEVEL
$RESOURCE_ID
$SCREEN_ID
Uppercase
Numeric and
alphabetic required Underscores
for first character.
are allowed.
3.
Is limited to 16 characters.
Can be composed of
Underscores.
Click OK.
GFK-1180K
Configuring Classes
11-17
CIMPLICITY
attributes
begin with $.
Custom
attributes.
Open a New
Attribute dialog
box.
For a selected
attribute:
Delete the
attribute.
The top part of the dialog box provides fields for you to define the attribute. Your
definition can provide default values and determines the options available to an object
designer when creating an object from the class.
Task 3. Configure a class attribute definition:
1.
Open either a new or existing Attribute dialog box in which you will fill in or
modify the top part.
Field Definition Part of the Attribute Dialog Box: GefTank Class Example
Read-only for
CIMPLICITY
class attributes.
11-18
July 2001
GFK-1180K
2.
(Optional) Enter the default value for the attribute in the Value field.
Acceptable values:
3.
4.
Select the data type of the value from the Data type drop-down list: Data types
are:
Analog
Boolean
String
Select the option from the Instantiation type drop-down list that controls how a
user will deal with the attribute when an object is being created:
Option
Required
Optional
Static
5.
Check Reference if you want to identify the value of this attribute as the value
of another attribute.
Important: The Value field in the Attribute dialog box must contain the
attribute ID of the value to be referenced.
6.
GFK-1180K
Go to Task 4 to configure the attribute's field layout in the Object dialog box.
Configuring Classes
11-19
1 Class
Enter and
define an
attribute value
in the Attribute
dialog box.
2 Object
End of example.
11-20
July 2001
GFK-1180K
Open the appropriate Attribute dialog box (if it is not open), in which you will
fill in or modify the fields in the Object Builder box. See page 11-18 for details.
2.
2.
3.
(Optional) Select a browser in the Browser type field if you want the user to
have access to a browser in the Object dialog box. When a browser is selected,
the appropriate Browser button will appear to the right of the field in the Object
dialog box. Browser options include:
Option
Alarm Class
Resource
Device
Role
Point
GFK-1180K
Configuring Classes
11-21
User
Port
4.
5.
Specify the order in which the field will appear on the Object dialog box tab in
the Order field.
Class attributes with the same order number (for the same tab) are sorted
alphabetically by Prompt (field name).
Use the Property page field to specify the tab on which the attribute will
display in the Object dialog box as follows.
Either
Click OK or Cancel.
Result:
OK
Cancel
Existing objects based on this class are reevaluated to reflect the new
class structure.
11-22
July 2001
GFK-1180K
1 Class
$DEVICE_ID
(CIMPLICITY Attribute)
Attribute definition
(previous task).
2 Object
Field for
$DEVICE_ID
Attribute
End of example.
GFK-1180K
Configuring Classes
11-23
Class
Scripts
4
Attributes
CIMPLICITY
Class
Attributes
Custom
Attributes
Actions
Events
String
Exp.
String
Exp.
Data Items
String
Expressions
Numeric
Expressions
CimEdit Screen
String Exp.=String
Expressions
CIMPLICITY
Numeric
Attributes
A data item:
Database Logger
Event Editor
BCE
CimView
Can include a subset of expressions of type: string or numeric. Note that a limited
number of string substitutions and numeric expressions are supported.
Displays in the Workbench right pane as a point with its associated object.
11-24
Task 1.
Task 2.
Task 3.
3A.
3B.
3C.
3D.
July 2001
GFK-1180K
1 Class
AVERAGE_INFLOW
Data item
Configure the data
item in the Class
dialog box
2 Object
A
AVERAGE_INFLOW
Point
Appears as a point in the
Workbench when an
object is created.
Workbench
Tree view.
point displays as a
point in the object
folder.
In other views, the
point includes its
object in the display.
Workbench
Other views.
End of example.
Note: Usually you will configure a data item that creates one of the several point types
available in CIMPLICITY.
Two additional options are available that reduce memory usage:
GFK-1180K
Configuring Classes
11-25
2.
Click New.
New Data Item: Template that wil become a Point for an Object
Uppercase
alphabetic required
for first character.
Numeric and
Underscores
are allowed.
Point for
object will be
as selected.
11-26
Is limited to 16 characters.
Can be composed of
Underscores.
July 2001
GFK-1180K
3.
Check Device or Virtual to create a data item definition that will become a
device or virtual point.
4.
5.
Click OK.
Result: The Data Item dialog box opens. The available tabs and options in the dialog
box depend on your Type and Class selections.
Note: You can also duplicate an existing data item and modify it.
The following values are omitted from data item configuration. This is because
typically the class developer will not know the devices or resources that are
configured for the objects in a project.
Instead, the object designer enters the following in the Object dialog box:
Value
Device ID
Resource ID
See page 11-18 for details about the Object dialog box.
See "Configuring Device Points" and "Configuring Virtual Points" chapters in this
manual for details about configuring device and virtual points.
GFK-1180K
Configuring Classes
11-27
11-28
July 2001
GFK-1180K
Class
Scripts
4
Attributes
CIMPLICITY
Class
Attributes
Custom
Attributes
String Exp.=String
Expressions
Actions
Events
String
Exp.
String
Exp.
Data Items
String
Expressions
Numeric
Expressions
CimEdit Screen
CIMPLICITY
Numeric
Attributes
GFK-1180K
Configuring Classes
11-29
1 Class
A Create a class
attributte if it
doesn't
currently exist..
A
B Enter the
attribute in a
Data Item field
that allows
string
expressions.
11-30
July 2001
GFK-1180K
2 Object
A The attribute value
displays in the Object
dialog box.
End of example.
GFK-1180K
Configuring Classes
11-31
String
Numeric
You can configure data items to include a subset of expressions based on simple
expression processing. Expressions can be used to set the value of a data item attribute.
Class
Scripts
Events
String
Exp.
String
Exp.
Data Items
Attributes
CIMPLICITY
Class
Attributes
Actions
String
Expressions
Custom
Attributes
Numeric
Expressions
CimEdit Screen
String Exp.=String
Expressions
CIMPLICITY
Variables
CIMPLICITY
Numeric
Attributes
11-32
All class attributes are available as variables. You can define your own
variables, or you can use the CIMPLICITY attributes.
$ID
$CLASS
July 2001
GFK-1180K
Use brackets {} to enclose variable values. (Brackets are also used for variables in
CimEdit.)
See the CimEdit Operation Manual, GFK1396, "Using Variables" chapter for detailed
information about variables.
Supported String Substitution for Data Items
String substitution is supported for the following data item attributes, which you enter in
the associated Data Item dialog box field.
For
Description
Safety Point
Screen
Availability Trigger
Measurement Units Label
Expression
Reset Point
Address
Device ID
GFK-1180K
Configuring Classes
11-33
1 Class
A Create a class
attributte if it
doesn't
currently exist..
A
B Enter the
attribute in a
Data Item field
that allows
string
expressions.
11-34
July 2001
GFK-1180K
2 Object
A The attribute value
displays in the Object
dialog box.
End of example.
GFK-1180K
Configuring Classes
11-35
String
Numeric
Numeric expressions are created with CIMPLICITY numeric data item attributes and can
consist of one or two operands. Operands can be either a constant value or a custom
attribute with a numeric data type.
Class
Scripts
4
Attributes
CIMPLICITY
Class
Attributes
Custom
Attributes
Actions
Events
String
Exp.
String
Exp.
Data Items
String
Expressions
Numeric
Expressions
CimEdit Screen
String Exp.=String
Expressions
11-36
July 2001
CIMPLICITY
Numeric
Attributes
GFK-1180K
For
Address adjustment
Device points
See page 11-41 for details about
address adjustment.
$CONV_LIMIT_LOW
Alarm delay.
Alarm configuration;
time in seconds
Alarm high limit
Alarm low limit
Second conversion
limit
First conversion limit
$DISPLAY_HIGH
$DISPLAY_LOW
$FORMAT_JUST
$FORMAT_PREC
Format precision
$FORMAT_WIDTH
$LEVEL
$RANGE_HIGH
$RANGE_LOW
$RAW_LIMIT_HIGH
$RAW_LIMIT_LOW
$SETPOINT_HIGH
$SETPOINT_LOW
$TREND_DURATION
Format width
Security level
Range high limit
Range low limit
Second raw limit
First raw limit
Setpoint high limit
Setpoint low limit
Trend duration
$TREND_SAMPLES
$WARNING_HIGH
$WARNING_LOW
Trend samples
Warning high limit
Warning low limit
$ALARM_DELAY
$ALARM_HIGH
$ALARM_LOW
$CONV_LIMIT_HIGH
GFK-1180K
Provides
Configuring Classes
Analog points
Analog points
Analog points
Analog points
See "Point Conversions in the
"Configuring Device Points"
chapter in this manual for details
about point conversion.
Analog points
Analog points
Analog points
0 = Zero filled
1 = Justify left (default)
2 = Justify right
Floating point or Analog points
with EU conversion
Analog points
All point types
Analog points
Analog points
Point Conversion / Analog points
Point Conversion / Analog points
Analog points
Analog points
Analog points only; time in
seconds
Analog points
Analog points
11-37
2.
Click New
The New Expression box opens.
3.
Select an Attribute ID from the drop-down list. The list includes the supported
CIMPLICITY numeric data item attributes. See the previous section.
4.
Click OK.
The Expression dialog box opens.
11-38
July 2001
GFK-1180K
5.
6.
7.
8.
Click OK.
Result: The expression is added to the data item's list of available numeric
expressions.
The numeric expressions provide rules for defining the point properties.
GFK-1180K
Configuring Classes
11-39
B Select a
CIMPLICITY
numeric attribute
to create a new
expression.
3 Configure
the
Expression
A Class attribute
options for the
expression
operands come
from the
Attributes tab in
the Class dialog
box.
B Expression
operands can
be class
attributes or
numbers.
C The
CIMPLICITY
numeric
attribute
appears in the
point's
configured
expression list.
End of example.
11-40
July 2001
GFK-1180K
Make sure your PLC stores data in contiguous blocks (or in blocks that are
equally spaced apart).
Example
You have two tanks with data mapped in two contiguous blocks.
PLC Addresses Mapped in Two Contiguous Blocks
2
9
3
10
1. Level
%R100
%R101
%R102
4. Temperature
%R103
5. Level
%R104
%R105
%R106
8. Temperature
%R107
9. Input valve
%Q0
%Q1
%Q2
%Q3
Block 1: PLC
Addressing
6
11
2.
Address adjustment
7
12
Block 2: PLC
Addressing
Use class attributes to enable the object designer to enter the base address for
each block as follows:
A. Use the CIMPLICITY $ADDRESS attribute for the first block.
B. Create class attributes for the second and any additional blocks.
Example
An attribute that will be used in address adjustment is named
OUTPUT_ADDR.
C. (Optional) Enter a base address in the Attribute dialog box.
Note: All address adjustment attributes appear as fields in the Object dialog
box. When an object designer creates an object, base addresses can be entered
for that object. If you enter a base address, that address appears as the default in
the Object dialog box. See page 11-18 for details about the Object dialog box.
GFK-1180K
Configuring Classes
11-41
3.
Determine the offset for addresses that are above the base address using the
formula.
Offset = PLC Address - Base Address.
Example
5=%R105-%R100
3.
D. Click OK.
The Expression dialog box displays.
E. Check Number and enter the address-offset in the Number field, e.g. 1.
F.
11-42
July 2001
Click OK.
GFK-1180K
4.
Click OK.
The Expressions dialog box opens.
G. Check Number and enter the address-offset in the Number field; e.g. 1.
H. Click OK.
Result: CIMPLICITY will automatically assign device points with addresses when
an object designer enters the base address for the one or more configured blocks in
the Object dialog box. The addresses will be calculated based on the adjustments
you specified in the Expression dialog box.
GFK-1180K
Configuring Classes
11-43
Definition
Just-in-time
Delay-load
11-44
July 2001
CimView,
Trending, and
Scripting.
GFK-1180K
Disadvantages
Non-Supported
Functions
Noneall functions
supported
Delay-Load
Loaded when needed
No memory usage until
point is loaded
Written to point database
Available in point list
Definition can be modified
Slower access
Configuration updates
can be lengthy on larger
systems
Trigger settings and
Alarm options are not
available
GFK-1180K
Configuring Classes
Trend buffering
Alarming
Attribute set
Analog deadband
Cannot be used
within another point's
configuration, e.g.
Safety point, Trigger,
Availability Trigger
point, etc.
Cannot be used in a
calculation point
equation
Cannot use another
point within its
configuration, e.g.
Safety point, Trigger,
Availability Trigger
point, etc.
Cannot be marked as
an enterprise point.
Trend buffering
Alarming
Cannot be used
within another point's
configuration, e.g.
Safety point, Trigger,
Availability Trigger
point, etc.
Cannot be used in a
calculation point
equation
11-45
Are stored in the Workbench Scripts folder, with a class$ prefix, as soon as
they are created.
Class
5
Scripts
Actions
Data Items
Attributes
String
Exp.
CIMPLICITY
Class
Attributes
Custom
Attributes
Events
String
Expressions
String Exp.=String
Expressions
String
Exp.
Numeric
Expressions
CimEdit Screen
CIMPLICITY
Numeric
Attributes
The class$ script can also be modified in the CIMPLICITY Program Editor by
opening it through the Workbench Scripts folder.
As a result an object designer can use the script editor for editing and debugging of the
scripts.
Tasks to write class scripts include:
11-46
Task 1.
Task 2.
Write a class script through the Scripts tab. See page 1149.
July 2001
GFK-1180K
2 Class/Object
The script is
associated with the
class in the Scripts
folder.
End of example.
GFK-1180K
Configuring Classes
11-47
A Script name is
3.
Is up to 15 characters.
Click OK.
Note: You can also duplicate an existing script and modify it.
11-48
July 2001
GFK-1180K
Open a New
Script Name
dialog box.
Open the
CIMPLICITY
Program Editor.
For a selected
script:
Duplicate script's
properties.
Delete the
script.
Open either a New Script name dialog box or display a selected script in the
Program Editor.
2.
3.
4.
Result: The script immediately appears in the Workbench Scripts folder as:
Class$Scriptname.bcl
Where
Class$ is the name of the class to which the script belongs.
Scriptname.bcl is the name entered in the New Script Name dialog box.
You can modify the script either through the Scripts folder or through the Class
dialog box.
GFK-1180K
Configuring Classes
11-49
Class
6
Scripts
Actions
Events
Data Items
Attributes
String
Exp.
CIMPLICITY
Class
Attributes
Custom
Attributes
String
Expressions
String Exp.=String
Expressions
Numeric
Expressions
String
Exp.
CimEdit Screen
CIMPLICITY
Numeric
Attributes
Cannot be deleted.
11-50
Task 1.
Task 2.
July 2001
GFK-1180K
Action dialog
box through
the Class
dialog box.
Configure the
action.
A The action is
2 Object
associated with an
object when the object
is created.
The associated action
displays in the Event
Editor. It cannot be
modified.
A
B
End of example.
GFK-1180K
Configuring Classes
11-51
2.
Is limited to 16 characters.
Can be composed of
Underscores.
Numeric and
Uppercase
alphabetic required Underscores
are allowed.
for first character.
3.
Click OK.
The New Action dialog box opens.
11-52
July 2001
GFK-1180K
Open a New
Action dialog
box.
For a selected
action:
Duplicate action's
properties.
Delete the
action.
All CIMPLICITY action types (found in the Event Editor) are available except for:
Recipe Upload/Download.
The difference between configuring a class action and a standard action is that you:
Select a data item instead of a point ID when you configure an action that
requires a point ID.
Note: The user can associate a non-object event with an object action. This allows an
object to instantiate actions that can be called from other events.
GFK-1180K
Configuring Classes
11-53
2.
3.
Log Only
Point Alarm Acknowledge
Run Script
Set Point
Transition Set
Fill in the fields that display, based on the selected action. See page 11-56 for
supported string substitution for action fields.
Your entries are based on the class configuration
Example
A. If a Point ID field displays, e.g., for a Set Point action:
i.
The Select a Data Item browser appears displaying the list of data items
created for the class.
ii.
11-54
July 2001
GFK-1180K
Automatically entered
when a Data Item is
selected.
The Select a Script File browser displays the scripts that have been
written for the class.
ii.
GFK-1180K
Configuring Classes
11-55
4.
Click OK.
Result: The action, which is modified or created, displays on the Actions tab in the
Class dialog box.
Point ID.
Resource ID.
Point value.
11-56
July 2001
GFK-1180K
Class
7
Scripts
Custom
Attributes
Events
String
Exp.
String
Exp.
Data Items
Attributes
CIMPLICITY
Class
Attributes
Actions
String
Expressions
String Exp.=String
Expressions
Numeric
Expressions
CimEdit Screen
CIMPLICITY
Numeric
Attributes
Class events:
Appear in the Event Editor window when an object is created. In the Event
Editor, events:
Cannot be deleted.
Creating class events is similar to creating events in the Event Editor. All existing event
types that are supported in the event editor are available for class event configuration.
Tasks to configure class events include:
GFK-1180K
Task 1.
Task 2.
Configuring Classes
11-57
A Open an Event
dialog box
through the
Class dialog
box.
Configure the
event.
A The event is
2 Object
B
A
associated with an
object when the
object is created.
The associated
event displays in the
Event Editor. It
cannot be modified.
End of example.
11-58
July 2001
GFK-1180K
Numeric and
Uppercase
alphabetic required Underscores
are allowed.
for first character.
Is limited to 16 characters.
Can be composed of
Underscores.
GFK-1180K
Configuring Classes
11-59
2.
Alarm Acknowledged
Alarm Deleted
Alarm Generated
Alarm Reset
Point Change
Point Equals
Point Transition High
Point Transition Low
Point Unavailable
Point Update
Run Once
Timed
The Select a Data Item browser appears displaying the list of data items
displayed for the class.
11-60
July 2001
GFK-1180K
B. Open an Action-Event dialog box by using any of the same methods you
used to open the Event dialog box (1 in this procedure).
The Select an Action browser opens displaying the actions that have been
created for the class.
D. Select an action that will be associated with the event.
GFK-1180K
Configuring Classes
11-61
E. Click OK.
The action appears in the Action ID field.
F.
G. Click OK.
The action appears in the list of actions associated with the event.
H. Specify the sequence in which the event's actions occur by using the Move
up and Move down buttons to place the actions in the order you want
them to occur.
4.
5.
Configure advanced specifications the same as you configure them for an event
in the Events folder.
5.
Click OK.
Result: When an object is created from the class, the event appears in the
CIMPLICITY Event Editor window as:
ObjectName.EventID
Where
ObjectName is the name of the object that has been created.
EventID is the name entered in the New Event dialog box.
11-62
July 2001
GFK-1180K
Point ID.
Alarm ID.
Resource ID.
Alarm Class.
Point Value.
GFK-1180K
Configuring Classes
11-63
Class
Scripts
Custom
Attributes
Events
String
Exp.
String
Exp.
Data Items
Attributes
CIMPLICITY
Class
Attributes
Actions
String
Expressions
String Exp.=String
Expressions
Numeric
Expressions
8
CimEdit Screen
CIMPLICITY
Numeric
Attributes
When you configure a class CimEdit screen an object designer can drag an existing
object from the Workbench to a new CimEdit screen.
The source object from the class CimEdit screen appears on the new screen. Object
values are substituted for variables, e.g. $OBJECT, that were configured on the source
screen.
Tip: It is recommended that you configure the following in the order they are listed:
1.
2.
One object that you can use to test the screen you are creating.
3.
Important: This step provides an overview of how to configure a CimEdit screen for a
class. It assumes that you are familiar with CimEdit configuration, which is essential for
creating an effective class CimEdit screen. For details about CimEdit configuration, see
the "CimEdit Operation Manual," GFK-1396.
Tasks to create a class CimEdit screen for a class include:
11-64
Task 1.
Task 2.
Task 3.
Enter class specifications for the top-level group. See page 11-68.
Task 4.
Task 5.
Associate the CimEdit screen with its class. See page 11-74.
July 2001
GFK-1180K
Text
Trend ActiveX
Tank group
object from the
Object Explorer
Text
End of example.
GFK-1180K
Configuring Classes
11-65
2.
Selecting
objects in
CimEdit.
11-66
July 2001
GFK-1180K
3.
4.
Result: The individual objects are grouped together into a top-level group object.
Object
group
GFK-1180K
Configuring Classes
11-67
2.
1 Enter an
Object name.
2 Click Apply.
3.
Assign the CIMPLICITY $OBJECT variable to the top level group object as
follows:
A. Select the Variables tab in the Properties - Group dialog box.
B. Enter $OBJECT in the Variable field. See page 11-32 for details about
$OBJECT.
11-68
July 2001
GFK-1180K
C. Check Public.
D. Click OK.
Result: When an object that is created from the class is dragged into CimEdit, a class
object graphic is created. The name of the object is substituted for {$OBJECT} in
expressions during runtime.
GFK-1180K
Configuring Classes
11-69
B Object
The name displays
on the Class Object
tab in the object's
Properties dialog
box.
2 Object Name
A Class
Enter $OBJECT on
the Variables tab in
the source object's
Properties dialog
box.
B Object
The object name
displays on the
Variables tab in the
object's Properties
dialog box.
End of example.
11-70
July 2001
GFK-1180K
The Container toolbar appears. You can now select any object in the group.
If the object is a nested group, you can configure or open that group.
2.
3.
Container toolbar
4.
5.
GFK-1180K
Configuring Classes
11-71
Example
{$OBJECT}.LEVEL
5.
6.
Result: When a class object is dragged into CimEdit the selected class object
graphic will include, but not display, the configuration. During runtime CimView
substitutes the class object name for {$OBJECT} in order to use the object's point
ID.
11-72
July 2001
GFK-1180K
2 Object
Configuration is:
B Not visible in the
class object
dialog box.
C Controls the
CimView display.
End of example.
GFK-1180K
Configuring Classes
11-73
Open the Class dialog box for the class with which the screen will be associated.
2.
3.
Enter the CimEdit screen name in the Graphics file field that will be associated
with the class
The selected CimEdit screen contains the source objects that are available to
object designers.
4.
Enter the name, in the Default Graphic field, of the CimEdit object that appears
as the default when a class object is dragged to a new CimEdit screen.
Result: When an object that is created from the class is dragged from the
Workbench into a new CimEdit screen, a class object graphic, which is linked to
the class source graphic appears.
An object designer can select another object in the default object's Properties dialog
box.
11-74
July 2001
GFK-1180K
Example: Use class CimEdit screens with more than one object.
1 Class
A Configure
objects on
class CimEdit
screen.
Object Name:
Output Valve
Object Name:
Object
B Select Output
Valve as the
default graphic.
GFK-1180K
Configuring Classes
11-75
2 Object
A The default
CimEdit object
appears when
a class object
is dragged to a
new screen.
B Object
designers
can select a
different
graphic on
the Class
Object tab.
End of example.
11-76
July 2001
GFK-1180K
Note: Refer to the documentation from your help-based software for details about
creating custom help files.
Compatible software sources include, but are not limited to:
RoboHELP.
Doc-To-Help.
2.
Enter the name of the help file in the Help file field.
Result: When an object designer presses F1 or clicks Help in the Object dialog
box, the table of contents for the specified help file appears.
GFK-1180K
Configuring Classes
11-77
Task 2.
1.
2.
3.
Navigate to the location where you will save the point class file.
4.
Enter <ClassName>.soc
Where
<ClassName> is the name of the class.
.soc is the class file extension.
11-78
July 2001
GFK-1180K
4.
Click Save.
Result: CIMPLICITY includes the class components in the .soc file as follows:
Component
Class configuration
Classes
Scripts
Screens
Class
Configuration
Data Items
Attributes
Actions
Events
.soc File
.bcl files
.cim file
A class developer can now modify the class to meet any different requirements for the
project.
An object designer can immediately create objects with associated CimEdit/CimView
screens.
1.
2.
GFK-1180K
Navigate to the location of the point class .soc file that will be imported.
Configuring Classes
11-79
4.
Class configuration
Classes
Scripts
Screens
Class
Configuration
Data Items
Attributes
Actions
Events
.soc File
.bcl files
.cim file
A class developer can now modify the class to meet any different requirements for the
project.
An object designer can immediately create objects with associated CimEdit/CimView
screens.
11-80
July 2001
GFK-1180K
2.
When the object is created, the value of the Attribute 'Manufacturer' is specified
as 'General Electric'.
Class
An object type: a group of objects that have the same properties, operations, and
behaviors. In this case, the class is defined for configuring a group of points.
Class developer
Person responsible for planning and building a class. The Class developer will determine
the application for which the class will be used and then accordingly plan the associated
attributes, data items and graphics.
Data Item
A data item is a template for a point definition. A data item becomes a CIMPLICITY
point when the class is instantiated into an object.
Instantiation
Producing a particular object from its point class template. This involves allocation of a
structure with the types specified by the template and initialization of attributes with
either default values or those provided by the user.
Just-in-Time Data Item
Just-in-Time (JIT) data items are not written to the point database when an object is
instantiated; rather, the point configuration is created on demand. JIT data items are
exclusive to point classes.
Object
In object-oriented design or programming, a self-contained item with instructions for the
operations to be performed on it. In this case, a point object that will conform to the point
class template for all configured data items, attributes, and graphics.
Object Developer
Person who will create an object by assigning values to the class attributes and select
associated graphics from the graphics library in order to support an application.
GFK-1180K
Configuring Classes
11-81
Operator
Person who will use the data and view the graphics screens from the instantiated object as
an integral part of monitoring and maintaining an application.
Classes can contain two member types:
11-82
Data Items
Attributes
CIMPLICITY attributes.
Custom attributes.
July 2001
GFK-1180K
2 One or more
objects can be
created from the
class.
Objects include
"instantiated"
parts that are
included in the
class.
Attributes
Data Items
Events
Actions
Scripts
CimEdit
Screen
Object 1
Attributes
Points
Events
Actions
Scripts
Class
CimEdit
Screen
Object 2
Attributes
Points
Events
Actions
Scripts
CimEdit
Screen
CimEdit
Screen
Object 3
Attributes
Points
Events
Actions
Scripts
Although class object features behave the same as their non-class counterparts,
CIMPLICITY makes it easy for the object designer (or any project designer) to locate
features for any class object. CIMPLICITY attaches the object name to the front of the
feature name.
GFK-1180K
12-1
Where
Tank_1 is a class object and
TANK_LEVEL is a data item attached to Tank_1.
Tank_2 is a class object and
TANK_LEVEL is a data item attached to Tank_2.
Important: Before you can configure a class object, a class must be created. If the class
exists, but is not in the current project, you simply need to import it into the project.
Note: The exceptions to the rule are data items that have the Just-in-Time (JIT) option
checked: JIT points are not created until requested by an application.
See page 12-5 for details about importing a class into a project.
See "Configuring Point Classes" for information and instructions about creating a class
and about Just-in-Time points.
2.
Data Item
Instantiation
Just-in-Time Data Item Just-in-Time (JIT) data items are not written to the point
database when an object is instantiated; rather, the point
configuration is created on demand. JIT data items are
exclusive to classes.
12-2
July 2001
GFK-1180K
Attributes.
Events.
Actions and/or
Scripts.
Events, Actions
Attributes, Points,
can be customized for each object if the
class configuration allows it.
Scripts apply to
all objects in the
class.
GFK-1180K
12-3
2.
An Object Designer creates and configures one or more objects based on the class.
How many and the content of fields that ask for specifications specific to the
object being configured depend on the class configuration.
12-4
July 2001
GFK-1180K
Step 2.
Step 3.
Step 4.
Step 5.
2.
Browse for the .soc file for the class you want to import.
Note: When the class developer exported the class, CIMPLICITY created a
.soc file with the name specified by the class developer. The .soc file contains
the class configuration including:
GFK-1180K
Specifications made in the Class dialog box (e.g. attributes, data items
(object points), events and actions).
Scripts.
12-5
4.
Click Open in the Open dialog box when you find the file.
Result: The class appears in the Class folder. Scripts that have been written for the
class appear in the Scripts folder.
12-6
July 2001
GFK-1180K
Press
Ctrl+N.
The New Object dialog box displays when you use any of the above methods.
2.
GFK-1180K
12-7
3.
See the "Configuring Classes" chapter in this manual for details about creating
a class.
4.
Click OK.
Description
Fields
Default Entries
Tabs
12-8
July 2001
GFK-1180K
Enter values in the Object dialog box fields that define the specific criteria for
the class object that is being configured.
When appropriate, the Browse buttons that appear throughout CIMPLICITY, display to
aid you search for the correct entries.
Option
Alarm Class
Resource
Device
Role
Point
User
Port
GFK-1180K
12-9
Result: CIMPLICITY takes the values you enter in the Object dialog box and applies
them to the appropriate feature in CIMPLICITY, e.g. points, alarms. You can also do
more specific configuration throughout the Workbench.
Important: You will not be able to complete a tab's configuration until you fill in all of
the required fields. If you try, an error message appears telling you that a value for an
attribute is required. This message continues to appear when you attempt to exit the
dialog box until all required fields are filled in.
12-10
July 2001
GFK-1180K
GFK-1180K
12-11
Note: CIMPLICITY puts scripts in the Scripts folder when written during class
configuration.
End of example.
12-12
July 2001
GFK-1180K
2.
3.
4.
5.
6.
7.
8.
Click OK.
GFK-1180K
1.
During runtime the graphic will represent the values of the selected class
object.
2.
The graphic will change to the graphic you selected, if it is different from
the default, as soon as you close the Properties - Class Object dialog box.
12-13
End of example.
12-14
July 2001
GFK-1180K
Event Manager
CimEdit
CimView
Point Control Panel
Each system point, which is Read only, is automatically updated by CIMPLICITY HMI.
The default update time is every 60 seconds. To see the value of any one, all you have to
do is select it for display.
GFK-1180K
$ALARM.ACKED
$ALARM.ACTIVE
$ALARM.TOTAL
$ALARM.UNACKED
$CLASS_<Alarm class name>.ALARMS
$CLASS_<Alarm class name>.UNACKED
$LOCAL.COMPUTER
$LOCAL.DATE.AMPM
$LOCAL.DATE.DAY
$LOCAL.DATE.DAYOFWEEK
$LOCAL.DATE.DAYOFYEAR
$LOCAL.DATE.HOUR
$LOCAL.DATE.HOUR12
$LOCAL.DATE.MINUTE
$LOCAL.DATE.MONTH
$LOCAL.DATE.SECOND
$LOCAL.DATE.SECONDOFDAY
$LOCAL.DATE.WEEK
$LOCAL.DATE.YEAR
$LOCAL.DATETIME
$LOCAL.WINUSER
$PROJECT
$PROJECT.AVAILABLE
$PROJECT.COMPUTER
$PROJECT.DATE.AMPM
$PROJECT.DATE.DAY
$PROJECT.DATE.DAYOFWEEK
$PROJECT.DATE.DAYOFYEAR
$PROJECT.DATE.HOUR
$PROJECT.DATE.HOUR12
$PROJECT.DATE.MINUTE
$PROJECT.DATE.MONTH
$PROJECT.DATE.SECOND
$PROJECT.DATE.SECONDOFDAY
$PROJECT.DATE.WEEK
$PROJECT.DATE.YEAR
$PROJECT.DATETIME
$PROJECT.DEVICES
$PROJECT.LOGGEDIN
$PROJECT.USERS
$ROLE
$ROLE.LEVEL
$USER
$USER.ALARMS
13-1
$ALARM.ACKED
Point Type
Server Point
Data Type
UDINT
Access
Read only
Description
$ALARM.ACTIVE
Point Type
Server Point
Data Type
UDINT
Access
Read only
Description
$ALARM.TOTAL
Point Type
Server Point
Data Type
UDINT
Access
Read only
Description
$ALARM.UNACKED
Point Type
Server Point
Data Type
UDINT
Access
Read only
Description
Server Point
Data Type
UDINT
Access
Read only
Description
Server Point
Data Type
UDINT
Access
Read only
Description
$LOCAL.COMPUTER
13-2
Point Type
Local Point
Data Type
STRING (15)
Access
Read only
Description
GFK-1180K
$LOCAL.DATE.AMPM
Point Type
Local Point
Data Type
BOOL
Access
Read only
Description
0=AM; 1=PM
$LOCAL.DATE.DAY
Point Type
Local Point
Data Type
USINT
Access
Read only
Description
$LOCAL.DATE.DAYOFWEEK
Point Type
Local Point
Data Type
USINT
Access
Read only
Description
$LOCAL.DATE.DAYOFYEAR
Point Type
Local Point
Data Type
UINT
Access
Read only
Description
$LOCAL.DATE.HOUR
Point Type
Local Point
Data Type
USINT
Access
Read only
Description
$LOCAL.DATE.HOUR12
Point Type
Local Point
Data Type
USINT
Access
Read only
Description
$LOCAL.DATE.MINUTE
GFK-1180K
Point Type
Local Point
Data Type
USINT
Access
Read only
Description
13-3
$LOCAL.DATE.MONTH
Point Type
Local Point
Data Type
USINT
Access
Read only
Description
$LOCAL.DATE.SECOND
Point Type
Local Point
Data Type
USINT
Access
Read only
Description
$LOCAL.DATE.SECONDOFDAY
Point Type
Local Point
Data Type
UDINT
Access
Read only
Description
$LOCAL.DATE.WEEK
Point Type
Local Point
Data Type
USINT
Access
Read only
Description
$LOCAL.DATE.YEAR
Point Type
Local Point
Data Type
UINT
Access
Read only
Description
$LOCAL.DATETIME
Point Type
Local Point
Data Type
UDINT
Access
Read only
Description
$LOCAL.WINUSER
13-4
Point Type
Local Point
Data Type
STRING (20)
Access
Read only
Description
GFK-1180K
$PROJECT
Point Type
Server Point
Data Type
STRING (20)
Access
Read only
Description
Project name
$PROJECT.AVAILABLE
Point Type
Local Point
Data Type
BOOL
Access
Read only
Description
Project availability
0=Not Available
1=Available
$PROJECT.COMPUTER
Point Type
Server Point
Data Type
STRING (15)
Access
Read only
Description
$PROJECT.DATE.AMPM
Point Type
Server Point
Data Type
BOOL
Access
Read only
Description
0=AM; 1=PM
$PROJECT.DATE.DAY
Point Type
Server Point
Data Type
USINT
Access
Read only
Description
$PROJECT.DATE.DAYOFWEEK
GFK-1180K
Point Type
Server Point
Data Type
USINT
Access
Read only
Description
13-5
$PROJECT.DATE.DAYOFYEAR
Point Type
Server Point
Data Type
UIND
Access
Read only
Description
$PROJECT.DATE.HOUR
Point Type
Server Point
Data Type
USINT
Access
Read only
Description
$PROJECT.DATE.HOUR12
Point Type
Server Point
Data Type
USINT
Access
Read only
Description
$PROJECT.DATE.MINUTE
Point Type
Server Point
Data Type
USINT
Access
Read only
Description
$PROJECT.DATE.MONTH
Point Type
Server Point
Data Type
USINT
Access
Read only
Description
$PROJECT.DATE.SECOND
Point Type
Server Point
Data Type
USINT
Access
Read only
Description
$PROJECT.DATE.SECONDOFFDAY
13-6
Point Type
Server Point
Data Type
UDINT
Access
Read only
Description
GFK-1180K
$PROJECT.DATE.WEEK
Point Type
Server Point
Data Type
USINT
Access
Read only
Description
$PROJECT.DATE.YEAR
Point Type
Server Point
Data Type
UINT
Access
Read only
Description
$PROJECT.DATETIME
Point Type
Server Point
Data Type
UDINT
Access
Read only
Description
$PROJECT.DEVICES
Point Type
Server Point
Data Type
UDINT
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.USERS
GFK-1180K
Point Type
Server Point
Data Type
UDINT
Access
Read only
Description
Number of users
13-7
$ROLE
Point Type
Server Point
Data Type
String (16)
Access
Read only
Description
$ROLE.LEVEL
Point Type
Server Point
Data Type
DINT
Access
Read only
Description
$USER
Point Type
Server Point
Data Type
String (32)
Access
Read only
Description
User identification.
$USER.ALARMS
13-8
Point Type
Local Point
Data Type
UDINT
Access
Read only
Description
GFK-1180K
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-1180K
14-1
in the
2.
Select CIMPLICITY.
3.
4.
Result: The result of using either method depends on the status of the project's
PtXref database.
If the PtXRef database has:
Been built and all of its subsystems are up-to-date, the Point Cross Reference
window opens, displaying the list of points in the PtXRef database.
Been built but all of its subsystems are not up-to-date, an Update PtXRef
Database dialog box appears.
14-2
GFK-1180K
To update the PtXRef Database before the PtXRef Point Explorer window
opens:
Simply click the Yes button.
Method 2
1.
2.
Select Build.
GFK-1180K
1.
2.
Click OK.
14-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
14-4
GFK-1180K
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-1180K
14-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.
14-6
GFK-1180K
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-1180K
14-7
2.
3.
4.
Check the check box to the left of each subsystem you want to include.
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.
Result: CIMPLICITY HMI scans the point table and displays the current
information.
14-8
GFK-1180K
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
Tree view
Selected point
Subsystem
Point use
Text view
GFK-1180K
14-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:
Points
Scripts
Event
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:
14-10
1.
Select the point you want to modify in the left pane of the Point Cross Reference
window.
2.
3.
4.
GFK-1180K
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
Database Logger
2.
3.
Method 2
1.
2.
Select Build.
3.
4.
CIMPLICITY HMI adds and displays the selected subsystems when you use either
method.
GFK-1180K
14-11
Selected substystems
selected
2.
If the PtXRef database needs to be rebuilt, the following dialog box appears providing
you with the rebuild status.
14-12
GFK-1180K
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 down menu.
GFK-1180K
14-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 (GFK1181) for detailed information on configuring a device for a particular protocol.
Device Configuration
The Workbench displays a project's existing devices in the right pane.
To view a project's existing devices:
1.
2.
Select Devices
The Workbench right pane displays the following fields for devices:
Device ID
Port
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
Note: Use the Workbench Field Chooser to remove or redisplay any of the fields, except
the Device ID. The Device ID is required. See the "Selecting Fields to Display in the
Right Pane" in the "Using the Workbench" chapter in this manual for information about
the Field Chooser"
The Device list is initially sorted by Device ID. You can click on any of the other
column titles at the top of the list to sort the list by that attribute.
GFK-1180K
15-1
2.
Expand Devices.
The existing devices appear in a list under Devices.
3.
Devices
expanded
Device selected to
review configuration
details
The Workbench right pane displays the following fields for devices:
Point ID
Device ID
Resource
Point Type
Description
Note: Information in the displayed fields comes from the associated point configuration.
Use the Workbench Field Chooser to remove or redisplay any of the fields, except the
Point ID. The Point ID is required
The Device list is initially sorted by Point ID. You can click on any of the other column
titles at the top of the list to sort the list by that attribute.
15-2
GFK-1180K
2.
The New Device dialog box opens when you use any method.
Port
GFK-1180K
Device Configuration
15-3
2.
Expand Equipment.
3.
Select Devices.
4.
A Device dialog box associated with the selected device opens when you use any
method.
15-4
GFK-1180K
On the General tab on the Device dialog box, you define the following for a new device:
Port
The port you selected in the New Device dialog box is displayed in this field.
You can click the Browser button
to the right of this input field to open the Select a
Port Browser and use it to select another port.
You can also click the Pop-up button
to display a popup menu that provides you with
the options to create a new port, edit the current port, or browse for another port.
Description
Enter up to 40 characters of explanatory text about the device.
Resource
Enter the name of the device's resource in this field. Remember, only the users that are
assigned this resource will be able to see device alarms.
You can click the Browser button
to the right of this input field to open the Select
A Resource Browser and use it to select the resource.
You can also click the Popup button
to display a popup menu that provides you with
the options to create a new resource, edit the current resource, or browse for another
resource.
Model Type
Select the type of device from the drop-down list. The list of model types depends on the
protocol.
GFK-1180K
Device Configuration
15-5
15-6
GFK-1180K
Configuring Resources
About Resources
Resources are the physical or conceptual units that comprise your facility. They
can be devices, machines, or stations where work is performed, or areas where
several tasks are carried out. Resource configuration plays an important role in
your CIMPLICITY HMI project by routing alarms to specific users and filtering
the data users receive.
CIMPLICITY HMI software uses resources in the following ways:
GFK-1180K
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.
16-1
Resource Configuration
The Workbench displays a project's existing resources in the right pane.
To view a project's existing resources:
1.
2.
Select Resources
The Workbench right pane displays the following attributes for each Resource:
Resource
Description
Resource Type
Note: Use the Workbench Field Chooser to remove or redisplay any of the
fields, except the Resource. The Resource is required. See the "Selecting Fields
to Display in the Right Pane" in the "Using the Workbench" chapter in this
manual for information about the Field Chooser"
The Resource list is initially sorted by Resource. You can click on any of the
other column titles at the top of the list to sort the list by that attribute.
2.
16-2
GFK-1180K
Method 4
A. Select Resources.
B. Click the New icon
The New Resource dialog box opens when you use any method.
Enter the name of the new resource in the Resource ID field and select OK.
The system verifies that the Resource ID does not already exist, and that no
invalid characters have been used.
If the Resource ID you entered is valid, the Resource Definition dialog box for
the new resource opens.
The Resource Definition dialog box lets you define the following for a new
resource:
Description
Up to 40 characters of explanatory text describing the resource.
Note that you cannot use the $ or | characters in a resource name.
Users for this Resource
The list of users that can view alarm or point information for this resource.
GFK-1180K
Configuring Resources
16-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.
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.
16-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-1180K
Configuring Ports
About Ports
A port is a communication "socket" that connects one or more factory devices such as
PLCs to the computer.
Use this function to configure ports and specify their characteristics. Configuration
requirements for ports vary depending on the type of port and communications protocol
being used. See the CIMPLICITY HMI Device Communications Manual (GFK-1181) for
detailed information on configuring ports for your specific device.
GFK-1180K
17-1
Port Configuration
The Workbench displays a project's existing ports in the right pane.
To view a project's existing ports:
1.
2.
Select Ports
The Workbench right pane displays the following fields for each Port:
Port
Protocol ID
Description
Note: Use the Workbench Field Chooser to remove or redisplay any of the fields, except
the Port. The Port is required. See the "Selecting Fields to Display in the Right Pane" in
the "Using the Workbench" chapter in this manual for information about the Field
Chooser"
The Port list is initially sorted by Port. You can click on any of the other column titles at
the top of the list to sort the list by that attribute.
You can create a maximum of sixteen (16) ports per project. If you attempt to create
more ports after that, an error message displays.
17-2
GFK-1180K
2.
Result: The New Port dialog box opens when you use any method.
Port
Click OK to continue configuring the new port. The Port Properties dialog box for the
new port opens. You will need to enter information for the General and port-specific
properties.
GFK-1180K
Configuring Ports
17-3
2.
Select Ports
3.
Method 1
Double-click a port in the right pane of the Workbench.
Method 2
A. Select a port in the right pane of the Workbench.
B. Click Edit on the Workbench menu bar.
B. Select Properties.
Method 3
A. Select a port in the right pane of the Workbench.
B. Click the Properties icon
A Port Properties dialog box associated with the selected port opens when you
use any method.
17-4
GFK-1180K
The General properties let you define the following for a new port:
Description
A Description can be up to 40 characters of explanatory text about the port.
Scan Rate
The basic timer for points monitored from this port. The rate at which points are polled is
a multiple of this Scan Rate. The scan rate includes configurable units that may be set in
units of Ticks (hundredths of seconds), Seconds, Minutes or Hours.
Retry Count
Retry Count specifies the number of times to retry communications to devices on this
port after a communications error is encountered
If communications cannot be established, devices on this port are considered to be down,
and a $DEVICE_DOWN alarm is generated for each device.
Once a device is down, periodic attempts are made to resume communications to the
device.
Enable
Check the Enable check box to enable communications on this port.
Uncheck this check box to disable communications on this port.
Guide: When a port is dynamically disabled, communication to all devices associated to
that port will stop.
By default, when the port is dynamically disabled:
GFK-1180K
The associated devices will be marked Down and their associated points will be
marked Unavailable.
Setpoints and processing of unsolicited data will not be allowed for the
associated devices.
Configuring Ports
17-5
Tip: As an alternative to this default action, you may configure a Global Parameter,
ALLOW_UPDATE_WHEN_DISABLED, to keep the associated devices alive.
If ALLOW_UPDATE_WHEN_DISABLED is configured, then when the port is dynamically
disabled:
Polling stops.
See the "System Management" chapter in this manual for a description of CIMPLICITY
HMI's global parameters.
Enable Stale Data
Check Enable stale data to keep the point available in most circumstances that would
have made it unavailable. However the point value will be stale, meaning it is the last
known value and may or may not have changed in the device.
The following table displays a point's availability when events occur and
QUALITY.STALE_DATA is configured as on or off.
Event
Poll Failure
Process Shutdown
System Shutdown
Ind. Point Unavailable
Out of PTMRP Range Limits
DC Sends Device State
DynCfg Disable Point/Device
17-6
GFK-1180K
Allen-Bradley Communications
Allen-Bradley Data Highway Plus
Allen Bradley DF-1 Communications
Allen-Bradley Intelligent Antenna Communications
APPLICOM Device
APPLICOM Database
CCM2
DDE
FloPro/FloNet
Genius
Honeywell IPC 620 Communications
Johnson N2
Mitsubishi A-Series Serial
Mitsubishi TCP/IP
MMS Ethernet
Modbus Plus
Modbus RTU
Modbus TCP/IP
OMRON Host Link
OMRON TCP/IP
OPC Client
Series 90 Protocol (SNP and SNPX)
Series 90 TCP/IP
Series 90 TCP/IP Triplex Communications
Seriplex
Sharp TCP/IP
Siemens TI Serial Communications
Smarteye Electronic Assembly
SNP and SNPX Communications
Square D SyMax SyNet
Toyopuc Ethernet Device Communications Module
GFK-1180K
APPLICOM
DDE
FloPro/FloNet
OMRON TCP/IP
Shart TCP/IP
Configuring Ports
17-7
17-8
1.
Export the point data for the port using the Import/Export utility if you plan to
re-use the same point data.
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.
GFK-1180K
GFK-1180K
An order or priority to each Alarm Class. The order is a number from 0 to 99, where
0 is the highest priority and 99 is the lowest priority.
Colors and blinking that provide immediate visual recognition of the alarm class
state.
Audio support that provides immediate recognition when an alarm in the class is
generated.
18-1
Step 2.
Step 3.
2.
Method 1
Double-click Alarm Classes
Method 2
A. Right-click an existing alarm class in the right pane.
B. Select New from the popup menu.
Result: A new Alarm Class Configuration dialog box opens when you use either
method.
18-2
GFK-1180K
Expand Advanced>Alarms
2.
Method 1
Double-click an alarm class in the Workbench right pane.
Method 2
A. Right-click an alarm class in the Workbench right pane.
B. Select Properties from the popup menu.
Result: The Alarm Class Configuration dialog box for the selected alarm class
opens when you use either method.
GFK-1180K
18-3
Task 2.
Select the Alarm Class tab in the Alarm Class Configuration dialog box.
2.
Must be unique.
Note: The Class ID field is read-only for previously created alarm classes.
New alarm
class being
configured.
(read-write)
Existing alarm
class being
modified.
(write only)
3.
4.
Select a priority number in the Order field. CIMPLICITY gives alarms with a 0order number the highest priority. The higher the number, the lower the priority.
Note: CIMPLICITY uses these priorities internally and to prioritize
occurrences, such as alarm sound.
If you assign the same order to more than one class, the classes are alphabetized
within the order.
Example
You assign order 0 to High, Medium and Low alarm classes.
The alphabetized class order is High, Low, Medium. Alarms in these classes
will display in the High, Low, Medium order, when sorted by class in the Alarm
Viewer.
18-4
GFK-1180K
Task 2. Select Colors and Blink Rates for the Alarm States
Task 2. Select colors and blink rates for the alarm states:
1.
Different color for the Background for alarms to which the class is
assigned.
Normal State
Alarm State
Acknowledged State
Note: Default colors are White for the text and Black for the background.
2.
3.
Enter a Blink rate for each alarm state in which you want the alarm to blink.
Value
Rate/Second
20
Enter a foreground and background color that will alternate with the other
foreground and background colors selected for that state.
GFK-1180K
Alternate with the blink colors at the specified rate to create a blink.
18-5
1 Font color
2 Class Background
(different) color
3 No blink
4 2 blinks per second
5 10 blinks per second
3
Blink colors
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/2000, you can configure the frequency, duration and number
of beeps.
Note: You can open the Alarm Class Configuration dialog box and configure the audio
for a point alarm through the Point Properties dialog box.
18-6
GFK-1180K
Tip: You can specify logical names in the file name, such as SITE_ROOT and BSM_ROOT
in the path name for the wave file. These are expanded into actual directory names when
the file is used. For example, SITE_ROOT: \sounds\high.wav refers to the file
high.wav in the sounds directory within the HMI project's directory.
You can also use a special variable called WIN_DIR, which expands to the Windows
NT/98 directory.
Step 3. Select sound for the alarm class:
1.
Beep
specifications
2.
3.
Important: Sounds only play if the CIMPLICITY Alarm Sound Manager is running.
Wave files
B. Find the .wav file you want to use in the Windows Open dialog box.
The file's path displays in the File name field.
C. Click Test to test the sound.
GFK-1180K
18-7
Beep
Note: You configure how to stop the alarm sound in the CIMPLICITY Alarm Sound
Manager dialog box.
18-8
GFK-1180K
Add more colors to the default table (indexes 96 through 255 are available for this
purpose)
Import screens from a CIMPLICITY System-I/U, -D/V, -H/U or -RS/U system that
do not use the default color mappings.
Red
0
255
0
0
128
0
128
255
0
128
128
32
224
255
0
255
Green
0
0
255
0
0
128
0
255
128
128
128
64
176
0
255
255
Blue
0
0
0
255
0
0
128
255
128
128
0
64
160
255
255
0
Color
Black
Red
Lime
Blue
Maroon
Green
Purple
White
Teal
Gray
Olive
Dark
Rose
Fuchsia
Aqua
Yellow
2.
Use the same rgb.dat and am_colors.cfg files for all projects.
Important: The file that is used to display colors is the file for the project in which
Alarm Viewer or CimView was started in, not the file for the project where the alarm
classes or CimView screens were configured.
Exampleam_colors.cfg file
GFK-1180K
18-9
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
18-10
GFK-1180K
Alarm State
Alarm High
Warning
High
Warning
Low
Alarm Low
Normal
Normal Msg
For digital points, only one alarm state can be defined. That is, a digital point is in alarm
when it is either "1" or "0". Otherwise, the point's value is in the Normal state. Also,
note the following:
GFK-1180K
Point Value
Alarm State
Alarm state
Alarm state
19-1
Example
The following alarm message has been configured for an analog point:
Temp Alarm - Temp: %STATE
The analog point references the following set of alarm strings when the
corresponding values are defined:
Alarm High
VERY HOT
Warning High
HOT
Warning Low
COLD
Alarm Low
VERY COLD
If the value of the analog point is above the Alarm High value, the text of the Alarm
message will be
Temp Alarm - Temp: VERY HOT
An index number, which is specified when a set is defined, identifies each set of alarm
strings. You can configure up to 99 alarm string sets, numbered 1 through 99. When you
configure a point you can select the set that applies to the point for inclusion in the point's
alarm message.
The CIMPLICITY default configuration includes a set of alarm strings for Index number
1. The Index number 1 alarm string is the default when you add a device point. This string
may be modified but should never be deleted.
19-2
GFK-1180K
Step 2.
Either:
Step 3.
2.
Expand Alarms
3.
.
.
The Workbench right pane displays the following fields for each Alarm String
Index:
Index
Note: Use the Workbench Field Chooser to remove or redisplay any of the fields, except
the Index. The Index is required. See the "Selecting Fields to Display in the Right Pane"
in the "Using the Workbench" chapter in this manual for information about the Field
Chooser"
The Alarm Definition list is initially sorted by Index. You can click on any of the other
column titles at the top of the list to sort the list by that attribute.
GFK-1180K
19-3
2.
Expand Alarms.
3.
The Alarm String Index dialog box opens when you use any method.
19-4
GFK-1180K
2.
Expand Alarms.
3.
4.
An Alarm String Index dialog box associated with the selected alarm string
opens when you use any method.
GFK-1180K
19-5
A higher severity
number gives
thealarm a higher
the priority.
(For new alarm strings) Use the next available alarm string index number
(default) in the Alarm string index field or enter a new, unique index number.
The new alarm string index number:
2.
Enter a string value for each of the alarm states: Alarm high, Warning high,
Warning low, Alarm low and Normal.
The string can contain up to 16 characters. The value you enter will display
when the point is in the related alarm state.
19-6
GFK-1180K
3.
Enter a number from 32767 to +32767 in the Severity field for each alarm
state. The higher the number, the more severe the alarm. CIMPLICITY treats
more severe alarms with higher priority.
The Point Manager
4.
Result: The alarm string you entered displays when the point is in the related
alarm state. The CIMPLICITY ActiveX AMV control can display and sort alarms
according to the alarm severity.
Alarm Severity Displayed in the ActiveX Alarm Control: Example
Alarm String
configuration
CimView
AMV Alarm Control
GFK-1180K
19-7
Configuring Alarms
About Alarms
CIMPLICITY HMI software generates alarms for:
1.
2.
2.
Select Alarms
The Workbench right pane displays the following fields for each alarm:
GFK-1180J
20-1
Alarm ID
Class 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 runtime parameters (see page 20-Error!
Bookmark not defined.).
Note: The Alarm ID must have an Alarm Type of
$CIMBASIC otherwise the alarm message may not be
displayed correctly.
Message
Description
Tip: Use the Workbench Field Chooser to remove or redisplay any of the fields, except
the Alarm ID. The Alarm ID is required. See the "Selecting Fields to Display in the Right
Pane" in the "Using the Workbench" chapter in this manual for information about the
Field Chooser"
The Alarm Definition list is initially sorted by Alarm ID. You can click any of the other
column titles at the top of the list to sort the list by that attribute.
$ALARM_DISABLED
$ALARM_ENABLED
$ALARM_MODIFIED
$ALARM_RAWLIM
$ALARM_RESTORED
$AM_STATUS
$DEVICE
$DEVICE_DOWN
20-2
GFK-1180J
GFK-1180J
$DEVICE_FAILOVER
$DL_FILE_FULL
$DOWNLOAD
$DYN_CFG
$GMR_DEV_DOWN
$GMR_POINT_DISCREPANCY
$LOGIN_FAILURE
$LOGON
$LOGOUT
$REDUND_DEV_DOWN
$RTR_LINK_DOWN
AMSI_ALARM
DB_CONN_DOWN
DB_START_FORWARD
MCP_PROC_DOWN
Configuring Alarms
20-3
Alarm Configuration
Step 1.
Step 2.
Step 3.
Step 4.
Step 5.
2.
Result: The New Alarm dialog box opens when you use any method.
3.
Enter the name of the new event alarm in the Alarm ID field.
4.
Click OK.
Result: The system verifies that the Alarm ID does not already exist, and that no
invalid characters have been used.
If the Alarm ID you entered is valid, the Alarm Definition dialog box for the new
alarm opens.
20-4
GFK-1180J
Open an event alarm's Alarm Definition dialog box, if it is not already open, as
follows:
A. Select Alarms
An Alarm Definition dialog box associated with the selected alarm opens
when you use any method.
2.
GFK-1180J
Configuring Alarms
20-5
3.
4.
Note: A reason to leave the field blank is that the alarm does not require a
variable. For example, if the alarm is created to alert users to "The
system is down." you can leave this field blank.
Always select $CIMBASIC if you are creating the alarm to be used as an
Alarm Look-up action for an event.
See the CIMPLICITY HMI Integrator's Toolkit Operation Manual (GFK-1461)
for detailed information about Alarm Types.
See the CIMPLICITY Basic Control Engine Event Editor and BCEUI Operation
Manual, GFK-1282, for details about Alarm Look-up actions.
5.
(Optional) Enter the name of a Help file that users can display when they click
Help in the Alarm Viewer.
The Help file:
Is a text file you create with a text editor (for example, Notepad) and
Enter the text that will display as the alarm message in the Alarm message
field.
An alarm message can have:
20-6
Any combination of fixed text, and variable runtime parameters (see page
20-Error! Bookmark not defined.).
An 80-character total display length for all fixed text and variable
parameters.
GFK-1180J
7.
Check if and when you want an alarm to be logged in the Alarm Logging box.
You can select any or all of the options:
Condition
Generate
Occurs.
Acknowledge
Reset
Delete
Tip: You can also enter alarm logging specifications in the Database Logger.
Open a point alarm's Alarm Definition dialog box, if it is not already open, as
follows:
A. Select Alarms
An Alarm Definition dialog box associated with the selected alarm opens
when you use any method.
2.
Modify the configuration using the same criteria that you use when you are in the
Point Properties dialog box.
The one feature you cannot configure in the Alarm Definition dialog box is
Alarm Logging. You can specify when an alarm will be logged in either the
point's Point Properties dialog box or in the Database Logger.
See "Configuring the Advanced Alarm Tab" in the "Point View, Limits and
Alarms" chapter in this manual for detailed information.
GFK-1180J
Configuring Alarms
20-7
Point Alarm
Alarm Definition
dialog box
Point Properties
dialog box
Note: You may see alarms in the list whose messages include variables such as %d, %s,
or %o. These alarms are system alarms whose messages may not be modified.
20-8
GFK-1180J
Point alarm
GFK-1180J
Configuring Alarms
20-9
Point alarm
20-10
GFK-1180J
Up to 20 comments are stored in an alarm comment file. When the 21st comment is
placed in the file, the first (oldest) comment is removed.
If you intend to enable the Store alarm comments option, make sure that the
alarm_help directory is writable.
2.
Select Properties.
The Project Properties dialog box opens.
3.
4.
Select Alarms.
5.
Click Settings.
GFK-1180J
Configuring Alarms
20-11
6.
Check Store alarm comments to enable the option and save alarm comments
beyond the life of alarms.
7.
Click OK.
Note: Click Cancel to cancel the changes.
20-12
GFK-1180J
Important: You configure the sound (.wav file or beeps) for projects in each class'
Alarm Classes Configuration dialog box. The Alarm Sound Manager only deals with
classes for which sound is configured. As a result, the Alarm Sound Manager does not
report alarms associated with classes for which no sound is configured.
Hardware requirements to generate an audio alarm include
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:
GFK-1180K
For Windows NT/2000, you can configure the frequency, duration and number
of beeps.
21-1
Step 2.
Step 3.
Step 4.
Step 5.
Step 6.
21-2
GFK-1180K
2.
in the
Method 2
A. Right-click the Alarm Sound Manager icon in the Workbench left or right
pane.
B. Select Properties from the popup menu.
Result: the CIMPLICITY Alarm Sound Manager dialog box opens when you use
either method.
GFK-1180K
21-3
Task 2.
Select the Projects tab in the CIMPLICITY Alarm Sound Manager dialog
box..
2.
Click Add.
The Add Project dialog box opens.
3.
4.
Enter a number equal to or greater than 0 in the Priority field to specify the
project's priority relative to other projects.
0 is the highest priority. The higher the number you enter, the lower the priority.
The list of projects on the Projects tab is sorted in the order of priority that you
specify.
The Alarm Sound Managers uses this project ordering to help determine which
sound plays first at run-time.
Example
You assign projects with priorities as follows.
Project
Priority
PROJ_A
PROJ_B
PROJ_C
21-4
Project
Priority
PROJ_C
PROJ_B
PROJ_A
GFK-1180K
5.
(Optional) Specify an alarm setup, which will filter the alarms that will trigger a
sound, in the Setup field.
Use one of the following methods.
Method 1
Type the name of an existing setup that was created in the stand-alone
Alarm Viewer, Alarm Viewer OCX or the Alarm Sound Manager.
Method 2
A. Click the Browse button to the right of the Setup field.
The Alarm Setups dialog box opens. Setups that were created in either the
stand-alone Alarm Viewer, Alarm Viewer OCX display or in the Alarm
Sound Manager display in the Setup list.
B. Either:
Create a new setup. See the "Configuring Alarm Viewer Fields and
Buttons" chapter in the Alarm Viewers Operation Manual, GFK-1993
for details.
C. Click OK.
The selected setup displays in the Add Project dialog box.
GFK-1180K
21-5
6.
Click OK.
The project displays in the list of projects on the Projects tab in the
CIMPLICITY Alarm Sound Manager dialog box.
Green displays
running
project is connected.
7.
Repeat adding projects until all of the projects that should have sound for alarms
appear in the Projects list.
Note: Select a project in the list and click Delete if you want to delete it.
2.
3.
4.
Click OK.
Result: The Alarm Sound Manager saves the configuration that appears on all of
the tabs in the CIMPLICITY Alarm Sound Manager dialog box in an .ini file.
You can continue to save the profile if you change the configuration on any other
tabs.
The profile is available whenever it is required.
Tip: Click Load profile on any tab in the CIMPLICITY Sound Manager dialog box
to load any of the profiles you saved.
21-6
GFK-1180K
Task 2.
Task 3.
Select which priority the Alarm Sound Manager should check first when
concurrent alarms are received as follows.
Check
Alarm Class
Project
3.
Specify the default priority that the Alarm Sound Manager will assign to each
project that is added to a current session in the Project default priority field.
Enter 0 or higher in the Project default priority field, where 0 is the highest
priority. The higher the number, the lower the priority.
The number you enter appears in the Priority field when you open a new Add
Project dialog box. See page 21-4 for details about adding projects to the Alarm
Sound Manager list.
GFK-1180K
21-7
1
2
Project
Priority
3
2
1
Alarm
Class 1
ALM_A
ALM_A
ALM_A
Class 1
Priority
1
1
1
Alarm
Class 2
ALM_B
ALM_B
ALM_B
Class 2
Priority
2
2
2
In addition, you currently have one alarm generated for each class in each project.
If you prioritize audio alarms by:
Alarm Class, the alarm order is:
Alarm Sound Alarm
Project
Order
PROJ_C
1
PROJ_B
2
PROJ_A
3
PROJ_C
4
PROJ_B
5
PROJ_A
6
Class
ALM_A
ALM_A
ALM_A
ALM_B
ALM_B
ALM_B
Class
ALM_A
ALM_B
ALM_A
ALM_B
ALM_A
ALM_B
End of example.
21-8
GFK-1180K
Specify the condition under which the sound/beep for an alarm is stopped as
follows.
Check
Acknowledge only
Acknowledged
Reset only
Reset.
Acknowledged or reset.
When the Alarm Manager stops the sound for one alarm, it provides sound for
the next highest priority alarm.
2.
Select whether or not to have the Alarm Sound Manager repeat the sound for an
alarm until it meets the stop sound conditions, as follows.
Check Repeat sound/beep to have the Alarm Sound Manager repeat the
sound.
The .wav sound or group of beeps (as specified in the Alarm Class
Configuration dialog box) repeats every 10 seconds for the alarm until the
stop sound/beep condition is satisfied.
When the stop condition is satisfied the Alarm Manager repeats the sound
for the alarm that assumes the highest priority status.
3.
To
Mute
Mute and
Clear mute on new alarm
Neither
GFK-1180K
21-9
1 Check to repeat the sound for the highest priority alarm until
2
3
4
2.
3.
Either:
Select an existing profile (e.g. the same profile you saved on the Projects
tab) or
4.
Click OK.
Result: The Alarm Sound Manager saves the configuration that appears on all of
the tabs in the CIMPLICITY Alarm Sound Manager dialog box in an .ini file.
You can continue to save the profile if you change the configuration on any other
tabs.
The profile is available whenever it is required.
Tip: Click Load profile on any tab in the CIMPLICITY Sound Manager dialog box
to load any of the profiles you saved.
21-10
GFK-1180K
Task 2.
Select the Startup tab in the CIMPLICITY Alarm Sound Manager dialog box.
2.
3.
Specify the Alarm Sound Manager profile that will be used as follows.
A. Click the Open dialog box button
field.
Tip: Select projects to start when Windows starts on the Startup Options tab in the
CIMPLICITY Options dialog box.
To open the CIMPLICITY Options dialog box:
GFK-1180K
1.
2.
21-11
2.
3.
Either:
Select an existing profile (e.g. the same profile you saved on the Projects or
Options tab) or
4.
Click OK.
Result: The Alarm sound Manager saves the configuration that appears on all of
the tabs in the CIMPLICITY Alarm Sound Manager dialog box in an .ini file.
You can continue to save the profile if you change the configuration on any other
tabs.
The profile is available whenever it is required.
Tip: Click Load profile on any tab in the CIMPLICITY Sound Manager dialog box
to load any of the profiles you saved.
21-12
GFK-1180K
An option to mute the sound that appears on the bottom of each tab.
Note: When the Clear mute on new alarm checkbox on the Options tab is checked, the
Alarm Sound Manager unchecks Mute and resumes alarm sounds when a new alarm is
triggered. See page 21-9 for details about specifying sound conditions.
Alarm Sound Manager Dialog: Section Displays on all Tabs
GFK-1180K
21-13
The icon displays as follows to alert you when the sound is mute. (The Mute checkbox is
checked on any tab in the CIMPLICITY Alarm Sound Manager dialog box.)
Tip: Click the Alarm Sound Manager task bar icon to open the CIMPLICITY Alarm
Sound Manager dialog box.
21-14
GFK-1180K
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-1180K
22-1
Assigning Alarms
CIMPLICITY HMI software generates two types of alarms; point alarms and
system alarms. Each point alarm is uniquely identified by its Alarm ID. Each
system alarm is uniquely identified by its Alarm ID and Resource ID.
For example:
Note: A possible exception is for $DEVICE_DOWN. You can use the Global
parameter DEVICE_DOWN_DEVICE_REF to put only the Device ID as the
alarm reference.
For Alarm Blocking, you can assign a uniquely identified alarm to only one
group. This means:
If you select Peer Blocking mode, only the first alarm in a set of
alarms with equal priority displays.
22-2
GFK-1180K
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-1180K
22-3
2.
Expand Alarms
3.
.
.
The Workbench right pane displays the following fields for each alarm blocking
group:
Group ID
Note: Use the Workbench Field Chooser to remove or redisplay any of the
fields, except the Group ID. The Group ID is required. See the "Selecting Fields
to Display in the Right Pane" in the "Using the Workbench" chapter in this
manual for information about the Field Chooser"
The Alarm Definition list is initially sorted by Group ID. You can click on any
of the other column titles at the top of the list to sort the list by that attribute.
2.
Expand Alarms.
3.
22-4
GFK-1180K
Method 4
A. Select Alarm Blocking.
B. Click the New icon
on the Workbench menu bar.
The Alarm Blocking dialog box opens when you use any method.
2.
Expand Alarms.
3.
4.
GFK-1180K
22-5
22-6
GFK-1180K
Adding an Alarm
You can enter the name of an Alarm ID in the Alarm ID field in the Alarm
Blocking dialog box in any of the following ways:
You can select Add to open the Browser dialog box and browse
for the Alarm ID you want.
You can click the Browser button to the right of the input field to
open the Browser dialog box and browse for the Alarm ID you
want.
You can click the Pop-up menu button to the right of the input field
to create a new Alarm ID, modify the current Alarm ID or browse
for an Alarm ID.
Enter the priority of the Alarm ID in the Priority field. This can be a number
from 0 to 32767. The higher the number you enter, the higher the blocking
priority for the alarm. For example, if you have alarm XXX with priority set to
10 and alarm YYY with priority set to 100 in the same group, when alarm YYY
generates, it blocks alarm XXX.
If the Alarm ID does not have a Point ID, you must assign a Resource ID to
the alarm. You can click the Browser button to the right of the input field to
open the Browser dialog box and browse for the Resource ID you want. You
can also use the Pop-up menu button to create a new Resource ID, modify the
current Resource ID or browse for a Resource ID. Remember that each Alarm
ID/Resource ID combination must be unique within a group and across all
groups.
Removing an Alarm
To remove an alarm from an Alarm block group:
GFK-1180K
1.
Select the alarm from the list in the group's Alarm Blocking dialog
box.
2.
Press Delete.
22-7
Modifying an Alarm
You can modify an alarm's name, priority and Resource ID in the list. All you
need to do is:
1.
Select the field you want to edit in the Alarms list in the group's
Alarm Blocking dialog box.
2.
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.
2.
3.
22-8
Enter the new priority and/or Resource ID for the alarms and select
OK. All the selected alarms will be assigned the new priority.
Non-point alarms will be assigned the new Resource ID.
GFK-1180K
Important: Before you start, make sure that the printer is not configured in Windows.
2.
Expand Alarms
3.
.
.
The Workbench right pane displays the following attributes for each Alarm
Printer:
GFK-1180K
Name
Node ID
Destination
Page Width
Page Length
23-1
Note: Use the Workbench Field Chooser to remove or redisplay any of the fields, except
the Name. The Name is required. See the "Selecting Fields to Display in the Right Pane"
in the "Using the Workbench" chapter in this manual for information about the Field
Chooser"
The Alarm Printer list is initially sorted by Name. You can click on any of the other
column titles at the top of the list to sort the list by that attribute.
2.
Expand Alarms.
3.
Result: The New Alarm Log Printer dialog box opens when you use any method.
23-2
GFK-1180K
Enter the name of the new alarm printer, or the name of the file you want to write
alarms to in the Name field
You may enter a maximum of 11 characters.
2.
Click OK.
Result: The system verifies that the alarm printer name does not already exist, and
that no invalid characters have been used.
If the alarm printer name you entered is valid, the Alarm Printer dialog box for the
new alarm printer opens.
2.
Expand Alarms.
3.
4.
Result: An Alarm Printer dialog box associated with the selected alarm string
opens when you use any method.
GFK-1180K
23-3
Note: You can also configure redundant alarm printers if your project supports the Host
Redundancy option.
When you are finished defining the alarm printer properties, click OK to close the Alarm
Printer dialog and create the new alarm printer, or click Cancel to close the property
sheet without creating the new alarm printer.
Specifications include:
Alarm Logging Options
Log Events
Select this check box if you want to log events to the printer.
23-4
GFK-1180K
Log Alarms
Check this check box if you want to log alarms to the printer.
Note: If you uncheck this check box, the Alarm logging options are grayed out.
Alarm Logging Options
These options are available only when you select the Log alarms check box.
Use these fields to specify the types of alarms, and alarms classes that will be printed on
this alarm printer:
Generated alarms
Set this check box to log messages when alarms are generated.
Acknowledged alarms
Set this check box to log messages when alarms are acknowledged.
Reset alarms
Set this check box to log messages when alarms are reset.
Deleted alarms
Set this check box to log messages when alarms are deleted.
All alarm classes
Set this check box to log messages for all alarm classes. When you do, the Alarm
Class field will be dimmed.
Alarm Class
This field is available when you uncheck the All alarm classes check box.
If you want log alarms for a particular Alarm Class, enter that class name in this field.
You can also:
GFK-1180K
Display the Select Alarm Class browser and use it to select the Alarm Class.
23-5
Enter the name of a local port on the project's computer (e.g. 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 (e.g. alarms.fil).
If you do not enter a file extension, none is automatically provided. The file is
placed in the project directory (not in the project's log directory) .
Example
If a project name is systest, the file is placed in the systest folder:
I:\testplans\systest
Tip: You can associate more than one alarm printer with a network printer or file on a
network disk. If you use a network printer or file, clear the Print header field in the
Layout tab of the Alarm Printer dialog box.
23-6
GFK-1180K
Specifications include:
Print Headers
Check this check box if you want to print a header at the top of each page.
If you have more than one alarm printer process sending messages to the same printer or
file, uncheck this check box. When you uncheck the check box, the Page length field is
disabled.
Page Length
Enter the number of lines per page that can be printed. The number must be an integer
between 1 and 999.
Page Width
Enter the number of characters that can be printed on a line. The number must be an
integer between 80 and 157.
Redundant Alarm Printing
This field is enabled if your project has the Host Redundancy option.
Check this check box if you want both the Master and Slave computers to print alarms.
Uncheck this check box if you only want the Master computer to print alarms.
GFK-1180K
23-7
23-8
GFK-1180K
Alarm Date/Time
Select the format you want to use to print the date and time of each alarm. A sample for
the format you choose displays in the Sample field in this box. You may select one of the
formats from the list, or construct your own format.
To construct date formats, use the following information:
m
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
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.
For example, if you enter HHHH:MM:SS:TT p, the sample time will be 13:05:06:08
PM.
You may use colons, spaces or any other delimiter of your choice to separate the time
fields.
GFK-1180K
23-9
For a redundant configuration where each computer has a local line printer (LPT1)
configured.
The primary computer is COMP1 and the secondary computer is COMP2.
If you enter LPT1 in the Output field and check Redundant alarm printing,
the Master project on COMP1 sends alarm messages to LPT1 on COMP1 and
the Slave project on COMP2 sends alarm messages that it generates while in
standby mode to LPT1 on COMP2.
When the project on COMP2 becomes the Master project, it continues to send
alarm printer messages to LPT1 on COMP2.
If you enter LPT1 in the Output field and uncheck Redundant alarm printing,
the Master project on COMP1 sends alarms to LPT1 on COMP1. The Slave
project on COMP2 sends no alarms until it becomes the Master project.
When the project on COMP2 becomes the Master project, it sends alarm
messages to LPT1 on COMP2.
2.
If you enter \\ABC\NET1 in the Output field and check Redundant alarm
printing, the Master project on COMP1 sends alarm messages to \\ABC\NET1
and the Slave project on COMP2 sends alarm messages that it generates while in
standby mode to \\ABC\NET1.This may result in duplicate messages.
If you select this option, disable the Print header field.
23-10
GFK-1180K
If you enter \\ABC\NET1 in the Output field and uncheck Redundant alarm
printing, the Master project on COMP1 sends alarms to the network device. The
Slave project on COMP2 sends no alarms until it becomes the Master project.
When the project on COMP2 becomes the Master project, it sends alarm
messages to \\ABC\NET1.
Note: Check Redundant alarm printing on the Layout tab in the Alarm Printer dialog
box if you want both the master and slave computers to print alarms. See page 23-7.
<rate>
<set>
<n >
<m>
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 mode line file:
GFK-1180K
1.
2.
3.
Save the file called cimp_port.bat in the top-level directory on the disk where
your project is located.
23-11
2.
3.
Enter amlp_flush.exe.
Note: You can also initiate amlp_flush.exe from scripts within the CIMPLICITY
HMI environment. This will trigger printing whenever the specified conditions (for
example an alarm going off) are met.
23-12
GFK-1180K
The Alarm Line Printer program (AMLP) assumes that there is no restriction for the
size of the alarm message queue. If the output device is disabled, a virtual memory
overflow can result.
You can use the AMLP_MAX_QUEUE global parameter to restrict the size of the
alarm message queue.
2.
The Alarm Line Printer program (AMLP) assumes that the time to be printed when
an alarm is acknowledged or deleted is the time the alarm was generated.
You can use the AMLP_USE_GEN_TIME global parameter to select whether you
want the generation time or the action (acknowledge or delete) time to be printed.
See the "Using Global Parameters" chapter in this manual for details about global
parameters.
GFK-1180K
23-13
Configuring Roles
About Roles
Each user in CIMPLICITY is assigned a role.
A role specifies what privileges its users have when they work in CIMPLICITY HMI.
Types of privileges include:
Action Calendar configuration (if the Action Calendar option is part of your
CIMPLICITY HMI product.)
The CIMPLICITY HMI default configuration includes the following three roles:
GFK-1180K
SYSMGR
USER
OPER
24-1
Role Configuration
The Workbench displays a project's existing roles in the right pane.
When you enter specifications for a role you
2.
Select Roles
The Workbench right pane displays the Role ID for each Role.
2.
The New Role dialog box opens when you use any method.
24-2
GFK-1180K
2.
Click OK.
Result: The system verifies that the Role ID does not already exist, and that no invalid
characters have been used.
If the Role ID you entered is valid, the Role Properties dialog box for the new role will
open.
2.
3.
The Role Properties dialog box associated with the selected role opens.
GFK-1180K
Configuring Roles
24-3
2
1
3B
3A
1 Checked assigns privilege.
2 Unchecked denies privilege.
3 Role can set points that have a
level number equal to or lower than
the Role Level number.
e.g. Points at the following levels
can be set :
A For SYSMGR, lower or equal to
100.
B For OPER, lower or equal to 10.
When checked a:
24-4
Privilege
Dynamic configuration
Process Control
Delete alarms
GFK-1180K
Level
Trigger Event
Script Control
Set point
Point by Address
Modify Attributes
See the "Monitoring Point Attributes" chapter in the CIMPLICITY HMI CimEdit Manual
(GFK-1396) for more information about the MANUAL_MODE and
QUALITY.DISABLE_WRITE attributes.
See " Using the Point Control Panel" chapter in the CIMPLICITY HMI User's Manual
(GFK-1180) for more information about enabling and disabling manual mode in the
Point Control Panel.
GFK-1180K
Configuring Roles
24-5
Unchecked
Configuration
24-6
Checked
Unchecked
GFK-1180K
2.
Uncheck the application's check box to prevent a role's users from configuring
an application.
Result: Access to any unchecked application is denied to a user for all unchecked
boXEs.
GFK-1180K
Configuring Roles
24-7
Example
The Point box is unchecked for a role in the Role Properties dialog box. When a user
attempts to open a point's dialog box by displaying the point's popup menu in the
Workbench, point access is dimmed.
Configuration access
denied.
24-8
GFK-1180K
Configuring Users
About Users
The Users application enables you to configure users for your CIMPLICITY HMI
project.
A User is an individual person working with a CIMPLICITY HMI project.
For each CIMPLICITY HMI user you can specify the following:
Security.
A user may be assigned a password. If a password is configured and enabled, then a
user cannot access CIMPLICITY project functions without entering both the User ID
and password.
Roles and Privileges.
Resources availability.
A user's view determines the resource data to which the user has access. Alarms for
resources outside a user's view will not appear on the user's Alarm Viewer window.
GFK-1180K
25-1
User Configuration
When you enter specifications for a user you
Step 1.
Step 2.
Step 3.
2.
Click Users
The Workbench right pane displays the following attributes for each User:
User ID
Enabled
Password
Role ID
User Name
Note: Use the Workbench Field Chooser to remove or redisplay any of the fields, except
the User ID. The User ID is required. See the "Selecting Fields to Display in the Right
Pane" in the "Using the Workbench" chapter in this manual for information about the
Field Chooser"
The User list is initially sorted by User ID. You can click on any of the other column
titles at the top of the list to sort the list by that attribute.
25-2
GFK-1180K
2.
Result: The New User dialog box opens when you use any method.
New User Dialog Box Filled In
2.
Click OK.
Result: The system verifies that the User ID does not already exist, and that no
invalid characters have been used. The User Properties dialog box opens is the
User ID is approved.
GFK-1180K
Configuring Users
25-3
2.
Select Users
3.
Method 1
Double-click a user in the right pane of the Workbench.
Method 2
A. Select a user in the right pane of the Workbench.
B. Click Edit on the Workbench menu bar.
B. Select Properties.
Method 3
A. Select a user in the right pane of the Workbench.
B. Click the Properties button
A User Properties dialog box associated with the selected user opens when you
use any method.
25-4
GFK-1180K
Note: If you change a user's configuration dynamically, the user must log out then log
back in for the changes to take effect.
Role
Enter the user's role in the Role field.
Click the Browser button
to the right of the input field to display the Select A Role
Browser and use it to select the role.
You can also click the Popup Menu button
role, or Browser for another role.
Password needed
Check Password needed to require the user to enter a password at login.
Password and Confirm Password
Password and Confirm Password are enabled when the Password Needed checkbox
is checked.
1.
2.
GFK-1180K
Configuring Users
25-5
Can use the ChangePassword command in the Basic Control Engine to change
the password in CimView.
(In a Server Redundancy configuration) can only change the password when the
Primary computer is running.
User name
Enter the user's name or descriptive text about the user.
Enabled
Either:
Result: When Enabled is unchecked, the account is not available for user login.
Important: If you disable an account dynamically, currently logged in users will not be
logged out; however, new login attempts will be rejected.
Password Expires
Enter the number of days until the users password expires or enter zero if the password
never expires in the Password Expires field.
Result: After the elapsed number of days, the user will be required to change the
password prior to logging in.
25-6
GFK-1180K
Note: If you change a user's resources dynamically, the user must log out then log back
in to access the changed resources.
2.
Click Add.
2.
Click Remove.
Note: You can also use the Shift and Ctrl keys in combination with the mouse to select
more than one resource for deletion.
GFK-1180K
Configuring Users
25-7
2.
Select Properties.
3.
4.
Select Alarms.
5.
Click Settings.
Either:
Option 1Disable automatic account disabling
Check No account disable.
Option 2Enable automatic account disabling:
2.
1.
2.
Enter the number of failed login attempts before disabling the account.
Click OK.
Result: The dialog box closes and your changes are saved.
25-8
GFK-1180K
GFK-1180K
2.
3.
Configuring Users
25-9
Alarms,
Event alarms,
Single points,
Groups of points,
External applications.
The configuration is straightforward. You do not need to know about SQL or other
ODBC database internals to configure Database Logger logging tables.
Use existing tables or create new tables that will log selected items for any one
of the processes.
Enter specifications for how, when and to what ODBC data source you want to
log data.
When you start the project in which you configured the Database Logger, the
Database Logger creates tables you configured based on the attributes you specified.
Creating a report is also straightforward. CIMPLICITY provides sample reports that you
use in Excel. You can use these sample reports to quickly generate a report or as a basis
to create new reports.
GFK-1180K
26-1
Note: The Database Logger option uses the standard ODBC interface to log your
production data.
Refer to the Readme file that accompanies this release for a list of supported database
interfaces.
2.
3.
4.
5.
7.
26-2
External applications.
GFK-1180K
On-node
Off-node
Table Type
Write Definition
DATA
1 for timestamp
The more attributes you have, the slower the writes will be.
GROUP
Example
If you are logging the value of two points, your group log table
will have 3 fields, timestamp and two fields for the points' values.
Bulk Insertion Peak Performance:
CIMPLICITY Database
Logger using bulk insertion.
On-node
Off-Node
Avg.
bytes/write
28
28
Approx.
Writes/sec
900-1000
700-800
Approx.
Total throughput/sec
25-30Kb
20-25Kb
Important: (For SQL Server) insert triggers fire only if bulk insertion is disabled.
GFK-1180K
26-3
2.
Method 1
Double-click Database Logger
pane.
Method 2
A. Select Database Logger in the right pane of the Workbench.
B. Click Edit on the Workbench menu bar.
C. Select Properties.
Method 3
A. Right-click Database Logger in the right pane of the Workbench.
B. Select Properties from the popup menu.
Method 4
A. Select Database Logger in the right pane of the Workbench.
B. Press Alt+Enter on the keyboard.
Result: The Database Logger window opens when you use any of these methods.
26-4
GFK-1180K
The icon to the left of each table indicates its type as follows:
Icon
Table
ALARM_LOG
Data
EM_LOG
EVENT_LOG
External application
Group
Log:
Selected alarms that appear in the Alarm
Viewer.
Selected point values individually.
Event Manager activities.
Selected system alarms that do not appear in
the Alarm Viewer.
Actions in certain CIMPLICITY
applications, e.g., Tracker.
Selected point values in parallel.
In order to configure how, when and where logs will collect and report data you can start
at the Database Logger level to specify certain properties and become more specific in
your configuration as follows:
Level 1.
Configure Database Logger defaults that apply to all tables in the Database
Logger.
Level 2.
Level 3.
When you complete your configuration to can easily create a report for reviewing logged
data.
GFK-1180K
26-5
Configuration Tool
Logging attributes,
Connection,
Maintenance events,
Advanced specifications.
26-6
GFK-1180K
Configuration Tool
29
55
Alarm logging
69
85
100
Application logging
100
Enter logging conditions that are different from the table defaults
for individual items in the table.
Configuration Tool
Result: When configuration for any table is completed you can open Excel and
generate reports from the samples that are included in CIMPLICITY or create your
own reports.
GFK-1180K
26-7
Note: The Event Manager Log (EM_LOG) and logs for external applications require
new reports.
Configure logging conditions for a:
Single point
50
Alarm
83
Event alarm
98
26-8
Data
Trends
115
118
121
GFK-1180K
Open
the Database Logger
Configuration window.
2 External
Application
Report specific to
application
Configure
Database Logger
defaults in a Properties
dialog box at this level.
Open
individual
Logging
Tables based
on what needs
to be logged.
For
Event Alarms
Open
EVENT_LOG
For
Points
Open a
Data log table
For
Point Groups
Open a
Group log table
For
Event Management
Configure
EM_LOG
Report created
on site.
Add
Alarm IDs or
Point IDs to the
table.
Configure
tables and items
in a Properties
dialog box at
each level.
For
Alarms
Open
ALARM_LOG
Use
provided Excel
reports (or create
reports) to display
selected data.
Add
Alarm IDs
Add
Alarm IDs
Alarm Report
Add
Point IDs
Values logged
individually.
Data Report
Add
Point IDs
Values logged
in parallel.
Trend Report
and Chart
A table can have, at most, 250 columns. The number of columns you can actually
have in a group table depends on the type of data you are storing.
GFK-1180K
26-9
Method 2
A. Click File on the Database Logger Configuration window menu bar.
B. Select New Table.
Method 3
A. Right-click any icon in the Database Logger Configuration windows list.
B. Select New in the popup menu.
The New Table dialog box opens when you use any method.
26-10
GFK-1180K
2.
Can contain
Underscores ( _ ).
Should not use any words that are reserved for the database management
system being used.
Example
If you are using a SQL Server, do not use BULK, which is a reserved word
for that DBMS.
3.
4.
Click OK.
Result: A Table Properties dialog box opens for you to configure the new table.
Important: You can only create new group, data and application log tables.
Only one alarm table (ALARM_LOG), event table (EVENT_LOG) and Event Manager
(EM_LOG) table exist in the Data Logger. You cannot delete these tables, and you cannot
create additional Alarm, Event or Event Manager tables.
2.
Method 2
Double-click the selected table.
Method 3
A. Click File on the Database Logger Configuration window menu bar.
B. Select Open Table.
GFK-1180K
26-11
Method 4
A. Right-click the selected table.
B. Select Open in the popup menu.
Method 4
Press Ctrl+O on the keyboard.
Result: The selected table opens when you use any method.
ALARM_LOG,
EM_LOG,
EVENT_LOG and
2.
Method 2
A. Click File on the Database Logger configuration window menu bar.
B. Select Copy Table.
Method 3
A. Right-click the selected table.
B. Select Copy in the popup menu.
Method 4
Press Ctrl+C on the keyboard.
A Copy table dialog box opens.
26-12
GFK-1180K
3.
Enter the name of the new table in the New table ID field.
4.
Click OK.
Result: The new table ID appears in the list of tables. You can now configure it as
you would any table.
ALARM_LOG,
EM_LOG,
EVENT_LOG and
2.
3.
Enter the new name for the table in the New table ID field.
4.
Click OK.
GFK-1180K
26-13
ALARM_LOG
EM_LOG
EVENT_LOG
2.
Method 2
A. Click File on the Database Logger configuration window menu bar.
B. Select Delete Table.
Method 3
A. Right-click the selected table.
B. Select Delete in the popup menu.
A message appears to inform you of the number of items in the table and
confirm deletion.
3.
Click OK.
26-14
GFK-1180K
2.
3.
Either:
A. Click OK to filter the list according to the information you've entered, or
B. Click Cancel to cancel the filter function.
Tip: To display all the items in the table, enter an asterisk (*) in the <Type> Identifier
field.
Use this wildcard to search for any number of characters at this point in the string. For
example, if you want to display the list of tables that start with M and end with X, enter
M*X in the Table Identifier field.
Use this wildcard to search for any character in this place in the string. For example, if
you want to display the list of tables whose first character is M and third character is X,
enter M?X in the Table Identifier field.
Note: There are no implied wildcards. If you do not include or terminate your search
string with an asterisk, only those items that match your request exactly will be returned.
If a Browser button is available to the right of an input field, you can click it and use the
Browser to select the filter.
If you are calling ODBC functions directly, you cannot use the * and ? wildcards. The
underscore ( _ ) character is the only available wildcard. Use it to search for any
character in this place in a string.
If you are calling SQL functions directly, you can use the * and ? wildcards.
GFK-1180K
26-15
26-16
GFK-1180K
Open the CIMPLICITY table in the Database Logger that you want to reconcile.
2.
3.
Red
Red
Red
Black
GFK-1180K
Enabled if looking at
indexes not updated from a
5.0 or older data log.
26-17
4.
Review the icons that display differences between the CIMPLICITY table
(Database Logger configuration) and the logging database as follows.
Field in the
CIMPLICITY
Field in the
Database
Logging
Logger
Database
Icon
Comment
(G,G)
Yes
Yes
(R line)
Yes
Yes
Types dont
match.
(R, G)
No
Yes
Unused
(G, R)
Yes
No
Uncreated
(Black)
Removed
Removed
Note: G=Green, R=Red
5.
Create uncreated fields that are in the CIMPLICITY table but not in the logging
database.
A. Select the fields that display the
(G,R) icon.
Tip: Press the Shift or Ctrl key to select multiple fields, or click Select
Uncreated to select all the uncreated fields in the table.
B. Click Create.
Result: The fields are created in the logging database. The fields icons
change to:
(G, G).
6.
Remove unused fields that are in not in the Database Logger, but are in the
logging database.
For Microsoft Access
A. Select the fields that display the
(R, G) icon.
Tip: Press the Shift or Ctrl key to select multiple fields, or click Select
Unused to select all the unused fields in the table.
B. Click Remove.
SQL Server and Oracle
SQL Server and Oracle do not directly support dropping columns in a database
table.
A. Copy the table to a temporary table.
B. Drop the table from the database.
C. Recreate the table with the fields you wish to use.
D. Copy the data from the temporary table to the new table.
E. Delete the temporary table.
F.
Result: The unused fields are removed from the database. The fields icons
change to
(Black).
7.
26-18
GFK-1180K
8.
(For Data Log tables that have indexes from CIMPLICITY V5.0 or older)
Important: Updating indexes to CIMPLICITY v5.5 may take a long time to
complete. The amount of time required depends on the size of the table. This
operation is very CPU intensive and will degrade the database server
performance while it is executing.
A. Make sure your project is shut down.
B. Disconnect any other clients accessing the table whose indexes you will be
upgrading.
C. Click Upgrade Indexes.
Result: A message appears warning you about making sure that no one is
logging to the table.
CIMPLICITY:
A. Drops all old indexes that it had created,
B. Creates new Version 5.5 indexes and
C. Disables the Upgrade Indexes button.
Method 2
1.
2.
Method 3
1.
2.
Method 4
Press Alt+F+C on the keyboard.
Result: The table closes and returns to the Database Logger Configuration
window.
GFK-1180K
26-19
2.
Select Exit.
Method 2
Click the Close Window button
Method 3
Press Alt+F+X on the keyboard.
Result: The Database Logger Configuration window closes.
Note: You can also exit the Database Logger Configuration window by clicking the
Close Window button on the top right corner of any open table.
26-20
GFK-1180K
General Parameters.
Connect and Store and forward specifications for Alarm, Event and external
application connections.
Connect and Store and forward specifications for Data and Group connections.
You can change these defaults for any individual table when you are configuring that
table's properties.
Method 2
1.
2.
Method 3
1.
2.
Result: The Logging Properties dialog box opens when you use any method.
GFK-1180K
26-21
2.
Enter an interval (in minutes) the Database Logger should wait between disk
scans in the Disk full scan rate (min) field.
Guidelines
The Database Logger scans the disk at intervals to determine if it is full. The
Disk full scan rate (min) determines how long the Database Logger waits after
completing one scan before it scans the disk again.
The default for the Disk full scan rate affects tables for which you have enabled
Disk Space Low maintenance event.
See page 26-42 in this chapter for details about Disk Space Low.
Database Logger Default:
30
Note: The Disk Full condition is only useful for Microsoft Access
databases. The SQL Server forces pre-allocation of disk space for data tables.
3. Enter a Database queue size that supports the worst-case logging during
activity bursts.
For example, if 10 points are being logged to the DATA_LOG table, you should
have a queue size of at least 10 in case the points' logging conditions all occur
simultaneously.
26-22
GFK-1180K
Guidelines
The default queue size is the size of the queue of logged data for each table in
the Database queue size field.
Increasing the size of the Database Logger queue will increase the
amount of memory used by the database logger. Since each table preallocates memory for the queue, this growth will take place at startup time.
For each additional entry in the queue, the following additional memory
will be used:
Alarm Log Table
Data Tables
Group Tables
20
4. Enter a value in ticks (100 ticks=1 second) in the Point data logging scan
rate (ticks) field that is:
Faster than the fastest table scan rate in ticks at which the Point Data
Logger will submit data for logging.
Large enough so that all the data for a PLC scan comes into the database
together.
Guidelines
The Point Data Logging scan rate is the rate at which the Point Data Logger
submits data for logging.
Database Logger Default:
5.
100
Enter the system path to the directory that holds the files created by table
maintenance export and purge actions in the Maintenance Action Export Path
field, if it is different from the default.
Guidelines
Database Logger Default:
GFK-1180K
26-23
6.
Check Enable Measurement Systems to have the Database Logger log data
for point values using the active measurement system converted value.
Note: The Database Logger logs values for device points and virtual points as
follows:
Device points
Virtual points
Example
If you configure a point to be in inches, if you are using a metric system and
that point is showing as centimeters, the Database Logger is still going to
log it as inches unless you check Enable Measurement Systems.
See the "Using Measurement Units" chapter in this manual for details about
active measurement unit configuration.
Database Logger Default:
7.
Is not checked.
Result: The pathname you enter is validated when the Parameters tab is closed.
26-24
GFK-1180K
Note: When you configure each table, you can choose to use these defaults or you can
specify an ODBC data source that is unique for that table.
The parameters that you specify as defaults deal with the:
1.
Connect information
2.
To enter Database Logger defaults for alarm, event and application logs:
1.
Select the Default Alarm Connection tab in the Logging Properties dialog box.
2.
Select an ODBC data source from the drop down list in the ODBC data
source, field. You can select from available options or configure an existing or
a new ODBC data source:
A. Select from the one or more Microsoft Access or SQL Server options in the
drop down menu. Basic options include:
GFK-1180K
26-25
iii. Configure the new ODBC data source based on the data source
procedures.
iv. Close the ODBC Data Source Administrator.
v.
3.
Select the new ODBC data source from the drop down menu.
Enter the username in the Database user field who will connect to the selected
database driver.
Important: This field is required if you are connecting to a SQL Server.
26-26
GFK-1180K
6.
Check Enable store and forward to have the ALARM_LOG table perform
store and forward functions.:
Check one of the two following options.
Option
No Limit
Either:
Click OK or
Result: The Database Logger validates your entries. You will be prompted if
additional information is required to connect to the database.
Information needed varies from database to database.
In general if you are connecting to:
Enter the Alias Name for the Oracle database in this field.
If the Data Logger is unable to connect to the selected database, validation fails.
GFK-1180K
26-27
Note: When you configure each table, you can choose to use these defaults or you can
specify an ODBC data source that is unique for that table.
The parameters that you specify as defaults deal with the:
1.
Connect information
2.
26-28
1.
Select the Default Point Connection tab in the Logging Properties dialog box.
2.
Configure the default parameters for the CIMPLICITY point and group log
tables the same way you configure the parameters for the CIMPLICITY alarm,
event and application log tables. See page 26-25 in this chapter for details.
GFK-1180K
Step 2.
Step 3.
Step 4.
Important: When using fully qualified points, you must provide remote project login
configuration with the project.
GFK-1180K
1.
2.
3.
4.
26-29
2 Double-click
DATA_LOG to open
the table.
3 Configure:
Table properties.
Logging conditions
for single point.
Note: Data logged for points includes: Point ID, Time the point value was logged
(timestamp), Resource, Value and other optional attributes that you select.
26-30
GFK-1180K
Primary key index on the joined Point ID and timestamp columns and
If you have selected the project name table attribute, the primary key index also
includes the project name column.
The primary key includes an MSEC column, if milliseconds is enabled.
Columns and rows in CIMPLICITY data logging tables are as follows.
COLUMN NAME
Constant fields
timestamp
point_id
DATA TYPE
DESCRIPTION
date/time
string
_RES
string
string
As configured.
Default is string
number
As configured.
Default is string
string
_TIME
date/time
_USER
_VAL
number
As configured.
Default is string
Attribute fields
_ALRM
_ENG
_PREV
_QUALITY
_RAW
Optional fields
project
msec
GFK-1180K
string
number
26-31
Option 1.
Add Points to Log Tables via a Point Properties Dialog Box
Option 1. Add a points data to a CIMPLICITY data table:
1.
Select Points
2.
Select, in the right pane, the virtual or device point for which you want to log
values.
3.
4.
5.
6.
Click OK or Apply.
Result: CIMPLICITY adds the point to its default DATA_LOG. You can apply
more specifications in the Database Logger.
26-32
GFK-1180K
Option 2.
Add Points to Data Log Tables through Database Logger
You can add points to a data or group log table through the Database Logger
Configuration window and in a data log or group log table's window. .
Option 2. Add points to a CIMPLICITY data log table:
1.
Method 2
i.
ii.
Method 3
i.
ii.
Method 2
A. Click File on the data table menu bar.
B. Select Add Points
Method 3
A. Right-click in the data table window.
B. Select Add Points from the popup menu.
GFK-1180K
26-33
The Select a Point browser opens when you use any method.
Piont Browser Example
2 Click OK.
2.
3.
Click OK.
Result: The Point IDs display in the data table window and will be logged
according to your specifications.
26-34
GFK-1180K
Task 2.
Task 3.
Task 4.
Task 5.
Task 6.
Task 7.
2.
Either:
Open the data log table's window. See page 26-11 for details.
Method 2
A. Click Edit on either windows menu bar.
B. Select Table Properties
Method 3
A. Right-click a data table in the Database Logger Configuration window or
any Point ID in the data table's window.
B. Select Table Properties from the popup menu.
Result. The data table, e.g. DATA_LOG Table Properties dialog box opens when
you use any method.
GFK-1180K
26-35
Note: For a CIMPLICITY data log table, you can change the table's default logging
conditions for an individual point in the (Database Loggers) Point Properties dialog box.
See page 26-50 for details.
Task 2. Configure data table logging conditions:
1.
The conditions you check define the default conditions for when the value of the
points in the table will be logged.
2.
ii.
26-36
i.
ii.
Select AM or PM.
GFK-1180K
C. Check On digital point state to log data while a digital point is in a certain
state.
i.
ii.
3.
i.
ii.
Check either:
Specific point
Specified point is updated. Enter a Point ID for this option.
The conditions you check define the conditions for when the values of
all the points in the table will be logged.
iii. Use the Deadband option if you want to filter out changes in the value
of the selected point type before triggering a logging eventfor either
the point being logged or the specific point.
GFK-1180K
a.
Check Deadband.
b.
c.
Absolute value or
26-37
The point's value must change more than the Deadband value before
another logging event will be triggered.
Example 1. Absolute Value
An Absolute Deadband value is 5.0.
Point Value
Result
200.0
201.3
No Logging event
204.2
No Logging event
205.1
Result
200.0
201.3
No Logging event
204.2
No Logging event
205.1
No Logging event
210.2
Note: An explicit deadband of 0 specifies that the point must have actually
changed as opposed to having been updated by the point manager.
B. Check On point alarm state to log point values when a specified point
goes into one or more selected alarm states.
Enter the Point ID in the Point Alarm field.
Important: For this option to work successfully, you must define alarm
limits for the trigger point. For example, if you select a Point ID and choose
its Alarm High state, logging in the table will occur each time the point
enters the Alarm High state.
C. Check one or more of the alarm states (e.g., Alarm high).
Note: The values for these alarm states are specified on the Alarm tab in
the selected points Properties dialog box.
Alarm Limits Used as Logging Conditions
Data log Properties dialog box
Default Logging Conditions tab
Group log Properties dialog box
Logging Conditions tab
26-38
GFK-1180K
You can combine On point value update logging with On point alarm state
logging.
If you do not define any logging conditions under Timed/Gated Logging, then data
will only be logged into the table when the trigger occurs.
You can combine triggers. When you combine triggers, logging occurs when either
of the triggers occurs.
Example
You want to log a set of points when POINT_A is updated or when POINT_B is in Alarm
High state. Do the following.
1.
2.
3.
4.
5.
Note: If a device point is configured as On Scan, the point value is updated on every
scan even though its value remains unchanged.
Tip: Click Use Defaults to reset the Logging Conditions to their default values. The
default is to log data periodically every 5 minutes.
GFK-1180K
26-39
Select the current point attributes that will be logged to the table.
2.
Log the:
Previous Value
INT
UINT
DINT
UDINT
REAL
STRING (255)
Previous value recorded in this table for this point.
Select a Data Type.
Raw Value
Alarm State
26-40
GFK-1180K
Resource
Engineering Units
Quality
User Flags
Table attributes
Project name
Project name.
Tip: Click Use Defaults to reset the Logging Attributes to their default values. The
defaults are to:
GFK-1180K
Select the Maintenance Events tab in a data Table Properties dialog box.
26-41
2.
ii.
ii.
Select AM or PM.
C. Check On digital point state to log data while a digital point is in a certain
state.
i.
ii.
3.
ii.
ii.
26-42
GFK-1180K
Select the Maintenance Actions tab in a CIMPLICITY data log Table Properties
dialog box.
2.
Specify that the Database Logger delete data from a logging table when a
maintenance event occurs, as follows.
A. Check Delete records
B. Select the number of records you want to retain in the table in one of the
following ways.
By Count
Delete all but the last (most recent) <n> records in the
table.
By Time
Delete all but the records entered in the table for the last
<n> days, hours, or minutes.
C. Do the following if you want to save the purged data to a CSV format file
before removing it from the table.
GFK-1180K
i.
ii.
26-43
3.
By Count
By Time
Data entered in the table for the last <n> days, hours, or
minutes is exported.
The Database Logger exports the data you specify from a
logging table to a CSV (Comma Separated Value) format
file when a maintenance event occurs.
4.
Where:
DATA_LOG is the data log table.
Where
D:\Deleted\ is the path to the program
Backupdeletedcsv.bat is the program that will be run when a
26-44
GFK-1180K
Tip: The default maintenance actions include purging all records except those created
within the last day. Click Use Defaults to use the default maintenance actions.
Use the default connections that are specified on the Default Point Connection
tab in the Logging Properties dialog box or
2.
Result: The Connection tab is dimmed and unavailable for configuration. The
data log table uses the connections specified on the Default Point Connection tab
in the Logging Properties dialog box.
GFK-1180K
26-45
Option 2. Specify connections that are specific for the data table.
1.
2.
3.
Select an ODBC data source from the drop down list in the ODBC data
source, field. You can select from available options or configure an existing or
a new ODBC data source:
A. Make a selection from the one or more Microsoft Access or SQL Server
options in the drop down menu. Basic options include:
26-46
GFK-1180K
iii. Configure the new ODBC data source based on the data source
procedures.
iv. Close the ODBC Data Source Administrator.
v.
4.
Select the new ODBC data source from the drop down menu.
Enter the username in the Database user field who will connect to the selected
database driver.
Important: This field is required if you are connecting to a SQL Server.
GFK-1180K
26-47
7.
No Limit
Disable logging actions for the table that you are configuring.
Override the queue size that is specified in the Database Logger's Logging
Properties dialog box.
Select and control bulk insertion for Microsoft SQL Server or MSDE.
26-48
Select the Advanced tab in the data log's Table Properties dialog box.
GFK-1180K
2.
3.
Check Disable logging actions to stop logging data to the selected table,
or
Leave Disable logging actions unchecked to have data logged to the table
when the CIMPLICITY project is running.
Check Use default to use the universal size specified on the Parameters tab
in the Database Logger's Logging Properties dialog box, or
Specify a queue size for the selected table, if it has special requirements, as
follows:
A. Uncheck Use default.
B. Enter a number in the Write queue size field that supports the worstcase logging during activity bursts.
For example, if 10 points are being logged to the table, you should have
a queue size of at least 10 in case the points' logging conditions all
occur simultaneously.
4.
As a result:
Important: (For SQL Server) insert triggers fire only if bulk insertion is disabled.
GFK-1180K
26-49
2.
Select the point you want to log under different conditions from the default.
3.
Method 3
A. Click Edit on the window's menu bar.
B. Select Point Properties
Method 4
A. Click the right mouse button.
B. Select Properties from the popup menu.
The (Database Loggers) Point Properties dialog box opens when you use any
method displaying either the default logging conditions or conditions that were
previously checked for the selected alarm.
3.
Select the logging conditions that apply to the selected point. See page 26-36 for
details about logging conditions.
4.
Click OK.
Result: The selected point will be logged when its logging conditions occur.
26-50
GFK-1180K
GFK-1180K
26-51
HIGH
HIGH state.
LOW
LOW state.
TRANSITION
high
low
transition
Note: Fields also appear for Timed/gated logging on a:
Data log table's Default Logging Conditions tab.
Group log table's Logging Conditions tab.
26-52
GFK-1180K
high
low
transition
Note: Fields also appear for Timed/gated logging on a:
Data log table's Default Logging Conditions tab.
Group log table's Logging Conditions tab.
high
low
transition
Note: Fields also appear for Timed/gated logging on a:
Data log table's Default Logging Conditions tab.
Group log table's Logging Conditions tab.
GFK-1180K
26-53
high
low
transition
Note: Fields also appear for Timed/gated logging on a:
Data log table's Default Logging Conditions tab.
Group log table's Logging Conditions tab.
26-54
GFK-1180K
Step 2.
Step 3.
Step 4.
Important: When using fully qualified points, you must provide remote project login
configuration with the project.
GFK-1180K
1.
2.
3.
4.
26-55
2 Double-click
GROUP_LOG to
display the table.
3 Configure:
Table properties.
Attributes for a point.
26-56
GFK-1180K
Note: Data logged for groups of points includes the time the values are logged
(timestamp) and Point ID values.
Point data can be logged as follows:
GFK-1180K
In response to an event.
26-57
If you have selected the project name table attribute, the primary key index also
includes the project name column.
The primary key includes an MSEC column, if milliseconds is enabled.
Columns and rows in Group logging tables are as follows.
COLUMN NAME
DATA TYPE
DESCRIPTION
Constant fields
timestamp
date/time
Timestamp of the logging event
Attribute fields
Note: The prefix of each attribute column is based on the SQL Field Prefix
specified for the point.
The index of each column is based on the point array element. Non array
points always have index value of '0' (e.g. <prefix>_VAL0)
<prefix>_ALRM<index>
<prefix>_ENG<index>
<prefix>_PREV<index>
string
string
Depends on point
type
<prefix>_QUALITY<index> number
<prefix>_RAW<index>
Depends on point
type
<prefix>_RES<index>
string
<prefix>_TIME<index>
date/time
<prefix>_USER<index>
<prefix>_VAL<index>
number
Depends on point
type
Optional fields
project
msec
string
number
Note: The maximum number of columns a table can have is SBMS specific. Consult
your DBMS documentation to ensure that your Group table does not exceed these limits.
Default MSDE DBMS is 1024 columns, 8060 Bytes per row.
Important: Since the Microsoft Access and Oracle format does not support sub-second
timestamp data, you cannot log points to a Group table at sub-second rates. Attempting to
do so will cause the duplicate-keyed records to be dropped from the database, unless you
have enabled millisecond logging.
26-58
GFK-1180K
Method 2
i.
ii.
Method 3
i.
ii.
Method 2
A. Click File on the window's menu bar.
B. Select Add Points
Method 3
A. Right-click in the group table's window.
B. Select Add Points from the popup menu.
GFK-1180K
26-59
The Select a Point browser opens when you use any method.
Piont Browser Example
2 Click OK.
2.
3.
Click OK.
Result: The Point IDs display in the group table's window and will be logged
according to your specifications.
26-60
Task 1.
Task 2.
Task 3.
Task 4.
Task 5.
Task 6.
Task 7.
GFK-1180K
2.
Either:
Open the group table (e.g., GROUP_LOG) window. See page 26 -11 for
details.
Method 2
A. Click Edit on either windows menu bar.
B. Select Table Properties
Method 3
A. Right-click a group table in the Database Logger Configuration window or
any Point ID in the group table's window.
B. Select Table Properties from the popup menu.
Result. The group table's (e.g., GROUP_LOG) Table Properties dialog box opens
when you use any method.
GFK-1180K
26-61
Note: Because, the points in a group table are logged in parallel, the logging conditions
are the same for all. However, you can select attributes that will be logged for individual
points.
Task 2. Configure group table logging conditions:
1.
The conditions you check define the conditions for when the values of all the
points in the table will be logged.
26-62
2.
Specify logging conditions the same way you specify them for a data log table.
See page 26-36 for details.
4.
Check On point alarm state to log point values when a specified point goes
into one or more selected alarm states.
GFK-1180K
Select the current point attributes that will be logged to the table.
The checked logging attributes will be the default logging attributes for additional points
you add to the group table.
Note: You can also specify that selected attributes be logged for individual points in the
group table. See page 26-68 for details.
Task 3. Configure a group log table's logging attributes:
1.
2.
Log the:
GFK-1180K
Point Value
Previous Value
Raw Value
Alarm State
Resource
Engineering Units
Quality
26-63
User Flags
Table attributes
Project name
Tip: Click Use Defaults to reset the Logging Attributes to their default values. The
defaults are to:
26-64
1.
Select the Maintenance Events tab in group Table Properties dialog box.
2.
Specify events the same way you specify them for a data log table. See page 2641 for the procedure.
GFK-1180K
Select the Maintenance Actions tab in the group log Table Properties dialog box.
2.
Specify actions the same way you specify them for a data log table. See page 2643 for the procedure.
GFK-1180K
Use the default connections that are specified on the Default Point Connection
tab in the Logging Properties dialog box or
Specify connections that are specific to the data or group logging table.
26-65
2.
Result: The Connection tab is dimmed and unavailable for configuration. The
CIMPLICITY group table uses the connections specified on the Default Point
Connection tab in the Logging Properties dialog box.
Option 2. Specify connections that are specific for the group table.
1.
2.
2.
26-66
Specify the connection the same way you specify it for a data log table. See page
26 -45 for the procedure.
GFK-1180K
Disable logging actions for the table that you are configuring.
Override the queue size that is specified in the Database Logger's Logging
Properties dialog box.
Select and control bulk insertion for Microsoft SQL Server or MSDE.
Select the Advanced tab in the group log's Table Properties dialog box.
2.
Do advanced configuration the same way you do for a data log table. See page
26-48 for the procedure.
Important: (For SQL Server) insert triggers fire only if bulk insertion is disabled.
GFK-1180K
26-67
2.
Select the point for which you want to log different attributes from the default.
3.
Method 3
A. Click Edit on the window's menu bar for the group log table.
B. Select Point Properties
Method 4
A. Click the right mouse button.
B. Select Properties from the popup menu.
The (Database Loggers) Point Properties dialog box opens when you use any
method displaying either the default logging conditions or conditions that were
previously checked for the selected alarm.
3.
Check the attributes that you want logged for the selected point.
4.
Click OK.
Result: The attributes you select will be logged for the selected point. The selection
does not change if you change the table defaults.
26-68
GFK-1180K
Alarm Logging
Alarm logging provides you with a straightforward process for creating and maintaining
records to analyze the alarm state of equipment and processes in your system. As a result,
alarm logging helps you determine if action is required to repair or maintain your system.
The Database Logger enables you to:
Log data about selected alarms or all alarms to an alarm log table.
You can display, print and analyze that information in a report that you create or in an
Excel CIMPLICITY Alarm Report that is included in CIMPLICITY. See page 26-121 for
details about CIMPLICITY Alarm Reports.
Note: Data logged for alarms includes: Alarm ID, Time the Alarm was Generated,
Alarm Class, Resource, Alarm Message, Logged By and other optional attributes that you
select.
GFK-1180K
26-69
Step 2.
Step 3.
Step 4.
2 Double-click
ALARM_LOG to
display the table.
3 Configure
Table Properties.
Logging conditions
for an alarm.
26-70
GFK-1180K
GFK-1180K
Alarm ID
Description
$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
26-71
Primary key index on the joined timestamp and sequence number columns and
If you have selected the project name table attribute, the primary key index also
includes the project name column.
The primary key includes an MSEC column, if milliseconds is enabled.
Columns and rows in Alarm logging tables are as follows:
26-72
COLUMN NAME
Constant fields
timestamp
sequence_number
alarm_id
alarm_class
resource
string
logged_by
reference
prev_state
string
string
string
log_action
string
final_state
string
alarm_message
generation_time
string
date/time
Optional fields
project
msec
string
number
date/time
number
string
string
GFK-1180K
Option 1.
Add Point Alarms to the ALARM_LOG Table via a Point
Properties Dialog Box
Option 1. Add a points alarms to an alarm log table:
1.
Select Points
2.
Select the point for which you want to log alarms in the right pane.
3.
4.
5.
Check if and when you want an alarm to be logged in the Alarm Logging box on
the Alarm tab of the Point Properties dialog box. You can select any or all of the
options:
Condition
Generate
Occurs.
Acknowledge
Reset
Delete
6.
Click OK or Apply.
Result: CIMPLICITY adds the point to its default ALARM_LOG. You can apply
more specifications in the Database Logger.
GFK-1180K
26-73
Option 2.
Add Alarms to ALARM_LOG through the Database Logger
You can add alarms to the CIMPLICITY ALARM_LOG table through the Database
Logger Configuration window and in the ALARM_LOG window.
Option 2. Add alarms to the ALARM_LOG table:
1.
Method 2
i.
ii.
Method 3
i.
Right-click ALARM_LOG.
ii.
Method 2
A. Click File on the ALARM_LOG window menu bar.
B. Select Add Alarms
Method 3
A. Right-click in the ALARM_LOG window.
B. Select Add Alarms from the popup menu.
26-74
GFK-1180K
The Select an Alarm Definition browser opens when you use any method.
Alarm Browser Example
2 Click OK.
2.
3.
Click OK.
Result: The alarms display in the ALARM_LOG window and will be logged
according to your specifications.
GFK-1180K
Task 1.
Task 2.
Task 3.
Task 4.
Task 5.
Task 6.
Task 7.
26-75
2.
Either:
Open the ALARM_LOG window. See page 26-11 for procedures to open
an existing table.
Method 2
A. Click Edit on either windows menu bar.
B. Select Table Properties
Method 3
A. Right-click ALARM_LOG in the Database Logger Configuration window
or any alarm in the ALARM_LOG window.
B. Select Table Properties from the popup menu.
Result. The ALARM_LOG Table Properties dialog box opens when you use any
method.
26-76
GFK-1180K
Note: You can change the conditions you specify in the ALARM_LOG Table Properties
for a single alarm. See page 26-83 for details.
Step 2. Configure ALARM_LOG default logging conditions:
1.
The conditions you check define the default conditions for when the alarms in
the table will be logged.
2.
GFK-1180K
Condition
Generate
Occurs.
Acknowledge
Reset
Delete
26-77
Select the Logging Attributes tab in the Table Properties dialog box.
2.
Tip: Click Use Defaults to set the logging attributes to their default value. The
ALARM_LOG will be set to not log the Project Name.
Warning: If you select or de-select the project name table attribute you must drop the
table so that it is properly recreated with or without the new project field as part of the
primary key. Failing to do so can cause the database logger to fail to log data into the
table.
26-78
GFK-1180K
GFK-1180K
1.
Select the Maintenance Events tab in the ALARM_LOG Table Properties dialog
box.
2.
Specify events the same way you specify them for a data log table See page 2641 for the procedure.
26-79
2.
Configure the maintenance actions the same way you configure maintenance
actions for a CIMPLICITY data table. See page 26-43 for the procedure.
26-80
Use the default connection that is specified on the Default Alarm Logging tab of
the Logging Properties dialog box or
GFK-1180K
2.
2.
2.
GFK-1180K
Enter specifications the same way you do for a CIMPLICITY data log table. See
page 26-45 for the procedure.
26-81
Disable all logging actions for the table that you are configuring
Override the queue size that is specified in the Database Logger's Logging
Properties dialog box.
Select and control bulk insertion for Microsoft SQL Server or MSDE.
Select the Advanced tab in the ALARM_LOG Table Properties dialog box.
2.
Do advanced configuration the same way you do for a data log table. See page
26-48 for the procedure.
Important: (For SQL Server) insert triggers fire only if bulk insertion is disabled.
26-82
GFK-1180K
Select the alarm you want to log under different conditions from the default.
2.
Method 2
A. Click Edit on the ALARM_LOG menu bar.
B. Select Alarm Properties
Method 3
A. Click the right mouse button.
B. Select Properties from the popup menu.
The Alarm Properties dialog box opens when you use any method displaying
either the default logging conditions or conditions that were previously checked
for the selected alarm.
GFK-1180K
26-83
3.
Click OK.
Result: The selected alarm will be logged in the ALARM_LOG when its logging
conditions occur.
26-84
GFK-1180K
You can display, print and analyze that information in a report that you create or in an
Excel CIMPLICITY Alarm Report that is included in CIMPLICITY. See page 26-121 for
details about CIMPLICITY Alarm Reports.
GFK-1180K
26-85
Step 2.
Step 3.
Step 4.
2 Double-click
EVENT_LOG to
display the table.
3 Configure:
Table properties.
Logging conditions
for an event alarm.
26-86
GFK-1180K
GFK-1180K
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
26-87
Primary key index on the joined timestamp and sequence number columns and
If you have selected the project name table attribute, the primary key index also
includes the project name column.
The primary key includes an MSEC column, if milliseconds is enabled.
Columns and rows in Event logging tables are as follows:
26-88
COLUMN NAME
Constant fields
timestamp
sequence_number
alarm_id
alarm_class
resource
string
logged_by
reference
alarm_message
generation_time
string
string
string
date/time
Optional fields
project
msec
string
number
date/time
number
string
string
GFK-1180K
Option 1.
Add Point Alarms to the EVENT_LOG via a Point Properties
Dialog Box
Option 1. Add a points alarms to the EVENT_LOG:
1.
Select Points
2.
Select the point for which you want to log alarms in the right pane.
3.
4.
5.
Check to log
the selected
point to the
EVENT_LOG
Opens the Alarm Logging
dialog box.
6.
Click Settings.
The Alarm Logging dialog box opens.
7.
GFK-1180K
26-89
8.
Check, in the Log alarm on box, when the point should be logged.
You can choose one or more of the options that will cause the point value to be
logged. Options include (for the point's alarm):
9.
Generation
Acknowledge
Reset
Delete
Click OK.
Result: The points alarms will be logged to the Event Log based on the specified
alarm status.
Tip: Click Table attributes to open the Event Logs Table Properties dialog box.
Configuration in this dialog box affects the entire Event Log.
Option 2.
Add Event Alarms through the Database Logger
You can add alarms to the EVENT_LOG through the Database Logger Configuration
window and in the EVENT_LOG. .
Option 2. Add alarms to the EVENT_LOG:
1.
Method 2
i.
ii.
Method 3
i.
Right-click EVENT_LOG.
ii.
26-90
GFK-1180K
Method 2
A. Click File on the EVENT_LOG menu bar.
B. Select Add Alarms
Method 3
A. Right-click in the EVENT_LOG window.
B. Select Add Alarms from the popup menu.
The Select an Alarm Definition browser opens when you use any method.
Alarm Browser Example
2 Click OK.
2.
3.
Click OK.
Result: The alarms display in the EVENT_LOG window and will be logged
according to your specifications.
GFK-1180K
Task 1.
Task 2.
Task 3.
Task 4.
Task 5.
Task 6.
26-91
2.
Either:
Open the EVENT_LOG window. See page 26-11 for procedures to open an
existing table.
Method 2
A. Click Edit on either windows menu bar.
B. Select Table Properties
Method 3
A. Right-click EVENT_LOG in the Database Logger Configuration window or
any alarm in the EVENT_LOG window.
B. Select Table Properties from the popup menu.
Result. The EVENT_LOG Table Properties dialog box opens when you use any
method.
26-92
GFK-1180K
Select the Logging Attributes tab in the EVENT_LOG Table Properties dialog
box.
2.
Tip: Click Use Defaults to set the logging attributes to their default value. The
EVENT_LOG will be set to not log the Project Name.
Warning: If you select or de-select the project name table attribute you must drop the
table so that it is properly recreated with or without the new project field as part of the
primary key. Failing to do so can cause the database logger to fail to log data into the
table.
GFK-1180K
26-93
26-94
1.
Select the Maintenance Events tab in the EVENT_LOG Table Properties dialog
box.
2.
Specify events the same way you specify them for an DATA_LOG. See page
26-41 for the procedure.
GFK-1180K
Select the Maintenance Actions tab in the EVENT_LOG Table Properties dialog
box.
2.
Configure the maintenance actions the same way you configure maintenance
actions for a data log table. See page 26-43 for the procedure.
GFK-1180K
Use the default connection that is specified on the Default Point Logging tab of
the Logging Properties dialog box or
Specify logging properties that are specific to the Data or Group Logging table.
26-95
2.
Result: The Connection tab is dimmed and unavailable for configuration. The
event log uses the properties specified on the Default Alarm Connection tab in the
Logging Properties dialog box.
Option 2Specifya connection that is specific for the EVENT_LOG.
26-96
1.
2.
Enter specifications the same way you do for a data log table. See page 26-45
for the procedure.
GFK-1180K
Disable logging actions for the table that you are configuring.
Override the queue size that is specified in the Database Logger's Logging
Properties dialog box.
Select and control bulk insertion for Microsoft SQL Server or MSDE.
Select the Advanced tab in the EVENT_LOG Table Properties dialog box.
2.
Do advanced configuration the same way you do for a data log table. See page
26-48 for the procedure.
Important: (For SQL Server) insert triggers fire only if bulk insertion is disabled.
GFK-1180K
26-97
Select the alarm you want to log under different conditions from the default.
2.
Method 2
A. Click Edit on the EVENT_LOG menu bar.
B. Select Alarm Properties
Method 3
A. Click the right mouse button.
B. Select Properties from the popup menu.
The Alarm Properties dialog box opens when you use any method displaying
either the default logging conditions or conditions that were previously checked
for the selected alarm.
26-98
GFK-1180K
3.
Click OK.
Result: The selected alarm will be logged in the EVENT_LOG when its logging
conditions occur.
GFK-1180K
26-99
Step 2.
Primary key index on the joined timestamp and sequence number columns and
If you have selected the project name table attribute, the primary key index also
includes the project name column.
The primary key includes an MSEC column, if milliseconds is enabled.
Columns and rows in EM logging tables are as follows.
26-100
COLUMN NAME
Constant fields
timestamp
sequence_number
time
event_type
event_source
action_type
string
string
action_target
string
Optional fields
project
msec
string
number
date/time
number
string
string
GFK-1180K
Expand the Basic Control Engine folder in the left pane of the Workbench.
2.
Select the Event ID in the left pane to which you want to attach the action.
4.
5.
Open the New Event-Action dialog box using any of the following methods.
Method 1
Click the New Event_Action button
Editor toolbar.
Method 2
A. Click File on the CIMPLICITY Event Editor menu bar.
B. Select New Event_Action.
Method 3
A. Click the right mouse button in the right pane.
B. Select New Event_Action from the popup menu.
Method 4
Press Ctrl+N on the keyboard.
The New Event-Action dialog box opens when you use any of these methods.
6.
GFK-1180K
26-101
7.
8.
Click OK.
Result: When the selected event triggers the action, the Event Manager sends the
data to the Database Logger.
26-102
GFK-1180K
Task 2.
Task 3.
Task 4.
Task 5.
Task 6.
2.
Method 2
A. Click the right mouse button.
B. Select Properties from the popup menu.
Method 3
A. Click Edit on the Database Logger Configuration window menu bar.
B. Select Table Properties
Result: The EM_LOG Table Properties dialog box opens when you use any
method.
GFK-1180K
26-103
Select the Logging Attributes tab in the Table Properties dialog box.
2.
Tip: Click Use Defaults to set the logging attributes to their default value. The
EM_LOG will be set to not log the Project Name.
Warning: If you select or de-select the project name table attribute you must drop the
table so that it is properly recreated with or without the new project field as part of the
primary key. Failing to do so can cause the database logger to fail to log data into the
table.
26-104
GFK-1180K
Select the Maintenance Events tab in the EM_LOG Table Properties dialog box.
2.
Specify events the same way you specify them for a data log table. See page 2641 for the procedure.
GFK-1180K
26-105
Select the Maintenance Actions tab in the EM_LOG Table Properties dialog
box.
2.
Configure the maintenance actions the same way you configure maintenance
actions for the data log table. See page 26-43 for the procedure.
26-106
Use the default connection that is specified on the Default Point Logging tab of
the Logging Properties dialog box. The default is CIMPLICITY Alarm Logging.
Specify connections that are specific to the Data or Group Logging table.
GFK-1180K
2.
Result: The Connection tab is dimmed and unavailable for configuration. The
EM_LOG uses the properties specified on the Default Alarm Logging tab in the
Logging Properties dialog box.
Option 2Specify logging properties that are specific for the EM_LOG.
GFK-1180K
1.
2.
Enter specifications the same way you do for the data log table. See page 26-45
for the procedure.
26-107
Disable logging actions for the table that you are configuring.
Override the queue size that is specified in the Database Logger's Logging
Properties dialog box.
Select and control bulk insertion for Microsoft SQL Server or MSDE.
Select the Advanced tab in the EM_LOG Table Properties dialog box.
2.
Do advanced configuration the same way you do for a data log table. See page
26-48 for the procedure.
Important: (For SQL Server) insert triggers fire only if bulk insertion is disabled.
26-108
GFK-1180K
Application Logging
Application Logging enables you to log actions of certain CIMPLICITY applications,
such as the Basic Control Engine. To take advantage this feature, you must configure an
Application Table for the product option.
The application chooses what data to log and when to log it.
Tip: You can configure the following properties for an Application logging table.
Logging attributes.
Maintenance actions.
Maintenance events.
Logging properties.
Follow the same steps that you follow for the EM_LOG. See page 26-100 for details.
Primary key index on the joined timestamp and sequence number columns and
If you have selected the project name table attribute, the primary key index also
includes the project name column.
Columns in Application logging tables include::
GFK-1180K
An auto increment sequence number that ensures that each row is unique.
26-109
SQLALARM.XLS
Alarm tables.
SQLDATA.XLS
Data tables.
SQLGROUP.XLS
Group tables.
SQLALARM97.XLS
Alarm tables.
SQLDATA97.XLS
Data tables.
SQLGROUP97.XLS
Group tables.
Use the reports with either Access or SQL Server to report on any tables you
have configured.
Save generated reports in Excel for later use, print them, or perform further
analysis on your data.
26-110
1.
Install MS Query.
2.
3.
4.
GFK-1180K
Install MS Query.
Step 2.
Place MS Query files in the correct location for the Database Logger.
Step 3a.
Step 3b.
Either:
A. Install Excel or
B. Select Add/Remove Programs.
2.
3.
4.
Select MS Query.
It is not necessary to select any of the ODBC drivers at this point, as they will be
installed with your CIMPLICITY software.
5.
Either:
A. Install Excel or
B. Select Add/Remove Programs (options).
2.
3.
4.
5.
6.
7.
GFK-1180K
26-111
2.
3.
Copy xlodbc.xla and xlodbc32.dll from their current directory to the new
path.
Step 3a. Install the Sample Reports using Microsoft Excel 5.0
To select the MS Query Add-In:
1.
2.
3.
Select Open.
The Open browser opens.
4.
5.
6.
26-112
GFK-1180K
7.
8.
Select Add-Ins
The Add-Ins dialog box opens.
9.
11. Replace any existing XLODBC.XLA add-in, if you are prompted to do so.
12. Save your updated report.
13. Repeat these steps for all three report files. You will need to do this only once
for each report.
14. Click OK.
Step 3b. Specify the MS Query file location in Excel for Office
97
Note: Follow this step if you receive an error message that Excel cannot find the
XLODBC.XLA file.
To specify the MS Query file location in the Visual Basic Editor:
1.
2.
Select Macro.
3.
5.
Select Reference.
The References - VBAProject dialog box opens.
6.
GFK-1180K
26-113
7.
8.
Click Browse
9.
26-114
GFK-1180K
Step 2.
Step 3.
Step 4.
2.
3.
Select Open.
The Open browser opens.
4.
5.
GFK-1180K
26-115
2.
3.
(Optional) Enter a Point ID if you want to display data for a single point. If no
Point ID is entered, data for all points in the log displays.
4.
(Optional) Enter a Start Time to display data logged from that time forward. If
no time is specified, the earliest data will be included.
5.
(Optional) Enter an End Time to display data logged up to the specified time. If
no time is specified, the latest data will be included.
6.
Select the ODBC Data Source to be used in generating the report. Your
selection must be the same data source that was used to log the data.
If an appropriate data source is not visible in the drop-down list, click Browse
to find one.
7.
Click either:
A. OK to save the parameters or
B. Cancel to cancel your entries.
Tip: Save your spreadsheet after setting the report parameters if you want the parameters
to be set the next time you run the report.
26-116
GFK-1180K
The data report contains a column for each attribute in the logging table. The columns
may be named as follows:
Column
Displays the:
timestamp
point_id
PROJECT
_ALRM
_ENG
_PREV
VAL
TIME
RAW
RES
Tip: If you save your spreadsheet after generating a report, the data will be available the
next time you view the report.
GFK-1180K
26-117
The same functionality that the Data Report provides for single point values and
Once you have installed the Trend Report you can view data in the following steps.
Step 1.
Step 2.
Step 3.
Step 4.
Step 5.
2.
3.
Select Open.
The Open browser opens.
4.
5.
26-118
GFK-1180K
2.
4.
(Optional) Enter a Start Time to display data logged from that time forward. If
no time is specified, the earliest data will be included.
5.
(Optional) Enter an End Time to display data logged up to the specified time. If
no time is specified, the latest data will be included.
6.
Select the ODBC Data Source to be used in generating the report. Your
selection must be the same data source that was used to log the data.
If an appropriate data source is not visible in the drop-down list, click Browse
to find one.
7.
Click either:
A. OK to save the parameters or
B. Cancel to cancel your entries.
Tip: Save your spreadsheet after setting the report parameters if you want the parameters
to be set the next time you run the report.
GFK-1180K
26-119
The Trend report contains a column for each point attribute in the table.
The prefix of each column is based on the SQL Field Prefix specified for the
point.
Displays the:
timestamp
<prefix>_<attrib><index>
26-120
.Value of an attribute.
GFK-1180K
2.
ALARM_LOG and
EVENT_LOG tables.
Once you have installed the Alarm Report you can view data in the following steps..
Step 1.
Step 2.
Step 3.
Generate a report.
Step 4.
2.
3.
Select Open.
The Open browser opens.
GFK-1180K
4.
5.
26-121
2.
Select either the ALARM_LOG or EVENT_LOG table in the ODBC Table field.
3.
(Optional) Enter an Alarm Class if you want to display alarms only for that
class.
4.
(Optional) Enter a Start Time to display data logged from that time forward. If
no time is specified, the earliest data will be included.
5.
(Optional) Enter an End Time to display data logged up to the specified time. If
no time is specified, the latest data will be included.
6.
Select the ODBC Data Source to be used in generating the report. Your
selection must be the same data source that was used to log the data.
If an appropriate data source is not visible in the drop-down list, click Browse
to find one.
7.
Click either:
A. OK to save the parameters or
B. Cancel to cancel your entries.
Tip: Save your spreadsheet after setting the report parameters if you want the parameters
to be set the next time you run the report.
26-122
GFK-1180K
Result: Progress messages display on the status display of the report while the report is
being generated. The completed report displays on the Data worksheet.
Definition
timestamp
Alarm ID
alarm_class
The alarm class of the alarm or event logged. You may filter a
report to include only one class of alarm. See Set Setting Alarm
Report Parameters, above.
resource
logged_by
reference
prev_state
The previous state of the alarm before the event which caused it to
be logged. This may be N (normal), G (generated), A
(acknowledged), or R (reset).
log_action
The trigger event which caused the alarm to be logged. This may
be G (generation), A (acknowledgment), R (reset), or D (manual
deletion).
final_state
The final state of the alarm after the trigger event. This may be G
(generated), A (acknowledged), R (reset), or D (deleted).
alarm_message
Tip: If you save the CIMPLICITY Alarm Report after you generate it, the same data will
be display the next time you open the report and select the Data worksheet.
GFK-1180K
26-123
Step 2.
Step 3.
2.
4.
26-124
GFK-1180K
C. Enter the correct password and confirm it, if the account requires a
password.
Service Dialog Box: One user example
Note: If no one is logged in to the account you select here, when the script
executes, no printers will be available. The report will be generated, but it
will not be printed.
For systems with multiple users:
A. Click System Account in the Service dialog box, under Log On As.
B. Check the Allow Service to Interact with Desktop check box.
Service Dialog Box: One user example
5.
Click OK to accept your changes and close the Service dialog box.
6.
7.
GFK-1180K
26-125
Expand the Basic Control Engine folder in the left pane of the CIMPLICITY
Workbench.
2.
Double-click Scripts.
The CIMPLICITY Program Editor opens.
3.
4.
Note: The following script opens the SQLALARM.XLS spreadsheet, generates a report,
and prints it. You can use it as a template for creating your own scripts:
26-126
GFK-1180K
Sub Main ()
'--------------------------------------------------------------------------------------' This section sets REPORT_TRIGGER back to 0 so that the script doesn't continue
to run.
' This is not needed if the report is triggered directly from a CimView screen or
by a
' TIMED event in the Database Logger or Event Manager.
'
Dim PT As New point
PT.id = "\\PROJECT\REPORT_TRIGGER"
PT.value = 0
PT.set
'--------------------------------------------------------------------------------------' The code from this point on is for printing.
' This example uses one of the existing Excel spreadsheets for extracting and
printing
' the data from the cimplog.mdb alarm database.
' You will need to customize this code so that it prints what you need. It is
also
' possible in some applications to run a specific macro from the command line.
' You can then use the SHELL command.
'
Dim Excel As Object
Set Excel = CreateObject ("Excel.Application")
'
'
Open the workbook for alarm reporting
Excel.application.workbooks.open "C:\CIMPICITY\REPORT\SQLALARM.XLS"
Excel.application.workbooks("SQLALARM.XLS").activate
'
'
Run the macro to get the data
Excel.application.Run "SQLALARM.XLS!GenerateReport"
'
'
Print the data
Excel.application.workbooks("SQLALARM.XLS").worksheets("Data").activate
Excel.application.workbooks("SQLALARM.XLS").activesheet.printout
'
'
Quit without saving the data
Excel.application.workbooks("SQLALARM.XLS").saved = TRUE
Excel.application.quit
End Sub
GFK-1180K
26-127
2.
Open the Table Properties dialog box for the table whose report will be printed.
3.
4.
5.
6.
7.
Enter the fill path and name of the executable you created from the script.
8.
Click OK.
The Database Logger saves your changes and closes the Table Properties dialog box.
Result: The report automatically generates and prints whenever any of the
maintenance events you specified occur.
2.
2.
3.
Result: The report automatically generates and prints whenever the event occurs.
26-128
GFK-1180K
2.
3.
4.
5.
In the Edit Script window, enter a script that will trigger the report. You can
generate the report directly, or trigger an event that invokes an action that
generates the report.
6.
7.
8.
9.
In the Procedure Information dialog box, create an Invoke Script action and
specify the script you created.
GFK-1180K
26-129
Table characteristics.
ODBC Configuration
When you install CIMPLICITY if you:
Do not install the server, CIMPLICITY 5.0 redistributes ODBC using Microsoft
data access components version 2.
You do not need to purchase or configure additional software to use these drivers.
Tip: Install the database server because, as a SQL server, it provides better scalability
when you want to go to a more robust SQL server to support Enterprise type solutions.
For improved performance and network extensibility, you may wish to log to a thirdparty database product such as Microsoft SQL Server or Oracle.
GFK-1180K
27-1
ODBC drivers.
Description
Microsoft Access
27-2
Data Source
Description
If you:
GFK-1180K
If you:
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.
Note: If you want to trend Logged or Logged Point data that is stored in a remote
database, you must add a custom data source to each Viewer.
If the project uses the default CIMPLICITY data sources, you may need to
modify your configuration depending on whether the default data sources use
SQL Server or Access.
Note: Normally there will not be any additional configuration. However, if you
install CIMPLICITY differently on one machine from a machine to which you
move the project, you may need to adjust the new machine.
Example
You installed the database server on Machine A. However, you did not install
the database server on Machine B. You moved the project to machine B.
CIMPLICITY logging expects to log to Access. In fact it won't because ODBC
is pointing to the SQL database server. You will need to reconfigure Machine B
to point to the correct data source.
GFK-1180K
If the project uses custom data sources, these must be reconfigured on the target
machine.
27-3
2.
3.
5.
Select either:
6.
Click Configure.
A first Microsoft SQL Server DSN Configuration wizard displays.
7.
Configure the first Microsoft SQL Server DSN Configuration wizard as follows:
A. Select the Server as follows:
For
Select
(local)
A remote machine
Select:
(local) for the local machine
Computer name for a remote
machine.
B. Click Next.
A second Microsoft SQL Server DSN Configuration wizard opens.
27-4
GFK-1180K
8.
Enter sa.
Leave blank.
E. Click Next.
9.
GFK-1180K
27-5
Run the ODBC Administrator (from the ODBC program group) or select the
ODBC option from the Windows NT Control Panel.
2.
3.
4.
Select Microsoft Access Driver from the list, and click OK.
5.
6.
7.
Either:
8.
Specify a file name In the Select Database or New Database dialog,, and click
OK.
9.
Note: Due to file locking issues in the Microsoft Access driver, you must never request
Exclusive access to a database that is used by CIMPLICITY for logging. In addition, the
Point Logging and Alarm Logging data sources must refer to different database files.
Configuring Oracle
When you install CIMPLICITY, you will be installing Microsoft data access components
version 2.5. This version of Microsoft data access components comes complete with
Microsoft ODBC for Oracle. There is no charge.
Support for an Oracle database is provided via Microsoft ODBC for Oracle. This driver
comes as part of the Microsoft MDAC, which gets installed when you install
CIMPLICITY.
CIMPLICITY support for Oracle also includes using the MERANT DataDirect Connect
ODBC driver for Oracle. MERANT can be contacted at 1-800-443-1601.
27-6
GFK-1180K
This support has been verified for Windows NT 4.0 and Windows 2000 on Intelcompatible processors.
The Oracle client software must be installed in the same computer as CIMPLICITY HMI
software.
If using the MERANT DataDirect driver, the MERANT ODBC driver must be installed
in the same computer as CIMPLICITY HMI software.
You must have the Allow Service to Interact with Desktop option turned on for the
CIMPLICITY service; otherwise, logging to Oracle will not work.
Guidelines about Oracle configuration and CIMPLICITY HMI include:
1.
2.
Database aliases configured on the client node must also be configured on the server
node.
3.
The Oracle servers IP address must be in the CIMPLICITY computers HOST file if
DNS or Wins resolution is not being used.
4.
In the ODBC data source for Oracle, enter the database alias name in the Server
Name field.
5.
All three of the Oracle services must be started on the Oracle server node.
Step 2.
2.
Double-click Services
Either:
Click Startup....
The (CIMPLICITY HMI) Service dialog box opens.
3.
4.
5.
Click OK.
The (CIMPLICITY HMI) Services dialog box closes.
6.
Click Close.
The Services dialog box closes.
GFK-1180K
27-7
Install the Oracle client utilities (either Administrator or User). Follow the
directions in the Oracle documentation to do this.
2.
3.
4.
6.
7.
8.
Select your newly created ODBC data source as the ODBC data source.
9.
10. Select your newly created ODBC data source as the ODBC data source.
Result: The new ODBC data source is now installed for CIMPLICITY data
collection.
27-8
GFK-1180K
Open the SQL Enterprise Manager in the Microsoft SQL Manager program
group.
2.
From the Server menu, select SQL Server, then Configure. The Server
Configuration/Options dialog opens.
3.
4.
5.
6.
Select OK.
7.
The change takes place the next time the SQL Server is restarted.
GFK-1180K
27-9
2.
3.
2.
When forwarding data (in store and forward), forward is a separate connection
to the database.
27-10
3.
4.
GFK-1180K
If the table is enabled for bulk insertion, bulk insertion requires a dedicated
connection to the database in order to work. As a result, maintenance actions for
bulk insert tables will need to allocate a separate connection. Once the action is
completed, it will free the connection.
5.
6.
If there are too many tables enabled for bulk insertion there, resulting in too many
connections at once, there will be a performance degrade.
If your system configuration regularly exceeds 5 connection, it is recommended that you
upgrade to CIMPLICITY SQL, which is a more robust server.
Open the SQL Enterprise Manager in the Microsoft SQL Manager program
group.
2.
From the Manage menu, select Databases. The Manage Databases dialog
opens.
3.
In the Manage Databases dialog, double click on the database used by the
CIMPLICITY Database Logger. The Edit Database dialog opens.
4.
5.
6.
Click OK.
7.
The change takes place the next time the SQL Server is restarted.
GFK-1180K
27-11
2.
3.
4.
5.
This command will dump the Transaction Log without saving the log.
If you want to save the log to a file, see your SQL Server documentation on how to do
this.
1.
2.
This change takes place the next time you update the project's configuration and then
restart the project.
It is recommended truncating the log as a system default.
To set truncate the log as a system default:
27-12
1.
2.
3.
4.
5.
6.
GFK-1180K
Table Characteristics
The Database Logger tables have the following characteristics:
Column definitions.
Key definitions.
Column Definitions
The following columns are defined for each type of log file:
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.
Note: Points with Engineering Units conversion are stored in floating point format
GFK-1180K
27-13
Key Definitions
The following keys are defined for each type of log file:
Group logging tables have a unique primary key index on the timestamp
column. If you have selected the project name table attribute, the primary key
index also includes the project name column.
Data logging tables have a primary key index on the joined timestamp and Point
ID columns, and a secondary index on the timestamp alone. If you have
selected the project name table attribute, the primary key index also includes the
project name column.
Alarm, Event, and Application logging tables have a primary key index on the
joined timestamp and sequence number columns, and a secondary index on the
timestamp alone. If you have selected the project name table attribute, the
primary key index also includes the project name column.
Important: Since the Microsoft Access format and Oracle do not support sub-second
timestamp data, you cannot log points to a Data or Group table at sub-second rates.
Attempting to do so will cause the duplicate-keyed records to be dropped from the
database.
27-14
GFK-1180K
Database-Disconnect-Recovery
If the Database Logger loses its connection to a database, it generates a
DB_CONN_DOWN alarm. When it successfully reconnects to the database, the alarm is
cleared.
You can control the amount of:
Data to be saved locally then forwarded to the database when the reconnection is
made.
Note: The DB_CONN_DOWN alarm is not stacked by default, but you can change it in
Alarm Configuration.
GFK-1180K
27-15
Note: Stored data and new logged data are sent in parallel to the database, and all
Maintenance actions are ignored while data is being stored.
After a file is forwarded to the database, the Database Logger sends the following
message to the Status Log:
Forward: <file_name> succ: <no_suc> fail <no_fail>
If there are failures, the following message will also be logged:
Forward: See log <filename> for errors.
If the Database Logger cannot process a SQL statement in a storage file, it generates a
log file with the same name as the storage file and the extension .LOG. The log file
contains the statement forwarded to the database and the error message returned by the
database.
If the Database Logger encounters no problems when forwarding data, no .LOG file is
generated.
Note: If you have Store and Forward enabled and storage files exist when you shut
down the Database Logger and you then disable Store and Forward, the Database
Logger will not forward records from the storage files when it restarts.
You can open a storage file and examine its contents in, for example, Notepad.
Important: Store and Forward is supported only for local Microsoft Access databases,
not remote Access databases.
If you choose to store unlimited records, the Database Logger continues to save
data records until it runs out of disk space. The following message is then
logged in the Status Log:
Unable to write to store and forward file, <filename>
and the Database Logger continues to try to save additional records.
The records are stored in one or more files in a storage directory. The number of files
depends on the maximum number of records you select and the maximum number of
records per file.
27-16
GFK-1180K
Where
<prcnam> is process name
Example
For point logging (group and data logs), the process name is MAC_PTDL.
For alarm logging, the process name is MAC_DL
<dbms_id> is the database's DBMS ID,
<date> is the date and
<time> is the time the file was created.
Example
MAC_PTDL_$PTLOG_20000913_174548.SQL
GFK-1180K
27-17
After the Database Logger loses its connection to the database, it stores five
records and logs the "Number of stored records exceeded" message to the Status
Log:
The Database Logger then reconnects to the database and is able to forward
three of the stored records before it loses its connection again.
The Database Logger will now store three records and log the "Number of
stored records exceeded" message to the Status Log:
If the Database Logger is shut down, and there are still records in the storage files, when
the Database logger restarts, these records are not counted against the maximum. Under
these conditions, you can have more than the maximum number of records stored to disk.
Note: You specify the maximum number of stored records on the Connection tabs in the
Database Logger Logging Properties dialog box.
Important: Please consider carefully when changing the maximum number of records
per stored file. Setting too high a number will result in unmanageable files, while setting
too low a number will cause excessive disk I/O.
1.
2.
27-18
GFK-1180K
2 connect_string
3 wait_period
*
*
4 wait_units
5 store_forward
*
*
6 store_path
7 recs_per_file
8 limited
recs
*
$LOGGING|Microsoft Access Driver <*.mdb>|DSN=CIMPLICITY Alarm Logging;UID=admin;DBQ=BSM_ROOT:\arc\CIMPLOG.MDB|1|0|0||100|0.000000
$LOGGING|Microsoft Access Driver <*.mdb>|DSN=CIMPLICITY Point Logging;UID=admin;DBQ=BSM_ROOT:\arc\POINTLOG.MDB|1|0|0||100|0.000000
Note that the Alarm Logging and Point Logging databases have separate
records.
3.
To define a new path for the stored records for a database, enter the pathname in
the store_path field for the database. You can set a different path for each
database.
4.
To define a new maximum number of records per stored file for a database,
enter the new maximum in the recs_per_file field for the database. You
can set a different maximum for each database.
5.
6.
Enter the following commands to regenerate the data file and close the
command window:
scpop dbsm_def
exit
In order for this change to take effect, you must shut down your project, perform a
Configuration Update, and then restart the project.
GFK-1180K
27-19
Client Configuration
Use the Windows Logon Username as the default user for logging in to a
CIMPLICITY HMI project.
Only have access for an associated CIMPLICITY HMI User ID if it has the
correct Authorization Code.
2.
Method 1
Double-click the Client icon in the Workbench.
Method 2
1.
2.
Method 3
1.
2.
Select New.
Method 4
1.
2.
Result: The New Client dialog box opens when you use any of these methods.
GFK-1180K
28-1
Continue
1.
2.
Select OK.
28-2
GFK-1180K
2.
3.
4. Open a Node Id's Client Properties dialog box using any of the following
methods.
Method 1
a.
Method 2
a. Right click a Node ID.
b.
Method 3
a.
b.
Result: The Client Properties dialog box opens when you use any method.
GFK-1180K
Client Configuration
28-3
Client Access
1.
2.
Leave it blank.
Check it
3.
4.
Leave it blank.
Leave it unchecked
28-4
GFK-1180K
Run the CIMPLICITY HMI Genauthcode application on the client to find its
unique Authorization Code.
a.
b.
c.
2.
Type genauthcode.
Result: Only the PC with the entered Authorization Code will automatically be
logged in with the User ID and/or Trusted specifications.
GFK-1180K
Client Configuration
28-5
Using CimView
About CimView
CimView is a runtime, interactive graphical user interface through which you can monitor
and control your facility. CimView displays screens that were created in CimEdit for
specific applications.
As a result, the appearance, purpose and interactive capability of the CimView screen
being viewed is the result of a system administrator, applications engineer and/or screen
designer's planning and configuration. (This chapter references these individuals as
system administrators.)
The system administrator also has control over whether or not an operator can access
several of CimView's available functions. Therefore, the features that are described in this
chapter may not be available on your CimView screens.
Example
CimView has a feature that, when functioning, enables a user to find and open a
selected screen. An applications engineer may design a CimView screen that runs
when a viewer boots up. The CimView screen contains buttons that enable an
operator to open pre-determined screens. However, the system administrator disables
the CimView File>Open capability. As a result an operator cannot open any other
screens.
This chapter describes CimView features that enable you to:
GFK-1180K
Open other CimView screens through an open CimView screen (See page
29-4).
Select whether or not to display the toolbar, menu and/or status bar (See
page 29-7).
Change the size of (zoom) the CimView screen and window that you are
viewing (See page 29-9).
29-1
Perform basic procedures for using objects with setpoint actions. See page 2913.
To find information about configuration for CimView, see the CIMPLICITY CimEdit
Operation Manual, GFK-1396.
CimView Opened
Because CimViewer is a runtime application, you can open it on either a:
Configuration or
Runtime
server or viewer.
Select Screens
2.
Select the screen you want to run in CimView in the right pane.
3.
Method 1
A. Click File on the Workbench Menu bar.
B. Select Open.
Method 2
A. Right-click the selected screen.
B. Select Open on the popup menu.
Result: If the CIMPLICITY project is running, CimView displays the runtime
version of the selected screen.
29-2
GFK-1180K
Popup.
Note: You can also open CimView through the Windows Start menu.
1.
2.
Select Programs>CIMPLICITY>HMI>CimView.
3.
GFK-1180K
Using CimView
29-3
Open other CimView screens through an open CimView screen (See page 29-4).
Select whether or not to display the toolbar, menu and/or status bar (See page
29-7).
Change the size of (zoom) the CimView screen and window that you are viewing
(See page 29-9).
Note: The features and behavior described are the default settings. You system may vary
due to customized configuration.
2.
Result: The selected screen overlays the current CimView screen in the open
window.
Open a CimView screen in a new window
Method 1
1.
Method 2
1.
2.
Result: The selected screen opens in a new window. The current CimView screen
remains open.
29-4
GFK-1180K
Note: The CimView screen may also have objects designed to open other screens.
Whether the screen overlays the current screen or appears in a separate window depends
on the configuration that was done in CimEdit.
2.
2.
Select Print.
Note: Select Print Setup on the File menu to configure the printer.
GFK-1180K
Using CimView
29-5
2.
Select Send.
If an email application is open and accessible, an email window from your email
application appears with a copy of the open CimView screen attached.
If no email application is open or accessible, a Choose Profile dialog box opens.
When you select the correct application, an email window opens with a copy of
the open CimView screen attached.
Send a CimView File Example
3.
Enter the email address and message to the recipient as you would when sending
any other email.
Result: A copy of the file that displays is sent to the recipient. The file may be a
CimView.cim or CimView.cimrt (runtime only) file.
Tip: You can email a captured picture of the current screen contents by using the
Windows Print Screen tools.
1.
Press Alt+Print Screen on the keyboard while the CimView screen is the
active window.
2.
Display the email message in which you want to paste the picture of the screen.
3.
Press Ctrl+V (or use one of the other paste methods for your email application).
Result: A copy of the display at the time you pressed Alt+Print Screen appears on
the email message ready to be sent.
29-6
GFK-1180K
2.
Select Toolbars
An Options dialog box opens.
3.
4.
Check to display
standard toolbar.
Status Bar
1.
2.
Menu/Title Bar
Method 1
1.
2.
Method 2
GFK-1180K
1.
2.
Using CimView
29-7
Result: All of the features that you checked display in CimView. The features you
unchecked do not display.
CimView
With toolbar, menu and status bar.
Without toolbar, menu and status bar.
Tip: You can position the toolbar anywhere you want on the CimView screen.
1.
2.
3.
Note: The Status bar provides information about objects and values. The Title bar
displays the screen file name.
Goes to the
Previous screen, the last screen that was opened before the
current screen.
First screen that was opened.
2.
Goes to the
Previous Screen
Home Screen
29-8
GFK-1180K
Zoom the screen, you can fit the window to the zoom.
Change the window size, you can make the screen fit into the window.
The fit is a "best fit." The screen maintains the width and height proportion it
was assigned during configuration.
Note: These methods are for display in CimView. To change the display of the CimView
screen, enter the screen dimensions on the Geometry tab of the Properties dialog box.
2.
Either:
A. Select Full Screen to use the entire monitor screen for display, or
B. Select the percent you want the display to zoom from one of the percent
choices.
View Menu
Use entire
monitor screen
for display.
Choose percent
screen will zoom
(or to best fit).
GFK-1180K
Using CimView
29-9
2.
Select Zoom.
View Menu
Opens Zoom
dialog box.
Percent screen
zoom
Screen expands
or contracts to fit
workspace
Enter an exact
percent zoom
3.
Either:
A. Select one of the zoom choices.
B. Enter a precise zoom percent in the Percent field.
Result: The CimView window will expand or contract to fit the workspace display
size.
If you change the CimView window size, e.g. make the entire window smaller or larger,
you can increase or decrease the size of the CimView screen (in proportion) to display a
"best fit" in the window.
To make the CimView screen the best fit for the window size:
on the toolbar
Result: The CimView screen will expand or contract in proportion to display the
best fit in the window.
29-10
GFK-1180K
Quick Trends
2.
Result: The Point Control Panel opens displaying the points that are configured
for the CimView screen or the selected object.
See the "Using the Point Control Panel" chapter in this manual for details about the
Point Control Panel.
Point Control Panel Opened through CimView
The points that display depend on what was
selected on the CimView screen.
Screen selected.
Object selected.
GFK-1180K
Using CimView
29-11
Note: If there are no points associated with the selected object, a message informs you.
The Point Control Panel does not open.
2.
Result: A trend chart opens. A trend for the points that are configured for the
current CimView screen begins immediately.
See the "Creating a Quick Trend" chapter in the Trend and XY Chart Operation
Manual, GFK-1260 for details about configuring Quick Trend charts.
Quick Trends Opened through CimView
The point trends that display depend on
what was selected on the CimView screen.
Object selected.
Screen selected.
29-12
GFK-1180K
Note: If there are no points associated with the selected object, a message informs you.
The Quick Trend chart does not open.
Setpoint Actions
Your CimView screen may provide you with the capability to set point values. If it does
following are some guidelines for using the method that is provided on the screen.
Methods include:
The method you use to execute a Slider setpoint depends on whether you selected the
object with the:
Mouse or
Keyboard.
Note: When you use a Slider setpoint, you may be setting different points in the
horizontal and vertical directions.
GFK-1180K
Using CimView
29-13
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.
2.
Result: The original value for the point display in the Status Bar.
Note: If the object is also configured with action when the mouse is clicked down or up,
the actions execute as configured.
Action
Up and Down
Vertical
Horizontal
Press Enter on the keyboard to activate the arrow keys for the Slider setpoint
action,
Note: 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.
2.
(Move the object by one pixel.) Press an arrow key. The direction of the key
defines the direction of the movement.
3.
(Move the object by 10 pixels.) Hold down the Ctrl key, then press an arrow key.
4.
Press Enter to accept the slider action, and perform the setpoint.
Result: The new value for the point displays in the Status Bar.
29-14
GFK-1180K
1 CimView
just
opened.
2 Setpoint
being
changed.
3 Setpoint
changed.
2.
3.
3.
Result: The new value for the point displays in the Setpoint object.
To cancel entering a new setpoint value:
Method 1. Use the mouse
1.
2.
GFK-1180K
Using CimView
29-15
2.
3.
Method 2
1.
2.
Result: If the system administrator has created help for that object, it will display.
Tip: Selecting Help on the CimView toolbar or pressing F1 displays the CimView help
file.
You can also use the Help button to view Help for toolbar buttons, menu items and other
CimView features.
29-16
GFK-1180K
GFK-1180K
View the current values of points that are added from any project in your
enterprise.
Change the alarm limits and enable/disable alarms for points you are displaying.
30-1
2.
3.
30-2
GFK-1180K
If no project is running:
A Select CIMPLICITY Project dialog box opens.
GFK-1180K
30-3
2.
Select New.
Method 2
Double-click the New button
Method 3
Press Ctrl+N on the keyboard.
Result: A new empty Point Control Panel appears when you use any method.
30-4
GFK-1180K
2.
Result: The file displays in the Point Control Panel with the configuration you
saved.
Example: Saved Point Control Panel File
GFK-1180K
30-5
Method 3
Press Ctrl+O on the keyboard.
The Open dialog box opens when you use any method.
2.
Result: The file displays in the Point Control Panel with the configuration you
saved.
30-6
GFK-1180K
2.
Select Save.
Method 2
Double-click the Save button
Method 3
Press Ctrl+S on the keyboard.
If the file has been saved previously the saved version is updated.
If the file is being saved for the first time, the Save As dialog box opens.
2.
Enter a name for the file in the folder where you keep Point Control Panel files
for the project.
3.
Click Save.
Result: A new Point Control Panel file is saved for future use.
Note: By default, Point Control Panel documents are placed in the main CIMPLICITY
HMI directory, but you can select another directory.
GFK-1180K
30-7
2.
Select Save As
The Save As dialog box opens.
3.
Enter a name for the file in the folder where you keep Point Control Panel files
for the project.
4.
Click Save.
Result: A copy of the existing Point Control Panel file is saved for future use.
2.
Select Install.
A Create Shortcut dialog box opens.
3.
Select the folder in which the shortcut should appear, e.g., Desktop.
4.
Click OK
If you open the shortcut when the project is not running a Select CIMPLICITY
Project dialog box opens to let you easily start the project.
30-8
GFK-1180K
Review the print preview using the Point Control Panel tools:
To
Action
Zoom in
Zoom out
GFK-1180K
Click Print.
30-9
2.
Method 2
Press Alt+F+R on the keyboard.
The Print Setup dialog box opens when you use either method.
Note: You can also change the printer specifications before you print the document.
2.
Select Print.
Method 2
Click Print in the Point Control Panel Print Preview window.
30-10
GFK-1180K
Method 3
Press Crtl+P on the keyboard.
Result: The Print dialog box opens when you use any method. You can continue
with printing in the same manner as you do with any Windows document.
If you made unsaved changes, a Point Control Panel message box appears
asking you if you want to save them.
2.
Click either:
A. Yes to save the changes, or
B. No to discard the changes, or
C. Cancel to return to the Point Control Panel.
Result: The Point Control Panel will close or re-appear based on your selection.
GFK-1180K
30-11
Add any points from running projects, to which you have access, to the Point
Control Panel.
Delete points. (Points are removed from the open Point Control Panel file. They
are not deleted from the project.)
Note: An Invalid Point icon will appear to the left of the Point ID if the point is not
valid. This can happen, for example, if you add a point to a Point Control Panel file, save
the file, close it, then delete the point from the project when you are working in the
Workbench. The next time you open the Point Control Panel file an Invalid Point icon
will appear next to that Point ID.
Method 3
Press Ctrl+A on the keyboard.
30-12
GFK-1180K
Method 4
A. Right-click a point that displays in the Point Control Panel.
B. Select Add Points from the popup menu.
The Select a Point Browser displays when you use any method. If more than one
project is running, the Point IDs that initially display in the browser are from the
project that was selected for connection when the Point Control Panel was open.
2.
Select the Point IDs you want to display in any running project.
3.
Click OK.
Result: The points appear in the Point Control Panel displaying their runtime
values, units and timestamp. If a point is in an alarm condition, its text displays in
the color associated with the alarm level.
GFK-1180K
30-13
2.
Click Points
3.
Select the points you want in the right pane of the Workbench.
4.
Either:
Method 1
Drag the selected points into the Point Control Panel.
Method 2
A. Click Edit on the Workbench menu bar.
B. Select Copy.
C. Click Edit on the Point Control Panel menu bar.
D. Select Paste.
Method 3
A. Select the Workbench.
B. Press Ctrl+C while the Workbench is active.
C. Select the Point Control Panel.
30-14
GFK-1180K
D. Press Ctrl+V.
Result: The points display their runtime values, units and timestamp in the Point
Control Panel. If a point is in an alarm condition, its text displays in the color
associated with the alarm level.
Example: Points in the Point Control Panel Dragged from the Workbench
Tip: You can drag the points from the Point Control Panel to a CimEdit Screen. They
become text objects in CimEdit.
Select the Point ID or Point IDs in a Point Control Panel file that you want to
paste into another.
2.
GFK-1180K
30-15
Method 2
Press Ctrl+C on the keyboard.
3.
Open the Point Control Panel file into which the Point IDs will be copied.
4.
30-16
GFK-1180K
Normal
Warning
Alarm
Select Colors.
3.
4.
Select the Foreground (Text) and/or Background color from the drop down field
menus for any of the four states.
5.
Either:
A. Click OK to save your changes, or
B. Click Cancel to discard the changes.
2 Click OK.
3 The Point Control
Panel displays
the selections.
GFK-1180K
30-17
Method 3
Press Delete on the keyboard.
Method 4
A. Right-click a point that displays in the Point Control Panel.
B. Select Delete from the popup menu.
A Point Control Panel dialog box appears asking you to confirm deletion.
2.
Either
A. Click Yes to delete the points, or
B. Click No to cancel deletion.
Note: If you do not save the Point Control Panel file after you delete the points, they will
reappear the next time you open the file.
30-18
GFK-1180K
Add manual mode points by having the Point Control Panel find and display
points that are already in manual mode.
Enable manual mode for existing points in the Point Control Panel.
Disable manual mode for any existing point that is in manual mode.
By Enabling Manual Mode, a user can separate the point from that equipment and set the
point to a known good value that preserves the system's integrity. When the required
corrections are made, the user can then bring the point back online by disabling manual
mode.
Note: A user needs to have a role in which Modify Attributes is checked in the Roles
dialog box in order to work with manual mode points.
Example
A temperature sensor that reports temperatures, which are acted upon by CIMPLICITY
HMI applications to initiate temperature control actions, fails. To continue the high
temperature setting, a user with Modify Manual Mode privilege places the point that
reflects the errant sensor in manual override mode. The user then sets a value that causes
the application to cease the unnecessary temperature control procedures. This allows
users who are knowledgeable of their CIMPLICITY HMI application implementation to
make emergency, temporary adjustments to their systems operation. Consequently, the
application does not have to anticipate and provide for handling of all possible failures in
its implementation.
When temperature sensor is fixed, the user disables manual mode. Point data collection
resumes.
Do either:
Method 1
A. Click Edit on the Point Control Panel menu bar.
B. Select Add Manual Mode Points
Method 2
Press Alt+E+M on the keyboard.
GFK-1180K
30-19
2.
Select the project in which the Point Control Panel should find manual mode
points.
If you have access to that project, the Point Control Panel looks for manual
mode points and provides a message stating how many it found.
2.
Click OK.
Result: the Point Control Panel displays all of the manual mode points that are in
the selected project.
A Manual Mode icon
See "Enabling and Disabling Manual Mode: in this chapter for more information
about Manual Mode points in the Point Control Panel.
2.
Choose either:
Method 1
A. Click Edit on the Point Control Panel menu bar.
B. Select Enable Manual Mode.
Method 2
Click the Enable Manual Mode button
toolbar.
30-20
GFK-1180K
An icon appears to the left of the Point ID, indicating that the point is in
manual mode.
3.
4.
Enter a new value for the point in the Set Value field.
Result: The point will continue to function in the CIMPLICITY HMI using the set
value.
2.
3.
Method 2
Click the Disable Manual Mode button
Result: Data collection from the PLC resumes for the point. The icon to the left of
the Point ID disappears.
GFK-1180K
30-21
A Detail tab provides you with a quick read-only summary of the point's
properties and setpoint access, if the point allows setpoints.
An Alarm tab enables you to change the alarm limits for a selected point. This
tab is available only if alarm limits (except On Update limits) are configured for
the point.
See "Procedures for Alarms in the Point Control Panel" in this chapter.
The point's detailed Point Properties dialog box in which you can make changes the same
way you can when you open it directly through the Workbench.
Using the Detail Tab in the (PCP) Point Properties Dialog Box
The Point Control Panel's (PCP) Point Properties dialog box provides you with summary
information about a selected Point ID and enables you to change runtime point alarm
values.
During runtime, you can quickly:
You do this on the Detail tab of the (PCP) Point Properties dialog box.
Note: A user needs to have a role in which Setpoint is checked in the Roles dialog box
in order to set points.
To use the Detail tab of the (PCP) Point Properties dialog box:
1.
2.
30-22
GFK-1180K
Method 3
Press Alt+Enter on the keyboard.
Method 4
Double-click anywhere the Point ID's line.
The Detail tab of the point's (PCP) Point Properties dialog box displays when
you use any method.
Read-only details about the point provide you with a quick overview of the
point's properties. The property specifications were entered in the point's full
Point Properties dialog box.
3.
Change the value of the point in the Set value field, if you need to.
Either the point's value will be changed or a message will display informing you
that it can't be changed and why.
2.
Method 2
1.
GFK-1180K
30-23
2.
Method 3
Click the Edit Point button
30-24
GFK-1180K
Add points with disabled or modified alarms by having the Point Control Panel
find and display those points.
Disable an alarm.
2.
3.
4.
5.
Select the project in which the Point Control Panel should find the disabled or
modified alarms.
If you have access to that project, the Point Control Panel looks for points with
disabled or modified alarms and provides a message stating how many it found.
6.
Click OK.
Result: the Point Control Panel displays all of points with modified and/or disabled
alarms that are in the selected project.
appears to the left of each Point ID that has a
An Alarm Limit Changed icon
modified alarm. A Disabled Alarm icon appears to the left of each Point ID that
has a disabled alarm.
GFK-1180K
30-25
Note: Points with On Update alarms do not have an Alarm tab in the (PCP) Point
Properties dialog box.
To use the Alarm tab in the (PCP) Point Properties dialog box:
1.
2.
Tab Displays
Analog
Boolean
30-26
GFK-1180K
3.
Use to:
Alarm Enabled
Alarm on Value of 1
Alarm on Value of 0
4.
Click Restore Alarm Limits if you want to restore the limits to their original
values.
5.
Either:
Click Apply to apply the changes and keep the (PCP) Point Properties
dialog box open, or
Click OK to save the changes and return to the Point Control Panel
window, or
Click Cancel to discard the changes and return to the Point Control Panel
window.
Note: If the point has no alarming or has On update alarming, the Alarm tab does not
appear in the dialog box.
GFK-1180K
30-27
2.
3.
Method 2
1.
Display the alarm tab on the point's (PCP) Point Properties dialog box.
2.
Method 3
1.
2.
Method 4
Click the Disable Alarm button
Result: The point's alarms are disabled and a Disabled Alarm icon
to the Point ID.
30-28
appears next
GFK-1180K
2.
3.
Method 2
1.
Display the alarm tab on the point's (PCP) Point Properties dialog box.
2.
Method 3
1.
2.
Method 4
Click the Enable Alarm button
Result: The point's alarms are enabled. The Disabled Alarm icon
Point ID disappears.
GFK-1180K
next to the
30-29
2.
3.
Double click the value you want to change in the Set Value column.
4.
5.
Either:
Click Apply to apply the changes and keep the (PCP) Point Properties
dialog box open, or
Click OK to save the changes and return to the Point Control Panel
window, or
Click Cancel to discard the changes and return to the Point Control Panel
window.
Note: You can open the array's detailed Point Properties dialog box to make other
modifications. See the section "Opening a Point's Detailed Point Properties Dialog Box"
in this chapter.
30-30
GFK-1180K
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-1180K
31-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.
31-2
Add a new measurement system (if the one you want does not exist).
Define an equivalent unit for each base measurement unit, by specifying the
label, display format and conversion equations to be used for each.
GFK-1180K
Expand the Advanced folder in the CIMPLICITY HMI Workbench left pane.
2.
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-1180K
31-3
2.
3.
Click OK.
Result: The Measurement System Properties dialog box opens.
To make the measurement system the active system when the project
starts:
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.
31-4
GFK-1180K
Move the cursor to the tab of the measurement system you want to copy.
2.
3.
4.
Enter the name of the new measurement system in the Destination field.
5.
Click OK.
Result: A new measurement system tab will be created with the name you
specified.
If there are existing Unit IDs in the left pane, you will see default values in the
Equivalent Unit ID, Forward Equation, Reverse Equation, Justification and Type
fields for the new measurement system.
Move the cursor to the tab of the measurement system you want to rename.
2.
3.
4.
Enter the new name of the measurement system in the Destination field.
5.
Click OK
Result: The measurement system tab will change to the name you specify.
GFK-1180K
31-5
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.
2.
Enter an optional display label in the Display label field. This display label is
automatically selected when a user selects the Unit ID for a point in Point
Configuration.
3.
Click Enter.
Result: 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.
31-6
GFK-1180K
2.
Click twice.
In the left pane, select the base unit, click the right mouse button and select
Properties from the pop-up menu.
2.
GFK-1180K
31-7
Note: When you use %P as the conversion equation in a measurement unit equivalence,
the display format fields such as Width, Precision, Type and Justification will be used
instead because a %P requires no conversion.
You can edit any of the following fields in the right pane or in the dialog box:
Equivalent Unit ID
Enter the Unit ID you want to use when the measurement system is active. The Unit ID
may or may not match any other Unit IDs in the configuration.
Forward Equation
Enter the equation to be used by Point Management to convert the base value to its
equivalent in this measurement system.
For example, if point XYZ's base value is in inches and you want to display it in
centimeters, use the forward expression %P*2.54001.
If the point's base value is the same as its converted value, just put %P in the field.
Reverse Equation
Enter the equation to be used by Point Management to convert the equivalent in this
measurement system to its base value.
For example, if point XYZ's base value is in inches and its equivalent value is in
centimeters, use the reverse expression %P/2.54001.
If the point's base value is the same as its converted value, just put %P in the field.
31-8
GFK-1180K
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 point's 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.
Type
This field determines the format type used when the point value is displayed.
By default, the project uses the display type you specify when you configure a point.
If you want to use a different display for all points that use this Unit ID, enter it in this
field. Use the drop-down list button to select one of the following:
Fixed
All points that use the Unit ID are displayed in fixed format using
the Width and Precision information you specify. If you do not
specify the Precision, the default is 6.
For example, if you specify a Width of 7 and Precision of 3, the point
display uses 7 places and there are 3 places after the decimal point. In this
case, 10 displays as 10.000.
Scientific
All points that use the Unit ID are displayed in scientific format
using the Width and Precision information you specify. If you do
not specify the precision, the default is 6.
Compact
All points that use the Unit ID are displayed in Fixed or Scientific
format based on Precision, which determines the exponent to start
displaying in Scientific format.
For example, if you specify a Precision of 5, the value 100,000 displays as
1e+005 and 10,000 displays as 10000.
The Compact type also truncates trailing zeros to the right of the decimal
point. For example, 10.0 displays as 10 and 10.10 displays as 10.1.
GFK-1180K
31-9
2.
3.
4.
Enter the name of the new measurement unit in the Destination field.
5.
Click OK.
Result: The Measurement Unit Properties dialog box opens.
6.
7.
Click OK.
A new measurement unit will be created with the name you specified.
Equivalent measurement units are also created for each measurement system in the right
pane.
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
Result: The measurement unit name in the left pane will change to the name you
specify.
31-10
GFK-1180K
2.
Select Options.
Result: The Options dialog box opens.
3.
4.
Click OK.
Click the measurement unit in the left pane that you want to delete.
2.
3.
4.
Click Yes.
GFK-1180K
31-11
2.
3.
Select System>Properties.
Result: The Measurement System Properties dialog box opens.
4.
5.
Click OK.
Result: When the project starts, this will be the active measurement system.
31-12
GFK-1180K
2.
Select Properties.
The Project Properties dialog box opens.
3.
4.
5.
Click Settings.
The Activate Measurement System dialog box opens.
The active measurement system you specified in the Measurement Unit
Configuration window displays. If you have not specified an active
measurement system <None> displays.
4.
(Optional) Click the drop-down list button to the right of the Active
Measurement System field and select a new active measurement system.
When you select the measurement system, its Use at runtime check box in the
Measurement Systems Properties dialog box is selected, and the check boxes for
all other measurement systems are cleared.
If you select <None>, only the base conversions are used
5.
GFK-1180K
Click OK.
31-13
Derived Points.
CimView Scripts.
31-14
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.
GFK-1180K
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 floating-point
types.
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.
GFK-1180K
31-15
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.
The result is then converted to the current active measurement system units for
the derived point.
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.
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.
31-16
GFK-1180K
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 expression's
minimum/maximum values and their related high/low values.
When CimView processes an object's 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 object's 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:
Contain values, CimView uses those values. Because they are correctly
associated with the point's measurement unit, the values will be converted to the
active measurement unit at runtime.
GFK-1180K
"Configuring Point View, Limits and Alarms" in the CIMPLICITY HMI Base
System User's Manual GFK-1180
31-17
Minimum and Maximum fields in CimEdit are blank so the point display limits
are used.
Display low and Display high fields are filled, in the View tab of the Point
Properties dialog box.
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.
31-18
GFK-1180K
GFK-1180K
31-19
System Utilities
GFK-1180K
Show Users.
Login Panel.
Process Control.
Use
To
Show Users
Login Panel
Process Control
32-1
Step 2.
Step 3.
Step 4.
Step 5.
2.
Result:
If no project is running:
The CIMPLICITY Project dialog box opens.
A. Select a project.
32-2
GFK-1180K
B. Click either:
Start or
Start as Viewer.
When a project is running:
The Show Users window opens.
GFK-1180K
Access Help.
System Utilities
32-3
2.
Select Options.
The Options dialog box opens.
3.
If you check the On user login check box, a sound plays whenever a user
logs in to any CIMPLICITY project that you are viewing.
If you uncheck the check box, no sound plays when users log in to
CIMPLICITY projects that you are viewing.
If you check the On user logout check box, a sound plays whenever a user
logs out of any CIMPLICITY project that you are viewing.
If you uncheck the check box, no sound plays when users log out of
CIMPLICITY projects that you are viewing.
4.
Either:
Click Cancel to close the dialog box without implementing any changes.
User ID,
Role,
Node and
Process ID.
The information in the sub-window updates as users log in and out of the project.
The method for opening a Show Users project varies depending on whether or not a
project was recently opened.
Option 1. Open a project that was recently opened.
Option 2. Open a project that was not recently opened.
32-4
GFK-1180K
Option 1. Open a project in the Show Users window that was recently
opened:
1.
2.
Click the project you want from the recently opened list.
A login dialog box displays.
3.
Option 2. Open a Project in the Show Users window that was not recently
opened:
1.
GFK-1180K
System Utilities
32-5
Option 3
Click the Open button on the Show Users window toolbar.
The Open dialog box opens displaying a list of currently running projects that
are broadcasting.
2.
3.
Result: A project sub-window displays in the Show Users window. The title bar for
the sub-window displays the project name and node name of the computer on
which the project is running.
Note: If a project is already open the newly opened project displays in a second subwindow.
32-6
GFK-1180K
The Search dialog box opens displaying the last search criteria that were entered.
2.
Fill in any single or combination of fields to search the list of users in a project.
User ID,
Role,
Node, and/or
Process.
Note: You can use the drop-down list buttons to the right of each field to
display and select previous search filters.
3.
Click Find.
The first user that matches the criteria in the active sub-window's list is
highlighted.
GFK-1180K
System Utilities
32-7
4.
Use the Search dialog box navigation buttons or quick keys to search for items
that match the critera as follows.
Button (key)
Next (Ctrl+N)
Previous (Ctrl+P)
2.
Menu.
Toolbar.
Shortcut keys.
32-8
Project.
View.
Help.
Search.
Window.
GFK-1180K
Recent Project
Displays the list of recently opened projects and lets you select
one.
Exit
Status Bar
Options...
GFK-1180K
Contents
Opens the Contents tab in the Show Users help dialog box.
Opens the Index tab in the Show Users help dialog box.
Opens the Index tab in the Show Users help dialog box.
About ShowUser...
System Utilities
32-9
Next
Displays the next line of user information that meets the search
criteria.
Previous
32-10
Cascade
Tile Horizontally
Tile Vertically
Arrange Icons
Close All
Open Projects
GFK-1180K
Opens a project.
Close
Search
Search Next
Search Previous
Tile Windows
Tile Windows
Cascade Windows
Cascades windows.
Opens a project.
Ctrl+S
Ctrl+N
Finds the next entry that matches the criteria in the Search
dialog box.
Ctrl+P
Finds the previous entry that matches the criteria in the Search
dialog box.
Alt+Print Screen
F1
Shift+F1
Alt+F4
Ctrl+Esc
GFK-1180K
System Utilities
32-11
These actions do not require that you exit from any applications that are currently
running. For example, if you are a supervisor, you can 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 screens will no longer show point status.
Review:
Tip: CimLogin and CimLogout Basic Control Engine API's are available for use in
CimView, e.g. to have a logout button on the screen.
32-12
GFK-1180K
Step 2.
Step 3.
Step 4.
2.
For each project that users on this computer are logged into the Login Panel displays
the:
GFK-1180K
Project ID,
User name,
Type.
System Utilities
32-13
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.
3.
4.
5.
32-14
GFK-1180K
6.
Click either:
Result: Either the password is changed to the new password you have entered or
the change is cancelled.
2.
Click Add.
The Add Saved Login dialog box opens.
3.
Select the project you want to apply the login to in the Project field.
Tip: Use the drop-down list button to display the list of available projects in
your enterprise.
4.
GFK-1180K
System Utilities
32-15
5.
Enter the password in the Password field and confirm it in the Confirm field.
6.
Either:
Click Cancel to exit this dialog box without saving the information you
entered.
Result: The new entry appears in the Saved Logins list. After you activate the new
saved login, whenever you open a screen in this project, you are automatically
logged in to the project.
32-16
GFK-1180K
2.
Click Remove.
Result: The login information no longer dispalys in the list and is deleted from the
Registry.
If you are currently displaying any screens that require this login, they are not
affected. If you exit a screen that requires the login, then try to reopen it, the
CIMPLICITY Login dialog box opens and you are asked for a username and
password.
GFK-1180K
System Utilities
32-17
Select a project from the list of projects that has a Logged in status.
2.
All runtime applications that you are logged into will be no longer update data.
For example, all CimView screens that have animation objects that use points
from this project will disable the objects.
If you are not logged into any runtime applications, the Login Panel removes the User
line.
32-18
GFK-1180K
Select the project from the list of projects that has a Logged out status..
2.
on the Toolbar.
Enter your Username and Password for viewing screens for the project.
Result: CIMPLICITY HMI software logs you back into the project. The status
changes to Logged in.
All runtime applications to which you have been logged in that are still open will
resume updating data. All CimView screens connected to this project will now have
their animation objects enabled.
Note: The screen itself may change if visibility animation has been enabled for objects
and keyed to User ID and Role ID information.
GFK-1180K
System Utilities
32-19
Menu.
Toolbar.
Shortcut keys.
File
Edit
Project
View
Help
Logout
Change Password Allows you to change your password for the selected project.
32-20
GFK-1180K
Status Bar
About LoginPanel
Displays the current version number for the Login Panel utility.
Shift+F1
Alt+F4
Ctrl+Esc
GFK-1180K
System Utilities
32-21
Step 2.
Step 3.
Step 4.
Step 5.
Start processes.
Step 6.
Stop processes.
Step 7.
Step 8.
Step 9.
2.
Result:
If no project is running:
The CIMPLICITY Project dialog box opens.
A. Select a project.
B. Click either:
Start or
Start as Viewer.
When you start the project, the normal startup dialogs are displayed.
32-22
GFK-1180K
GFK-1180K
System Utilities
32-23
Click the drop-down list button to the right of the Project field.
A list of currently running projects that are broadcasting is displayed.
2.
3.
Click Connect.
Note: If you are not currently logged in to the project, a CIMPLICITY
Login dialog box opens.
Enter your User ID and Password.
Result: When CIMPLICITY processes a saved login or the login just entered,
the CIMPLICITY Process Control dialog box displays with the list of process
names and statuses for the project you selected.
32-24
GFK-1180K
Exit CPC.
Important: This is not the recommended way to start or stop CIMPLICITY HMI
software. You should only use CIMPLICITY Program Control to start and stop
processes if you have been instructed to do so by GE Fanuc support personnel, or if you
are testing an API application. In the latter case, you should only be starting and stopping
your API application.
GFK-1180K
System Utilities
32-25
Halted or
Running.
The following table lists background Process IDs for all base system and product options
for CIMPLICITY HMI processes. The set of options running on a node depends on the
communication protocols, printers, and product options you have installed.
32-26
AMRP
APSM_RP
CAL_RP
Action Calendar
CNCALM
DA_RC
DA_RP
DL_RP
DYNCFG
EM_RP
MTCPSI_RP
MRTUSI_RP
MASTER_<port>
MASTER_<printer_name>
MASTER_PTDP_RP
MASTER_PTM<n>_RP
PDC_DS
PROF_RP
Profile Trending
PRT_CNT
PRT_CLNT
PRT_DS
PRT_GRD
PRT_STND
TrackerStandby Process
PTDL_RP
PTX_RP
<rcositename>
RCODB_RP
UR_RP
GFK-1180K
2.
3.
Result: If the process starts successfully, its status in the process list changes from
Halted to Running.
GFK-1180K
System Utilities
32-27
2.
Result: If the processes start successfully, their status in the process list changes
from Halted to Running.
2.
3.
Result: If the process stops successfully, its status in the process list changes from
Running to Halted.
32-28
GFK-1180K
2.
Result: If the processes halt successfully, their status in the process list changes
from Running to Halted.
2.
3.
Click Connect.
Result: The process list for the newly connected project displays in the
CIMPLICITY Process Control dialog box.
GFK-1180K
System Utilities
32-29
1 Click Release to
release current
project.
2 Click Connect to
connect to another
project.
32-30
GFK-1180K
System Management
GFK-1180K
33-1
Logical Names
Logical names are used to override default values in the log_names.cfg file for the
CIMPLICITY HMI Base System and options.
Note: Do not confuse logical names with environment variables. Logical names are
found in the log_names.cfg file, while environment variables are accessed through
the Control Panel.
Import/Export points.
The default or expected is 1000.
Example
An example entry in log_names.cfg is:
CLIE_MAX_PTS|S|default|5|5000
Specifies a:
BSM_PTM_APPQ
33-2
July 2001
GFK-1180K
Then:
If:
Then:
If:
Then:
If:
Point Management finds that growth has occurred in the number of periods
specified by BSM_PTM_AQ_CNT4DROP,
Then:
Point Management will start dropping records. Note that these periods are
not required to be time consecutive, that is, growth might be noted for three
time consecutive periods, no growth for 2 periods, and then growth for
another three periods. It is when the maximum number of periods is
exceeded that dropping will occur.
If:
Then:
It is expected that client applications will consume queued messages, and the
internal lists will drop below the threshold.
When messages drop below that threshold, a reset for the periods of growth
count occurs. Counting, therefore, starts over the next time the threshold is
exceeded.
GFK-1180K
System Management
33-3
Allen-Bradley Communications
SNP Communications
<port>_ALL_UNSO
PLC2_PROT_WRITE_ALL
PLC2_PROT_WRITE_<port>
ABI_MAXDEF
33-4
MD_QUERY_ALL
MD_QUERY_<device>
MD_SKIP_GENREF_ALL
MD_SKIP_GENREF_<device>
July 2001
GFK-1180K
<prcnam>_UNSO_DEC
<prcnam>_UNSO_EITHER
<prcnam>_UNSO_HEX
DC_CONNECT_MS
DC_CONNECT_URETRY_CNT
DC_TCP_POLLS_MS
DCQ_DEAD_TIME
MMAX_SYNC_TICKS
MSYNC_TICKS
SNP Communications
Logical names that can be modified in the log_names.cfg file 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.
GFK-1180K
System Management
33-5
2.
3.
Type cd data.
4.
5.
Find the parameter you want to change, and make the change.
6.
7.
Note: When you are ready to implement the change in the runtime system, you will have
to stop and restart CIMPLICITY software.
33-6
July 2001
GFK-1180K
GFK-1180K
1.
Run Regedit.exe.
2.
Open HKEY_CURRENT_USERS
3.
Open Software
4.
1.
Open HKEY_CLASSES_ROOT
2.
.AMV
.cim
.CLG
.GEF
CFGCab Document
CimEdit
CimEdit.Documents
CimView
CimView.Documents
System Management
33-7
Run Regedit.exe.
2.
CFGCab Document
CimEdit
CimEdit.Documents
CimView
CimView.Documents
3. Run RegEdt32.
4.
33-8
July 2001
GFK-1180K
The first section is about the Microsoft Systems Management Server (SMS). It
briefly explains what SMS is and how it can be used for software distribution.
For more information about SMS, please see the Microsoft Systems
Management Server documentation in the Microsoft Developer's Network Books
Online.
GFK-1180K
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
33-9
Manages network applications (applications run over the network from servers).
All these tasks can be performed centrally with the SMS Administrator at a Microsoft
Windows NT-based client. The SMS system:
SMS lets you centrally manage your entire enterprise. Using SMS you can:
Distribute and install software on clients and servers across your corporate
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
Distribute software to the servers from which you want users to access 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.
33-10
July 2001
GFK-1180K
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.
2.
3.
Send the instructions for running the package command to the target clients.
All of these tasks can be done with a single Run Command On Workstation job (as
described in this document). Alternatively, you can do each of these tasks individually
using separate Run Command On Workstation jobs.
When a job sends a package, SMS compresses all files and subdirectories in the package's
source directory into a single compressed package file and transfers the compressed file to
the sites containing target clients. The compressed package file is stored on the site
server.
Once a package has been sent to a target site, the package is distributed to servers at the
target site. The SMS Despooler at the target site decompresses the compressed package
file into the package source directory's original files and directory structure, and places
these files on the distribution servers in a subdirectory of the
SMS\LOGON.SRV\PCMPKG.SRC directory. The package source directory is shared so
that the client can have access to the directory.
GFK-1180K
System Management
33-11
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 package's 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.
33-12
July 2001
GFK-1180K
Step 2.
Step 3.
2.
3.
GFK-1180K
4.
5.
Enter the name of the Application Source Directory in the Target Path: field.
The default directory is c:\cimpsms.
6.
System Management
33-13
7.
8.
Check the Upgrade box if you want to allow an upgrade during installation.
9.
10. Share the Application Source Directory with the same name (for example, the
share name for c:\cimpsms is CIMPSMS).
33-14
July 2001
GFK-1180K
2.
3.
4.
Select New.
The Package Properties dialog box opens.
5.
Click Import.
The File Browser dialog box opens.
6.
7.
Click OK.
The File Browser dialog box closes and the Package Properties dialog box
redisplays.
GFK-1180K
System Management
33-15
8.
Select Workstations.
The Setup Package for Workstations dialog box opens.
9.
Enter the location of the Application Source Directory in the Source Directory
field,
You can use the Browser button to the right of the box to find it.
2.
3.
Select New.
The Job Properties dialog box opens.
4.
33-16
July 2001
GFK-1180K
5.
Click Details.
The Job Details dialog box opens.
5.
6.
7.
8.
9.
Click OK.
This will create a job for CIMPLICITY HMI Site wide installation
Once the job is executed, this package can be deleted.
GFK-1180K
System Management
33-17
Login Password
Role Privileges
Setpoint Security
Setpoint Password
Select whether the user needs to enter a password in the CIMPLICITY Login
dialog box.
Passwords are stored in an encoded format and are not directly readable by
users.
See "Role Configuration" in the CIMPLICITY Base System User's Manual (GFK-1180)
for more information about configuring role privileges.
33-18
July 2001
GFK-1180K
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.
See "Setpoint Security" in the "Understanding Points" chapter in the CIMPLICITY HMI
Base System User's Manual (GFK-1180).
Setpoint downloads
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
GFK-1180K
System Management
33-19
By default, the Audit Trail alarms are logged in the Event Log table of the Database
Logger. You can choose whether you want to log each alarm. You can also choose to log
each alarm in the Event Log table or Alarm Log table. Finally, you can generate a report
of Audit Trail alarms from the Database Logger table.
See the "Database Logger Configuration" chapter in the CIMPLICITY HMI Base System
User's Manual (GFK-1180) for more information.
Setpoint Downloads
A user can download setpoints from:
CimView screens
Recipes
33-20
July 2001
GFK-1180K
Project Login/Logout
The $LOGIN_FAILURE alarm is generated when a user fails to log in to a
CIMPLICITY HMI project correctly and the number of consecutive login errors has been
reached. The alarm message contains the following information:
User ID <user_id> disabled, computer <computer_name>
The $LOGIN alarm is generated when a user successfully logs in to a CIMPLICITY HMI
project. The alarm message contains the following information:
User ID <user_id> @ <computer_name> logged on
The $LOGOUT alarm is generated when a user logs out of a CIMPLICITY HMI project.
The alarm message contains the following information:
User ID <user_id> @ <computer_name> logged out
GFK-1180K
System Management
33-21
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.
The CIMPLICITY HMI License Agreement dialog box opens.
33-22
July 2001
GFK-1180K
4.
Result: The next dialog box that opens depends on your computer status:
If any projects are running, the OEM Key dialog box opens.
If no projects are running, the CIMPLICITY HMI OEM Key dialog box
opens.
2.
Click Next.
Note: Click Cancel to exit OEM Key without stopping the running projects.
GFK-1180K
System Management
33-23
You can
Leave the dialog box open or minimize it while OEM Key is running.
Check the Show status window check box to display the time left. This status
window displays on top of all the windows on your screen.
Note: If you exit the dialog box or click Quit, the OEM Key terminates immediately.
Displays a dialog box warning you that it will stop all running projects.
33-24
July 2001
GFK-1180K
Remote Projects
If, when a project starts, the Point Bridge or Point Data Logger need to get points from
projects on other computers running CIMPLICITY projects, you need to define remote
projects.
If your computer is on a network with other CIMPLICITY computers, you can retrieve
point information from projects running on the other computers in a variety of ways:
You can display points from other computers on CimView screens running in
your project.
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.
2.
3.
The Workbench right pane initially displays the following fields for remote projects:
Project
User ID
Note: Use the Workbench Field Chooser to remove or display any of the available fields,
except the Project. The Project is required. All of the fields in the Remote Project dialog
box are available to display in the Workbench. See the "Selecting Fields to Display in the
Right Pane" in the "Using the Workbench" chapter in this manual for information about
the Field Chooser"
The Remote Project list is initially sorted by Project. You can click on any of the other
column titles at the top of the list to sort the list by that attribute.
GFK-1180K
System Management
33-25
2.
3.
The New Project dialog box opens when you use any method.
Enter the name of the remote project in the Project Name field and click OK. The
Remote Project dialog box opens. This dialog box consists of two tabs.
33-26
Use the General tab to enter general information about the project.
Use the Enterprise tab to configure data and alarm collection for an enterprise
project.
July 2001
GFK-1180K
In the General property tab of the Remote Project dialog box, enter information in the
following fields:
User ID
Enter the CIMPLICITY User ID that will be accepted for the remote project login.
Password
Enter a password, if you want to require one, for the remote project login.
Reenter Password
If you are entering a password, re-enter it here to confirm it.
Enable
Check Enable to enable the login.
If you clear the check box, the login will not be made.
Resident Process Use Only
Check Resident Process Use Only if you only want resident processes to automatically
log in to remote projects. Users will still have to log in at the Application level.
If you uncheck this check box, users will not have to log in at the Application level, and
they are automatically given the same privileges as the CIMPLICITY User ID for the
remote login.
GFK-1180K
System Management
33-27
If you want to use your current project as an Enterprise Server, you must define a remote
project for each project in your enterprise from when you want to concentrate data or
alarm information.
In the Enterprise tab, the Resource and Device are pre-configured. Users who want to
view point and alarm information from a remote project on an Enterprise Server must
have the remote projects Resource configured in their view.
Enter the following information:
Collect points
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.
33-28
July 2001
GFK-1180K
You have a complex system architecture where users on Viewers need to display
points from Servers.
You want to generate alarms on your Server for points on another Server.
You will need to do the following to successfully use the Point Bridge:
1.
Configure a Remote Project for the source system on the destination system.
2.
3.
Define a device for the Point Bridge port and make sure the Device Name
matches the Remote Project name.
4.
Define the points you want to retrieve from the source system. Make sure that
the Point Address matches the source project's point name.
The Point ID on the destination system does not have to match the Point ID on the source
system. The data types and number of elements of the two points do have to match.
When the source point changes value, the point value is updated on the local system.
Both reading and writing of points are supported. If a point is configured for WRITE
access on both systems, a user on the Point Bridge system can set the value of the Point
Bridge point. The point on the source system is then updated.
Dynamic configuration of Point Bridge points is also supported.
Note: Diagnostic points are not available for the Point Bridge.
GFK-1180K
System Management
33-29
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.
33-30
Update Criteria
Address
Clear this check box. Point Bridge does not support this
feature.
July 2001
GFK-1180K
A Global Parameter:
Defines parameters for the CIMPLICITY Base System and options that override
default parameters in the software.
Controls either:
GFK-1180K
The system or
A project.
A-1
Warning: Improper global parameter configuration can cause adverse system effects.
Do not add, modify or delete global parameters unless specifically instructed to by the
documentation or a GE Fanuc Automation representative.
2.
3.
Project
Current project
System
System
Result: The global parameters that exist for your selection appear in the
Workbench right pane.
System is selected.
A-2
July 2001
GFK-1180K
The procedure for each of these management functions is simple. However, the result of
any modification can have a powerful impact on the system. Therefore, you will see
warning messages every step of the way. They are there for a reason.
Following is a graphic summary of the procedure.
3 Update the
configuration.
GFK-1180K
A-3
2.
Project
System
The global parameters for your selection display in the right pane.
3.
4.
Method 3
A. Right-click the selected global parameter.
B. Select Properties from popup menu.
Method 4
A. Click Edit on the Workbench menu bar.
B. Select Properties.
Method 5
Press Alt+Enter on the keyboard.
A message appears warning you against changing global parameter values
unless instructed to by the documentation or a GE Fanuc Automation
representative when you use any method.
A-4
July 2001
GFK-1180K
5.
Click either:
A. OK if you are sure you want to change the value.
B. Cancel to cancel the job.
A Global Parameter - <name> dialog box appears when you click OK.
6.
7.
Click OK.
8.
Do the following if you selected a system global parameter and want the
parameter to be changed for the current project. Otherwise, go to 9.
A. Select Project in the Workbench left pane.
B. Check to see if the global parameter appears in the right pane.
C. If the global parameter:
9.
i.
ii.
Does exist, change the value the same way you did for the system
global parameter.
Method 2
A. Click Project on the Workbench menu bar.
B. Select Configuration Update.
Method 3
Press Alt+P+C on the keyboard.
GFK-1180K
A-5
A message box appears asking you if you want to copy master configuration
data to run-time data.
A-6
July 2001
GFK-1180K
Important: A global parameter applies to either the project or the system. It is important
that you add the parameter to the correct folder. If you add it to the wrong folder, it will
not be workable.
To add a global parameter to the Workbench list:
1.
2.
3.
Select
To add a:
Project
System
Method 2
A. Click the right mouse button on your selection.
B. Select New from the popup menu.
Method 3
A. Click File on the Workbench menu bar.
B. Select New.
C. Select Object from the extended menu.
Method 4
Press Ctrl+N on the keyboard.
The New Global Parameter dialog box opens when you use any method.
GFK-1180K
4.
5.
Click OK.
A-7
A message box appears warning you that improper configuration can cause
adverse effects.
6.
6.
Enter a value that applies to the global parameter in the Value field.
7.
Click OK.
9.
Method 2
A. Click Project on the Workbench menu bar.
B. Select Configuration Update.
Method 3
Press Alt+P+C on the keyboard.
A message box appears asking you if you want to copy master configuration
data to run-time data.
A-8
July 2001
GFK-1180K
2.
To delete a:
Project
System
3.
4.
Method 2
A. Click the right mouse button on your selection.
B. Select Delete from the popup menu.
Method 3
A. Click Edit on the Workbench menu bar.
B. Select Delete.
C. Select Object from the extended menu.
Method 4
Press Del on the keyboard.
A message box appears asking you if you want to delete the selected items.
5.
GFK-1180K
Click Yes.
A-9
A message box appears warning you that improper configuration can cause
adverse effects.
6.
Click OK if you are sure you want to delete the global parameter.
The global parameter is deleted from the list.
7.
Update the CIMPLICITY configuration. See page 1-5 for details about updating
the CIMPLICITY configuration.
Result: The global parameter is deleted from the list and de-activated in the
CIMPLICITY system and/or project.
A-10
July 2001
GFK-1180K
Global Parameters
Following is a list of global parameters.
Parameter
ACK_TOUT
ALARM_SAVE_COMMENTS
ALLOW_UPDATE_WHEN_DISABLED
AM_OLD_POINT_RESET
AM_RESET_ACK_STATE
AMLP_HIGHWATERMARK
AMLP_LOSTALARMSPAGE
AMLP_LOWWATERMARK
AMLP_MAX_QUEUE
AMLP_USE_GEN_TIME
AMLP_USE_RESET_TIME
BIND_ADDR
CE_MAX_DELAY
CE_MAX_THREADS
CE_THREAD_TIMEOUT
CLR_TOUT
CONNECT_DROP_PERIOD
CONNECT_RETRY_PERIOD
DARP_LVV_USECURRENT
DARP_STARTUP_INTERVAL
DB_CLOCK_ADJUSTMENT_MONITOR
DB_COMPACT_QUEUE_SIZE
DB_COUNTER_FIELD
DB_DBMS_QUEUE_SIZE
DB_DEBUG
DB_ENABLE_MSEC
DB_ENABLE_TRANSACTIONS
DB_MSEC_FIELD
DB_POINT_ID_FIELD
DB_PROJECT_FIELD
DB_QUEUE_OVERFLOW_DELAY
DB_QUEUE_SIZE
DB_STATUS_LOG_OFF
DB_TABLE_FAILURE_RETRY
DB_TIME_FORMAT
DB_TIMESTAMP_FIELD
DB_TIMESTAMP_FILTER
DB_TIMESTAMP_PRECISION
DBDL_DEVICE_CHECK_PERIOD
DC_RETRY_ONE_DEVICE
GFK-1180K
For
Points and Alarms
Alarms
Ports
Alarm Manager
Alarm Management
Alarm Line Printer
Alarm Line Printer
Alarm Line Printer
Alarm Line Printer
Alarm Line Printer
Alarm Line Printer
Router
Basic Control Engine
Basic Control Engine
Basic Control Engine
Alarm Management
Login
Login
Historical Data Analyzer
Historical Data Analyzer
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Database Logger
Device Communications
See Page in
Chapter 1:
14
14
15
15
16
16
16
17
17
17
18
18
19
19
19
19
20
20
20
21
21
21
22
22
23
23
25
25
26
26
27
27
27
28
28
29
30
30
31
31
A-11
DEL_OPT
Device Communication Parameters
DEVICE_DOWN_DEVICE_REF
DONT_VERIFY_ESPOINT_FRID
DT_UPD_INTERVAL
FIRST_WEEK_DAYS
GSM_ANNUN_ALARM_H1
GSM_ANNUN_ALARM_H2
GSM_ANNUN_ALARM_L1
GSM_ANNUN_ALARM_L2
GSM_ANNUN_DIG_OFF
GSM_ANNUN_DIG_ON
GSM_ASC_FONT_NAME
GSM_ASC_FONT_SIZES
GSM_ASC_SCALE
GSM_CACHE_SIZE
GSM_EXPONENT_PRECISION
GSM_GLOBAL_SCRIPT
GSM_LIB_CACHE_SIZE
GSM_OVERRIDE_POINT_FMT
GSM_SPCONFIRM_DEFAULT
GSM_STALE_COLOR_KEY
GSM_TERMSERV_CACH_SIZE
GSM_UNAVAIL_COLOR_KEY
GSM_UNAVAILABLE_TIMELIMIT
HDA_PTDL_OFFSET
IPC_BCAST_INTERVAL
IPC Global Memory Use Parameters
PORT_PERIOD_SECS
PORT_GROWTH_PERIODS
PORT_NONE_CONSUMED
SOCK_PERIOD_SECS
SOCK_GROWTH_PERIODS
SOCK_NONE_CONSUMED
IPC_QUEUE_SIZE
LOG_OPT
LOGIN_RETRY_PERIOD
MAX_TREND_BUF
MULTICAST_HOSTNAME
MULTICAST_IP_ADDR
MULTICAST_TTL
PB_DIAGS
PROJECT_ID
PROWLER_CACHE_SIZE
A-12
July 2001
Alarms
Device Alarms
Enterprise Server Points
Date/Time Points
Date/Time Points
CimView
CimView
CimView
CimView
CimView
CimView
CimEdit/CimView (Classic
ASCII File (Imports)
CimEdit/CimView (Classic
ASCII File (Imports)
CimEdit/CimView (Classic
ASCII File (Imports)
CimView
CimView
CimView
CimEdit/CimView
CimView
CimView
CimView
CimView (using Terminal
Services)
CimView
CimView
Historical Data Analyzer
CIMPLICITY IPC
CIMPLICITY IPC
CIMPLICITY IPC
Database Logging
CIMPLICITY Login
Trending
IP Address Traffic
IP Address Traffic
IP Address Traffic
Point Bridge
Multiple Projects
WebView/ThinView
31
58
32
32
33
33
34
34
35
35
36
36
37
37
38
38
39
39
40
40
41
41
42
42
42
43
43
44
45
45
46
46
46
47
48
48
49
49
GFK-1180K
PTDL_ENABLE_MEASUREMENTS
PTDL_QUANTIZATION
PTMDP_DO_EU_CONV
PTMDP_DO_SAVEPOINT_CACHE
PTMDP_DO_SAVEPOINT_COMPACT
PTMRP
PTX_MAX_CACHED_POINTS
RAW_LIMIT_ALARM
REDUND_LINK_SLEEP
REPEAT_TOUT
RTR_ACCEPT_CONN
RTR_DISABLE_BCAST
RTR_MAX_OUTMESSAGE_COUNT
SECURE_SOCKETS
SETPOINT_SECURITY
SHORT_FILENAMES
STARTUP_TIMEOUT
SVC_RETRY_COUNT
SVC_RETRY_DELAY
SYSNAME
TERMSERV_ALLOW_SETPOINTS
UR_LOGIN_FAILURES
GFK-1180K
Measurement System(Data
logging)
Database Logging
Point Configuration
Point Configuration
Point Configuration
Point Management
Point Translation
Point Alarms
Server Redundancy
Alarm Management
Network Options
Router
Router
Network
Point Management Security
Filenames
Project
External Services
External Services
Project
Points (using Terminal Services)
User Interface
49
50
50
50
51
51
51
52
52
52
52
53
53
54
55
55
55
56
56
56
56
57
A-13
$AM_STATUS
For:
Alarms
Project
Purpose:
Default for:
Value:
Default Value: N
Record Format: $AM_STATUS| |<
ACK_TOUT
For:
Purpose:
Default for:
Value:
ALARM_SAVE_COMMENTS
For:
Alarms
Project
Purpose:
Default for:
Value:
YES
Default Value: NO
Record Format: ALARM_SAVE_COMMENTS|1|<option>
A-14
July 2001
GFK-1180K
ALLOW_UPDATE_WHEN_DISABLED
For:
Ports
Project
Purpose:
Value:
NO
Default Value: NO
Record Format: ALLOW_UPDATE_WHEN_DISABLED|1|<option>
AM_OLD_POINT_RESET
For:
Alarm Manager
Project
Purpose:
To update the time when an alarm is generated from the generated time
to the reset time.
The updated value can be viewed in the Alarm Viewer.
Value:
Default Value: N
Record Format: AM_OLD_POINT_RESET|1|<Y or N>
GFK-1180K
A-15
AM_RESET_ACK_STATE
For:
Alarm Management
Project
Purpose:
Value:
NO
Default Value: NO
Record Format: AM_RESET_ACK_STATE|1|<option>
AMLP_HIGHWATERMARK
For:
Purpose:
Value:
AMLP_LOSTALARMSPAGE
For:
Purpose:
Value:
Project
Default Value: N
Record Format: AMLP_LOSTALARMSPAGE|1|<flag>
A-16
July 2001
GFK-1180K
AMLP_LOWWATERMARK
For:
Purpose:
Value:
Default Value: 0
Record Format: AMLP_LOWWATERMARK|1|<number>
AMLP_MAX_QUEUE
For:
Purpose:
Value:
AMLP_USE_GEN_TIME
For:
Purpose:
Value:
NO
GFK-1180K
A-17
AMLP_USE_RESET_TIME
For:
Purpose:
To have the alarm printer print the time an alarm was reset.
Important: The global parameter, AM_OLD_POINT_RESET must be
set along with AMLP_USE_RESET_TIME, as follows:
Value:
Default Value: N
Record Format: AMLP_USE_RESET_TIME|1|<N or Y>
BIND_ADDR
For:
Router
System
Purpose:
Value:
A-18
July 2001
GFK-1180K
CE_MAX_DELAY
For:
Purpose:
To specify 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.
Value:
Default Value: 60
Record Format: CE_MAX_DELAY|3|<time>
CE_MAX_THREADS
For:
Purpose:
Value:
Default Value: 30
Record Format: CE_MAX_THREADS|3|<time>
CE_THREAD_TIMEOUT
For:
Purpose:
To specify the idle cache time in seconds before the threads are freed.
Value:
CLR_TOUT
For:
Alarm Management
Project
Purpose:
Default for:
Reset Timeout field in the Alarm Options Properties dialog box for
points and alarms
Value:
Default Value: 0
Record Format: CLR_TOUT|3|<minutes>
GFK-1180K
A-19
CONNECT_DROP_PERIOD
For:
Login
System
Purpose:
Value:
CONNECT_RETRY_PERIOD
For:
Login
System
Purpose:
Value:
DARP_LVV_USECURRENT
For:
Purpose:
Defines whether the previous or current row in the source table should
be used for the LVV calculation.
Value:
Project
Use the current row in the source table for the LVV
calculation.
Use the previous row in the source table for the LVV
calculation.
Default Value: N
Record Format: DARP_LVV_USECURRENT|3|<value>
A-20
July 2001
GFK-1180K
DARP_STARTUP_INTERVAL
For:
Purpose:
Value:
Number (of seconds). Enter a value between 3600 (one hour) and
86400 (one day).
If you enter a value less than 3600, the minimum value will be used. If
you enter a value greater than 86400, the maximum value will be used.
DB_CLOCK_ADJUSTMENT_MONITOR
For:
Database Logger
Project
Purpose:
Defines the rate at which system clock adjustments are checked. All
synchronized timed events are adjusted when a system clock
adjustment occurs.
Value:
Default For:
Default Value: 60
Record Format: DB_CLOCK_ADJUSTMENT_MONITOR|1|<seconds>
DB_COMPACT_QUEUE_SIZE
For:
Database Logger
Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose:
For Microsoft Access databases, the compact queue holds the database
requests. This global parameter defines the queue size for maintenance
actions.
Value:
Number
GFK-1180K
A-21
DB_COUNTER_FIELD
For:
Database Logger
Project
Purpose:
Value:
To modify the name of the seq_num field that specified the record
sequence number of each logged transaction in the following Database
Logger Tables:
SPC tables
HDA tables
Tracker tables
DB_DBMS_QUEUE_SIZE
For:
Database Logger
Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose:
Defines the database's queue size for non-table requests. For example,
connect requests are non-table requests
Value:
A-22
July 2001
GFK-1180K
DB_DEBUG
For:
Database Logger
Project
Purpose:
Value:
256
512
1024
DB_ENABLE_MSEC
For:
Database Logger
System or
Project
Purpose:
GFK-1180K
A-23
Value:
Folder
System
Project
Values include:
Y
Default Values: msec is the default name of a field that CIMPLICITY creates in the
database.
Note: CIMPLICITY names the field msec. To change this name, use
the global parameter DB_MSEC_FIELD. See page 1-25 for details
about the DB_MSEC_FIELD global parameter.
Record Value: DB_ENABLE_MSEC|1|<Y or N>
Important
1.
2.
3.
If you are logging data from multiple projects to the same database then all projects
must have the feature identically configured.
5.
If you are using DB_ENABLE_MSEC on more than one computer, including servers
and viewers, add DB_ENABLE_MSEC on each.
4.
Only Point Logging, Alarm Logging and Trending clients fully support this feature.
To alter the name that CIMPLICITY uses to refer to or create the field in the
database, create another global parameter, name it DB_MSEC_FIELD, and provide
the appropriate string value for the field name.
A-24
July 2001
GFK-1180K
DB_ENABLE_TRANSACTIONS
For:
Database Logger
Project
Purpose:
Value:
DB_MSEC_FIELD
For:
Database Logger
System or
Project
Purpose:
To alter the default name that CIMPLICITY uses to refer to a field that
reports the sub-second portion of timestamps in the database. See page
1-23 for details about the associated DB_ENABLE_MSEC global
parameter.
Value:
Important
1.
If you want to enable DB_MSEC_FIELD, create or enable the parameter before you
create any tables in the database.
CIMPLICITY creates the field as part of a table's primary key when it creates the
table. CIMPLICITY creates tables when you start your project for the first time or
reconcile a table through the Database Logger Configuration program. Therefore,
you will have to drop any table that exists before you create or enable
DB_MSEC_FIELD so CIMPLICITY can recreate them with the new field.
GFK-1180K
2.
If you are logging data from multiple projects to the same database then all projects
must have the feature identically configured.
3.
Only Point Logging, Alarm Logging and Trending clients fully support this feature.
A-25
DB_POINT_ID_FIELD
For:
Database Logger
Project
Purpose:
Value:
DB_PROJECT_FIELD
For:
Database Logger
Project
Purpose:
Value:
SPC tables
HDA tables
Tracker tables
A-26
July 2001
GFK-1180K
DB_QUEUE_OVERFLOW_DELAY
For:
Database Logger
Project
To specify the delay in seconds between logging overflow errors for the
Database Logger.
Value:
Default Value: 30
Record Format: DB_QUEUE_OVERFLOW_DELAY|1|<seconds>
DB_QUEUE_SIZE
For:
Database Logger
System
Purpose:
Default for:
Value:
Default Value: 20
Record Format: DB_QUEUE_SIZE|1|<size>
DB_STATUS_LOG_OFF
For:
Database Logger
Project
Purpose:
Value:
Default Value: 0
Record Format: DB_STATUS_LOG_OFF|1|<number>
GFK-1180K
A-27
DB_TABLE_FAILURE_RETRY
For:
Database Logger
Project
Purpose:
Value:
DB_TIME_FORMAT
For:
Database Logger
Project
Purpose:
To define the timestamp format for your database so that time and date
fields will be written correctly in the Store and Forward files. This
parameter is for a database that does not use the default Microsoft
Access and SQL Server timestamp format, which is used by
CIMPLICITY.
Value:
Uppercase
Y
Year
Month
Hour
Lowercase
d
Day
Minutes
Seconds
A-28
July 2001
GFK-1180K
DB_TIMESTAMP_FIELD
For:
Database Logger
Project
Purpose:
Value:
To modify the name of the unique timestamp field which specifies the
date and time of each logged transaction in the following Database
Logger tables.
SPC tables
HDA tables
Tracker tables
GFK-1180K
A-29
DB_TIMESTAMP_FILTER
For:
Database Logger
Project
Purpose:
Default For:
Value:
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
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
Default Value: 0
Record Format: DB_TIMESTAMP_FILTER|1|<option>
DB_TIMESTAMP_PRECISION
For:
Database Logger
Project
Caution: Do not create or modify this option unless instructed to by GE Fanuc support
personnel.
Purpose:
Value:
A-30
July 2001
GFK-1180K
DBDL_DEVICE_CHECK_PERIOD
For:
Database Logger
Project
Purpose:
Value:
Default Value: 30
Record Format: DBDL_DEVICE_CHECK_PERIOD|1|<minutes>
DC_RETRY_ONE_DEVICE
For:
Device Communications
Project or System
Purpose:
Value:
FALSE
DEL_OPT
For:
Alarms
Project
Purpose:
Default For:
Value:
Acknowledged only
Reset only
AR
Default Value: AR
Record Format: DEL_OPT|1|<option>
GFK-1180K
A-31
DEVICE_DOWN_DEVICE_REF
For:
Device Alarms
Project
Purpose:
Value:
1.
2.
The Resource ID, which in this case it takes it from the device's
resource and
3.
A Reference ID.
Default Value: The Reference ID is the same for every device down alarm. So if there
are two devices using the same resource, their alarms get stacked into
one set of alarms as opposed to appearing independently.
Record Format: DEVICE_DOWN_DEVICE_REF|1|<value>
DONT_VERIFY_ESPOINT_FRID
For:
Purpose:
Value:
Setpoint Security for all points from a given provider are enforced
against the Resource IDs as configured on the provider.
This means that a setpoint against any of these points with
resources not configured on the Enterprise Server project will
always fail since a resource that is not configured cannot be in a
user's view.
Default Value: N
Record Format: DONT_VERIFY_ESPOINT_FRID|1|<value>
A-32
July 2001
GFK-1180K
DOWNLD_PASSWD
For:
Point Setup
Project
Purpose:
Default for:
Value:
Up to 80 alphanumeric characters.
DT_UPD_INTERVAL
For:
Date/Time Points
Project
Purpose:
To set the interval in seconds to update a Projects Date & Time system
points.
Value:
Default Value: 1
Record Format: DT_UPD_INTERVAL|3|<seconds>
FIRST_WEEK_DAYS
For:
System
Purpose:
Value:
Default Value: 1
Record Format: FIRST_WEEK_DAYS|3|<days>
GFK-1180K
A-33
GSM_ANNUN_ALARM_H1
For:
CimView
System or Project
Purpose:
To specify the color and blink state to be displayed when the alarm
state for an analog point is Warning High.
Value:
Blink either:
Y
Blink or
No blink.
Example
3Y (Blue, Blink)
Note: The color associated with each number is defined in the
RGB.DAT file. See "RGB.dat Files" in the "Applying Inanimate Visual
Features" chapter in the CIMPLICITY CimEdit Manual, GFK-1396.
Default Value: 14N (Aqua, No Blink)
Record Format: GSM_ANNUN_ALARM_H1|1|<color_number><blink>
GSM_ANNUN_ALARM_H2
For:
CimView
System or Project
Purpose:
To specify the color and blink state to be displayed when the alarm
state for an analog point is High.
Value:
Blink either:
Y
Blink or
No blink.
Example
13Y (Fuschia, Blink)
Note: The color associated with each number is defined in the
RGB.DAT file. See "RGB.dat Files" in the "Applying Inanimate Visual
Features" chapter in the CIMPLICITY CimEdit Manual, GFK-1396.
Default Value: 15N (Yellow, No Blink)
Record format: GSM_ANNUN_ALARM_H2|1|<color_number><blink>
A-34
July 2001
GFK-1180K
GSM_ANNUN_ALARM_L1
For:
CimView
System or Project
Purpose:
To specify the color and blink state to be displayed when the alarm
state for an analog point is Warning Low.
Value:
Blink either:
Y
Blink or
No blink.
Example
8Y (Teal, Blink)
Note: The color associated with each number is defined in the
RGB.DAT file. See "RGB.dat Files" in the "Applying Inanimate Visual
Features" chapter in the CIMPLICITY CimEdit Manual, GFK-1396.
Default Value: 10N (Olive Green, No Blink)
Record format: GSM_ANNUN_ALARM_L1|1|<color_number><blink>
GSM_ANNUN_ALARM_L2
For:
CimView
System or Project
Purpose:
To specify the color and blink state to be displayed when the alarm
state for an analog point is Low.
Value:
Blink either:
Y
Blink or
No blink.
Example
4Y (Maroon, Blink)
Note: The color associated with each number is defined in the
RGB.DAT file. See "RGB.dat Files" in the "Applying Inanimate Visual
Features" chapter in the CIMPLICITY CimEdit Manual, GFK-1396.
Default Value: 13N (Fuchsia No Blink)
Record format: GSM_ANNUN_ALARM_L2|1|<color_number><blink>
GFK-1180K
A-35
GSM_ANNUN_DIG_OFF
For:
CimView
System or Project
Purpose:
To specify the color and blink state to be displayed when the Boolean
point is 0.
Value:
Blink either:
Y
Blink or
No blink.
Example
13Y (Fuchsia Blink)
Note: The color associated with each number is defined in the
RGB.dat file. See "RGB.dat Files" in the "Applying Inanimate Visual
Features" chapter in the CIMPLICITY CimEdit Manual, GFK-1396.
Default Value: 6N (Purple, No Blink)
Record Format: GSM_ANNUN_DIG_OFF|1|<color_number><blink>
GSM_ANNUN_DIG_ON
For:
CimView
System or Project
Purpose:
To specify the color and blink state to be displayed when the Boolean
point is 1.
Value:
Blink either:
Y
Blink or
No blink.
Example
6N (Purple No Blink)
Note: The color associated with each number is defined in the
RGB.DAT file. See "RGB.dat Files" in the "Applying Inanimate Visual
Features" chapter in the CIMPLICITY CimEdit Manual, GFK-1396.
Default Value: 7N (White, No Blink)
Record Format: GSM_ANNUN_DIG_ON|1|<color_number><blink>
A-36
July 2001
GFK-1180K
GSM_ASC_FONT_NAME
For:
Purpose:
To specify the name of the font to use for text on an ASCII (.ASC)
screen.
Value:
Font Name.
The font must be a TrueType font.
GSM_ASC_FONT_SIZES
For:
Purpose:
Value:
Default Value: 112, 140, 168, 280, 364, 560, 602, 602, 602, 602, 602, 602, 602,
602, 602, 602.
Record Format: GSM_ASC_FONT_SIZES|1|<list>
GFK-1180K
A-37
GSM_ASC_SCALE
For:
Purpose:
Value:
GSM_CACHE_SIZE
For:
CimView
System or Project
Purpose:
To increase the cache size if you require faster screen repaint times
when switching between screens.
Value:
Default Value: 8
Record Format: GSM_CACHE_SIZE|1|<number>
Note: Increasing this number uses additional memory and may have a
negative effect on the performance of other transactions.
A-38
July 2001
GFK-1180K
GSM_EXPONENT_PRECISION
For:
CimView
System or Project
Purpose:
To do the following:
If:
A Text object on a CimView screen has a "General" format and
The number of digits exceeds this parameter,
Then:
The number is displayed in scientific notation with that number of
significant digits.
Value:
Default Value: 6
Record Format: GSM_EXPONENT_PRECISION|1|<number>
GSM_GLOBAL_SCRIPT
For:
CimEdit/CimView
Purpose:
Value:
System or Project
Example
GSM_GLOBAL_SCRIPT|1|"D:\SCR\MISCR.TXT;D|\SCR\TKSETS.T
XT"
GFK-1180K
A-39
GSM_LIB_CACHE_SIZE
For:
CimEdit/CimView
System or Project
Purpose:
To increase the cache size for library screens (screens that contain link
source objects or class object graphics). This is similar to
GSM_CACHE_SIZE. This parameter affects both standard console
CimView sessions as well as WebView and ThinView sessions.
Value:
Default Value: 4
Record Format: GSM_LIB_CACHE_SIZE|1|<number>
Note: Increasing this number uses additional memory and may have a negative effect on
the performance of other transactions.
GSM_OVERRIDE_POINT_FMT
For:
CimEdit/CimView
System or Project
Purpose:
To adjust the format used to display point values. This is used in most,
but not all, parts of CimView. The format is specified using a "printf"
style format string, just like in the Custom display format of a text
object in CimEdit.
Value:
A-40
July 2001
GFK-1180K
GSM_SPCONFIRM_DEFAULT
For:
CimView
System or Project
Purpose:
Value:
Select one:
OK,
Skip or
Cancel.
Default Value: OK
Record Format: GSM_SPCONFIRM_DEFAULT|1|<selection>
Note: If you select a default that is not available in the dialog box, CimView uses OK as
the default button.
GSM_STALE_COLOR_KEY
For:
CimView
System or Project
Purpose:
To display a last available data value in a color rather than display the
default text if a point being displayed in a Text object on a CimView
screen is unavailable and there is last available data. If no last available
data exists, the default text is displayed.
Value:
See "Dealing with the RGB Index" in the "Applying Inanimate Visual
Features" chapter in the CIMPLICITY CimEdit Manual, GFK-1396.
Default Value: The Text object displays the default text when the point is unavailable,
regardless of whether a last available value exists or not.
Record Format: GSM_STALE_COLOR_KEY|1|RGB(<red>,<green>,<blue>)
GFK-1180K
A-41
GSM_TERMSERV_CACHE_SIZE
For:
Purpose:
Value:
Default Value: 4
Record format: GSM_TERMSERV_CACHE_SIZE|1|<number>
GSM_UNAVAIL_COLOR_KEY
For:
CimView
System or Project
Purpose:
Value:
Default Value: 0
Record format: GSM_UNAVAIL_COLOR_KEY|1|<number>
GSM_UNAVAILABLE_TIMELIMIT
For:
CimEdit/CimView
Purpose:
Value:
System or Project
A-42
July 2001
GFK-1180K
HDA_PTDL_OFFSET
For:
Purpose:
To specify the number seconds that you allow for the delayed logging
of the Point Data Logger (required if you rely on source and flag fields
you are logging to be synchronized to 00 seconds).
The Historical Data Analyzer Resident Process gathers values per
minute for the source field and flag field for all HDA fields that are to
be evaluated at the current time.
The Point Data Logger
Any delay with writing to the database will cause the log time to be
delayed. Therefore, a Group table that is configured to log
synchronized may actually log its values a number of milliseconds (or
even seconds) late.
Value:
Default Value: 99
Record Format: HDA_PTDL_OFFSET|1|<milliseconds>
IPC_BCAST_INTERVAL
For:
Router
System and Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose:
Value:
Default Value: 75
Record Format: IPC_BCAST_INTERVAL|1|<number>
GFK-1180K
A-43
There are two sets of global parameters. The first set is for On-Node
message "ports"; the other set is for Off-Node communications through
"sockets".
On-Node Message "Ports"
Global Parameter Specifies:
PORT_PERIOD_SECS The number of seconds in a calculation period.
The default is 5.
PORT_GROWTH_PERIODS The number of periods to allow that message production
PORT_NONE_CONSUMED
Specifies
A-44
July 2001
GFK-1180K
IPC_QUEUE_SIZE
For:
Router
System
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose:
Value:
Default Value: 50
Record Format: IPC_QUEUE_SIZE|1|<number>
LOG_OPT
For:
Database Logging
Project
Purpose:
To define the default logging conditions for an alarm. You can choose
any of the following:
Value:
Alarm is generated
Alarm is acknowledged
Alarm is reset
GFK-1180K
A-45
LOGIN_RETRY_PERIOD
For:
CIMPLICITY Login
Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose:
Value:
MAX_TREND_BUF
For:
Trending
Project
Purpose:
Value:
MULTICAST_HOSTNAME
For:
IP Address Traffic
System
Purpose:
Value:
A-46
July 2001
GFK-1180K
MULTICAST_IP_ADDR
For:
IP Address Traffic
System
Purpose:
Value:
IP address
Guidelines
For the latest list of reserved multicast addresses, visit the Information
Sciences Institute web site.
Default Value: 224.0.0.29.
Record Format:
Caution: If you change the address, make sure that you change it on all the machines, in
order to insure that they will continue "talking" with each other.
GFK-1180K
A-47
MULTICAST_TTL
For:
IP Address Traffic
System
Purpose:
Value:
PB_DIAGS
For:
Point Bridge
Project
Purpose:
Value:
A-48
July 2001
GFK-1180K
PROJECT_ID
For:
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose:
Value:
PROWLER_CACHE_SIZE
For:
WebView/ThinView
Purpose:
Value:
System or Project
Default Value: 0
Record Format: PROWLER_CACHE_SIZE|1|<number>
PTDL_ENABLE_MEASUREMENTS
For:
Purpose:
Default For:
Value:
Default Value: 0
Record Format: PTDL_ENABLE_MEASUREMENTS|1|<num>
GFK-1180K
A-49
PTDL_QUANTIZATION
For:
Data Logging
Project
Purpose:
To specify the rate in ticks at which the Point Data Logger submits data
for logging.
Default for:
Point data logging scan rate field in the Database Logger Logging
Properties dialog box.
Value:
Faster than the fastest table scan rate in ticks at which the Point
Data Logger will submit data for logging.
Large enough so that all the data for a PLC scan comes into the
database together.
PTMDP_DO_EU_CONV
For:
Point Configuration
Project
Purpose:
Value:
Default Value: 0
Record Format: PTMDP_DO_EU_CONV|3|<option>
PTMDP_DO_SAVEPOINT_CACHE
For:
Point Configuration
System and Project
Purpose:
Default For:
Value:
Default Value: 1
Record Format: PTMDP_DO_SAVEPOINT_CACHE|1|<flag>
A-50
July 2001
GFK-1180K
PTMDP_DO_SAVEPOINT_COMPACT
For:
Point Configuration
Project
Purpose:
Default For:
Compact on project startup check box in the Point Setup dialog box.
Value:
Default Value: 0
Record Format: PTMDP_DO_SAVEPOINT_COMPACT|1|<flag>
PTMRP
For:
Point Management
Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose:
Value:
PTX_MAX_CACHED_POINTS
For:
Point Translation
Project
Purpose:
To limit the size of the Point Translation cache on systems that have a
large number of points. Point Translation adds points to the cache
when Point Management applications (for example, scripts, CimView
windows, Point Control Panel, etc.) requests point information.
Caution: If the applications on a project are likely to cycle through all the points,
limiting the cache size may cause point information to update more slowly than expected.
Value:
Enter 0 (zero), or delete the global parameter if you do not want to limit
the cache size. Otherwise, enter the number of points to be put into the
cache.
Default Value: 0
Record Format: PTX_MAX_CACHED_POINTS|3|<value>
GFK-1180K
A-51
RAW_LIMIT_ALARM
For:
Point Alarms
Project
Purpose:
To enable or disable the generation of alarms for point values that are
outside their raw limits. The options are:
Value:
NO
REDUND_LINK_SLEEP
For:
Server Redundancy
System
Purpose:
To make the Router wait a period of time before creating the link to the
slave node.
Value:
Default Value: 5
Record Format: REDUND_LINK_SLEEP|3|<number>
REPEAT_TOUT
For:
Alarm Management
Project
Purpose:
Default for:
Minutes field in the Alarm Options tab of the Alarm Definition dialog
box when Auto repeat is set to Timed.
Value:
RTR_ACCEPT_CONN
For:
Network Options
System
Purpose:
Default for:
Value:
Stand alone.
Default Value: Y
Record Format: RTR_ACCEPT_CONN|1|<option>
A-52
July 2001
GFK-1180K
RTR_DISABLE_BCAST
For:
Router
System
Purpose:
Value:
Disable broadcast.
Default Value: N
Record Format: RTR_DISABLE_BCAST|1|<option>
RTR_MAX_OUTMESSAGE_COUNT
For:
Router
System
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose:
Value:
GFK-1180K
A-53
SECURE_SOCKETS
For:
Network
System
Purpose:
2.
Where
Y = Yes, activate encryption
N = No, de-activate encryption
3.
4.
5.
Important: Only computers that have CIMPLICITY 4.01 service pack 2 or higher
installed will be able to communicate with a SECURE_SOCKET encrypted PC.
A-54
July 2001
GFK-1180K
SETPOINT_SECURITY
For:
Purpose:
Value:
NO
Default Value: NO
Record Format: SETPOINT_SECURITY|1|<option>
SHORT_FILENAMES
For:
Filenames
Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose:
Value:
NO
Default Value: NO
Record Format: SHORT_FILENAMES|1|<option>
STARTUP_TIMEOUT
For:
Project
Project
Purpose:
To set the number of minutes to wait before timing out when starting
up a project.
Value:
Default Value: 10
Record Format: STARTUP_TIMEOUT|3|<minutes>
GFK-1180K
A-55
SVC_RETRY_COUNT
For:
External Services
Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose:
To set the number of retries waiting for an external service to start up.
Value:
Default Value: 30
Record Format: SVC_RETRY_COUNT|1|<number>
SVC_RETRY_DELAY
For:
External Services
Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose:
To set the delay in ticks between retries waiting for an external service
to start up.
Value:
SYSNAME
For:
Project
Project
Caution: Do not modify this option unless instructed to by GE Fanuc support personnel.
Purpose:
Value:
Default Value: The name that was assigned to the project when it was created.
Record Format: SYSNAME|1|<project_name>
TERMSERV_ALLOW_SETPOINTS
For:
Purpose:
Value:
A-56
July 2001
GFK-1180K
UR_LOGIN_FAILURES
For:
User Interface
Project
Purpose:
Value:
Default Value: 3
Record Format: UR_LOGIN_FAILURE|3|<number>
GFK-1180K
A-57
ABETH_PLC_POLL_TIMEOUT
ABETH_PLC_REQUEST_TIMEOUT
ABETH_PLC_RESPONSE_TIMEOUT
ABKT_AB_ADDRESSING
FloPro/FloNet Communications
FLOPRO_RESPONSE_TIMEOUT
FLOPRO_STATIC_MODEL
Marquee Driver
MARQ_PROC_NEW_ALARMS
MARQ_RESERVED_NULL
MARQ_WORD_WRAP_ON
MARQ_WRAP_HF
MARQ_POINT_LIMIT_LEN
COM<port>_TO
SA85_DRIVER_TIMEOUT
MBETH_DISABLE_UNSO_DATA
<port>_OMRON_SA1
<port>_OMRON_SERVICE
<port>_OMRON_SNA
<port>_TO
A-58
GMR_NO_MASTER
GMR_SKIP_L_DOMAIN
GMR_WRITE_ALL
HCT_SKIP_L_DOMAIN
UNSO_TX_AREA_<n>
July 2001
GFK-1180K
Smarteye Communications
GFK-1180K
<port>_LOG_WARNING
<port>_MODE
<port>_POLL_LIMIT
<port>_RESTART_SEA
SE_LABEL_LEN
A-59
2.
3.
where
<dir> is the directory where you need to make the changes.
For global parameters that apply to the:
idtpop glb_parms
notepad glb_parms.idt
A-60
July 2001
GFK-1180K
4.
5.
6.
Exit Notepad.
7.
Type scpop glb_parms at the DOS prompt. A new binary version of the
Global Parameters file will be produced and put in the master directory.
8.
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\hmi\data
GFK-1180K
A-61
A-62
July 2001
GFK-1180K
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.
GFK-1180K
B-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
B-2
GFK-1180K
VALUE
RAW_VALUE
STATE
TYPE
LENGTH
ELEMENTS
SIZE
DISP_FORMAT
EU_LABEL
ALARM_HIGH
ALARM_LOW
WARNING_HIGH
WARNING_LOW
DISP_HIGH
DISP_LOW
INIT_STATE
ALARM_ENABLED
WARN_ENABLED
VALUE
Displays the converted (EU) value of the point. If there is no conversion, the
raw value is displayed. If you do not enter an attribute in the CWSERV
command, this is the default attribute that is displayed.
RAW_VALUE
Displays the raw value of the point.
STATE
Displays the current state of the point.
The point's current state depends on its point class and alarm conditions.
For all point classes, the states that can be displayed are:
NORMAL
UNAVAILABLE
For Analog and APPL point classes, the additional states that can be displayed
are:
GFK-1180K
ALARM HIGH
ALARM LOW
WARNING HIGH
B-3
WARNING LOW
The point's 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 point's value is in the
alarm state.
TYPE
Displays the point's type. You will see one of the following:
BOOLEAN
BITSTRING
OCTETSTRING
CHARACTERSTRING
UNSIGNED INTEGER 1
UNSIGNED INTEGER 2
UNSIGNED INTEGER 4
INTEGER 1
INTEGER 2
INTEGER 4
FLOATING POINT
STRUCTURE
Note
LENGTH
Displays the length of the point. This field is only meaningful for the following
point types:
BITSTRING
OCTETSTRING
ELEMENTS
Displays the number of elements contained in the point.
SIZE
Displays the size of the data.
DISP_FORMAT
Displays the format used when displaying the point's value in Alarm Viewer,
Status Log messages, or CimView.
B-4
GFK-1180K
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 point's value exceeds this number, the point is in ALARM HIGH state.
ALARM_LOW
Displays the Alarm Low value for the point. This field is only valid for the
following point types:
ANALOG
APPL
If the point's value is less than this number, the point is in ALARM LOW state.
WARNING_HIGH
Displays the Warning High value for the point. This field is only valid for the
following point types:
ANALOG
APPL
If the point's value is greater than this number, but less than the Alarm High
number, the point is in WARNING HIGH state.
WARNING_LOW
Displays the Warning Low value for the point. This field is only valid for the
following point types:
ANALOG
APPL
If the point's value is less than this number, but greater than the Alarm Low
number, the point is in WARNING LOW state.
DISP_HIGH
Displays the high limit for the display value for this point. This field is only
valid for the following point types:
ANALOG
APPL
DISP_LOW
Displays the low limit for the display value for this point. This field is only valid
for the following point types:
GFK-1180K
ANALOG
APPL
B-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
2.
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]'
B-6
GFK-1180K
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:
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-1180K
B-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.
B-8
GFK-1180K
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.
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-1180K
B-9
B-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-1180K
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.
2.
GFK-1180K
B-11
The following macro is the one associated with the Set button above.
Array
channel=INITIATE("cwserv","point")
=POKE(channel,"cwserv_array.raw_value[0:9]",Sheet1!R5C4:R14C4)
=TERMINATE(channel)
=RETURN()
To change the setpoint, enter the new values in R5C4 through R14C4, and click
Set.
B-12
GFK-1180K
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.
GFK-1180K
B-13
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.
B-14
GFK-1180K
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 project's Status Log file
for detailed information on the cause of the problem.
GFK-1180K
2.
When the DDE Share window opens, select DDE Shares from
the Shares menu.
3.
4.
5.
6.
7.
8.
9.
Select OK.
B-15
\\nodeName\NDDE$
CWSERV$
B-16
GFK-1180K
GFK-1180K
C-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.
C-2
GFK-1180K
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-1180K
C-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.
C-4
GFK-1180K
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.
GFK-1180K
C-5
Remember that a device can have associations with multiple folders, but a folder
can only be associated with one of the project's devices.
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.
C-6
GFK-1180K
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.
2.
3.
GFK-1180K
C-7
4.
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.
C-8
GFK-1180K
Note
Conflicts do not need to be resolved in order for the import to continue.
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-1180K
C-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.
C-10
GFK-1180K
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-1180K
C-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 project's associations configured.
If you open the project from ComputerB and perform a point import, it will also
be performed because the computer has the project's associations configured.
Note that if ComputerB had its association configured as follows:
F:\project\project.gef with C:\folder\folder.ef7
the import will be performed but it will end up assuming that the folder is a
different folder.
C-12
GFK-1180K
CimView/CimEdit
For example, when you select a project in the Point Control Panel, that project may be a
running Machine Edition project. You select it the same as you do a Plant Edition project.
Once the project is open you browse for and select points to view, the same as you do for
Plant Edition projects.
Example
Point Control Panel
displaying a
Machine Edition project's
point data.
GFK-1180K
D-1
2.
Viewer connectivity.
Machine Edition
View
Plant Edition
Server
Point Data
Plant Edition
Viewer
Plant Edition
Viewer
The CIMPLICITY Enterprise Server (ES) serves data from one or more CIMPLICITY
Machine Edition projects. At startup the ES obtains a list of exported Machine Edition points
and adds those to the points it is serving. Similarly, whenever the Machine Edition node is
restarted, the ES will resynchronize the list of points. Whenever an ES point goes into demand
(e.g. a viewer starts using it), the ES will start collecting that data from the Machine Edition
node.
An important feature of the CIMPLICITY Enterprise server is that the architecture provides
scalability. Therefore, the server can handle data distribution to hundreds of viewers while
limiting the impact on the CIMPLICITY View to one request per point.
D-2
July 2001
GFK-1180K
CIMPLICITY HMI
Plant Edition
Viewer
Machine Edition
View
Machine Edition
View
Plant Edition
Server
Integrated Functionality
CIMPLICITY HMI Plant Edition provides you with the tools to easily work with Machine
Edition point data through the Plant Edition interface.
However, the two applications are designed to fulfill different requirements and, therefore,
have some differences in design functionality.
Following are details about:
Point ID's
Point Readings
Setpoint Privilege
Security
GFK-1180K
D-3
EU Conversion
D-4
July 2001
GFK-1180K
Unlike Plant Edition, Machine Edition runtime data collection is contained in the View
screen. Therefore, when you close view, data collection stops.
If a user is monitoring the Machine Edition project's point values in the Point Control
Panel, the values will stop displaying.
2.
In order to insure that the point ID is available to the Plant Edition Point Control Panel
(appears in the browse list), set the Machine Edition Inspector field, Mark as Used to
True.
If you do not set a Machine Edition point's Mark as Used field to True and the Machine
Edition point is not available to the View screen, it will not be available to the Point
Control Panel.
GFK-1180K
D-5
Appendix E - Import/Export
Configuration
Create and modify CIMPLICITY HMI point data using third party software.
Import point data into CIMPLICITY HMI software to update the database.
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.
In addition to reading and writing information in the CIMPLICITY HMI point database
and CSV files, Import/Export uses information in the Import/Export configuration files to
determine default field data, and writes informational, warning, and error messages to a
log file.
GFK-1180K
E-1
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.
E-2
GFK-1180K
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-1180K
If you want to enter a blank character field, use " " (a double-quote, followed
by any number of spaces, followed by a double-quote) for the field entry.
Initial blanks at the start of a field are ignored. If you want initial blanks, you
must edit the file with Notepad and enclose the field in double quotes.
A field that contains a comma does not need to be enclosed in double quotes.
For example:
You do not need to enter two double quotes if you want a double quote to be a
part of a data string. For example:
E-3
You may modify these configuration files through any text editor, independent of
Import/Export.
Contains information about default values that Import/Export will assign to point
configuration fields when importing data for new points. This file is a CSV file
that uses the SNF format.
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.
E-4
GFK-1180K
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.
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.
GFK-1180K
E-5
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
Note: The internal format contains all the fields in the Full Set plus additional
unsupported fields.
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.
Do not modify the Full Set or Logicmaster Export definitions.
E-6
GFK-1180K
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.
Note: Point IDs may have up to 32 characters
Example
GEF_DEMO_REAL_REAL_LONG_NAME will be truncated to
XXXXXXXX_GEF_DEMO_REAL_REAL_LONG.
GFK-1180K
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.
E-7
Import Procedure
To import data:
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 project's Data subdirectory is
recommended. You should always use the .CSV extension with this
filename.
Important: Option names are case sensitive and must be entered as defined.
E-8
GFK-1180K
Description
-D <device_id>
-R <resource_id>
-Pa <prefix>
-y
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.
GFK-1180K
E-9
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.
E-10
Ver.
1.0
GFK-1180K
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 project's Data subdirectory is
recommended. You should always use the .CSV extension with this
filename.
Important: Option names are case sensitive and must be entered as defined.
The optional arguments for the export command are:
Argument
Description
-Pr
-Ef <format>
GFK-1180K
E-11
-Sp <point_id>
-Sd <device_id>
-So <origin_id>
Export data for Point IDs whose Origin IDs match the
string you specify. Specify one of the following:
Ddevice point
Gglobal virtual point
Rderived 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.
Example
clie export myfile.csv -Pr -Ef "My Set"
exports the data fields defined by "My Set" in ie_formats.cfg to MYFILE.CSV and
MYFILE.ROL, and strips off any prefixes on the Point IDs.
E-12
GFK-1180K
Note: There are no implied wildcards. If you do not include or terminate your search
string with an asterisk, only those items that match your request exactly will be returned.
GFK-1180K
E-13
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.
>
Use this wildcard to search for any number of characters at this point in
the string. For example, if you want to delete all points that start with
M and end with X, enter M*X in the <point_id> field.
Use this wildcard to search for any character in this place in the string.
For example, if you want to delete all points whose names are three
characters long and whose first character is M and third character is X,
enter M?X in the <point_id> field.
Note: There are no implied wildcards. If you do not include or terminate your Point ID
string with an asterisk, only those Point Ids that match your request exactly will be
deleted.
Wild cards do not work with the -sp option.
E-14
GFK-1180K
32 characters
Point ID
Description
A derived point gets its data from an equation, and cannot be set with a setpoint.
Note: Some of the optional fields are specific to points of a particular origin. The Point
Origin column identifies the type of point defined by the record. The point types are:
All
Device
Global (virtual)
Derived (virtual)
GFK-1180K
E-15
E-16
ACCESS
CONV_LIM_HIGH
PT_ORIGIN
ACCESS_FILTER
CONV_LIM_LOW
PT_SET_INTERVAL
ACK_TIMEOUT
CONV_TYPE
PT_SET_TIME
ADDR
DELETE_REQ
PT_TYPE
ADDR_OFFSET
DESC
RANGE_HIGH
ADDR_TYPE
DEVIATION_PT
RANGE_LOW
ALM_CLASS
DEVICE_ID
RAW_LIM_HIGH
ALM_CRITERIA
DISP_LIM_HIGH
RAW_LIM_LOW
ALM_DEADBAND
DISP_LIM_LOW
REP_TIMEOUT
ALM_DELAY
DIS_TYPE
RESET_ALLOWED
ALM_HIGH_1
DISP_WIDTH
RESET_COND
ALM_HIGH_2
ELEMENTS
RESET_PT
ALM_HLP_FILE
ENG_UNITS
RESET_TIMEOUT
ALM_LOW_1
EQUATION
RESOURCE_ID
ALM_LOW_2
FW_CONV_EQ
REV_CONV_EQ
ALM_MSG
GR_SCREEN
ROLLOVER_VAL
ALM_ROUTE_OPER
INIT_VAL
SAFETY_PT
ALM_ROUTE_SYSMGR
JUSTIFICATION
SAMPLE_INTV
ALM_ROUTE_USER
LEVEL
SAMPLE_INTV_UNIT
ALM_STR
LOCAL
SCAN_RATE
ALM_TYPE
LOG_ACK
SETPOINT_HIGH
ANALOG_DEADBAND
LOG_DEL
SETPOINT_LOW
BFR_COUNT
LOG_GEN
TIME_OF_DAY
BFR_DUR
LOG_RESET
TRIG_CK_PT
BFR_EVENT_PERIOD
MAX_STACKED
TRIG_PT
BFR_EVENT_PT_ID
MEASUREMENT_UNIT_ID
TRIG_REL
BFR_EVENT_TYPE
POLL_AFTER_SET
TRIG_VAL
BFR_EVENT_UNITS
PRECISION
UPDATE_CRITERIA
BFR_GATE_COND
PROC_ID
VARIANCE_VAL
BFR_SYNC_TIME
PTMGMT_PROC_ID
VARS
CALC_TYPE
PT_ENABLED
GFK-1180K
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-1180K
Point Type
Device
32 characters
Description
E-17
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
E-18
GFK-1180K
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
Point Type
All
10 characters
Help File
Description
GFK-1180K
E-19
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
E-20
GFK-1180K
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-1180K
Point Type
All
Integer
Description
E-21
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
E-22
GFK-1180K
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-1180K
Point Type
Device
Integer
Description
E-23
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
E-24
Point Type
Device
32 characters
Device ID
Description
GFK-1180K
DISP_LIM_HIGH
Point Type
All
Integer
Description
DISP_LIM_LOW
Point Type
All
Integer
Description
DISP_TYPE
Point Type
CHAR
Display Type
Description
DISP_WIDTH
Point Type
All
Integer
Display Width
Description
ELEMENTS
Point Type
All
Integer
Elements
Description
ENG_UNITS
GFK-1180K
Point Type
All
8 characters
Eng. Units
Description
E-25
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
E-26
Point Type
Number
Initial Value
Description
GFK-1180K
JUSTIFICATION
Point Type
All
Boolean
Justification
Description
LEVEL
Point Type
All
DINT
Level
Description
LOCAL
Point Type
Boolean
Local Value
Description
LOG_ACK
LOG_ACK is not currently supported.
LOG_DEL
LOG_DEL is not currently supported.
LOG_GEN
LOG_GEN is not currently supported.
LOG_RESET
LOG_RESET is not currently supported.
GFK-1180K
E-27
MAX_STACKED
Point Type
All
Integer
Description
MEASUREMENT_UNIT_ID
Point Type
All
32 characters
Measurement Unit ID
Description
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
E-28
GFK-1180K
PTMGMT_PROC_ID
Point Type
14 characters
Point Manager
Description
PT_ENABLED
Point Type
Device
Boolean
Enabled
Description
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
GFK-1180K
Interval
The interval at which the Timer/Counter
point will be updated while the Expression
value remains HIGH.
E-29
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
Set Time
Base start time for the Timer/Counter point
interval.
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
E-30
Point Type
Device
Integer
Description
GFK-1180K
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-1180K
Point Type
Derived (virtual)
32 characters
Reset Point
Description
E-31
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
E-32
Point Type
Derived (virtual)
Integer
Rollover
Description
GFK-1180K
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
Point Type
GFK-1180K
Device
Integer
Scan Rate
Description
E-33
SETPOINT_HIGH
Point Type
All
Integer
Description
SETPOINT_LOW
Point Type
All
Integer
Description
TIME_OF_DAY
TIME_OF_DAY is not currently supported.
TRIG_CK_PT
Point Type
All
32 characters
Availability Trigger
Description
TRIG_PT
Point Type
Device/Derived (virtual)
32 characters
Trigger
Description
E-34
GFK-1180K
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
GFK-1180K
E-35
VARIANCE_VAL
Point Type
Derived (virtual)
Number
Variance value
Description
Point Type
All
Integer
Vars
Description
VARS
E-36
GFK-1180K
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
GFK-1180K
3.
Header
}Field Names
Records
E-37
GFK-1180K
F-1
Modem
Modem
F-2
GFK-1180K
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-1180K
F-3
2.
3.
4.
5.
After the software installation completes, the Remote Access Setup dialog box opens
automatically.
1.
F-4
Click Configure....
GFK-1180K
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.
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.
GFK-1180K
F-5
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.
F-6
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.
GFK-1180K
Note
It is also possible to select Use DHCP to assign remote TCP/IP client
addresses to perform the allocation of IP Addresses.
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.
Click OK to close the dialog box and return to the Services dialog
box.
2.
If you see the message "Remote Access Service is not started on the selected server",
you need to start up the service.
3.
GFK-1180K
F-7
4.
Make sure that all the users who will be dialing in as clients have
Dialin permission.
F-8
GFK-1180K
2.
3.
4.
5.
After the software installation completes, the Remote Access Setup dialog box opens
automatically.
1.
GFK-1180K
Click Configure....
F-9
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.
F-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-1180K
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-1180K
1.
Open My Computer.
2.
3.
Add an entry for the Remote Access Server you want to connect to.
F-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.
F-12
GFK-1180K
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-1180K
F-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).
F-14
GFK-1180K
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 computer's 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-1180K
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.
F-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-1180K
G-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.
G-2
3.
4.
5.
6.
7.
8.
9.
July 2001
GFK-1180K
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.
\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.
GFK-1180K
G-3
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:
G-4
1.
2.
3.
4.
In the New Client dialog box, enter the name of the computer
running the Web Server, then select OK.
5.
July 2001
Select OK.
GFK-1180K
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.
GFK-1180K
G-5
Open the
http://<mycomputer>/CIMPLICITY/HMI/Validate.h
tml 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.ht
ml).
The Validation document opens at the first set of tests.
G-6
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.
July 2001
GFK-1180K
I get the error "Object doesn't 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.
GFK-1180K
G-7
#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.
G-8
July 2001
GFK-1180K
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")
GFK-1180K
G-9
pointGet (Method)
Syntax
pointGet(String cimGate)
[buffered form]
[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);
G-10
July 2001
GFK-1180K
}
else {
document.MyForm.speed.value = document.MyApplet.getPointValue(1);
}
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
GFK-1180K
G-11
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
G-12
July 2001
GFK-1180K
Use an unlicensed version and the accompanying restrictions. See page H-32.
Important: Once you register CIMPLICITY, the registration files, *.key, *.rst,
*.41s and *.ent, must stay in the same place on the hard disk. If you use a utility (e.g.
defragmentation) that changes the location of these files, you will lose your registration.
Consult the utility documentation for possible ways to protect these files.
GFK-1180K
H-1
Prepare for registration to obtain the generated system key code (next).
Step 2.
Task 2.
Task 3.
Task 4.
Task 5.
2.
3.
4.
H-2
July 2001
GFK-1180K
1.
2.
Click Yes
GFK-1180K
H-3
1.
Enter company contact name, company name, address, telephone number, fax
number and email address in the CIMPLICITY Registration: User Information
dialog box.
When you request your System Authorization Code you will need to furnish
your GE Fanuc Automation representative with the information that you enter.
Note: The license is issued to a company, not to an individual.
2.
Click Next.
H-4
July 2001
GFK-1180K
1.
Enter the serial number for your base system in the Serial no. field in the
CIMPLICITY Registration: Serial Numbers dialog box.
You can find the serial number in the CIMPLICITY registration envelope that is
included in the CIMPLICITY system package.
2.
Click Next
GFK-1180K
H-5
Automatically
generated when
correct serial
number is
entered.
Click Next.
Result: The CIMPLICITY Registration System Authorization Code dialog
box opens.
Obtain from
GE Fanuc by
phone or fax.
H-6
July 2001
GFK-1180K
Task 2.
(780) 420-2049
Phone:
(780) 420-2007 or
1-800-647-4196
Email:
Authorization@gefedmonton.ge.com
Faxes and calls received after hours, on weekends, or holidays are processed as soon as
possible on the following business day.
The information you provide GE Fanuc Automation is:
User information, including name, company, street and email addresses and
telephone and fax numbers.
Based on the information you provide your GE Fanuc Automation representative, you
will be given a System Authorization Code.
2.
Select CIMPLICITY>HMI>Registration .
3.
4.
5.
Click Next
The License Agreement dialog box opens.
6.
Click Yes
The CIMPLICITY Registration: Serial Numbers dialog box opens.
GFK-1180K
H-7
7.
Click Next
The CIMPLICITY Registration: Authorization screen opens.
8.
Click Next
The CIMPLICITY Registration: System Authorization Code dialog box opens.
9.
Obtained from
GE Fanuc
through the
Internet or by
phone or fax.
H-8
July 2001
GFK-1180K
Important: Do not change the base serial number when you enter new options through
the CIMPLICITY Registration: Welcome dialog box.
To register the new product option:
1.
2.
3.
Click Add.
The Product Serial Number dialog box opens.
4.
Enter the serial number that appears on the option's License sheet in the Serial
number field.
The name of the option appears in the Product field.
5.
GFK-1180K
Click OK.
H-9
The product option, with an unlicensed status, appears in the Options and
Versions upgrades list in the CIMPLICITY Registration: Welcome dialog box.
6.
Click Next
The CIMPLICITY Registration: License Agreement screen appears.
7.
Click Yes.
The CIMPLICITY Registration: Finish screen appears.
8.
Result: If you display the CIMPLICITY Welcome dialog box after you reboot
you will see that the option's status has changed to Licensed.
H-10
July 2001
GFK-1180K
Contact your distributor for complete information about placing a functional upgrade
order.
To register a functional upgrade:
GFK-1180K
1.
2.
3.
Click Change.
4.
Enter the applicable serial number for the base system you are registering.
5.
Click Next
H-11
Automatically
generated when
correct serial
number is entered
6.
Contact GE Fanuc with the new base serial number and System Key Code to
obtain a new System Authorization Code.
7.
Click Next
8.
Obtained from
GE Fanuc
through the
Internet or by
phone or fax.
9.
Click Next
The CIMPLICITY Registration: Finish screen appears.
H-12
July 2001
GFK-1180K
Note: If you want to add additional options to the functional upgrade, you do not need to
contact GE Fanuc. Simply enter a valid serial number for each option you have purchased
and want to enable. See page H-15 for details.
Note: If you current installation is CIMPLICITY 4.01 in the 90-day warranty period, the
version upgrade is provided at no charge.
If your current version is out of the 90-day warranty period, you must purchase the
version upgrade.
You will receive an upgrade license (either from your distributor or directly from GE
Fanuc) when you purchase an upgrade. Use the Registration program to add the new
license to your current set of installed licenses.
Important: Do not change the base serial number when you enter new options through
the CIMPLICITY Registration: Welcome dialog box.
To upgrade from CIMPLICITY V3.0 or higher:
GFK-1180K
1.
2.
3.
4.
H-13
5.
6.
Click Add.
The Product Serial Number dialog box opens.
7.
8.
Click OK.
The new version, with an unlicensed status, appears in the Options and Versions
upgrades list in the CIMPLICITY Registration: Welcome dialog box.
9.
Click Next
The CIMPLICITY Registration: License Agreement screen appears.
H-14
July 2001
GFK-1180K
Important: If you are upgrading from a version prior to v3.0, you must contact GE
Fanuc for a new serial number and, during installation, for a System Authorization Code.
To upgrade from a CIMPLICITY version that is lower than v3.0:
1.
2.
3.
4.
5.
6.
7.
Click Add.
The Product Serial Number dialog box opens.
8.
GFK-1180K
H-15
9.
Click OK.
The new version, with an unlicensed status, appears in the Options and Versions
upgrades list in the CIMPLICITY Registration: Welcome dialog box.
Automatically
generated when
correct serial
number is entered
Serial numbers for any other CIMPLICITY product options in use on the
system you are upgrading
H-16
July 2001
GFK-1180K
Obtained from
GE Fanuc
through the
Internet or by
phone or fax.
Note: If you want to add additional options to the functional upgrade, you do not need to
contact GE Fanuc. Simply enter a valid serial number for each option you have purchased
and want to enable. See page H-15 for details.
GFK-1180K
H-17
2.
Select CIMPLICITY>HMI>Registration
Check Transfer.
4.
Click Next.
The CIMPLICITY Registration: License Agreement screen appears.
5.
Click Yes.
The CIMPLICITY Registration: Transfer dialog box opens.
6.
H-18
July 2001
GFK-1180K
7.
Click Next.
The CIMPLICITY Registration: Transfer Using Network dialog box appears.
8.
Check The windows directory of the target system is available from this
system via the network.
The Target windows directory field is enabled.
9.
Enter the path for the Windows directory (e.g. WINNT) in the Target windows
directory field.
Tip: Map the network drive in the File Explorer if the windows directory of the
target system is not available from this system.
GFK-1180K
H-19
H-20
1.
2.
July 2001
GFK-1180K
Step 2.
Step 3.
Task 2.
Insert a floppy disk in the floppy disk drive on the target computer.
2.
Begin registration the same as you would for a new registration as follows:
A. Click Start on the Windows task bar.
B. Select CIMPLICITY>HMI>Registration
5.
Click Next.
The CIMPLICITY Registration: License Agreement screen appears.
GFK-1180K
H-21
6.
Click Yes
The CIMPLICITY Registration: User Information screen appears.
7.
Enter user information the same as you would for a new registration.
8.
Click Next.
The CIMPLICITY Registration: Transfer screen appears.
9.
H-22
July 2001
GFK-1180K
Make sure that Target System and Step 1: Register the Diskette are checked
on the CIMPLICITY Registration: Transfer Using Floppy Disk screen
2.
Click Next.
The CIMPLICITY Registration: Register diskette screen appears.
3.
Click
GFK-1180K
H-23
4.
5.
Click OK.
CIMPLICITY registers the diskette.
Remove the diskette from the target system and bring it to the source system.
Note: Leave the CIMPLICITY Registration: Register diskette screen displaying on the
target computer.
H-24
July 2001
GFK-1180K
2.
3.
Select CIMPLICITY>HMI>Registration.
The CIMPLICITY Registration: Welcome dialog box appears.
4.
Check Transfer.
5.
Click Next.
The CIMPLICITY Registration: License Agreement screen appears.
6.
Click Yes.
The CIMPLICITY Registration: Transfer screen appears.
7.
8.
Click Next
GFK-1180K
H-25
Click
H-26
July 2001
GFK-1180K
GFK-1180K
H-27
Tip: Click View license status on the CIMPLICITY Registration: Finish screen to
make sure that the source computer is now unlicensed.
Important: If you wish to continue to run fully functional CIMPLICITY software on the
source computer, contact your distributor to purchase additional licenses.
H-28
July 2001
GFK-1180K
2.
3.
Click Next.
The CIMPLICITY Registration: Authorization from the diskette screen
appears.
GFK-1180K
H-29
4.
Click
H-30
July 2001
GFK-1180K
5.
Click Next.
The CIMPLICITY Registration: Finish screen appears informing you that you
successfully transferred your CIMPLICITY HMI software to the target system.
6.
Click Finish.
7.
Reboot the newly licensed computer for the changes to take affect.
Result: The target computer can now function as the registered CIMPLICITY
HMI source.
GFK-1180K
H-31
Run the CIMPLICITY Demo project or any other existing project for two (2)
hours.
An unlicensed device communications enabler (devcom) will run for only two
hours regardless of whether the base system has been licensed or not.
2.
Select CIMPLICITY>HMI>Registration
Check Unregister.
4.
Click Next.
A CIMPLICITY Registration message appears.
5.
Click Yes if you are certain you want to remove the CIMPLICITY registration.
Result: CIMPLICITY registration is removed from your system. If you need to reregister, contact GE Fanuc.
H-32
July 2001
GFK-1180K
Appendix I - Removing
CIMPLICITY Software
GFK-1180K
1.
2.
3.
4.
Click Add/Remove.
5.
I-1
2.
Select Settings.
3.
4.
I-2
5.
6.
Click Add/Remove.
7.
July 2001
GFK-1180K
Appendix J - Resolving
Problems
.OUT and .ERR files for all CIMPLICITY HMI processes other
than user processes
GFK-1180K
J-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:
J-2
Date/Time
Status
Process
Procedure
Source
Code
The primary value used by software for expressing the type of error.
Reference
Message
July 2001
GFK-1180K
Each entry in the list is preceded by a color-coded dot that corresponds to the
Status field entry. The correlations are:
Red - Failure
Yellow - Warning
Green - Success
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-1180K
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 project's Status Log file will
automatically be displayed.
J-3
J-4
Select Log
Save as Text...
Print...
Print Preview...
Print Setup...
Exit
July 2001
GFK-1180K
Filter Entries...
Find...
Find Next
Detail...
Live Update
Refresh
Toolbar
Status Bar
GFK-1180K
Help Topics
J-5
Save
J-6
Ctrl+P
F3
Finds the next Status Log message that fits the search criteria.
Ctrl+D
Ctrl+L
Ctrl+R
July 2001
GFK-1180K
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 project's log directories.
To display a log file:
GFK-1180K
1.
2.
Click OK.
3.
The dialog box closes, and the file you selected is displayed in the
CIMPLICITY Log Viewer window.
J-7
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.
J-8
Date
Time
Status
Code
The primary value used by the software for expressing the type
of error.
PID
Process
Procedure
Source:
Reference
Error Message
July 2001
GFK-1180K
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 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.
GFK-1180K
J-9
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.
J-10
July 2001
GFK-1180K
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
GFK-1180K
J-11
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.
J-12
July 2001
GFK-1180K
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.
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.
GFK-1180K
J-13
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.
J-14
July 2001
GFK-1180K
GFK-1180K
1.
2.
Use the Explorer to check for any non-zero length .ERR and
.OUT files in the main log directory.
3.
J-15
Associated Process
Allen-Bradley Ethernet device communications where <n> is the
port number
Serial device communications where <n> is the port number
Alarm Manager
Data Logger
Dynamic Configuration
Basic Control Engine
Point Data Logger
Virtual Point Processor
Point Manager
Point Translation
User Registration
Point Bridge
Genius device communications where <n> is the port number
Series 90 TCP/IP device communications where <n> is the port
number.
Series 90 TCP/IP redundancy where <n> is the port number.
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 project's log directory.
3.
J-16
July 2001
GFK-1180K
Index
#
#ERROR!ARRAYNOTALLOWED G-7
#ERROR!ARRAYOUTOF BOUNDS G-7
#ERROR!BADSERVERRESPONSE G-7
#ERROR!CIMPLICITYNOTRUNNING G-7
#ERROR!INVALIDPOINTID G-8
#ERROR!NOTIMPLEMENTED G-8
#ERROR!NOTLICENSED G-8
#ERROR!POINTIDSYNTAX G-8
#ERROR!POINTUNAVAILABLE G-8
#ERROR!SERVERNEEDSRESTART G-8
#ERROR!URLEXCEPTION G-8
$
$ADDRESS
Class attribute 11-16
$ADDRESS_ADJ
Numeric data item 11-37
$ALARM.ACKED 13-2
$ALARM.ACTIVE 13-2
$ALARM.TOTAL 13-2
$ALARM.UNACKED 13-2
$ALARM_DELAY
Numeric data item 11-37
$ALARM_DISABLED 20-2
$ALARM_ENABLED 20-2
$ALARM_HIGH
Numeric data item 11-37
$ALARM_LOW
Numeric data item 11-37
$ALARM_MODIFIED 20-2
$ALARM_RAWLIM 20-2
$ALARM_RESTORED 20-2
$AM_STATUS 20-2, 1-14
$CLASS 11-32
$CLASS_<Alarm class name>.ALARMS 13-2
$CLASS_<Alarm class name>.UNACKED 13-2
GFK-1180K
$CONV_LIMIT_HIGH
Numeric data item 11-37
$CONV_LIMIT_LOW
Numeric data item 11-37
$DESCRIPTION
Class attribute 11-16
$DEV_DOWN 20-3
$DEVICE 20-2
$DEVICE_DOWN 20-2
$DEVICE_FAILOVER 20-3
$DEVICE_ID
Class attribute 11-16
$DISPLAY_HIGH
Numeric data item 11-37
$DISPLAY_LOW
Numeric data item 11-37
$DL_FILE_FULL 20-3
$DOWNLOAD 20-3
$DYN_CFG 20-3
$EU_LABEL
Class attribute 11-16
$FORMAT_JUST
Numeric data item 11-37
$FORMAT_PREC
Numeric data item 11-37
$FORMAT_WIDTH
Numeric data item 11-37
$GMR_POINT_DISCREPANCY 20-3
$ID 11-32
$LEVEL
Class attribute 11-17
Numeric data item 11-37
$LOCAL.COMPUTER 13-2
$LOCAL.DATE.AMPM 13-3
$LOCAL.DATE.DAY 13-3
$LOCAL.DATE.DAYOFWEEK 13-3
$LOCAL.DATE.DAYOFYEAR 13-3
$LOCAL.DATE.HOUR 13-3
$LOCAL.DATE.HOUR12 13-3
$LOCAL.DATE.MINUTE 13-3
$LOCAL.DATE.MONTH 13-4
$LOCAL.DATE.SECOND 13-4
$LOCAL.DATE.SECONDOFDAY 13-4
$LOCAL.DATE.WEEK 13-4
$LOCAL.DATE.YEAR 13-4
$LOCAL.DATETIME 13-4
$LOCAL.WINUSER 13-4
$LOGON 20-3
$LOGOUT 20-3
$OBJECT 11-32
Used in a Class CimEdit screen 11-68
$PROJECT 13-5
$PROJECT.AVAILABLE 13-5
$PROJECT.COMPUTER 13-5
$PROJECT.DATE.AMPM 13-5
Index-i
$PROJECT.DATE.DAY 13-5
$PROJECT.DATE.DAYOFWEEK 13-5
$PROJECT.DATE.DAYOFYEAR 13-6
$PROJECT.DATE.HOUR 13-6
$PROJECT.DATE.HOUR12 13-6
$PROJECT.DATE.MINUTE 13-6
$PROJECT.DATE.MONTH 13-6
$PROJECT.DATE.SECOFDAY 13-6
$PROJECT.DATE.SECOND 13-6
$PROJECT.DATE.WEEK 13-7
$PROJECT.DATE.YEAR 13-7
$PROJECT.DATETIME 13-7
$PROJECT.DEVICES 13-7
$PROJECT.LOGGEDIN 13-7
$PROJECT.USERS 13-7
$RANGE_HIGH
Numeric data item 11-37
$RANGE_LOW
Numeric data item 11-37
$RAW_LIMIT_HIGH
Numeric data item 11-37
$RAW_LIMIT_LOW
Numeric data item 11-37
$RAW_VALUE
Point attributes 10-22
$REDUND_DEV_DOWN 20-3
$RESOURCE_ID
Class attribute 11-17
$ROLE 13-8
$ROLE.LEVEL 13-8
$RTR_LINK_DOWN 20-3
$SCREEN_ID
Class attribute 11-17
$SETPOINT_HIGH
Numeric data item 11-37
$SETPOINT_LOW
Numeric data item 11-37
$TREND_DURATION
Numeric data item 11-37
$TREND_SAMPLES
Numeric data item 11-37
$USER 13-8
$USER.ALARMS 13-8
$WARNING_HIGH
Numeric data item 11-37
$WARNING_LOW
Numeric data item 11-37
%
%% 8-15
%DEV_AMT 8-15
%DEV_VAL 8-15
%EU 8-15
%ID 8-15
Index-ii
%LIMIT 8-15
%STATE 8-15
%VAL 8-15
.
.soc File
Imported into a project 12-5
.wav
Alarm hardware requirements 21-1
Stop for an alarm 21-9
_
_ENG
In Data Report 26-117
_PREV
In Data Report 26-117
_RAW
In Data Report 26-117
_RES
In Data Report 26-117
{
{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 21-1
Alarm blocking 22-1
Alarm classes 18-1
Alarm printer configuration 23-1
Alarms 20-1
CIMPLICITY HMI and Control C-1
CIMPLICITY HMI log files J-1
Classes 11-1
Client configuration 28-1
Database logging, Managing 27-1
Devices 15-1
Measurement units 31-1
Microsoft System Management Server 33-10
Point control panel 30-1
Ports 17-1
GFK-1180K
RAS F-1
Resources 16-1
Roles 24-1
Security features 33-18
System Utilities 32-1
WebGateway G-1
About Alarm Strings 19-1
About CimView 29-1
About System Management 33-1
About the CIMPLICITY To Windows Server B-1
About Users 25-1
Absolute Alarming 8-21
Access
Runtime monitoring 2-32
ACCESS
Import/export fields E-17
Access CIMPLICITY service
Automatic report printing 26-124
Access to Manual Mode 6-44
ACCESS_FILTER
Import/export fields E-17
ACCESS_FLAG
Point attributes 10-23
ACK_TIMEOUT
Import/export fields E-17
ACK_TOUT 1-14
Point attributes 10-23
Acknowledgement
Automatic for alarms 8-34
Actions
Configure for a class 11-53
Create for a class 11-52
Device properties, CIMPLICITY HMI and Control
C-4
In classes 11-50
Activate
Dynamic configuration 2-27, 26-16
Active Measurement System
About 31-12
Defining in Measurement Units 31-12
Defining in Project Properties 31-13
Add
Class object to project 12-10
Custom class attribute 11-17
Data items 11-26
Global parameter value 1-7
Project to CIMPLICITY options list 3-14
Subsystems to PtXRef database 14-11
Add Point
Button 30-12
Add Points
Manual in the Point Control Panel 30-19, 30-25
GFK-1180K
Index
Index-iii
Alarm blocking
About 22-1
Alarm assignment 22-2
Alarm priorities 22-2
Blocking modes 22-2
Configuring 22-4
Rules for 22-3
Alarm Blocking Configuration
Opening an existing dialog box 15-4, 19-5, 22-5, 23-3
Alarm blocking group
Adding an alarm 22-7
Modifying an alarm 22-8
Removing an alarm 22-7
Alarm Blocking Group
Creating 22-4
Alarm Class
Color assignments 18-9
Colors 18-5
Default alarm color mappings 18-9
ID 18-4
Map new colors 18-9
Open configuration dialog 18-2
Sound 18-6
Specifications 18-4
Alarm class Configuration
Mapping colors in rgb.dat 18-9
Alarm classes
About 18-1
Alarm Classes
About 18-1
Configure 18-2
Alarm comments
More about 20-11
Alarm Configuration 20-1
Creating A New Alarm Definition 20-4
Modifying an existing alarm 20-5
Setting runtime alarm properties 20-11
Alarm Definition
Alarm Options Properties 20-10
Alarm Definitions
Standard Alarms 20-2
Alarm ID
In Alarm Report 26-123
Alarm Limit Changed
Icon 30-27
Alarm Logs
Database Logger defaults 26-25
Alarm Options Properties 20-10
Alarm printer configuration 23-1
About 23-1
Adding an alarm printer 23-2
Additional steps for serial printers 23-11
Date/time format properties 23-8
Date/time formats 23-9
Delete and acknowledge times 23-13
Index-iv
GFK-1180K
ALARM_LOG
Add alarms through Database Logger 26-74
Configure logging conditions for single alarm 26-83
Logging conditions 26-77
Logging properties 26-80
Maintenance actions 26-80
Maintenance events 26-79
Open 26-76
Overview 26-69
System alarms 26-71
Table logging attributes 26-78
Tasks to configure properties 26-75
ALARM_LOW B-5
Point attributes 10-25
alarm_message
In Alarm Report 26-123
ALARM_SAVE_COMMENTS 1-14
ALARM_STATE
Point attributes 10-26
Alarms
About 20-1
Absolute 8-21
Add to logging through Database Logger 26-74
Advanced tab 8-13
Basic limits 8-12
Basic message 8-11
Class and alarm message 8-16
Class configuration 8-18
Configure a connection 26-75
Deadband 8-29
Define advanced message 8-15
Definition 8-14
Delay 8-26
Deletion 8-36
Deviation 8-22
Help file 8-29
Logging conditions 26-77
Maximum stack 8-36
Mute sound 21-9
On update 8-23
Open log report 26-121
Rate of change 8-24
Removing roles 8-31
Repeats 8-34
Report logged data 26-121
Roles assigned to 8-30
Routing 8-30
Setting options 8-33
Table indexes columns rows 26-72
Table logging attributes 26-78
Table schema 26-72
Timed/gated maintenance notes 26-51
View logged data 26-123
GFK-1180K
Index
Index-v
AMLP_USE_RESET_TIME 1-18
AMSI_ALARM 20-3
Analog
Virtual point initialization 7-6
Analog Deadband 6-23
ANALOG_DEADBAND
Import/export fields E-21
Point attributes 10-26
appendCaption (Method)
WebGateway, Web data applet G-9, G-10, G-11
Application Logging
Overview 26-109
Application Logs
Database Logger defaults 26-25
Application privileges
Point by address 24-5
Application Privileges 24-4
Delete alarms 24-4
Dynamic configuration 24-4
Level 24-5
Modify alarms 24-4
Modify manual mode 24-5
Process control 24-4
Script control 24-5
Set point 24-5
Setpoint audit trail 24-5
Trigger event 24-5
Application Source Directory Creating
Site wide installation 33-13
Applications
Table indexes columns rows 26-109
Apply
Point attributes 10-11
Architecture Integration
Machine Edition point data D-2
Area Resource Security Privilege 24-6
Arithmetic
Operators and custom conversion 6-36
Operators for expressions 7-50
Array
Limits for device points 6-7
Array Point Example - CWSERV B-11
Array Tab
In the Point Control Panel 30-30
Arrays
And histogram points 7-42
Device arrays in Alarm Viewer 6-6
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 CimEdit 7-5
Virtual arrays in CimView 7-5
Index-vi
GFK-1180K
Automatic Actions
For alarms 8-33
Automatically Print Report
Script example 26-126
Trigger report event 26-128
Availability Triggers
For device points 6-17
For virtual points 7-15
Average Points 7-29
B
Background
Changing color in the Point Control Panel 30-17
Background Color
For alarm class 18-5
For point alarm class 8-19
Base Engineering Units
For a device point 6-31
Base Rate
And scan rate 6-23
Basic
Alarm limits 8-12
Device custom addressing 6-8
Device point configuration 6-3
Virtual point configuration 7-3
Basic Control Engine
Guideline for measurement units 31-19
Beep
Alarm hardware requirements 21-1
Sound for an alarm 18-8
Stop for an alarm 21-9
Before you start
RAS F-3
Begin
Point cross reference 14-2
BEU
For a device point 6-31
BFR_COUNT
Import/export fields E-21
BFR_DUR
Import/export fields E-22
BFR_EVENT
Import/export fields E-22
BFR_EVENT_PT_ID
Import/export fields E-22
BFR_EVENT_TYPE
Import/export fields E-22
BFR_EVENT_UNITS
Import/export fields E-22
BFR_GATE_COND
Import/export fields E-22
BFR_SYNC_TIME
Import/export fields E-23
BIND_ADDR 1-18
GFK-1180K
Index
Bitwise
Operators and custom conversion 6-36
Operators for expressions 7-51
Blank
Point cross reference window 14-3
Blink
For alarm class 18-5
For point alarm class 8-19
Blocking modes
Alarm blocking 22-2
Blocking rules
Alarm blocking 22-3
BOOL 6-5
Boolean
Virtual point initialization 7-6
Broadcast
Machine Edition product integration D-4
Browse
Open window 2-13
Browser
And point attributes 10-11
Browser for Points
For the Point Control Panel 30-12
Browser Windows
Point search aids in the Workbench 9-5
BSM_PTM_APPQ 33-2
BSM_PTM_AQ_CNT4DROP 33-3
BSM_PTM_AQ_PERIOD 33-3
Buffering
For device points 6-18
For virtual points 7-16
Build
Point cross reference database 14-3
Bulk Insertion
Insert triggers 26-3
Peak performance Database Logger 26-3
Button
Add Point 30-12
Build PtXRef database 14-3
Delete point 30-18
Disable Alarm 30-28
Disable Manual Mode 30-21
Edit Point 30-24
Enable Alarm 30-29
Enable Manual Mode 30-20
Limits 30-27
One page 30-9
Point Properties 30-22
Two pages 30-9
View options 14-7
BYTE 6-5
Index-vii
C
CALC_TYPE
Import/export fields E-23
Calculation
Average points 7-29
Delta Accum array 7-26
Delta Accum points 7-22
Equation 7-20
Equation w/override points 7-37
Histogram 7-42
Max capture point 7-31
Min Capture point 7-33
Timer/counter point 7-40
Trans High Accum point 7-35
Value Accum point 7-27
CALCULATION_TYPE
Point attributes 10-27
Calendar
Area resource security privilege 24-6
Configuration privileges 24-6
Privileges 24-6
Capabilities
Workbench 2-1
Categorize points 4-2
CE_MAX_DELAY 1-19
CE_MAX_THREADS 1-19
CE_THREAD_TIMEOUT 1-19
Change
A CIMPLICITY HMI project name 2-20
Global parameter value 1-4
Point through point cross reference window 14-10
Project in point cross reference window 14-13
Select existing record or file 2-30
Change View Options
Show Users 32-4
Characters
Reserved when naming points 4-4
Charts In Trend reports 26-121
Check Box
Enable tree text view 14-7
Show only used points 14-7
Sort on 14-7
Choose
Fields 2-15
CimEdit
A screen for class 11-64
Configure a screen for a class 11-65
Display screen for a class object 12-13
CimEdit Management of Animated Objects
Guideline for measurement units 31-17
CIMHOSTS.TXT
Configuring for RAS F-13
Index-viii
GFK-1180K
CIMPLICITY Software
Copying a project to diskette 3-27
Creating a remote project 33-26
How configuration updates are handled 3-24
Logging in 3-25
New project options 3-9
Remote projects 33-25
Removing Windows 95 Registry Information 33-7
Removing Windows NT Registry Information 33-8
Setting project properties 3-3
CIMPLICITY to Windows Server B-1
Displaying point data B-6
Point Topic Attributes B-3
CIMPLICITY To Windows Server
About B-1
Command syntax for System topic B-13
Creating A DDE Share B-15
CWSERV Command Syntax B-1
CWSERV Icon B-7
Error Messages B-15
Formats command syntax B-13
Help command syntax B-14
Implementing a Setpoint macro B-9
Macro format for modifying point data B-8
Microsoft Excel Example B-2
Modifying Point Data B-8
Performance considerations B-8
Referencing CWSERV from a Networked NT
Client B-16
Remote Access of CWSERV on Windows NT B-15
Sample CWSERV Commands B-2
Sample spreadsheets and macros B-10
Starting CWSERV B-7
System command syntax B-13
Topics command syntax B-13
Using with Microsoft Excel B-6
CIMPLOG.MDB 26-25
CimView 29-1
About 29-1
Associate a screen with a point 8-2
Executing in-place edit setpoint actions 29-15
Executing Slider Setpoints 29-13
Open 29-2
Opening a screen 2-33
Screen for a selected point 2-36
Selecting setpoint object with keyboard 29-14
Selecting setpoint object with mouse 29-14
Trigger log report 26-129
CimView Autostart
Disable Microsoft network login prompt 3-18
Windows 98 3-18, 3-20
CimView Scripts
Guideline for measurement units 31-18
GFK-1180K
Index
Class
About 11-1
Actions 11-50
Add custom attribute 11-17
Add new data item 11-26
Address adjustment expressions 11-41
Assign object properties in CimEdit 11-71
Attribute properties 11-18
Attributes 11-15
CimEdit screen 11-64
CIMPLICITY attribute as the default 11-29
CIMPLICITY attributes 11-16
Colors for alarm class 18-5
Colors for point alarm class 8-19
Configuration steps 11-7
Configure a CimEdit screen 11-65
Configure actions 11-53
Configure an event for 11-60
Configure for alarms 18-2
Configure specifications for alarms 18-4
Configuring 11-1
Create 11-13
Create a script for 11-48
Create actions 11-52
Create event for 11-59
Create numeric expressions 11-38
Create string expressions 11-34
Custom attributes 11-17
Data Item options 11-44
Data items 11-24
Data Items, Configuration options 11-27
Delay-load data items 11-44
Dynamic configuration 2-27
Events 11-57
Export 11-78
Expressions 11-32
For alarms 8-16
ID for alarm class 18-4
Import into a project 12-5
Just-in-time data items 11-44
Map colors for alarms 18-9
Member type chart 11-1
Name object in CimEdit 11-68
New attribute 11-17
Object Builder group 11-21
Open Alarm Class dialog 18-2
Plan 11-8
Priority for alarm sound 21-7
Rgb.dat colors and alarms 18-9
Scripts 11-46
Write scripts for 11-49
Index-ix
Class Attribute
$ADDRESS 11-16
$DESCRIPTION 11-16
$DEVICE_ID 11-16
$EU_LABEL 11-16
$LEVEL 11-17
$RESOURCE_ID 11-17
$SCREEN_ID 11-17
Class Object
Add to project 12-10
Assign attribute values 12-8
Configuration steps 12-5
Configure properties 12-8
Create 12-7
Create CimEdit screen 12-13
Dialog box tabs 12-8
General values 12-10
Object evolution 12-3
Overview 12-2
Class Objects
Definitions 12-2
Class-Object
Evolution and construction overview 11-2
clearPoints (Method)
WebGateway, Web data applet G-11
CLIE See Import/Export
export command E-11
Import command E-8
Client configuration
About 28-1
Client properties 28-3
Client package Distribution
How it works 33-11
Client properties
Client configuration 28-3
Client Properties
Open dialog box 28-3
Client setup
RAS, Windows 95 F-11
RAS, Windows NT F-9
Close
Database Logger Configuration window 26-20
Logging table in Database Logger 26-19
Project view in Show Users 32-8
The Point Control Panel 30-11
CLR_TOUT 1-19
Point attributes 10-27
Collapse
Left pane view 2-7
Color
Assignments for alarm class 18-9
Color Assignments
Alarm class configuration 18-9
Index-x
Colors
Changing in the Point Control Panel 30-17
For alarm class 8-19, 18-5
Columns
In alarm logging tables 26-72
In application logging tables 26-109
In data logging tables 26-31
In event logging tables 26-88
In Event Manager logging tables 26-100
In group logging tables 26-58
Number allowed in log table 26-9
Combining triggers
Database Logger 26-39
Command Line Options
startup.exe 3-28
Command Syntax for System Topic B-13
Formats B-13
Help B-14
System B-13
Topics B-13
Common point properties
Device properties, CIMPLICITY HMI and
Control C-4
Compact
Width for an analog point 8-5
Components
WebGateway G-3
Workbench 2-3
Computer
Transfer license from one to another H-21
Transfer license via the network H-18
Conditions
For logging alarms 26-77
Configuration
Class objects 12-5
Data items 11-27
Database Logger hierarchy 26-5
Device point overview 6-1
Dynamic 2-27
Dynamic for Class 2-27
Dynamic for port 2-27
Dynamic in Database Logger 26-16
Dynamic restrictions for point 2-27
Steps for class 11-7
Update 2-26
Virtual point overview 7-1
Configuration Import/Export See Import/Export
Configuration Privileges 24-7
GFK-1180K
Configure
Alarm class specifications 18-4
Alarm classes 18-2
Alarm Logging properties 26-75
Alarm Sound Manager project priority 21-4
Blink for alarm class 18-5
Blink for point alarm class 8-19
Class 11-1
Colors for alarm class 18-5
Colors for point alarm class 8-19
Event action logging properties 26-103
Event alarm Logging properties 26-91
Global parameters 1-3
Group point logging properties 26-60
Point data logging properties 26-35
Projects for Alarm Sound Manager 21-4
Configure Properties
Class object 12-8
Configuring
Data items 11-24
Configuring a Port 17-2
Configuring additional Locks
SQL Server 27-9
Configuring alarm blocking 22-4
Configuring Alarm Strings 19-3
Configuring automatic startup
RAS, Windows NT server F-7
Configuring Point Bridge Points 33-29
Configuring Resources 16-2
Connect
Quick device connect for a project 5-3
CONNECT_DROP_PERIOD 1-20
CONNECT_RETRY_PERIOD 1-20
Connecting to a Computer
CIMPLICITY options 3-14
Connection
For group point logs 26-65
Connectivity
Enterprise Server and Machine Edition D-2
Viewer and Machine Edition D-3
Contacting your distributor 1-1
Control properties
Actions C-4
Common point properties C-4
Device properties, CIMPLICITY HMI and
Control C-2
Import options C-3
CONV_LIM_HIGH
Import/export fields E-23
CONV_LIM_LOW
Import/export fields E-23
CONV_TYPE
Import/export fields E-24
Point attributes 10-27
GFK-1180K
Index
Conversion
Custom for a device point 6-35
Device points 6-29
Linear for a device point 6-35
Operators for expressions 7-52
Tab for device points 6-30
Converted values
Linear device point conversion 6-34
Copy
Database Logger table 26-12
Project to a new project 2-19
Copy of Point Control Panel File
Save 30-8
Copying a Project to Diskette 3-27
Create
A new Point Control Panel file 30-4
Class 11-13
Class object 12-7
New alarm class 18-2
New device point 6-2
New record or file 2-29
New virtual point 7-2
Numeric expressions in classes 11-38
Set for point enumeration 6-38
String Expression in a class 11-34
Creating
Alarm Block Group 22-4
Role 24-2
Creating a DDE Share B-15
Creating A New Alarm Definition 20-4
Creating A New Alarm String 19-4
Creating a new device 15-2
Creating A New Port 17-3
Creating a New Project
Options 3-9
Creating A New Remote Project 33-26
Creating a new user 25-3
Creating a resource 16-2
Creating tables
Database logger, Column definitions 27-13
Database logger, Key definitions 27-14
Creating Tables
Database logger 27-13
Criteria
For an alarm 8-21
Update for a device point 6-10
CSV file format E-2
Custom Attributes
Class 11-17
Custom Conversion for a device point 6-35
Custom HTML pages, Troubleshooting
WebGateway G-7
Customer support 1-2
Customize
Workbench point list 9-1
Index-xi
CWSERV
Command Syntax B-1
Command syntax for System topic B-13
Creating a DDE Share B-15
Displaying Point Data B-6
Error Messages B-15
Formats command syntax B-13
Help command syntax B-14
Icon B-7
Implementing a Setpoint macro B-9
Macro format for modifying point data B-8
Microsoft Excel Example B-2
Modifying Point Data B-8
Performance considerations B-8
Point Topic Attributes B-3
Referencing from a Networked NT Client B-16
Remote Access of CWSERV on Windows NT B-15
Sample Commands B-2
Sample spreadsheets and macros B-10
Spreadsheet example with array point B-11
Spreadsheet example with single point B-10
Starting B-7
System command syntax B-13
Topics command syntax B-13
Using with Microsoft Excel B-6
CWSERV Attributes
ALARM_ENABLED B-6
ALARM_HIGH B-5
ALARM_LOW B-5
DISP_FORMAT B-4
DISP_HIGH B-5
DISP_LOW B-5
ELEMENTS B-4
EU_LABEL B-5
INIT_STATE B-6
LENGTH B-4
RAW_VALUE B-3
SIZE B-4
STATE B-3
TYPE B-4
VALUE B-3
WARN_ENABLED B-6
WARNING_HIGH B-5
WARNING_LOW B-5
D
DARP_LVV_USECURRENT 1-20
DARP_STARTUP_INTERVAL 1-21
Data
Enable stale 17-6
Logging overview 26-30
Logs for device points 6-19
Logs for virtual points 7-17
Index-xii
Data Item
String expressions 11-32
Data Item Numeric
$ADDRESS_ADJ 11-37
$ALARM_DELAY 11-37
$ALARM_HIGH 11-37
$ALARM_LOW 11-37
$CONV_LIMIT_HIGH 11-37
$CONV_LIMIT_LOW 11-37
$DISPLAY_HIGH 11-37
$DISPLAY_LOW 11-37
$FORMAT_JUST 11-37
$FORMAT_PREC 11-37
$FORMAT_WIDTH 11-37
$LEVEL 11-37
$RANGE_HIGH 11-37
$RANGE_LOW 11-37
$RAW_LIMIT_HIGH 11-37
$RAW_LIMIT_LOW 11-37
$SETPOINT_HIGH 11-37
$SETPOINT_LOW 11-37
$TREND_DURATION 11-37
$TREND_SAMPLES 11-37
$WARNING_HIGH 11-37
$WARNING_LOW 11-37
Data Items
Add new 11-26
Class 11-24
Configuration 11-27
Configuring 11-24
Delay-load 11-44
Options 11-44
Supported string substitution 11-33
Data log
Add points through Database Logger 26-33
Logging conditions 26-36
Open 26-35
Tasks to configure properties 26-35
Data Log
Configure logging conditions for single point 26-50
Logging properties 26-45
Maintenance actions 26-43
Maintenance events 26-41
Table logging attributes 26-40
Data log table
Add points through Point Properties dialog 26-32
Data Table
Deadband 26-37
Schema 26-31
Data Triggered Logging
For group point logging 26-37, 26-62
For point data 26-36
GFK-1180K
Data Type
3D_BCD 6-4
4D_BCD 6-4
Bool 6-5
BYTE 6-5
Device point 6-3
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-3
WORD 6-5
DATA_LOG
Add point alarms through Point Properties
dialog 26-73
Database
Point cross reference 14-3
Point data logs 26-46
Reconcile with table in Database Logger 26-17
Supported interfaces for logging 26-1, 26-2
Database disconnect recover
Database logger 27-15
Database disconnect recover, Enabling store and
forward 27-16
Database disconnect recover, Reconnect wait
period 27-15
Database disconnect recover, Store and forward 27-15
Database disconnect recover, Store and forward changing defaults 27-18
Database disconnect recover, Store and forward maximum records 27-18
Database disconnect recover, Store and forward
filenames 27-17
Database logger
Creating tables, Column definitions 27-13
Creating tables, Key definitions 27-14
Database disconnect recover, Enabling store and
forward 27-16
Database disconnect recover, Reconnect wait
period 27-15
Database disconnect recover, Store and forward 27-15
Database disconnect recover, Store and forward changing defaults 27-18
Database disconnect recover, Store and forward maximum records 27-18
Database disconnect recover, Store and forward
filenames 27-17
GFK-1180K
Index
Index-xiii
Datadirect
Merant driver for Oracle 27-6
Date/time format properties
Alarm printer configuration 23-8
Date/time formats
Alarm printer configuration 23-9
DB_CLOCK_ADJUSTMENT_MONITOR 1-21
DB_COMPACT_QUEUE_SIZE 1-21
DB_CONN_DOWN 20-3
DB_COUNTER_FIELD 1-22
DB_DBMS_QUEUE_SIZE 1-22
DB_DEBUG 1-23
DB_ENABLE_MSEC 1-23
DB_ENABLE_TRANSACTIONS 1-25
DB_MSEC_FIELD 1-25
DB_POINT_ID_FIELD 1-26
DB_PROJECT_FIELD 1-26
DB_QUEUE_OVERFLOW_DELAY 1-27
DB_QUEUE_SIZE 1-27
DB_START_FORWARD 20-3
DB_STATUS_LOG_OFF 1-27
DB_TABLE_FAILURE_RETRY 1-28
DB_TIME_FORMAT 1-28
DB_TIMESTAMP_FIELD 1-29
DB_TIMESTAMP_FILTER 1-30
DB_TIMESTAMP_PRECISION 1-30
DBDL_DEVICE_CHECK_PERIOD 1-31
DC_RETRY_ONE_DEVICE 1-31
Deadband
And alarms 8-29
In database logging 26-37
DEADBAND
Point attributes 10-28
Default Color Mappings
Alarm class 18-9
Default Logging Properties
Database Logger 26-21
Default Parameters
For Database Logger 26-22
Default User 25-1
Defaults
Alarm logging 26-25
ALARM_LOG logging properties 26-81
Application logging 26-25
Configuration level 1 in Database Logger 26-6
Configuration level 2 in Database Logger 26-6
Configuration level 3 in Database Logger 26-7
Event logging 26-25
Group point logging 26-28
Point connection 26-66
Point data connection 26-46
point logging 26-28
Defining a resource
Properties 16-3
Index-xiv
Definitions
Class 11-81
Class objects 12-2
For fields displayed in the Workbench 9-8
DEL_OPT 1-31
Point attributes 10-28
Delay
Alarms 8-26
Delay Load
For device points 6-23
Delay Load Function
Explanation for device points 6-28
Delay-Load Data Items 11-44
Delete
Global parameter 1-9
Table in Database Logger 26-14
Delete Alarm privilege 24-4
Delete and acknowledge times, Modifying
Alarm printer configuration 23-13
Delete Point
Button 30-18
Delete Points
From the Point Control Panel 30-18
Delete Records
Maintenance action 26-43
DELETE_REQ
Import/export fields E-24
Deleting a user from a resource 16-4
Deleting configuration data
Import/Export E-14
Deleting Login Information 33-6
Deletion
Alarms 8-36
Delta Accum Array 7-26
Delta Accum Points 7-22
Derived Points
Guideline for measurement units 31-16
DESC E-37
Import/export fields E-24
Description
Event alarm definition 20-5
Of Workbench parts 2-3
DESCRIPTION
Point attributes 10-28
Detail Tab
In the PCP 30-22
DEV_ID 8-15
Deviation Alarming 8-22
DEVIATION_PT
Import/export fields E-24
DEVIATION_PTID
Point attributes 10-29
Device
Point configuration overview 6-1
GFK-1180K
Device Communications
Global parameters 1-58
Device configuration
Creating a new device 15-2
Device specific properties 15-6
General properties 15-5
Device Configuration 15-1
Device General Properties
Description 15-5
Model Type 15-5
Resource 15-5
Device properties
Control for CIMPLICITY HMI and Control C-2
Device specific properties 15-6
Device status 6-12
DEVICE_DOWN_DEVICE_REF 1-32
DEVICE_ID
Import/export fields E-24
Point attributes 10-29
Devices
About 15-1
Diagnostic
Point when the enabler uses custom addressing 6-13
Points used with devices 6-12
Dialog Box
CIMPLICITY Registration Authorization H-6
CIMPLICITY Registration System Authorization
Code H-7
CIMPLICITY Registration User Information H-4
Field Chooser 2-16
Search 2-12
View options 14-7
DINT 6-4
Disable
Device point 6-16
Device point alarm 6-16
Microsoft Network Login Prompt 3-18
Virtual point 7-14
Virtual point alarm 7-14
Disable / Modify Alarms 24-5
Disable Alarm Button 30-28
Disable Alarm Privileges 24-4, 24-5
Disable Alarms
In the Point Control Panel 30-28
Disable Communications on Port
Consequence of 17-5
Disable Level Privileges 24-5
Disable Manual Mode Button 30-21
Disable Manual Mode Points
In the Point Control Panel 30-21
Disabled Alarm
Icon 30-27
Disk Scan Rate 26-22
Disk Space Low
Maintenance events 26-42
GFK-1180K
Index
DISP_FORMAT B-4
DISP_HIGH B-5
DISP_LIM_HIGH
Import/export fields E-25
Point attributes 10-29
DISP_LIM_LOW
Import/export fields E-25
Point attributes 10-30
DISP_LOW B-5
DISP_TYPE
Import/export fields E-25
DISP_WIDTH E-25
Display
A new Point Control Panel file 30-4
Advanced group of alarm tabs 8-13
Alarm Sound Manager dialog 21-3
Fields in right pane 2-15
Files 2-9
Options in Workbench 2-7
Point Control Panel 30-2
Records 2-9
View tab 8-3
Workbench 2-3
Display High/Low
Analog point limits 8-6
Displaying Point Data with CWSERV B-6
Displaying Ports 17-2
Displaying status log message details J-8
Distributors
Phone numbers 1-1
Domains
For programmable controllers dynamically
reconfigured 6-20
DONT_VERIFY_ESPOINT_FRID 1-32
DOWNLD_PASSWD 1-33, 1-55
DP_FLAG
Point attributes 10-30
Drag
Points into Point Control Panel 2-36
Drag Points to the Point Control Panel 30-14
Drive Field
Maintenance events 26-42
DT_UPD_INTERVAL 1-33
Duplicate Project Broadcast
Machine Edition product integration D-4
DWORD 6-5
Dynamic
Configuration 2-27
Remote Project configuration restrictions 2-27
Update
Point configuration 2-27
Update Class configuration 2-27
Update Port configuration 2-27
Index-xv
Dynamic Configuration
Begin 2-27, 26-16
Using in Database Logger 26-16
Dynamic Configuration Changes
Security audit trail 33-21
Dynamic Configuration privilege 24-4
E
Edit
Glb_parms.idt 1-60
Global parameter value 1-4
Point through point cross reference window 14-10
Select existing record or file 2-30
Edit menu
Login panel 32-20
Edit Point Button 30-24
Element Value Set
In the Point Control Panel 30-30
ELEMENTS B-4, E-37
Import/export fields E-25
EM_LOG
Overview 26-100
Tasks to configure properties 26-103
EM_LOG Table
Schema 26-100
Empty
Point cross reference window 14-3
Enable
Analog display configuration guide 8-5
Device point 6-16
Device point alarm 6-16
Virtual point 7-14
Virtual point alarm 7-14
Enable Alarm Button 30-29
Enable Alarms
In the Point Control Panel 30-29
Enable Manual Mode Button 30-20
Enable Manual Mode Points
In the Point Control Panel 30-20
Enable Project Multicast 3-5
Enable Stale Data
For a port 17-6
Enable Tree Text View
Check box 14-7
ENG_UNITS
Import/export fields E-25
Engineering Units
Group point logging attribute 26-63
Point data logging attribute 26-41
Specified in the virtual point Expression editor 7-47
Enlarge
CimView screen display size 29-9
Enterprise properties
Remote project 33-28
Index-xvi
Enterprise Server
And Setpoint security guidelines 4-7
Connectivity with Machine Edition point data D-2
Enumeration
Application examples 6-42
Associate a point with a set 6-40
Create a set 6-38
Guidelines 6-37
Overview for points 6-37
Enumeration Point 6-37
Equal
Trigger point 6-22
EQUATION
Import/export fields E-26
Equation Points 7-20
Equation w/override points 7-37
Error messages
WebGateway G-7
WebGateway,
#ERROR!ARRAYNOTALLOWED G-7
WebGateway,
#ERROR!ARRAYOUTOFBOUNDS G-7
WebGateway,
#ERROR!BADSERVERRESPONSE G-7
WebGateway,
#ERROR!CIMPLICITYNOTRUNNING G-7
WebGateway, #ERROR!INVALIDPOINTID G-8
WebGateway, #ERROR!NOTIMPLEMENTED G-8
WebGateway, #ERROR!NOTLICENSED G-8
WebGateway, #ERROR!POINTIDSYNTAX G-8
WebGateway,
#ERROR!POINTUNAVAILABLE G-8
WebGateway,
#ERROR!SERVERNEEDSRESTART G-8
WebGateway,
#ERROR!URLEXCEPTION G-8
Error Messages B-15
EU
And linear conversion 6-35
EU Conversion
Machine Edition product integration D-4
EU_CONV
In the virtual points Expression Editor 7-47
EU_EXPRESSION
Point attributes 10-31
EU_LABEL B-5
Point attributes 10-30
EU_REV_EXP
Point attributes 10-31
Event Alarm
Description 20-5
GFK-1180K
Event Alarms
Add to logging through Database Logger 26-90
Add to logging through Point Properties dialog 26-89
Configure a connection 26-91
Table indexes columns rows 26-88
Table logging attributes 26-93
Table schema 26-88
Event Logs
Database Logger defaults 26-25
Event Management Actions
Configure a connection 26-103
Event Manager
Guideline for measurement units 31-19
In point cross reference 14-1
Log table indexes columns rows 26-100
Trigger log report printing 26-128
EVENT_LOG
Add event alarms through Database Logger 26-90
Add event alarms through Point Properties
dialog 26-89
Configure logging conditions for single event
alarm 26-98
Logging properties 26-95
Maintenance actions 26-95
Maintenance events 26-94
Open 26-92
Overview 26-85
System alarms 26-87
Table logging attributes 26-93
Tasks to configure properties 26-91
Events
Configure for a class 11-60
Create for a class 11-59
For a class 11-57
Trigger automatic report 26-128
Example, About
RAS F-2
Example, Remote configuration
CIMPLICITY HMI and Control C-11
Excel
And MS Query for logging reports 26-111
Charts in Trend reports 26-121
Used for alarm log reports 26-121
Used for point log reports 26-115
Used for trend log reports 26-118
Execute SQL Command
Logging maintenance action 26-44
Executing Setpoints
In-place edit 29-15
Object Selected with keyboard 29-14
Object Selected With Mouse 29-14
Executing Slider Setpoints 29-13
Exit
Database Logger 26-20
The Point Control Panel 30-11
GFK-1180K
Index
Expand
Left pane view 2-7
Explorer
Use to find a file 2-14
Export
Class 11-78
Export Path
For maintenance action 26-23
Export procedure
Import/Export E-11
Export Records
Logging maintenance action 26-44
Exporting configuration data E-11
Expression
And timer/counter points 7-41
Create string in a class 11-34
For equation w/override points calculation 7-37
Rules for defining for an equation point 7-21
Expression Editor 7-47
And PTMDP_DO_EU_CONV 7-47
Expressions
Class 11-32
Numeric in data item fields 11-36
EXTRA
Point attributes 10-31
F
Failures 6-12
Field
Chooser 2-15
Need update 2-26
Select in right pane 2-15
Field Chooser
Open dialog box 2-15
Fields
Definitions for fields displayed in the Workbench 9-8
To display in the Workbench 9-6
File
Create new 2-29
Find 2-14
Finding its name 2-12
Open in Point Control Panel 30-6
Save in Point Control Panel 30-7
Select for display 2-9
Select to edit 2-30
File Management Functions
In Database Logger 26-10
File menu
Login panel 32-20
Files
Point Control Panel 30-4
Filter
Timestamps default 26-24
Index-xvii
Filter List
In Database Logger 26-15
Filtering status log messages J-12
final_state
In Alarm Report 26-123
Find
A file 2-14
A record or file 2-10
Name of file or record 2-12
Finding status log messages J-13
Finding the next status log message J-14
First Converted Value
And linear conversion 6-35
FIRST_WEEK_DAYS 1-33
Fixed
Width for an analog point 8-4
FLAGS
Point attributes 10-31
Floating Point Numbers
KB in log record 26-9
Floating Point Vs. Integer
Guideline for measurement units 31-14
FloPro/FloNet
Global parameters list 1-58
Flush
Alarms printed on network printer 23-12
Folder
Expand in left pane 2-7
Fonts
Changing color in the Point Control Panel 30-17
Foreground Color
For alarm class 18-5
For point alarm class 8-19
Format
IFELSE 7-51
FORMAT_PREC
Point attributes 10-32
FORMAT_WID
Point attributes 10-32
Formats - CWSERV System Topic B-13
Forward
Custom device point conversion 6-35
FR_ID
Point attributes 10-32
Function Upgrade Registration H-11
Functionality
Viewer and Machine Edition integration D-3
Functions
Alarm 7-49
Further configuration
RAS, Windows NT server F-7
Windows NT client F-11
FW_CONV_EQ
Import/export fields E-26
Index-xviii
G
GE FANUC
Hotline 1-2
General
Basic virtual point information 6-3, 7-3
General properties
Alarm printer configuration 23-4
Device 15-5
Remote project 33-27
getCaption (Method)
WebGateway, Web data applet G-9
getPointStatus (read only property)
WebGateway, Web data applet G-12
getPointValue (read only property)
WebGateway, Web data applet G-12
Glb_parms.idt
Edit 1-60
Global parameter file 1-60
Locate 1-60
Sample file 1-62
Global Parameter
ALLOW_UPDATE_WHEN_DISABLED and port
configuration 17-5
Global Parameters
$AM_STATUS 1-14
ACK_TOUT 1-14
Add 1-7
ALARM_SAVE_COMMENTS 1-14
ALLOW_UPDATE_WHEN_DISABLED 1-15
AM_OLD_POINT_RESET 1-15
AM_RESET_ACK_STATE 1-16
AML_LOWWATERMARK 1-17
AMLP_HIGHWATERMARK 1-16
AMLP_LOSTALARMSPAGE 1-16
AMLP_MAX_QUEUE 1-17
AMLP_USE_GEN_TIME 1-17
AMLP_USE_RESET_TIME 1-18
BIND_ADDR 1-18
BSM_PTM_APPQ 33-2
BSM_PTM_AQ_CNT4DROP 33-3
CE_MAX_DELAY 1-19
CE_MAX_THREADS 1-19
CE_THREAD_TIMEOUT 1-19
CLR_TOUT 1-19
Configure 1-3
CONNECT_DROP_PERIOD 1-20
CONNECT_RETRY_PERIOD 1-20
DARP_LVV_USECURRENT 1-20
DARP_STARTUP_INTERVAL 1-21
DB_CLOCK_ADJUSTMENT_MONITOR 1-21
DB_COMPACT_QUEUE_SIZE 1-21
DB_COUNTER_FIELD 1-22
DB_DBMS_QUEUE_SIZE 1-22
DB_DEBUG 1-23
GFK-1180K
DB_ENABLE_MSEC 1-23
DB_ENABLE_TRANSACTIONS 1-25
DB_MSEC_FIELD 1-25
DB_POINT_ID_FIELD 1-26
DB_PROJECT_FIELD 1-26
DB_QUEUE_OVERFLOW_DELAY 1-27
DB_QUEUE_SIZE 1-27
DB_STATUS_LOG_OFF 1-27
DB_TABLE_FAILURE_RETRY 1-28
DB_TIME_FORMAT 1-28
DB_TIMESTAMP_FIELD 1-29
DB_TIMESTAMP_FILTER 1-30
DB_TIMESTAMP_PRECISION 1-30
DBDL_DEVICE_CHECK_PERIOD 1-31
DC_RETRY_ONE_DEVIE 1-31
Definition A-1
DEL_OPT 1-31
Delete 1-9
Device communications 1-58
DEVICE_DOWN_DEVICE_REF 1-32
DONT_VERIFY_ESPOINT_FRID 1-32
DOWNLD_PASSWD 1-33, 1-55
DT_UPD_INTERVAL 1-33
Edit a value 1-4
Edit glb_parms.idt file 1-60
Find in the Workbench A-2
FIRST_WEEK_DAYS 1-33
GSM_ANNUN_ALARM_H1 1-34
GSM_ANNUN_ALARM_H2 1-34
GSM_ANNUN_ALARM_L1 1-35
GSM_ANNUN_ALARM_L2 1-35
GSM_ANNUN_DIG_OFF 1-36
GSM_ANNUN_DIG_ON 1-36
GSM_ASC_FONT_NAME 1-37
GSM_ASC_FONT_SIZES 1-37
GSM_ASC_SCALE 1-38
GSM_CACHE_SIZE 1-38, 1-40
GSM_EXPONENT_PRECISION 1-39
GSM_GLOBAL_SCRIPT 1-39
GSM_OVERRIDE_POINT_FMT 1-40
GSM_SPCONFIRM_DEFAULT 1-41
GSM_STALE_COLOR_KEY 1-41
GSM_TERM_SERV_CACHE_SIZE 1-42
GSM_UNAVAIL_COLOR_KEY 1-42
GSM_UNAVAILABLE_TIMELIMIT 1-42
HDA_PTDL_OFFSET 1-43
IPC_BCAST_INTERVAL 1-43
IPC_QUEUE_SIZE 1-45
List 1-11
List for Allen-Bradley 1-58
List for Allen-Bradley Data Highway Plus 1-58
List for FloPro/FloNet 1-58
List for Marquee Driver 1-58
List for Mitsubishi Serial 1-58
List for Modbus Plus 1-58
GFK-1180K
Index
Index-xix
Group Log
Add points through Database Logger 26-59
Logging conditions 26-62
Logging properties 26-65
Maintenance actions 26-65
Maintenance events 26-64
Open 26-61
Table logging properties 26-63
Tasks to configure properties 26-60
Group Point Logs
Database Logger defaults 26-28
Group Points
Open log report 26-118
Report logged data 26-118
Table indexes columns rows 26-58
Table schema 26-58
View logged data 26-120
Group Table
Indexes columns rows 26-58
GROUP_LOG
Add point alarms through Point dialog 26-73
GSM_ANNUN_ALARM_H1 1-34
GSM_ANNUN_ALARM_H2 1-34
GSM_ANNUN_ALARM_L1 1-35
GSM_ANNUN_ALARM_L2 1-35
GSM_ANNUN_DIG_OFF 1-36
GSM_ANNUN_DIG_ON: 1-36
GSM_ASC_FONT_NAME 1-37
GSM_ASC_FONT_SIZES 1-37
GSM_ASC_SCALE 1-38
GSM_CACHE_SIZE 1-38, 1-40
GSM_EXPONENT_PRECISION 1-39
GSM_GLOBAL_SCRIPT 1-39
GSM_OVERRIDE_POINT_FMT 1-40
GSM_SPCONFIRM_DEFAULT 1-41
GSM_STALE_COLOR_KEY 1-41
GSM_TERMSERV_CACHE_SIZE 1-42
GSM_UNAVAIL_COLOR_KEY 1-42
GSM_UNAVAILABLE_TIMELIMIT 1-42
Guidelines
Database queue size 26-23
Disk scan rate 26-22
Enumerated points 6-37
Maintenance action export path 26-23
Point data logging scan rate 26-23
HDA
Global Parameter 1-43
HDA_PTDL_OFFSET
HDA 1-43
Help - CWSERV System Topic B-14
Help File
And alarms 8-29
Help File Conventions
Point class 11-77
Help Menu
Login panel 32-21
Histogram Point 7-42
Hotline
Phone numbers 1-2
How Client Package Distribution Works 33-11
How Configuration Updates Are Handled 3-24
I
Icon 30-27
Alarm Limit Changed 30-27
Alarm Sound Manager on Windows task bar 21-14
Database Logger 26-4
For tables in Database Logger 26-5
Invalid point 30-12
Manual mode 30-20, 30-25
Point cross reference 14-2
ID
For alarm class 18-4
ie_deflds.cfg E-4
Changing information in E-5
ie_formats.cfg E-5
Changing information in E-6
IFELSE
Format 7-51
Import
Class into a project 12-5
Point class 11-79
Import options
Device properties, CIMPLICITY HMI and
Control C-3
Import Procedure
Import/Export E-8
Import, Process
CIMPLICITY HMI and Control C-7
Import, Rules
CIMPLCITIY HMI and Control C-7
Index-xx
GFK-1180K
Import/Export E-1
Configuration Files E-4
Data file format E-2
Deleting configuration data E-14
Export field formats file E-5
Export procedure E-11
Exporting configuration data E-11
Field names E-15
Required E-15
Import Field Defaults File E-4
Importing configuration data E-8
Introduction E-1
Log file E-7
Log file format E-7
Log file name E-7
Logicmaster 90 support E-37
Logicmaster Fields
ADDR E-37
DESC E-37
ELEMENTS E-37
PT_ID E-37
PT_TYPE E-37
Optional field names E-15
Sample data file E-2
Sample Logicmaster File E-37
Wildcards for delete E-14
Wildcards for export E-13
Import/export Fields
ACCESS E-17
ACCESS_FILTER E-17
ACK_TIMEOUT E-17
ADDR E-17
ADDR_OFFSET E-18
ADDR_TYPE E-18
ALM_CLASS E-18
ALM_CRITERIA E-18
ALM_DEADBAND E-19
ALM_DELAY E-19
ALM_HIGH_1 E-19
ALM_HIGH_2 E-19
ALM_HLP_FILE E-19
ALM_LOW_1 E-20
ALM_LOW_2 E-20
ALM_MSG E-20
ALM_ROUTE_OPER E-20
ALM_ROUTE_SYSMGR E-20
ALM_ROUTE_USER E-21
ALM_STR E-21
ALM_TYPE E-21
ANALOG_DEADBAND E-21
BFR_COUNT E-21
BFR_DUR E-22
BFR_EVENT E-22
BFR_EVENT_PT_ID E-22
BFR_EVENT_TYPE E-22
GFK-1180K
Index
BFR_EVENT_UNITS E-22
BFR_GATE_COND E-22
BFR_SYNC_TIME E-23
CALC_TYPE E-23
CONV_LIM_HIGH E-23
CONV_LIM_LOW E-23
CONV_TYPE E-24
DELETE_REQ E-24
DESC E-24
DEVIATION_PT E-24
DEVICE_ID E-24
DISP_LIM_HIGH E-25
DISP_LIM_LOW E-25
DISP_TYPE E-25
ELEMENTS E-25
ENG_UNITS E-25
EQUATION E-26
FW_CONV_EQ E-26
GR_SCREEN E-26
INIT_VAL E-26
JUSTIFICATION E-27
LEVEL E-27
LOCAL E-27
LOG_ACK E-27
LOG_DEL E-27
LOG_GEN E-27
LOG_RESET E-27
MAX_STACKED E-28
MEASUREMENT_UNIT_ID E-28
POSS_AFTER_SET E-28
PRECISION E-28
PROC_ID E-28
PT_ENABLED E-29
PT_ORIGIN E-29
PT_SET_INTERVAL E-29
PT_SET_TIME E-30
PT_TYPE E-30
PTMGMT_PROC_ID E-29
RANGE_HIGH E-30
RANGE_LOW E-30
RAW_LIM_HIGH E-30
RAW_LIM_LOW E-30
REP_TIMEOUT E-31
RESET_ALLOWED E-31
RESET_COND E-31
RESET_PT E-31
RESET_TIMEOUT E-32
RESOURCE_ID E-32
REV_CONV_EQ E-32
ROLLOVER_VAL E-32
SAFETY_PT E-33
SAMPLE_INTV E-33
SAMPLE_INTV_UNIT E-33
SCAN_RATE E-33
SETPOINT_HIGH E-34
Index-xxi
SETPOINT_LOW E-34
TIME_OF_DAY E-34
TRIG_CK_PT E-34
TRIG_PT E-34
TRIG_REL E-35
TRIG_VAL E-35
UPDATE_CRITERIA E-35
VARIANCE_VAL E-36
VARS E-36
Import/Export Fields
DISP_WIDTH E-25
PT_ID E-15
PT_ORIGIN E-15
Importing configuration data E-8
Incorrect information conflicts
CIMPLICITY HMI and Control C-10
Indexes
In alarm logging tables 26-72
In application logging tables 26-109
In data logging tables 26-31
In event logging tables 26-88
In event manager logging tables 26-100
In group logging tables 26-58
InetPub\Scripts\CimGate.dll G-3
InetPub\wwwroot\CIMPLICITY\HMI\*.html G-3
InetPub\wwwroot\CIMPLICITY\HMI\CimData.jar G-3
INIT_STATE B-6
INIT_VAL
Import/export fields E-26
INIT_VALUE
Point attributes 10-32
Initialization
Specifications for a virtual point 7-6
Text points 7-7
Initialized
Initialization option 7-6
In-place edit setpoint actions 29-15
Insert Triggers
And Bulk insertion 26-3
Insertion
Peak performance bulk 26-3
Install Shortcut
Of Point Control Panel file 30-8
Installation
Upgrade licenses H-13
Installation procedure
WebGateway G-2
Installing
WebGateway G-2
Installing the RAS
Windows NT client F-9
Windows NT server F-4
INT 6-4
Integrated Functionality
Machine Edition point data D-3
Index-xxii
Integration
Machine Edition Point Data D-1
Machine Edition point data architecture D-2
Set up Machine Edition D-5
Interval
Disk scan rate 26-22
Timer/counter point 7-40
Intervals
Point data logging conditions 26-36
Introduction
Site wide installation 33-9
Invalid Point
Icon 30-12
In point cross reference 14-6
IPC for Point Management 1-44
IPC_BCAST_INTERVAL 1-43
IPC_QUEUE_SIZE 1-45
J
Job Creating for CIMPLICITY HMI Installation
Site wide installation 33-16
Justification
For an analog point 8-3
JUSTIFICATION
Import/export fields E-27
Just-in-Time Data Items
Class 11-44
L
LAST_UPD_MAN
Point attributes 10-20
Layers
CIMPLICITY programs 3-23
Left
Justification for an analog point 8-3
Left Pane
Changing the view 2-7
Create new record or file from 2-29
In point cross reference window 14-6
LENGTH B-4
Less Than
Trigger point 6-22
Less Than Equal
Trigger point 6-22
Level
Device point security 6-20
Virtual point security 7-17
LEVEL
Import/export fields E-27
Point attributes 10-32
Level Privilege 24-5
GFK-1180K
License
Installing for upgrade H-13
Transfer from one computer to another H-21
Transfer via the network H-18, H-21
Licenses
Running without authorization H-32
Upgrading CIMPLICITY HMI H-11
Limitations
RAS F-15
String substitution 11-33
Limits
Analog display 8-6
Array limits for device points 6-7
Basic alarm 8-12
Range 8-7
Setpoint 8-9
Tab 8-7
Limits Button 30-27
Linear Conversion for a device point 6-34
List
Alarm Sound Manager projects 21-4
All files for an object 2-9
All points displayed in the Workbench 9-1
All records for an object 2-9
Customize point list in the workbench 9-1
Filter in Database Logger 26-15
Of global parameters 1-11
Points in point cross reference 14-6
Resorting in point cross reference 14-6
Select points in the Workbench 9-2
Selected files for an object 2-10
Selected records for an object 2-10
Load
Profile in Alarm Sound Manager 21-6
LOCAL
Import/export fields E-27
Point attributes 10-33
Locate
Glb_parms.idt 1-60
Location
MS Query for logging reports 26-112
Log
Select to log point alarms 8-28
Log and error files
Viewing J-1
Log file format
Import/Export E-7
Log file name
Import/Export E-7
Log On As
CIMPLICITY service 26-125
Log Record
Allowed size 26-9
LOG_ACK
Import/export fields E-27
GFK-1180K
Index
log_action
In Alarm Report 26-123
LOG_DEL
Import/export fields E-27
LOG_GEN
Import/export fields E-27
Log_names.cfg 33-5
LOG_OPT 1-45
LOG_RESET
Import/export fields E-27
logged_by
In Alarm Report 26-123
Logging
Add alarms through Database Logger 26-74
Add data points through Database Logger 26-33
Add event alarms through Database Logger 26-90
Add event alarms through Point Properties
dialog 26-89
Add group of points through Point Properties
dialog 26-32
Add group points through Database Logger 26-59
Add point alarms through Point Properties
dialog 26-73
group points 26-55
Point data 26-29
Logging Conditions
ALARM_LOG 26-77
Configure for a single alarm 26-83
Configure for a single event alarm 26-98
Configure for a single point 26-50
Data log 26-36
Group log 26-62
Logging Count
Maintenance event 26-42
Logging Data Tables
Maintenance events 26-41
Logging Database
Reconcile with table 26-17
Logging In 3-25
Logging in to a project
Login panel 32-19
Logging out of a project
Login panel 32-18
Logging Properties
Default in Database Logger 26-21
For alarm logs 26-80
For event alarm logs 26-95
For point data logs 26-45
Logging Properties Dialog Box
Open 26-21
Index-xxiii
Logging Reports
Alarms 26-121
And MS Query 26-111
Automatic printing 26-124
Generate Alarm Report 26-123
Generate Data Report 26-116, 26-119
Group points 26-118
MS Query path 26-112
Parameters for group point logs 26-119
Parameters for point logs 26-116
Points 26-115
Shipped with CIMPLICITY 26-110
Logging Table
Close in Database Logger 26-19
Copy to new table 26-12
Create new 26-10
Delete in Database Logger 26-14
Open 26-11
Reconcile with logging database 26-17
Rename in Database Logger 26-13
Logging Tables
Maintenance actions 26-43
Logical
Operators and custom conversion 6-36
Operators for expressions 7-52
Logical Names 33-2
Allen Bradley Communications 33-4
Editing the file 33-5
Log_names.cfg 33-5
Mitsubishi TCP/IP Communications 33-5
Modbus Plus Communications 33-4
SNP Communications 33-5
Logicmaster 90 support
Import/Export E-37
Login Information
Deleting 33-6
Login Panel 32-12
Edit menu 32-20
File menu 32-20
Help Menu 32-21
Logging in to a project 32-19
Logging out of a project 32-18
Managing saved logins 32-15
Menu options 32-20
Password, changing 32-14
Project Menu 32-20
Shortcut keys 32-21
Start 32-13
Toolbar buttons 32-21
View Menu 32-21
Login Password
Security features 33-18
LOGIN_RETRY_PERIOD 1-46
Index-xxiv
M
Machine Edition
Enterprise Server connectivity D-2
Integrated functionality D-3
Integration handling D-3
Point data integration D-1
Point data integration architecture D-2
Set up for data point integration D-5
Viewer connectivity D-3
Maintain
PtXRef database 14-11
Maintenance Action Export Path 26-23
Maintenance Actions
Trigger log report printing 26-128
Maintenance Events
For alarms 26-79
For event alarms 26-94
For point data logs 26-41
For point groups 26-64
Notes about timed/gated 26-51
Managing Saved Logins 32-15
Manual
Reset for an alarm 8-35
Manual Mode
Description 6-44
Icon 30-20, 30-25
Manual Mode Points
Add to the Point Control Panel 30-19, 30-25
Disable in the Point Control Panel 30-21
Enable in the Point Control Panel 30-20
Manual Points in the PCP
Overview 30-19
Mapping Colors in rgb.dat
Alarm class configuration 18-9
Mappings
Color defaults for alarm class 18-9
New colors for alarm class 18-9
Marquee driver
Global parameters list 1-58
Max Capture Point 7-31
Max Count
For a device point trend history 6-18
For a virtual point trend history 7-16
Max Duration
For a device point trend history 6-18
For a virtual point trend history 7-16
max number of stored records
Default store and forward 26-27
MAX_STACKED
Import/export fields E-28
MAX_TREND_BUF 1-46
MCP_PROC_DOWN 20-3
MDAC
From Microsoft 27-6
GFK-1180K
Measurement System
Adding 31-4
Copying 31-5
Defining properties 31-4
Renaming 31-5
Measurement Systems
Configuring 31-2
Measurement Unit
Copying 31-10
Defining properties 31-6
Editing properties 31-7
Equivalent unit definition 31-7
Equivalent unit id 31-8
Forward equation 31-8
Justification 31-9
Precision 31-9
Renaming 31-10
Reverse equation 31-8
Type 31-9
Width 31-9
Measurement Units
About 31-1
Active measurement system, about 31-12
Configuring 31-2
Creating 31-6
Guidelines 31-14
Guidelines, Basic control engine 31-19
Guidelines, CimEdit management of animated
objects 31-17
Guidelines, CimView scripts 31-18
Guidelines, Derived points 31-16
Guidelines, Event manager 31-19
Guidelines, Floating point vs. integer 31-14
Starting 31-3
MEASUREMENT_UNIT_ID
Import/export fields E-28
Point attributes 10-33
Menu
Show Users help 32-9
Show Users search 32-10
Show Users window 32-10
Menu options
Login panel 32-20
Status log viewer J-4
Menu Options
Show Users 32-8
Merant
Datadirect Connect ODBC driver for Oracle 27-6
Message
Advanced alarm 8-15
Basic alarm 8-11
message Box
In Alarm Sound Manager 21-13
Microsoft
MDAC 27-6
GFK-1180K
Index
Index-xxv
N
Name
Finding 2-12
Node and project 3-4
Name Object in CimEdit
Class 11-68
Naming Points 4-2
Reserved words 4-3
Need Update
Point field 2-26
Network Options
CIMPLICITY options 3-16
Network Printer
Flushing alarms 23-12
Networking considerations
RAS F-14
RAS, Client has network card configured F-14
New
Alarm Class Configuration dialog opened 18-2
Class attribute 11-17
Class object 12-7
Create logging table 26-10
Creating new device points 6-2
Creating virtual points 7-2
Global parameter 1-7
Logging table copied from existing 26-12
Quick device setup 5-3
Record or file 2-29
New Name
CIMPLICITY HMI project 2-20
New point conflicts
CIMPLICITY HMI and Control C-9
New Project
Copy from an existing project 2-19
New Project Options 3-9
No Limit
Default store and forward 26-27
Node Name
And project name 3-4
None
Initialization option 7-6
Trigger point 6-22
Numeric Data Item
$ADDRESS_ADJ 11-37
$ALARM_DELAY 11-37
$ALARM_HIGH 11-37
$ALARM_LOW 11-37
$CONV_LIMIT_HIGH 11-37
$CONV_LIMIT_LOW 11-37
$DISPLAY_HIGH 11-37
$DISPLAY_LOW 11-37
$FORMAT_JUST 11-37
$FORMAT_PREC 11-37
$FORMAT_WIDTH 11-37
Index-xxvi
$LEVEL 11-37
$RANGE_HIGH 11-37
$RANGE_LOW 11-37
$RAW_LIMIT_HIGH 11-37
$RAW_LIMIT_LOW 11-37
$SETPOINT_HIGH 11-37
$SETPOINT_LOW 11-37
$TREND_DURATION 11-37
$TREND_SAMPLES 11-37
$WARNING_HIGH 11-37
$WARNING_LOW 11-37
Numeric Data Item Attributes
In expressions 11-37
Numeric Expressions
In data item fields 11-36
O
Object
Add class object to project 12-10
Assign attribute values to class object 12-8
Class object dialog box tabs 12-8
Configuration class objects 12-5
Configure properties for class object 12-8
Create class object 12-7
Create class object CimEdit screen 12-13
Display in left pane 2-7
General values in a class 12-10
Object Builder Group
For classes 11-21
Object Evolution
Class object 12-3
Objects
Definitions class objects 12-2
Grouped on a class CimEdit screen 11-66
ODBC configuration 27-1
Drivers 27-2
ODBC Configuration
Custom data sources 27-3
Data sources 27-2
Microsoft Access data sources 27-6
Moving projects 27-3
ODBC Source
For point data logs 26-46
OMRON Serial
Global parameters list 1-58
OMRON TCP/IP
Global parameters list 1-58
On and Off
Manual mode 6-44
On Change
Trigger point 6-22
On Demand On Change 6-10
On Demand On Scan 6-10
GFK-1180K
GFK-1180K
Index
Operators
Arithmetic for expressions 7-50
Bitwise for expressions 7-51
Conversion for expressions 7-52
Logical for expressions 7-52
Relational for expressions 7-53
Scientific for expressions 7-54
Valid for custom conversion 6-36
Option Button
All subsystems 14-4
Selected subsystems 14-4
Options
For alarms 8-33
Options Button
Select subsystems 14-11
Oracle
Allow service to interact with desktop 27-7
Configuration for CIMPLICITY HMI 27-7
Configuring for CIMPLICITY HMI 27-6
Set up in CIMPLICITY HMI software 27-8
Versions supported 27-6
Oracle requirements
Database logger 27-8
Out of Range 7-55
Output and error files
System, Checking J-15
Output and error files, Project
Checking J-16
Overview
Advanced device point configuration 6-15
Advanced device point specifications 6-20, 7-19
Advanced virtual point configuration 7-12
Alarm limit values 8-25
Alarm logging 26-69
Alarms 8-10
Class-object evolution and construction 11-2
Database Logger 26-1
Database Logger file management functions 26-10
Default Database Logger logging properties 26-21
Device point configuration 6-1
Event alarm logging 26-85
Event Management logging 26-100
Expression operations 7-48
Global parameters A-1
Logging reports 26-110
Manual points in the PCP 30-19
Point class 4-2
Point Cross Reference 14-1
Point cross reference window panes 14-4
Point data logging 26-29, 26-30
Point group logging 26-55
Point type 4-2
Point View 8-2
Point view - limits and alarms 8-1
Quick device setup 5-1
Index-xxvii
P
Pane
Left 2-7
Right 2-8
Panes
In point cross reference window 14-4
Left in point cross reference window 14-6
Workbench 2-3
Parameters
Default for Database Logger 26-22
For logged data reports 26-116
For logged trend reports 26-119
Password
Logging default 26-26
Password, Changing
Login panel 32-14
Path
Maintenance action export default 26-23
MS Query for logging reports 26-112
PB_DIAGS 1-48
Performance
Bulk insertion peak 26-3
Database Logger 26-3
Periodic
And on digital point state 26-53
And Synchronized for timed/gated 26-52
Data log maintenance event 26-42
Only for time/gated 26-51
Point data logging conditions 26-36
Synchronized and on digital point state 26-54
Phone numbers
Distributors 1-1
Phone Numbers
Hotline 1-2
Ping
RAS, Testing the connection F-13
Ping, Client
RAS, Testing the connection F-13
Ping, Server
RAS, Testing the connection F-14
Place Shortcut
Of Point Control Panel file 30-8
Plan
Class 11-8
Index-xxviii
Point
Associate with an enumeration set 6-40
Dynamic configuration restrictions 2-27
Invalid 14-6
Machine and Plant Editions product variations D-3
Machine Edition data integration D-1, D-2
Machine Edition product integration updates D-4
Monitoring runtime values 2-35
Security level for device point 6-20
Security level for virtual point 7-17
Set up Machine Edition for integration D-5
Point Alarm Class
Colors 8-19
Point Alarms
Add to logging through Point Properties dialog 26-73
Point Attribute
Security 10-41
Point Attributes
$RAW_VALUE 10-22
ACCESS_FLAG 10-23
ACK_TOUT 10-23
ADDR 10-23
ADDR_OFFSET 10-23
ALARM_CRITERIA 10-24
ALARM_DELAY 10-24
ALARM_HIGH 10-24, 10-25
ALARM_LOW 10-25
ALARM_STATE 10-26
ANALOG_DEADBAND 10-26
Applied 10-11
CALCULATION_TYPE 10-27
CLR_TOUT 10-27
CONV_TYPE 10-27
DEADBAND 10-28
DEL_OPT 10-28
DESCRIPTION 10-28
DEVIATION_PTID 10-29
DEVICE_ID 10-29
DISP_LIM_HIGH 10-29
DISP_LIM_LOW 10-30
DP_FLAG 10-30
EU_EXPRESSION 10-31
EU_LABEL 10-30
EU_REV_EXP 10-31
EXTRA 10-31
FLAGS 10-31
FORMAT_PRC 10-32
FORMAT_WID 10-32
FR_ID 10-32
INIT_VALUE 10-32
LAST_UPD_MAN 10-20
LEVEL 10-32
LOCAL 10-33
MEASUREMENT_UNIT_ID 10-33
POINT_SET_INTERVAL 10-34
GFK-1180K
POINT_SET_TIME 10-34
POINT_STATE 10-34
PROCESS_ID 10-33
PTMGMT_PROCESS_ID 10-33
QUALITY 10-17
QUALITY.ALARMED 10-18
QUALITY.ALARMS_ENABLED 10-19
QUALITY.DISABLE_WRITE 10-19
QUALITY.IS_AVAILABLE 10-19
QUALITY.IS_IN_RANGE 10-20
QUALITY.MANUAL_MODE 10-18
QUALITY.STALE_DATA 10-20
RANGE_HIGH 10-35
RANGE_LOW 10-35, 10-36
RATE_TIME_INTERVAL 10-34
REP_TOUT 10-36
RESET_POINT_ID 10-36
SAFETY_CHECK_PTID 10-39
SCAN_POINT 10-37
SCAN_RATE 10-37
SETPOINT_HIGH 10-37, 10-38
SETPOINT_LOW 10-38
TIMESTAMP 10-21
TRIG_TYPE 10-39
TRIG_VALUE 10-40
TRIGGER_POINT 10-39
VARIANCE_VALUE 10-40
WARNING_HIGH 10-40
WARNING_LOW 10-41
Point Bridge
Configuring points 33-29
Device point restrictions 6-12
Point configuration details 33-30
Point by Address privilege 24-5
Point Class
Definitions 11-81
Help file conventions 11-77
Import 11-79
Plan 11-8
Sample 11-2
Point Configuration
Configuring Point Bridge Points 33-29
In point cross reference 14-1
Point bridge point configuration details 33-30
Point conflicts, Incorrect information
CIMPLICITY HMI and Control C-10
Point conflicts, New point
CIMPLICITY HMI and Control C-9
Point conflicts, Resolving
CIMPLICITY HMI and Control C-8
Point Control Panel
About 30-1
Drag points into 2-36
Open 2-36, 30-2
GFK-1180K
Index
Index-xxix
$LOCAL.DATE.YEAR 13-4
$LOCAL.WINUSER 13-4
$PROJECT 13-5
$PROJECT.AMPM 13-5
$PROJECT.AVAILABLE 13-5
$PROJECT.COMPUTER 13-5
$PROJECT.DATE.DAY 13-5
$PROJECT.DATE.DAYOFWEEK 13-5
$PROJECT.DATE.DAYOFYEAR 13-6
$PROJECT.DATE.HOUR 13-6
$PROJECT.DATE.HOUR12 13-6
$PROJECT.DATE.MINUTE 13-6
$PROJECT.DATE.MONTH 13-6
$PROJECT.DATE.SECOND 13-6
$PROJECT.DATE.SECONDOFDAY 13-6
$PROJECT.DATE.WEEK 13-7
$PROJECT.DATE.YEAR 13-7
$PROJECT.DATETIME 13-7
$PROJECT.DEVICES 13-7
$PROJECT.LOGGEDIN 13-7
$PROJECT.ROLE 13-8
$PROJECT.ROLE.LEVEL 13-8
$PROJECT.USER 13-8
$PROJECT.USER.ALARMS 13-8
$PROJECT.USERS 13-7
Point Topic Attributes B-3
ALARM_ENABLED B-6
ALARM_HIGH B-5
ALARM_LOW B-5
DISP_FORMAT B-4
DISP_HIGH B-5
DISP_LOW B-5
ELEMENTS B-4
EU_LABEL B-5
INIT_STATE B-6
LENGTH B-4
RAW_VALUE B-3
SIZE B-4
STATE B-3
TYPE B-4
VALUE B-3
WARN_ENABLED B-6
WARNING_HIGH B-5
WARNING_LOW B-5
Point Value
Group point logging attributes 26-63
Point data logging attributes 26-40
Point_Id
In Data Report 26-117
In Database Logger Group Report 26-120
POINT_SET_INTERVAL
Point attributes 10-34
POINT_SET_TIME
Point attributes 10-34
Index-xxx
POINT_STATE
Point attributes 10-34
POINTLOG.MDB 26-25
Points
Add to data logging through Database Logger 26-33
Add to data logging through Point Properties
dialog 26-32
Add to group log through Database Logger 26-59
Availability with enable stale data 17-6
Configure a connection 26-35
Configure group log properties 26-60
Data logging conditions 26-36
Data table indexes columns rows 26-31
Data table logging attributes 26-40
Deleting from the Point Control Panel 30-18
Focusing on in point cross reference 14-9
Group logging conditions 26-62
Group logging overview 26-55
Lists in point cross reference 14-6
Logging overview 26-29
Open log report 26-115
Report logged data 26-115
Set in the PCP 30-23
Table group logging attributes 26-63
Timed/gated logging notes 26-51
Timed/gated maintenance notes 26-51
Type in point cross reference 14-7
View logged data 26-117
Viewing in cross reference 14-5
Points for the Point Control Panel
Add from the Workbench 30-14
Add using the Point Browser 30-12
From another PCP 30-15
Points in the PCP
Alarm tab 30-26
Poll After Set 6-23
Poll Once 6-11
POLL_AFTER_SET
Import/export fields E-28
Port
Dynamic configuration 2-27
General properties 17-5
Port specific properties 17-7
Quick setup for a project 5-3
Port Attributes
Description 17-2
Port Id 17-2, 17-3
Protocol 17-3
Protocol Id 17-2
Port configuration
Changing protocols 17-8
Port Configuration 17-1, 17-2
Creating A New Port 17-3
Opening an existing Properties dialog box 17-4
GFK-1180K
GFK-1180K
Index
Index-xxxi
Index-xxxii
Run 2-17
Stop 2-22
Switch to another 2-18
Update 2-25
PROJECT
In Data Report 26-117
Project log and error files J-1
Project login/logout
Security audit trail 33-21
Project Menu
Login panel 32-20
Show Users 32-9
Project Name
And node 3-4
Group point logging attribute 26-64
Point data logging attribute 26-41
Project Properties
Enable Project Broadcast 3-5
General 3-4
Options 3-4, 3-5
Protocols 3-4
Setting 3-3
Settings tab 3-7
Project setup
For WebGateway G-4
PROJECT_ID 1-49
Projects
And Alarm Sound Manager startup 21-11
Projects List
Alarm Sound Manager dialog 21-4
Properties
Configure for alarm logging 26-75
Configure for event alarm logging 26-91
Configure for Event Management action
logging 26-103
Configure for group point logging 26-60
Configure for point data logging 26-35
Viewing for point 14-10
Protocol
Changing for port 17-8
Quick enable in a project 5-2
PROWLER_CACHE_SIZE 1-49
PT_ENABLED
Import/export fields E-29
PT_ID E-15, E-37
PT_ORIGIN E-15
Import/export fields E-29
PT_SET_INTERVAL
Import/export fields E-29
PT_SET_TIME
Import/export fields E-30
PT_TYPE E-37
Import/export fields E-30
PTDL_ENABLE_MEASUREMENTS 1-49
PTDL_QUANTIZATION 1-50
GFK-1180K
PTMDP_DO_EU_CONV 1-50
In the Expression Editor 7-47
PTMDP_DO_SAVEPOINT_CACHE 1-50
PTMDP_DO_SAVEPOINT_COMPACT 1-51
PTMGMT_PROC_ID
Import/export fields E-29
PTMGMT_PROCESS_ID
Point attributes 10-33
PTMRP 1-51
PTX_MAX_CACHED_POINTS 1-51
PtXRef
Add subsystems to 14-11
Build 14-3
Build database again 14-11
Rebuild database 14-12
Refresh point cross reference view 14-8
Staying current 14-11
PtXRef Database
Full View 14-5
Text View 14-5
Tree View 14-5
Q
Quality
Group point logging attribute 26-63
Point data logging attribute 26-41
Point support at runtime 6-44
QUALITY
Point attributes 10-17
QUALITY.ALARMED
Point attributes 10-18
QUALITY.ALARMS_ENABLED
Point attributes 10-19
QUALITY.DISABLE_WRITE
Point attributes 10-19
QUALITY.IS_AVAILABLE
Point attributes 10-19
QUALITY.IS_IN_RANGE
Point attributes 10-20
QUALITY.MANUAL_MODE
Point attributes 10-18
QUALITY.STALE_DATA
Point attributes 10-20
Queue Size
Specifying in Database Logger 26-22
Queue size, Modifying
Alarm printer configuration 23-13
Quick
Device setup 5-1
Port setup for a project 5-3
Quick Trend
Open 2-36
GFK-1180K
Index
R
R1
And linear conversion 6-35
R2
And linear conversion 6-35
Range
Configuring limits 8-7
Range Low/High
Limits 8-7
RANGE_HIGH
Import/export fields E-30
Point attributes 10-35
RANGE_LOW
Import/export fields E-30
Point attributes 10-35, 10-36
RAS
About F-1
About the example F-2
CIMPLICITY options, Server F-14
Client setup, Windows 95 F-11
Client setup, Windows NT F-9
Configuring automatic startup, Windows NT
server F-7
Configuring the CIMHOSTS.TXT file F-13
Further configuration, Windows NT client F-11
Further configuration, Windows NT server F-7
Granting client dial-in permission, Windows NT
server F-7
Installing, Windows NT client F-9
Installing, Windows NT server F-4
Limitations on support F-15
Networking considerations F-14
Requirements F-3
Server setup, Windows NT F-4
Testing the connection F-13
Testing the connection, Ping F-13
Testing the connection, Ping on client F-13
Testing the connection, Ping on server F-14
Rate
Blink for alarm class 18-5
Blink for point alarm class 8-19
Disk scan 26-22
Scan point data logging in Database Logger 26-23
Rate of Change
Alarming 8-24
RATE_TIME_INTERVAL
Point attributes 10-34
Raw Value
And linear conversion 6-35
Group point logging attributes 26-63
Point data logging attributes 26-40
RAW_LIM_HIGH
Import/export fields E-30
Index-xxxiii
RAW_LIM_LOW
Import/export fields E-30
RAW_LIMIT_ALARM 1-52
RAW_VALUE B-3
Point attributes 10-22
REAL 6-4
Rebuild
PtXRef database 14-12
Reconcile
Upgrade indexes 26-19
Reconcile Table and Logging Database
In Database Logger 26-17
Reconfigure a Point
Through the Point Control Panel 30-23
Reconnect wait period
Database logger, Database disconnect recover 27-15
Record
Allowed size in log 26-9
Create new 2-29
Finding its name 2-12
Select for display 2-9
Select to change 2-30
Reduce
CimView screen display size 29-9
REDUND_LINK_SLEEP 1-52
Redundant Alarm Printers
More about 23-10
Ref Count 14-7
reference
In Alarm Report 26-123
Referencing CWSERV from a Networked NT
Client B-16
Refresh
Screen in point cross reference window 14-8
Workbench window 2-6
Refreshing the process list 32-29
Registering CIMPLICITY HMI
Running without authorization H-32
Registration
CIMPLICITY System Authorization code H-7
CIMPLICITY upgrades H-11
Functional upgrades H-11
Lower than version 3.0 upgrades H-15
Prepare for CIMPLICITY H-2, H-18
Remove for CIMPLICITY H-32
V3.0 or higher H-13
Version 4+ upgrades H-13
Related
Operators and custom conversion 6-36
Relation
And trigger points 6-22
Relational
Operators for expressions 7-53
Remote Access of CWSERV on Windows NT B-15
Remote Access Server See RAS
Index-xxxiv
Remote configuration
CIMPLICITY HMI and Control C-11
Remote configuration, Example
CIMPLICITY HMI and Control C-11
Remote project
Enterprise projects 33-28
General properties 33-27
Remote Projects 33-25
Creating 33-26
Remove CIMPLICITY Registration H-32
Remove Points
From the Point Control Panel 30-18
Removing
Saved logins 32-17
Windows 95 Registry Information 33-7
Windows NT Registry Information 33-8
Removing an alarm
Alarm block group 22-7
Removing CIMPLICITY software I-1
From Windows 98 I-1
From Windows NT I-2
Removing Registry Information 33-7
Rename
CIMPLICITY HMI project 2-20
Table in Database Logger 26-13
REP_TIMEOUT
Import/export fields E-31
REP_TOUT
Point attributes 10-36
Repeat
Alarm Manager sound 21-9
REPEAT_TOUT 1-52
Repeats
For alarms 8-34
Reports
Alarm logged data 26-121
Automatic printing 26-124
Generate Alarm Report 26-123
Generate Data Report 26-116, 26-119
Group point logged data 26-118
MS Query for logging reports 26-111
Point logged data 26-115
With CIMPLICITY for logging 26-110
Reports, Automatic printing, Script
Database logger 26-126
Requirements
Hardware for Alarm Sound Manager 21-1
RAS F-3
Reserved
Characters when naming points 4-4
Words when naming points 4-3
Reset Condition
And value Accum points 7-27
GFK-1180K
Reset Point
And average points 7-30
And delta Accum point 7-25
And max capture point 7-32
And Min Capture point 7-34
And Trans High Accum point 7-36
And Value Accum point 7-28
Reset Procedures
For alarms 8-35
RESET_ALLOWED
Import/export fields E-31
RESET_COND
Import/export fields E-31
RESET_POINT_ID
Point attributes 10-36
RESET_PT
Import/export fields E-31
RESET_TIMEOUT
Import/export fields E-32
Resolving point conflicts
CIMPLICITY HMI and Control C-8
Resolving problems
About CIMPLICITY HMI log files J-1
Backup process log files J-16
Checking project output and error files J-16
Checking system output and error files J-15
Project log files J-1
System log files J-1
Viewing log files J-1
Resource
Group point logging attribute 26-63
In Alarm Report 26-123
Point data logging attribute 26-41
Resource Attributes
Alarm Mgr 16-2
Description 16-2
Resource ID 16-2
Resource Type 16-2
Resource configuration
Adding a new user 16-4
Adding a user 16-4
Deleting a user 16-4
Resource definition 16-3
Viewing user properties 16-4
Resource Configuration 16-1
Creating a resource 16-2
RESOURCE_ID
Import/export fields E-32
Resources
About 16-1
Configuring 16-2
Responses 6-12
GFK-1180K
Index
Restrictions
Device points 6-12
Dynamic class configuration 2-27
Dynamic point configuration 2-27
Dynamic port configuration 2-27
On characters when naming points 4-4
On words when naming points 4-2
Remote project dynamic configuration 2-27
Retries 6-12
REV_CONV_EQ
Import/export fields E-32
Reverse
Custom device point conversion 6-36
Review
Point in point cross reference window 14-9
Rgb.dat File
And alarm classes 18-9
Right
Justification for an analog point 8-3
Right Pane
Changing the view 2-8
Field selection 2-15
Point cross reference window 14-9
Role configuration
Creating a new role 24-2
Role Configuration 24-1
Application privileges 24-4
Calendar privileges 24-6
Configuration privileges 24-7
Role Privileges
Calendar area resource security 24-6
Calendar configuration 24-6
Delete Alarm 24-4
Disable / modify alarms 24-5
Dynamic Configuration 24-4
Level 24-5
Modify alarm setups 24-4
Modify Manual Mode 24-5
Point by Address 24-5
Process Control 24-4
Script control 24-5
Security features 33-18
Set Point 24-5
Setpoint Audit Trail 24-5
Trigger event 24-5
Roles
About 24-1
Assigned to view alarms 8-30
Create new for viewing alarms 8-32
Removing from viewing alarms 8-31
ROLLOVER_VAL
Import/export fields E-32
Round
Timestamps filter 26-24
Index-xxxv
Routing
Alarms 8-30
Rows
In alarm logging tables 26-72
In application logging tables 26-109
In data logging tables 26-31
In event logging tables 26-88
In event Manager logging tables 26-100
In group logging tables 26-58
RTR_ACCEPT_CONN 1-52
RTR_DISABLE_BCAST 1-53
RTR_MAX_OUTMESSAGE_COUNT 1-53
Run
CIMPLICITY HMI project 2-17
Run a Program
Logging maintenance action 26-44
Running Without Authorization H-32
Runtime
Access overview 2-32
Availability triggers and device points 6-17
Availability triggers and virtual points 7-15
Monitor a points values 2-35
Notes for virtual points 7-55
Opening a CimView window 2-33
Opening windows 2-33
Point quality support 6-44
Unavailable values 8-8
Runtime Attribute
TIMESTAMP 10-21
S
Safety Points
For device points 6-17
For virtual points 7-14
SAFETY_CHECK_PTID
Point attributes 10-39
SAFETY_PT
Import/export fields E-33
Sample CWSERV Commands B-2
Sample File
Glb_parms.idt 1-62
Sample Point Class 11-2
Sample Spreadsheets and Macros for CWSERV B-10
Array point example B-11
Single point example B-10
SAMPLE_INTV
Import/export fields E-33
SAMPLE_INTV_UNIT
Import/export fields E-33
Save
Alarm sound profile 21-6, 21-10, 21-12
Copy of Point Control Panel file 30-8
Point Control Panel file 30-7
Save Deleted in File 26-43
Index-xxxvi
Saved
Initialization option 7-6
Saved Logins
Adding 32-15
Managing 32-15
Removing 32-17
Saved or Initialized
Initialization option 7-6
Saving the status log as a text file J-9
Scan Disk Rate 26-22
Scan Rate
And base rate 6-23
Point data logging 26-23
SCAN_POINT
Point attributes 10-37
SCAN_RATE
Import/export fields E-33
Point attributes 10-37
Schema
ALARM_LOG tables 26-72
DATA_LOG tables 26-31
EM_LOG tables 26-100
EVENT_LOG tables 26-88
GROUP_LOG table 26-58
Scientific
Operators for expressions 7-54
Width for an analog point 8-4
Screen
Configure for a class 11-65
For a class 11-64
Refresh in the Workbench 2-6
Script
Automatically print report 26-126
Create for a class 11-48
Script control privilege 24-5
Script, Creating for automatic report 26-126
Scripts
In classes 11-46
In point cross reference 14-1
Write for a class 11-49
Search
For a record or file 2-10
Show Users information 32-7
Search Aids
Browser windows 9-5
Wildcard characters 9-4
Search String Wildcards
Database logger 26-15
Second Converted Value
And linear conversion 6-35
Secondary Index
Data table 26-31
SECURE_SOCKETS 1-54
GFK-1180K
Security
Level for device point 6-20
Level for virtual point 7-17
Machine Edition product integration D-3
Point attribute 10-41
Setpoint 4-5
Security Audit Trail
Dynamic configuration changes 33-21
Point control panel alarm changes 33-20
Project login/logout 33-21
Security features 33-19
Setpoint downloads 33-20
Security Features
About 33-18
Login password 33-18
Role privileges 33-18
Security audit trail 33-19
Security audit trail dynamic configuration
changes 33-21
Security audit trail setpoint downloads 33-20
Security audit trail, Point control panel alarm
changes 33-20
Security audit trail, Project login/logout 33-21
Setpoint password 33-19
Setpoint security 33-19
Select
Another project 2-18
CimView screen for a selected point 2-36
Field in right pane 2-15
Selected Subsystems
Option button 14-4
Selecting a status log printer J-11
Selecting a status log to view J-7
Serial alarm printers
Additional configuration 23-11
Series 90 TCP/IP
Global parameters list 1-58
Server setup
RAS, Windows NT F-4
Services
And Oracle 27-7
Set
Created for point enumeration 6-38
Set Point privilege 24-5
Set Value
Array in the Point Control Panel 30-30
setCaption (Method)
WebGateway, Web data applet G-9
Setpoint
Configure limits 8-9
Security 4-5
Setpoint audit trail privilege
More about 24-6
Setpoint Audit Trail privilege 24-5
GFK-1180K
Index
Setpoint Downloads
Security audit trail 33-20
Setpoint Low/High
Limits 8-9
Setpoint Object Selected with keyboard 29-14
Setpoint Object Selected With the Mouse 29-14
Setpoint Password
Security features 33-19
Setpoint Privilege
Machine Edition product integration D-3
Setpoint Security
Security features 33-19
SETPOINT_HIGH
Import/export fields E-34
Point attributes 10-37, 10-38
SETPOINT_LOW
Import/export fields E-34
Point attributes 10-38
setPointID (Method)
WebGateway, Web data applet G-11
Setpoints
In the Point Control Panel 30-23
Setting CIMPLICITY Startup Options
Windows 98 CimView autostart 3-20
Setting Project Properties 3-3
Setting Runtime alarm properties 20-11
Setting runtime user properties 25-8
Settings Tab
Project Properties 3-7
Setup
Alarm Sound Manager 21-5
Hardware in quick device setup 5-1
Quick device setup 5-1
Quick device setup for a project 5-3
Quick port setup for a project 5-3
Quick protocol setup 5-2
Setup Printer
For Point Control Panel 30-10
Setup Program
Begin for CIMPLICITY registration H-2, H-18
SHORT_FILENAMES 1-55
Shortcut
For Point Control Panel file 30-8
Shortcut keys
Status log viewer J-6
Shortcut Keys
Login panel 32-21
Show Users 32-11
Workbench 2-4
Show Only Used Points
Check box 14-7
Help Menu 32-9
Search Menu 32-10
Index-xxxvii
Index-xxxviii
GFK-1180K
$DEVICE_DOWN 20-2
$DEVICE_FAILOVER 20-3
$DL_FILE_FULL 20-3
$DOWNLOAD 20-3
$DYN_CFG 20-3
$GMR_DEV_DOWN 20-3
$GMR_POINT_DISCREPANCY 20-3
$LOGON 20-3
$LOGOUT 20-3
$REDUND_DEV_DOWN 20-3
$RTR_LINK_DOWN 20-3
AMSI_ALARM 20-3
DB_CONN_DOWN 20-3
DB_START_FORWARD 20-3
MCP_PROC_DOWN 20-3
Start
A halted process 32-27
Alarm Sound Manager with Windows startup 21-11
All halted processes 32-28
CIMPLICITY HMI project 2-17
Login panel 32-13
Point Control Panel 30-3
Point cross reference 14-2
Project CIMPLICITY options list 3-14
Workbench 2-2
Start as a Viewer
CIMPLICITY options 3-13
Starting CimView Screens at Boot
Windows 98 3-18
Starting CWSERV B-7
Startup Options
CIMPLICITY options 3-15
startup.exe 3-28
STARTUP_TIMEOUT 1-55
State
Colors for alarm class states 18-5
Colors for point alarm class states 8-19
STATE B-3
States
Changing color in the Point Control Panel 30-17
Status bar
In Workbench 2-4
Status log viewer
Displaying message details J-8
Filtering messages J-12
Finding messages J-13
Finding the next message J-14
Help menu J-5
Log menu J-4
Menu options J-4
Printing the log file J-10
Process names J-14
Saving status log as a text file J-9
Selecting a log to view J-7
Selecting a printer J-11
GFK-1180K
Index
Index-xxxix
Switch
Projects 2-18
Synchronized
And On Digital Point State 26-53
Data log maintenance event 26-42
Only for timed/gated 26-51
Point data logging 26-36
SYSNAME 1-56
System
CIMPLICITY boot options 3-17
Node and project names 3-4
System - CWSERV System Topic B-13
System Account
CIMPLICITY service 26-125
System Alarms
ALARM_LOG 26-71
EVENT_LOG 26-87
System Authorization Code
For CIMPLICITY H-7
System Key Code
Generate for CIMPLICITY registration H-6
System log and error files J-1
System Management
About 33-1
Deleting Login Information 33-6
Editing global parameters 1-60
Global parameters for device communications 1-58
Global parameters sample file 1-62
Removing CIMPLICITY Software Windows 95
Registry Information 33-7
Removing CIMPLICITY Software Windows NT
Registry Information 33-8
Removing registry information 33-7
Removing Windows 95 Registry information 33-7
Removing Windows NT Registry information 33-8
System Parameters
Editing the logical names file 33-5
Logical names See also Logical names
System Point
$ALARM.ACKED 13-2
$ALARM.ACTIVE 13-2
$ALARM.TOTAL 13-2
$ALARM.UNACKED 13-2
$CLASS.ALARMS 13-2
$CLASS.UNACKED 13-2
$LOCAL.COMPUTER 13-2
$LOCAL.DATE.AMPM 13-3
$LOCAL.DATE.DATETIME 13-4
$LOCAL.DATE.DAY 13-3
$LOCAL.DATE.DAYOFWEEK 13-3
$LOCAL.DATE.DAYOFYEAR 13-3
$LOCAL.DATE.HOUR 13-3
$LOCAL.DATE.HOUR12 13-3
$LOCAL.DATE.MINUTE 13-3
$LOCAL.DATE.MONTH 13-4
Index-xl
$LOCAL.DATE.SECOND 13-4
$LOCAL.DATE.SECONDOFDAY 13-4
$LOCAL.DATE.WEEK 13-4
$LOCAL.DATE.YEAR 13-4
$LOCAL.WINUSER 13-4
$PROJECT 13-5
$PROJECT.AMPM 13-5
$PROJECT.AVAILABLE 13-5
$PROJECT.COMPUTER 13-5
$PROJECT.DATE.DAY 13-5
$PROJECT.DATE.DAYOFWEEK 13-5
$PROJECT.DATE.DAYOFYEAR 13-6
$PROJECT.DATE.HOUR 13-6
$PROJECT.DATE.HOUR12 13-6
$PROJECT.DATE.MINUTE 13-6
$PROJECT.DATE.MONTH 13-6
$PROJECT.DATE.SECOND 13-6
$PROJECT.DATE.SECONDOFDAY 13-6
$PROJECT.DATE.WEEK 13-7
$PROJECT.DATE.YEAR 13-7
$PROJECT.DATETIME 13-7
$PROJECT.DEVICES 13-7
$PROJECT.LOGGEDIN 13-7
$PROJECT.ROLE 13-8
$PROJECT.ROLE.LEVEL 13-8
$PROJECT.USER 13-8
$PROJECT.USER.ALARMS 13-8
$PROJECT.USERS 13-7
System Utilities
About 32-1
Login panel See Login panel
Process control 32-22
Show Users 32-2
Using Program Control 32-22
T
Tab
Advanced alarm 8-13
Advanced device 6-21
Advanced general for device points 6-15
Advanced general for virtual points 7-12
Advanced virtual 7-12
Basic alarm 8-10
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-30
Limits 8-7
View 8-3
GFK-1180K
Table
Close in Database Logger 26-19
Copy in Database Logger 26-12
Create new for logging 26-10
Delete in Database Logger 26-14
Group logging conditions for points 26-62
Logging conditions for alarms 26-77
Logging conditions for point data 26-36
Open in Database Logger 26-11
Reconcile with logging database 26-17
Rename in Database Logger 26-13
Upgrade indexes to 5.5 26-19
Table characteristics
Database logger 27-13
Table Logging Attributes
Alarm logs 26-78
Data point logs 26-40
Event alarm logs 26-93
Group point logs 26-63
Tables
Maintenance actions 26-43
Maintenance events for alarms 26-79
Maintenance events for event alarms 26-94
Maintenance events for point data 26-41
Maintenance events for point groups 26-64
Table logging attributes for alarms 26-78
Table logging attributes for event alarms 26-93
Table logging attributes for group points 26-63
Table logging attributes for point data 26-40
Tabs
In Class object dialog boxes 12-8
Task Bar
Alarm Sound Manager icon 21-14
Tasks
Configure alarm logging properties 26-75
Configure event alarm logging properties 26-91
Configure Event Management action logging
properties 26-103
Configure group point logging properties 26-60
Configure point data logging properties 26-35
TERMSERV_ALLOW_SETPOINTS 1-56
Testing the connection
RAS F-13
Testing the connection, Ping
RAS F-13
Testing the connection, Ping on client
RAS F-13
Testing the connection, Ping on server
RAS F-14
Testing the connections
WebGateway G-5
Text
Enumerated point values 6-37
Virtual point initialization 7-7
GFK-1180K
Index
Text View
In point cross reference 14-5
Review point information in text view pcr
window 14-10
TIME
In Data Report 26-117
Time Last Logged
Group point logging attribute 26-63
Point data logging attribute 26-41
TIME_OF_DAY
Import/export fields E-34
Timed Gated Logging
For data log tables 26-36
Timed/Gated
Logging notes 26-51
Maintenance notes 26-51
Timer/Counter Point 7-39
Timestamp
In Alarm Report 26-123
In Data Report 26-117
In database Logger Group Report 26-120
TIMESTAMP
Point attributes 10-21
Timestamp Filtering 26-24
Toolbar
View options button 14-7
Toolbar buttons
Status log viewer J-6
Toolbar Buttons
Login panel 32-21
Show Users 32-11
Toolbars
Workbench 2-3
Tools
Alarm Sound Manager runtime 21-13
Finding record or file names 2-12
For record and file configuration 2-28
Runtime monitoring 2-32
Topics - CWSERV System Topic B-13
Trans High Accum Points 7-35
Transaction Log
Truncating as CIMPLICITY maintenance
action 27-12
Truncating as system default 27-11
Transfer
License from one computer to another H-21
Transfer CIMPLICITY License H-21
Transfer CIMPLICITY license via the network H-18
Transmissions 6-12
Tree View
In point cross reference 14-5
Review point information 14-10
Trend History
For a device point 6-18
For a virtual point 7-16
Index-xli
Trend Report
Charts 26-121
Database logger 26-118
TRIG_CK_PT
Import/export fields E-34
TRIG_PT
Import/export fields E-34
TRIG_REL
Import/export fields E-35
TRIG_TYPE
Point attributes 10-39
TRIG_VAL
Import/export fields E-35
TRIG_VALUE
Point attributes 10-40
Trigger
Example with virtual points 7-46
Report printing 26-128
Trigger event privilege 24-5
Trigger Function
Explanation for device points 6-24
Explanation for virtual points 7-45
Trigger Point
And equation w/override points 7-38
And min capture point 7-34
And Trans High Accum point 7-36
Equal relation 6-22
Greater than equal 6-22
Greater than relation 6-22
Less than 6-22
Less than equal 6-22
None relation 6-22
On change 6-22
Trigger Points
For device points 6-21
For virtual points 7-20
TRIGGER_POINT
Point attributes 10-39
Triggered Maintenance
For data logs 26-42
Troubleshooting
WebGateway G-7
Truncate
Timestamps filter 26-24
Trusted
User access 28-3
TWIPS
Definition 1-38
Two Pages Button 30-9
Type
Of points 4-2
TYPE B-4
Index-xlii
U
UDINT 6-4
UINT 6-4
Uninstall
CIMPLICITY in Windows NT I-2
Unregister
CIMPLICITY H-32
Unsolicited 6-10
Unsolicited On Change 6-11
Update
Criteria for a device point 6-10
Project after a change 2-25
Update Criteria
And trigger function for device points 6-24
And trigger function for virtual points 7-45
UPDATE_CRITERIA
Import/export fields E-35
Upgrade
CIMPLICITY HMI H-11
Functional registration H-11
Installing licenses H-13
Lower than version 3.0 registration H-15
Table indexes to 5.5 26-19
V3.0 or higher registration H-13
Version 4+ registration H-13
UR_LOGIN_FAILURES 1-57
Used Points
Viewing 14-5
User Account
CIMPLICITY service 26-124
User Attributes
Role Id 25-2
User Id 25-2
User Name 25-2
User configuration 25-1
Creating a new user 25-3
Setting runtime user properties 25-8
User Configuration
Modifying an existing user 25-4
Runtime login failures 25-9
User Flags
Group point logging attribute 26-64
Point data logging attribute 26-41
User General Properties 25-5
Password 25-5
Password Needed 25-5
Role 25-5
User Name 25-6
User Identification
Automatic access 28-3
User Information
Preparing for CIMPLICITY registration H-4
User properties
Runtime 25-8
GFK-1180K
V
VAL
In Data Report 26-117
Valid
Operators and custom conversion 6-36
validating project connections
WebGateway G-5
Validating web connections
WebGateway. G-6
Value
Add a global parameter 1-7
Edit for global parameter 1-4
VALUE B-3
Value Accum Point 7-27
Values
Assign to a class object 12-8
Enumerated for points 6-37
General for class object 12-10
Store for virtual points 7-9
Variables
$CLASS 11-32
$ID 11-32
$OBJECT 11-32
VARIANCE_VAL
Import/export fields E-36
VARIANCE_VALUE
Point attributes 10-40
Variations
Handling Machine Edition integration D-3
VARS
Import/export fields E-36
Version Upgrade 4+ Registration H-13
Version Upgrade From lower than 3.0
Registration H-15
Version Upgrade From V3.0 or higher registration H-13
GFK-1180K
Index
View
A point in point cross reference 14-9
All files for an object 2-9
All records for an object 2-9
Change the left pane 2-7
Change the right pane 2-8
Global parameters in the Workbench A-2
Logged alarm data 26-123
Logged group point data 26-120
Logged point data 26-117
Open tab 8-2
Point Control Panel 2-36
Point cross reference window 14-4
Point information in tree view pcr window 14-10
Refresh in point cross reference window 14-8
Selected files for an object 2-10
Selected records for an object 2-10
View Menu
Login panel 32-21
Show Users 32-9
View Options
change in Show Users 32-4
Dialog box 14-7
Viewer
Connectivity with Machine Edition point data D-3
Viewing log and error files J-1
Viewing user properties for a resource 16-4
W
WARN_ENABLED B-6
Warning
Update 2-25
WARNING_HIGH B-5
Point attributes 10-40
WARNING_LOW
Point attributes 10-41
WARNING_LOW B-5
Wave
Sound for an alarm class 18-7
Web server requirements
WebGateway G-2
WebGateway
About G-1
Components G-3
Error messages G-7
Error messages,
#ERROR!ARAYNOTALLOWED G-7
Error messages,
#ERROR!ARRAYOUTOFBOUNDS G-7
Error messages,
#ERROR!BADSERVERRESPONSE G-7
Error messages,
#ERROR!CIMPLICITYNOTRUNNING G-7
Error messages, #ERROR!INVALIDPOINTID G-8
Index-xliii
Index-xliv
Workbench
Add global parameter 1-7
Add points to the Point Control Panel 30-14
Delete global parameter 1-9
Edit global parameter 1-4
Global parameters application A-2
Shortcut Keys 2-4
Z
Zero
Justification for an analog point 8-3
Zoom
CimView screen display size 29-9
GFK-1180K