Uploaded by dariojampy

iFIX Fundamentals Student Manual

advertisement
PROFICY ® SOFTWARE
IFIX FUNDAMENTALS
EDUCATION SERVICES
STUDENT
MANUAL
GFS-154K
Copyright 2024 GE Vernova
Do not copy or distribute
training.ip@ge.com
PROFICY ® SOFTWARE
iFIX Fundamentals
At the end of this training course, you will be able to:
 Configure and launch iFIX projects
 Define basic configurations with the SCU
 Build and troubleshoot I/O Driver configurations
 Add, delete and modify tags using both Thick and Thin Client tools
 Create Graphics, Animations and Control within the Workspace
 Write and configure scripts with VBA in the Workspace Visual Basic
Editor (VBE)
 Understand and implement Global objects
 Create and maintain display navigation schemes inc Reusable
displays
 Manage and display process alarms and events
 Archive and trend historical data
 Deploy a system-wide security scheme

Proficy iFIX Fundamentals
ii
Education Services
GFS-154K
Proficy iFIX Fundamentals
Special Features of this Book
Glossary
Occasionally in the text, you will find highlighted words. These words are key terms
in the study of this subject.
Note
Notes merely call attention to information that is especially significant to
understanding the content of this manual.
Tip
In the text of some pages, you may find a Tip Icon. Tips are either reminders
or shortcuts to help you complete a task more efficiently.
Warning / Important
Warnings or Important information are presented like this. They often
specify actions that if not followed will likely cause a problem.
Copyright© 2024 GE Vernova
All Rights Reserved
This document is based upon information available at the time of its publication. While efforts have
been made to render accuracy to its content, the information contained herein does not purport to
cover all details or variations in hardware or software, nor to provide for every possible contingency
in connection with installation, operation, and maintenance. Features may be described herein
which are not present in all hardware and software systems. GE Vernova assumes no obligation of
notice to holders of this document with respect to changes subsequently made.
GE Vernova makes no representation or warranty, expressed, implied, or statutory with respect to,
and assumes no responsibility for the accuracy, completeness, sufficiency, or usefulness of the
information contained herein.
Proprietary information of GE Vernova is furnished for customer use only. No other uses are
authorized without written permission of GE Vernova.
 Proficy is a trademark of GE Vernova, Inc.
 Microsoft is a trademark of The Microsoft Corporation, Inc.
GFS-154K
Education Services
iii
Proficy iFIX Fundamentals
Table of Contents
1
iFIX Introduction .......................................................................................... 1-1
Proficy iFIX Overview ....................................................................... 1-3
Client Server Architecture ................................................................ 1-5
Licensing .......................................................................................... 1-6
iFIX Technologies.............................................................................. 1-9
iFIX Core Development.................................................................... 1-11
Troubleshooting Topic ................................................................... 1-15
eBooks Topic .................................................................................. 1-15
Lab Exercise #1 – Investigate student computer / Online Help ... 1-17
(Optional) Lab Exercise #2 – Sample System ............................... 1-19
(Optional) OLT Integrated Learning Lab ...................................... 1-21
Review Questions ........................................................................... 1-22
Review ............................................................................................ 1-23
2
iFIX Architecture and Applications ............................................................. 2-1
Architecture Overview..................................................................... 2-3
Data Flow.......................................................................................... 2-9
iFIX Applications .............................................................................2-10
Project Management ..................................................................... 2-25
iFIX Fundamentals class example system ................................... 2-26
Troubleshooting Topic .................................................................. 2-28
eBooks Topic ................................................................................. 2-29
Lab Exercise #1 – Investigate the SCU ........................................ 2-31
Lab Exercise #2 – Create a simple display .................................. 2-37
(Optional) OLT Integrated Learning Lab ......................................2-51
Review Questions .......................................................................... 2-52
Review ............................................................................................ 2-53
3
Communications .......................................................................................... 3-1
Communications Overview ............................................................. 3-3
I/O Drivers and OPC Servers........................................................... 3-4
IGS Driver ......................................................................................... 3-8
Monitoring IGS Communications .................................................. 3-20
Version 7.x I/O Driver Configuration Basics ................................. 3-22
SIM Driver ....................................................................................... 3-31
SCADA Components in the SCU................................................... 3-33
Troubleshooting Topic .................................................................. 3-34
eBooks Topic ................................................................................. 3-34
Lab Exercise #1 – Configure the IGS Driver ................................. 3-35
Lab Exercise #2 – Access the IGS Driver in Configuration Hub . 3-49
(Optional) Lab Exercise #3 – Installing v7.x MBE Driver ............. 3-53
(Optional) OLT Integrated Learning Lab ..................................... 3-60
Review Questions .......................................................................... 3-61
Review ............................................................................................ 3-62
iv
Education Services
GFS-154K
Proficy iFIX Fundamentals
4
Alarms.......................................................................................................... 4-1
Alarms Overview .............................................................................. 4-3
Message Formats ............................................................................ 4-4
Alarm Areas ...................................................................................... 4-4
Alarm Area Database ....................................................................... 4-5
Alarm Services ................................................................................. 4-5
Troubleshooting Topic .................................................................. 4-10
eBooks Topic .................................................................................. 4-11
Lab Exercise #1 – Alarm Services ................................................. 4-13
Lab Exercise #2 – Apply Alarm Areas and Shelving Polices ........ 4-17
(Optional) OLT Integrated Learning Lab ..................................... 4-21
Review Questions .......................................................................... 4-22
Review ............................................................................................ 4-23
5
Process Database – Thick Client Configuration.......................................... 5-1
Database Overview ......................................................................... 5-3
Database Tags ................................................................................. 5-4
Database Manager .......................................................................... 5-8
Analog Tags ................................................................................... 5-13
Register Tags ................................................................................. 5-22
Troubleshooting Topic .................................................................. 5-24
eBooks Topic ................................................................................. 5-25
Lab Exercise #1 – Database Manager .......................................... 5-27
Lab Exercise #2 – Add Analog Tags ............................................. 5-33
(Optional) OLT Integrated Learning Lab ..................................... 5-43
Review Questions .......................................................................... 5-44
Review ............................................................................................ 5-45
6
Process Database – Thin Client Configuration ........................................... 6-1
Introduction to Configuration Hub .................................................. 6-3
Configuration Hub Panels ............................................................... 6-4
Digital Tags ...................................................................................... 6-9
Troubleshooting Topic ...................................................................6-18
eBooks Topic ................................................................................. 6-20
Lab Exercise #1 – Thin Client Maintenance of a PDB ...................6-21
Lab Exercise #2 – Mass Creation of Model and Database ......... 6-29
(Optional) OLT Integrated Learning Lab ..................................... 6-39
Review Questions .......................................................................... 6-40
Review ............................................................................................ 6-39
GFS-154K
Education Services
v
Proficy iFIX Fundamentals
7
Pictures and Templates............................................................................... 7-1
Overview .......................................................................................... 7-3
Workspace Documents ................................................................... 7-4
Picture Basics................................................................................... 7-5
Creating Pictures ............................................................................. 7-6
Editing Pictures ............................................................................... 7-10
Workspace User Preferences ........................................................ 7-13
Troubleshooting Topic ................................................................... 7-18
eBooks Topic .................................................................................. 7-18
Lab Exercise #1 – User Preferences - Defaults ............................ 7-19
Lab Exercise #2 – Create a Picture Layout .................................. 7-23
(Optional) OLT Integrated Learning Lab ..................................... 7-32
Review Questions .......................................................................... 7-33
Review ............................................................................................ 7-34
8
Introduction to Workspace .......................................................................... 8-1
Overview .......................................................................................... 8-3
Workspace Orientation .................................................................... 8-4
Workspace Ribbons ......................................................................... 8-5
Building Displays ............................................................................. 8-11
Troubleshooting Topic .................................................................. 8-13
eBooks Topic ................................................................................. 8-14
Lab Exercise #1 – Access a Remote iFIX SCADA Node ...............8-15
Lab Exercise #2 – Start to Create the HMI Pictures.....................8-19
(Optional) OLT Integrated Learning Lab ..................................... 8-27
Review Questions .......................................................................... 8-28
Review ............................................................................................ 8-29
9
Graphics Objects ......................................................................................... 9-1
Overview .......................................................................................... 9-3
Objects and Properties.................................................................... 9-4
Property Window ............................................................................. 9-5
Datalinks ........................................................................................... 9-7
The Expression Builder .................................................................... 9-8
Data Source Syntax ......................................................................... 9-9
Tag Status, Quick Trend and Tag Control Panel ......................... 9-10
Troubleshooting Topic .................................................................. 9-13
eBooks Topic ................................................................................. 9-14
Lab Exercise #1 – Using the Property Window .............................9-15
Lab Exercise #2 – Adding Datalinks ............................................. 9-19
Lab Exercise #3 – Add the additional Ingredient Tanks ............. 9-23
(Optional) OLT Integrated Learning Lab ..................................... 9-25
Review Questions .......................................................................... 9-26
Review ............................................................................................ 9-27
vi
Education Services
GFS-154K
Proficy iFIX Fundamentals
10 Data Entry and Control .............................................................................. 10-1
Overview ........................................................................................ 10-3
Datalink ........................................................................................... 10-4
Data Entry Experts ..........................................................................10-5
Digital Point Experts ...................................................................... 10-9
Key Macro Editor .......................................................................... 10-11
Summary of Data Entry Methods ................................................ 10-14
Troubleshooting Topic ................................................................. 10-15
eBooks Topic ................................................................................ 10-16
Lab Exercise #1 – Data Entry using Datalinks and Experts ........ 10-17
(Optional) OLT Integrated Learning Lab ................................... 10-28
Review Questions ........................................................................ 10-29
Review .......................................................................................... 10-30
11 Global Objects ............................................................................................ 11-1
Overview ......................................................................................... 11-3
User Globals .................................................................................... 11-4
Global Variables .............................................................................. 11-4
Global Threshold Tables ................................................................ 11-6
Global Key Macros .......................................................................... 11-8
Global Procedures and Forms ....................................................... 11-9
Troubleshooting Topic ................................................................. 11-10
eBooks Topic ................................................................................ 11-12
Lab Exercise #1 – Create Global Variables ................................. 11-13
Lab Exercise #2 – Create Global Threshold Tables ................... 11-15
Lab Exercise #3 – Create Global Key Macros............................. 11-19
(Optional) OLT Integrated Learning Lab .................................... 11-22
Review Questions ......................................................................... 11-23
Review ........................................................................................... 11-24
12 Animations ................................................................................................. 12-1
Overview ........................................................................................ 12-3
Animation Experts .......................................................................... 12-4
The DataLink Revisited................................................................. 12-12
Basic Animation Dialog ................................................................. 12-13
Advanced Animation Dialog ......................................................... 12-14
Animation Objects and Data Conversion .................................... 12-16
Troubleshooting Topic ................................................................. 12-18
eBooks Topic ................................................................................ 12-19
Lab Exercise #1 – Animate Objects in the Ingredients display .. 12-21
Lab Exercise #2 – Animate Objects in the Packaging display .. 12-29
(Optional) OLT Integrated Learning Lab ................................... 12-40
Review Questions ......................................................................... 12-41
Review .......................................................................................... 12-42
GFS-154K
Education Services
vii
Proficy iFIX Fundamentals
13 Introduction to VBA ................................................................................... 13-1
Overview ........................................................................................ 13-3
iFIX Workspace Scripting .............................................................. 13-4
Visual Basic for Applications ......................................................... 13-4
Visual Basic Editor Orientation...................................................... 13-5
Microsoft and iFIX Automation Help ............................................. 13-8
Objects, Properties, Methods, Events......................................... 13-10
Subroutines ................................................................................... 13-12
Commonly Used iFIX Subroutines and Functions ...................... 13-13
Commonly used Microsoft Subroutines and Functions ............. 13-14
Troubleshooting Topic ................................................................. 13-15
eBooks Topic ................................................................................ 13-16
Lab Exercise #1 – Project User and Forms ................................. 13-17
Lab Exercise #2 – Control using VBA in the Packaging picture 13-21
(Optional) OLT Integrated Learning Lab ................................... 13-27
Review Questions ........................................................................ 13-28
Review .......................................................................................... 13-29
14 Navigation.................................................................................................. 14-1
Overview ........................................................................................ 14-3
Navigation Essentials .................................................................... 14-4
Navigation Experts ........................................................................ 14-6
Scripts............................................................................................. 14-8
User Preferences ........................................................................... 14-9
Troubleshooting Topic ................................................................. 14-10
eBooks Topic ................................................................................ 14-10
Lab Exercise #1 – Prepare all Main screens for navigation ....... 14-11
Lab Exercise #2 – Configure the Header picture for navigation14-19
(Optional) Lab Exercise #3 – Configure Footer navigation ....... 14-25
(Optional) OLT Integrated Learning Lab ................................... 14-27
Review Questions ........................................................................ 14-28
Review .......................................................................................... 14-29
15 Monitoring Alarms ......................................................................................15-1
Overview ........................................................................................ 15-3
Alarm Services Review .................................................................. 15-4
Alarm Messages..............................................................................15-5
Alarm Summary ...............................................................................15-6
Alarm Summary Configuration ....................................................... 15-7
Alarm Fields and Counters ........................................................... 15-15
Troubleshooting Topic ................................................................. 15-16
eBooks Topic ................................................................................ 15-17
Lab Exercise #1 – Alarm Summary configuration ....................... 15-19
Lab Exercise #2 – Alarm Counters ............................................. 15-29
(Optional) OLT Integrated Learning Lab ................................... 15-30
Review Questions ......................................................................... 15-31
Review .......................................................................................... 15-32
viii
Education Services
GFS-154K
Proficy iFIX Fundamentals
16 Reusable Displays ...................................................................................... 16-1
Overview ........................................................................................ 16-3
Model Substitution versus Tag Groups ........................................ 16-3
Asset Model Substitution .............................................................. 16-4
Tag Group Substitution .................................................................. 16-7
Troubleshooting Topic ................................................................. 16-10
eBooks Topic ................................................................................ 16-11
Lab Exercise #1 – Build a re-usable display ................................ 16-13
Lab Exercise #2 – Load with Model Substitution Parameters ... 16-19
(Optional) OLT Integrated Learning Lab ................................... 16-23
Review Questions ........................................................................ 16-24
Review .......................................................................................... 16-25
17 Historical Collection ................................................................................... 17-1
Overview ......................................................................................... 17-3
iFIX Collector for Proficy Historian ................................................ 17-4
SCU and the iFIX Data Collector .................................................... 17-4
Workspace as a Proficy Historian Client ....................................... 17-5
Tag Configuration ........................................................................... 17-6
Collector Configuration .................................................................. 17-8
Adding Tags to the iFIX Data Collector ......................................... 17-9
Adding All iFIX Tags to the iFIX Data Collector ........................... 17-11
Troubleshooting Topic ................................................................. 17-12
eBooks Topic ................................................................................ 17-13
Lab Exercise #1 – Configure the iFIX Data Collector .................. 17-15
(Optional) OLT Integrated Learning Lab ................................... 17-23
Review Questions ........................................................................ 17-24
Review ...........................................................................................17-25
18 Analytical Displays .................................................................................... 18-1
Overview ........................................................................................ 18-3
Line Multiline Chart Object ............................................................ 18-4
Data Sources ...................................................................................18-5
iFIX as a Historical HMI ...................................................................18-9
Display Time Controls .................................................................. 18-11
Troubleshooting Topic ................................................................. 18-12
eBooks Topic ................................................................................ 18-13
Lab Exercise #1 – MultiLine Chart object .................................... 18-15
Lab Exercise #2 – Historical Datalinks ........................................ 18-21
Lab Exercise #3 – Global Time Controls .................................... 18-23
(Optional) OLT Integrated Learning Lab ................................... 18-25
Review Questions ........................................................................ 18-26
Review ...........................................................................................18-27
GFS-154K
Education Services
ix
Proficy iFIX Fundamentals
19 Security ...................................................................................................... 19-1
Overview ........................................................................................ 19-3
Security Configuration................................................................... 19-4
Specify Security File Locations......................................................19-5
Specify Security Areas ...................................................................19-5
Create Security Groups and Privileges ........................................ 19-6
Configuration Hub Groups ............................................................ 19-6
Define and Assign local iFIX Users ................................................ 19-7
Define and Assign Windows iFIX Users ........................................19-8
Auto Login ...................................................................................... 19-9
Assign Security Areas to Tags and Pictures............................... 19-10
VBA and Security .......................................................................... 19-11
Setting Environment Protection for the Workspace .................. 19-12
Logging into Security.................................................................... 19-13
Proficy Authentication .................................................................. 19-14
Troubleshooting Topic ................................................................. 19-15
eBooks Topic ................................................................................ 19-16
Lab Exercise #1 – Security Configuration Utility......................... 19-17
Lab Exercise #2 – Securing Pictures and Tags ......................... 19-25
Lab Exercise #3 – Running a Secure HMI ................................... 19-31
(Optional) OLT Integrated Learning Lab ................................... 19-34
Review Questions ........................................................................ 19-35
Review .......................................................................................... 19-36
20 iFIX Thin Client Access .............................................................................. 20-1
Proficy iFIX Thin Client interfaces ................................................ 20-3
Configuration Hub.......................................................................... 20-4
Webspace....................................................................................... 20-8
Operations Hub (Web HMI) ......................................................... 20-10
Remote Desktop .......................................................................... 20-13
Troubleshooting Topic ................................................................ 20-15
eBooks Topic ............................................................................... 20-16
Lab Exercise #1 – Investigate Configuration Hub...................... 20-17
Lab Exercise #2 – Investigate a Webspace Session ................. 20-19
Lab Exercise #3 – Investigate Operations Hub - Web HMI ...... 20-21
(Optional) OLT Integrated Learning Lab ................................... 20-25
Review Questions ........................................................................ 20-26
Review .......................................................................................... 20-27
x
Education Services
GFS-154K
0)
01
INTRODUCTION
a
At the end of this module, you will be able to:
 Describe the basic concepts of the iFIX
HMI/SCADA
 List the high-level iFIX features
 Discuss topics in HMI/SCADA development
 Explain the Application Development Steps
5%
Proficy iFIX Fundamentals - Introduction
1-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction
Proficy iFIX Overview
What is iFIX?
Modern industry, whether manufacturing dog food or drugs; processing water or
whiskey; baking bread or beans, demands an efficient interaction between plant and
personnel.
Operators must be informed in real time, able to assert control instantaneously.
iFIX is the solution.
One of its roles is to inform and alert the viewer using easily digestible, intuitively
designed displays, often pictorial, while providing user interaction and recording
significant events.
These are among the tenets of any modern Human Machine Interface, the HMI.
iFIX is an HMI.
HMIs, in the broad sense are all around us in today’s modern consumer world.
From making fast food choices, selecting delectable sides and drinks, to observing
fitness statistics on a smart watch, to the in car HMI, providing key driving information
and alerts.
In car HMIs are a great example. Low cost technology advancements have accelerated
their adoption.
Efficient presentation of driving information, sometimes allowing modifications to how the
data is presented, is provided by the manufacturer - the designer.
With iFIX, YOU are the designer. You decide how the information is presented; you decide
how the Human interacts with the Machine.
iFIX is a fully customizable HMI.
Less obvious are the components which route the data from source to HMI.
In the car example, think of where and how data is measured. The road speed, the tyre
pressures, the remaining charge in an EV’s battery.
Measurement sensors are interrogated. Their data processed, recorded, and routed to
the HMI.
This process is effectively the SCADA. Data Acquisition, with a dash of Supervisory
Control.
iFIX is a SCADA.
Real time HMI?
Traditionally, HMIs have traded only in Real Time data. When a sensor supplies a changed
value, the previous value is lost in the darkness of time.
iFIX in pure isolation is a Realtime SCADA / HMI.
However, coupled with Proficy Historian, which has capabilities included free of charge
with every iFIX SCADA license, important data can be captured, then processed to
provide a myriad of analytic capabilities.
In today’s efficiency conscious businesses, Historical Data and the analysis thereof is
king.
iFIX is capable of interactive intelligent analysis of this Historically captured data.
GFS-154K
Education Services
1-3
Proficy iFIX Fundamentals - Introduction
Proficy iFIX is a Windows-based HMI/SCADA component
of the Proficy family of software automation products.
Based on open, component-based technology, iFIX is
designed to allow easy integration and interoperability
between plant floor devices and business systems.
It includes functional and architectural features that
reduce the design time for automation projects, allow
simple system upgrades and maintenance, provide
seamless integration with third-party applications, and
increase productivity.
Figure 1-1. Proficy Applications
As a SCADA (Supervisory Control And Data Acquisition), iFIX is tasked with the collection
or acquisition of process control data, as well as enabling automatic or manual control
over the process equipment or devices. The SCADA component can also “manage”
information for other users on the network. Generally, this includes judging conditions
and generating alarms, providing sampled data to a local or Plant wide Historian, as well
as reporting and interacting with other applications using plant floor data. SCADA is
server-based.
Figure 1-2. SCADA & HMI
As an HMI (Human Machine Interface), iFIX provides a user with a graphical interface that
displays current operating and safety conditions. It also accepts control instructions and
feedback from the user. It will receive and send all of its information through the SCADA.
HMI is client-based.
1-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction
Client-Server Architecture
The relationship between HMI and SCADA is often termed a Client-Server relationship.
One of the key features of iFIX is the way it uses a Client-Server relationship for
application development and operation, in addition to the more basic role of moving
information around a network.
The SCADA server in this client-server relationship, is the central repository for process
data. It is responsible for collecting and updating the information from attached
equipment or devices. It organizes the information and provides friendlier labelling and
context for operators and other users. It also generates new information based on the
incoming updates. The server does not broadcast all this information across the network;
it waits for clients to request specific data and then it responds to the clients with only
the data that was requested. This ensures clean and efficient transfer of data over the
network.
The HMI Client in this client-server relationship, requests data from a server through its
graphical user interface (GUI). It does not store or copy data from the server to local files
or databases, but instead interacts with the data in the central repository at real-time.
Examples of data requests are links in graphic displays, alarms in summary tables, trends
in charts, content for reports, etc.
With iFIX, a Client-Server relationship encompasses all real-time data collection and
management; be it for current process values, control set points, alarms or internal logic.
It is also extended to the configuration of iFIX on the network. Developers can use
“remote” iFIX installations to develop iFIX applications on PCs deployed around the
network. The settings and applications are usually configured in situ on the target
machine, not on the developer’s machine. This avoids any requirement to maintain
duplicate files in multiple locations, and also ensures that the management of iFIX
applications is simple, efficient and direct.
Figure 1-3. Server & Client
GFS-154K
Education Services
1-5
Proficy iFIX Fundamentals - Introduction
Licensing
A computer with a licensed iFIX installation is referred to as a NODE. iFIX is licensed in
categories depending on the functionality required by users.
SCADA vs. HMI
The SCADA component is licensed as a SCADA Server node.
The HMI component is licensed as a Client node.
These components can be licensed separately, or in combination. On larger, more highly
segregated networks, SCADA servers are used solely for data acquisition and
management and Clients are kept on separate PCs as remote visualization interfaces. In
smaller, more isolated applications, a SCADA server may be bundled with a Client into a
single license, providing both the data management and visualization components on one
PC.
Run-time vs. Development
Licensing can also be categorized by whether or not a
Development or configuration capability is included. By default,
every license has capabilities allowing for the execution of files
and processes. These types of licenses are referred to as RunTime licenses. The ability to configure or develop HMI/SCADA
features and content can be added to this default capability.
This dual Run-Time and Development capability is simply
referred to as a Development license.
Runtime
Development
Development Clients can configure all the visualization
components of an HMI. In addition, they can configure the other
components of iFIX, such as data acquisition and management
features, even though the Client is restricted from running these
components by the license. In this scenario, the Client connects
to the SCADA and changes the files and settings in situ. An
example being remotely editing the tag database or the I/O
Driver configuration.
Figure 1-4. Development vs Runtime
Both Client and Server could be licensed as either Development or Runtime, however it is
very common to have a Development Client and a Runtime SCADA Server.
1-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction
Development of SCADA components is also
possible via a thin client interface known as
Configuration Hub
SCADA Development
Configuration Hub. This web-based environment
HTML5 Browser
exposes iFIX Communication Drivers, the iFIX
Process Database and Asset Models which can be
used to speed development of the iFIX Process
Database and subsequently reusable HMI displays.
A Development License however would still be
required on the target SCADA server.
The obvious advantage is that many development
Figure 1-5. SCADA web-based Development
tasks can be performed remotely with no need for
any iFIX software or license, to be installed locally.
This same web-based environment can also be used to configure Proficy Historian.
GFS-154K
Education Services
1-7
Proficy iFIX Fundamentals - Introduction
License Comparison
iFIX Plus
This is a Development, Runtime or Blind (no HMI) SCADA Server and includes Networking
allowing remote iFIX Clients to connect. It has a spectrum of SCADA Tag counts from 75
to Unlimited*.
Proficy Historian Essentials of up to 1000 permanent tags is included.
iFIX Standard (Standalone)
This is a Development or Runtime SCADA Server and does not include Networking, thus
remote iFIX Clients cannot connect. It has a spectrum of SCADA Tag counts from 75 to
Unlimited*.
Proficy Historian Essentials of up to 1000 permanent tags is included.
iFIX IoT
This is a lightweight version of iFIX designed to run only on Windows 10 IOT Enterprise or
Windows 7 Embedded OS. It has a limited SCADA Tag count of 100, 500, 1500 or 5000.
Proficy Historian Essentials of up to 1000 permanent tags is included.
iFIX Options
Additional options can be added to many of these licenses. These include:
 IGS Driver (Basic or additional protocols)
 iClients or TS (Terminal Services) Clients (thick or thin remote clients)
 OPC UA Client Driver (connect to OPC UA Servers, using their data as a SCADA Tags
source)
 Additional OPC UA Server connections (2 included, maximum 10)
 SCADA Synchronization (High Availability, license for Primary and Backup SCADA Nodes)
 Electronic Signatures (signing and recording of actions such as tag writes or alarm
acknowledgment)
 iPower (extensive add on solution for the Power and Utility industries)
 Win-911 (Alarm notification)
* SCADA Tags counts are 75, 150, 300, 900, 1500, 10000, 30000, Unlimited.
Note
Since Licensing deals can change, always check the latest pricing guide, or with
your sales representative for the most up to date information.
1-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction
iFIX Technologies
iFIX is an application based on industry standards. It uses standard communication
protocols for networking and inter-application connections, as well as various database
access methods in order to move data in and out of the application. This ensures that
iFIX can be integrated with a wide range of products from the many vendors in various
industries.
Within the application, modern standards and technologies are used to maximize
flexibility, interoperability and extensibility. This helps engineering and maintenance staff
to rapidly design, build and deploy the application, as well as keep it running at a high
level of performance with less effort.
Communications
iFIX is a Windows-based platform that supports a wide range of standard technologies to
facilitate data movement around a network and to other applications. These include:
 TCP/IP networking protocol used to for both iFIX node and Control Device
communications
 OPC is found at the Control Device communications, SCADA and HMI layers. These may
be OPC DA, OPC UA or OPC A&E
 ODBC, OLEDB and ADO for external Relational Database access
 VBA scripting and automation for application interoperability
Figure 1-6. iFIX communications methods
GFS-154K
Education Services
1-9
Proficy iFIX Fundamentals - Introduction
HMI
The visualization component supports technologies that add functionality and flexibility
for development and maintenance efforts. iFIX includes:
 An object-oriented graphic and component architecture that supports COM/DCOM.
 High Performance Graphics (ISA 101)
 Large Dynamic Object libraries (Dynamos)
 Choice of Clients. Thin Clients (HTML5), Thin (Remote Desktop Services) and Thick
Clients
 Historical event playback for troubleshooting.
 VBA scripting and automation. Including Forms and Toolbars (customized or standard).
 Schedules for automating data transfer activities or control actions.
 Support for integration of ActiveX objects, documents and controls.
 Support for integration of .NET Components.
 A Cross-Reference Utility for reporting links between objects, displays, scripts and the
Process Database tags.
 A Profile Manager for managing iFIX projects.
 Built-in security features that comply with 21 CFR Part 11 FDA regulations.
 Configurable Ribbon and Menu option with Office themes
 A project-specific Backup and Restore utility (that can be automated).
1-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction
iFIX Core Development
This Fundamentals course will cover the steps required to build a networked HMI/SCADA
application. Below is a summary of the basic steps involved in this process. With the
exception of the base system configuration, all components can be developed or
configured on-line while the system is running (with no requirement to stop and restart).
Base System Configuration, Project folders, Networking and Application
tasks
Before starting, there are basic settings that need to be configured in order to start iFIX
with a unique network identity, using a specific set of system folders. This configuration
will also have settings to build network connections to networked SCADA nodes. Finally,
a start up list for applications can be built to direct iFIX to start required applications
along with iFIX.
I/O Communications
IO communications to plant sensors and process control hardware must be created
before a SCADA can send or receive data from the plant floor. This requires an I/O Driver
or OPC server software installation, configuration and deployment. Once ready, the
SCADA can use the drivers or servers to communicate with multiple supported PLC, DCS,
or RTU control hardware devices.
Process Database
The Process Database is a proprietary database that organizes and sorts process data
into individual units of information called tags. Tags can interact with I/O
communications to read and write data to the control hardware. Tags can also be linked
together to create or process internal data for calculations, secondary functions, and
internal logic.
Asset Models
Asset Models contain defined Object Types and deployed Object Instances.
Models Types define the structure of the equipment pieces within a particular level in a
logical hierarchy and may have Data Variables declared, such as Level, Flow, Speeds, etc
for an actual process unit, or simpler KPIs for a Line or Plant.
A deployed instance of an Object Type will be for a specific use, such as a tank
containing a process ingredient, with variables bound to specific data sources such as
iFIX Process Database Tags.
Using Models, the Process Database Tags associated with the Object Instances can be
created when the Model is deployed and Published. This can significantly reduce
development time, especially on a system with many repeatable process units.
GFS-154K
Education Services
1-11
Proficy iFIX Fundamentals - Introduction
Alarm detection and generation
Tags can also be configured with limits and conditions to assist with alarm detection and
generation. These alarms are delivered to various alarm sub-systems (or services) such
as an alarm summary table, alarm printers, alarm files or external databases.
Historical Data and Alarm Archiving
iFIX is able to supply both Data, and Alarms and Events to Historical repositories. An iFIX
SCADA license allows use of the Proficy Historian Essentials Edition to store up to 2500
Tags on a 200 day rolling buffer, as well as permanently store Tags, the number of which
is based on the SCADA License purchased. Alarms and Events from iFIX can be passed to
a Relational Database such as Microsoft SQL Server.
If a separate instance of Proficy Historian is available with an Enterprise license, then
both Data and Alarms and Events can be Collected.
With iFIX v2022, the Essentials addition of Proficy Historian and these Data and Alarms
Collectors are part of the default integrated installer, completed in a few clicks.
External Application Communications
iFIX can be linked to external applications to facilitate data transfer for tasks such as
analysis, reporting and recipe management. These include business programs such as
office applications, databases and scheduling systems or operational programs such as
recipe management, quality control or lab testing applications.
Pictures and Templates
HMI development mainly entails building a graphical interface for operators and other
users. These graphics feature plant floor representations of equipment, alarm notification
screens, historical data trending and analysis, as well as features that allow control and
interaction with the control system. Objects can be Animated from several sources, but
typically either directly from a Process Database Tag value, or from an Object in a
deployed Model.
Reporting interfaces are often included along with specific analysis displays.
Global Features
Global objects, forms, symbols and scripts can be created to speed development and
streamline maintenance. Generally, global features should be created early on and used
as standardized components in the HMI.
1-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction
Navigation and Scripted Features
Navigation is built to allow the operators to move through the available displays and
application features.
VBA is embedded in the HMI development environment. It allows developers to extend
the standard features of the product through scripting. Custom forms, objects, symbols,
toolbars and other display features can be created and deployed with VBA scripting from
within the documents supported in the HMI environment.
Reusable displays
Deployed Object Models can be used as a source for reusable displays. A universal
screen can be designed, for example to represent an ingredient tank with its various
variables. Crucially however data sources will contain a Model Substitution Parameter.
After building this universal screen, these Substitution Parameters can be loaded with a
specific value for the individual process unit.
Alternatively, iFIX supports the legacy Tag Group system, which achieves the same result
but uses mapping lists in a Tag Group File to hold substitution parameters.
Analytical Displays
iFIX is able to access data from various archival databases or Historians to provide
analysis of data over long time periods. The primary source would be Proficy Historian,
either on the SCADA using the Essentials Edition or a remote Historian with its own
license. Traditional charts and grids for trend analysis viewing and reporting purposes are
available as part of the iFIX HMI displays. Display screens can also use almost any
animated object to present historical data values, creating the possibility of a time
controlled Historical HMI.
Alarm Notification
Display screens can also incorporate tables, grids and links to provide immediate
notification and management of network-wide system alarms. In addition, there are
controls available for sorting, filtering, acknowledging, and clearing alarms generated by
SCADAs around the network. Archived alarms can also be reviewed through a variety of
interfaces.
Security Features
iFIX has numerous security features to restrict access to system components and
content. Access to application features, individual displays, objects, scripts and tags can
be governed through the use of Groups, Users and various classification Areas.
Users and Groups can be contained in iFIX only, or from a site wide Proficy Authentication
(UAA) source and well as Windows accounts through local or domain sources or LDAP(s).
The iFIX security schemes provide support for 21 CFR Part 11 security features (required
in FDA validated applications).
GFS-154K
Education Services
1-13
Proficy iFIX Fundamentals - Introduction
Application Development Flowchart
iFIX can be developed in any number of ways. However, we will be following this general
outline for application development. Many components within the system depend on
others, so it is logical to work on components only after their dependencies have been
satisfied. This progressive approach builds from step to step, and is generally a good
practice to follow.
Figure 1-7. iFIX SCADA development steps
Figure 1-8. iFIX HMI development steps
1-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction
Troubleshooting Topic
In subsequent chapters of this course, we will investigate tools relevant to topic which
can assist in troubleshooting.
In this Introduction Chapter, nothing to troubleshoot as yet.
eBooks Topic
Also, in subsequent chapter of this course we will focus on a relevant help topic from the
Online Help.
One the of lab exercises in this chapter is to introduce the Online Help.
GFS-154K
Education Services
1-15
Proficy iFIX Fundamentals - Introduction
1-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction
Lab Exercises – Introduction to iFIX
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Understand the classroom environment regarding the roles of the network connected
computers.
 Locate the ClassFiles to be accessed during various lab exercises in this class.
 Access the Proficy iFIX Online Help.
Introduction
Your learning environment setup will be introduced and explained by your instructor. You
will walk through what is installed for use during the session.
Lab Exercise #1 – Environment Setup
You Instructor will now take you through a demonstration of the classroom and its various
computers.
You can follow on your own student computer, launching the same applications as your
instructor, where you feel comfortable doing so.
You will be using all the applications and interfaces demonstrated, in step-by-step guided
lab exercises in later chapters on this course.
Part A – Investigate your own Student computer
1. On your Student computer desktop is a text file named PC Info Student # (where # is
your Student number) e.g., PC Info Student1.txt.
2. Open this info file and familiarize yourself with the details, especially credentials.
3. Open a Windows File Explorer and navigate to the folder:
C:\ClassFiles\.
4. Observe the structure, a folder for each module of the course. Most folders have files
that you will need to use when instructed in the relevant lab exercises.
5. When following the Instructor, open at least:
iFIX Startup.
Configuration Hub.
iFIX Online Documentation.
GFS-154K
Education Services
1-17
Proficy iFIX Fundamentals - Introduction
Part B – Access the Proficy iFIX Online Help
1. Locate and open the Chrome browser from your Windows desktop.
Then click the iFIX Online Help bookmark to open the iFIX v2022 Online Help.
2. In the Search field on the top right type in SCU then click Enter on your keyboard.
3. When the results appear, click on the item returned titled Configuring iFIX Using the
SCU.
4. Browse through the returned help topic. We will work with the SCU in a later chapter.
5. Close the browser when complete.
Tip
This shows the Online Help, which obviously requires an Internet connection. Later in
this course you will access the local iFIX eBooks.
1-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction
(Optional) Lab Exercise #2 – Sample System
Proficy iFIX installs with a Sample System demonstrating examples of potential HMI
layouts for either a Juice Plant (Food & Beverage) or a Water Plant (Utilities). Both
commonly found as Proficy iFIX customers.
1. Locate on the Windows Desktop the iFIX Sample System. icon:
2. Double-click to start the Sample System.
3. When the Sample System initial page opens, click the Juice Plant button. The Juice Plant
Dashboard will open.
4. Navigate around, spend a few minutes to try out a few of the alternate pages from the
Navigation panel on the left side.
5. Click the Vertical Navigation link at the top of the Navigation panel. This will return you to
the Sample System initial page.
6. Click the Water Plant button.
7. Navigate to the Clear Well page using the link in the Navigation panel.
8. Try to control some element. Try the Man Auto controls,
icon
and try changing a Setpoint.
or click the settings
Don’t worry if you can’t, this is just a quick look at an example Proficy iFIX SCADA / HMI
system.
9. On the Navigation panel, click the Exit link. This will shut down the Sample System.
GFS-154K
Education Services
1-19
Proficy iFIX Fundamentals - Introduction
1-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 1 How To. This will open a
new browser tab and run the How To video.
End of Lab Exercises
GFS-154K
Education Services
1-21
Proficy iFIX Fundamentals - Introduction
Review Questions
1.
Which node type collects data directly from the Plant floor using I/O Drivers and
Database Tags?
2. Does a SCADA or a Client initiate communications for data and alarm transfer?
3. Can a Client Development license configure features found on a SCADA?
4. Name two communications technologies supported by iFIX.
5. Name three technologies supported by the iFIX HMI to provide added functionality
and flexibility.
1-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction
Review
Now that you have completed this module, you should be able to:
 Describe the basic concepts of the iFIX HMI/SCADA
 List the high-level iFIX features
 Discuss topics in HMI/SCADA development
 Explain the Application Development Steps
GFS-154K
Education Services
1-23
Proficy iFIX Fundamentals - Introduction
1-24
Education Services
GFS-154K
0)
02
ARCHITECTURE AND APPLICATIONS
a
At the end of this module, you will be able to:
 Describe the system architecture
 Discuss key applications
 Explain the Training Course application for the
lab exercises
 Create a Simple Display and associated
Database Blocks
10%
Proficy iFIX - Architecture and Applications
2-2
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Architecture Overview
In this chapter we will look at the fundamental architecture of iFIX, how those puzzle pieces
fit together, which come first, which follow on.
SCADA and Client nodes will have some common, and some unique configuration steps.
We will try to explain each.
We will also look at the iFIX applications utilized to configure these components of an iFIX
system.
Project
Setup
Project Configuration
Each iFIX system, whether a SCADA or Client node, starts with its Project Configuration
completed in the System Configuration Utility, or SCU.
These basic settings directly affect how iFIX is started, how it identifies itself on the
network, and how it interacts with data and systems distributed around the plant.
Networking, node names, project folders and start-up tasks are all configured in the SCU
whether SCADA or Client, then I/O Drivers and the Process Database (PDB) for SCADA
nodes.
For detailed configuration there are menus available, as well as a handy toolbox. Settings
can be changed on-line but will not take effect until iFIX has been shut down and restarted
using the changed SCU file.
I/O
Communications
Communications
A SCADA node can use a variety of communications media to exchange data with plant floor
Control Devices such as PLCs and Sensors. Examples are:
Telemetry: radio, telephone or satellite communications.
Serial network: networks connected with RS-232 or RS-485 cables.
Proprietary network: proprietary vendor technologies using unique protocols and
equipment with a variety of cables, connectors and terminators.
Ethernet network: commercial or industrial grade Ethernet cables, switches and routers.
GFS-154K
Education Services
2-3
Proficy iFIX - Architecture and Applications
The SCADA node uses I/O Drivers and OPC servers to translate the data from these control
devices to Windows friendly data that can be used with the iFIX application. These various
media and their supported protocols can coexist simultaneously on the SCADA node.
The installation of a relevant I/O Driver is required to communicate with these plant floor
Control Devices.
Communication is also possible to other sources which do not fall into the plant floor Control
Device category, here communications protocols such as OPC UA, OPC DA, MQTT, and
many more, can be found.
I/O Drivers and OPC servers are software applications that are usually installed on the
SCADA node. Their role is to pair up a communication protocol with a communication media
in order to access data from the various control devices either by poll – actively asking for
data, or unsolicited – passively waiting to be sent data.
I/O Drivers often support more than one protocol and media combination, though these
combinations are almost always specific to a vendor product family (for example, Siemens,
Rockwell, Modicon).
These applications act as the schedulers, arbitrators, requesters, and responders for all
data being exchanged between the SCADA node and the control device (much like a printer
driver for a normal PC). I/O Drivers run as independent processes with individual
configurations on the SCADA.
As we will discuss later, Version 7.x Drivers reserve a memory space for storing current
values or retrieving recent changes. This memory space, unique to each driver, is called the
Driver Image Table (DIT) and it contains an image of the current values from the hardware.
The IGS Driver does not have a DIT.
The I/O Driver is responsible for organizing the addresses of the incoming and outgoing
data into poll records. The poll records are periodically polled based on a poll time to
provide the snapshot of what is happening on the plant floor . This constantly updating data
is deposited into the DIT for delivery to other parts of iFIX on a real-time basis.
The information in a DIT is very simple. It consists of an address (specific to the control
hardware) and a value (such as an integer, float, string etc). It generally does not provide
enough information to help operators run the plant efficiently. The Process Database will be
used to organize this data into more helpful information for operations staff.
The IGS Driver does not have Poll Records, however, does have the ability to use Static
Tags which allows the IGS Driver to contain individual process values. These Static Tags, for
individual values, can have user defined names, data types, and even scaling.
2-4
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Asset
Models
Asset Models
Asset Models contain defined Object Types and deployed Object Instances.
Models Types define the structure of the equipment pieces within a particular level in a
logical hierarchy and may have Data Variables declared, such as Level, Flow, Speed, etc for
an actual process unit, or simpler KPIs for a Line or Plant.
A deployed instance of an Object Type will be for a specific use, such as a tank containing a
process ingredient, with Variables bound to specific data sources such as iFIX Database
Tags.
Using Models, the Database Tags associated with the Object Instances, can be created
automatically when the Model is deployed and Published. This can significantly reduce
development time, especially on a system with many repeatable process units.
Process
Database
Process Database
The Process Database is an iFIX proprietary database that helps to turn driver data into
more useful information. The basic unit of information in the PDB is a tag (or block).
Tags are usually associated with a single data value or process element (e.g. a tank level or
pump status), though they often have many different ways of interacting with that value.
Throughout iFIX, each tag is identified using a unique name (e.g. Tank1>Level).
Each tag can be described or given instructions using parameters called elds.
Tags have fields for descriptions, engineering units, alarm thresholds, actions, or logic to
help provide human-friendly information to the variety of applications in iFIX.
An I/O Address field is configured to connect I/O Tags to individual values from the
connected I/O Driver.
Process
Database
Scan Alarm & Control
SAC is a process that can transfer data to and from multiple I/O Driver addresses as quickly
as twenty times per second (0.05s interval). In addition to performing as the intermediary
between the I/O Driver and the PDB, SAC performs calculations and logic, detects alarm
conditions and generates messages.
Tag values are updated from the I/O Driver based on a scan time. This interval is set on a
tag-by-tag basis in the scan time field and allows for a high degree of flexibility for tag
updates. These scan times also govern how often logic is run, calculations are made, or
alarms are potentially generated.
GFS-154K
Education Services
2-5
Proficy iFIX - Architecture and Applications
HMI
HMI Clients
Operator screens organize and display the information in a visually intuitive and accessible
format. Developers can design graphic displays that represent the equipment and
instrumentation on the plant floor. PDB Tag values are tied to visual cues such as grids,
colored objects, text or other indicators through animation objects and updated based on a
refresh rate.
As well as the Thick Client Workspace HMI Application installed with iFIX, several Thin Client
(no iFIX Applications installed where viewed) are available:
 Webspace – a Webserver for iFIX, Clients connect using a Web Browser, iOS or Android App.
 Remote Desktop Services (RDP) – A Microsoft technology.
 Operations Hub Web HMI App – a Webserver providing a responsive HTML5 dashboard for
iFIX.
2-6
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
HMI
Data Source Syntax
These Client displays can be located anywhere on the network and therefore need to know
where the source data originates. While the Client-Server architecture is efficient and
simplifies development, deployment and management, it does require that every link
requesting data use the node name in the data source. (SCADA server nodes are uniquely
named as the first step in configuring a node).
There are four parts in a data source for tag-based data: SERVER.NODE.TAG.FIELD.
SERVER: the source application. e.g. FIX32 for the PDB tags, HIST for Historian.
NODE: the source SCADA node name. For PDB and Historian tags this is always a SCADA
node name.
TAG: the name of the individual tag in the PDB or Historian.
FIELD: the specific parameter from the tag. e.g.
F_CV = numeric current value.
A_DESC = alphanumeric description.
A_EGUDESC = alphanumeric engineering unit description, etc.
Each display link will specify the four-part data source syntax to identify what data to
request from the appropriate SCADA server. For example,
FIX32.SCADA1.TANK1>LEVEL.F_CV
This indicates that the link should be updated using data from a PDB source (FIX32) on the
SCADA server uniquely named SCADA1. It will specifically request data from the numeric
current value field (F_CV) of the TANK1>LEVEL tag.
Similarly, the following:
HIST.SCADA1.TANK1>LEVEL.F_CV
indicates that the link needs data from the Historian that is storing data for SCADA1. This
would be used in an analytical display in trend charts or with historical animations.
When using Object Models, the Data Source, although technically still using the exact same
SERVER.NODE.TAG.FIELD syntax, is much easier to browse as the model hierarchy is used
to locate the relevant parent – child structure. This effectively populates the TAG part of the
data source syntax, selecting the default current value as the field.
FIX32.SCADA1.ProficyPharma>Ingredients>Water>TankLevel
GFS-154K
Education Services
2-7
Proficy iFIX - Architecture and Applications
Historical
Archiving
Historical Archiving
Much like operator displays, Historians will use the data source syntax to link to the PDB
tag, periodically sampling and storing tag values in a historical archive. However, the
Historian always assumes the data is coming from the SCADA server PDB database, so the
SERVER component of the syntax is not required. For a Historian, the data source syntax
for an iFIX source will look like this:
NODE.TAG.FIELD
or for example,
SCADA01.TANK1>LEVEL.F_CV
After data has been archived, operator displays, or other tools can be used for retrieval and
analysis. These tools must use the full four-part syntax, with HIST indicating that the
source application is the Historian.
Security
Running as a thread throughout the different areas of configuration and applications, is iFIX
Security.
Whether configuring the Project, the Database or the HMI, security rules will apply.
As mentioned in the introduction chapter, the iFIX Security system contains Users, Groups,
Areas and Application permissions. Users can be iFIX local, Windows or from Proficy
Authentication (UAA).
We will in a later chapter discuss how the security system is configured.
2-8
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Data Flow Summary - Read
A v7.x I/O Driver reads data from control hardware addresses based on logical address
groupings called poll records. Each poll record has a poll time that governs how often the
addresses are polled.
The v7.x I/O Driver deposits the read data in its own DIT.
IGS does not have a DIT.
In the IGS Driver the SAC Scan time controls how often the Poll happens.
SAC continually scans the v7.x DIT and transfers data to the appropriate PDB tags. Each
tag has a scan time that determines how often data is scanned and transferred.
SAC on each scan of an IGS source, will request the IGS Driver to perform a read, the IGS
driver optimizes these requests to ensure efficient use is made of the communications
channel.
SAC also performs calculations, data scaling and alarm detection for each tag based on its
scan time.
Operator displays use animation objects to retrieve tag values into graphics as
continuously updating visual cues. These animations use a refresh rate to determine how
often data is updated on the screen.
Historians use Collection Rates to retrieve real-time tag values and permanently store them
with a time and date stamp in an archive.
Data Flow Summary – write data
Operators use control interfaces in the graphic displays to write values to PDB tags. The
tag update occurs immediately.
Once the tag value has been changed by the graphic display, the value will be processed by
SAC on the next process cycle (maximum of 0.05s) and written to either the appropriate poll
record in the DIT of a v7.x driver, or if the IGS driver is used, will pass the new value to the
IGS driver for writing to the control hardware.
Once the v7.x DIT data in the poll record entry has been changed, the value will be written
to the appropriate control hardware register immediately.
GFS-154K
Education Services
2-9
Proficy iFIX - Architecture and Applications
iFIX Applications
Each of the major iFIX architecture components have applications that are used to
configure, monitor and interact with them. The focus of this course is to help you acquire
the skills required to use these applications and their tools to develop, deploy and maintain
iFIX SCADA/HMI systems.
Project
Setup
Project Configuration - System Configuration Utility
The SCU is one of the few iFIX tools which can be used when iFIX is not running. It can be
opened with the Windows “Search programs and files” field by typing “SCU” or from within
the “iFIX program group in the “Start” menu.
Figure 2-1. Navigating to the System Configuration Utility
Multiple iFIX projects may be configured for a single node, but only one project (and one
SCU file) can be used at a time. To segregate the various configurations that may reside on
a computer, developers create distinct projects that use separate folders, files and SCU
configurations. Each target project is associated with its own SCU file and folders, and the
Launch application will start projects according to the SCU file specified by the user.
2-10
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Figure 2-2. The System Configuration Utility
The main screen of the SCU can be used to assess the enabled components of the iFIX
node, as well as the essential details of the node such as its name, whether it is a SCADA or
a client or part of a larger network. It has several interactive elements that can be used to
configure settings quickly without using the menus or toolbox buttons.
All Settings however are found in the File, Configure and Help menus:
Figure 2-3. The System Configuration Utility Menus
GFS-154K
Education Services
2-11
Proficy iFIX - Architecture and Applications
Local Startup Configuration
The Local Startup Configuration is essential for
identifying a node with a unique name or logical name
(nickname). It also controls whether iFIX runs as a
service or the service automatically starts at system
boot.
Double-clicking on the Node Name or using the
Configure menu - Local Startup, opens this dialog box.
Figure 2-4. The Local Startup dialog box
The Local Node Name must be unique within an iFIX network and is limited to eight
characters. The node name is how the iFIX node identifies itself to other iFIX nodes as well
as to other applications. Since the node name is included in the data source syntax for a
variety of client applications, any duplicate node names on the network will cause
confusion.
The Local Node Alias is a way of substituting a generic node name for a unique one. When
Local Node Alias is enabled on SCADA nodes, the “THISNODE” node name will also be
available in all browse lists for tags. By choosing “THISNODE”, a developer is instructing a
display to always use the PDB tags located on the local node. If the picture is moved to
another SCADA, the display will always look for PDB tags of the same name on its own host
node.
This tool is good for quickly replicating displays to multiple SCADAs using PDBs with the
same tags, such as in a classroom environment or for manufacturers who repackage iFIX
with their equipment. For the most part, it is not used in normal automation environments.
By enabling “Run as iFIX Service”, a developer can ensure that essential iFIX SCADA
processes can run independently of user login. Typically, this includes essential data
gathering processes such as SAC, I/O Drivers, alarming, SQL tasks, networking, historical
collection, and background schedules. Even if Windows is logged out, these tasks will
continue to run in the background and provide clients with necessary data.
Set service startup type to “Automatic” ensures that iFIX starts automatically once
Windows is running.
2-12
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Path Configuration
Figure 2-5. Path Configuration
The Path configuration allows users to specify where project files are located. The folder
locations listed in each individual SCU file govern where iFIX will look for things like graphic
displays, PDB files and Alarm Areas etc. In this way, many different projects can be
developed on the same node but kept in distinct locations.
The Path configuration can also use shared folders, mapped drives or network resources as
file locations. In this way, operator displays and the Alarm Areas, may be stored centrally
and accessed by users over the network. This will ensure all users are using the same
content or data while reducing the maintenance efforts required to copy content around the
network when changes are made.
UNC addressing is supported (e.g. \\<servername>\share\directory)
GFS-154K
Education Services
2-13
Proficy iFIX - Architecture and Applications
By default, iFIX installs to the Base directory location. However, if for some reason a user
installs iFIX in a different location, this directory can be edited to use the specific install
location for that node. This will ensure that iFIX uses the correct base directory to launch all
iFIX applications, such as the SCU or the Workspace.
It is common for project folders (Database, Picture, etc.) to be sub-directories of the Base
directory. The Change Base button can be used to reassign the project directories using
the new Base. The SCU will even prompt the user and create new directories if they do not
already exist.
The following is a brief summary of the types of iFIX files contained within each of the
Project Folders.
Developers may have more than one project available on individual nodes, so it is helpful to
be able to specify which folders to use with a given SCU file.
The Application Paths In Current Project Configuration entries can be used to specify the
alternate project location (with no effect on the Base).
When starting iFIX, the user will choose which project to load by selecting the appropriate
SCU file.
The Change Project button is used to reassign the remaining project directories to include
the project root directory (e.g. ProjectA or PlantA project root directory). If the project
folders already exist, the path configuration will update the entries to reflect these project
folder locations. (The project folders do not have to be subdirectories of the Base
directory).
The Project locations contain the following types of iFIX files:
 Project: Root directory for project files.
 Local:
SCU files, Toolbars, configuration *.INI, Model Database, OPC UA security
certificates.
 Database (PDB): PDB, I/O Drivers configuration, schedules, Model database.
 Picture (PIC): Displays, Dynamos, Color sets, Tag Groups.
 Application (APP): Miscellaneous documents.
 Historical (HTR): Legacy Historical configuration.
 Historical Data (HTRDATA): Legacy Archives.
 Alarms (ALM): Alarm files.
 Alarm Areas AAD: Alarm Area Database
Creating New Projects can be achieved here. If a user wants to build a new project with
new directory locations, iFIX can automatically build the folders and pre-populate them with
default project files. A project root directory must be provided, and then the Change
Project button will execute the changes. iFIX will prompt the user and then create all the
necessary sub-directories, along with all the factory default files required to work with a
project (such as color sets, graphic symbol sets, toolbars etc).
Note
Creating new projects must be performed when iFIX is not running
2-14
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Network Configuration
Figure 2-6. Network Configuration
One of the most powerful features of any SCADA/HMI is the ability to distribute process
information around the network to multiple users in various operational disciplines. iFIX is
built to communicate with clients and other applications at real-time using the TCP/IP
network protocol. Because the Client-Server relationship means that the client requests
data and the server responds, network configuration in the SCU is very straightforward. It
consists of enabling networking and defining valid server nodes (SCADA nodes only).
Network configuration is very simple. Once your IT staff have everything in place for
successful Windows-based networking, configuration should proceed quickly.
Stand-alone nodes will choose “No Network Support”.
For networked nodes, TCP/IP is the only choice of network protocol.
Once Network support is enabled, Remote Nodes may be specified. These Remote Nodes
are iFIX nodes that can be used as sources of data. iFIX SCADA nodes are the only node
types that can collect and manage data, so Client node names do not need to be added to
this list. Simply add the SCADA name to the Remote Node Name field and click Add.
Dynamic Connections is an option which can be set for clients with very infrequent
requests for data from any available node on the network. This allows a client to scan the
network for any SCADA node name used as a source in its operator displays. It will then
issue a request for data from that SCADA. Due to the extra scanning overhead, it is strongly
recommended that the Remote Nodes list be manually created for all but the most casual of
Clients.
Enforce Trusted Computing uses the accompanying password as a security measure to
validate connecting clients. The password in the SCU on both the client and server must be
identical.
GFS-154K
Education Services
2-15
Proficy iFIX - Architecture and Applications
IT Requirements and Configuration
iFIX nodes use node names to identify themselves and route information on an iFIX network.
However, TCP/IP uses IP addresses to identify network resources. Therefore, a necessary
first step for iFIX networking is building an index or directory (like a phone book) that maps
iFIX node names to corresponding IP addresses or computer names.
If the network is using static IP addresses, a Windows resource called a HOSTS file can be
used. (HOSTS is a text file located in the \Windows\System32\Drivers\etc\ folder). A
sample is pictured below. It is best to map both IP addresses and computer names against
node names, even if only one method is being used.
Figure 2-7. Sample Hosts File.
If using dynamic IP addresses with a Domain Name Server (DNS), the solution is less
simple. A static list like the HOSTS file will not work because each machine may change its
IP address periodically. Fortunately, a DNS server tracks these changes and provides an
automatically updated list to networked users. However, the DNS server matches up IP
addresses to computer names or domain names only - it does not know about node names!
In order to accurately route iFIX messages around a network using DNS, the node names
must be identical to the computer names. That way, when requests are made by iFIX clients
the DNS server thinks the node name is really a computer name and correctly routes the
request to the proper address.
2-16
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Task Configuration
Figure 2-8. Typical SCU Tasks configurations for SCADA (left) and Clients (right)
Depending on the duties of the iFIX node, it will need to run certain applications. These are
normally iFIX applications such as I/O Drivers, SAC or the Workspace but often they can
include important third party applications (for example, Excel, Oracle client software,
reporting software, etc). The Tasks configuration in the SCU allows a user to list the
applications to start with iFIX as well as any special parameters to use when starting the
application.
Tasks can be started normally (in the foreground as a window), as minimized applications
(icon in the Windows taskbar, *) or in the background as processes (no window, no icon, %).
SCADA tasks:
 IOCNTRL.EXE – Starts and controls the IO Drivers*
 WSACTASK.EXE – Starts SAC and loads PDB
 WSQLODC.EXE – Starts SQL tasks
 IHFIXCOLLECTOR – Starts the iFIX Collector for Historian
 SUMQDEL.EXE – Periodically deletes residual alarms from Alarm queues
 FIXBACKGROUNDSERVER.EXE – Runs schedules as background tasks
Client tasks:
 WORKSPACE.EXE – Visualization
Note
* Although the IOCNTRL.exe task is automatically added as a Task on Startup to
any new project, it is only actually required for legacy v6.x Drivers. If using IGS,
OPCUA or even v7.x Drivers the I/O Control (IOCNTRL.exe) Task on Startup can be
deleted.
GFS-154K
Education Services
2-17
Proficy iFIX - Architecture and Applications
Some tasks have special Command Line Parameters which can be used to specify specific
behavior for the task. These parameters can be added by selecting the task from the list,
typing in the parameter(s) and then choosing Modify.
Task
Switch
IOCNTRL.EXE
/A
WSACTASK.EXE
Additional Parameter
Start all drivers listed in the SCU.
/S
Three letter acronym
for the Driver (eg.
/SABR).
Starts a specific driver. Multiple
drivers can be added by repeating
the switch with the appropriate
driver acronym.
/D
Number of seconds
(eg. D30).
Delay Driver setup.
S
Synchronize SAC to the system
clock.
D
Number of seconds
(eg. D30).
Delay SAC start up. This gives a
V7.x Driver an opportunity to prepopulate it’s DIT.
Q
Number of alarms.
(eg. Q2000)
This sets the maximum size of the
master alarm queue. If the number
of undelivered alarms exceeds this
number, the surplus alarms will be
lost.
C
SumQDel.EXE
Description
Suppress I/O Driver
communication alarms. This
parameter must be the last
parameter on the command line.
-D
mm:ss
(minutes:seconds).
(eg. 15:00)
Determines how long to delay
after start up before cleaning up
queues.
-F
mm:ss
(minutes:seconds).
(eg. 30:00)
Determines the frequency for
subsequent queue cleanup.
FixBackgroundServer.exe
/service
Runs this task as a service.
iHFixCollector.exe
NOSERVICE
The iFIX Collector for Proficy
Historian must pass a command
line option, typically SERVICE
when iFIX is running as a Service
and NOSERVICE when not.
iHiFixAECollector.exe
NOSERVICE
Same as the iHFixCollector.
Table 2-1. Command Line Parameters
2-18
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
I/O
Communications
Communications Configuration – IGS Driver Configurator & v7.x Powertool
The applications, which will be covered in much greater depth
in a later chapter, which are used to configure
communications, are the Configuration tool for the IGS Driver,
and the Powertool used by a v7.x Driver.
The IGS Configuration Tool is accessed via the Windows
System tray, right click the IGS icon and choose Configuration.
This is also in its own group of programs from the Windows
Start menu.
This will open the IGS Configuration tool. We will look at
configuring IGS later.
Figure 2-9. Start the IGS Configuration Tool
The Powertool for any installed iFIX v7.x Driver will be found, by
default, in the iFIX Group of programs from the Windows Start
menu.
Figure 2-10. Start a v7.x Powertool
Tip
Driver Configuration applications, whether IGS or v7.x (or even legacy v6.x which we
are not discussing here) can be opened by running the program XXXDIDW.exe, where
XXX is the 3 letter acronym for the Driver, such as IGSDIDW.exe, MBEDIDW.exe or
OUADIDW.exe
GFS-154K
Education Services
2-19
Proficy iFIX - Architecture and Applications
Asset
Models
Asset Model Configuration – Configuration Hub
Asset Models are defined in the Models panel of Configuration Hub.
Configuration Hub can be opened locally from the desktop shortcut, or the button in the iFIX
Workspace Applications ribbon, however since it is designed as a network wide web based
tool, these are hyperlinks to: https://<hostname>:5000
e.g.
https://host-1:5000
Port 5000 is the default for Configuration Hub, during installation this port will be checked
and if available it will used. During this installation an alternate port could be applied.
Figure 2-11. Configuration Hub – Model panel
2-20
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Process
Database
Process Database Configuration – Database Manager or Configuration Hub
The Process Database can be configured using either Database Manager, a thick client
application installed with iFIX, or using the Database panel in Configuration Hub, which of
course is a Thin client and can potentially be accessed from anywhere.
Both these tools will be covered in later chapters.
Figure 2-12. Database Manager
Figure 2-13. Configuration Hub – Database panel
The Scan Alarm and Control SAC application is a background application. There is no
application which configures the SAC.
When Database tags are added, how SAC processes them is configured in each tags Scan
settings.
GFS-154K
Education Services
2-21
Proficy iFIX - Architecture and Applications
HMI
HMI Clients – Workspace
Operator screens are developed in the iFIX Workspace application.
As we will see in later chapters, Workspace, as well as being the Configuration and Runtime
HMI environment, is the central application providing access to most other iFIX applications.
Using Workspace as the Runtime HMI Client, requires an iFIX installation and license locally
on the computer. This is a thick client solution.
Figure 2-14. Workspace
HMI Clients – WebSpace, Operations Hub, Remote Desktop
These are thin client solutions. The computer on which the Runtime HMI is being viewed
does not need any iFIX software installed locally.
In the case of WebSpace and Operations Hub, only a supported browser is required.
For Remote Desktop connections, a supported Microsoft Remote Desktop client must be
installed on the viewing computer.
For all of these thin client solutions, an associated server application must be installed and
licensed on the source server computer, being a Webspace server, an Operations Hub
server or Windows Remote Desktop Services.
Other iFIX applications will be investigated as we progress through this iFIX Fundamentals
course.
2-22
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Historical
Archiving
Historical Archiving – Proficy Historian
iFIX SCADA nodes contain a real-time database - the Process Database. Therefore, in order
to review how a process has performed over the last hour, day, week or batch period, that
PDB real time data must be stored somewhere now for retrieval after.
Proficy Historian, with its Essentials Edition included with an iFIX SCADA license, is the ideal
repository.
The iFIX 2022 Integrated Installer, with its default options, includes the Proficy Historian
server and the Proficy Historian Collector for iFIX Data (and Alarms & Events).
Configuration Hub can then be used to fine tune the iFIX Data Collector settings and then
add tags from the iFIX PDB and being a thin client this can be achieved from any network
connected computer.
Figure 2-15. Configuration Hub – Collector Panel
The Historian Desktop Administrator will also be installed with the Historian server on the
iFIX SCADA node, this too can be used to configure the iFIX Data Collector and add tags
from the iFIX PDB.
Figure 2-16. Proficy Historian Desktop Administrator
GFS-154K
Education Services
2-23
Proficy iFIX - Architecture and Applications
Security – Security Configurator, Configuration Hub
iFIX Security is configured primarily in the iFIX Security Configuration Utility. This is where
Security Areas and Applications permissions can be assigned to Groups.
Users can then be added to these Groups, or even assigned permissions directly.
Users can also come from Windows, either local workstation or domain.
In Configuration Hub, Proficy Authentication (UAA) is configured, whereby Users can also
be added to the iFIX Security Groups which are mirrored in Proficy Authentication.
Much more on this in a later chapter.
Figure 2-17. iFIX Security Configurator
Figure 2-18. Configuration Hub – Proficy Authentication Panel
2-24
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Project Management
iFIX provides a variety of tools to assist with the management of projects and SCU files.
These tools allow the user to start iFIX using a designated SCU file (inheriting its directories)
and node name. FIX.EXE is the default launching application for iFIX. It uses the default SCU
to start up the iFIX project using the node name designated in the SCU file.
Launch
Launch.exe can pass parameters to FIX.EXE to start a project using an alternate SCU file
and node name. When Launch.exe is used, a simple user dialog appears and prompts the
user for instructions.
Figure 2-19. The iFIX Launch application
 iFIX: In the top section, once a Node Name is entered, an SCU file can be browsed and
selected as the desired project. If the Node Name is edited, it will over-ride the default node
name in the SCU file.
 Sample System: Will start the iFIX Sample System in Demo mode.
 SCU: Opens the SCU for editing.
 Desktop Shortcut: This uses the settings from the top section (iFIX) to create a desktop
shortcut that will automatically start that iFIX project without opening the Launch
application.
The check box at the very bottom (Don’t show…), hides this Launch Window and forces the
use of FIX.EXE with the default SCU file and NodeName.
The Launch.exe application has a number of very useful parameters such as the /t switch
to force iFIX to start in demo mode.
Very useful on Runtime nodes for quick modifications. For a launch shortcut which will
already contains the SCU location and Nodename, simply add the /t option to the end, e.g.
/sC:\PROGRAM FILES (X86)\Proficy\iFIX\LOCAL\SCADA1.SCU /nSCADA1 /lSCADA1 /t
GFS-154K
Education Services
2-25
Proficy iFIX - Architecture and Applications
iFIX Fundamentals class example system
For the lab exercises (in reality the example system is almost irrelevant), we could simply
produce meaningless ‘widgets’.
As seen in the iFIX Sample System, a Food & Beverage example is given, as is a Water
Treatment example. These are common iFIX end user applications.
Equally the pharmaceutical industry has been an avid adopter of iFIX (and Proficy Batch) for
many years, security enhancements made many years ago were developed specifically with
the pharmaceutical industry in mind.
Our course system is a rudimentary manufacturing system for an influenza antiviral drug.
A fun and functional flu fighting pharma factory!
There is no need to get caught up in the detail of this manufacturing process, please don’t!
There are certainly gaps in the course manufacturing system, it is not a real-world
application.
The iFIX Fundamentals course example system only exists to provide some context when
the various components of the iFIX project are developed.
This same example system will be further utilized in the follow-on iFIX Advanced, and iFIX
Scripting courses.
Our example system will build up a project including the I/O Drivers, Asset Model, Process
Database, Historical Collection, and of course HMI Displays representing the following
process areas:
Ingredient Tanks: There are several raw products which are combined in order to
manufacture the antiviral pill. The Ingredients process area contains six tanks of raw
materials, Cellulose E460, Cellulose E463, a pH Stabilizer, Sodium E468, Stearate E470b
and a Water suspension containing the active antiviral active ingredient, known as NHC.
Data sources include levels, inlet and outlet controls and pumps.
Blending Line: The Ingredients are fed into the Blending line where they are mixed, milled
and processed into a final blend. Moisture levels are important during these processes
whose ultimate goal is to mix, i.e. blend the ingredients and reduce the particle size of the
mixed product.
Data sources include the feed rates from the Ingredient tanks, moisture levels and particle
sizes at each stage along with the controllable status of the mixing, milling and final
blending stages with their machine speeds.
Granulation: This process is split into Wet Granulation and Dry Granulation. These
processes combine to compact the powders for tablet formation. This involves a hot drying
process to reduce the moisture content where the small particles produced in the final
blend will form larger particles called granules. The resultant granules are compressed
under pressure into tablets and then cooled.
Data sources include the dryer temperature, the final moisture content and the chiller
temperature.
2-26
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Packaging:The packaging line simply takes the now formed tablets and inserts and seals
them into blister packs, boxes the blister packs, and palletizes the boxes.
Data sources include the packaging conveyor control and speed, palletizer control, and unit
counts of product (tablets), blister packs and boxes.
Energy Center: An HMI display presents information from the plant Energy center.
In this environmentally conscious world, the plant takes electricity from the grid supply but
supplements electricity from local Wind and Solar sources and a high power battery storage
unit. These renewable sources feed the plant in order to reduce costs and carbon footprint.
Data sources include the plant demand on the grid, the wind, solar and battery supplies.
The plant carbon footprint is calculated based on the balance of these power sources.
Analytics: Whilst not a distinct process unit of the plant, the Analytics display presents
Historical data as trend and numerical KPIs.
Alarms: Again, is not a plant process unit per se, but an important interface to allow Alarm
interaction with plant operators. This display presents alarm states and counters.
SystemInfo: A SystemInfo display is also provided. This contains links to many
troubleshooting and configuration tools. The local SCADA performance is also monitored
showing statistics for the Scan Alarm and Control process, a critical part of the SCADA
system, as well as historically collected computer performance information.
GFS-154K
Education Services
2-27
Proficy iFIX - Architecture and Applications
Troubleshooting Topic
We have discussed in this chapter important components in the iFIX architecture and iFIX
applications utilized to configure these.
We will single out two important areas of the SCADA and Client architecture.
SCADA Scan Alarm and Control
This is the SAC process. The actual background application is:
C:\Program Files(x86)\Proficy\iFIX\wsactask.exe
In order to monitor how this application is performing, counters are presented in the
monitoring application Mission Control in its SAC tab. Mission Control is the application:
C:\Program Files(x86)\Proficy\iFIX\mission.exe
Check out these SAC Counters also shown in the SystemInfo display of the course system
HMI.
Figure 2-20. Mission Control – SAC tab
Network SCADA to Client communications
Since this relies on the Windows TCP/IP protocol, many non iFIX tools are available.
Ping from the command line is a traditional first port of call, e.g. ping scada2 or ping
10.0.0.2
However this is usually blocked by the Windows Firewall.
Netstat is another Windows command line tool to investigate network port usage.
iFIX has several tools also. Search the iFIX Online Help for iFIX applications such as
nethis.exe and netdiag.exe.
The SystemInfo display also has links to open Mission Control and these Networking tools.
2-28
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
eBooks Topic
Briefly mentioned in this chapter was running iFIX as a Windows Service. This has significant
advantages in a production system.
Open the Online Help and search for “iFIX as a Service”.
Take a read at this topic when you have time.
Figure 2-21. Online Help – iFIX as a Service
GFS-154K
Education Services
2-29
Proficy iFIX - Architecture and Applications
2-30
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Lab Exercises - Applications
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Open and investigate the SCU.
 Launch iFIX and investigate the Workspace Application.
 Create a simple new HMI Display with its associated Database Blocks.
Introduction
The System Configuration Utility (SCU) is used to build the base configuration for the node.
This includes networking characteristics, node name, whether the node is a Client or
SCADA, as well as I/O Drivers, PDB and Alarming capabilities. You will investigate the SCU
and configure some settings.
You will then build a simple HMI display.
When you are finished with these exercises, answer the Summary Questions at the end of
the module.
Lab Exercise #1 – Introduction to the SCU
Part A – Investigate the SCU
1. On your Student computer desktop double click the iFIX Startup icon
to open the iFIX Startup dialog, then click the SCU button.
GFS-154K
Education Services
2-31
Proficy iFIX - Architecture and Applications
The SCU is launched.
2. Take a moment to browse through some of the
Configure menu items. Many of these you will revisit
in later exercises. Perhaps open the configuration
dialogs for:
a.
b.
c.
d.
SCADA
Paths
Alarms
Tasks – refer back to Table 2-1 in the chapter
notes to understand some of these tasks and
their potential command line switches
e. Local Startup – observe your nodename and that
the Local Node Alias is enabled.
2-32
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
3. Next, Open the Network configuration either from the Toolbox icon or from the
Configure menu select Network or even you can Double click either of the two networked
PCs mimics on the SCU main screen (if they are showing).
4. The Network Configuration dialog appears. Ensure Networking is enabled by selecting
TCP/IP protocol, if not already set.
5. In the Remote Node Name field, type in the NodeName of one other node in classroom,
e.g. SCADA2.
Click the Add button to add it to the list.
Then click OK to close the Network dialog.
6. Save your SCU file by clicking File menu then Save.
7. Lastly Close the SCU.
When your project starts, this alternate SCADA node in the classroom will be included in the
list of data sources to which your node can connect. Clients will not be added to this list.
Remember, once an iFIX project is started, changes to the SCU will occur only after the
node is re-started.
8. If you wish to look at the Windows file that will match network addresses to node names,
open a Windows File Explorer. The HOSTS file will be located in the following directory:
C:\Windows\System32\Drivers\etc
The HOSTS file can be easily edited using Notepad++ or the Windows Notepad application.,
however be aware that Windows defaults usually will mean that this will be a protected path
with write restrictions.
GFS-154K
Education Services
2-33
Proficy iFIX - Architecture and Applications
9. If you have an empty file, check with your instructor and Configure the HOSTS file.
Otherwise, your HOSTS file should look something like the sample below (different names
and IP addresses may be set by your instructor).
This file will help Windows match requests for node names to the proper network IP
addresses. That way the correct network connections are made, and the iFIX nodes can
transfer data and alarms between each other.
10. Save the HOSTS file if changes are made. When saving the HOSTS file in Notepad, never
select Save As, since Notepad will add a .txt as an extension. TCP/IP will assume the file
has been deleted.
No restarts of iFIX or the PC are required after the HOSTS file has been saved, it takes
immediate effect.
2-34
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Part B – Create Desktop Shortcuts
To easily start your project, we will create a shortcut on the Windows Desktop. This uses
the Launch application to associate your nodename with the SCU configuration you have
saved.
We will also create a second shortcut to force iFIX to start in Demo mode.
1. On your Student computer desktop double click the iFIX Startup icon
to open the iFIX Startup dialog, then click the Desktop Shortcut button.
2. At the prompt, provide a shortcut name using SCADA and your student number, SCADA# e.g.
SCADA1, then click Create.
This shortcut, when used, will immediately launch the project without any further prompting
from the user. Check your desktop to verify that it was created.
GFS-154K
Education Services
2-35
Proficy iFIX - Architecture and Applications
3. Click Exit on the iFIX Startup dialog box to close it.
Now let’s create a Demo Launch Shortcut by duplicating the shortcut created above.
4. Right click on the new Shortcut just created and click Copy.
5. In a blank area of the desktop right click and click Paste.
A new shortcut will appear with the name SCADA# - Copy.
6. Right Click on this new shortcut and click Properties.
7. In the General tab set the name to SCADA# - Demo
(Where SCADA# is your own NodeName)
8. In the Shortcut tab add a /t option to the end of the target field. Ensure there is a space
before this /t entry.
9. Click OK to close the Shortcut dialog.
10. Double click this new Demo shortcut and observe that the title bar on the iFIX startup
windows states that it is in DEMO MODE.
This would give you 120 minutes of full development time, BUT with no networking capability.
Very useful for those quick modifications on a Runtime Client node.
11. Once iFIX has started in Demo mode, shut down iFIX from the iFIX Startup Window. We will
want to run with no restrictions as we continue the course.
2-36
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Lab Exercise #2 – Create a simple display
Introduction
We will use simple iFIX HMI objects to quickly develop a component which will represent
one of the Ingredient Tanks in our example system.
When you complete this exercise, your Ingredient Tank display should resemble the one
depicted below.
Part A – Create the Ingredient Tank
1. Using your own SCADA# shortcut, e.g. SCADA1, (NOT the Demo one) created in the last lab
exercise, double click to start iFIX.
The Workspace application will open and present you with a new blank display.
Take some time to tour around the various components of Workspace, especially the
different Ribbons (or tabs) where you can access many of the Workspace tools.
2. The Workspace picture Toolbox should be open. If it is not, from the Home Ribbon, select
Show/Hide and enable the Toolbox.
GFS-154K
Education Services
2-37
Proficy iFIX - Architecture and Applications
Objects can be snapped to the Grid for accurate alignment. The Grid also has a size setting.
3. From the Format Ribbon, click the Grid button, then the Grid Settings option.
4. In the Grid Settings dialog box, set as follows:
a.
b.
c.
d.
Show the Grid: checked
Snap to Grid: checked
Grid Interval: 20
Then click OK.
5. Next, select the Polygon tool from the Toolbox.
This will provide a set of cross hairs.
6. Left click once to place a starting point on one of the Grid dots, then move the cross hairs
horizontally to the right and left click once more to add a second point, then move the cross
hairs vertically down and
left click once more to add a third point.
So far it should be like a simple right-angled triangle:
2-38
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
7. Continue to left click adding more points to the polygon until
it resembles this tank object, on the final point double click
to complete the polygon.
This may take a bit of practice to begin with. Delete and retry
as many times as you need to perfect the shape.
Having a larger Grid size of 20 makes it simpler to achieve
accurate angles of the polygon.
8. Once complete, if you are still not satisfied, rather than deleting and trying yet again, right
click on the polygon and choose Reshape. This will allow you to drag individual points in order
to reshape the polygon into what you had intended.
9. Next, again from the toolbox, select the Datalink Stamper tool.
GFS-154K
Education Services
2-39
Proficy iFIX - Architecture and Applications
10. At the prompt which will appear, type in to the Source field the value Tank1>Level.
This will allow you to create a new Process Database Tag ‘on the fly’. No need to go to one of
the Database configuration tools to add the tag. This is particularly useful when adding only
one or two tags.
11. Click OK and you will be prompted that the Source does not exist. Click the Create button.
2-40
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
12. The block type selection list will now appear. Highlight the AI Analog Input type then click
OK.
13. The new tag template will open. In the first Basic tab enter the following values:
a. Description: Tank1 Level
b. I/O Address: RA
c. Units: %
GFS-154K
Education Services
2-41
Proficy iFIX - Architecture and Applications
14. Move to its Advanced Tab and check the Enable Output field. Then click the Add button.
15. You will then be asked if you wish to place the block On Scan, this will start the SAC process
scanning and updating this tag. Click the Yes button.
16. Finally click the OK button on the Datalink dialog box where these steps started and position
it to the right of the polygon representing the Ingredient Tank.
Always refer back to the example of this display at the start of this lab exercise.
17. Click Ctrl-S on the keyboard (Save also has an icon on the Quick Access Toolbar at the very
top left and under the Workspace button). Supply the name TankTemplate.grf.
2-42
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
18. Using the same Datalink Stamper tool from the Toolbox, add a second Datalink. At the prompt
which will appear, type in to the Source field the value Tank1>InletPump.
19. As before, click the OK button, and since this tag does not yet exist, you will be prompted.
Click the Create button and then when the list of block types appears, highlight the DI Digital
Input type then click OK.
20. The Digital Input tag type template will appear, its Tag Name already completed. In its Basic
tab enter the following values:
a.
b.
c.
d.
GFS-154K
Description: Tank1 Inlet Pump
I/O Address RX:0
Labels – Open: Stopped
Labels – Closed: Running
Education Services
2-43
Proficy iFIX - Architecture and Applications
21. Move to the Advanced tab, here in the Options panel, check Enable Output.
22. Now click the Add button at the bottom, and click Yes to place OnScan.
23.Back in the Datalink dialog box, make a few changes. Modify as follows:
a. Add the text .A_CV to after InletPump
The Source will now be:
Tank1>InletPump.A_CV
b. Change the Data Entry Type to In-Place
c. Then click OK
d. Position this new Datalink on the top left of the polygon
2-44
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
24.Next, with this last datalink highlighted, right click and choose Color then Foreground.
Then select from the High Performance color set HPTrueBlack.
25. Next, with this last datalink highlighted, right
click and choose Duplicate.
26. When the new duplicated datalink appears,
drag it to the bottom right of the polygon.
When in position, double click to open the
Datalink dialog box.
27. The source will still have
TANK1>INLETPUMP in its name. Simply
type into the source field to modify to the
OUTLETPUMP.
Then click OK.
Again, since the OutletPump tag does not
yet exist, you will be prompted to Create the
tag. As before click the Create button and
choose a DI Digital Input type from the list,
then click OK.
GFS-154K
Education Services
2-45
Proficy iFIX - Architecture and Applications
28. The Digital Input tag type template will appear, its Tag Name already completed. In its Basic
tab enter the following values:
a.
b.
c.
d.
Description: Tank1 Outlet Pump
I/O Address: 100:0
Labels – Open: Stopped
Labels – Closed: Running
29. Move to the Advanced tab, here in the Options panel, check Enable Output.
30.Now click the Add button at the bottom and click Yes to place OnScan.
31. Back in the Datalink Configuration, click OK.
32. Either from the Workspace Quick Toolbar, or using the keystroke Ctrl-S, Save the picture.
2-46
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Part B Add Animations and Control
1. Locate in the System Tree the Dynamo Sets folder (we will explain the System Tree in more
detail later – just follow the screenshots for now) and double click on HP_Class to open the
set.
2. Select the first Dynamo in the set, it has the name IngPump
which is shown in the System Tree. Drag this Dynamo into your
TankTemplate display, placing it under the InletPump datalink
added before.
3. You will be prompted to select a Pump Tag value.
In the drop down box in the Current Setting column, select the
Tag: Tank1>InletPump
Then click OK.
4. Close the HP_Class Dynamo set.
GFS-154K
Education Services
2-47
Proficy iFIX - Architecture and Applications
5. With this new Pump Dynamo highlighted, click Ctrl-D on the keyboard to Duplicate the
pump. Drag the duplicated pump to the bottom right of the polygon, this will be the Outlet
Pump.
6. Double click the duplicated dynamo for the Outlet Pump and change the Pump Tag source to:
Tank1>OUTLETPUMP
Then click OK.
Again, refer to the example at the start of this lab exercise for objects and positioning.
7. Next double click the polygon representing the Ingredient Tank. Its Basic Animation Dialog
box will open. Enable the Fill Percentage checkbox.
8. In the Fill Expert dialog, select the Tank1>Level source from the drop down list.
Then click the OK button.
2-48
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
9. Back in the Basic Animation Dialog, enable the Foreground Color checkbox.
10. In the Foreground Color Expert dialog, select the Fix32.THISNODE.Tank1>Level.F_CV source
from the drop down list.
Then click the OK button.
11. Click OK on the Basic Animation Dialog box to complete.
12. Lastly Save the picture again. Ctrl-S or Save from the Workspace Quick Toolbar.
GFS-154K
Education Services
2-49
Proficy iFIX - Architecture and Applications
Part C Test the new Ingredient Tank Display
1. Move from Workspace Configure Mode into Workspace Run Mode by clicking the
Switch to Run button
in the Home Ribbon.
Warning - Keystrokes
For switching iFIX Workspace from Configure mode to Run mode, or vice versa, the
standard keystroke of Ctrl-W is provided. However, in this classroom environment
you may have connected through your local internet browser.
By a twist of unfortunate fate, Ctrl-W on most Windows based internet browsers
will terminate the current browser tab or even the browser application if only 1 tab
is open! This would therefore close your connection to your cloud based student
computer! Very annoying!
To avoid this, your instructor may have had you connect to your student computer
using RDP. This RDP file would have already been supplied before the class. In
which case Ctrl-W will work perfectly well for switching between the Workspace
modes.
Alternatively, if you are using a Windows based browser, use the Switch to Run
button:
to move from Workspace Configure to Workspace Run mode.
To switch back from Workspace Run to Configure mode, a custom keystroke of
Ctrl-Q has been added.
The Inlet and Outlet Pump statuses should show Running or Stopped.
The Tank Level datalink should show the current level.
The Tank fill percentage should follow the current level value, and its color change with the
increasing level.
The sources are simulations within the iFIX Process Database, the level is a ramp up from 0
to 100%.
2. Click the center of the InletPump dynamo. The status will change, and the color of the pump
will change. Green if Running and the level filling animation is active. Grey stopped, and the
level filling animation will stop.
3. Try the Outlet Pump. This used a non simulated source, so no effect on the level. Return to
Workspace Configure mode, use Ctrl-Q (or Ctrl-W if on an RDP connection).
2-50
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 2 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
GFS-154K
Education Services
2-51
Proficy iFIX - Architecture and Applications
Review Questions
1.
What part of iFIX is used to collect data from plant floor control devices?
For all V7.x Drivers, where is the data deposited?
2. Where are tags created and stored? What process updates tag values?
3. What is the fastest possible scan time of a PDB tag?
4. What are the four parts of tag-based data sources? Give examples of each component.
5. What graphic elements are responsible for requesting data from tags?
What determines how quickly values are updated?
Electronic Books Research
6. Once finding a topic in the eBooks, how can you remember the topic for later use?
How is this achieved?
2-52
Education Services
GFS-154K
Proficy iFIX - Architecture and Applications
Review
Now that you have completed this module, you should be able to:
 Describe the system architecture
 Discuss key applications
 Explain the Training Course application for the lab exercises
 Create a Simple Display and associated Database Blocks
GFS-154K
Education Services
2-53
Proficy iFIX - Architecture and Applications
2-54
Education Services
GFS-154K
0)
03
COMMUNICATIONS
a
At the end of this module, you will be able to:
 Explain the different types of I/O Drivers and
OPC Servers
 Discuss the basics of I/O Driver configuration
 Discuss the IGS Driver
 Install I/O Drivers and OPC Servers
15%
Proficy iFIX Fundamentals - Communications
3-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
I/O
Communications
Communications Overview
SCADAs use a variety of communication media to transfer data to and from control
hardware such as PLCs, RTUs and DCS systems. These media are tailored to the realities of
the industrial process, balancing cost and performance against throughput and distance.
For example, radio may be used in one area of the process where a remote location is
kilometers away, while Ethernet is used inside the plant where distances rarely exceed
several hundred meters. As a result, SCADA servers are often called on to use a variety of
I/O ports to communicate to remote devices.
Most PLC, RTU and DCS vendors use their own proprietary data transfer protocols to
communicate across the media linking devices to PC-based workstations. Without a
matching driver for the protocol, the SCADA will not be able to retrieve or send data to the
control hardware.
SCADA communications
SCADA nodes need to manage these hardware connections by combining the various
available communications media with the vendor protocols. iFIX uses I/O Drivers and OPC
servers to continuously communicate with the plant floor devices.
I/O Drivers and OPC servers are software applications that are installed on the SCADA node.
These applications act as the schedulers, arbitrators, requesters and responders for all data
being exchanged between the SCADA PC and the control hardware. They pair protocols
with media in order to poll data from the various control devices. I/O Drivers often support
more than one protocol and media combination, though these combinations are almost
always specific to a vendor product family (for example, Siemens, Modicon or Allen
Bradley).
GFS-154K
Education Services
3-3
Proficy iFIX Fundamentals - Communications
I/O Drivers and OPC Servers
The Industrial Gateway Server (IGS) Driver is today’s interface of choice by many
developers, as it has support for 135 configurable protocols from an array of manufacturers.
iFIX v 7.x I/O Drivers are also supported and found in many end user applications.
They use a GE proprietary protocol or OPC DA to provide data to iFIX. As OPC DA servers
they can also interoperate with any OPC DA client application on platforms using
COM/DCOM.
They incorporate many advanced features within a friendly development interface called
the Powertool. The Powertool allows both configuration and run-time monitoring of the OPC
v.7.x Server.
Always check which hardware types, protocols, and operating systems are supported.
They have a richer feature set than the legacy v.6.x drivers and can also be controlled with
VBA scripting from iFIX.
Legacy v. 6.x I/O Drivers may still be found, structurally they are very similar to v7.x I/O
Drivers with some key differences. They use an iFIX proprietary protocol for data transfer to
SAC. They have limited Operating System support but will work with iFIX. Always check the
release notes for operating system support.
3-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
Communication Media types
I/O Drivers can also be categorized by media type. Regardless of the protocol being used,
I/O Drivers using common communication media look and behave similarly.
Media Type
COM
Serial port
Description
Serial communications
through serial ports via
RS-232 or RS-485.
Advantages
- Works with any PC serial
port.
- Can use a modem.
- Inexpensive, easy to
configure.
Disadvantages
- Slow communications.
- Limited to short
distances.
RES
Resident
card
Proprietary vendor
equipment including
cables and vendor
supplied cards.
- High-speed, deterministic
communications.
- Excellent for long
distances.
- Robust, built for plant
floor.
- Generally very
expensive.
- Usually requires extra
software.
- More complex to set
up.
RTU or DDA
RTU communications
through radios,
telephones and
satellites.
- Ideal for low-bandwidth
communications to very
distant or remote
locations.
- Can report data directly to
displays.
- Built-in alarm handling.
ETH
Ethernet
Standard commercial
or industrial grade
Ethernet equipment
and network cards.
- High-speed
communications.
- Good for long distances.
- Inexpensive and flexible.
- Easy to support.
- Very slow
communications.
- Usually requires extra
software from RTU
vendor.
- Requires more complex
configuration to avoid
overloading and to
achieve
deterministic data
transfer.
Table 3-1. I/O Driver media types
GFS-154K
Education Services
3-5
Proficy iFIX Fundamentals - Communications
Installing I/O Drivers
The IGS with its full set of supported protocols is part of the default installation of an iFIX
2022 SCADA node. Once installed, the protocols which have been licensed will be available
for use once the IGS has been added to the iFIX Project SCU.
For v7.x (or v6.x) Drivers, each Driver must be installed. The GE Digital Support web site
lists all of the available I/O Drivers from GE Digital and its partners. Once the media type
and protocol have been determined, developers can browse for the correct I/O Driver.
Always ensure compatibility with product version and operating system.
Navigate to https://digitalsupport.ge.com/ and search for a driver, typically by entering a
device model, e.g. APACS for the DCS APX Driver or Control Logix 5000 which will offer up
the IGS Driver.
There are fact sheets online for each driver that will assist identification of the best I/O
Driver based on the requirements.
Sourcing and Licensing
Once the required driver has been identified it must be individually licensed for all
Development SCADA nodes using it at site. The IGS Driver must be licensed, it also has
some Premium protocols which must be licensed separately. Most v7.x drivers do not
require specific licensing, but there are some exceptions such as the very common S7A
Driver for the Siemens S7 PLC.
The Support web site is the most reliable source for I/O Drivers, as recent revisions will
always be available on the download site. It also contains every I/O Driver supported by
iFIX, including the older v.6.x versions.
Driver pre-requisites.
Some drivers require third-party software in order to communicate with the specific
hardware devices. Examples include RS Linx to communicate to AB PLCs via the ABR driver,
or Bristol Babcock OpenBSI to communicate to Bristol Babcock RTUs. Naturally, if resident
cards are present, they must be installed and configured correctly.
v.7.x Drivers require a COM compliant operating system. The most popular drivers are kept
up to date with operating systems such Windows 2019 Server and Windows 10.
Older drivers may only support older operating systems which in themselves will likely have
security vulnerabilities. If possible, keep versions of operating systems and drivers up to
date.
If using OPC over a network, DCOM will have to be enabled, proper security must be set
and appropriate firewall considerations satisfied. Better still adopt OPC UA instead.
3-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
Installation Steps
 Determine which I/O Driver to use according to the protocol and media requirements
 Download the I/O Driver from the GE Digital Support web site
 IGS is installed with iFIX using the v2022 integrated installer. It can however be downloaded
and installed separately
 For v7.x Drivers, install to the iFIX Base directory. It is best to keep the driver executable and
resource files in the same directory as the other iFIX applications
 For v7.x Drivers, install the full driver, indicate “Server” when prompted. It installs all the
driver components. If only the Powertool is needed, choose “Client”
GFS-154K
Education Services
3-7
Proficy iFIX Fundamentals - Communications
Industrial Gateway Server (IGS) Driver
The IGS Driver provides OPC based connectivity for iFIX. It is a standalone package whose
current version contains 135 configurable Protocol drivers based on industry standard
protocols and provides connectivity to the world’s most popular devices.
Administration, configuration, and maintenance is performed through an independent
Configuration Application.
IGS can be used to provide stable, reliable connections to thousands of mixed vendor
devices and instruments for any of the iFIX software packages and can be shared with third
party applications. In addition, IGS has an optional ‘Premium’ driver package that can be
added on top of the base offering which extends connectivity even further.
Licensing
The IGS Driver is licensed as a ‘keyed’ option on the Proficy License Key, it must be ordered
at the same time as the iFIX License. The GE Core Drivers are included with the IGS license,
but some Protocols will require additional licensing. Always check to see if the Protocol
required necessitates a supplementary purchase.
If licensed by family groups, check the key to ensure the number of family groups required
is on the license key.
Figure 3-1. IGS Driver Licensing
Installation
During the default installation of the IGS Driver with the iFIX 2022 integrated installer, all
available protocols are installed. If performing a manual installation, the protocols required
can be optionally selected.
A list of all protocols available in the IGS Driver are on the next page.
3-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
IGS Protocols
Advanced Simulator
Allen-Bradley 1609 UPS Driver
Allen-Bradley Bulletin 900
Allen-Bradley ControlLogix
Allen-Bradley ControlLogix
Unsolicited
Allen-Bradley DH+/DH485
Allen-Bradley DF1
Allen-Bradley Ethernet
Allen-Bradley Micro800
Ethernet
Allen-Bradley Micro800 Serial
Allen-Bradley Unsolicited
Ethernet
Analog Devices OPC Server
Aromat Ethernet OPC Server
Aromat Serial OPC Server
AutomationDirect DirectNET
AutomationDirect EBC OPC
Server
AutomationDirect ECOM OPC
Server
AutomationDirect K Sequence
AutomationDirect Productivity
3000
Beckhoff TwinCAT I/O
BUSWARE Ethernet
CODESYS Ethernet
Contrex M-Series
Contrex Serial
Custom Interface Driver - CID
Cutler-Hammer D50/D300
Cutler-Hammer ELC Ethernet
Cutler-Hammer ELC Serial
Dataforth isoLynx
DDE Client Driver
Fanuc Focas Ethernet
Fanuc Focas HSSB
Fuji Flex
GE CCM
GE Ethernet Global Data (EGD)
GE Ethernet OPC Server
GE SNP OPC Server
GE SNPX OPC Server
Hilscher Universal Driver
Honeywell HC900 Ethernet
Honeywell UDC Ethernet
Honeywell UDC Serial
Idec OPC Server
Intelligent Actuator (IA) Super
SEL
InTouch Client
IOtech PointScan 100
Keyence KV Ethernet
Krauss Maffei MC4 Ethernet
Memory Based
Mettler Toledo Continuous
Mode Serial
Micro-DCI
Mitsubishi CNC Ethernet
Mitsubishi Ethernet
Mitsubishi FX
Mitsubishi FX Net
Mitsubishi Serial
Modbus ASCII Serial
Modbus Ethernet
Modbus Plus
Modbus Serial
Modbus Unsolicited
MTConnect
ODBC Client Driver
Omron FINS Ethernet
Omron FINS Serial
Omron Host Link
Omron NJ Ethernet
Omron Process Suite
Omron Toolbus
OPC DA Client Driver
OPC UA Client Driver
OPC XML-DA Client Driver
Optimation OptiLogic
Opto 22 Ethernet
Partlow ASCII
Philips P8/PC20
SattBus Ethernet
SattBus Serial
Scanivalve Ethernet
Siemens S5
Siemens S5 (3964R)
Siemens S7 MPI
Siemens S7-200
Siemens TCP/IP Ethernet
Siemens TCP/IP Unsolicited
Simatic 505 Ethernet - CTI
2500 Series
Simatic 505 Serial - CTI 2500
Series
SIXNET EtherTRAK
SIXNET UDR
SquareD
System Monitor
Telemecanique Uni-Telway
Thermo Westronics Ethernet
Thermo Westronics Serial
TIWAY Host Adapter
Torque Tool Ethernet
Toshiba Ethernet
Toshiba Serial
Toyopuc Ethernet PC3/PC2
Toyopuc Serial
User Configurable Driver
Wago Ethernet
Yaskawa Memobus Plus (SA85)
Yaskawa MP Series Ethernet
Yaskawa MP Series Serial
Yokogawa Controller Serial
Yokogawa CX
Yokogawa Darwin Ethernet
Yokogawa Darwin Serial
Yokogawa DX Ethernet
Yokogawa DX Serial
Yokogawa DXP
Yokogawa HR
Yokogawa GX
Yokogawa MW
Yokogawa MX
Yokogawa YS100
Premium
ABB Totalflow
Alstom Redundant Ethernet
BACnet/IP
Bristol/IP
Enron Modbus
Fisher ROC Ethernet
Fisher ROC Serial
Fisher ROC Plus Ethernet
Fisher ROC Plus Serial
IoT Gateway
Lufkin Modbus
OMNI Flow Computer
Ping
SNMP
Triconex Ethernet
Weatherford 8500
WITS Level 0 Active
WITS Level 0 Passive
Table 3-2. All IGS Protocols
GFS-154K
Education Services
3-9
Proficy iFIX Fundamentals - Communications
IGS Driver Configuration
The IGS Driver is configured with a Channel and Device definition.
The Channel definition assigns the protocol to be used, e.g. Allen Bradley ControlLogix
Ethernet.
A channel definition represents a communication medium from the SCADA PC to one or
more external devices. A channel can be used to represent a serial port, a card installed in
the PC or an Ethernet socket. The Channel defines which device driver protocol will be used
by all child devices of the channel.
The IGS Driver contains 135 protocol device drivers.
The Device definition then selects the Device type connected, e.g. MODBUS TCP/IP.
Many options are available during this Device configuration wizard, all of which can be
modified afterwards.
Device definitions comprise the second tier of the driver hierarchy. Devices represent the
PLCs or other hardware with which the server communicates. The device driver that the
channel is using restricts device selection.
For each Channel, there can be multiple device definitions. Each device will have its own
entry, along with specific device settings such as its name, type of Device, an IP address,
station number or logical name, along with many device driver specific settings.
Tags are the next step in configuring the IGS Driver.
Tags represent addresses within the PLC or other hardware device with which the server
communicates. The IGS Driver allows both Dynamic Tags and user-defined Static Tags.
Dynamic Tags are entered directly in the iFIX process Database Tag I/O Address field.
User-defined Static Tags are created in the IGS Configuration and support tag scaling. They
can be addressed by the Static Tag name when entered as sources for iFIX Process
Database Tags in the I/O Address field. They can also be directly browsed from any OPC
clients that support tag browsing.
Static Tags however are optional and, in many cases, may be inefficient
Tag Groups can be added to the project. Tag groups are used to tailor the layout of data
into logical groupings that fit the application's needs. Tag groups allow multiple sets of
identical tags to be added under the same device. This can be convenient when a single
device handles several similar machine segments.
Tip
The use of Tag Groups containing Static Tags can speed up significantly the
development of Asset Models and the iFIX Process Database. The IGS Channels,
Devices and Tag Groups can be browsed in the Asset Model panel of Configuration
Hub. From these, Models and Tags can then be automatically generated.
3-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
The IGS Configurator
The Configurator is divided into three panes: the Project View, the Detail View, and the
Event Log View.
Project View (1)
This view displays one of several configuration selection options for the current project. The
Project View that is displayed depends on the option chosen in the View Selector.
Detail View (2)
This view displays one of several configuration selection options for the current project. Its
information is related to the current Project View as determined by the View Selector. For
example, when Channels/Devices is selected, the Detail View will display the list of devices
or tags owned by the object selected in the Project View.
Event Log View (3)
This view displays three types of recorded messages: General Messages, Warnings, and
Errors. It is the bottom pane.
Figure 3-2. IGS Configurator Views
Saving IGS Projects
On startup, the IGS Driver will load the most recent project. Effectively the last configuration
file saved will become the default startup configuration. To determine what project the
server will load, look to the most recently used file list found under the File menus. The
loaded project will be the first project file listed.
GFS-154K
Education Services
3-11
Proficy iFIX Fundamentals - Communications
IGS Projects Properties
There are several IGS Project properties which can be configured, notably the iFIX PDB
Settings. Its configuration dialog contains parameters that allow users to adjust the
behavior between the processing of iFIX Process Database (PDB) Tags and the IGS Driver
Tags.
Figure 3-3. IGS Project Properties – iFIX PDB Settings
These Properties include:
 PDB to server request timeout(s): This parameter specifies the amount of time that the iFIX
PDB will wait for a response from an add, remove, read, or write request before timing out.
The default setting is 5 seconds
 Enable latched data: By enabling latched data, the last value successfully read will be
preserved on the screen. The default setting is unchecked
 Enable update per poll: When checked, the IGS Driver will deliver the current value, quality,
and timestamp to iFIX every time that the driver polls the device. The default setting is
unchecked
 Use iFIX Startup Configuration File: When checked, this file will be created by iFIX and
contain all items that will be accessed by the iFIX PDB. It will automatically start scanning
items before iFIX requests item data. The default setting is checked
 Enable connectivity to iFIX PDB: Enable or disable support of the client/server protocols. If
the iFIX PDB operation is disabled, the server does not respond to any request for iFIX PDB
data. For better performance and security when the server is only being used for OPC
connectivity, disable this property
See the IGS Help for further information.
3-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
Other Project Properties
Other Project properties can be configured here. Be it General, OPC DA, OPC UA, OPC AE or
Thingworx.
Figure 3-4. IGS Project Properties – OPC DA Settings
Figure 3-5. IGS Project Properties – OPC UA Settings
Again, refer to the IGS Help for detailed explanations.
GFS-154K
Education Services
3-13
Proficy iFIX Fundamentals - Communications
IGS Driver Configuration
The IGS Driver Configurator allows straightforward navigation of the IGS Driver hierarchy.
As levels are added, the project view will display Channels and Devices. As items are
selected in this Project view, the Detail view on the right hand side will display the selected
components child members.
Channels
Channel definitions are the top tier. A channel definition represents a communication
medium from the SCADA PC to one or more external device. A channel can be used to
represent a serial port, a card installed in the PC or an Ethernet socket. The Channel defines
which device driver protocol will be used by all child devices of the channel. The IGS Driver
contains 135 selectable channel protocols.
Figure 3-6. IGS Driver Channel Configuration
Channels require unique names and are configured to communicate on the required Device
Driver Protocol and assigned to the I/O port local on the SCADA PC e.g. Allen Bradley
ControlLogix Ethernet using the PC Ethernet port.
3-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
The configuration wizard offers the ability to modify many Channel parameters. These will
vary depending upon the Protocol selected. These parameters can be modified
subsequently by either double clicking the Channel in the Project view or by selecting
properties from the Channel’s right click menu.
Figure 3-7. IGS Driver Channel Properties (Modbus Ethernet)
Devices
Devices are added to Channels. Their configuration depends on the hardware features and
functions supported by the Protocol assigned to the Channel. In general, Device
configuration comprises of uniquely naming the device and supplying its address (e.g. IP
Address, station number, etc).
As with channels, a configuration wizard offers the ability to modify many Device
parameters. These again will vary depending upon the Protocol and Device selected. These
parameters can be modified subsequently by either double clicking the Device in the Project
view or by selecting properties from the Device’s right click menu.
Figure 3-8. IGS Driver Device Properties (Modbus Ethernet - Timing)
GFS-154K
Education Services
3-15
Proficy iFIX Fundamentals - Communications
Let’s single out Timing properties of a Device as it is good to understand how these apply
when a data failure occurs. Other Device properties obviously also have greater or lesser
effects, check the IGS Help to understand other properties.
 Device Failure Logic: As with any other iFIX Driver, failure logic is important to configure
correctly and is often dependent upon the Channel physical medium (e.g. Serial, Ethernet or
Proprietary). Other factors such as the number of Tags in the iFIX PDB can affect its
performance. The most important timings can be modified during the Device Configuration
wizard when adding the Device or in the Timing tab of the Device Properties.
 Connect Timeout(s): This parameter (which is used primarily by Ethernet based drivers)
controls the amount of time required to establish a socket connection to a remote device.
The device's connection time often takes longer than normal communications requests to
that same device. The valid range is 1 to 30 seconds. The default is typically 3 seconds, but
can vary depending on the driver's specific nature. If this setting is not supported by the
driver, it will be disabled.
 Request Timeout(ms): This parameter specifies an interval used by all drivers to determine
how long the driver will wait for a response from the target device to complete. The valid
range is 50 to 99999 milliseconds. The default setting is usually 1000 milliseconds, but can
vary depending on the driver's specific nature. The default timeout for most serial drivers is
based on a baud rate of 9600 baud or better. When using the driver at lower baud rates,
users may need to increase the timeout to compensate for the increased time required to
acquire data.
 Retry Attempts: This parameter specifies how many times the driver will retry a
communications request before considering the request to have failed and the device to be
in error. The valid range is 1 to 10. The default setting is typically 3, but can vary depending
on the driver's specific nature. The number of retries configured for an application depends
largely on the communications environment.
 Timeouts: If the environment is prone to noise induced communications failures, users may
want to set up the devices for auto-demotion or increase the number of retries that the
driver performs. If increasing the number of retries, note that when the driver encounters a
communication issue, it will attempt to reacquire the data for any lost requests. Based on
the "Request timeout" and the "Retry Attempts" count, the driver will pause on a specific
request until either the device responds or the timeout and retries have been exceeded.
This can potentially decrease the communications of other devices that have been
configured on that channel. In this situation, it may be more appropriate to utilize the autodemotion functionality to optimize communications with other devices on the same channel.
 Inter-Request Delay: This parameter specifies how long the driver will wait before sending
the next request to the target device. It will override the normal polling frequency of tags
associated with the device, as well as one-shot Reads and writes. This delay can be useful
when dealing with devices with slow turnaround times and in cases where network load is a
concern. Configuring a delay for a device will, however, affect communications with all other
devices on the channel. Thus, it is recommended that users segregate any device that
requires an inter-request delay to a separate channel if possible. Other communications
settings (such as Communication Serialization) can extend this delay. The valid range is 0 to
300,000 milliseconds; however, some drivers may limit the maximum value due to a function
of their particular design. The default setting is 0, which indicates that there will be no delay
between requests with the target device. This setting will be disabled if it is not supported
by the driver.
3-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
In addition to these Timing settings, the Auto-Demotion properties control how to
temporarily place a device off-scan in the event that the device is no longer responding. By
placing a nonresponsive device offline for a specific time period, the driver can continue to
optimize its communications with other devices on the same channel. After the time period
has been reached, the driver will reattempt to communicate with the nonresponsive device.
If the device is responsive, the device will be placed on-scan, otherwise it will restart its offscan time period.
Tags
Tags represent addresses within the PLC or other hardware device with which the server
communicates. The IGS Driver allows both Dynamic Tags and user-defined Static Tags.
Dynamic Tags are entered directly in the iFIX process Database Tag I/O Address.
User-defined Static Tags are created in the IGS Configuration and support tag scaling.
iFIX PDB Tags can address the Static Tag by name when entering sources in the I/O
Address field. They can also be directly browsed from any OPC clients that support tag
browsing.
Tags are added either by clicking the Click to add a static tag prompt in the Detail view
window or selecting New Tag from a Device right click menu. No wizard is presented for
adding tags, the tag configuration screen will appear, and parameters are entered manually.
Mass configuration can be achieved via a CSV import.
For many iFIX applications, Static Tags should not be necessary, Dynamic Tags should be
preferred.
Here the Tag Address is configured only in the iFIX PDB Tags I/O Address field.
Figure 3-9. IGS Driver Static Tag Properties
GFS-154K
Education Services
3-17
Proficy iFIX Fundamentals - Communications
Tag Name
This parameter is used to enter the string that will represent the data available from the tag.
The tag name can be up to 256 characters in length. While using long descriptive names is
generally a good idea, some OPC client applications may have a limited display window
when browsing the tag space of an OPC server. The tag name is part of the OPC browse
and therefore data tag names must be unique within a given device branch or tag group
branch.
If the application is best suited for using blocks of tags with the same names, then use tag
groups to segregate the tags. For more information, refer to Tag Group Properties.
Static Tag properties
These can be configured when adding the Tag or edited afterwards.
 Address: This parameter is used to enter the tag's desired driver address. The address's
format is based on the driver being used. The address entered can be up to 128 characters
in length. Once an address has been entered, it can be tested by clicking Check Address,
which will then attempt to validate the address with the driver. If the driver accepts the
address as entered, no message will be displayed. A popup will inform of any error. Some
errors will be related to the data type selection and not the address string.
 Description: This parameter is used to attach a comment to the tag. A string of up to 255
characters can be entered for the description. This is usually accessible when browsing
from an OPC client.
 Data Type: This parameter is used to specify the format of this tag's data as it is found in
the physical device. In most cases, this is also the format of the data as it returned to the
client. The data type setting is an important part of how a communication driver Reads and
Writes data to a device. For many drivers, the data type of a particular piece of data is rigidly
fixed and the driver knows what format needs to be used when reading the device's data.
This may be numerical or sting data such as Word, Short, Long, Float, Double, String and
many others.
 Client Access: This parameter is used to specify whether the tag is Read Only or
Read/Write. By selecting Read Only, users can prevent client applications from changing the
data contained in this tag. By selecting Read/Write, users allow client applications to change
this tag's value as needed.
 Scan Rate: This parameter is used to specify the update interval for this tag when used with
a non-OPC client.
When used with an iFIX Tag, it is the iFIX Tag which controls the update rate and overrides
any value entered here. When non-OPC clients access the data, and therefore this Scan
rate applies, users can tailor the bandwidth requirements of the server to suit the needs of
the application. The default is 100 milliseconds.
3-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
With the IGS Driver online and in a runtime operation, these parameters can be changed at
any time. Changes made to Tag Properties will take effect immediately, however OPC
clients that have already connected to this tag will not be affected until they release and
attempt to reacquire it.
In all cases Hints provide a quick reference guide to the driver's address formats. Users can
also access the driver's help documentation from Hints.
Tip
Adding Multiple Devices to a single Channel, as is seen in this course system, is not
recommended. The course system only uses the IGS local Simulation protocol.
In a production system with real remote devices and sensors, an optimization tip is to
have multiple Channels connecting to the same remote Device, splitting the
processes or I/O Addresses within the Device, between these multiple Channels.
GFS-154K
Education Services
3-19
Proficy iFIX Fundamentals - Communications
Monitoring IGS Communications
There are several ways to monitor, optimize and troubleshoot the IGS Driver.
When communications problems occur, users can utilize both OPC and channel diagnostics
to help determine the cause of the issue. These views provide diagnostics on both the
server-level and driver-level. Since they may affect performance, users should only utilize
diagnostics when debugging or troubleshooting.
OPC Quick Client
The OPC Quick Client can assist in the testing and development of the IGS Driver via the
OPC Data Access interface. It can be accessed via the Tools menu in the IGS Configurator.
When selected, a new window launches, auto populated with all Channels, Devices and any
Static Tags already added to the IGS configuration.
Figure 3-10. Launch the OPC Quick Client
OPC Diagnostic Viewer
The OPC Diagnostics Viewer provides both a real-time and historical view of OPC events
occurring between an OPC client and the server. It is accessed from the View menu.
An event is a method call that a client makes to the server, or a callback that the server
makes to a client.
Enable Diagnostic Capture must be enabled in the OPC DA settings of the project Property
Editor.
Figure 3-11. OPC Diagnostic Viewer
3-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
Communication Diagnostics
The Communication Diagnostics feature provide real-time information on the
communication driver's performance. All Read and Write operations can be viewed in the
Diagnostics Viewer or tracked directly in the OPC client application with built-in Diagnostics
Tags.
The Diagnostic Viewer also provides a real-time protocol view, which is useful when making
changes to key communication parameter settings (such as baud rate, parity, or Device
IDs). The changes' effects will be displayed in real-time. Once the correct communication
and device settings are made, the data exchange with the device will be visible.
Communication Diagnostics is enabled in Channel Properties and accessed from the View
menu.
Figure 3-12. Communication Diagnostics
GFS-154K
Education Services
3-21
Proficy iFIX Fundamentals - Communications
Version 7.x I/O Driver Configuration Basics
Version 7.x I/O Drivers are organized into a three level hierarchy: Channels, Devices and
Data Blocks.
Channels are the top tier. A channel definition includes the important information about
which I/O port to use (e.g. NIC #1, NIC #2, COM port 1, etc.). The I/O port is the “door” to
the device network for the SCADA and must be explicitly defined.
Device definitions comprise the second tier of the driver hierarchy. For each Channel,
there can be multiple device definitions. Each device will have its own entry, along with a
specific device ID such as an IP address, station number or logical name. This will tell the
I/O Driver how to find the PLC or RTU on the device network.
Data Blocks (or Poll Records) constitute the third tier. For each device there will be
unique poll records that indicate which I/O addresses to poll from the PLC registers. Each
poll record will have a poll time that governs how often polling will occur.
The Powertool
The Powertool is a common interface shared by all iFIX v7.x I/O Drivers.
It is the primary interface for configuring the driver channels, devices and data blocks. It
creates a file used by the driver poll task to communicate to the appropriate hardware
registers in the plant floor control devices. Once the configuration file has been built, the
Powertool does not need to be open for communications to occur, it can be used simply to
monitor the I/O Driver polling.
The Powertool has two modes:
Configure mode allows the settings to be created or edited for channels, devices and data
blocks.
Statistics mode allows monitoring of I/O driver polling processes. Transmit and receive
counters, errors, error timestamps and, for certain drivers, even current values can be
reviewed at real-time.
The Powertool also allows manual Stop and Start of the I/O Driver poll task.
Note
The Powertool can be used to start and test the I/O Driver communications even
when iFIX is not running.
3-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
Saving and Options
The Powertool default configuration file can be stored anywhere on the SCADA. By
choosing the Setup item from the Options menu, the following dialog box can be set to
direct the I/O Driver to a default configuration file and path (using the Default Path tab).
Figure 3-13. I/O Driver default file name and path
To keep things simple and efficient, it is best to save the configuration file in the project
PDB directory. It is also a good practice to name the file using the following convention:
<nodename>.XXX
where the <nodename> is the SCADA node name and XXX is the three letter driver name.
For example, the SCADA01 MBE driver configuration file should be named SCADA01.MBE
Note
If the developer wants to use a different naming convention and directory, it is
possible, but there are extra steps required. The default path and name will still
have to be configured from the Options menu (using the new names and locations),
but the developer will also need to put a “dummy” file in the PDB directory using
the naming convention described above. This dummy file can be an empty text
file; it does not actually need to contain anything. Due to legacy functionality, the
SCADA needs to see what looks like a configuration file in the default PDB
directory before it creates the DIT. Once the DIT is created, the I/O Driver is
started using the Powertool defaults.
GFS-154K
Education Services
3-23
Proficy iFIX Fundamentals - Communications
The Advanced Tab of this dialog box also contains some helpful features.
Figure 3-14. Powertool Setup Dialog – Advanced Tab
 Server Auto Create: This will detect PDB tag I/O Addresses and automatically create any
missing addresses in the I/O Driver (according to certain preset rules). The Auto Create
cannot add devices, but it can add or extend data blocks to include new addresses.
 Startup Auto Start: This will ensure that the I/O Driver starts in Run mode (i.e. polling the
hardware).
 NIO Simulation Mode: This allows the DIT to reflect output values from PDB tags back as
inputs. This is generally only used for testing or simulation.
The Memory settings are useful for reducing or increasing the footprint of the DIT common
memory space on a PC. These settings affect the DIT and its efficiency directly, hence they
are rarely edited except with assistance from GE Digital Technical Support.
3-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
Powertool Configuration
The Powertool allows straightforward navigation of the I/O Driver hierarchy. As levels are
added, a tree view of the configured elements will be displayed in the explorer pane on the
left-hand side. As items are selected in this explorer view, the settings appear in a form on
the right hand side. This is true for both Configuration and Statistics mode.
Channels and Protocols
The top tier of the I/O Driver hierarchy is the channel settings. The types of settings
available will depend greatly on the type of driver used (e.g. Ethernet, COM, RES, etc.) and
the protocols it supports. For I/O Drivers that support one type of media (e.g. Ethernet) and
one type of Protocol (e.g. Modbus TCP) there will be very few items to set. With multiple
media, multiple protocol drivers (e.g. Serial, Radio or Telephone media with Modbus ASCII
or RTU protocols), set up will be more complex in order to specify exactly what is required
by the application.
Figure 3-15. Powertool Channel Configuration (MBE I/O Driver)
Channels require unique names and I/O ports in order to be configured. In the example
above, setting the channel is as simple as choosing which Ethernet card to use.
In this case, the cards are numbered 0-n, and a quick description (retrieved from the
Windows registry) is supplied underneath to assist with selection. Other I/O Drivers may
require more detailed configuration.
GFS-154K
Education Services
3-25
Proficy iFIX Fundamentals - Communications
If a back-up channel is enabled, the I/O Driver automatically fails over to that channel when
the primary channel fails. This is true for all v7.x Drivers. Mixed media/protocol drivers will
allow cross over of channel media (for example, telephone connections can back up radio
connections).
Each channel can generally support only one protocol at a time. For multiple protocol
drivers, the protocol will be chosen and associated with a specific I/O port. All Devices
using that channel will be required to communicate using that protocol.
Devices
Devices are added to Channels. Their configuration depends on the hardware features and
functions supported by the I/O Driver. In general, Device configuration comprises of
uniquely naming the device and supplying its address (e.g. IP Address, station number, etc).
As with channels, back-up devices can be specified for automatic fail-over should the
primary device fail. Unlike channels, where error or failure detection is usually built into the
protocols they use, devices need to have failure conditions defined explicitly for them. This
is set in three fields: Reply Timeout, Delay and Retries.
Figure 3-16. Powertool Device Configuration (MBE I/O Driver)
Reply Timeout is the maximum allowable latency between when the I/O Driver transmits a
request and receives a response from the PLC. Should the PLC response exceed the Reply
Timeout, the I/O Driver will attempt to Retry the connection. If the I/O Driver consecutively
fails to connect to the PLC the number of times defined in the Retry field, it will wait the
period of time defined in the Delay Time field before it automatically fails over to the backup device if it exists. In any case, it will report the lost connection to iFIX as COMM
(communications) errors and continue attempting connection.
3-26
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
Data Blocks (or Poll Records)
Data Blocks are added to Devices to allow a user to drill into the registers present in the
control hardware. The Data Block specifics depend on the capabilities of the hardware, and
the unique addressing that each vendor uses to identify I/O registers.
Figure 3-17. Powertool Data Block Configuration (MBE I/O Driver)
The essential settings for a data block are the Address range identifying the registers, the
Data-Type and the Primary Rate. The block name is a useful group name for the I/O
address range, but unlike the channel and device names, the data block name is not
required to connect PDB tags to the DIT.
GFS-154K
Education Services
3-27
Proficy iFIX Fundamentals - Communications
Address Ranges
A developer can create data block address ranges of any size permitted by the protocol and
data type, however there are some good practices to follow. In general, for analog-type
addresses such as integers and real numbers, it is best to create a range of between 100
and 150 addresses, if possible. This is the optimum size for a data block to transfer data
and populate the DIT. Digital addresses such as Boolean values follow a similar rule, with
the optimum range between 100 and 200 words (groups of bit addresses). Each word is
composed of 16 (or 32) single bit addresses, where the Boolean values are stored.
An address range must be of a single homogenous data-type, such as “Unsigned Integers”.
For example, if a range of addresses from 1 to 100 is composed of unsigned integers from 1
to 49, real numbers from 50 to 75 and signed integers from 76 to 100, the user will have to
create three separate data blocks: Datablock1 will range from 1 to 49 and be all unsigned
integers; Datablock2 will range from 50 to75 and be all real numbers; Datablock3 will range
from 76 to 100 and be all signed integers.
Deadband indicates that the DIT should be updated only when a value changes by at least
this amount (in native units, not percentage).
Primary (Poll) Rate
The poll rates can be assigned in different ways. By default, the Primary poll rate will
always poll the data at the desired period (1 second, 1 minute, etc). This poll rate tells the
driver how often to update the DIT with values from the hardware (provided the Deadband
conditions are satisfied).
Examples:
 A rate of zero (0) polls as quickly as the driver can manage
 A rate of 0.5 polls the entire range of addresses every half-second
 A rate of 1 polls every second; 1:00 polls every minute; 1:00:00 polls every hour; 1:00:00:00
polls every day
Secondary (Poll) Rate and Access Time
For instances where the data being updated in the DIT is not always being used by other
parts of iFIX, the driver allows the user to specify a slower Secondary polling rate. This
slower poll rate will be used to continue updating the DIT in a “maintenance mode”.
The Primary and Secondary rates are used based on simple rules. If the data in the DIT is
being requested by tags or other iFIX processes, the I/O Driver will always revert to the
faster Primary poll rate. If the requests pause or stop, a timer counts down starting from the
Access Time. At zero the poll rate will switch to the slower, more efficient Secondary rate.
3-28
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
Statistics Mode and Monitoring Communications
The Statistics mode of the Powertool is an effective troubleshooting and optimization tool
for I/O Driver communications. Each element of the configuration can be specifically
targeted, and parent elements will also contain summary information and totals for all their
contained elements.
In combination with the Enable checkbox (Configure mode) it is relatively easy to isolate
trouble spots with various driver elements, be they in the Channel, Devices or Data Blocks.
Data Blocks
Data Blocks will give the lowest level information, including information such as the number
of Transmits (requests) and Receives (responses), current data quality and timestamps for
reads, writes and errors.
Figure 3-18. Powertool Statistics mode (MBE I/O Driver data block)
GFS-154K
Education Services
3-29
Proficy iFIX Fundamentals - Communications
Devices
Device statistics show summaries and totals for all the data blocks specified within the
Device. It will also verify the channel address (IP address, or port number) as well as the
device address. It will show counts for error conditions, but for more information, the user
will need to drill down into the specific data blocks.
Figure 3-19. Powertool Statistics for Devices
Channels
Channel statistics show summaries and totals for all the devices specified within the
Channel. Like the Device page, the user will have to drill down for specific information.
Figure 3-20. Powertool Statistics for Channels
3-30
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
The SIM Driver
iFIX is delivered with two drivers that can be used for testing and simulation. These
simulation drivers are built differently than other iFIX I/O Drivers. They do not have a
configuration interface, nor can they be monitored using troubleshooting tools. The user
does not need to create channel, device or poll record definitions as the values are coming
from an internal software process.
These simulation drivers also provide limited system information to PDB tags such as alarm
and system counts.
Static Addresses
The SIM driver provides 2,000 16-bit registers (0 to 1999 words, 0-15 bits) that can be used
for both analog and digital values. Addressing is simple. Analog and text tags use whole
number addressing representing 16 bit words (e.g. 1, 25, 250, etc). Digital tags will use a
Word:Bit combination to specify a two-state value (e.g. 1:0, 25:2, 250:15).
These registers are a single set of read-write addresses shared between digital and analog
values.
The SM2 driver provides two independent sets of 20,000 registers. The set for analog
addresses stores values in 32-bit words, whereas the separate set for digital addresses
holds values in 16-bit words. The addressing conventions are the same as with the SIM
driver.
GFS-154K
Education Services
3-31
Proficy iFIX Fundamentals - Communications
Signal Generation Addresses
Read-Only Registers
Read-Write Registers
Register
Description
Register
Description
RA
Ramp from 0 to 100% of EGU
range.
Rate controlled by RY register.
RI
Control Ramp direction of RH
register. (0 = down, 1 = up).
RB
Count from 0 – 65535 at 20
counts per second.
RJ
Control RH ramp speed in
cycles/hr. (1 to 3600, default =
60 = 1 cycle/min).
RC
Shift one bit through a 16-bit
word.
Rate controlled by RZ register
RK
Start or pause RH ramp register.
(0 = pause, 1 = start).
RD
Sine wave from 0 to 100% of
EGU.
Rate controlled by RY register.
RX
Start or pause all other registers.
(0 = pause, 1 = start).
RE
Sine wave from 0 to 100% of
EGU, delayed 90 degrees from
RD.
Rate controlled by RY register.
RY
Control RA, RD, RE, RF register
speeds in cycles/hr. (1 to 3600,
default = 60 = 1 cycle/min).
RF
Sine wave from 0 to 100% of
EGU, delayed 180 degrees from
RD.
Rate controlled by RY register.
RZ
Controls the speed of RC in bits
per minute. (2 to 1200, default =
180 = 3 bit shifts per second).
RG
Random values from 25% to
75% of EGU range.
RH
Ramp from 0 to 100 to 0% of
EGU. Rate controlled by RJ
register.
S
(SM2
only)
Simulates COMM alarms on all
registers when set to 1.
Table 3-3. The signal generation registers for the SIM and SM2 drivers
3-32
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
SCADA components in the SCU
Once the required I/O Drivers have been identified installed and added to the SCU
configuration, the SCADA server is ready for further configuration. This will include enabling
SCADA capabilities; defining which drivers to load and which PDB to use.
Specification of these features requires re-visiting the SCU to complete the SCADA specific
configuration. Once completed, the SCADA will be able to begin data acquisition.
Figure 3-21. SCADA components of the SCU
There are three tasks to configure to prepare iFIX for data acquisition and control:
Enable SCADA, set the default PDB, and add the I/O Drivers.
 SCADA Support: Enabling SCADA support designates the iFIX node as a SCADA server,
allowing it to use I/O Drivers and PDBs to manage data. Disabling SCADA support makes
the iFIX node a Client.
 PDB: Once SCADA support has been enabled this field becomes available. A SCADA node
can have several PDB files in its PDB path, but only one can be loaded and connected to
SAC at a time. The PDB listed in this field will become the default PDB and iFIX will load it at
start-up.
 I/O Drivers: The browse list for I/O Driver Name will only show the installed I/O Drivers. iFIX
will only create DITs for v7.x I/O Drivers in the Configured I/O Drivers list, and it can manage
eight drivers at a time (including the SIM and SM2 drivers). Simply browse to the desired I/O
Driver and click Add to include it in the list of drivers. When using IOCNTRL.EXE and the /A
switch (in the SCU Task configuration), all listed drivers will be started when iFIX starts.
GFS-154K
Education Services
3-33
Proficy iFIX Fundamentals - Communications
Troubleshooting Topic
Testing for successful Communications between the iFIX SCADA node and the plant floor
devices is best done within the communication applications themselves. That is, the IGS
Driver Configurator or the v7.x Driver Powertool.
Already discussed in this chapter are the IGS troubleshooting tools of:
 OPC Quick Client – check to see if any or all sources are communicating
 Communication Diagnostics – use per Channel to determine if communications on the
specific protocol are operational
 OPC Diagnostics – use to diagnose any issues when OPC Clients are retrieving data from the
IGS Driver
eBooks Topic
There are hundreds of Drivers capable of working with iFIX.
The Online Help covers many I/O Driver related topics.
Search the Online Help and search for “Drivers”. Look for the I/O Drivers topic.
Take a read at this topic and the linked topics when you have time.
Figure 3-22. Online Help – I/O Drivers
3-34
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
Lab Exercises – Communications
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Configure the IGS Driver
 Monitor the IGS Driver
 (Optionally) Configure the MBE v.7.x I/O Driver
 (Optionally) Monitor MBE Communications
When you are finished with these exercises, answer the Summary Questions at the end of
the module.
Introduction
The Instructor’s PC will provide a simple Modbus simulation. You will connect the IGS
Modbus Ethernet Device Driver to this simulation to demonstrate the IGS configuration and
to supply values to sample tags.
You will add a new Device to the Plant Controllers for the Ingredients process area and
import a set of static tags.
Optionally you may install, configure and monitor the v7.x MBE Driver.
Lab Exercise #1 – Configure the IGS Driver
Part A – Add a new Modbus TCP Channel
1. Save and close any open pictures and minimize
Workspace.
2. From the Windows desktop, click the up arrow to the left on
the clock in the system tray, next right click on the IGS icon,
then click Configuration at the top of the list.
3. The current IGS configuration will be presented.
Take a moment to look around observing the Project View
(tree on the left), the Detailed View (panel on the right) and
Event View (event list at the bottom.
GFS-154K
Education Services
3-35
Proficy iFIX Fundamentals - Communications
Next, we will add a new Channel:
4. Highlight Connectivity at the top of the Project tree, then right click on Connectivity and
select New Channel.
5. In the Channel Type drop down, select Modbus TCP/IP Ethernet and click Next.
6. In the next window configure the Channel name as ModBusTCP and click Next.
7. In the next window leave Virtual Network and Transactions per Cycle at the defaults and
click Next.
8. In the next window, leave the Network Adapter at Default then click Next.
3-36
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
9. Click Next 3 more times until the final summary page is shown. Click Finish.
Now we will add a Device Definition.
10. Ensure that the new Channel ModbusTCP is highlighted in the tree of the IGS
Configurator. There are multiple ways of adding Channels and Devices, let’s try an
alternate.
From the Edit menu: click Connectivity -New Device.
11. Name the Device InstructorsPLC and click Next.
12. Leave the Device type as Modbus and click Next again.
GFS-154K
Education Services
3-37
Proficy iFIX Fundamentals - Communications
13. In the Device ID field enter the IP Address of the Modbus PLC that the Instructor has
provided. e.g. 10.0.0.20 (Ask your Instructor if unsure) and click Next.
14. Click Next 10 times to accept the default settings, then finally click Finish on the last
summary window. (Yes, there are so many configurable options when setting up a device,
that is what makes the IGS Driver such a great choice – its flexibility).
Now that a Channel has been created and a Device defined, we will add a Static Tag to
retrieve information from the Instructors PLC – a Modbus PLC simulation.
3-38
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
15. With the InstructorsPLC highlighted click the link Click to add a static tag, in the right
hand pane.
16. Enter the following information for this Static Tag:
a.
b.
c.
d.
e.
f.
g.
Name: AmbTemp
Description: Ambient Temperature
Address: 400100
Datatype: Default
Client Access : Read/Write
Scan Rate : 100ms
Click OK when complete.
It should now look like this:
17. Add a second Static Tag for a Boolean value (right click in the right side Details pane and
choose New Tag):
a.
b.
c.
d.
e.
f.
GFS-154K
Name: HeaterSwitch
Description: Status of the heater
Address: 000001
Datatype: Default
Scan rate: 100ms
Click OK when complete.
Education Services
3-39
Proficy iFIX Fundamentals - Communications
Next you will save the IGS Driver configuration. This can have additional security applied,
but we will leave it with limited security for now.
18. File menu – Save As, or in the main toolbar click the Save As button.
19. At the Save Project prompt, select the No encryption option, then click OK.
20. When prompted for the location, this will be the file in your iFIX projects \PDB path:
C:\Program Files (x86)\Proficy\iFIX\PDB\Plant.opf.
Highlight the Plant.opf file and click Save. At the Confirm prompt, click Yes.
3-40
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
Part B – Add new Devices and then Static Tags through import
1. Locate and highlight the PlantData channel in the Project tree. Right click and choose
New Device.
2. Name the Device SIMDev and click Next.
3. Leave the Device type as 16 Bit Device and click Next again.
4. Click Next accepting the default settings, until the final summary window and click Finish.
5. With the new SIMDev highlighted in the Project tree, right click and choose Import CSV.
6. Browse to the folder C:\ClassFiles\03. Communications\ and highlight the file
Functions.csv. Then click Open.
7. Observe several Static Tags for Ramps, Random, Sine and User functions have been
added.
GFS-154K
Education Services
3-41
Proficy iFIX Fundamentals - Communications
You will now through addition of a Device and Import of Static Tags, add a PLC designed to
monitor the processes required to present data from the Ingredient Tanks in the course
system.
Often it is more efficient and less click intensive, to create a configuration in a csv editor,
such as Excel, and then import.
8. Again, right click on the PlantData Channel and choose New Device.
9. Name the new Device IngredientsPLC. Then click Next 4 more times to accept the
defaults, then click Finish on the last screen.
10. Next, right click on this new IngredientsPLC Device and choose Import CSV.
11. This time in the same \03.Communications\ folder, highlight the IngredientsPLC.csv file
and click Open.
12. Once imported, highlight the cellulose_E460 Tag Group and observe its contained Static
Tags.
13. Lastly Save the IGS configuration. Click Ctrl-S on the keyboard, or use one of the Save
options in the File Menu or main toolbar.
3-42
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
Part C – Monitor the IGS Driver
1. From the Tools menu select Launch OPC Quick Client OR from the tool bar click the OPC
Quick Client icon:
2. The OPC Quick Client should resemble the figure below. Verify that your hierarchy looks
like the one shown.
3. Expand the tree and select the ModbusTCP.InstructorsPLC device.
The Item pane will show the two Static Tags added earlier. Displayed will be the ItemID,
Data Type, Value, Timestamp, Quality, and Update Count. Initially the value will be zero.
4. Browse the other ModbusTCP components and observe the Items each offer:
a.
b.
c.
d.
e.
ModbusTCP.CommunicationsSerialization
ModbusTCP._Statistics
ModbusTCP._System
ModbusTCP.InstructorsPLC._statistics
ModbusTCP.InstructorsPLC._System
5. Highlight the ModbusTCP.InstructorsPLC in the Project tree, then, right click on the
AmbTemp Tag and select Synchronous Write.
GFS-154K
Education Services
3-43
Proficy iFIX Fundamentals - Communications
6. In the Write Value field enter any value between 0 and 100 then click OK.
Note
Everyone else in the class will attempt this too. It’s unlikely all will write a new value
at the exact same time as you, therefore this is a last person wins situation since
you are all writing to the same register in the Instructors PLC Modbus Simulator.
7. Repeat this with a Boolean value (1 or 0 will suffice) for the HeaterSwitch.
Observe the timestamps shown for the last activity, be it a read or a write.
8. Close the OPC Quick Client and click No to saving changes.
9. Exit to close the IGS Configurator, ensuring that any changes you made have been Saved.
3-44
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
Part D – Add the IGS Driver to the Project SCU
Although the IGS Driver is now configured, your iFIX SCADA# project is unaware of its
existence. The iFIX project must be told to use the IGS Driver, this is achieved in the SCADA
section of the SCU.
1. As before, open the iFIX SCU. (Refer to the earlier chapter lab if you do not remember how).
2. When the SCU opens, from the Configure menu choose SCADA.
Alternatively, the SCADA button on the hand toolbox at the bottom will open the same window.
3. In the SCADA Configuration window, click the ellipses button to the right of the I/O Driver
Name field, in the popup list of all installed drivers, highlight the IGS Driver then click OK.
4. Next click the Add button. The IGS Driver should now be in the Configured list.
5. Click OK to close the SCADA Configuration.
Click Yes at the SCU - DATABASE prompt.
6. Save and close the SCU.
7. Shutdown iFIX and click Save when prompted
to Save the Database, then OK when saved.
8. Restart your iFIX project from your SCADA#
desktop shortcut.
GFS-154K
Education Services
3-45
Proficy iFIX Fundamentals - Communications
(Optional) Part E – Configure IGS Settings required by Configuration Hub
The IGS Driver has several layers to its configuration, whether the Project configuration
which you have just done, OPC UA Server and Client management or underlying Settings.
When using Configuration Hub to access the IGS Driver in order to browse the channels,
devices and tags, the IGS web API must be enabled and an authorized user must be
accessible.
These are configured in the Settings tool.
1. As before, right click on the IGS icon in the Windows system tray (by the clock). This time
instead of choosing Configuration, choose Settings.
2. There are many tabs in this Settings tool. Move to the Configuration API Service tab.
3. The top 2 x settings of Enable and Enable HTTP must be set to Yes. This is already
configured in the IGS Settings on your Student computer, however on a default installation of
iFIX and the IGS Driver, these 2 settings will be set to No.
4. The IGS Driver has its own security system. When remote access is required from
Configuration Hub, or any 3rd party application, user credentials will be required. The default
installation if the IGS Driver in the iFIX 2022 Integrated installer, automatically configures the
Administrator user with no password. This is the default user with which Configuration Hub
will attempt its connection.
Here a new user could be added to one of the groups depending upon access required. This
screenshot below shows the user ExternalUser added to the Administrators group providing
maximum permissions. Your Instructor added this user. NOTE IGS Passwords require at least
14 characters, with upper and lower case letters, numbers and a special character!
5. Click the OK button to close the IGS Settings tool when complete.
3-46
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
(Optional) Part F – Configure and investigate other IGS Protocols
As seen in this chapter, the IGS offers 135 Protocol Drivers. In the class we have only looked
at the Modbus TCP/IP and the Simulation Channel types.
If there is time and you wish to investigate other common Protocols such as Allen Bradley
Control Logix, Modicon, Siemens etc, ask your instructor to explain how some of these may
be added and their common configuration options.
GFS-154K
Education Services
3-47
Proficy iFIX Fundamentals - Communications
3-48
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
Lab Exercise #2 – Access the IGS Driver in Configuration
Hub
1. Ensure that iFIX was restarted after the SCU changes in the last lab exercise.
2. From the Windows desktop, locate and double click the Configuration Hub shortcut.
3. At the Welcome page, enter Administrator as the user. The password will be the standard
password used throughout this class for administration users. Check your desktop
Student PC info file or ask your instructor. Then click the Sign In button. (The user and
password should be saved in the browser already).
Configuration Hub will now open.
4. In the Navigation panel, expand your SCADA# node, e.g. SCADA1 then highlight
Connections.
5. In the central Connection panel click on the IGS tab.
6. Next expand the ModbusTCP Channel and highlight the InstructorsPLC device.
7. Then click the Browse button.
GFS-154K
Education Services
3-49
Proficy iFIX Fundamentals - Communications
8. This device and its Static Tags will now be displayed, there are only the 2 Tags which you
added in an earlier lab. Enable the checkbox on both the AmbTemp and HeaterSwitch
tags. Then click the Stage Tags button.
9. Next, with these 2 tags enabled, click the Create (2) Tags button.
NOTE that the Block type automatically selected for the AmbTemp is an AI and a DI for the
HeaterSwitch.
10. A banner will appear at the top indicating the tags have been created.
Click anywhere in this green banner to acknowledge it.
Recall, Configuration Hub is a web-based configuration tool, the (potentially) remote
SCADA node may be running the plant, so actually adding the tags to a live SCADA
server is a 2 stage process. These have been created but not yet Published.
3-50
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
11. In the Navigation panel, next to your SCADA node name, click the Publish icon.
12. At the Publish prompt click the Publish button.
13. Click Done when Publishing has
completed.
14. The proof point, which we will revisit later, is viewing the Database panel in Configuration
Hub.
Click Database in the Navigation panel, then highlight one of the tags just added, e.g. the
AMBTEMP, then in the Details panel its Current value can be viewed and refreshed.
15. Once complete, close Configuration Hub, i.e. close the browser currently open displaying
Configuration Hub.
GFS-154K
Education Services
3-51
Proficy iFIX Fundamentals - Communications
3-52
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
(Optional) Lab Exercise #3 - Installing v7.x MBE Driver
Introduction
Drivers are available and can be searched on the GE Digital Support site:
https://digitalsupport.ge.com
They incorporate a Setup.exe to install the Driver Server and Client components.
We will be installing a typical common v7.x driver, being the Modbus Ethernet (MBE) driver.
Part A – Install the MBE Driver
1. Open a Windows File Explorer and navigate to the C:\ClassFiles\03.
Communications\MBE.
2. Inside the folder is a file called Setup.EXE. Double-click to launch this installer.
3. You will be faced with two steps, Welcome and then Licensing Agreement; click Next on
each.
4. The installation Wizard prompts you for an installation folder. By default, it supplies the
iFIX BASE path as the destination. Keep the default and continue, click Next.
5. You will be prompted for your node type. Leave this at the default of Server and click
Next.
6. You will be prompted for your node name. Verify that this is SCADA# (where # is your
assigned number, e.g. SCADA1. Then click Next.
7. Provide a location for the MBE driver shortcuts, leave at the default of the iFIX program
group.
Click Finish.
8. Bypass the Release Notes by clicking No to the pop up, unless you have plenty of free
time.
A message will most likely appear stating that the computer has a newer version of HTML
help. Click OK to close this pop up.
9. Click Done on the last Driver Installation screen.
GFS-154K
Education Services
3-53
Proficy iFIX Fundamentals - Communications
Part B – Configure the MBE Driver
1. Open the SCU and from the Configure Menu select SCADA.
2. Click the ellipses button to the right of the in the I/O Driver Name field.
3. Select MBE from the list, click OK in the popup, then click Add to add it to the configured list.
4. With this new MBE Driver highlighted in the Configured list, click the Configure button on the
right.
5. Next, click the Connect button to the Local Server when prompted.
6. Before you configure anything, lets save the MBE Config file in the projects \PDB folder. Click
the File menu and choose Save As.
7. Save as your SCADA#.mbe where # is your student number, in the iFIX\PDB folder e.g.
C:\Program Files (x86)\Proficy\iFIX\PDB\SCADA1.MBE
8. Our first task is to Create a Channel definition using an Ethernet card:
9. Click the Edit menu - Add Channel, or Click the Channel button.
3-54
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
A new channel will be added to the explorer pane, and the channel configuration form will
be displayed on the right side.
10. Set the Channel definition as follows
a. Channel Name: PLCNET
b. Description : PLC Network
c. Primary Card Number: select a card that is bound to your SCADA IP Address, e.g.
10.0.0.1 (check your PC Info desktop file)
d. Enable tickbox: checked
Next, we will define the PLC device (our Modbus Simulator on the Instructor PC). The
Instructor will provide the IP address to you. This will probably be 10.0.0.20.
11. Click the Edit menu - Add Device, or use the Add Device button.
12. Set the Device definition as follows:
a.
b.
c.
d.
GFS-154K
Device Name: InstructorPLC
Description : Instructors Modbus Simulation
IP Address: 10.0.0.20 (check with the instructor to ensure this is correct)
Enable tickbox: checked
Education Services
3-55
Proficy iFIX Fundamentals - Communications
Next, we will retrieve information from the PLC simulator. We will be creating two data
blocks: one for digital values and one for analog values. Create a data block:
13. Click the Edit menu - Add Data Block, or use the Add Data Block button.
14. Set the first Datablock definition as follows:
a.
b.
c.
d.
e.
Block Name: AnalogsA
Description : Analog Processes
Starting Address: 400100
Ending Address 400224
Enable tickbox: checked
15. Repeat for a second Datablock definition as follows:
a.
b.
c.
d.
e.
f.
Block Name: BooleanA
Description : Digital Processes
Starting Address: 000001
Address Length: 200
Primary Rate: 02
Enable tickbox: checked
16. Save the MBE Driver configuration. From the File menu choose Save, or use the Save button.
17. Next, from the Options menu choose Setup.
3-56
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
18. Move to the Default Path tab and enter:
a. Default Configuration File Name: SCADA#.MBE (e.g. SCADA1.MBE where # is your
student number).
b. Default Path for Configuration File: add \PDB to the end as this is where you saved this
file.
c. Then click OK.
19. Lastly, click the Run button on the main toolbar.
This MBE Driver was just added to the SCU, therefore is not yet running. After iFIX has been
restarted this MBE Driver will start automatically and use this file as the default configuration.
GFS-154K
Education Services
3-57
Proficy iFIX Fundamentals - Communications
Part C – Monitoring the MBE Driver
1. Highlight the AnalogsA data block in the explorer pane. Switch the MBE Powertool to
Statistics mode by choosing either the Display Mode menu and then - Stats Mode, or clicking
the Statistics Mode button.
2. The Powertool should resemble the figure below (with different stats). Verify that your
hierarchy looks like the one shown.
If there are errors in communications, the Last Error Time will show when they occurred, and
the Last Error frame will show a description of the error. The Timeout and Retries counters
may show indications that there have been brief interruptions. In an operational
environment, this should prompt personnel to undertake troubleshooting and optimization to
ensure clean, consistent communications.
3. If the Data Quality is Good, then the driver is currently retrieving good values from the
simulator. Continue to the next steps. If Data Quality is Bad, check the error information,
review your settings, and then check with the instructor before moving on.
4. Highlight the BooleanA data block. Ensure communications are good before exploring the
InstructorPLC device and PLCNET channel. When finished reviewing the Device and channel
statistics, return to the AnalogsA data block.
3-58
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
5. Next, open the Data Monitor (the button is located in the lower right portion of the Statistics
pane). This is a table view of the driver image table, showing the addresses and current
values as retrieved by the driver. Switch the Format to Decimal and note that some of the
addresses are displaying integer values. These are the same values used in the IGS Lab, if
the OPC Quick Client was used to write a new value, it would be shown here.
6. Close the Data Monitor and then Save your configuration and close the Powertool when you
are finished.
7. You will be back at the SCADA Configuration in the SCU where you added this new MBE
Driver.
Click OK to close the SCADA Configuration, then Save and close the SCU.
8. iFIX will need to be restarted in order to have this MBE Driver loaded automatically on startup
and available as a source for Process Database Tags.
GFS-154K
Education Services
3-59
Proficy iFIX Fundamentals - Communications
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 3 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
3-60
Education Services
GFS-154K
Proficy iFIX Fundamentals - Communications
Review Questions
1.
In the IGS Driver, what kind of information does a Channel definition contain?
2. In both the IGS and v 7.x what type of information does a Device definition contain?
3. What are the three types of Tags that may be found in use with the IGS Driver?
4. What three tools can be used to monitor the IGS Driver?
5. What kind of information does Statistics mode show in a V 7.x Driver?
Electronic Books Research
6. In the IGS Driver Help – find what components can be Imported and Exported?
GFS-154K
Education Services
3-61
Proficy iFIX Fundamentals - Communications
Review
Now that you have completed this module, you should be able to:
 Explain the different types of I/O Drivers and OPC Servers
 Discuss the basics of I/O Driver configuration
 Discuss the IGS Driver
 Install I/O Drivers and OPC Servers
3-62
Education Services
GFS-154K
0)
04
ALARMS
a
At the end of this module, you will be able to:
 Create Alarm Areas and common formats
 Enable Alarm Services
 Understand Alarm Shelving
20%
Proficy iFIX Fundamentals - Alarms
4-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Alarms
Alarms Overview
The SCU provides access to the Alarms system, which is an important part of the SCADA
node. This controls how the alarming sub-system will generate, label and deliver alarms.
Specification of these features requires re-visiting the SCU to complete alarm specific
configuration. Once completed, the SCADA will be able to perform the desired alarm
generation.
Figure 4-1. Alarming components of the SCU
Overview of Alarming
One of the important responsibilities of a SCADA server is to assess or detect unsafe or
unwanted conditions based on measurements from instrumentation on the plant floor. iFIX
provides alarm detection with SAC and the PDB.
Each PDB tag will include instructions that help SAC determine whether alarm conditions
exist. If alarms have been detected, special messages will be generated, labelled and then
delivered to various destinations such as operator displays, printers, text files or archive
databases.
The SCU has two tools that allow developers to set system-wide rules for how messages
are generated, labelled, and delivered.
GFS-154K
Education Services
4-3
Proficy iFIX Fundamentals - Alarms
Message Formats
Developers can create common formats to govern how alarm messages are displayed by
the alarm destinations (or services).
The alarm message will be displayed using field information from the PDB tags such as tag
name, description, and units. These fields will be displayed in individual columns.
The common format can also specify the length (in # of characters) for each field in the
message. These fields will be added, one after another, to form a single-line alarm
message.
The order the fields appear in the message will follow the column order as per the list. Use
the arrows to move a selected field up or down in the list.
Figure 4-2. Common Alarm Format
Alarm Areas
Alarm messages are high priority messages that often require operators to respond. As
SCADA servers generate alarms based on data coming in from all over the plant floor, it is
important to label and route alarms properly, so that operations staff do not get
overwhelmed by messages from parts of plant that do not concern them.
Alarm Areas allow developers to create labels for alarm messages so that they only end up
at necessary destinations. These labels can represent physical plant areas, logical areas, or
operational areas. When an alarm message is generated, it will be labeled accordingly.
Each destination alarm service will have a list of valid areas (a filter) that will allow or restrict
message delivery based on the message alarm area.
Alarms Areas can be shared between SCADA Servers and are contained the
AlarmsAreas.AAD file – AAD for short.
4-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Alarms
Alarm Areas Database
The Alarm Area Database (AAD) is a central resource where Alarm Areas are stored.
By default, the AAD is populated with sixteen (16) alarm areas (labelled by letters A – P). To
add alarm areas, enter an alphanumeric label and click Add. There is no theoretical limit to
the number of Alarm Areas.
Figure 4-3. SCU Alarm Area Database
Alarm Handling
Once generated, alarms are placed in a temporary queue on the SCADA. Clients and
SCADAs will request alarm updates from this central queue periodically. These alarm
updates will be routed to applications called Alarm Services. Each Alarm Service has its
own queue and can use their own custom Alarm Filters to restrict alarm delivery and routing.
It can also use a common (global) filter list.
Advanced - Common Areas
This common Alarm Area list can be defined in same location as the common format.
Alarm Services
iFIX provides a number of Alarm Service applications to deliver alarms to the locations and
people who need to assess what is going on in the plant and prevent undesirable events
from getting out of control. Some of these services are graphical in nature, and others are
background programs that facilitate delivery to other applications for analysis or reporting.
Figure 4-4. Alarm Configuration Dialog box with Alarm Services
GFS-154K
Education Services
4-5
Proficy iFIX Fundamentals - Alarms
Each Alarm Service has its own configuration requirements and interface. Both Clients and
SCADA servers can make use of these services to relay information to operators or other
applications. To enable a service, highlight it and click the “Enable” radio button. The
“Modify” button will be enabled, thus allowing further configuration of the services.
Alarm Printers
Any iFIX node (Client or SCADA) can send alarms to a maximum of four alarm printers.
These printers can be assigned to serial, parallel or USB ports. Output can be to single line
feed or a full page sheet feed. Alarm Printers have been retired by most users in this
environmentally focused world.
Figure 4-5. Alarm Printer Configuration
The Areas button allows selection of valid alarm areas for filtering based on the AAD. The
user can either choose “All” to let all alarms through, or a subset of the areas in the AAD, or
the “Areas Common to all Services” (i.e. Common Areas list). The Format button allows the
user to build a unique format for the alarm message or, more commonly, to use the Common
Format.
Alarm Summary
The Alarm Summary service is responsible for routing alarm messages to alarm summary
tables in displays. These interactive summary objects provide operators with a means to
interact with the alarm sub-system by reviewing, sorting, filtering, acknowledging, shelving,
and clearing alarms. It also provides audible signals (Horn Support) to indicate that new
alarms are present in the summary table. The Areas button can be used to filter the alarms
in the Alarm Summary service queue, just as with the other services. In displays, the Alarm
Summary object also supports supplemental filtering to restrict which alarms are visible.
The message format does not apply to the Alarm Summary.
Figure 4-6. Alarm Summary Configuration
4-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Alarms
Alarm Files
The Alarm File service will write messages to simple text-based files in the Alarm path
(generally the ALM directory). As with the printers, the alarms are written line-by-line in
batches. The text-based files have an extension of .ALM, and are created daily using the
date stamp as the file name (YYMMDD). Throughout the day, alarms will be written to the
text file, which grows as large as is required.
Figure 4-7. Alarm File Configuration
Alarm History
The Alarm History service will provide messages to a viewer (ALMHIS.EXE) for review during
short-term troubleshooting. This viewer can be launched from the Run prompt, or via
Workspace icons and scripts. The Alarm History viewer only holds the alarms temporarily,
so it is not good for long-term review of alarms. The alarms will be displayed in a First In,
First Out (FIFO) manner, up to a maximum number (by default, 100).
Figure 4-8. Alarm History Configuration
Note
The FIFO queue size for the Alarm History service can be set from the main Alarm
Configuration dialog by clicking on the Advanced button, and then selecting Queue
Configuration. Change the number found in the History field.
Alarm ODBC
The Alarm ODBC service is responsible for performing batch writes of alarm messages to a
Relational Database (RDB) such as Microsoft SQL Server or Oracle, however many ODBC
compliant relational databases can be used. This is an effective tool for long-term alarm
storage and analysis.
This functionality is covered in the iFIX Advanced Development course.
GFS-154K
Education Services
4-7
Proficy iFIX Fundamentals - Alarms
Alarm Network
The Alarm Network service enables network transmission of alarms between nodes
(SCADAs and Clients). When the Alarm Network service is enabled, a Network Alarm Client
task (NAC.EXE) is set up to request alarms from all SCADAs in the networked nodes list. A
Network Alarm Manager (NAM.EXE) is also created (on SCADA nodes only) to receive the
requests and then respond with the latest alarm messages. Thus, the Alarm Network
service must be enabled on every node that needs to receive or send alarms over the
network.
Figure 4-9. Alarm Network Configuration
Alarm Startup Queue
The Alarm Startup Queue service is responsible for populating Alarm service queues with
remote alarms that were generated while a node was shut down. For example, if a Client is
shut down and restarted at the end of a shift, the Alarm Startup Queue will go back and repopulate the various Alarm service queues with alarms from a period before iFIX was
restarted.
Figure 4-10. Alarm Startup Queue Configuration
The User can specify a period for previous alarm retrieval, and also whether to bring
Summary Alarms only (excluding system or operator messages).
4-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Alarms
Other Alarm Services
In addition to these Alarm Services configurable in the SCU, iFIX has an OPC Alarm & Event
Server, providing real time Acknowledgeable alarms to any OPC AE Client. If archiving
Alarms and Events from iFIX, the Historian Alarm & Event Collector will use this OPC AE
Service.
The iFIX OPC Unified Architecture (UA) Server also exposes Alarms and Events, again with
the ability to filter and acknowledge via any OPC UA compliant Client.
Alarm Shelving
Although not configured in the SCU, Alarm Shelving applies to all alarm destinations of an
iFIX Process Database Block alarm.
Essentially it is suppression of alarms for a preconfigured period of time. Operators may be
presented with nuisance alarms from sensors or machines which are not relevant at the time
determined by the operator.
Shelving an alarm is an HMI runtime action. The operator would select the active alarm, then
choose a Shelving option, e.g. for 1 minute, 10 minutes or 24 hours. The time options will
depend on a Shelving Policy which will have been configured and applied to individual
database blocks.
The alarm will then be hidden from view and will only reappear when the shelve period has
elapsed.
Shelving Polices can be added using the Database Manager application which we will look at
in the next chapter, however as with other Database Tag related tasks, this can also be
done ‘on the fly’ when modifying individual tags.
Shelving Policies have a name, description, maximum duration and a set of preset shelving
durations.
Figure 4-11. Alarm Shelving Policy Configuration
GFS-154K
Education Services
4-9
Proficy iFIX Fundamentals - Alarms
Troubleshooting Topic
Alarm Services have a finite number of Alarms they can contain at once. All Alarm Services
have a storage queue (a buffer) then a final destination. Think of the Print Service, it buffers
or queues alarms ready to pass to a printer and finally a piece of paper. It may take time for
the printer to accept the alarms for print and if in the meantime more and more alarms arrive
in the queue, it has the potential to overflow.
Queues therefore need to be large enough to accommodate the largest potential influx of
alarms at once. Alarm queues can individually be modified.
If an alarm queue from any Alarm Service overflows, an iFIX System Alert Message will be
issued.
Look to see which queues overflowed, return to the SCU and modify the queue sizes.
Figure 4-12. iFIX System Alert Message – Alarm Queue Overflow
A utility is supplied for Alarm Queue monitoring. Look for the Alarm Status (ALMSTAT.exe)
tool available in the course system System Info picture. Its Q option shows current queue
sizes and usage. Basically, no queues except the Alarm History, which is a rolling FIFO,
should have any LOST alarms.
Figure 4-13. Alarm Status – Q option
4-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Alarms
eBooks Topic
There is a theoretical unlimited number of Alarm Areas possible in an iFIX System.
Naming these Alarm Areas is simple enough, but sometimes a developer may find
themselves using the same name for both Alarm Areas and Process Database Tagnames.
Whilst this is acceptable, it will mask Alarm Counters for the Area. Runtime Alarm counters
will be discussed in a later chapter.
The actual names used by Alarm Areas can be plentiful but there are some rules.
Search the Online Help for “Alarm Area Name Syntax”. Look for this topic.
Take a read at this topic when you have time.
Figure 4-14. Online Help – Alarm Area Names
GFS-154K
Education Services
4-11
Proficy iFIX Fundamentals - Alarms
4-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Alarms
Lab Exercises – Alarm Services
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Create Alarm Areas and Common Formats.
 Enable Alarm Services with Alarm Area Filters.
 Apply Alarm Areas and Shelving Polices to individual tags.
When you are finished with these exercises, answer the Summary Questions at the end of
the module.
Introduction
At this stage we want to configure all the Alarm Services used to handle the alarm messages
for our example iFIX project. We will set the common formats for the Alarm Services to use
for displaying alarm messages, create Alarms Areas and then apply these Alarm Areas,
along with a Shelving Policy to iFIX Process Database Tags.
Lab Exercise #1 – Alarm Services
Part A – Configure Alarm Services and the Common Format
1. Open the SCU as done before, and from the Configure Menu select Alarms, or Use the Alarms
icon in the SCU toolbox.
2. Click the Advanced button. In the resulting dialog, click the Common Format button.
GFS-154K
Education Services
4-13
Proficy iFIX Fundamentals - Alarms
Notice the fields that can be added to the alarm messages. We will change the format of
the message slightly.
3. In the Column Order, use the arrows to move the Description field up so that it is after
Tagname.
4. In the Length fields, change Value to 10 and Description to 35.
Now, every Alarm service that uses the common message format will display alarms using
these rules.
5. Click OK (twice) to return to the main Alarms Configuration dialog.
6. One by one, highlight and ensure the following Alarm Services are enabled:
a.
b.
c.
d.
e.
Alarm Summary Service
Alarm File Service
Alarm History Service
Alarm Network Service
Disable any Alarm Printer and Alarm ODBC services, if already enabled
Your Alarm Services Configuration dialog box should resemble the one shown below.
By default, all Services will use the Common Format and the Common Alarm Areas.
7. Click OK. Then from the File menu click Save to save your SCU file.
4-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Alarms
Part B – Configure Alarm Areas
Unlike the other Alarm functions, the Alarm Areas Database (AAD) can only be edited when
iFIX is started.
iFIX should still be running from the previous lab exercises.
1. In the SCU from the Configure menu, select the Alarm Area Database, or from the SCU
Toolbox click the icon:
The Edit Alarm Area Database dialog is used to add, edit or delete Alarm Areas to the AAD,
one area at a time. By default, the AAD includes Areas labelled A through P.
There is no limit to the number of Areas you can add.
2. We will not be using any of the default A through to P Areas, therefore it will be advisable to
delete these A to P Alarms Areas. Highlight the A to P unwanted Areas and click the Delete
button.
3. Type the new Area into the Alarm Area field and then click the Add button.
One area at a time, add the following list of Areas. These area labels are not case-sensitive
(but they are spelling-sensitive!).
a.
b.
c.
d.
e.
f.
Blending
Energy
Granulation
Ingredients
Packaging
SystemInfo
The final list should look like this:
4. When finished, click OK to close the Alarm Area Database configuration.
5. Save your SCU file again. These Alarm Areas will be available immediately and do not require
an iFIX restart to take effect.
6. Close the SCU.
GFS-154K
Education Services
4-15
Proficy iFIX Fundamentals - Alarms
4-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Alarms
Lab Exercise #2 – Apply Alarm Areas and Shelving Polices
We will now apply these new Alarm Areas, along with a Shelving Policy to iFIX Process
Database Tags.
1. Open iFIX Workspace. This may still be open from an earlier iFIX startup. However, if it has
been closed, or for ease later on, add a Desktop Shortcut for Workspace. This will be very
useful later.
From the Windows Start – All Programs – iFIX – iFIX Workspace – (right click) – Send to – Desktop:
2. Double click this new iFIX Workspace shortcut. Workspace will open in Configure mode.
3. From the Workspace button, choose Open
(or Ctrl-O) and open the TankTemplate.grf
picture created in an earlier lab exercise.
Notice in the screenshot here this
TankTemplate is on the Recent documents list.
You could simply click on it in this list to open.
GFS-154K
Education Services
4-17
Proficy iFIX Fundamentals - Alarms
4. Double click on the Datalink for the InletPump. When it opens click the Modify Tag button at
the right side of the Source field.
5. The Tank1>InletPump Tag template will now open. Click on the Alarms tab, then double click
onto the Alarm Areas field which currently is set to ALL, then click the ellipses button.
4-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Alarms
6. Uncheck the Use “ALL” alarm areas box, then double click on the Ingredients Alarm Area to
add it to the Configured Areas column. Then click OK.
7. Back in the Tank1>InletPump template and its Alarm tab, tick the Enable Alarm Shelving
checkbox, then from its drop down list click <New>.
8. In the New Alarm Shelve Policy window, enter the values as shown and click the Add button to
add new Presets:
Policy Name: PRODUCTION; Description: Shelve Policy for Production Alarms; Maximum Duration 1
Hour; Preset1: 1 Minutes; Preset2: 5 Minutes; Preset3: 10 Minutes.
Then click the Save button.
GFS-154K
Education Services
4-19
Proficy iFIX Fundamentals - Alarms
9. Back in the Tank1>InletPump Tag template, click the Save button, then at the prompt to place
back OnScan click Yes.
10. Lastly click the OK button on the Datalink dialog box.
11. Repeat this process for the Tank1>OutletPump using its Datalink dialog box and it’s Modify
Tag button. This time however you only need to select the PRODUCTION Shelving Policy, not
create it.
Since you have just modified properties of iFIX Process Database Tags, to ensure these new
settings are not lost you will need to save the Process Database.
12. From the Workspace Applications Ribbon, in the Process Database section, click the Save
Database button.
4-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Alarms
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 4 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
GFS-154K
Education Services
4-21
Proficy iFIX Fundamentals - Alarms
Review Questions
1.
In your own words, why are Alarm Services important in a SCADA / HMI system?
2. What are Alarm Areas?
3. Name three Alarm Services.
4. Where are Alarm Areas stored? Do SCADA servers and Clients need to use the same
Alarm Areas?
5. Which Alarm service sends alarm messages to operator displays?
Electronic Books Research
6. Which three characters cannot be used in an alarm area?
4-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Alarms
Review
Now that you have completed this module, you should be able to:
 Create Alarm Areas and common formats.
 Enable Alarm Services
 Understand Alarm Shelving
GFS-154K
Education Services
4-23
Proficy iFIX Fundamentals - Alarms
4-24
Education Services
GFS-154K
0)
05
PROCESS DATABASE THICK CLIENT CONFIGURATION
a
At the end of this module, you will be able to:
 Compare primary and secondary database tags
 Describe the commonly used tag types
 Discuss the Database Manager
 Utilize Database Manager tools
 Configure Alarm Shelving Policies
 Work with Analog Tags
 Describe the Analog Alarm (AA) tag
 Define Register tags
25%
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
5-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Process
Database
Database Overview
The Process Database (PDB) is the central repository for real-time SCADA data and
information. It is comprised of tags (or blocks) that are linked to I/O addresses to facilitate
visualization and management of plant floor data. Tags can also be linked to each other to
form chains where more complex actions can be performed in specific sequences. Every
tag has fields to describe it, from its name and description to alarm limits and security
restrictions.
The Database Manager is the thick client application used to develop and administer tag
databases.
Figure 5-1. The Database Manager
GFS-154K
Education Services
5-3
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Database Tags
Tags are the basic units of the Process Database. They can read, write, calculate, and
manipulate data, even performing basic logic execution if required. Tags come in a variety
of types, with each tag type specializing in specific duties.
Primary and Secondary Tags
Primary tags are generally associated with values from a Driver. These tags are tasked with
sending and receiving data to and from I/O Addresses based on a scan time. Primary tags
can be linked to other tags, or they can be stand-alone tags.
Typical primary tag examples are the Analog Input and Digital Input tags.
Secondary tags receive and send their data to and from other tags, not from the Driver.
They have no scan time and cannot be stand-alone blocks. Secondary tags typically
perform calculations, timing and logic with data retrieved by primary tags. The Calculation
and Totalizer tags are examples of secondary tags.
Tag Chains
Tags can be linked together to form tag chains. These chains of tags pass values to one
another in series, performing special actions at each transfer. There are some basic rules
governing chains:
 Since the data must come from somewhere, the tag chain must start with a Primary tag
(though additional primary tags can also appear in the middle or end of a chain). This
Primary tag will receive its values from the Driver, an operator input or possibly a script. A
Secondary tag cannot start a chain.
 Tags can be members of only one chain at a time.
 All tags in the chain inherit the scan time of the Primary tag at the start of the chain. The
entire chain will be evaluated based on this scan time.
 All tags will receive their data from the tag preceding it in the chain and in most cases will
pass the result of their actions to the tag following it. Some tags are known as Pass Through
where the value of the previous tag is passed on to the next tag unchanged.
From the
Driver
Analog Input
Primary Tag
I/O Address
And Scan Time
Calculation
Secondary
Tag
Sends calc to
Totalizer
Secondary
Tag
Totals calc
From the
Driver
Analog Input
Primary Tag
I/O Address
And Scan Time
Calculation
Secondary
Tag
Sends calc to
Analog Output
Primary Tag
I/O Address
No Scan Time
To the Driver
Figure 5-2. Tag Chain Examples - Read-only (top) and Read-Write (bottom)
5-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Commonly Used Tag Types
Analog Inputs and Outputs (AI / AO)
As Primary tags, Analog Inputs retrieve values from the Driver, whereas Analog Outputs
send values to the Driver. Analog tags specialize in handling numbers with a continuous
range of values that are framed by an upper and lower limit (such as integers and real
numbers).
Digital Inputs and Outputs (DI / DO)
Like their analog counterparts, Digital Inputs retrieve values from the Driver and Digital
Outputs send values to the Driver. Digital tags specialize in handling values with only two
states (0 or 1).
Analog and Digital Registers (AR / DR)
These two tag types retrieve analog or digital data respectively from the Driver using an I/O
address. They can also write values to the Driver. This special tag has no scan time,
instead is updated when an HMI animation requests an update. They cannot be used in a
chain. There are no alarming capabilities. Allows animation objects to bypass SAC and PDB
to display values directly from the Driver. They can map up to 1024 values from the Driver in
a single Register tag.
Calculation (CA)
A valuable secondary tag, the Calculation block can use up to eight inputs (from tags or
constants) to execute mathematical expressions. For equations using more than eight
inputs, extra Calculation blocks may be chained together, with results passed from block to
block as new inputs.
Event Action (EV)
Performs limited tests and logic operations using IF-THEN-ELSE logic.
Program Tags (PG)
Program tags are neither Primary nor Secondary tags - they are known as Batch Blocks.
These stand-alone blocks can execute simple 20 line programs to assist with internal
database actions and logic.
Timer (TM)
Counts time up or down based on the value being passed to it by upstream tags.
Totalizer (TT)
Maintains totals based on the values passed to it from upstream tags.
Extended Trend (ETR)
Able to buffer up to 600 values in a FIFO cache. These values can be used to pre-populate
a real-time trend when it opens.
GFS-154K
Education Services
5-5
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
iFIX Tag Summary
Name
Type
Description
Analog Input (AI)
Primary
Retrieves analog data from Driver using an I/O address
and scan time. Alarms can be generated from this tag.
Can also write values to the Driver.
Analog Alarm (AA)
Primary
Retrieves data from Driver using an I/O address. Very
similar to the Analog Input, with enhanced alarming
capabilities.
Analog Output (AO)
Primary
Sends analog data to Driver using an I/O address.
There is no alarm detection capability with this tag.
Analog Register (AR)
Special
Retrieves analog data from Driver using an I/O address.
Can also write values to the Driver. This special tag has
no scan time (it inherits the I/O driver poll time) and
cannot be used in a chain. There are no alarming
capabilities. Allows animation objects to bypass SAC
and PDB to display values directly from the Driver.
Boolean (BL)
Primary
This block performs calculations using up to eight
inputs that result in a true or false evaluation. The
output from this tag is either 0 (False) or 1 (True).
Calculation (CA)
Secondary
Uses up to eight inputs (from tags or constants) to
execute mathematical expressions. For equations using
more than eight inputs, extra Calculation blocks may be
chained together, with results passed from block to block
as new inputs.
Dead Time (DT)
Secondary
Provides a way to incorporate a pause or delay in the
transmission of values to tags downstream in the chain.
Device Control (DC)
Primary
Can monitor up to 16 Digital input addresses and output
to a maximum of eight I/O addresses. This block is
typically used to control devices with multiple
dependent digital conditions.
Digital Input (DI)
Primary
Retrieves digital data from Driver using an I/O address
and scan time. Alarms can be generated from this tag.
Can also write values to the Driver.
Digital Alarm (DA)
Primary
Retrieves data from Driver using an I/O address. Very
similar to the Digital Input, with enhanced alarming
capabilities.
Digital Output (DO)
Primary
Sends digital data to Driver using an I/O address. There
is no alarm detection capability with this tag.
Digital Register (DR)
Special
Retrieves digital data from Driver using an I/O address.
Can also write values to the Driver. This special tag has
no scan time (it inherits the I/O driver poll time) and
cannot be used in a chain. There are no alarming
capabilities. Allows animation objects to bypass SAC
and PDB to display values directly from the Driver.
Event Action (EV)
Secondary
Performs limited tests and logic operations using IFTHEN-ELSE logic.
Extended Trend (ETR)
Secondary
Able to buffer up to 600 values in a FIFO cache. These
values can be used to pre-populate a real-time trend
when it opens.
5-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Fanout (FN)
Secondary
Passes the value it receives to up to four additional tag
fields. This is a simple way split a chain or to send
values to more than one chain.
Histogram (HS)
Secondary
Records how frequently a value occurs and can be
displayed in a Histogram chart (FIX32 or FIX Desktop
only) in a display.
Lead Lag (LL)
Secondary
Allows simulation of process dynamics by combining
the advantages of lead and lag compensation
strategies.
Multistate Digital Input
(MDI)
Primary
Allows the distillation to a single output (0-7) from the
combination of multiple (maximum of three) digital input
states. Each of the eight result states can be labelled.
On-Off Control (BB)
Secondary
Uses analog values along with upper and lower
thresholds to write digital values to downstream blocks
(such as DO).
Pareto
Primary
Accepts up to eight inputs, calculates percentages and
then provides the output to a Bar chart (FIX32 or FIX
Desktop only).
PID (PID)
Secondary
The PID block maintains balance in a closed loop by
changing the controlled variable (an analog output) in
response to deviations from a user-defined set point.
Program
Batch
Executes simple 20 line programs to assist with internal
database actions and logic.
Ramp (RM)
Primary
Decreases or increases a target output value using up
to three stages for ramping values. Each ramp stage
lets you specify a target value and a ramp rate.
Ratio/Bias (RB)
Secondary
The Ratio Bias block lets you change an incoming signal
by adding a constant (bias) and/or by multiplying by a
constant (ratio).
Signal Select (SS)
Secondary
Samples up to six inputs, manipulates the inputs
according to a user-selected mode, and sends the
result to the next block.
SQL Data (SQD)
Secondary
Transfer data between PDB tags and relational
database tables.
SQL Trigger (SQT)
Primary
This tag can trigger a relational database read or write
(SELECT, INSERT, UPDATE, DELETE) based upon
events or time.
Text (TX)
Primary
Retrieves text data from Driver using an I/O address
and scan time. Alarms can be generated from this tag.
Can also write values to the Driver.
Timer (TM)
Secondary
Counts time up or down based on the value being
passed to it by upstream tags.
Totalizer (TT)
Secondary
Maintains totals based on the values passed to it from
upstream tags.
Trend (TR)
Secondary
Able to buffer up to 80 values in a FIFO cache. These
values can be used to pre-populate a real-time trend
when it opens.
Table 5-1. iFIX tags
GFS-154K
Education Services
5-7
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Database Manager
The Database Manager a thick client tool used for creating, editing and monitoring the
Process Database. The spreadsheet interface is simply a view into a PDB. The user has a
high level of control over what is displayed.
Database Button
New creates a fresh database using the read-only EMPTY.PDB file. A new database file
name will be prompted.
Close does not shut down SAC or the PDB, it simply ends the current session with the PDB
and clears the view in Database Manager. If any were made a prompt to save changes will
appear.
The Database Manager is a client tool that allows development of PDB files on remote
nodes, as well as the local PDB. There are two ways to view and access PDBs around the
network: “Open” and “Reload”. “Open” and “Reload” are very similar in appearance but
result in quite different actions being taken.
The Open command results in a dialog box listing the SCADA servers as listed in the SCU
network configuration. A green icon next to the node name indicates a good connection, a
red icon indicates a bad connection. By choosing a node, the Database Manager will “Open”
a development session with the node, using the currently active PDB.
The Save command Saves the current loaded PDB to the \PDB path. SaveAs will prompt for
a new name.
Figure 5-3. Database Button tools
5-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Home Ribbon Tools
Figure 5-4. Home Ribbon Tools
The Clipboard Tools provide commonly used commands such as Cut, Copy and Paste.
The Reload button results in a dialog box listing the available SCADA servers. It also shows
a list of all the PDB files in the SCADA’s PDB directory. By selecting a PDB from this list, the
user is indicating that they would like to either change the PDB that SAC is operating on, or
that they would like SAC to restart the PDB using the default start up settings. Obviously,
changing the PDB on-the-fly can disturb all attached clients who require data from its tags,
so reloading is not recommended for stable operational environments but instead for
isolated nodes where development, testing and simulation are required.
The Create New button starts a new fresh empty database with no Tags.
The Import and Export buttons access valuable tools to help rapidly develop an application.
It can often be easier and quicker to build tag and field lists in a simple CSV file. In these
situations, the Export feature will create a CSV file with the fields for each tag type (AI, DI,
CA, etc.) in columns and the visible tags in rows. This exported information is very helpful to
use as a template for quick addition of new tags. Using MS Excel as a CSV editor will grant
the developer access to useful Copy, Fill, and Find and Replace tools that can create and
modify tag fields very quickly.
The Import feature will temporarily pause SAC and build all the tags from the CSV file. The
tag creation is very quick and, when completed, SAC will restart the PDB.
Figure 5-5. Sample CSV file for PDB Import
GFS-154K
Education Services
5-9
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Alarm Shelving Policies helps manage the options available to operators in run mode when
choosing to shelve alarms. The iFIX Shelve Policies button will open the Alarm Shelve
Policies dialog box. From here, up to 20 alarm shelving policies can be configured, which will
subsequently allow operators to shelve (or suppress) alarms for the defined period of time.
The Blocks tools provide buttons for working with tags. The Show selection opens a tag for
viewing only, leaving it on-scan. The Modify button will open the tag for editing. Any tag is
taken off-scan while it is being edited.
The Generate button can quickly create multiple tags with sequential numbers in their
various fields (such as tag name, description, I/O address, etc).
Verify is a helpful development troubleshooting tool. It will enumerate all the tags in the
PDB and ensure that there are no errors in their configuration. It can detect missing or
empty fields in tags, orphaned secondary blocks, illegal chains, and missing or illegal tags in
dependent blocks (such as the Calculation block).
Summary will provide the user with a quick report showing how many tags are in the PDB,
how many of them count as I/O against the license (Primary tags only), as well as a
Database Serial Number. The Database Serial number is very helpful to developers in
maintaining PDB version control.
The Drivers button will display links to the currently available I/O Drivers. If listed here, the
Drivers have been created and are ready for use with PDB tags.
The Help button provides iFIX assistance (with the local eBooks) or specific help for
Database Manager, block types and fields (with Help topics).
The Tools button provides a launch link for the Historian Administrator, and via the
Customize Tools selection the ability to add other shortcuts to external applications.
5-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
View Ribbon Tools
Figure 5-6. View Ribbon Tools
Freeze Columns allows the user to anchor a column or columns in order to maintain column
visibility while using the scroll bars.
The Re-sort button will perform a resort based on the current saved sort order.
The Refresh button and its key accelerator (CTRL-R) are very useful for updating the
Database Manager fields with the latest field information, particularly for fields like Scan
Status, Current Value and Current Alarm.
The Pause button will stop the auto spreadsheet refresh if enabled.
The Status Bar checkbox enables or disables the Status Bar, where useful settings
information can be shown like the current Refresh / Display / Sort / Query / Column.
The Properties button will launch a separate dialog box that will help the user tailor the
Database Manager to their personal preferences and to isolate only the tags and fields they
need to see at any given moment.
Figure 5-7. Database Manager View Properties
GFS-154K
Education Services
5-11
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
The Options button will launch a separate dialog box which has a number of convenient
user preferences that can be changed to suit a user’s needs.
The Enable Spreadsheet Auto Refresh option is helpful when troubleshooting values,
alarms and chain execution, but it does consume extra PC resources.
Automatically Put Block on Scan after Modify is helpful for returning a block to its normal
scan status after it has been edited.
Display in Modify mode ensures that double-clicking a tag in the Database Manager opens
the tag for editing (taking it off scan), whereas Display in Show will open the tag for readonly review (and leave it on scan).
Figure 5-8. Database Manager View Properties
5-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Analog Tags
The Analog tags are most frequently used to work with ranges of values between upper and
lower measurement limits. Commonly, these are measured variables such as pressure,
volume, temperature, pH, counters and speeds. As such, these tags are closely tied to plant
floor instrumentation and less to the status values of two-state equipment.
There are three main analog tags: The Analog Input, the Analog Alarm and the Analog
Output. There is also a special tag called an Analog Register that is popular for situations
where alarms, trending and tag chains are not required.
Tags can be added in several different ways. From the Database Manager, a tag can be
added by double-clicking on an empty cell, by clicking the Add button from the Blocks Tools
in the Home Ribbon.
Tags can also be added while building displays in the Workspace by using the Add Database
Block button from the Applications Ribbon.
The following dialog box will prompt the user to choose from the complete list of available
blocks.
Figure 5-9. Add Database Blocks
Figure 5-10. Choosing Database Blocks
GFS-154K
Education Services
5-13
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Analog Input (AI) Tags
The Analog Input tag specializes in retrieving analog values from the Driver. It provides the
current value to animations in displays, historian tags, reports, and other chained tags. The
AI tag also supports simple alarming and can write to the same address it reads. To provide
inputs and outputs to the same I/O address, the address must support both reads and
writes.
Figure 5-11. Analog Input tag (Basic tab)
Basic Tab Fields
The Basic tab is where the basic tag information is configured.
Tag Name: This is a 256 character alphanumeric name that will be used to identify the tag
in all data source links. The name may start with a number but cannot contain spaces.
Underscore characters (“_”) are commonly used in place of spaces. (Field: A_TAG).
Description: This is a 256 character alphanumeric description that is usually a little
friendlier to users as it can use all characters, including spaces. It will appear in alarm
messages, chart legends and potentially screens and reports. (Field: A_DESC).
Next: The name of the next tag in the chain is entered here. Using the up arrow will move
forward to the configuration of the next block in the chain.
A list of existing tags can be browsed by using the ellipsis button.
5-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Engineering Units
The AI tag must provide a range of values between an upper and lower limit. The
Engineering Units allows the user to prescribe the Low Limit and High Limit for the data to
fifteen significant digits (i.e. any combination of whole or decimal digits totaling fifteen).
Scientific notation is also supported.
The Units field will hold the Engineering Unit (A_EGUDESC) description of up to 33
characters. This information can be used in charts and Alarm Summary tables.
Configuring I/O Addresses
There are two main fields to complete when linking a database block to a Driver address.
Driver: this refers to the selected Driver. This list will contain the drivers configured in the
SCADA section of the SCU. Choose the appropriate Driver from the drop-down list. (Field:
A_IODV).
I/O Address: this is a link to access the source value in the Driver’s configuration.
For IGS and OPC Drivers this is browsable, for v7.x Drivers the I/O Address must be known
and entered manually. (Field: A_IOAD)
For the IGS Driver this is made up of:
Channel.Device.StaticTags. e.g. ModbusTCP.InstructorsPLC.AmbTemp
OR
Channel.Device.<DynamicTagAddress>. E.g. ModbusTCP.InstructorsPLC.400100
For a v7.x Driver this is made up of:
Device:Word e.g. InstructorPLC:400100
The Channel and Device names must match the information in the driver configuration.
Analog addresses typically require a word, register address, or if from a supported hardware
device, a symbolic address from the PLC.
This may vary depending on the Driver or protocol used. (Field: A_I/OAD).
Signal Conditioning
This is a function of the I/O Driver which provides special algorithms and non-linear scaling
to help iFIX perform a conversion of instrumentation signals into integer numbers and then
scaling the result to fit a range of engineering units. Most modern Control devices already
scale values at source.
Linear Scaling
This allows the user to specify linear scaling to the values coming from the Driver. It allows
the block to take raw values from the Driver and apply a linear scaling algorithm to present
the data in a meaningful range for the operator or HMI user.
Raw Low is the lower limit of the incoming values from the Driver.
Raw High is the upper limit of the incoming values from the Driver.
Scale Low is the desired Lower limit that matches our measurement units (or EGU limits).
Scale High is the desired Upper limit that matches our measurement units (or EGU limits).
Use EGU, when enabled, indicates that the EGU settings should be used as the upper and
lower range of the scaled values.
GFS-154K
Education Services
5-15
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Scan times
Primary tags like the AI can use a variety of scan times to control the frequency with which
they perform their duties.
Time Based: this allows the tag to process values based on a defined time period, be it
measured in sub-second intervals, seconds, minutes or hours. (Examples: 0.5 = ½ second,
3 = 3 seconds, 1M = 1 minute, 2H = 2 hours).
Exception Based (v7.x Drivers only): the tag will update only when a significant change
occurs in the value. Input tags rely on the I/O Driver (through the Datablock deadband
setting) to flag when a change has occurred. In addition to the available checkbox, the
letter “E” will signal Exception-based scans.
One Shot: the tag scans the value only once, and then the tag is turned off-scan. It will
only scan again when the tag is manually placed back on-scan. To designate a one-shot
scan time, use a zero (0) in the scan time field.
Note
Phasing allows the developer to offset the collection of tags using the same scan
time. The scan period remains the same, but the time at which tags are scanned is
staggered.
Alarms Tab
Alarm Areas and Priorities are assigned here. Alarm conditions are based on thresholds
values within a Dead Band margin.
Figure 5-12. Analog Input tag (Alarms tab)
5-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Alarm Limits
With Analog values, alarm detection requires a series of thresholds to define alarm
conditions.
 Low Low and High High alarms are more severe than Low and High alarms. As such, a Low
Low or High High alarm will replace existing Low or High alarms in the Alarm Summary table,
regardless of the order in which they occurred. These four thresholds are the main alarm
limits.
 The tag will alarm when its value changes by more than the Rate of Change between
successive scans.
 DeadBand affects when a value can re-alarm after an initial alarm. The value must deviate
from the threshold by this minimum amount before the tag can re-alarm.
Alarm Shelving
If alarm shelving is enabled, alarms can be temporarily suppressed from the active alarms
list in the Alarm Summary object for a fixed period of time. Tags can be assigned to a
specific Shelving Policy as configured in Database Manager.
Shelving helps improve the display of alarm information on screen and assists operators
with prioritization so they can focus on only the highest priority alarms on screen at any
point in time. Alarm shelving is particularly useful if there are lots of alarms for an operator to
sort through.
Advanced Tab
The Advanced Tab provides configuration settings for security access to the tag and set
point changes, in addition to alarm text fields and other fields specific to this type of tag.
Figure 5-13. The Advanced Tab
GFS-154K
Education Services
5-17
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
A selection of these Advanced Options are:
Alarm Extension Fields: these are 80-character text fields that can be used to add more
information to alarm messages and may be alphanumeric with no character restrictions.
Security Areas: these will be dealt with in subsequent modules.
Enable Output: allows this tag to write values back to the Driver source using the same I/O
Address, if supported by the Driver.
Smoothing uses a weighted average of values from the previous scan and the current scan
with a weighting factor and the following equation:
Output = (n /16) X (previous value) + (16-n / 16) x (current value)
n is the relative weighting as represented in the Value field.
Startup Mode: If Auto mode, forces the tag to use the scan settings and I/O Address
information in the I/O Addressing section to govern data retrieval from a Driver. If Manual
mode, it disconnects the tag from automatic Driver updates allowing manual interaction.
Historian Tab
iFIX Tags provide developers with a built-in interface to assign sampling and archiving
settings for Proficy Historian. This provides a one-step configuration without any need for
duplicate effort in Proficy Historian.
Use of these configuration fields is most useful when combined with a PDB Import from
CSV.
Tip
With all Process Database tags when viewed in Database Manager or via the Modify
feature in Workspace, the F1 standard Help keystroke will open context help for any
selected field.
Equally ‘picking up’ by clicking the question icon in the tag titlebar
‘dropping’ onto a field will also open its context help.
5-18
Education Services
and then
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Analog Alarm (AA) Tags
The Analog Alarm tag is essentially the same tag as the Analog Input tag, except that it has
enhanced alarm capabilities.
The Basic and Advanced tabs are identical to the AI, so we will focus on the alarm
enhancements found on the Alarms Tab.
Alarms Tab
The Analog Alarm tag shares certain alarm qualities with the Analog Input tag, such as Alarm
Area designation, alarm priorities and the thresholds for alarms detection. There are some
additional fields that can be used to add intelligence to the way alarms are handled.
Figure 5-14. Analog Alarm Tag - Alarm Tab
The Target Value and DEV (deviation) fields will define a desirable condition (such as an
optimum level) and detect significant departures from this condition.
The ROC field stands for Rate of Change and detects the increase or decrease between
successive scans. Should the change exceed this value, the condition will trigger an alarm.
Suppress COMM Alarm is also very useful when communication failures occur between the
SCADA and the PLC, but no alert is required for the process represented by this AA tag.
GFS-154K
Education Services
5-19
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Analog Output (AO) Tags
The Analog Output tag resembles the Analog Input and Analog Alarm tags, except that it is
used exclusively for writing values to the Driver.
Basic Tab Fields
Figure 5-15. Analog Output Tag
There is no Scan Time to specify as it will be processed by SAC as soon as a new value is
written to it. The AO tag will then write a new set point to the Driver on the very next SAC
cycle (1/20th of a second). Note that when AO tags start a chain, the chain will only be
executed when there is a set point change to process for the AO tag.
5-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Alarms Tab
AO tags can generate Event Messages but cannot generate alarms. Since event messages
report to most Alarm Services (except the Alarm Summary) they must be labeled with Alarm
Areas.
Advanced Tab
AO tags support Alarm Extensions and Security fields. They can also restrict the operator
set point ranges and rate of change.
Figure 5-16. Analog Output Tag - Advanced Tab
GFS-154K
Education Services
5-21
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Register Tags
Register tags, both Analog and Digital, are popular for situations where alarms and tag
chains are not required. They can still be collected historically.
Like AI tags they have read and write capabilities. They are not processed by the SAC task
therefore cannot use the Alarm sub-system and do not issue Alarms, however when used as
outputs Operator Messages are issued to configured alarm destinations. The Alarms tab
only shows assigned Alarm Areas for the block.
AR (and DR) tags have a privileged direct access to the addresses in IGS Static Tags,
Datablocks or Poll Records configured within v7.x Drivers. As such, no scan time needs to
be specified; the values are updated based on the poll time of the target poll record and
then only when a display requests the data. Register tags will be dormant if there are no
displays requesting data from them. This is a very streamlined way to provide simple data
to displays, as SAC and the PDB are not involved.
Addressing
One other benefit is the ability to reference data from an entire contiguous register using a
single Register Tag. All referenced addresses will inherit the fields associated with the
Register tags, things like descriptions, labels and engineering units must be generic enough
to be shared amongst the entire range of addresses. Current values are referenced in
displays using offset addressing.
An example is provided below:
The IGS Driver has a MODBUS TCP Channel configured with a Device and a single Static
Tag referencing address 400100.
If an Analog Register tag is created, named SETPOINTS_ARRAY, it uses the following
starting address in its I/O Address field:
ModBusTCP.InstructorPLC.400100[32]
The Element factor in square brackets [32] dictates the element accessible on this register.
This depends on the protocol and data type accessed. Refer to the Driver Help for further
information.
Normally, an animated object such as a datalink on a display would link to the tag using the
four-part data source syntax using SERVER.NODE.TAG.FIELD, as in the following example:
FIX32.THISNODE.SETPOINTS_ARRAY.F_CV
Here the F_CV is the current value field, but only for the addressed register (400100). To
use the offset functionality and display values from other addresses without creating other
tags, the user will use a F_# field, where # is the offset from the starting address. For
example:
Address 400100 FIX32.THISNODE. SETPOINTS_ARRAY.F_0.
Address 400101 FIX32.THISNODE. SETPOINTS_ARRAY.F_1.
Address 400110 FIX32.THISNODE. SETPOINTS_ARRAY.F_10.
5-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Figure 5-17. Analog Register Tag
Summary
A significant reduction in maintenance effort can result from using register tags in this
manner. One tag can represent an entire contiguous register, as opposed to a single
address from the source I/O Address.
Resource intensive applications also see performance benefits, as values will only be
retrieved from the v7.x Driver, or the IGS Driver when a display with links to the register tags
is open and activated.
GFS-154K
Education Services
5-23
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Troubleshooting Topic
We have discussed in this chapter the tools contained in Database Manager.
Some tools exist here for troubleshooting and analysis purposes.
Database Verify
Figure 5-18. Home Ribbon - Verify
This Verify Tool is designed to check tag chains in the Process Database. If tags are chained
together, but one of these tags, e.g. a Calculation tag makes reference to a tag which does
not yet exist, the whole chain will be off scan. An error in one tag therefore has
consequences beyond itself.
Verify will report any referenced tags which do not exist. It also has an Edit button to quickly
modify the offending block.
Figure 5-19. Verify Results
Once any errors have been rectified, Re-Verify will re-run the checks and if all have cleared,
the ideal “No errors detected” prompt will appear.
Figure 5-20. Verify – No errors detected
5-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
eBooks Topic
The Program Block (PG). There are vastly more powerful programming tools available to a
developer, be it the Controller device such as a PLC, or VBA in Workspace and Schedules or
calling external Python scripts, REST APIs or functions in DLLs or APIs.
However, there is a place for the mature PG block.
If the source being tested and the action destination are both within the Process Database,
then if the PG block is capable of the function, then why take the function external.
Search the Online Help for “Program Block”. Look for this Program Block topic and take a
read when you have time.
Figure 5-21. Online Help – Program Block
GFS-154K
Education Services
5-25
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
5-26
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Lab Exercises – Process Database – Thick Client
Configuration
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Explore the Process Database Manager tools
 Configure Database Manager Columns and Appearance.
 Create Shelving Policies.
 Add Primary tags – Analog values from the IGS Driver.
 Add Secondary tags – Calculations and Trends
 Import tags into the Process Database from a CSV file.
Introduction
We have successfully established communications to our control devices on the Plant Floor
and our I/O Drivers are making data available. We will change the appearance of the
Database Manager to help us with development and add additional Shelving Policies. The
next task is to rapidly create a set of database tags to get the PDB started. We will create
Analog tags to read and write values to the I/O Driver and process hardware, along with
Calculation and Trend tags. We will then import a CSV file with pre-populated tag
information to create additional tags for our course system. the tags.
Lab Exercise #1 – Database Manager
Part A – Database Manager Tools
1. Make sure iFIX is running and Workspace is open.
From the Applications Ribbon, click to open Database Manager
It is also on the System Tree.
2. When prompted, Open Local Node…
GFS-154K
Education Services
5-27
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
You should see the 3 tags added earlier for the TankTemplate picture and the 2 tags added
using the Modbus simulation from the instructors PLC.
3. Firstly, we will change the appearance of the Database Manager to suit our needs. We will start
by adding additional fields. From the Home Ribbon, click Properties.
4. To assign additional fields to columns click on the Columns Tab.
5. Scroll down the Available Columns list until you locate and highlight the Scan Stat field.
Click the Add button. While you are here, scroll further down and add the Alarm Area 1 field.
6. Click the Apply button. You should see that the columns have been added to the Database
Manager (still seen behind this window). If you need to resize columns, the Display Width field in
the Columns tab can be changed. You can also click and drag column widths in the Database
Manager.
7. Click the Font tab. Choose a Font to use in the Database Manager that will make things easier to
read. For example, 12 point Regular GE Inspira Sans. Click Apply to test the font.
8. When satisfied, click OK.
5-28
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
9. We will change some of the defaults for the Database Manager.
From the Home Ribbon , click Options. Be sure to configure at least the following:
a.
b.
c.
d.
Save Settings on Exit: checked
Enable Spreadsheet Auto Refresh: checked
Display in MODIFY Mode: selected
Click OK when done
10. Highlight any one of the tags in the list, e.g. TANK1>LEVEL. Hold in the Ctrl key on your
keyboard and whilst Ctrl is pressed, double click on this highlighted tag.
The tag template will open, however notice that the Save button is greyed out. By holding in
the Ctrl key, double click has opened the tag in a Show mode. You cannot modify any
properties, and importantly the tag is not off scan. When the Display in SHOW Mode (RO) is
selected in Options, double clicking a tag will open it in this Show mode only, holding in Ctrl
when double clicking will open it in Modify mode.
11. Click the Cancel button. Note that no prompt appears to place the tag back On Scan, since it
was not off scan.
12. From the Home ribbon, click the Save button.
GFS-154K
Education Services
5-29
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Part B – Create Shelving Policies.
In this exercise we will create additional Shelving Policies for our course system and assign
three different shelving preset levels.
1. In Database Manager, find and click in the Home Ribbon the Shelve Policies button.
2. In the Alarm Shelve Policies configuration, observe that the PRODUCTION Policy created ‘on the
fly’ already exists. Click the New button to add a new policy.
3. In the New Alarm Shelve Policy dialog configure as follows:
a.
b.
c.
d.
Policy Name: ENERGY
Description: Shelving Policy for Energy Center Alarms
Maximum Duration: 1 Hours
In the Preset section, click the Add button 3 times then modify to configure the
presets as:
e. Level1 – 1 Minutes – Default
f. Level2 – 5 Minutes
g. Level3 – 10 Minutes
5-30
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
4. Click the Save button to confirm the new policy.
5. Repeat to add a third Shelve Policy. Use the same settings but for the policy:
a. Policy Name: PACKAGING
b. Description: Shelving Policy for Packaging Area
6. Once the three policies are listed, click the X to close the Alarms Shelve Policies configuration
screen.
7. In Database Manager on the Home Ribbon, as before, click the Save button in the Process
Database section.
8. Next, click the Reload button to the right of the Save button.
9. At the Reload prompt, ensure that the file database is highlighted, then click the Reload button.
Saving, Opening, and Closing a database has no immediate effect on the running SCADA
Process Database, SAC is still processing all primary and secondary tags, all clients
currently viewing data from the tags will see no effect.
However, Reloading a database has a dramatic effect. It is the same as restarting iFIX as far
as the Process Database is concerned. All tags will be reset to their startup values. Clients
currently viewing data from the tags will have no values until the reload has completed, they
may see errors depending upon how Workspace and Animation defaults have been
configured.
GFS-154K
Education Services
5-31
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
5-32
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Lab Exercise #2 – Add Analog Tags
Part A – Add Analog Input
Introduction
We are ready to create Analog tags to read and write values to the I/O Driver and process
hardware using Database Manager, our thick client solution. We will begin by focusing on
consumption information from the Energy Center adding tags to show current power
demands and a calculation to determine its Carbon Footprint.
1. Ensure iFIX is running, and that Database Manager is open.
2. From the Home ribbon in Database Manager, click the Add button in the Blocks section.
3. The Database manager will prompt you to
choose a block type.
Choose Analog Input.
Then click OK.
4. We will start with the total power demand placed on the Energy Center by the plant. Enter the
following information into the fields on the Basic tab. We will also create a chained Calculation
block for this tag.
a.
b.
c.
d.
e.
Tag Name: PLANTKWH
Description: Live Plant Power Consumption
Driver: choose IGS
I/O Address: click the Browse button
When the browse window opens select the
EnergyPlant - EnergyPLC as the device and
CurrentPowerDemand as the Item.
Then click OK.
f. Scan Time: 10
g. Low Limit: 0
h. High Limit: 1000
i. Units: kWh
GFS-154K
Education Services
5-33
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
The Basic tab of this new tag should look like this:
5. Move to the Alarms tab and double click on the ALL label in Alarm Areas.
6. Next, click the ellipses button to open the Configure Alarm Areas window.
7. Untick the Use “ALL” alarm areas checkbox, then double click Energy in the Available Areas list
to add it to the Configured Areas list.
8. Click OK to close the Configure Alarm Areas window.
5-34
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
9. Make these additional changes in the Alarm tab of this new PLANTKWH tag:
a.
b.
c.
d.
e.
Alarms High: 800
Alarms High High: 950
Alarms Deadband: 3
Enable Alarm Shelving: checked
Shelve Policy: choose ENERGY
10. Return to the Basic tab and in the Next field type in ENERGYTREND then click the up arrow.
11. You will be prompted that the tag does not exists, this is as expected since you have not yet
created it.
Click the Yes button.
GFS-154K
Education Services
5-35
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
12. From the list of available tag types, highlight the ETR Extended Trend Block type then click OK.
13. The new Extended Trend tag ENERGYTREND will open ready to configure. Make the following
changes to its fields:
a.
b.
c.
d.
e.
f.
g.
Description: Plant Recent Energy Usage
Clear Buffers on Startup: Unchecked
Low Limit: 0
High Limit: 1000
Units: kWh
Next : (type in) CARBONKWH
Click the up arrow to the right of the Next field.
14. When prompted that this new CARBONKWH tag does not exist, click Yes to add the block now.
5-36
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
15. When asked which type of block to select, choose the CA Calculation then click OK.
16. The new Calculation tag will appear. Configure its fields as detailed below:
a.
b.
c.
d.
e.
f.
g.
Description: Live Carbon Footprint at current consumption rate
Inputs B: 0.23314
Inputs C: 1000
Output Calculation: ((A*B)/C)
Low Limit: 0.0000
High Limit: 0.5000
Units: tCO2e
17. Next, click the Add button and at the prompt to place the tags (and chain) On Scan click Yes.
18. Lastly, Save and Reload the Process Database once again.
GFS-154K
Education Services
5-37
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
(Optional) Part B – Analog Output and Register Tags
1. Right click inside the Process Database and
choose Add Block.
2. From the list of block types, choose the AO –
Analog Output type. Then click OK.
3. Configure this new AO tag as follows:
a.
b.
c.
d.
e.
f.
g.
h.
5-38
Tag Name: TANK1>INLETRATE
Description: Tank1 Inlet Rate
Driver: SIM
I/O Address: RY
Low Limit: 0
High Limit: 3,600
Units: LPM
Initial Value: 600
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
4. Move to the Advanced tab, and in the Operator Limits section set:
a. Low Value: 10
b. High Value: 3000
c. Rate Limit: 100
5. Now click the Save button to Save this new tag.
Notice you did not get a prompt to place On Scan, this is an Output tag and does not have a Scan
Status, it is processed by SAC when it changes.
6. Next, Add another new tag. You have seen a number of ways to add a new tag so far, so pick
one. When the select a block type window appears, choose the AR – Analog Register and click
OK.
7. Set up this new AR tag with the following settings:
a. Tag Name: SETPOINTS_ARRAY
b. Description: Array of Setpoint values
c. Driver: IGS
d. I/O Address: ModbusTCP.InstructorsPLC.400100[32]
(you can Browse and select a <Dynamic Address> then type in the 400100[32] at the
end of this I/O Address)
e. Move to the Advanced tab.
f. In the Options section check the Enable Output box.
GFS-154K
Education Services
5-39
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
8. Now click the Save button to Save this new tag.
Notice you did not get a prompt to place On Scan, this is an Register tag and is not processes by
SAC, it is essentially a pointer to the Driver I/O Address.
9. Save the Process Database once again.
10. After Saving, Reload the Database, this will force any output tags to load their Initial values.
Tip
When using AI or AO tags in HMI display objects such as a Datalink, the tag field to
display the current value is F_CV.
With Register tags, the F_CV exists, and will show the value of the first element in the
array.
In our example here being the Modbus address 400100.
Subsequent elements in the array can then be mapped in a the HMI object, these are
addressed using an offset, the F_0, F_1, F_2,..F_n fields.
It is possible, depending upon the Driver source address, to map all the way to
F_1023, i.e. 1024 values, only using single AR tag in the PDB.
5-40
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Part C – Bulk Import of tags from a CSV file
We are going to populate the PDB by importing some pre-made tags for the Course system.
1. In Database Manager on the Home Ribbon look in the Process Database section to find and click
the Import button.
Notice that SAC must be stopped while a bulk import is being performed. For this reason, it
is best to complete this on an offline engineering workstation only, not on an operational
SCADA node. As we will see later, even adding new tags, as well as importing, using the thin
client solution of Configuration Hub is a 2 stage process to avoid inadvertently affecting a
live operational SCADA node.
2. Click OK at this prompt then browse to the folder C:\ClassFiles\05. Process Database - Thick
Client\ and highlight the file EnergyCenter.csv. Then click Open.
3. At the CARBONKWH Duplicate found prompt, click Yes to overwrite and then Yes at the replace
tag prompt.
GFS-154K
Education Services
5-41
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
If you completed the earlier optional lab to add AO and AR tags, there should now be 23
tags in your Process Database. The CARBONKWH was updated as it is chained on to one of
the new imported tags and required this update.
Tip
If you also are prompted about adding new Alarms Areas, then it is most likely that
you did not complete the earlier lab, or misspelled Alarm Area names when these
were added. Just allow the CSV import to create these new alarms areas by clicking
Add All, and move on.
4. Click the Save button, this will save as the same database.pdb file.
5. Just to make sure, now click the Reload button, and Reload the database, to have the Process
Database at its start up condition, if any tags were off scan it will force them on scan.
5-42
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 5 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
GFS-154K
Education Services
5-43
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Review Questions
1.
What is the difference between Primary and Secondary tags?
2. What is the difference between opening a PDB file and reloading a PDB file?
3. What type of file can be used for bulk import and export of tags?
4. What is the format for most analog I/O addresses in (a) the IGS Driver and (b) a V 7.x
Driver?
5. What settings does the Analog Output block use to restrict operator input ranges?
Electronic Books Research
6. Using the eBooks, name three block types which support Alarm Shelving. (Search for
Shelving and look for the “About Alarm Shelving” topic).
5-44
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
Review
Now that you have completed this module, you should be able to:
 Compare primary and secondary database tags
 Describe the commonly used tag types
 Discuss the Database Manager
 Utilize Database Manager tools
 Configure Alarm Shelving Policies
 Work with Analog Tags
 Describe the Analog Alarm (AA) tag
 Define Register tags
GFS-154K
Education Services
5-45
Proficy iFIX Fundamentals - PDB - Thick Client Configuration
5-46
Education Services
GFS-154K
0)
06
PROCESS DATABASE THIN CLIENT CONFIGURATION
a
At the end of this module, you will be able to:
 Describe Configuration Hub for Database
Configuration
 Understand Asset Model concepts
 Describe the Digital Input (DI) tag and Digital
Output (DO) tag
Explain the function of the Digital Alarm (DA) tag
30%
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
6-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
I/O
Communications
Process
Dat abase
Asset
Models
Introduction to Configuration Hub
Configuration Hub allows remote, web-based configuration of multiple Proficy products in
one place.
Facilitating access and configuration from anywhere.
The current Proficy products supported within Configuration Hub are iFIX, Historian and
Proficy Authentication (UAA).
Installation of the iFIX 2022 Common Components includes Configuration Hub and Proficy
Authentication. It is highly recommended that these Common Components are installed only
once on a network wide system, with potentially many iFIX nodes registered with the
instance of Configuration Hub.
The Proficy Authentication (formerly UAA) instance, is the security provider utilized by and
configured within Configuration Hub.
A central instance of Proficy Authentication can operate as the single security provider for
any iFIX, Historian, Operations Hub or Plant Applications systems on a connected network.
Figure 6-1. iFIX Common Components installation
With iFIX locally installed, Configuration Hub is launched either from the Windows Desktop
shortcut or from the Application Ribbon in Workspace.
However, it’s a web URL, therefore, can be launched from anywhere supplying the address:
https://<servername>:<port#>
e.g.
https://host-1:5000
Port 5000 is the default external port for Configuration Hub. Be aware that an alternate port
may have been selected during the installation.
GFS-154K
Education Services
6-3
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Configuration Hub is an Integrated Development Environment or IDE, a flexible layout of
panels and tools that work together to build a system.
Configuration Hub leverages web technologies to create a panel based experience for
configuring Proficy products that allows opening, closing resizing and repositioning of the
panels in such a way as to reflect the most convenient and efficient way of working.
Configuration Hub Panels
The Navigation Panel, is used to open any of the other configuration panels, which may be
varied depending upon which Proficy products which have been registered. These could be
Proficy Authentication, iFIX, or Historian.
The Navigation panel can be closed to provide more real estate, or reopened from the
toolbar.
Figure 6-2. Navigation Panel; Tools; Publish & Save All
The main Configuration Panel area will be populated with which ever component is selected
in the Navigation panel, this could be Proficy Authentication Security, the iFIX Connections,
Models or Database, or from Proficy Historian such as Systems, Collectors, Models or Tags.
Each Configuration panel will open with in its own tab.
Figure 6-3. Configuration Panel
6-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
The Details Panel is a companion panel that responds and works with the currently active
Configuration Panel. For example, if configuring in the iFIX Database panel, the Details panel
will show the tag property grid for the currently selected tag.
Figure 6-4. Details Panel
iFIX Specific Panels
The iFIX Connections Panel allows connectivity to sources from which data will be retrieved
for Models and the Process Database. Both Models and Tags can be created by browsing
sources in the Connections Panel. Available currently are the OPC UA and IGS Drivers.
In the Navigation panel, select Connections, and then select either OPC UA or IGS at the top
of the Main Configuration Panel.
Figure 6-5. Connections Panel
GFS-154K
Education Services
6-5
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
The iFIX Model Panel allows creation of a blueprint or template of the assets in a system
and to quickly and easily create and maintain instances generated from a Type definition.
Models are made up of:
 Object Types: A tangible object such as tank, mixer, furnace, or pump etc, which have
common variables and contained types shared across all object types. Object Types will
have Variables, Contained Types, and Templates.
 Variables - Individual measurements that are common to the type, such as levels, flow,
temperature, etc. Variables represent tags that will hold values retrieved via iFIX Connection
sources e.g. IGS or OPC UA.
 Templates: These provide the capability to have one or more translations of an Object Type
into an Object Instance.
 Substitutions – These allow parametrization of the Type definition such that each Object
Instance can have unique values when created from the Type and Templates.
 Contained Types - these allow creation of a hierarchical structure for assets that will be
instantiated together.
 Object Instances – This is an instance created from the Object Type. The instance
represents an asset in the actual system with its variables created as iFIX tags (direct
variables), point to existing iFIX tags (indirect variables) or are static to the type (static
variables).
Do not get too wrapped up in Model definitions at this stage. We will touch on Model
creation in this Fundamentals course, but we will utilize an Imported Model. The iFIX
Advanced class will look fully at developing a reusable Asset Model. The OLT Learning
module for this chapter will also look a little deeper into Model Creation and Deployment.
Figure 6-6. iFIX Models Panel
6-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
The iFIX Database Panel provides similar functionality to the iFIX Database Manager which
we looked at in the last chapter. As clearly pointed out, Database Manager is a thick client
solution. Configuration can only take place on a computer where iFIX and a development
license is installed.
The Database Panel in Configuration Hub is very much a thin client solution. Configure the
iFIX Process Database from a supported browser from any network connected computer.
That Database Panel interface should be fairly intuitive to use by those familiar with webbased grid objects.
Figure 6-7. iFIX Database Panel
This Database Panel contain an intuitive and very useful set of tools. The Database Panel
toolbar provides:
 Database Selection: a drop-down list to switch to another database
 Ellipses button (other tools): Access the menu to create a New Database, Save As,
database Import or Export
 Refresh: refresh the grid view
 Clear Filters: clear all filters currently applied to the grid
 Delete: Select one or more tags and click this button to delete the tag(s)
 Duplicate: Select a tag and click this button to duplicate an existing currently selected tag. A
new name will be requested
 New: The New button is used to add a new tag to the database
 Settings: the settings icon is selected to pick the columns for display in the Database grid
Figure 6-8. iFIX Database Panel Tools – inc Import and Export
GFS-154K
Education Services
6-7
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
An important concept to grasp is that the Database functionality in Configuration Hub has
off-line storage where all tasks such as adding, deleting or modifying tags is staged. Only
when modifications have been Saved and Published will the live SCADA Process Database
be updated. Recall these Database modification tasks may be taking place remotely,
therefore this two stage Save / Publish process provides an airgap.
With the Database Panel open tools to interact with the source iFIX tags in this web
container are provided such as sorting, filtering, modifying the displayed columns, and
interacting with the iFIX tags.
Status Icons indicate whether a tag has been added, modified or published.
Figure 6-9. Added, Modified, Published Status
Figure 6-10. Publish / Save All / View Publish Log
Import / Export
The Configuration Hub Database Panel tools as shown in the last page, contains both an
Import and Export tool. These are designed around an external CSV formatted file.
It is worth noting that the Model Panel also has an Import / Export function.
Figure 6-11. iFIX Model Panel – Import and Export
The format of the CSV file for the Database Panel Import / Export is very similar indeed to
the format seen in the last chapter relating to Import / Export in Database manager. Crucially
however the Database Panel Import / Export format additionally contains the Asset Model
configuration.
This is by far the most effective and simplest method for mass creation of both the Asset
Model (with Types and Instances) and all tags in the Process Database, regardless if they
are part of an Asset Model or not.
The Import / Export CSV format found in the Model Panel, is significantly different and more
complex. It will facilitate mass creation of both the Asset Model and the Staging step of any
tags associated with the deployed Instance of an Asset model.
Figure 6-12. CSV for Import using the Database Panel – note the MOT / MPG ‘Tag’ types
6-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Digital Tags
The Digital tags are most frequently used to work with two-state values coming from plant
floor equipment. Commonly these are on-off statuses, true-false conditions or equipment
faults and alarms. As such, these tags are closely tied to equipment such as valves, pumps,
motors and switches, although they can be used for just about anything.
There are three main digital tags: The Digital Input, the Digital Alarm and the Digital Output.
There is also a special tag called a Digital Register that is popular for situations where
alarms, trending and tag chains are not required.
Tags can be added several different ways. As we saw in the last chapter, there are several
ways inside Database Manager to add a new tag. Also in the Workspace using the Add
Database Block button from the Applications Ribbon.
The Database Panel in Configuration Hub too provides the ability to add new tags. Using
the New button in the Database Panel tools, a name is supplied, the type of tag is selected
then clicking Create will add (not publish) the new tag.
Figure 6-13. Configuration Hub - Database Panel – New Tag
As with any SCADA modifications made from Configuration Hub, there is a two stage
process before these changes are committed. A Save must firstly be performed, followed by
a Publish, before the new tag will be added to the iFIX SCADA Process Database and placed
On Scan.
GFS-154K
Education Services
6-9
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Digital Input (DI) Tags
The Digital Input tag specializes in retrieving digital values from the Driver. It provides the
current digital state to animations in displays, historian tags, reports, and other chained
tags. The DI tag also supports simple alarming and can write to the same address it reads
(as long as the I/O address supports both reads and writes). All editable fields can be
modified in the Details Panel.
Figure 6-14. Digital Input tag (General, I/O Addressing , Limits)
General Fields
Tag Name: As with the Analog tags discussed before, and any tag for that matter, this is a
256 character alphanumeric name that will be used to identify the tag in all data source
links.
Description: This is a 256 character alphanumeric description.
Limits and Scaling (Labels in Database Manager view): This maps each state to text label
that operators can use to assess conditions. The Open State corresponds to zero (0),
whereas the Close state corresponds to one (1). (Field: A_CV).
Note
Each configurable text box corresponds to a field. Use the iFIX Online Help to find
the field abbreviations used in data sources.
6-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Configuring IO Addresses
Driver: this refers to the Driver selected. This list will contain the drivers configured in the
SCADA section of the SCU. Choose the appropriate Driver from the drop-down list. (Field:
A_IODV).
Figure 6-15. List of Available I/O Drivers (As configured in SCU)
I/O Address: this is a link to access the source value in the Driver’s configuration.
For the IGS Driver this is made up of:
Channel.Device.StaticTags. e.g. ModbusTCP.InstructorsPLC.HeaterSwitch
OR
Channel.Device.<DynamicTagAddress>. E.g. ModbusTCP.InstructorsPLC.000001
For a v7.x Driver this is made up of: Device:Word:Bit e.g. PLC01:DB1:1
The Channel and Device names must match the information in the driver configuration.
Digital addresses typically require a word and bit, or register address, or if from a supported
hardware device a symbolic address from the PLC.
This may vary depending on the Driver or protocol used. (Field: A_I/OAD).
If using the IGS or OPC UA Driver, a Browse button is presented which will facilitate
browsing the Driver structure.
For a v7.x Driver the I/O Address is added manually.
Figure 6-16. Selecting I/O Addresses
GFS-154K
Education Services
6-11
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Scan times
Primary tags like the DI can use a variety of scan times to control the frequency with which
they perform their duties.
Time Based: this allows the tag to process values based on a defined time period, be it
measured in sub-second intervals, seconds, minutes or hours. (Examples: 0.5 = ½ second,
3 = 3 seconds, 1M = 1 minute, 2H = 2 hours).
Exception Based (v7.x Drivers only): the tag will update only when a significant change
occurs in the value. Input tags rely on the I/O Driver (through the Datablock deadband
setting) to flag when a change has occurred. In addition to the available checkbox, the
letter “E” will signal Exception-based scans.
One Shot: the tag scans the value only once, and then the tag is turned off-scan. It will
only scan again when the tag is manually placed back on-scan. To designate a one-shot
scan time, use a zero (0) in the scan time field.
Alarms Options
The Alarms Options is where alarm-specific fields are grouped. It is important to have the
Alarm Area Database built before assigning Alarm Areas to database tags.
Figure 6-17. Alarm Options
6-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
When Enable Alarm is enabled, alarms will be generated and sent to all alarm locations.
Importantly, they will require operator interaction through the Alarm Summary to
acknowledge and clear the warnings.
When Enable Event is enabled, the same alarm information is generated and sent, but not to
the Alarm Summary service. As a result, there is no requirement for operator feedback (i.e.
it is used for reporting purposes only). Both Enable Alarm AND Enable Event must be
enabled for Event Messaging to work.
Alarm Type
With digital values, alarm detection is simple, as the value exists in only two states (0 or 1).
 None will disable alarm generation on state changes, other alarms will still be generated
 Open will generate alarms when the digital value transitions to 0
 Close will generate alarms when the digital value transitions to 1
 Change of State will generate alarms for all value transitions
Alarm Areas
When Alarm conditions have been detected, the
alarm message will be labelled using all the alarm
areas listed for the tag. Each tag can have a
maximum of 15 different alarm areas listed. When the
alarm message is received by the various Alarm
services, they will match the alarm area label on the
message to the list of filtered alarm areas. If just one
of the alarm areas labelling the message matches an
area in the filter, the message will be delivered to the
Alarm service.
To add Alarm Areas to a tag, they are selected from
the available list, as configured in the Alarm Area
Database. Individual or multiple areas can be selected.
ALL is the default for any new tag.
Figure 6-18. Selecting Alarm Areas
Alarm Priority
iFIX can also label alarms by Alarm Priority. This granularity is for filtering alarms in
destinations such as the Alarm Summary, Alarm ODBC or Alarm & Event OPC and OPC UA
Servers. In order of decreasing severity the Alarm Priority levels are Critical, HiHi, High,
Medium, Low, LoLo and Info.
Alarm Shelving
If alarm shelving is enabled, alarms can be temporarily suppressed from the active alarms
list in the Alarm Summary object for a fixed period of time. Tags can be assigned to a
specific Shelving Policy as configured in Database Manager.
Shelving helps improve the display of alarm information on screen and helps operators with
prioritization so they can focus on only the highest priority alarms on screen at any point in
time. Alarm shelving is particularly useful if there are lots of alarms for an operator to sort
through.
GFS-154K
Education Services
6-13
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Advanced Options
Advanced Options provide configuration settings for security access to the tag and set point
changes, in addition to alarm text fields and other fields specific to this type of tag.
Figure 6-19. Advanced Options
A selection of these Advanced Options are:
Enable Output: allows this tag to write values back to the Driver source using the same I/O
Address, if supported by the Driver.
Startup Mode: If Auto mode, forces the tag to use the scan settings and I/O Address
information in the I/O Addressing section to govern data retrieval from a Driver. If Manual
mode, it disconnects the tag from automatic Driver updates allowing manual interaction.
Alarm Extension Fields: these are 80-character text fields that can be used to add more
information to alarm messages and may be alphanumeric with no character restrictions.
Security Areas: these will be dealt with in subsequent modules.
Previous and Next Block field for chaining. The Next field is editable, Previous is not.
The Historian and E-Signature fields will be discussed in later chapters.
6-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Digital Alarm (DA) Tags
The Digital Alarm tag is essentially the same tag as the Digital Input tag, except that it has
enhanced alarm capabilities.
The General and Advanced tabs are identical to the DI, so we will focus on the alarm
enhancements found on the Alarms Tab.
Alarms Options
The Digital Alarm tag shares certain alarm qualities with the Digital Input tag, such as Alarm
Area designation, alarm priorities and the types of alarms detected (such as “Change of
State” or “Close”). There are some additional fields that can be used to add intelligence to
the way alarms are detected, generated and linked to other tags.
Figure 6-20. Digital Alarm Tag - Alarm Options
Contact Name Fields
When the alarm is generated based on plant floor conditions, a DA tag can change the set
point of another digital tag (the contact tag). The contact tag name is entered in the
appropriate field. When the alarm is generated, the digital tag will be closed (set point = 1).
Depending on the operator’s reaction to the alarm, the tag may be automatically opened
(reset to 0).
Acknowledged: the contact will be reset when the operator acknowledges the alarm (for
example, by using the Alarm Summary table).
Return: the contact will be reset when the alarm conditions return to normal (the tag’s
current value returns to safe limits).
All Clear: the contact will be reset when the operator acknowledges the alarm and the
alarm conditions return to normal (both requirements must be met).
Never: the operator must manually reset the contact tag.
Contact tags are used to automatically control dependent devices according to plant
conditions, or to enunciate more severe alarms using alarm sirens or lights (whose states
are tied to the digital tags). This type of control is often built into the PLC logic and is not
required in the SCADA. However, sometimes it is easier to set up and maintain with tags in
a database, so it can be used as an alternative to PLC-based alarm logic.
GFS-154K
Education Services
6-15
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Other Alarm Option Fields
ACK Tag: this digital tag, when closed (set to 1), will automatically acknowledge the current
DA tag alarm conditions. Developers can associate a single “Master” alarm to many
dependent “slave” alarms with an ACK Tag, and thus allow operators to acknowledge
blanket alarm conditions quickly and easily.
Alarm Suspend: this digital tag, when closed (set to 1), will suspend alarm message
generation and delivery for the current DA tag. It allows the operator to temporarily pause
alarming on certain tags, in order to display only important or critical alarms from other tags.
Delay: this will allow the user to configure a minimum level of persistence in a plant floor
condition before an alarm in generated. This can filter out short-term spikes, corrections or
insignificant alarms by reporting them only after they have been occurring for a designated
amount of time. Given in dd:hh:mm:ss.
This effectively stops annoying the operator with alarms which quickly rectify themselves.
Re-Alarm Time: the user can configure a minimum waiting period between when an alarm is
first generated and when it can be re-generated or updated. This is helpful in reducing the
number of distracting alarms during periods of fluctuation or upset where time is required to
return the plant floor conditions to normal. Given in dd:hh:mm:ss.
This effectively deliberately annoys the operator. Making them pay attention to very
important alarms. Even if they have acknowledged the alarm, it will keep reminding them
until they have fixed the root issue.
6-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Digital Output (DO) Tags
The Digital Output tag resembles the Digital Input and Digital Alarm tags, except that it is
used exclusively for writing values to the Driver. It is simpler than the DI or DA because of
this.
Figure 6-21. Digital Output Tag
The main difference with the Digital Output tag is the fact that there is no Scan Time in the
I/O Address fields. The DO tag will write a new set point to the Driver on the very next SAC
cycle (1/20th of a second), so it operates in a permanent exception-based mode. When DO
tags start a chain, the chain will only be executed when there is a set point change to the
DO tag.
Output settings are available to change the DO block functions. Invert Output will change
the operator set point to the opposite state provided before sending it to the Driver. For
example, an operator input of “1” would be relayed to the Driver as “0”. Sometimes this is
done to make the operator interface consistent (as the control logic may require values that
are counter-intuitive).
The Initial Value is the first value that SAC will send the Driver when the PDB is first loaded
or later reloaded. This is helpful for sending initialization or communication information.
However, if the Initial Value is different to the existing value read by the Driver, a write will
only occur if the Write if different is set to Yes.
DO tags can generate Event Messages (remember: alarm information without any feedback
requirement or Alarm Summary visibility) but cannot generate alarms. Because it does
report to Alarm Services (except Alarm Summary) it must be labeled with Alarm Areas.
GFS-154K
Education Services
6-17
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Troubleshooting Topic:
IGS connectivity
When adding tags whose I/O Addresses are an IGS source, either using the New button in
the Configuration Hub Database Panel, or through CSV Import, it is important that three
steps have already taken place for permit the connection to the IGS Driver.
IGS Settings – Configuration API Service: Enable and Enable HTTP must be set to Yes.
Figure 6-22. IGS Settings – Configuration API Service
IGS Settings – User Manager: A valid User for IGS Connectivity must be available and
known. It is often a good choice to create a User for this purpose. On a default installation,
the Administrator user will have been configured with no password.
Figure 6-23. IGS Settings – User Manager / access configuration
IGS Connectivity into Configuration Hub will assume Administrator with no password. If an
Administrator password has been set, or a custom user has been created for this purpose, it
must be entered in the Configuration Hub IGS access configuration in the Details Panel.
Figure 6-24. Configuration Hub – IGS access configuration
6-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Firewalls
A common issue during initial setup of a system using Configuration Hub, is caused by its
network packets being blocked by Firewalls, either the Windows Firewall built into the
Windows O.S. or a hardware firewall on the path between the Configuration Hub server and
the computer attempting to access it.
When attempting a connection to a remote Configuration Hub server, the follow error is
presented.
Figure 6-25 Error – Cannot connect to the Configuration Hub server
By default, rules are actually added and enabled in the Windows Firewall where
Configuration Hub is installed. Therefore, it is unlikely that the Windows Firewall will be at
fault, it may be a hardware firewall on the network path at fault
When enabling firewalls with Port Rules, Configuration Hub requires TCP Port 5000 and
Proficy Authentication requires TCP Port 443.
GFS-154K
Education Services
6-19
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
eBooks Topic
Configuration Hub spans iFIX, Historian and Proficy Authentication.
Proficy Authentication itself, configured inside Configuration Hub, spans iFIX, Historian,
Operation Hub and Plant Applications.
Full Configuration Hub Online Help therefore is separate to iFIX.
All Online Help topics we have looked at so far access the web page:
https://www.ge.com/digital/documentation/ifix/version2022/index.html
Configuration Hub Online Help is found at:
https://www.ge.com/digital/documentation/confighub/version2022/index.html
Search the Configuration Hub Online Help and search for “Substitutions”. Look for this topic.
Take a read at this topic and the related Models topics when you have time.
Figure 6-26 Configuration Hub Online Help - Substitutions
6-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Lab Exercises – Process Database – Thin Client
Configuration
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Navigate the existing Process Database using Configuration Hub.
 Add Digital Tags, browsing the IGS Driver for sources.
 Import an Asset Model and Tags from CSV
 Explore an Asset Model
Introduction
In these lab exercises, you will utilize Configuration Hub as a thin client configuration tool for
the iFIX Process Database.
You will use the Database Panel to add Digital Tags, both manually and Importing of a set of
tags required to further develop the course system along with an Asset Model.
You will then investigate this imported Asset Model, including its Object Types, Contained
Types with Variables, Substitution Parameters, and its Deployed instance of the Model.
Lab Exercise #1 – Thin Client Maintenance of a Process
Database
Part A – Investigate the existing Process Database in the Database Panel
1. Ensure that iFIX is running and that any mandatory labs exercises to add tags to your
Process Database have been completed.
2. From the Windows desktop, locate and double click the Configuration Hub shortcut
3. At the Welcome page, enter Administrator as the user. The password will be the standard
password used throughout this class for administration users. Check your desktop
Student PC info file or ask your instructor. Then click the Sign In button.
Configuration Hub will now open.
GFS-154K
Education Services
6-21
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
4. In the Navigation panel, expand your SCADA# node, e.g. SCADA1 then highlight
Database.
The Database Panel will open.
5. Under the TAG NAME Column where the label currently states Filter, type in feed (not
case sensitive) to filter the current tag list and locate and highlight the SOLARFEED tag.
The Details Panel will open showing the configured fields for this AI Tag SOLARFEED.
6. In its ALARM OPTIONS section modify the following fields:
a.
b.
c.
d.
e.
f.
Alarm Areas: Energy
Shelve Enable: ENABLED
Shelve Policy: ENERGY
Low Low: 50
Low: 100
Then click the Save button at the top left.
7. Observe the Edited icon
in the STATUS Column for this SOLARFEED tag.
If you were to open Database Manager and view the Alarms tab and its setting for this tag
on the live SCADA Database, these new changes will not yet apply.
You have Saved but not Published, hence this Edited icon.
8. Next, click the Clear Filters button in the Toolbar to remove the ‘feed’ filter.
6-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
9. Go ahead now and click the Publish icon in the Navigation Panel for your SCADA node.
The Save button saves all and exists outside any scope for iFIX, Historian or Proficy
Authentication.
However, Publish is node specific, hence the Publish button for your SCADA node is part of
the SCADA node component in the Navigation Panel. In practice there may be 10 or 20 iFIX
SCADA nodes listed in the Navigation Panel therefore the Publishing action must be
restricted to each individual node.
10. At the Publishing Prompt, click the Publish button.
Warning
Observe that the default is to stop then restart the SAC process. This will have an
effect on any client interface currently retrieving data from that SCADA node’s
Process Database.
HMI Pictures in Run mode may be affected, operators may see error messages.
Any Historical Collection may store ‘Bad’ values during this restart of SAC.
11. When the Publish has completed, click the Done button.
Observe that the Status icon has changed to Published for the SOLARFEED tag.
12. With any tag highlighted and the Details Panel populated with its fields, locate and click
the Refresh icon in its Current Value field. If its source is changing, if its Scan time is
frequent, such as this Rotate tag, the Current Value will update.
GFS-154K
Education Services
6-23
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Part B – Add new Digital Tags
1. In the Configuration Hub Database Panel, click the New button to create a new tag.
2. Enter the Name as PROFICYPHARMA>INGREDIENTS>SODIUM_E468>INLETPUMP and
select DI – Digital Input as the Type, then click the Create button.
This Tag Name may seem long winded right now, but this is using the naming convention
which will come when using an Asset Model, so please make sure that you follow the naming
given here.
3. Next, in its Details panel, configure this new tag as follows:
a. Description: Sodium_E468 Tank Inlet Pump
under IO ADDRESSING
b. Driver: select IGS from drop down list
c. Address: click the browse icon
: expand PlantData – IngredientsPLC –
sodium_E468 – select InletPump then click the Select button
under LIMITS AND SCALING
d. Open Tag: Stopped
e. Closed Tag: Running
under ALARMS OPTIONS
f. Alarm Areas: Ingredients
g. Alarm Type: Open
h. Shelve Enable: ENABLED
i. Shelve Policy: PRODUCTION
under ADVANCED OPTIONS
j. Enable Output: YES
k. Then click the Save button at the top left
6-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
4. With this newly added tag highlighted, click the Duplicate button in the Database Tools.
5. Modify the Destination Name, simply change the last part from INLETPUMP to OUTLETPUMP.
Then click the Create button.
6. Next, configure this new duplicated tag as follows:
a. Description: Sodium_E468 Tank Outlet Pump
b. Driver: IGS
c. Address: click the browse icon : PlantData – IngredientsPLC – sodium_E468 –
OutletPump
d. Open Tag: Stopped
e. Closed Tag: Running
f. Alarm Areas: Ingredients
g. Alarm Type: Open
h. Shelve Enable: ENABLED
i. Shelve Policy: PRODUCTION
j. Enable Output: YES
k. Then click the Save button at the top left
7. Next, click the New button to create another new tag.
8. This time Enter the Name as
PROFICYPHARMA>INGREDIENTS>SODIUM_E468>INLETSWITCH and select DO – Digital
Output as the Type, then click the Create button.
GFS-154K
Education Services
6-25
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
9. Now, configure this new tag as follows:
a. Description: Sodium_E468 Tank Inlet Switch
b. Driver: IGS
c. Address: click the browse icon : PlantData – IngredientsPLC – sodium_E468 –
InletSwitch
d. Open Tag: Open
e. Closed Tag: Closed
f. Alarm Areas: Ingredients
g. Initial Value: CLOSE
h. Then click the Save button at the top left
10. With this new DO Tag highlighted click the Duplicate button again. This time modify to the
PROFICYPHARMA>INGREDIENTS>SODIUM_E468>OUTLETSWITCH
a. Description: Sodium_E468 Tank Outlet Switch
b. Driver: IGS
c. I/O Address: click the browse icon : PlantData – IngredientsPLC – sodium_E468 –
OutletSwitch
d. Initial Value: CLOSE
e. All other field values can stay the same, simply click again the Save button
Now you have 4 x new Tags. 2 new DI’s and 2 new DO’s.
11. Go ahead now and click the Publish icon in the Navigation Panel for your SCADA node.
12. This time UNTICK the ‘Do you want to stop SAC…’ option, then click Publish.
Click Done when the Publish completes.
Warning
If any errors are generated at this point, they could be investigated in the relevant
log file.
However if the message states “Complete with errors” ,ignore and move on.
6-26
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
13. In the Database Panel, locate and highlight the newly added Inlet Pump, click the Refresh
icon in the Current Value field, it should be Stopped.
14. Now locate and highlight the newly added Inlet Switch, click the Refresh icon in the Current
Value field, it will be showing ??? as its value.
Warning
A Digital Output, (any Output tag for that matter) only contains a value when
written to, OR on Reload of the Database if an Initial value is supplied.
You did enter Close as the Initial value, but since the ‘Do you want to stop SAC…’
was de-selected when Publishing, the SAC did not reload, its Initial Value was not
set
15. Click the Publish button again, this time check the ’Do you want to stop SAC…’ , then click
Done when complete.
16. Now go back to those DO tags and Refresh their Current Values. They will now have the Initial
Value of Close.
GFS-154K
Education Services
6-27
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
6-28
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Lab Exercise #2 – Mass Creation of Model and Database
Introduction
In this lab exercise, you will investigate the format of CSV file required for import into the
Model Panel, then the format required for import into the Database Panel.
You will then use these to initially create the basic Model template – import using the Model
Panel.
Then through import in the Database Panel, you will create the deployed instance of the
Model, all of the tags required by the Model and many additional tags for our course system
not associated with the model.
Part A – Investigate the CSV formats.
1. Ensure that iFIX is running and that any mandatory labs exercises to add tags to your Process
Database have been completed.
2. Open Configuration Hub, either from the Desktop icon, or from the Applications Ribbon in
Workspace. Log in to Configuration Hub in the same way you have done several times already.
3. Verify in the Database Panel for your own SCADA node, e.g. SCADA1 that you have up to 27
tags. Some were created in earlier optional labs, so you may not have all.
GFS-154K
Education Services
6-29
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
4. Click Model in the Navigation Panel under your SCADA node, and verify that no Model yet
exists, i.e. there are no Types, and no Instances.
5. Open a Windows File Explorer and browse to the folder:
C:\ClassFiles\06. Process Database – Thin Client\ and locate and open in Excel
the file 1. ModelTypes.csv.
6. Scroll through, but DO NOT CHANGE any values, observe the format of the CSV with its
Header fields denoted with a # such as #PropertyDefinitionHeader followed by the Property
Definitions themselves, e.g. Sodium_E468 as an ContainedAsset and InletPump as a Boolean
Variable.
6-30
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
7. Close Excel when you have looked, do not save any changes.
8. Repeat and observe the format of the other CSV in this same folder, open 3.
PDB_And_Model.csv in Excel.
9. Observe this format is almost identical to that discussed in the last chapter as the CSV import
format used by Database Manager.
10. Scroll to toward the bottom of this CSV in Excel and observe the ‘tag types’ of:
MOT, MPG, MPD, MTT, MTV, MTS, MTVP, MOI, MOV and MOS.
These are not actually tag types that an engineer familiar with the iFIX Process Database
would recognize, but are components of the Asset Model and will be processed accordingly
by the Import function in Configuration Hub Database Panel.
11. Close Excel when you have taken a look, do not save any changes.
Note
Due to time limitations and the possible complexity of the process to create these
CSV files, the iFIX Fundamentals course only requires students observe these
import files.
The iFIX Advanced course, and Online Training (OLT) Modules will take a deeper
look at the creation of these import files.
GFS-154K
Education Services
6-31
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Part B – Import and Investigate an Asset Model
1. Return to Configuration Hub and the Model Panel for your own SCADA node, click the
Import button.
2. Click the Choose File button and browse to the 2. Model_And_Instance.csv file.
This is an additional file containing both the Asset Model and the Instance required for our
course system.
C:\ClassFile\06. Process Database – Thin Client folder. Highlight this file and click Open.
3. Next, click the Import button.
Note
The 2. Model_And_Instance.csv file contains the Asset Model Types, a template,
and the Instance for our course system. Unchecking the Object Instances
checkbox would only import the Asset Model and Template, not the Instance.
6-32
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
4. When complete the top banner in Configuration Hub will show:
5. The Import Model window will show Import Completed and provide a link to the Import Log
File.
Only if this Log file link is clicked will it save a copy in your local computers \Downloads
folder.
Click this if you wish, then view the ImportLog.txt file in a text viewer such as Notepad or
Notepad++.
Click the Close button to close the Import Model window.
GFS-154K
Education Services
6-33
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
6. Return to the Model Panel for your SCADA node in Configuration Hub.
7. Expand and observe the three hierarchical layers in this defined Model.
Production Plant as the Parent (top layer), Ingredients as a Child Object (middle layer, a Plant
may have many children) and IngredientTank as the Grand Child Object (bottom layer,
Ingredients may have many Ingredient Tanks).
8. With the IngredientTank Object highlighted, click its ellipses button on the right and choose
Edit.
9. As an example, in the VARIABLES list, select the InletPump Variable which belongs to this
IngredientTank Template. You will need to ensure that the Details Panel is open and dragged
to view values as shown below.
a. Observe, this is a BOOLEAN with a DI Tag type defined
b. Observe the IngredientName SUBSTITUTION Parameter defined below
c. Observe that this IngredientName in the template is substituted, with curly brackets {},
into the Description and I/O Address in the DI Tag template for this InletPump.
When Instances are deployed this {IngredientName} will be substituted with an actual
process, thus the Description and I/O Address will have real values. As we will see later this
same Substitution Parameter can be used in re-usable HMI Displays.
6-34
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
10. Next, open the Database Panel for your SCADA node. Click the ellipses button then choose
Import.
11. In the Import iFIX Database window, click the Choose File button and browse to select the
CSV investigated earlier: C:\ClassFiles\06. Process Database – Thin Client\ 3.
PDB_And_Model.csv. Then click Open.
12. In the Import iFIX Database window, click the Import button.
13. On completion you will see the banner:
14. As with the Model import, a copy of the Log File may be saved in the local computer
\Downloads Folder.
Click the Log file link.
If an ImportLog.txt file already existed in this folder, a (n) e.g. (1) will be appended.
15. Click the Close button in the Import iFIX Database window.
16. If you wish, open the ImportLog(1).txt file in the \Downloads folder, in a text viewer such as
Notepad or Notepad++.
GFS-154K
Education Services
6-35
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
17. Click the Refresh icon
in the Database Panel, observe many new tags are listed.
These are New and Un-Published as indicated by the blue + icon.
18. Likewise in the Model Panel, the Instance of ProficyPharma was added as a New Instance and
again has a blue + icon.
Note
This last import using 3. PDB_And_Model.csv is actually a bit of a cheat / gift!
It contains the complete Model including Types, Template and Instances
It also contains the complete Process Database required for the course system.
If by choice or accident, you used alternate names for tags, or chose incorrect I/O
Addresses, this import will bring your Process Database ‘up to speed’ so to speak.
This really is to mitigate any failures in later lab exercises.
19. Next, click the Publish button in the Navigation Panel
for your SCADA node. Ensure that the ‘Do you want
to stop SAC…’ checkbox IS enabled.
Then click the Publish button.
20. Click Done to close the Publish window when
complete.
If any Errors occur a PublishLog.txt file can be saved
to your local computer \Downloads folder for
investigation.
If the errors are minor (yellow banner) and the checks
in the following steps are unsatisfactory, investigate
with your instructor, otherwise move on.
6-36
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
21. In the Database Panel for your SCADA node, click the Refresh icon again, then scroll though
the tags list to check that all have a Status of Published.
22. Highlight a Model tag such as the one shown below and with the Details Panel open, click the
Refresh icon in the Current Value field to see updates.
23.Move to the Models Panel, Refresh the panel if needed, and under the ProficyPharma
Instance, expand to view and highlight the Ingredient Sodium_E468. In the Details Panel,
observe that the Substitution Parameter has been given the value Sodium_E468. This actual
value will iterate through all uses of {IngredientName}.
GFS-154K
Education Services
6-37
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
24.Next, expand through to the InletSwitch variable for this Sodium_E468 Ingredient.
Observe that the Tag Name, the Description and the I/O Address all contain the correct
Sodium_E468 value. In the Template this was {IngredientName} so now has been substituted.
Tip
We have added 6 x Ingredient Tanks with their variables containing automatically
substituted values, speeding up the development significantly of the Model Instance
and the iFIX Process Database Tags associated with the Model. Scale this concept
up to 100 Ingredient Tanks, or any real repeatable process unit, and potentially 100s
of development hours could be saved.
6-38
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 6 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
GFS-154K
Education Services
6-39
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Review Questions
1.
Name the three Configuration Hub Panels.
2. What is the difference between Saving and Publishing in Configuration Hub?
3. What is the difference between a Digital Alarm block and a Digital Input block?
4. How do you configure a Digital Input block to read and write from the IO Address?
5. In your own words, what is the difference between the Import CSV format used in the
Models Panel of Configuration Hub, and the Import CSV format used by the Database
Panel
in Configuration Hub? Which is best?
Electronic Books Research
6. What is the A_PRI field used for?
6-40
Education Services
GFS-154K
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
Review
Now that you have completed this module, you should be able to:
 Describe Configuration Hub for Database Configuration
 Understand Asset Model concepts
 Describe the Digital Input (DI) tag and Digital Output (DO) tag
 Explain the function of the Digital Alarm (DA) tag
GFS-154K
Education Services
6-41
Proficy iFIX Fundamentals - PDB - Thin Client Configuration
6-42
Education Services
GFS-154K
0)
07
PICTURES AND TEMPLATES
a
At the end of this module, you will be able to:
 Use the Workspace to build iFIX HMI pictures
 Use the Create Picture Wizard to develop
picture templates
 Configure Workspace User Preferences
35%
Proficy iFIX Fundamentals - Pictures and Templates
7-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
HMI
Overview
The displays created for the HMI will become the primary means for an operator to interact
with the process on the plant floor. It will often be the most useful means for other
personnel to find the information they need for analysis, reporting and troubleshooting
purposes.
iFIX pictures support many powerful features to help build and customize the visualization
environment for all users. Shapes, symbols, and buttons are used to create simple and
intuitive representations of plant floor processes. Forms, prompts and dialogs allow for
detailed operator interaction with any aspect of the control system. Historical trend charts
can be embedded in pictures beside real-time data for comparative analysis. VBA scripting
provides limitless customization and extends the Workspace to interoperate with 3 rd party
applications and databases.
High Performance Graphics
High-performance HMI displays provide information to operators in a concise and effective
way that maximizes their ability to assess the state of a process. By minimizing visual
distractions and irrelevant information, operators can more readily determine what actions
they need to take. iFIX provides graphic tools including dynamos and a high-performance
color palette, designed to assist in the creation of pictures that follow industry guidelines for
High-Performance HMI. The use of high-performance graphic tools and settings are
recommended for pictures intended for export to Proficy Operations Hub. However, Highperformance tools and design principles should be used when designing any iFIX pictures.
Figure 7-1. High Performance Graphic Display
GFS-154K
Education Services
7-3
Proficy iFIX Fundamentals - Pictures and Templates
Workspace Documents
The Workspace supports a variety of document types. Native iFIX documents include iFIX
Pictures (.GRF), Schedules (.EVS) and Dynamo Sets (.FDS). Pictures and schedules can be
used in both Configure and Run mode, whereas Dynamo sets are used solely in Configure
mode to add graphic components to Pictures. Each of these documents supports (but does
not require) VBA scripting.
The Workspace is an ActiveX container, and as such it is also able to display any ActiveX
document type (for example Microsoft Word or Excel documents). When these documents
are opened by the Workspace, they do not open in their parent application, but instead
reside natively within the Workspace. The Workspace will even provide the default toolbars
associated with the parent application.
Pictures
These are the primary graphical interfaces for operators. They show the process data in a
friendly and intuitive manner while also providing a platform for scripting, reporting, trending
and alarm display.
Schedules
These documents are not intended as an operator interface. Their role is to act as a
detection mechanism and trigger for automated actions such as reporting, data transfer and
routine tasks. Schedules can trigger scripts using Time-based or Event-based triggers.
These documents typically run behind the scenes performing easily automated actions.
Dynamo Sets
Dynamo Sets provide logical groups of re-usable graphical symbols such as representations
of tanks, pipes, pumps and valves. Developers often create their own dynamos to help build
visualization standards into the application. Dynamos can be composed of static shapes
that are used more like scenery, or they can contain easily assigned animations that can
interact with the user.
Run vs. Configure
Run and Configure modes can be toggled using the Run button in the Home Ribbon and
Quick Toolbar, or by using the default keyboard shortcut Ctrl+W.
Important
Recall previously mentioned in this course that if using a Windows based browser
when viewing your student computer for the class, by an unfortunate twist of fate,
Ctrl-W will terminate either the browser tab or the whole browser if only one tab is
open.
Highly annoying in this iFIX class.
In the training course system, when switching from Configure to Run mode, use the
Run button in the Home Ribbon, or Quick Toolbar.
When switching from Run mode back to Configure mode use the custom keystroke
of Ctrl-Q which has been added.
7-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
Picture Basics
Container Qualities
Pictures are containers. Shapes, animations, buttons, forms, and scripts are all contained
within the picture file, so there is no need to maintain or copy resource files when moving or
copying pictures. All contained items are displayed in the System Tree as they are built, and
all contained scripts and forms are displayed in the Visual Basic Editor (Project Explorer).
3rd party ActiveX controls and .NET Components can also be embedded in iFIX pictures.
Design Considerations
Consideration should be given to the system-wide requirements before display building
begins. The types of workstations used, and the navigation methods required will affect the
design and deployment of displays. Use High-performance Dynamos, graphic objects, and
colors wherever possible to simplify the layout and presentation.
Color
Display color is important to provide high-contrast, easy-to-read information to operators. It
can also uniquely identify pop-up pictures, different plant areas or different navigation
areas. Lighter colors are popular with systems that support many colors, as they are easier
to read and are visually more comfortable. For systems that support fewer colors (16 or
256), black backgrounds are used to provide the highest contrast with brighter colors.
Size and Resolution
The Workspace has a scaling feature that will automatically resize displays for monitors of
different resolutions. The only display features that are not re-scaled are tools that use the
Windows System Fonts, such as user prompts, pushbuttons and forms. For this reason, it is
best to use a common System Font on all client computers, and where possible, it is best to
use a common monitor resolution to avoid unintended scaling effects.
Picture sizes can vary depending on what the display is used for. Process screens are
usually full screen or, in cases where other pictures are needed for alarm enunciation and
navigation, the largest screens used. Navigation screens often take the form of side frames
or header/footer style banners. Control interfaces are often small pop-up pictures,
containing only simple and essential features for control actions.When developing for touch
screen or mobile devices, ensure that interactive features such as buttons and drop-down
boxes are of sufficient size to allow selection using larger pointers (such as fingers).
Full Screen
For stations with full time use, it is best to design displays using Workspace Full Screen
dimensions. When properly deployed, Workspace Full Screen mode (set in User
Preferences - General) not only provides the maximum viewable area, but it can also
prevent access to all other parts of the Windows O.S. For casual users who need to view
displays while using other applications, it is best to use Workspace in a normal mode.
Menus, Title Bars and Status Bars can be enabled or disabled in order to provide additional
security to the system, maintain the navigation integrity of the display interfaces and to
provide extra viewable space for display content.
GFS-154K
Education Services
7-5
Proficy iFIX Fundamentals - Pictures and Templates
Display interaction
It is best to know in advance if the system will operate with multiple dependent displays
simultaneously open and whether those displays will need to share information between
them. This will affect template design and the use of variables and scripting within pictures.
Creating Pictures
Creating new pictures prompts the Create Picture Wizard. This tool can be used to define
a variety of picture templates.
There are three ways that pictures can be created using the Create Picture Wizard:
 Create Pictures from pre-defined templates.
 Create pictures using “on the fly” settings provided by the user.
 Create untitled pictures using default settings (defined in the User Preferences).
Figure 7-2. Create New Picture
Figure 7-3. Create Picture Wizard
7-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
Option 1: Create pictures from a pre-defined template.
The first step of the wizard prompts the user to identify how the Workspace should look
with respect to title bars, status bars and menus. Enabling Full Screen mode will disable the
remaining settings.
The second step displays the existing templates that can be used to create one or more
pictures simultaneously. Some templates build a single display, others build multiple
interlocking pictures (with frames, banners and main screens).
Figure 7-4. Template configuration
The Modify Configuration button will allow a user to specify a new template. There are a
number of picture settings that can be pre-defined including display dimensions, color and
title bar details. The user can also define whether the display should be “Always On Top” or
“Resizeable”. Once the new template has been created, it can be saved under a new name
and incorporated into the larger template list.
The third step asks the user to confirm which pictures to create (using the check boxes)
and to provide unique file names (by default in the PIC path).
Figure 7-5. Supplying Picture File Name(s)
GFS-154K
Education Services
7-7
Proficy iFIX Fundamentals - Pictures and Templates
The fourth step provides a quick summary before prompting the user to finish.
Figure 7-6. Summary and Finish
7-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
Option 2: Create a custom picture
This choice only allows the generation of a single picture. The user will provide the picture
details in the interface.
As with Option 1, the first step of the wizard prompts the user to identify how the
Workspace should look with respect to title bars, status bars and menus. Enabling Full
Screen mode will disable the remaining settings. The basic picture settings are provided in
the second and third steps.
Figure 7-7. Create Custom Picture - Dimensions
Figure 7-8. Create Custom Picture - Attributes
The fourth step specifies the new picture name, and the fifth step summarizes the
operation and prompts the user to finish.
Option 3: Create an “Untitled” picture with default settings
There is only one step to this operation: a picture will be created based on the Picture
Preferences in the Workspace User Preferences. This is quick and easy but does not allow
any user control over picture generation.
GFS-154K
Education Services
7-9
Proficy iFIX Fundamentals - Pictures and Templates
Editing Pictures
Right-clicking the picture background or the Picture icon in the System Tree can also
provide access to the Edit Picture dialog box. This dialog box will edit only certain
properties of the current picture.
Figure 7-9. Edit Picture dialog
Picture Caching
To improve the loading performance of displays, pictures can be assigned to one of two
memory caches. A permanent pre-load memory cache can be defined in the
FixUserPreferences.INI file (stored in the Projects \LOCAL Path). This cache is reserved for
frequently used pictures that are needed for quick access by operators. A second
temporary FIFO cache can rotate recently viewed pictures into a finite number of slots. (If
the picture is in the permanent cache, it does not get added to the temporary cache).
Caching can be disabled on a picture-by-picture basis.
7-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
Picture Sizing, Location and Scaling
Picture sizes are controlled by Enhanced Coordinates which govern Window Width and
Height and scaling.
This Enhanced Coordinate System, allows creation of pictures independent from restricted
screen resolution. For the Enhanced Coordinate System, the dimension and position of a
picture are measured in postscript points. The Enhanced Coordinate System features
automatic scaling of a picture when viewed on a screen with a resolution that is different
from the screen on which the picture was originally created. Once a picture is created with
the Enhanced Coordinate System, the picture retains its original aspects even when viewed
on screens with different resolutions.
The Enhanced Coordinate System provides a Zoom to Fit viewing preference that is enabled
for run mode. Zoom To Fit suppresses scroll bars while allowing a view of the entire picture
on screen. The objects within the picture do not change their position and dimensions even
when the picture is brought to a new screen resolution, which is different from the resolution
on which the picture was developed. Zoom to Fit does not change the location of the
objects/shapes within the picture but scales the picture for viewing only.
Zoom to Fit is enabled for Run mode by default in User Preferences.
Zoom to Fit can be selected in Configure mode by clicking the Zoom to Fit button on the
View Ribbon, or with the keystroke Ctrl+M. This really is to provide a quick view in Configure
mode of how the picture will look in Run mode. It is not possible to edit the picture whilst in
Zoom to Fit in Configure mode.
Figure 7-10. Zoom to Fit (Configure mode)
There is a legacy Logical Coordinate System, on older iFIX systems. The screen resolution
is measured in logical units. The logical unit value is derived from the screen resolution of
the terminal on which the picture was originally created. Typically, 100 wide by 75 high in a
4:3 ratio display.
When viewing this picture on a terminal with a different screen resolution, the picture may
not automatically scale to the new screen resolution.
The Auto Scale option allows movement of pictures between screens with the same
resolution. However, when viewed on a screen with a different resolution, the picture many
not scale as desired. When moving pictures to a screen with a different resolution, it is
recommended to use the Enhanced Coordinate System.
GFS-154K
Education Services
7-11
Proficy iFIX Fundamentals - Pictures and Templates
A picture created with the Logical Coordinate System can easily be upgraded to the
Enhanced Coordinate System. The Enhanced Coordinate System expert converts the
picture from logical units to postscript points. During the upgrade process, the picture in the
Logical Coordinate System is saved to a Backup folder before the picture is upgraded. When
a picture is upgraded, the icon changes to indicate the upgraded picture.
Update Window Location allows the position or size of a picture to be permanently set.
Either from the Picture tools in the View Ribbon or the right-click menu from a picture in
focus.
In order to drag a picture to a new default location, the title bar must be enabled.
Figure 7-11. View Ribbon - Update Window Location
Figure 7-12. Picture right click menu - Update Window Location
This is particularly useful with smaller popup pictures where the desired opening location is
chosen by dragging the picture by it’s titlebar, then clicking Update Window Location.
7-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
Workspace User Preferences
The Workspace uses default settings to determine how to draw shapes and create
documents. The user can edit these settings to suit the project requirements. These
preferences will be applied to all subsequent shapes and documents.
User Preferences is accessed via the Settings button on the Home Ribbon.
Figure 7-13. Accessing User Preferences
User Preferences has many diverse configuration components, some relate directly to the
creation of pictures and their objects. Other settings for Workspace itself. Some for
Workspace security and others for external applications.
The available pages are:
 General: basic settings
 Animation Data Error Defaults: How animations react when data is not available
 Shape Preferences: default properties of objects which can be added to pictures
 Picture Preferences: defaults for new Untitled pictures
 Standard Chart Preferences: defaults for the Standard Chart object
 Drawing options: settings for CAD Tools
 Environment Protection: certain Workspace security settings
 Background Startup: which Schedules load when the iFIX Scheduler starts
 Startup Pictures: picture which open when Workspace starts in Run mode
 Change Management: external application for a legacy version control system
 Operations Hub: connectivity for publishing iFIX pictures to Operations Hub
 Historian: a Proficy Historian option to collect all iFIX tags
We will look in detail at some of these pages which are relevant to the topics covered in this
chapter.
GFS-154K
Education Services
7-13
Proficy iFIX Fundamentals - Pictures and Templates
General Page
 Start Workspace in Run mode: automatically launches the Workspace in Run mode using
the displays listed in the StartUp Pictures tab
 Auto Save Documents…: will ensure that all configuration changes will be saved before
switching to Run mode (including bad ones!)
 Full Screen in Run mode: will remove all title bars, menus and Status bars from Workspace in
Run mode. This will provide the maximum viewable area for displays
 Always Create Backup Copy: will move a copy of the previous version of document to the
\PIC\Backup\ path
 Fire Datachange Event on Startup: this will trigger script execution whenever the
Workspace changes state (i.e. Startup, Switch to Configure, Switch to Run) commonly seen
with Schedules
 Extend Workspace to support multiple monitors: Automatically change the Workspace to
support multi monitor resolutions and dimensions
 Enable Ribbon User Interface: Set the Workspace to use the Ribbon Interface, as opposed
to a legacy Menu view
 Zoom To Fit in Run mode: enables the Zoom To Fit function which ensures that objects
within the picture do not change their position and dimensions even when the picture is
brought to a new screen resolution, which is different from the resolution on which the
picture was developed. Zoom to Fit does not change the location of the objects/shapes
within the picture, but scales the picture for viewing only
 Enable High performance HMI Graphics: select this check box to create High-performance
graphics for export to Operations Hub, or to create High-performance iFIX pictures that use
the High-performance color set and the High-performance settings for shapes and picture
creation
Figure 7-14. User Preferences – General page
7-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
Shape Preferences
The Shape Preferences page has various options to set the defaults used by new object
instances.
For example, when a rectangle is drawn, its colors, its fill style, its edge style, and width etc.
Default font for text objects, default sizes and properties of pipes, and other text and
datalink options.
If these properties are configured to design defined common values before development
commences, fewer modification will be required later.
Figure 7-15. User Preferences – Shape Preferences
GFS-154K
Education Services
7-15
Proficy iFIX Fundamentals - Pictures and Templates
Picture Preferences Page
The settings on this tab will govern how default “Untitled” pictures will be created. These
settings will be applied to all new pictures, but not existing ones.
Figure 7-16. Picture Preferences page
In addition to the standard Picture qualities, the Picture Cache size can be set here. This
refers to the combined size of the temporary FIFO cache size and the permanent cache.
Tip
For help on these picture characteristics, highlight a field and press F1
7-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
StartUp Pictures Page
When Start Workspace in Run Mode is enabled on the General tab, this list of documents
will be opened automatically. These items can be pictures or schedules and there can be as
many as needed. The order they are listed is also the order in which they are opened, with
items further down the list being opened on top of items higher in the list.
Figure 7-17. Startup Pictures page
GFS-154K
Education Services
7-17
Proficy iFIX Fundamentals - Pictures and Templates
Troubleshooting Topic
Picture Dimensions can be a source of frustration if forced to view in resolutions or ratios
which are different to how the picture was designed.
Enhanced Coordinates does take much of this frustration away.
Establishing a good understanding of Enhanced Coordinates, with Zoom to Fit, and as we
will see later in this course, certain Picture Navigation methods, will benefit the design
journey.
eBooks Topic
Search the iFIX Online Help and search for “Picture Coordinate”. Look for this topic.
Take a read at this topic when you have time.
Figure 7-18 Online Help – Picture Coordinate
7-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
Lab Exercises – Pictures and Templates
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Set User Preferences.
 Create a set of pictures by modifying a pre-defined configuration.
 Control the Startup of Workspace.
Introduction
Before you create any picture templates or custom pictures, you should set up the design
defaults to speed development and harmonize standards across the whole HMI. These
standards will be used throughout the HMI to provide a consistent look and feel. Think of it
as the HMI branding influencing the styles, the colors, the fonts, even object defaults such
as line widths or fill styles. These can reduce time spent on changes when building the
actual HMI.
The iFIX Fundamentals course system, for our ‘flu fighting pharma factory’ is designed
around a 16:9 ratio layout, with a default 1920 x 1080 resolution. Any pre-configured
pictures and dynamos have been developed with this 1920 x 1080 resolution.
If you are using a different resolution or ratio, then lab exercises will work, however you may
need to resize any objects preconfigured for the class when adding to your own pictures.
iFIX Workspace does have, by default, a Zoom to Fit in Run mode, so any pre-configured
pictures will be scaled to fit. Just something to be aware of.
Lab Exercise #1 – User Preferences - Defaults
1. In an earlier lab exercise, you were asked to place a shortcut to iFIX Workspace on your
Windows Desktop, if completed, double click to start Workspace in Configure mode.
If you did not create the shortcut earlier, go back to Lab 2 in Chapter 4 where this was
added.
iFIX Workspace must now be open in Configure mode to proceed.
2. On the Home Ribbon click on Settings then click User Preferences.
GFS-154K
Education Services
7-19
Proficy iFIX Fundamentals - Pictures and Templates
3. When User Preferences opens, it will show its General page. Make or check the
following settings:
a. Start in Run Mode: check
b. Full Screen in Run mode: check
Since this setting has consequences which will affect all pictures in Run mode a
secondary warning prompt appears, click Yes at the prompt.
c. Zoom to Fit in Run mode: this will already be enabled, be aware of this feature
which will modify the Run mode sizing of pictures and objects if different to the
Configure mode dimensions
d. Remember last filter: check
4. Next, move to the Shape Preferences page.
7-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
5. In Shape Preferences modify as follows:
a. Fade Color: HPLightGray
Color selections, accessible via many tools, will present a palette of colors belonging to
a selected Color Set. Hover over a color with your mouse to display the color names.
b. Background Color: HPOffWhite
c. Edge Width: 2
As discussed in this chapter HP Graphics recommends a simpler set of colors. The High
Performance Color Set is the default when making color selections. An alternate Color Set
can be selected from the drop-down list. Even custom Color Sets can be created. This High
Performance Color Set in our course system has been slightly modified to include a few GE
corporate branded colors. Familiarize yourself with this palette.
GFS-154K
Education Services
7-21
Proficy iFIX Fundamentals - Pictures and Templates
6. Next, move to the Picture Preferences page. In here modify the following:
a. Automatically determine document size: check
This should already be checked by default, ensure it is.
b. Grid Interval: 10
c. Grid Enabled: check
d. Snap to Grid: check
We will revisit more User Preference settings shorty.
7. Click OK now to close User Preferences.
7-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
Lab Exercise #2 – Create a Picture Layout
In this lab you will create a set of three pictures for our course system HMI.
It is important to have an intuitive navigation ability permanently available in the HMI. A
separate picture containing objects used to facilitate navigation is common.
You will create a Header picture for navigation, plus other informative components.
Alerting operators of priority events is also important. It is common to have a these
permanently displayed in its own smaller ‘banner’ type picture.
You will create a Footer picture which will contain a list of priority alarms plus other useful
components.
A third, larger picture will sit between these Header and Footer pictures. This will be the
blank canvas which can be duplicated many times in order to construct the individual plant
process area pictures. This will be the Main picture.
Part A – Picture Creation Wizard
1. In iFIX Workspace, close any open pictures. There will possibly be either an Untitled.grf
picture if Workspace was previously closed, or perhaps the TankTempate.grf left open from a
previous lab exercise. A very useful tool for closing any pictures currently open, whether 1 or
20 is the Close All in the View Ribbon. If prompted Save any of your own pictures.
2. Ensure that Workspace is Maximized. If not click the standard Windows Maximize button in
the Workspace Titlebar.
3. You will now use the Create Picture Wizard to create the three pictures explained above. From
the Workspace button click New then click Picture.
The Create Picture Wizard will open. It is possible to suppress this Wizard, the Introduction
page of the Wizard has a checkbox which if enabled will no longer open the Wizard when a
New Picture is created.
GFS-154K
Education Services
7-23
Proficy iFIX Fundamentals - Pictures and Templates
4. Leave the Wizard Introduction page as shown, with Create Picture(s) from a Predefined
Configuration selected, then click the Next button.
If you did not Maximize Workspace in step 2 above, you will be prompted to Maximize now. Do
this now before proceeding.
5. The Wizard is aware that you already enabled the Full Screen in Run Mode checkbox in User
Preferences. We will make further modification shortly. With the Workspace Appearance the
same as shown below, click the Next button.
7-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
6. The third page of the Wizard presents a library of pre-configured picture layouts, some are
single pictures, some are up to four pictures. Select the Main, Header, Footer set and then
click the Modify Configuration button.
7. With the Main picture highlighted, click the Background Color selector and in the High
Performance Color Set, click to select HPOffWhite, then click OK.
8. Next, click the Sizes tab and modify the following settings:
a. Height: 50
It is important that Height is modified first.
b. Top: 40
GFS-154K
Education Services
7-25
Proficy iFIX Fundamentals - Pictures and Templates
The Sizes tab setting should now look like this:
9. If you Highlight the Header and Footer in turn, there is no need to make any Size changes,
observe the Height of each will have been automatically calculated and set.
10. Back in the Attributes tab, set the Background Color of both the Header and Footer to
HPCharcoal.
11. In the same Wizard page, click the Save As
button and at the New Configuration Name
prompt, enter PlantHMI as the name and click
OK.
7-26
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
12. Next, click the Return to Wizard button, your new PlantHMI layout will be listed and
highlighted. Click the Next button.
13. On the next Select Filename(s) page, type in the simple names of Main, Header and Footer as
shown, then click the Next button.
14. The last page is a summary showing the Configuration layout used, the pictures to be created,
and contains the checkbox once again to hide the Picture Creation Wizard. Click the Finish
button.
The three new pictures will now open in Workspace Configure, with the sizing and
background colors as selected in the Wizard. They will also have a 10 point Grid enabled,
which you set in User Preferences. However due to the picture sizes and the Workspace
Configure layout, with its Ribbons, System Tree etc, you are unable to see the full layout.
GFS-154K
Education Services
7-27
Proficy iFIX Fundamentals - Pictures and Templates
15. In the Home Ribbon, click Full Screen. It is also the fourth tool along on the Workspace Quick
Toolbar.
For the first time you should now see the layout of your HMI in all its glory! Very bare for
now, but you will develop an eye-catching design over the coming chapters and lab
exercises.
7-28
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
Part B – Startup Pictures
1. If still in Full Screen in Configure mode, click Esc on your keyboard to return to the layout with
Ribbons, System Tree etc.
2. Right click on a blank area of the Header picture and select Picture from the list.
The Edit Picture windows will allow editing of several Picture properties, which were
available in the Wizard. Window Width and Window Height shown here are a simple report of
the current Window dimensions. Recall only Document dimensions will actually resize a
picture, modifying these Window dimensions in this Edit Picture window has zero effect.
3. If you selected the wrong Background Color when creating the Header in the Wizard, modify it
here. Do not make any other changes. Click OK to close the Edit Picture Window when done.
4. Open User Preferences again as you did in Lab 1. From the Home Ribbon, click Settings then
choose User Preferences.
5. In its Startup Pictures page, click into the first row (it will turn blue) on the right side then
click the ellipses button.
GFS-154K
Education Services
7-29
Proficy iFIX Fundamentals - Pictures and Templates
6. In the Open window which will appear showing all Picture (GRF) files in the projects \PIC\ path,
select the Header.grf picture from the list and then click Open.
7. Back in the Startup Picture page of User Preferences, click into the second row, under the
Header.grf entry to reveal the second row ellipses button. Again, click the ellipses button to
browse and add a second picture, this time Footer.grf.
8. Repeat again to add the Main.grf picture. The list will look this this:
Note at the top the statement “Pictures to open when Workspace starts in Run mode”. Thus
if Workspace start in Configure mode, these picture will not open.
9. Click OK now to close User preferences.
7-30
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
10. Next to test, close Workspace. Either the familiar X at the top right as per any Windows
application, or from the Workspace button, click Exit.
11. Lastly from the Workspace Desktop shortcut you created earlier Start Workspace.
Workspace will open in Run mode with the three HMI pictures you created in this Lab
exercise.
12. Switch back to Configure mode, recall Ctrl-Q is the keystroke on the training course system.
Ctrl-W is the default but may close your browser.
GFS-154K
Education Services
7-31
Proficy iFIX Fundamentals - Pictures and Templates
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 7 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
7-32
Education Services
GFS-154K
Proficy iFIX Fundamentals - Pictures and Templates
Review Questions
1.
What are three design considerations to keep in mind when designing displays?
2. What are the three document types native to the Workspace?
3. What does iFIX offer to assist in designing a system which minimizes visual distractions
and irrelevant information to the operator?
4. What does Zoom To Fit in Run mode achieve?
5. What does Update Picture Location do?
Electronic Books Research
6. What are picture layers?
GFS-154K
Education Services
7-33
Proficy iFIX Fundamentals - Pictures and Templates
Review
Now that you have completed this module, you should be able to:
 Use the Workspace to build iFIX HMI pictures
 Use the Create Picture Wizard to develop picture templates
 Configure Workspace User Preferences
7-34
Education Services
GFS-154K
0)
08
INTRODUCTION TO WORKSPACE
a
At the end of this module, you will be able to:
 Describe the tools in the Workspace
 Utilize graphic shapes and tools
 Build displays
40%
Proficy iFIX Fundamentals - Introduction to Workspace
8-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to Workspace
HMI
Overview
The Workspace is the main visualization tool for iFIX. While it provides the tools and
applications required to develop the operator interface for the SCADA system, it also
provides a central management interface for all the iFIX applications used to develop a full
SCADA/HMI project.
The Workspace has two modes to allow easy and effective development, operation, and
maintenance.
Workspace Configure mode allows iFIX content to be created or edited while the rest of the
system continues running.
Workspace Run mode allows run-time execution of iFIX documents and scripts. These two
modes can be toggled, on the fly, to provide quick feedback and testing during
development, or quick development access during maintenance efforts.
Operator displays, historical trending, alarm summaries, VBA scripting, navigation and
reporting interfaces are features built in the Workspace.
Figure 8-1. The iFIX Workspace (Configure mode)
The main components of the Workspace are:
 The System Tree
 Ribbons
 Toolbox / Toolbars
 Documents
GFS-154K
Education Services
8-3
Proficy iFIX Fundamentals - Introduction to Workspace
Workspace Orientation
The Workspace has a wide variety of tools to assist with development and maintenance of
iFIX systems. The following is a quick orientation to the tools available in Configure mode.
The System Tree
The System Tree is available only in Configure mode. In addition
to being a valuable display management tool, it is a project
explorer for the entire iFIX project. All of the major iFIX
applications may be launched from the System Tree.
Each of the branches in the System Tree may be expanded to
show contained elements such as configuration files,
applications, or other essential documents. Depending on the
document type, individual elements within the document may
also be browsed using a drill-down capability. Many items have
a right-click menu that grants access to configuration choices or
actions.
The System Tree can be docked or undocked from its position in
the Workspace using the mouse (click and drag). Once
undocked, it can be resized and moved.
Key Tools
 Database: PDB files and Database Manager
 Dynamo Sets: reusable graphic symbols
 Globals: shared variables, threshold tables and objects
 Help & Information: iFIX eBooks
 I/O Drivers: I/O Driver configurations and Configurators
 Pictures: operator displays and display contents
 Security: Login and Setup
 System Configuration: SCU and configuration files
 Tag Group: shared displays and tag lists
Figure 8-2. Workspace System Tree
Note
The System Tree can be customized to remove or add folders, applications, and
documents. For more information, search the Online Help for "Customizing the
System Tree".
8-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to Workspace
Workspace Ribbons
Unlike the System Tree, the Workspace Ribbons are primarily focused on Workspace
documents and objects such as displays, dynamos and shapes. In order to assist the
developer, some of the tools available may change depending on what objects are selected.
Home Ribbon
Figure 8-3. Workspace Home Ribbon
This Ribbon contains Clipboard, Workspace, New and Editing Tools.
This is a very useful Ribbon giving quick access to Switch to Run, the VB Editor, Full Screen
in configure mode, ability to Show or Hide the System Tree, the Status Bar and the Toolbox.
New Schedules or Dynamo Sets can be created, and the Create Picture Wizard initiated.
Various useful Editing tools can be accessed too, the Find and Replace is very useful when
mass editing sources configured in a picture. Notice the key accelerators which appear on
the mouse over tooltip, especially for Undo (Ctrl+Z), copy (Ctrl+C), paste (Ctrl+V) and
duplicate (Ctrl+D).
Insert Ribbon
Figure 8-4. Workspace Insert Ribbon
This Ribbon contains Shape, Objects/Links, Connectors, Charts, VisiconX and Scheduler
Tools.
A display designer can select from the available shapes and objects from the Insert Ribbon.
Some objects will provide a stamping tool that adds objects of pre-defined size and shape;
others will provide a cross-hairs tool that allows the designer to create the shapes with
mouse drags and clicks.
Many of these objects are also available by default in the Toolbox, but it is always handy to
be able to insert objects with more than one tool.
GFS-154K
Education Services
8-5
Proficy iFIX Fundamentals - Introduction to Workspace
Tools Ribbon
Figure 8-5. Workspace Tools Ribbon
The Tools Ribbon contains again many tools from the Insert Ribbon. Additionally, there are:
The Animations tools provides the user with the common animation experts for the
currently selected object. This includes things such as color, filling, rotation and motion.
The Task/Experts tools provides the user with the Command experts which automatically
create the VBA code required for selected functions.
The Data Entry Expert provides a selection of ‘off the shelf’ input methods when writing to
I/O values.
The Picture tools allows the user to create and modify properties of Pictures.
The Dynamos tools to build and update iFIX preconfigured objects known as Dynamos.
Chart Groups tools and the VB Editor can also be accessed in the Tools Ribbon.
Operations Hub tools to access the Toolbox and the Publish Picture tool for use with
Operations Hub.
Format Ribbon
Figure 8-6. Workspace Format Ribbon
The Format Ribbon contains again many tools from the Insert Ribbon.
The Styles tools allow modification of the object’s Fill, Edge and Background properties.
Color Selections will open a dialog box displaying the current color set. Standard palettes
plus Custom and HP Color Sets can be selected. These colors can be applied to any object
that uses color
The Arrange tools help designers quickly draw displays with precision and order with
functions such as Bring to Front, Send to Back , Group, Align, Flip, Space Evenly and Make
Same Size. A Grid can also be applied to the current open picture, Fonts can also be
modified here.
The Picture tools provide designer even more ways of manipulating the current picture to
assist in development.
8-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to Workspace
View Ribbon
Figure 8-7. Workspace View Ribbon
This Ribbon contains Picture, Show/Hide, Zoom and Window Tools.
Picture Tools for Viewing, setting Window location and resizing pictures and enabling or
disabling the Grid.
Show or Hide the Status Bar and System Tree.
The Zoom tools allow the designer to Zoom into the picture in Configure mode, whilst still
able to edit any object or property of the picture. Zoom to Fit is for Viewing only, i.e. no
editing is possible, and shows the picture in its Runtime Zoomed to Fit dimensions and scale.
The Window tools allow the designer to position and switch open documents.
Applications Ribbon
Figure 8-8. Workspace Applications Ribbon
This Ribbon contains shortcuts to various iFIX Applications
such as the Configuration Hub, SCU, Security
Configuration, OPC UA Configuration, Utilities then
Process Database.
The Utilities section contains Alarm History and other
project applications.
The Utilities tools dropdown provides the designer other
picture tools and applications. In particular the Upgrade to
Enhanced Coordinates and Button Caption Convert
tools, for when upgrading iFIX from a version of iFIX
without Enhanced Coordinates.
Figure 8-9. Utilities
GFS-154K
Education Services
8-7
Proficy iFIX Fundamentals - Introduction to Workspace
Administration Ribbon
Figure 8-10. Workspace Administration Ribbon
This Ribbon provides access to Change Management and Historian.
Change Management is a legacy version change control application which iFIX can be
easily integrated with. This is an additional license to iFIX. Its tools can be accessed here.
Historian tools can be accessed here for:
 Historical Migrating of data from Classic Historian or Advanced Historian
 Configure Historian Server , assigning the default server and collector with this iFIX node
 Configure VisiconX for use with Proficy Historian
 Historian Administrator - access the thick client, if installed locally, the external tool to fully
administer the Historian Server.
8-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to Workspace
Toolbars and the Toolbox
As a quick alternative to using the System Tree or Ribbon Tools, iFIX makes numerous
toolbars available to assist with development. Like the System Tree, toolbars can be
positioned within the design environment (this can be very helpful when editing in Full
Screen mode). The Toolbox is a set of common tools, which also can be customized, that is
visible only when the user is working with pictures.
When using the Workspace Menu layout as opposed to the default Ribbon layout, most
Toolbars can be docked. The Toolbox however is permanently undocked.
Toolbars
Figure 8-11. Access Toolbars
Toolbars can be added, removed, and edited by
selecting Toolbars in the Home Ribbon’s
Settings. The Toolbars dialog box will appear,
showing all available toolbars that have been
selected for use. Toolbars can belong either to
the Workspace application, in which case they
will always be visible, or to Picture documents,
where they will only be visible when a picture is
open for editing. Select the owner and then add
or hide available toolbars by checking the box.
Figure 8-12. Enable / Disable Toolbars
GFS-154K
Education Services
8-9
Proficy iFIX Fundamentals - Introduction to Workspace
Custom Toolbars
The Customize button will allow creation, import, or edit of toolbars and buttons.
The Toolbars tab facilitates this.
If toolbars were created in another project, they may be imported to the current project in
three easy steps.
 Copy the toolbar .TBX file to the project LOCAL path.
 Navigate to the customize toolbars dialog.
 Import the toolbar and assign it an owner.
Figure 8-13. Customize Toolbars
The Buttons tab will allow addition and removal of existing buttons from toolbars (and the
Toolbox), and with some VBA skill, the developer can even create new toolbar buttons to
assist with rapid development. Each category contains its own group of buttons, usually
with similar functions (the button description will explain the button’s duties). These buttons
can be dragged from the dialog box and dropped into any toolbar (including the Toolbox).
To remove buttons, simply drag the button from the toolbar when this dialog is open.
Figure 8-14. Customize Toolbars - Buttons
8-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to Workspace
Building Displays
Creating Shapes
The Workspace supports a number of flexible shapes and editing
functions to help designers quickly and easily create high quality
graphical interfaces. These shapes can be added from the Insert
Ribbon, from the Toolbox or from a separate Shapes toolbar.
Some objects will provide a stamp tool to add objects of pre-defined
size and shape, others will provide a cross-hairs tool that allows the
designer to create the shapes with mouse drags and clicks.
Figure 8-15. The Toolbox
The common graphic shapes can be created either from the
Toolbox or from Shapes on the Insert Ribbon.
Such as:
 Rectangle
 Rounded Rectangle
 Oval
 Chord
 Polygon
 Pie
 Pipe
 Arc
 Line
 Polyline
Figure 8-16. Shapes
Font
Font characteristics for individual or multiple text
shapes may be changed using the Font Dialog.
(Using the CTRL key with the mouse will select
multiple shapes).
Figure 8-17. Font Dialog
GFS-154K
Education Services
8-11
Proficy iFIX Fundamentals - Introduction to Workspace
Color
Color can be set for a shape’s foreground, background, edge, or fade characteristics. As
with the Font tool, multiple shapes can be set at once. The Color Selections tool can also
remain open while additional shapes are chosen and edited.
This is accessed from the Toolbox, the Format Ribbon or on an object’s right click menu for
most objects.
Figure 8-18. Toolbox Color Tool
Figure 8-19. Object Right Click Menu – Color options
Tip
 Use Dynamos Sets whenever possible to speed display development
 Select multiple shapes: CTRL + mouse
 Move shape: Arrow keys, or SHIFT+ Arrows
 Resize shape: CTRL+ Arrows
 Duplicate shape : CTRL+D, or CTRL+Click+Drag on existing shape
 Group multiple shapes : CTRL+G
 Drill into grouped objects : SHIFT+Click
 Undo : CTRL+Z
 Perfect Square or Circle : CTRL+Click+Drag for new Oval or Rectangle
 Save Display : CTRL+S
 Toggle Configure/Run mode : CTRL+W
 Always remember the right-click menu
8-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to Workspace
Troubleshooting Topic
WYSIWYG. Developing iFIX Pictures sometimes requires access to many components and
tools.
Being able to carry out development, and actually seeing in Configure Mode what you will
see in Run Mode, can take some effort.
Zoom to Fit in Run mode is useful in Run mode, but problematic in Configure mode if the
development and display resolutions are different.
Workspace Configure in the View Ribbon does offer a Zoom to Fit (Ctrl-M) tool. This is a
quick view tool. When zoomed to the Run mode ratio, it is not possible to modify the picture
or its objects.
There is no easy answer other than develop in the ratio and resolution that typically the HMI
will use in Run mode.
Develop in Full Screen in Configure mode. Use an Undocked System Tree. Use the Toolbox,
or better still create a custom Toolbar with all the common tools that are needed for
development.
Figure 8-20. Full Screen Configure mode, Undocked System Tree, Custom Toolbar
GFS-154K
Education Services
8-13
Proficy iFIX Fundamentals - Introduction to Workspace
eBooks Topic
Building Customized Toolbars can assist a developer as a time saving tool. Instead of having
to access tools from multiple locations be they existing toolbars or Workspace Ribbons,
commonly used tools could be added to a custom toolbar.
Search the iFIX Online Help and search for “Customizing Toolbars”. Look for this topic and
browse the related topics, especially the steps to add customized toolbars.
Take a read at this topic when you have time.
Figure 8-21 Online Help – Custom Toolbars
8-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to Workspace
Lab Exercises – Introduction to Workspace
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Use various Workspace Tools and features.
 Access data from a remote SCADA node.
 Create a Template picture for future use.
 Begin development of a navigation picture.
 Begin creation of the Ingredient Process area picture though addition of shapes and
dynamos.
Introduction
Using some of the iFIX Workspace tools discussed in this chapter, as well as those used
previously, you will modify your TankTemplate picture created in an earlier lab exercise, to
access data from a remote SCADA node in the classroom.
You will then begin the creation of a new picture to represent the Ingredients Process area
of the course system. You will subsequently build on this in the next few chapters of the
course. You will then add some pre-configured dynamos and objects to your Header picture,
this will eventually become the primary navigation tool, but will present other useful
information such as process area statuses, plant status and security information.
Lab Exercise #1 – Access a Remote iFIX SCADA Node
1. Ensure that iFIX is running and that Workspace is open in Configure mode.
2. If any pictures are currently open, close using Close All on the View Ribbon.
3. In the System Tree, expand Pictures and locate the TankTemplate picture created in an
earlier lab exercise.
Double click on TankTemplate in the System Tree to open it.
4. We will require both the System Tree and the Toolbox for this lab exercise, if either are not
open right now, from the Home Ribbon, click Show/Hide and then check each in turn to
open. NOTE: the Toolbox will only appear if a picture is already open.
GFS-154K
Education Services
8-15
Proficy iFIX Fundamentals - Introduction to Workspace
5. With the TankTemplate picture open, click the Switch to Run button from the Home
Ribbon, or in the Quick toolbar. (Recall Ctrl-W may close your browser. If you have
connected to your student computer using an RDP link or your browser is unaffected, then
by all means use Ctrl-W instead).
6. As tested before, this Tank Template should have a level which is filling – 0 to 100%.
The Datalink on the right shows the level numerically.
The top left inlet pump if clicked, will toggle its state between Stopped to Running,
indicated by a text value and a gray or green central color.
The outlet pump will also toggle when clicked, with the same color change and text label,
but has no effect on the tank level (it’s a very simple simulation source!)
7. Switch back to Workspace Configure mode using the Ctrl-Q custom keystroke. Again, if
you have connected to your student computer using an RDP link or your browser is
unaffected, then by all means use Ctrl-W.
8. Using your cursor, draw a box around all objects in the picture, you are simply selecting
all objects inside this frame. (Ctrl-A will have selected all picture objects which for this
picture would also have been acceptable). With all selected, click Ctrl-G on the keyboard.
This is the Group shortcut. You now have a single Group containing all if these objects.
9. Next, with this group highlighted. Click Ctrl-D on the keyboard. This is the Duplicate
shortcut. A second group will appear slightly
to the right of the first group.
10. Now, from the Home Ribbon, find and click
Full Screen, it is also in the Quick toolbar.
11. Drag the new duplicate group to the right.
8-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to Workspace
Your Full Screen in Configure Mode layout should now look this this:
12. We will be replacing the sources in this right hand tank so that the data comes from an
alternate student’s SCADA server on the class network.
Recall that you added a Networked node in your SCU in Chapter 2 Lab 1.
If you do not remember which node you connected to, open the SCU to check.
This will be SCADA# where # is the alternate Students number.
13. Click to highlight only the right hand group representing the Tank, Pumps and Datalinks.
14. With it selected, click Ctrl-F on the keyboard. This will open the Find and Replace tool,
which is also available on the Home Ribbon – look for it later, but since you are in Full
Screen in Configure mode, keystrokes are easier.
15. In the Find and Replace window go to the Replace tab. Configure as follows:
a. Find what: *.thisnode.* (NOTE: This is not case sensitive by default, there is a Match
Case checkbox)
b. Replace With: *.SCADA#.* e.g. SCADA2 (the alternate node added in your SCU –
Networking)
c. Include Scripts: check
d. Then click the Find button
GFS-154K
Education Services
8-17
Proficy iFIX Fundamentals - Introduction to Workspace
16. The Match List will populate with all datasources and scripts containing THISNODE.
Always check the Property Value column to make sure it has found what you expected it
to find.
Then click the Replace Preview button.
17. Always carry out this Replace Preview and check the Replace Value With column to
ensure the replacement values are what you expected. Drag the Column headers and the
window to view.
Only then click the Replace All button.
18. The list will now clear. Click the Close button.
19. Click Ctrl-S on the keyboard to Save the picture. Yes, you could use the Workspace button
or Quick toolbar to perform the save.
20. Let’s test this remote data connection. Switch to Run as before, and check that the right
hand tank now has data independent from the left hand tank. You are now observing and
controlling data sources from another student’s SCADA server!
21. If you see an error popup message and the datalinks show @@@, and the pump color is
red, then you have not connected to the remote node.
22. As the message indicates, check your SCU. Or make sure the picture has the correct
remote node name, check your spelling.
23. Switch back to Configure mode, Ctrl-Q, then Save and close all pictures.
8-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to Workspace
Lab Exercise #2 – Start to Create the HMI Pictures
Introduction
We have configured most of the SCADA components of our flu fighting pharma factory! Now
it’s time to design and develop our HMI environment. We will begin a display for the
Ingredients Process Area.
You will build the Ingredients picture from the Main picture, this will preserve the size,
location and background color. Then you will modify the Tank Template group already
created, adding additional shapes, dynamos and text.
Part A - Create the Ingredients Process Area Picture
1. Ensure that iFIX is running and that Workspace is open in Configure mode.
2. Open the TankTemplate picture created earlier. You should now start to become familiar with
using the System Tree to access pictures and other HMI components.
3. From the Workspace button, click New, then Create, then Dynamo Set.
4. With this new Untitled.fds Dynamo set open, drag and drop the left hand Tank Group from the
TankTemplate picture into the Dynamo set.
GFS-154K
Education Services
8-19
Proficy iFIX Fundamentals - Introduction to Workspace
5. At the Add Objects to Dynamo Set prompt, select Add to Dynamo Set As-Is, then click OK.
A Master Dynamo is the alternate, which will allow mass updated of potentially 100’s of
already deployed copies of the Dynamo. We are using As-Is, effectively the Dynamo Set is
simply an easily accessible storage location for this Tank. Using the Dynamo set for what we
are doing in this lab is not necessary, but now you know how to create your own Dynamo
Sets and add objects to them!
6. Next, from the View Ribbon, click Close All. You will be prompted to save the Untitled Dynamo
Set. Click the Yes button then supply a name of MyDynamos.
7. Now we want to undock the System Tree. Left
click and hold on the top of the System Tree
and drag to the right. It is now undocked.
8. Next, from the Home Ribbon (or Quick
Toolbar) click Full Screen. You can even go
ahead now and close the Close Full Screen
button, it’s just taking up space. Esc on the
keyboard will also close full screen.
9. Expand the Pictures folder in the System Tree, then double click on the Main picture.
This picture has the perfect dimensions, location and color we require for all ‘Main’ screen, i.e.
plant process area pictures. So, we will make it a template.
10. Click Alt on your keyboard.
You are in Full Screen in Configure mode, however this keystroke will pop in the Ribbons to
quickly get to all tools. From the Workspace button (you know where it is by now) choose
Save As.
Name the new copy as Template.grf. When you click Enter on your keyboard to commit the
Save As notice you are returned back to Full Screen in Configure mode once again. Uselful!
8-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to Workspace
Yes, this is a Template picture, so you would only ever permanently add components that
will be common across all pictures, otherwise you will leave it blank. Some underlying VBA
scripts may be useful on every picture, however its way to early on the course to dive in
with VBA!
11. From the Workspace button (after clicking Alt again) choose Save As once more. This time
save the picture as Ingredients.grf.
12. Now from the System Tree, expand Dynamo Sets and then double click on your MyDynamos
set created above.
13. Drag in from the MyDynamos set the Tank group and drop into this new Ingredients picture,
then close the MyDynamos set.
14. Right click on the Tank Group and click Ungroup Objects. Your layout should now look
something like this:
Firstly, you will add some text labels and 2 x simple shapes - rectangles which will be
animated and controllable later for the Inlet Switch and Inlet Rate sources.
15. Using the Text tool from the Toolbox, add a label for the Unit
name of Cellulose_E463 and a label for the Inlet processes.
16. Then add 2 x rectangles, one
longer than the other. Depending
upon the size of your original
tank, you will need to re-size so
all fits in the Ingredients picture.
Shortly it should look like:
GFS-154K
Education Services
8-21
Proficy iFIX Fundamentals - Introduction to Workspace
17. With the first new rectangle selected, click the Color tool from the Toolbox, and with the
ForegroundColor Property set, choose the HPBrightGreen color in the High Performance
Color Set:
18. Then highlight the second rectangle and set the Foreground Color to GEAqua (1 in from top
right in the color set).
19. Next add similar text label and the same sized rectangles under the tank for the Outlet label.
For speed, duplicate the Inlet objects and double click on the text object to modify its caption.
Resize, adjust fonts styles and colors if you wish. After these cosmetic tweaks, it should look
like this:
20. Keep clicking Ctrl-S regularly to save the Ingredients picture.
21. Next, add a vertical line object. From the Toolbox, click the Line tool
and place it
vertically to the left of the Tank. Use the example on the next page as a guide.
22. Add another line, this time Horizontal towards the top and to the left of the vertical line.
23.Next, locate on the System Tree, in Dynamo Sets, the HP_Plant Dynamo Set, double click to
open it.
24.The first object is named grpIngredients. Its name can be seen in the System Tree. Drag this
grpIngredients object and place in the top left of the Ingredients picture.
25. Now add a new text label, next to this grpIngredients object with a caption of Ingredients.
8-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to Workspace
26. Finally, reposition and resize as needed the objects, especially the Tank and its labels etc. to
the left of the Ingredients picture similar to the picture on the next page.
You will be adding a total of 6 x tanks to this display.
The Ingredients picture should now resemble this example below. You can make cosmetic
tweaks along the way:
27. Save and close the Ingredients picture for now.
28. Close, no need to save, the HP_Plant Dynamo set.
GFS-154K
Education Services
8-23
Proficy iFIX Fundamentals - Introduction to Workspace
Part B – Modify the Main Picture as the Plant Overview
1. Ensure that iFIX is running and that Workspace is open in Configure mode.
2. In the System Tree locate and open the Main.grf picture.
3. Also, in the System Tree locate under Dynamo Sets the HP_Plant Dynamo Set. Double click
to open it.
4. From the Home Ribbon, as before, click Full Screen.
5. In turn drag each of the group objects, from grpIngredients, to grpUnderConstruction in this
HP_Plant Dynamo Set and drop into the Main picture.
6. Add a text label to each for the process areas of:
a.
b.
c.
d.
e.
f.
Ingredients
Blending
Granulation
Packaging
Energy Plant
Under Construction
7. Add simple vertical dividing lines for aesthetics.
8. When complete, Save and close this Main picture.
9. Close, do not save, the HP_Plant Dynamo set.
8-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to Workspace
Part C – Modify the Header Picture as the Navigation and Info Display
1. Ensure that iFIX is running and that Workspace is open in Configure mode.
2. In the System Tree locate and open the Header.grf picture.
3. Also, in the System Tree locate under Dynamo Sets the HP_Class Dynamo Set. Double click
to open it.
4. From the Home Ribbon, as before, click Full Screen.
5. The first object to drag into the Header is the grpHeader object. Drag to the very top of the
Header picture.
Use the example on the next page as a guide.
6. Next, drag and drop the bmpHome object and place to the far left of the picture.
7. Now, drag and drop the UnitButton object.
8. For the first one when prompted, set the Process Unit as Ingredients. Do not
yet modify the Status Tag(F_CV), leave at its default. Click OK.
9. Repeat to add another 7 x UnitButton objects, setting the Process Unit to:
a.
b.
c.
d.
e.
f.
g.
Blending
Granulation
Packaging
Energy
Analytics
Alarms
System
Use the example on the next page as a positioning guide.
GFS-154K
Education Services
8-25
Proficy iFIX Fundamentals - Introduction to Workspace
10. In many real world plants, works may be on going. In our course system we will have some
‘Under Construction’ process areas that will be visited in the iFIX Advanced course.
For now, Add 2 x Under Construction buttons. Use the UnitUC buttons from the HP_Class
Dynamo Set.
At the prompt leave Process Unit at its default of Unit and click the OK button.
11. Save the Header picture. Click Ctrl-S.
12. Close the HP_Class Dynamo Set for now.
13. Next, again under Dynamo Sets, locate and open the GE_Icons Dynamo Set.
The Unit Button dynamo was generic in its appearance, this allowing 1 object for many
purposes, you simply modified its text Unit name. To add some visual references, you will
add the relevant icon object to each Unit button in the Header picture.
14. From this GE_Icons Dynamo set drag and drop the relevant icon onto its Unit button:
a.
b.
c.
d.
e.
f.
g.
h.
Ingredients Unit button: bmpIngredients
Blending Unit button: bmpBlending
Granulation Unit button: bmpGranulation
Packaging Unit button: bmpPackaging
Energy Unit button: bmpEnergy
Analytics button: bmpAnalytics
Alarms button: bmpAlarms
System button: bmpSystem
15. Close the GE_Icons Dynamo set when done.
16. Next from the Toolbox locate the Date and Time objects and add them each in turn onto the
banner at the top of the Header picture.
17. Lastly Save the Header picture and close Workspace.
Then from the desktop shortcut, start Workspace.
The Header and Main pictures, now partly populated, will open along with the still empty
Footer.
8-26
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to Workspace
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 8 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
GFS-154K
Education Services
8-27
Proficy iFIX Fundamentals - Introduction to Workspace
Review Questions
1.
In which Workspace Ribbon will you find the Dynamo Tools?
2. How do you customize toolbars?
3. How can a user create unique color sets?
4. What tool can be used to browse pictures and drill-down into groups and objects?
5. Where can a user define default settings for shapes and text?
Electronic Books Research
6. Use the eBooks to run a search on the Find and Replace tool.
Try running a Search on the words Find and Replace ( no speech marks) and then a
second search with the phrase “Find and Replace” ( in speech marks).
(a) What was the difference in the search results and
(b) what is the keyboard accelerator for the Find and Replace tool?
8-28
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to Workspace
Review
Now that you have completed this module, you should be able to:
 Describe to the tools in the Workspace
 Discuss graphic objects and properties
 Build displays
GFS-154K
Education Services
8-29
Proficy iFIX Fundamentals - Introduction to Workspace
8-30
Education Services
GFS-154K
0)
09
GRAPHIC OBJECTS
a
At the end of this module, you will be able to:
 Define Objects and Properties
 Use the Property Window
 Add DataLinks to display
 Explore the Expression Builder
 Discuss Tag Status and Quick Trend
45%
Proficy iFIX Fundamentals - Graphic Objects
9-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Graphic Objects
HMI
Overview
Thus far we have referred to most of the things created in the Workspace as shapes or
documents. These things are best described with a set of characteristics that can be edited
or animated. A more formal classification of these things is required so that new topics can
be discussed.
The Workspace is an object-oriented application that supports an object-oriented scripting
language. Therefore, to make the most of these powerful features, it is important to
understand objects and their properties.
Figure 9-1. Pictures with objects
Example properties
1. Text with Font Style
2. Datalink (text) with Foreground Color
3. Polygon with Fill Style
4. Line with Edge Width
5. Chart with duration
GFS-154K
Education Services
9-3
Proficy iFIX Fundamentals - Graphic Objects
Objects and Properties
Understanding objects and properties is essential for iFIX HMI development beyond the
most basic features.
Objects
Objects are individual units or components within an application. They are comprised of
properties and behaviors that make them unique. When an object is created, it provides
information about its properties and behaviors to the parent application in order to allow the
properties to be edited. Though many objects have a graphical nature, not all objects can
be represented visually.
Objects must be given a unique name in order to be properly identified by the parent
application.
Examples of objects in the Workspace are:
 Pictures, Schedules, and Dynamo Sets (document objects)
 Rectangle, Oval, Polygon and Text objects (simple graphical objects)
 Chart and Alarm Summary objects (complex graphical objects)
 Animation and Data objects (invisible, non-graphical objects)
Properties
Properties are the characteristics that describe an object and enable/disable certain
behaviors. Some properties are common to many objects, whereas other properties are
singular to specific object types.
Examples of properties are:
 ForegroundColor, Height, Width, RotationAngle and Visibility (appearance properties)
 IsSelectable, HighlightEnabled, GridEnabled (behavior-enabling properties)
By changing object properties, the designer will change the appearance and duties of an
object.
Examples of property editing tools:
 Color Selections dialog, Font dialog (text only), the Align and Flip formatting tools
 The mouse, used to edit height, width and position
 Object and Format menus, as well as the right-click menu
 The Toolbox and various toolbars
 The Property Window
9-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Graphic Objects
Property Window
The Property Window can be accessed with the F4 key,
or by using the right-click menu on an object, or from
the Properties tool in the Home Ribbon.
The Property Window is a tool that lists the editable
properties for any object. Properties can be edited
from within the list, or by using the variety of editing
tools available in the Workspace. Depending on the
property, the user can browse from a list of valid
settings, open another editing tool, or supply a unique
value. The F1 key will offer help for the highlighted
property, as well as examples of valid entries.
Editing Properties
The Property Window is available in Configure Mode
and can show and edit properties for only one object at
a time. However, the Property Window is non-modal or
modeless, so it can be left open while the user selects
other objects in the picture. Each new selection will
refresh the Property Window with the property settings
for the newly selected object.
Figure 9-2. Property Window
Objects can be chosen from the drop-down list at the top of the dialog. This provides the
unique object name in bold, and the object class (i.e. family or type) in regular text.
Properties can be sorted alphabetically or by category. Most objects share a set of common
properties such as Name, Color and Description, however the list of available properties will
depend on the properties supported by the object class.
For example, rectangle objects and text objects share Description, Visibility, Height and
Width as properties. Rectangle objects also have ForegroundColor, BackgroundColor and
RotationAngle properties to describe their specific colors and geometry, but no Font
properties, as they do not display text. Conversely, text objects use Font properties to
describe their text, but do not require the same variety of properties to describe color or
geometry.
GFS-154K
Education Services
9-5
Proficy iFIX Fundamentals - Graphic Objects
Object Containers, Grouped Objects and Contained Objects
Documents are both objects and object containers. As such, they have properties of their
own that can be set and edited, but they also provide a platform for other objects to be
built. Every object, visible or invisible, is shown in the System Tree.
Grouped objects and contained objects can be explored with the System Tree drill down
feature, by double-clicking on the group or object or by expanding the “+” in front of the
object.
Graphically, Enter Drilldown is also an option in the right click menu of the group.
When Objects are grouped, they form a Group object with its own properties. These
properties are a logical, generic subset of common properties present in the contained
objects. Setting the properties of the group will result in the setting of the properties of all
the contained objects. To change the properties of a single object within a group of objects,
use the drill down feature to select the object and then use any of the editing tools available.
Objects can be dragged and dropped into or out of groups using the System Tree. Objects
are added to groups by dragging the object from the document to the group in the System
Tree. Likewise, the System Tree can be used to remove objects from a group. Select the
object in the System Tree and use the delete key to remove the object from the group and
the picture. Objects can also be removed from groups without deleting them, simply drag
the object from the group to the Picture document icon in the System Tree.
Crucially, when using the Drilldown feature, either from the right click menu, or when
expanding the group in the System Tree, the object is not ungrouped, and therefore does
not lose any property values, methods or events assigned to the group, e.g. any animations,
any click actions belonging to the group will not be lost.
The Property Window will then present the properties of whatever object within the group
has been selected, no matter if it is one layer down or a hundred!
Figure 9-3. Drilldown of groups
9-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Graphic Objects
Datalinks
DataLinks are specialized text objects that
can be used to display data from tags or
other data sources. DataLinks are
important tools for providing real-time
information to operators in a numeric or
text format. Inserted from either the
Toolbox or from the Objects/Links tool in
the Insert, Tools or Format Ribbons.
Figure 9-4. Adding a Datalink
Figure 9-5. Datalink configuration
Source
The DataLink configuration dialog is used for defining what tag or data source to use, and
how to format the text. The Source field requires the four-part data source syntax
(SERVER.NODE.TAG.FIELD) of the tag and field that the developer wants to display. If just
the tag name is defined, the DataLink will assume FIX32 as the Server, the current SCADA
as the Node and F_CV as the field (numeric current value).
A_ vs. F_
When displaying text, such as the labels used to define each state in a Digital tag, the A_CV
field should be used. A_CV will display the alphanumeric text corresponding to the current
value. Other popular alphanumeric fields are A_CUALM (Current Alarm), A_LAALM (Latched
Alarm) and A_DESC (tag description). F_ fields are used to display purely numeric data.
Formatting
The DataLink can be displayed using Center, Left or Right justification in a numeric or
alphanumeric format. If numeric, the DataLink can display numbers with a specific number
of whole or decimal digits. If alphanumeric, the DataLink can display text with a specific
number of lines and characters per line. Data can also be shown in its raw format, directly
from the tag without any alteration.
Properties
Though the DataLink configuration dialog is helpful for setting up the format of the data it
retrieves, the standard editing tools are used to edit the properties of the DataLink itself,
such as its color, size, and font.
GFS-154K
Education Services
9-7
Proficy iFIX Fundamentals - Graphic Objects
The Expression Builder
Entering data sources for DataLinks can be performed manually, or by using the drop-down
list of recently used data sources. For systems with many tags, sources will often need to
be browsed. The Expression Builder provides an intuitive interface for users to quickly
define all four parts of the data source syntax.
Access the last 10 sources
Open the Expression Builder
Modify the Source Tag
Figure 9-6. Datalink source configuration (Expression Editor Control)
Figure 9-7. The Expression Builder
9-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Graphic Objects
Data Source Syntax
The Data Source syntax can be progressively built using an intuitive tab-pane interface.
Each of the standard iFIX Data Source servers is supported on individual tabs.
The following servers will construct an output which will use the full four-part data source
syntax (i.e. Server.Node.Tag.Field):
 FIX Database: this server is labelled FIX32 in the data source
 Model: although the Asset Model hierarchy is used for simpler browsing,
FIX32.NODE.TAG.FIELD is returned
 Historical: this will be archived data from Proficy Historian. The server alias default value
will be HIST
 Alarm Counters: FIX32.Node.AlarmArea.Counter is used to link to alarm counter information
(very similar to tags)
These servers will use a different syntax:
 Pictures: the syntax will follow a Picture.Object.Property convention
 Globals: User.GlobalObject.Property is used for Global data
 Data Servers: This will follow the naming convention of the OPC Server(s) that are directly
connected to the Workspace
A Check Syntax button verifies that the data source syntax is valid.
Refresh Rate
DataLinks use a refresh rate to determine how often data should be retrieved from the data
source. This information is configured in the Expression Builder when the data source is
originally configured.
Tolerance is used for data sources that use comparisons or evaluations such as “equals”,
“greater than” or “less than” (=, >, <). The tolerance will specify the accuracy required for
equivalence.
Deadband will evaluate whether the data value has changed. Only data values that change
by at least this amount will be refreshed in the picture.
Refresh Rate is the period (in seconds) used by the data source for requesting data
updates. The default for this is 1 second.
Mathematical Functions
The Expression Builder can create more complex equations or evaluations for use with
DataLinks, animations or scheduled activities. The Mathematical Functions button will reveal a
calculator to use with the server data sources. With the mathematical functions, it is
possible to create in situ unit conversion calculations, totals, and percentages. Multiple data
sources can be combined in a single expression to produce the required result.
The standard arithmetic, exponential, logarithmic and trigonometric functions are supported,
allowing fairly complex calculations. The calculated result is displayed in the DataLink.
AND, OR, XOR and NOT functions allow for Boolean evaluations where the result is either
True or False. The comparative functions such as “equals”, “less than” and “greater than” (=.
<, >) also provide a True or False result. These are useful for two-state animations such as
color and visibility, or in schedules for evaluating current conditions and thresholds for
values.
GFS-154K
Education Services
9-9
Proficy iFIX Fundamentals - Graphic Objects
Tag Status, Quick Trend and Tag Control Panel
The Workspace provides three run-time tools for drilling down into objects associated with
tags (such as DataLinks). These tools are available through a right-click menu at Run time.
If a single object is selected, the right-click menu appears with only the Tag Status and
Quick Trend tools available.
If multiple objects are selected, the right-click menu features two stages, the second of
which also provides the Tag Control Panel.
Figure 9-8. Run-time Tag Status
Tag Status
The Tag Status pop-up builds a summary of the data in most of the fields for a tag. A small,
non-configurable real-time trend is available as is alarm information, I/O Address details and
chain navigation (if applicable).
Figure 9-9. Tag Status display for an AI block associated with a DataLink
9-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Graphic Objects
Tag Control Panel
When multiple objects have been selected, the Tag Control Panel may be accessed. It
provides a summary sheet for all the tags associated with the selected objects, as well as
links to the Tag Status and Quick Trend displays (the buttons in the row header).
Figure 9-10. Tag Control Panel display for multiple tags
The Add Row button will add additional tags to the list via the Expression Builder. The CTRL
key will allow the selection of multiple tags, especially useful when deleting extra tags from
the panel or for permanently saving commonly used lists. The Save Tag List and Load Tag
List buttons allow a user to manage permanent lists anytime the Tag Control Panel is open.
Quick Trend
Quick Trend displays can be opened with both single and multiple selections. Like the Tag
Control Panel, it provides the ability to add or delete items from the trend, as well as save
and load permanent tag lists. These lists can be recalled any time a Quick Trend is open.
Figure 9-11. Quick Trend display for an AI block associated with a DataLink
GFS-154K
Education Services
9-11
Proficy iFIX Fundamentals - Graphic Objects
Configuration
In order for these tools to be accessible to the user at run-time, the developer must first
ensure that the IsSelectable property of the object is set to True. Any object with an
IsSelectable property and an association to a real-time tag can be used to launch Tag Status
or Quick Trend displays.
Figure 9-12. Setting the IsSelectable Property in the Property Window
Note
Any object that is selectable will be able to use the Tag Status and Quick Trend
pop-up screens. However, these screens only display information from real-time
database tags, so objects using other data sources will generate a message
denying the pop-up launch
Ensure that your project PIC directory has a sub-directory named TagStatus in it. If
not, copy the TagStatus folder from a project that does.
9-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Graphic Objects
Troubleshooting Topic
When using the Expression Builder and browsing a remote SCADA node for Process
Database tags, there is the possibility of unnecessary network loading. If no filter has been
applied, then potentially 10s of thousands of tagnames may be requested. This could take
quite some time.
Applying a tag filter with * wildcards will reduce the requested tagname down to those who
match the filter.
Figure 9-13. Expression Builder Filtering
Once an initial filter has been applied, it is possible to remember it for next time. This is done
by enabling Remember last filter in the General page of User Preferences.
The very first time the Expression Builder browses tagnames, all are returned, but after a
filter has been applied, subsequently browsing of tags in the Expression Builder will be prefiltered. Simply modify the filter for that instance use.
Figure 9-14. User Preferences – General – Remember last filter
GFS-154K
Education Services
9-13
Proficy iFIX Fundamentals - Graphic Objects
eBooks Topic
Using the Expression Builder with a retained Filter can be very useful in saving time to
browse.
Search the iFIX Online Help and search for “Filtering Data Sources”. Look for this topic and
browse the related topics, especially steps to modify filters.
Take a read at this topic when you have time.
Figure 9-15 Online Help – Filtering Data Sources
9-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Graphic Objects
Lab Exercises – Graphic Objects
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Use the Property Window to make changes to objects
 Add DataLinks to show key process values in both numeric and text formats
Introduction
First you will modify both new and existing objects using the Property Window.
The Ingredients picture requires key values to be presented to the operators. Datalinks will
be added through several methods, whose sources will browsed from both the Asset Model
seen earlier and directly from the Process Database Tags.
Our Ingredients picture has only one of the six tanks so far. You will add the other tanks
required.
Lab Exercise #1 – Using the Property Window
1. Ensure that iFIX is running, and that Workspace is open in Configure mode.
2. Open the Ingredients picture created earlier.
3. Click F4 on your keyboard to open the Property
Window.
If no objects within the Ingredients picture are
selected, the Property Window will present picture
properties, such as Name, Background Color,
AlwaysOnTop and many more that you may already
be familiar with, and some which you are not.
These are all the exposed properties of the picture
object in one place. Any which are editable could be
modified here.
4. Locate the Datalink which in Run mode shows the Running or Stopped Status of the Inlet
Pump. With the Property Window still open, highlight this Inlet Pump Datalink.
Immediately the Property Window will update to show this newly selected objects
properties.
5. Locate the FontStyle property and change to Bold.
GFS-154K
Education Services
9-15
Proficy iFIX Fundamentals - Graphic Objects
6. Next, highlight the Outlet Pump Datalink and also change its FontStyle to Bold.
7. Close the Property Window.
8. Either from the Insert, Tools or even Format Ribbon,
click Shapes then choose the Line tool.
9. Using the cross hairs
draw a horizontal line
underneath the Ingredients label on the left of the
picture.
Use the example shown below as a guide.
10. With this new line highlighted, right click and from the list choose Property Window.
11. In the Property Window for this new line, locate the Edge Color.
Lines do not have a Foreground color. It is the Edge Color which changes the color seen. If the
line Edge Style was changed from Solid to Dash or Dot etc. the Background Color will be
shown between the dots or dashes.
12. Click the ellipses button in this EdgeColor and when the now familiar High Performance
Color Set appears, choose HPGraphite.
13. Next, using the Property Window for this same line, set its EdgeWidth to 1.
14. Keep Saving, Ctrl-S, as you go along!
15. Duplicate this new line five times. Move all of these under the Ingredients label on the
left of the picture, they will become dividing lines between KPIs. Use the example shown
below as a guide.
9-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Graphic Objects
16. Next, add text labels under each of these lines for each Ingredient:
a.
b.
c.
d.
e.
f.
Cellulose E460 (%)
Cellulose E463 (%)
pHStabilizer (%)
Sodium E468 (%)
Stearate E470b (%)
Water (%)
17. Also add a Levels text label at the top. Use the Property Window to set its FontStyle to
Bold.
18. Lastly add five vertical lines which will become Tank dividers, use the Property Window to
set their EdgeColor to HPGraphite, and EdgeWidth to 1.
GFS-154K
Education Services
9-17
Proficy iFIX Fundamentals - Graphic Objects
9-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Graphic Objects
Lab Exercise #2 – Adding Datalinks
1. If still in Full Screen in Configure mode, click Esc on the keyboard to return to the view where
all Ribbons are visible.
2. With the Ingredients picture still open, from the Insert Ribbon click
Objects/Links then Datalink Stamper.
This method of adding a Datalink will immediately present the
Datalink Configuration window, when complete it will add a Datalink
to the picture using the default text size.
3. When the Datalink Configuration Window opens, click the ellipses
button to browse the Expression Builder.
4. The source you will select from the FIX Database is:
Fix32.THISNODE.PROFICYPHARMA>INGREDIENTS>CELLULOSE_E460>TANKLEVEL.F_CV
a. In the Expression Builder select the FIX Database tab
b. From the Node Names list select THISNODE
c. In the Tag Names list you are looking for the Tag:
PROFICYPHARMA>INGREDIENTS>CELLULOSE_E460>TANKLEVEL
d. Since the Tagname is long, you will need to scroll in order to view the whole name
e. In the Field Names list select F_CV, or click the F_* button as this will automatically
pick this field
The Expression Builder output field at the bottom should now contain this full syntax of
SERVER.NODE.TAG.FIELD
Tip
There are some techniques to make this a little easier. Using Model sources instead
or using the Filter tools.
GFS-154K
Education Services
9-19
Proficy iFIX Fundamentals - Graphic Objects
5. Now, click OK to return to the Datalink Configuration Window. Here set the Formatting Justify
to Right.
Then click OK.
6. You will now have the floating stamper attached to your cursor. Move this floating stamper
under the Cellulose E460 (%) label on the left then left click to commit the location.
7. With this new Datalink highlighted, use the Property Window (F4) to modify its
ForegroundColor to GEAqua, and Font to 16 point Bold.
9-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Graphic Objects
8. Next, from the Tools Ribbon click Objects/Links then
Datalink.
This method of adding a Datalink will present the cross hairs
and ask you to draw a location box. This sets the size and
location. Only then will the Datalink Configuration window
appear.
This has overridden any default text size.
9. Draw the location box under the Cellulose E463 (%) label,
and attempt to make it a similar size to the Datalink added in
the last steps.
10. When the Datalink Configuration Window appears, as before
click the ellipses button to open the Expression Builder.
11. This time when the Expression Builder opens, choose the Model tab, then:
a. Select the SCADA dropdown as THISNODE and the Instances radio button
b. Expand ProficyPharma, then Ingredients, then choose Cellulose_E463
c. Then select the TankLevel
That was much simpler than scrolling through a huge list of tags!
Notice the Expression Builder Output window. It has constructed the familiar full syntax of:
Fix32.THISNODE.PROFICYPHARMA>INGREDIENTS>CELLULOSE_E463>TANKLEVEL.F_CV
12. Click OK to close the Expression Builder. Set the Datalink again to Right Justify, then click
OK.
GFS-154K
Education Services
9-21
Proficy iFIX Fundamentals - Graphic Objects
13. The Toolbox also has these same two Datalink tools. Use the Toolbox
Datalink Stamper to add eight more Datalinks. These will be
configured as follows. See the example below for placement.
Or, Duplicate an existing Datalink which has already been sized, and
colored as required.
Pay attention to the Field used, i.e. F_CV for Analogs and A_CV for
Digitals.
Location
Data Source (Model tab)
Field
Justify
Digits or #
Lines
Decimal or
Chars
3
pHStabilizer>TankLevel
F_CV
Right
5
2
4
Sodium_E468>TankLevel
F_CV
Right
5
2
5
Stearate_E470b>TankLevel
F_CV
Right
5
2
6
Water>TankLevel
F_CV
Right
5
2
7
Cellulose_E460>InletSwitch
A_CV
Left
1
8
8
Cellulose_E460>InletRate
F_CV
Left
5
2
9
Cellulose_E460>OutletSwitch
A_CV
Left
1
8
10
Cellulose_E460>OutletRate
F_CV
Left
5
2
14. Using the Property Window, modify all the Level Datalinks to 16 point Font with a GEAqua
Foreground color. (If you duplicated the first Datalink, these properties will already have been
set).
15. Likewise, modify the Cellulose E460 Datalinks to a FontStyle of bold, and change their
Foreground color to HPTrueBlack.
16. Make sure that the Ingredients picture has been Saved, Ctrl-S. Keep Saving!
9-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Graphic Objects
Lab Exercise #3 – Add the additional Ingredient Tanks
1. With the Ingredients picture still open, locate and open from the System Tree, the Dynamo
Set HP_Class. You will want to do this in Configure mode Full Screen.
2. In the HP_Class Dynamo Set, drag into the Ingredients picture the grpIngTank dynamo.
This is a pre-configured grouped object with Tank, Pumps, Switches, Rate sources all
configured but using a placeholder tagname of @IngredientName@.
You may recall this was the Substitution Parameter name used in the Asset Model, however
we will prompt for each Ingredient Tank Source.
3. When you drag in this grpIngTank dynamo you will asked if you wish to update the source.
Click Yes.
4. Next you will be asked for the New Ingredient. Type in Cellulose_E463 then click OK.
This custom dynamo could have been configured to ask you to browse the model in the
Expression Builder, but this a simpler one click, rather than several clicks, solution.
GFS-154K
Education Services
9-23
Proficy iFIX Fundamentals - Graphic Objects
5. Drag in four more copies of this grpIngTank dynamo, but one at a time, and update the New
Ingredient to:
a.
b.
c.
d.
pHStabilizer
Sodium_E468
Stearate_E470b
Water
If you make any errors, e.g. wrong process spelling, it will be much easier to delete the wrongly
configured tank and drag in the dynamo once more.
6. Close the HP_Class Dynamo Set.
7. Position these new Ingredient Tanks inside the divider lines added earlier. See the example
below.
8. Save the Ingredients picture.
9. If you were to Switch to Run mode, you will find that your Cellulose_E460 tank has some
working animations and control with colors to reflect the status of the source tags. However,
the newly added Tanks whilst allowing control of the sources, have objects colored black. You
will see in the Globals chapter how we add common animation colors.
9-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - Graphic Objects
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 9 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
GFS-154K
Education Services
9-25
Proficy iFIX Fundamentals - Graphic Objects
Review Questions
1.
What is an object? Provide three examples.
2. What is a property? Provide three examples.
3. What tool can be used to provide a list of all the editable properties in an object?
4. What tool can be used to sequentially build or browse data sources for Data Links and
other animations?
5. What setting controls how often data is retrieved from data sources, and where is it set?
Electronic Books Research
6. What Raw Format options are available for the Datalink object? Explain both methods.
9-26
Education Services
GFS-154K
Proficy iFIX Fundamentals - Graphic Objects
Review
Now that you have completed this module, you should be able to:
 Define Objects and Properties
 Use the Property Window
 Add Datalinks to displays
 Explore the Expression Builder
 Discuss Tag Status and Quick Trends
GFS-154K
Education Services
9-27
Proficy iFIX Fundamentals - Graphic Objects
9-28
Education Services
GFS-154K
0)
10
DATA ENTRY AND CONTROL
a
At the end of this module, you will be able to:
 Describe DataLink Data Entry methods
 Explore the Data Entry Expert
 Use the Open, Close and Toggle Digital Point
Experts
 Use the Key Macro Editor
50%
Proficy iFIX Fundamentals - Data Entry and Control
10-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Data Entry and Control
HMI
Overview
A critical capability of any SCADA/HMI is the ability to change control set points and interact
with data in the plant floor control devices. iFIX has several standard tools that can be
quickly and easily configured to provide operators with these control interfaces. For a
higher level of customization, VBA scripting can be used.
Most control interfaces are designed for use with a keyboard and mouse. As such, most
control actions are driven by mouse clicks or key sequences. The vital factors are to make
the data entry methods easy and intuitive to use, but also secure and accurate. Always use
F_CV fields when specifying data sources for control as A_CV fields can cause errors.
Some examples of data entry interfaces are:
 DataLink In-Place data entry
 Push buttons
 Sliders and ramp buttons
 Alphanumeric keypads
 Dynamos
 Command experts
 Key macros
Figure 10-1. Examples of a various control interfaces
GFS-154K
Education Services
10-3
Proficy iFIX Fundamentals - Data Entry and Control
DataLink
The DataLink has a built-in data entry mode. It can be configured in its configuration dialog.
In-Place data entry
When In-Place data entry is enabled, a cursor will appear in the DataLink when the user
clicks on it. The keyboard can then be used to change the value. The Enter key is used to
send the command.
Configuration is very simple. Open the DataLink configuration dialog and switch the Data
Entry Type to In-Place. An optional Confirm dialog can be specified to give the operator
feedback about the control action and allow for a last-minute cancellation in case of a
mistake.
Figure 10-2. In-Place Data Entry for DataLinks
Advantages: Minimal configuration is required and since the data entry occurs within the
displayed text, the amount of extra space required for changing set points is minimized.
Disadvantages: The In-Place interface is difficult to find and clumsy to use. It provides no
clues about valid setpoints, and it only allows control of the value that is being displayed (as
opposed to a separate but related tag).
10-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Data Entry and Control
Data Entry Experts
The Data Entry Expert has four distinct control interfaces that can be used for analog and
digital set points. These interfaces are opened via mouse clicks and can be applied to any
target object, not just DataLinks or Push buttons.
Pushbutton
The Pushbutton interface is best for controlling digital tags. The developer will supply the
data source of the target control tag, and button labels for the Open (0) and Close (1) states.
Figure 10-3. Data Entry Expert – Push Button Configuration
Clicking on the target object accesses the Pushbutton dialog at run-time. It provides clear,
intuitive instructions. It can control a tag other than the one being displayed in a DataLink or
other animation.
Figure 10-4. Data Entry Expert – Pushbutton at run-time
Advantages: It is easy to configure and as with all the options in the Data Entry Expert, it
helps create a simple standardized look and feel for control actions. It is easier to use than
a DataLink and is economical in its use of space.
Disadvantages: It still requires multiple clicks to assign values to two-state equipment.
While easy to use, there is no information about what tag is being controlled, or what its
current state may be.
GFS-154K
Education Services
10-5
Proficy iFIX Fundamentals - Data Entry and Control
Numeric/Alphanumeric
This method works well with both analog and digital tags. The developer will supply the
data source of the target tag, as well as guidelines about the validity of inputs.
Figure 10-5. Data Entry Expert – Numeric/Alphanumeric configuration
The developer will specify whether the input is purely numeric, or alphanumeric. Limits can
be set manually to restrict what the operator can set, or they can be fetched from the tag
(using the high and low engineering limits). If the engineering units change, the interface
will automatically update from the native tag fields.
Figure 10-6. Numeric Data Entry
Advantages: This is still small, but much less clumsy to use than a DataLink. It can also be
used with any target object or target tag.
Disadvantages: While easy to use, there is no information about what tag is being
controlled, or what its current state may be.
10-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Data Entry and Control
Slider
Controlling analog tag values is the primary use for the slider. It interacts with both the
mouse and the keyboard. The mouse can drag the slider bar, and the keyboard can be used
to enter an exact value or to “jog” the value up or down using the arrow keys.
Figure 10-7. Data Entry Expert – Slider configuration
As with the Numeric/Alphanumeric data entry, the slider can fetch the tag limits at run-time.
It can also be set to write continuously, so with each movement of the slider, a value is sent
rather than when OK is pressed.
Figure 10-8. Slider at run-time
Advantages: This control is intuitive and easy to use and provides both mouse and
keyboard control. It also provides the user with an upper and lower range to use as a
guideline for set points.
Disadvantages: The slider only writes integer values to analog tags. As with the other
methods, it does not provide information about the tag being set.
GFS-154K
Education Services
10-7
Proficy iFIX Fundamentals - Data Entry and Control
Ramp
This data entry interface allows an operator to repeatedly increment and decrement an
analog value using buttons that change the value by a pre-set percentage.
Figure 10-9. Data Entry Expert – Ramp configuration
The designer can set the limits manually or fetch them. In addition, there are two Ramp
Percentages that may be set. (The single arrow is Ramp Percentage 1, the dual arrows are
Ramp Percentage 2).
Figure 10-10. Ramp at run-time
Advantages: This is an effective way to quickly step a set point up or down without typing.
Disadvantages: It does not provide information about the tag being set, or what its current
value may be.
10-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Data Entry and Control
Digital Point Experts
With two-state equipment, it may be desirable to simplify the interface beyond the
pushbutton model, especially if quick and easy changes are required. The Digital Point
experts have no interface and respond to a single click on the target object. Depending on
the command type that is deployed, the click will automatically send an “Open” command
(0), a “Close” command (1) or a “Toggle”.
The Digital Point Experts are found under Commands in Tasks/Experts in the Tools Ribbon
and in the Experts Toolbar, enabled via Settings - Toolbars in the Home Ribbon.
Figure 10-11. Commands - Digital Point Experts
Figure 10-12. Experts Toolbar - Digital Point Experts
Clicking a target object and then using the appropriate button will apply the Digital Point
experts.
The target data source is set in a simple dialog box.
GFS-154K
Education Services
10-9
Proficy iFIX Fundamentals - Data Entry and Control
Open Digital Point
Clicking on the target object will send a zero (0) to the specified digital tag. Usually, this
feature is incorporated into a custom pop-up picture to ensure that the control command is
not set by accident from a main process screen.
Figure 10-13. Open Digital Point Expert
Close Digital Point
Clicking on the target object will send a one (1) to the specified digital tag.
Figure 10-14. Close Digital Point Expert
Toggle Digital Point
The Toggle Digital Point Expert is very useful, but it is best used when accompanied by
some form of indication so that the operator has immediate feedback of the changes
required or performed. The Toggle will change a 0 state to 1, or 1 to 0 depending on what
the current value is.
Figure 10-15. Toggle Digital Point Expert
Advantages: Very quick and easy setting of points. No space required for control pop-ups.
Disadvantages: Accidental setting of points is easily possible. Also, there is no obvious
way of signaling where the command is or what it does.
10-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Data Entry and Control
Key Macro Editor
The Key Macro Editor allows a designer to apply a set of keystrokes to an object, a group, a
picture, or even globally (inside Workspace) in order to automatically set control tags.
It is accessed from the Applications Ribbon.
Figure 10-16. Access the Key Macro Editor
Figure 10-17. Key Macro Editor – picture selection
If applied to an object, that object must be selected before the keystrokes will trigger the
action. If applied to a picture, the keystrokes will work whenever the picture is open.
There are two steps to setting a key macro:
 Select a keystroke sequence
 Configure an Action
Highlighting a cell in the Key Combination column will prompt a button to appear. This
button will launch a keyboard-mapping interface. Any key sequence can be created to
trigger an action. (Be careful not to overwrite any existing commands).
Figure 10-18. Key Macro keystroke assignment
GFS-154K
Education Services
10-11
Proficy iFIX Fundamentals - Data Entry and Control
The Run Wizard button provides a dialog box with a wide range of commands, including
some to control tag values:
 Close Digital Point
 Open Digital Point
 ToggleDigitalPoint
 Data Entry Expert
 Ramp Tag Value
 Write to a Database Point
These choices provide simple interfaces for a developer to assign control actions to target
tags.
Once a Key macro has been set on a picture, group or object, its System Tree icon will
change to reflect the fact that there is a Key macro command associated with it. This can
be very helpful to people learning or maintaining the system.
Figure 10-19. System Tree icon with the key symbol
Advantages: Key Macros provide quick and simple control of tag values, and they are more
secure than mouse clicks.
Disadvantages: This is not a clear and intuitive interface for new users. It is like having to
know the “secret knock” to open a door.
10-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Data Entry and Control
Multiple Command Script Wizard
This dialog box provides a standardized means of interacting with commands on objects – in
this case Key macro commands.
The drop-down list provides the commands that can be assigned to objects. When chosen,
these commands usually launch an expert window to collect the necessary details for the
action, such as tag name, setpoint, limits, etc.
Figure 10-20. Multiple Command Script Wizard
Once the command has been specified, it is added to the Configured Actions tree, and can
be recalled and edited in the future. As the name suggests, more than one command can be
assigned per action.
Figure 10-21. Multiple Command Script Wizard – Configure Actions
There are tool buttons available to help manage the commands. From left to right, the
functions Append, Delete Selected, Delete All, Move Up, Move Down, Show Actions, Hide
Actions, open an Expert or open the VB Editor.
GFS-154K
Education Services
10-13
Proficy iFIX Fundamentals - Data Entry and Control
Summary of Data Entry Methods
DataLink In-Place Data Entry – a good method for space-saving and quick configuration.
Both the mouse and keyboard are required.
Data Entry Expert – a good alternative to DataLinks, providing standardized intuitive
interfaces accessible with the mouse.
 PushButton – mouse only
 Numeric/Alphanumeric – mouse and keyboard
 Slider – mouse or keyboard
 Ramp – mouse only
Digital Point Experts – a quick and efficient interface that is well suited to knowledgeable
operators. Single mouse clicks are all that are required.
 OpenDigitalPoint
 CloseDigitalPoint
 ToggleDigitalPoint
Key Macro Editor – can use most of the other interfaces but is driven via the keyboard
instead of by a mouse.
 Close Digital Point
 Open Digital Point
 ToggleDigitalPoint
 Data Entry Expert
 Ramp Tag Value
 Write to a Database Point
10-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Data Entry and Control
Troubleshooting Topic
When using the Slider Data Entry Expert, there is an option to Write Continuously.
If this is enabled, every tiny movement of the Slider will result in a new value being sent to
the source, which may be a tag in the iFIX Process Database.
If the HMI using the Slider is remote to the SCADA, then this can add an overhead, but in a
modern networked environment, this is likely to be negligible.
Figure 10-22. Slider – Write Continuously
However, one effect that can be puzzling, is if an Analog Output tag is the Data Source and
the Operator Limits – Rate Limit has been applied. Usually, the Rate Limit prevents the
operator from ramping up or down a data source too quickly. One change per operator
action, for example by 100 each time.
Figure 10-23. Slider – Write Continuously
When using the Slider with Write Continuously enabled as the HMI Data Entry tool, each tiny
movement is seen as a unique value to write, therefore appears to override the Rate Limit. It
is of course not an override, just an effect of using this tool with Write Continuously enabled.
The solution is never to use Write Continuously with an Analog Output tag where a Rate
Limit was applied.
GFS-154K
Education Services
10-15
Proficy iFIX Fundamentals - Data Entry and Control
eBooks Topic
Using the Multiple Command Script Wizard is a great way of added several commands to
the same action, e.g. a button click. The VBA code is added automatically, meaning there is
no need to enter the VB Editor.
The Multi Command Script Wizard is used automatically in the Key Macro Editor, however it
is available via the Basic Animation Dialog. More on that later.
Search the iFIX Online Help and search for “Multiple Command Script Wizard”. Look for this
topic and browse the related topics.
Take a read at this topic when you have time.
Figure 10-24 Online Help – Multiple Command Script Wizard
10-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Data Entry and Control
Lab Exercises – Data Entry and Control
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Add DataLink data entry in the Ingredients display
 Use the Data Entry Expert for certain tags in both the Ingredients and Packaging displays
 Use Digital Point Experts for equipment in both the Ingredients and Packaging displays
 Use Key Macros to change values in the Packaging display
Introduction
Our Ingredients display already has the ability to show us important process information in
DataLinks. Now we will modify one of these DataLinks to provide us with read and write
capabilities. You will then use Data Entry Experts to provide methods of changing other
values in both the Ingredients and Packaging displays.
Finally, you will add a key macro to the Packaging display to ramp up or down the conveyor
speed.
Lab Exercise #1 – Data Entry using Datalinks and Experts
Part A - Add Control Capabilities to the Ingredients display
1. Ensure that iFIX is running, and that Workspace is open in Configure mode.
2. Open the Ingredients picture created earlier.
3. Locate the Datalink for the Cellulose E460 Inlet Rate.
4. Double click this Datalink to open its Configuration window.
5. In the Data Entry section, set the Type to In-Place. Click OK to close the Datalink window
when done.
6. Save the Ingredients picture (Ctrl-S) then Switch to Run mode.
GFS-154K
Education Services
10-17
Proficy iFIX Fundamentals - Data Entry and Control
7. In Run mode carry out these steps:
a.
b.
c.
d.
e.
Click into the Datalink. A box will appear showing it is selected.
Click into the numerical value already there. It will most likely highlight in blue.
Click delete on the keyboard to delete the current numbers.
Type in a new value, e.g. 23.
Click Enter on the keyboard to commit the new value.
8. Switch back to Configure mode (remember the Ctrl-Q custom keystroke) when done.
Part B - Add Control Capabilities using Data Entry Experts
1. Highlight the rectangle above this last Datalink, representing the Cellulose E460 Inlet Rate,
and with it selected click the Data Entry Expert button in the Toolbox.
2. When the Data Entry Expert opens, choose Numeric/Alphanumeric Entry then select the
Numeric Entry radio button. Then click the ellipses button to open the Expression Builder.
10-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Data Entry and Control
3. In the Expression Builder move to the Model tab, choose THISNODE from the SCADA drop
down box, select the Instances radio button, then expand the Model hierarchy to select
Cellulose_E460 InletRate.
4. Click OK to close the Expression builder. Back in the Data Entry Expert, check the Fetch
Limits at Runtime checkbox. Then lastly click OK to close the Data Entry Expert.
5. Save the Ingredients picture (Ctrl-S), then Switch to Run mode.
6. Click the rectangle you just configured above. The Data Entry popup appears. Type in a new
value, e.g. 20 then click the OK button. The new value has been set.
7. Switch back to Configure mode.
8. From the Home Ribbon, click Settings, then click Toolbars:
9. In the Toolbars configuration window, select Picture as the Owner, then check to enable the
Experts Toolbar. Click the Close button when done.
GFS-154K
Education Services
10-19
Proficy iFIX Fundamentals - Data Entry and Control
10. In the Ingredients picture, highlight the rectangle representing the Cellulose E460 Inlet
Switch and with it selected, click the Data Entry Expert button in the Experts Toolbar.
This really is exactly the same as the Toolbox button.
11. In the Data Entry Expert, choose Pushbutton Entry as the method, set the Open and Close
buttons Titles to Stop and Start, then browse the Expression Builder to select the InletSwitch
from the Cellulose_E460 Ingredient of the Model. Click OK in the Expression Builder, then
click OK again in the Data Entry Expert.
12. Save the Ingredients picture (Ctrl-S), then Switch to Run mode.
a.
b.
c.
d.
e.
Click the rectangle you just configured above. The Push Button Entry popup appears
Try both the Stop and Start buttons.
When Start is pressed the Datalink will show that the switch has Closed.
When Stop is pressed the Datalink will show that the switch has Opened.
Click OK to close the Pushbutton Entry popup.
13. Switch back to Configure mode.
14. Repeat the steps above but for the Outlet Switch using the Outlet Switch rectangle below the
Tank.
Do not forget to keep Saving the picture!
10-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Data Entry and Control
15. Back in Configure mode, highlight the rectangle for the Cellulose E460 Outlet Rate under
the tank, with it selected click the Data Entry Expert in the Experts Toolbar.
16. This time choose Slider Entry as the method. Browse the Expression Builder Model to select
the OutletRate for the Cellulose_E460 Ingredient. Check Fetch Limits at Runtime. Click OK
when done.
17. Save the Ingredients picture (Ctrl-S), then Switch to Run mode.
18. Click the rectangle you just configured above. The Slider Entry popup appears. Drag the
slider left or right to a new value then click the OK button to commit the new value.
If the Write Continuously checkbox had been enabled, the new value, continuously, will have
been written to the tag with every tiny movement.
19. Switch back to Configure mode.
20. From the View Ribbon, click Close All.
GFS-154K
Education Services
10-21
Proficy iFIX Fundamentals - Data Entry and Control
Part C - Add Control Capabilities to the Packaging display
1. Ensure that iFIX is running, and that Workspace is open in Configure mode.
2. From the System Tree, open the Packaging picture. This is a partially complete display
supplied with the course system.
3. From the Home Ribbon, or Quick toolbar, place Workspace Configure in Full Screen mode.
Ensure that the Experts Toolbar is still open.
4. Locate the Conveyor Manual Control section at the right and highlight the State Control
button. With it selected click the Toggle Digital Point Expert from the Experts Toolbar.
5. When the Toggle Digital Tag Expert opens, click the ellipses button to open the Expression
Builder.
10-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Data Entry and Control
6. This time, since there are no Models for the Packaging area (come back on the Advanced iFIX
course to look at building Models from scratch!) use the FIX Database tab.
7. Now, there are many tags in your Process Database. The Expression builder has a useful filter
tool.
a. Highlight THISNODE in the Node Names column. All Tags are returned.
b. In the filter field under the Tag Names column, type in *pack* then click the F button.
Only tags with ‘pack’ somewhere in their name are returned.
c. Highlight the PACKAGINGCONVEYORCONTROL tag.
d. Then click the F_* button to automatically choose the F_CV field.
e. Click OK to close the Expression builder.
8. Click OK to close the Toggle Digital Tag Expert.
9. Repeat this last step using the Toggle Digital Point Expert, but this time for the Palletizer
control and use the tag Fix32.THISNODE.PACKINGPALLETIZERSTATUS.F_CV.
Notice how the Expression Builder remembered the last filter of *pack*.
10. Save the Packaging picture (Ctrl-S), then Switch to Run mode.
11. Click the State Control button configured above with the Digital Point Expert.
Notice the already animated conveyor will stop and start, but there was no secondary prompt.
12. Click the Palletizer Control button configure above with the Digital Point Expert.
The Datalink showing Feeding or Not Feeding changes. The Pallet itself will be animated by
you later.
13. Switch back to Configure mode.
14. Ensure that the Packaging picture has been Saved.
GFS-154K
Education Services
10-23
Proficy iFIX Fundamentals - Data Entry and Control
15. Next with the Speed Setpoint button selected, click the Data Entry Expert button in the
Experts Toolbar:
16. Configure the Data Entry Expert as follows:
a.
b.
c.
d.
e.
Method: Ramp Entry
Data Source: FIX32.THISNODE.PACKAGINGCVSPEED.F_CV
Ramp Percentage 1: 2
Ramp Percentage 2: 4
Fetch Limits: checked
17. Click OK when done
18. Save the Packaging picture (Ctrl-S), then Switch to Run mode.
19. Click the Speed Setpoint button configured above.
20. Try the Up and Down buttons to ramp up or down by the 2% or 4%
(of range) steps. See the effect on the Conveyor Speed.
21. Switch back to Configure mode.
22. Ensure that the Packaging picture has been Saved.
10-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - Data Entry and Control
Part D - Add Key Macros to the Packaging display
1. Ensure that the Packaging picture is open in Configure mode.
2. The Key Macro Editor can be opened from the Applications Ribbon:
3. However sometimes it is more useful to open it from the right click menu of a specific picture
or object to which the key macro is to be assigned.
Right click in a blank area (no objects selected) of the Packaging picture.
Then select Key Macro then Add.
The Key Macro Editor will open and already be focused on this Packaging picture.
4. Always double check the Key Macros Apply To: field at the top.
This object must be in focus for the key macros listed to run as intended.
5. With Packaging shown in this field, click the NONE button under Key Combination.
GFS-154K
Education Services
10-25
Proficy iFIX Fundamentals - Data Entry and Control
6. When the Keyboard layout appears, click the PgUp button to assign PageUp as the desired
keystroke. Then click the OK button.
7. When returned to the Key Macro Editor, click the Run Wizard button in the same row as this
new PageUp Key Combination.
8. From the drop down list select Ramp Tag
Value.
9. In the Ramp a Value Expert which appears,
select the PACKAGINGCVSPEED tag and its
F_CV using the Expression Builder and set it
to Ramp By Value with a value of 2.
10. Click OK to close the Expert.
11. Click OK to close the Multi Command Script
Wizard.
12. Next add an almost identical second new Key
Combination for PgDn, the PageDown
keystroke.
13. Click Run Wizard again and in the Multi Command Script Wizard, choose Ramp Tag Value.
14. Again, select the same PACKAGINGCVSPEED tag and its F_CV.
15. This time however set its Ramp By Value to -2 (minus 2).
16. Click OK to close the Expert, click OK to close the Multi Command Wizard and finally click
OK to close the Key Macro Editor.
10-26
Education Services
GFS-154K
Proficy iFIX Fundamentals - Data Entry and Control
17. Save the Packaging picture (Ctrl-S), then Switch to Run mode.
18. On your keyboard click the Page Up button. The Conveyor Speed should increase by 2 units.
19. On your keyboard click the Page Down button. The Conveyor Speed should decrease by 2
units.
20. Switch back to Configure mode.
21. Ensure that the Packaging picture has been Saved.
GFS-154K
Education Services
10-27
Proficy iFIX Fundamentals - Data Entry and Control
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 10 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
10-28
Education Services
GFS-154K
Proficy iFIX Fundamentals - Data Entry and Control
Review Questions
1.
What are the key factors to remember when implementing various data entry
methods?
2. Which of the data entry methods can employ a confirmation dialog box for the
operator?
3. What does Fetch Limits do?
4. What is the danger of using Digital Point experts in a main process screen?
5. Can key macros be assigned to pictures?
Electronic Books Research
6. What can you set in the Key Macro Editor User Preferences?
GFS-154K
Education Services
10-29
Proficy iFIX Fundamentals - Data Entry and Control
Review
Now that you have completed this module, you should be able to:
 Describe DataLink Data Entry methods
 Explore the Data Entry Expert
 Use the Open, Close and Toggle Digital Point Experts
 Use the Key Macro Editor
10-30
Education Services
GFS-154K
0)
11
GLOBAL OBJECTS
a
At the end of this module, you will be able to:
 Define Global Objects
 Use Global Variables
 Create Global Threshold Tables
 Use Global Forms and Procedures
55%
Proficy iFIX Fundamentals - Global Objects
11-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Global Objects
HMI
Overview
Thus far, objects have been discussed within a document-based context, most commonly
with regard to Pictures and Dynamo Sets. Every object is described or has functionality
enabled by a set of properties. These objects are very useful, but their scope is limited to
the document of which they are a part.
Global objects provide a means of extending the scope of objects to any document in the
Workspace. Global objects and their properties can be accessed universally for use in
defining animations, providing common forms and displaying system-wide data. Generally,
these objects are data objects and have no visible graphic component.
User Globals reside in a unique area and provide a means for developers and users to
create, store, and link to common objects and properties.
Plug-and-Solve Globals are reserved separately for third-party software providers to use
with their plug-in applications.
User Globals can be found in the System Tree and browsed in the Expression Builder.
Figure 11-1. Global Objects in the User Globals area
Figure 11-2. Global Objects in the Expression Builder
GFS-154K
Education Services
11-3
Proficy iFIX Fundamentals - Global Objects
User Globals
User Globals are stored in a single document. The User.FXG file is
found in the project PIC path and can be copied to other iFIX
projects for re-use. Like Pictures and Dynamo Sets, this
document can hold a variety of different object types, as well as
VBA forms and scripts. Global Key Macros can also be built for
use anywhere in the Workspace and these are stored in the User
Globals file.
The main interface for Global object access and creation is the
System Tree. From here a user can access a right-click mouse
menu to edit the contents of the User Globals.
Figure 11-3. User Globals right-mouse menu
Save will commit all changes permanently to the User.FXG file.
The Find and Replace and Property Window choices behave exactly like their normal object
counterparts.
Global Variables
Variables are useful tools for storing information used by many different areas of iFIX. The
variable itself is invisible and can only be seen in the System Tree. However, variables can
be used as data sources for DataLinks and other animations as well as VBA scripts. For
example, variables can be used to hold the names of the Current and Previous displays.
These names can then be used to assist with navigation.
Variables can receive their data from VBA scripting or via other data sources assigned
through the Expression Builder (such as tags).
Creating Global Variables is relatively easy. The User right-click menu in the System Tree
offers a Create Variable choice that requires manual configuration. The Workspace
Toolbox also provides a button to add variables with a friendly interface.
Figure 11-4. Simple Global variable
Variables must be given a unique name and must be assigned a data type (e.g. String, Float,
Boolean, etc). This will provide the necessary format for the data before it is passed along
to its destination. Note that a Local Variable can be created as well. These variables will be
deposited in the current Workspace document and will be restricted to the same document
scope as normal objects.
11-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Global Objects
Assignment with Expression Editor
Global Variables are commonly used with DataLinks to display information. In these cases,
the Global Variable acts as data source, much like a tag. As such, it can be defined using
the Expression Builder.
Figure 11-5. Browsing the Expression Builder to configure a Datalink to use a Global Variable
GFS-154K
Education Services
11-5
Proficy iFIX Fundamentals - Global Objects
Global Threshold Tables
Global Threshold Tables are useful tools for mapping two different data types against each
other, instead of just passing a value straight through. For instance, a developer can create
a universal threshold that maps numbers (integers) to colors. This is commonly done in
association with color animations on process equipment and alarm states.
There are five main data types that can be used as sources and destinations:
 Boolean (True or False)
 Integer
 Float (Real numbers)
 String (Text)
 Color (Destination only)
The main benefit of creating a global threshold table is that it can be shared amongst
numerous “child” objects. These objects will automatically inherit changes, edits or
additions to the Global Threshold table without any need for reconfiguration. This is an
important way to implement project standards and save time in development and
maintenance.
Creating Global Threshold tables can only be done from the System Tree. The right-click
menu allows a developer to Create Threshold. A custom Threshold dialog will appear to
allow the user to map the values at various levels.
Figure 11-6. Custom Lookup Table examples
The Source Property Type refers to the incoming data from the data source (e.g. a tag
current value) whereas Objects Property Type indicates what the value will be mapped to
before being passed to the destination. Exact match is very good for two-state tables for
color, visibility and text strings. Range Comparison is much better for analog tag ranges.
Entries can be edited in-place or through a mini-dialog that can be opened by doubleclicking on the target cell.
11-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Global Objects
The developer can then give the Threshold table a more
meaningful name. This is accomplished this by opening
the Property Window and then using the System Tree to
select the Threshold. From there the Name property is
easily edited in the Property Window.
Figure 11-7. Rename a Threshold Table
Assignment with Expression Builder
Much like Global Variables, Global Threshold tables are commonly used with DataLinks to
display information. However, they also play an important part in object animations for color
and visibility. In both cases links are defined using the Expression Builder. The Animations
chapter will show this in more detail. Unlike with the Variable, only User and the Table name
are required, no Properties are selected.
Figure 11-8. Linking to a Global Threshold table with the Expression Editor
GFS-154K
Education Services
11-7
Proficy iFIX Fundamentals - Global Objects
Global Key Macros
Global Key Macros can be added from the System Tree right-click mouse menu, or from the
Key Macro Editor itself. These macros obey the same rules as normal key macros, but are
recognized anywhere in the Workspace at run-time, even if there are no pictures open.
Figure 11-9. Global Key Macros
When exiting the Key Macro Editor, the developer is prompted to Save the User.FXG file.
This can be set to automatically save whenever there are changes.
The User Global icon in the System Tree is altered to indicate there are Global Key Macros
with the inclusion of a small golden key icon.
Figure 11-10. Global Key Macros - save
11-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Global Objects
Global Procedures and Forms
Global Procedures and Forms are an effective means of distributing functionality throughout
the Workspace without duplicating effort. Scripts are written once in the User VBA project
and, similarly, Forms are developed and deposited in the same project. Instead of
recreating these components in each document that requires them, the developer can call
the procedure or launch the form directly from the User Globals document. This will be
covered in more detail in the VBA chapter.
Figure 11-11. Global Alarm Area form
GFS-154K
Education Services
11-9
Proficy iFIX Fundamentals - Global Objects
Troubleshooting Topic
Key Macro Hierarchy.
It is possible to have the same Key combination used at multiple levels.
Object Level
Key Macros can be assigned, for example PageUp, when an object in a picture is clicked.
There may be 10 text objects as labels to setpoints values. When label1 is selected, PageUp
will ramp value1 up by 1 unit. When label2 is selected, PageUp will ramp value2 up by 1 unit.
This means that all 10 x labels can use the common keystroke of PageUp to ramp up by 1
unit.
Figure 11-12. Object Level Key Macros
Picture Level
At the picture level, with no objects (e.g. in the example no labels selected) PageUp could
carry out an entirely different task, perhaps ramp a singular value or open a digital tag.
Figure 11-13. Picture Level Key Macros
11-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Global Objects
Global Level
At a Global level (user.fxg) the PageUp Key Macro could be used for navigation, moving up
through the different process area pictures.
Figure 11-14. Global Level Key Macros
From a troubleshooting point of view, care should be taken not to overlap, however if they
do, the hierarchy is as follows.
 Object
 Picture
 Global
This means that if a picture is open containing the same Key combination as a Global Key
combinations, the Global one is masked. Only when the Picture using the same Key
combination is closed will the Global Key combination work.
If an object with the same Key combination as a picture is selected, the Picture Key
combination is masked. Only when the object is deselected will the picture Key combination
work.
Summary
Try to use different Key combinations, but using the same Key combination can be useful at
the object level. Simply be aware of the hierarchy order.
GFS-154K
Education Services
11-11
Proficy iFIX Fundamentals - Global Objects
eBooks Topic
It is possible to mask a Key Combination, typically at a Global or Picture level.
This topic is covered in the Online Help.
Search the iFIX Online Help and search for “Disabling a Key”. Look for this topic.
Take a read at this topic when you have time.
Figure 11-15 Online Help – Disabling a Key Combination
11-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Global Objects
Lab Exercises – Global Objects
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Create Global Variables to track current alarm area, current and previous picture names
 Create Global Threshold tables for two state equipment and multi-state tanks
 Create string thresholds for Plant Status messages
 Create Global Key Macros to Login and HMI reset
Introduction
You are going to create Global Variables to assist with the management of navigation, as
well as alarm filtering. These variables will be used in the Lab Exercises of subsequent
modules.
You will then create Global Threshold tables to assist with the management of color and text
animations on a variety of process equipment. These Threshold tables will be used in the
Lab Exercises of subsequent modules.
Lab Exercise #1 – Create Global Variables
1. Ensure Workspace is open in Configure mode, and that at least one picture is open.
2. Expand the System Tree - Globals folder, note the one item named User with an icon of
the whole world! OK it’s a Globe. Notice the golden key on the icon, this indicates that at
least one Global Key Macro is already present, this in fact is our custom Ctrl-Q keystroke to
switch from Workspace Run to Configure mode.
3.
In the Toolbox click the Variable button to create a new Global Variable.
4. Name the new Variable varCurrentPicture, choose String from the drop down list and set
as a Global Variable. Then click OK.
GFS-154K
Education Services
11-13
Proficy iFIX Fundamentals - Global Objects
5. Observe the new variable in the System Tree by expanding the Globals folder and then
the User document.
6. Using the toolbox button, add three more Global Variables with the following properties:
Variable Name
Data Type
Variable Type
varPreviousPicture
String
Global
varNextPicture
String
Global
varAlarmArea
String
Global
7. When finished, right-click the User document and click Save. This will save all your
changes to the User.FXG document, whether they are variables, thresholds, key macros,
forms or scripts.
8. Observe your collection of Global variables.
11-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Global Objects
Lab Exercise #2 – Create Global Threshold Tables
1. Ensure Workspace is open in Configure mode, and that the System Tree is open.
2. Right-click the User document in the System Tree and select Create Threshold Table.
3. The Custom Lookup Table dialog will appear. Configure as follows:
a.
b.
c.
d.
e.
f.
Source Property Type: Float
Objects Property Type: Color
Exact Match: enabled
Double click onto Row1 number 1, in the New Level window set:
Input Low: 0.00
Output Primary: click the color box to open the High Performance Color Set and
choose HPCharcoal
Then click OK
g. Double click onto Row2 number 2, in the New Level window set:
h. Input Low: 1.00
i. Output Primary: click the color box to open the High Performance Color Set and
choose HPBrightGreen
Then click OK
j. With Row3 selected click the Delete Row button and continue to delete all unused
rows until only these 2 configured rows remain. This is a tidy up task, it has no effect on
functionality.
k. Then click OK
GFS-154K
Education Services
11-15
Proficy iFIX Fundamentals - Global Objects
4. Observe this new Threshold table in the System Tree. Note that the new Threshold table is
using the generic name of Threshold.
5. Click F4 on the keyboard to open the Property Window
The Property Window will display the Threshold properties, including the Name.
Change the Name from Threshold to tblBoolean.
We will be using this Threshold table to set animations for the status of switches, pumps
and any other two state devices.
Leave the property Window open, just move it to one side – remember it is a floating window
and non modal.
6. Using the right-click menu on Globals - User, create another Threshold table. This one will
be used to assign a color indication to tank levels. Since we are using analog values with our
tank levels, we will be using Float as the Source Property Type and Color as the Objects
Property Type.
We will use a Range Comparison. Set the following values:
Low
High
Color
0.00
10.00
HPBlush
10.00
25.00
HPPeach
25.00
75.00
GEBlue
75.00
90.00
HPPeach
90.00
100.00
HPBlush
7. When finished, click OK to add the Threshold table to the Globals document.
Use the Property Window to rename it tblLevelColor.
11-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Global Objects
8. Using the right-click menu on Globals - User, create another Threshold table.
This one will be used to assign color indication to a variety of Plant Statuses.
This single table has many uses for Production Areas as well as the Energy Center and
Historical Collection.
Float is the Source Property Type and Color as the Objects Property Type.
Use Exact Match. Set the following values shown below for the tblStatusColor table.
Click the Insert Row button to add the required additional rows.
When finished, click OK to add the Threshold table to the Globals document.
Use the Property Window to rename it tblStatusColor
9. Using the right-click menu on Globals - User, create another Threshold table.
This one will be used to assign a Message to a variety of Plant Statuses.
This single table has many uses for Production Areas as well as the Energy Center and
Historical Collection.
Integer is the Source Property Type and String as the Objects Property Type.
Use Exact Match. Set the following values shown below for the tblUnitStatus table.
Click the Insert Row button to add the required additional rows.
When finished, click OK to add the Threshold table to the Globals document.
Use the Property Window to rename it tblUnitStatus
Value
Color
Value
String
0
HPAluminium
0
Stopped
1
HPLavender
1
Starting
2
HPBrightGreen
2
Execute
3
HPHighlighter
3
Resetting
4
HPPeach
4
Suspended
5
HPRed
5
Aborting
6
HPBrightGreen
6
Collecting
7
HPRed
7
Stopped
8
HPHighlighter
8
Check
9
HPPeach
9
Action
10
HPRed
10
Critical
11
HPBrightGreen
11
Good
12
HPPeach
12
High
13
HPRed
13
Critical
14
HPBrightGreen
14
Normal
15
HPPeach
15
High
16
HPRed
16
Maximum
17
HPPumpkin
17
Loaded
18
HPViolet
18
OK
19
HPKellyGreen
19
Good
20
HPBrightGreen
tblStatusColor – Float - Color
20
Perfect
tblUnitStatus – Integer - String
That was a lot of clicks! Very large lookups are perhaps easier when referencing an external
table in a relational database – an iFIX Advanced class topic. Or there is a simpler trick when
creating large thresholds tables of certain types, watch the optional OLT lab How To video
to find out!
GFS-154K
Education Services
11-17
Proficy iFIX Fundamentals - Global Objects
10. Observe the User Globals folder in the System Tree. It should resemble the figure below.
11. Right–click the User icon and select Save.
11-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Global Objects
Lab Exercise #3 – Create Global Key Macros
1. Ensure Workspace is open in Configure mode, and that the System Tree is open.
2. Right-click the User folder document in the System Tree and select KeyMacros then Edit.
(NOTE it will show Add if no Global Key Macros already exist).
3. The Key Macro Editor will open already set to add Key Macros to the User Globals document.
Ensure that the Key Macros Apply to: field, is set to User.
4. Click into the next free row and click again on the NONE label to open the Keyboard selector.
5. Choose Ctrl and L as the key combination. Then click OK.
6. In this new row for Ctrl-L, click the VB Editor button. This will take you into the VB Editor!
Don’t panic! We will be looking at VBA in more detail later.
7. You will see the cursor in a new procedure headed Public Sub FixGlobals_CtrlL().
Under this line simply type in login. It should now look like this:
GFS-154K
Education Services
11-19
Proficy iFIX Fundamentals - Global Objects
8. In the VB Editor, click the File Menu then Close and Return to Workspace Application (or AltQ).
9. Back in the Key Macro Editor, add another new Key combination entry, click into the next free
Key Combination row and in the Keyboard selector, choose the Home key. Then click OK.
10. In this new row for Home, click the VB Editor button. This will take you into the VB Editor
again.
11. You will see the cursor in a new procedure headed Public Sub FixGlobals_Home().
Under this line simply type in HMIReset. This is a procedure which does not yet exist. You will
create it in the VBA Chapter of this course. The VB Editor for this User code should now
contain 3 x keystroke procedures:
12. Once again, in the VB Editor, click the File Menu then Close and Return to Workspace
Application (or Alt-Q).
13. Click the OK button at the bottom to close the Key Macro Editor. Since you made changes to
the User Globals, you will be prompted to Save User.fxg. Click Yes at this prompt.
11-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Global Objects
14. Switch to Run mode and use the Ctrl-L keystroke.
15. The Login Prompt will appear. You are already currently logged in as the Administrator user.
We will look at Security later in the course. For now, click the Exit button.
16. As stated, the Home key action will be added later. DO NOT try it yet.
If you attempted to you will see this error:
17. Switch back to Configure mode. Ctrl-Q was a custom Global Key Macro which was already
shown in the Key Macro Editor.
GFS-154K
Education Services
11-21
Proficy iFIX Fundamentals - Global Objects
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 11 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
11-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Global Objects
Review Questions
1.
Where are Global variables, Thresholds, Procedures, Forms and Key Macros stored?
2. How does a developer Save Globals?
3. What syntax is required for displaying data from Global Variables?
4. What are four source data types that can be used in Global Threshold Tables?
5. How are key macros assigned to the User Globals area?
Electronic Books Research
6. What does the FactoryGlobals page contain?
GFS-154K
Education Services
11-23
Proficy iFIX Fundamentals - Global Objects
Review
Now that you have completed this module, you should be able to:
 Define to Global Objects
 Use Global Variables
 Create Global Threshold Tables
 Use Global Procedures
11-24
Education Services
GFS-154K
0)
12
ANIMATIONS
a
At the end of this module, you will be able to:
 Define Graphic Experts
 Use the Basic Animation Dialog Box
 Describe the Advanced Animation Dialog Box
 Configure Animations and Global Threshold
tables
 Classify the four types of Animation Object
60%
Proficy iFIX Fundamentals - Animations
12-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
HMI
Overview
Animations are a powerful means of conveying intuitive information to operators without
resorting to text. Their primary role is to link data sources to object properties at real-time,
using the data to change properties such as color or visibility dynamically. These visual
cues are often more helpful for assessing process conditions and equipment states quickly.
Animations are objects. They are assigned to parent objects to facilitate data refreshing,
handling and conversion from valid data sources. These Animation objects then use this
“massaged” data to change the properties of the parent object. The Animation object
properties govern how this is accomplished.
A typical Animation is the use of color to determine equipment states, alarm conditions and
threshold limits. Visibility can also be changed dynamically to hide or reveal objects based
on the current process conditions. Fill animations can show tanks filling or emptying,
position animations can move objects around the screen, rotation will change an objects
angular orientation. Deployed efficiently, animations are excellent tools to create displays
that visually mimic what is happening with the process equipment. However, too much
animation can create overly busy or confusing displays. Using High Performance graphical
objects, especially pre-configured dynamos, can prevent a developer from over
complicating the HMI.
Figure 12-1. Example of animations used in an HMI display
GFS-154K
Education Services
12-3
Proficy iFIX Fundamentals - Animations
Animation Experts
The Workspace provides a number of different tools to assign animations to objects. The
Tools Ribbon, the Toolbox and the Experts toolbar have sets of Animation Experts that
provide simple interfaces for configuring animations. The Basic Animation Dialog provides
quick access to common animations.
Figure 12-2. Animation Experts from Tools Ribbon / Experts Toolbar / Toolbox
Figure 12-3. Basic Animation Dialog
12-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
Animations have two main tasks: data refresh and data conversion. The animation is
responsible for managing the requests for information from data sources such as PDB tags.
This is set through the Expression Builder and involves the same steps used to define a data
source for a DataLink. The animation is also responsible for converting the data from its
native format (generally numeric) to a value that makes sense for the property being
updated (such as color, text or a number using a different range). The Animation Experts
provide simple configuration of these duties from a single location.
Foreground Color
The Foreground Color Expert will assign an animation to the foreground color property of an
object. This generally means that it will map a quantitative value (a number) to a qualitative
value (such as color). The best means to do this is with a lookup table.
Figure 12-4. Foreground Color Expert
The data source is provided using the Expression Builder and colors can be mapped based
on the current value, the current alarm, or the latched alarm (most severe unacknowledged
alarm). Setting the animation color table is very similar to setting the Lookup table for a
Global Threshold.
Two-state or integer tags commonly use an Exact Match method of ascribing colors to
values, whereas analog values are best described using a Range Comparison. Individual
values or ranges are matched to a single color.
GFS-154K
Education Services
12-5
Proficy iFIX Fundamentals - Animations
Using Global Threshold tables
When creating animations for multiple objects that share the same color scheme, it is much
easier to create and assign a Global Threshold table to provide the color mapping. This will
save time because the developer will not need to repeatedly recreate the individual
animation tables. If changes are required, they can be made once to the Global Threshold
table and automatically inherited to all the objects that use the table.
Use Shared Threshold Table, when enabled, will bypass the lookup table in the Expert and
use an assigned Global Threshold Table. The table can be browsed using the Expression
Builder.
Figure 12-5. Assigning Global Thresholds to animations
Once an animation has been added to a parent object, the System Tree will reflect the new
addition as a contained object within the parent object. Using System Tree drill down, a
user can find all the animations applied to an object and view their properties with the
Property Window. Note the icon and naming convention used for table-based animation
objects.
Figure 12-6. Foreground Color Animation Objects in the System Tree
12-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
Fill
Fill is generally applied to geometric objects to indicate a current value as a percentage of
maximum. This is a useful tool for showing tank levels or other percentage-based
indicators. Configuration is similar to the ForegroundColor animation, except that the
incoming data and the animated property are both numbers, though they have different
ranges. The Fill Animation will provide a linear scale calculation to change the incoming
data value into a number that fits the expected output range (almost always a percentage).
Figure 12-7. Fill Expert
Once a fill animation has been added to a parent object, the System Tree will reflect the
new addition. The icon and naming convention used for this type of animation object
reflects the Linear Scaling of values performed by the Fill animation.
Multiple animations can be assigned to a single object, but only one animation can be
assigned to each property. The Rectangle in the System Tree has been assigned two
animations: the Linear1 animation is for Fill, and the Lookup1 animation is for
ForegroundColor.
Figure 12-8. Fill Animations in the System Tree
GFS-154K
Education Services
12-7
Proficy iFIX Fundamentals - Animations
Rotate
Like the Fill Expert, the Rotate Expert performs linear conversions from data source ranges
to output property ranges. The result is a Linear animation object. Configuration is easy.
Instead of performing a linear conversion to provide a percentage, the Rotate Expert scales
to degrees. This will determine the angular orientation of the object.
Figure 12-9. Rotate Expert
The Rectangle in the System Tree has been assigned three animations: the Linear2
animation is for Rotate, Linear1 is for Fill, and the Lookup1 animation is for ForegroundColor.
Figure 12-10. Rotate Animations in the System Tree
12-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
Scale
The Scale Expert changes the height and/or width of an object and is used to show objects
growing or shrinking. (This is helpful when moving objects from a distant perspective to a
nearer one, or vice versa). As with the Fill animation, the data conversion is linear, and the
output is a percentage. The developer can define the behavior governing the scaling
animation by setting height only, width only or uniform height and width to be changed. It
can also scale from the center of the object or from any of the corners.
Figure 12-12. Scale Expert
The Rectangle in the System Tree has been assigned four animations: the Linear3
animation is for Scale, the Linear2 animation is for Rotate, Linear1 animation is for Fill, and
the Lookup1 animation is for ForegroundColor.
Figure 12-13. Scale Animations in the System Tree
GFS-154K
Education Services
12-9
Proficy iFIX Fundamentals - Animations
Position
The Position Expert is responsible for moving an object around a display. This position is a
numeric coordinate set (therefore this is a Linear data conversion).
Relative Position Type uses the coordinates which are measured from the original position
of the object.
Absolute Position Type uses the coordinates within the picture itself.
Both methods use the Enhanced Coordinates of the picture.
The object can be moved vertically, horizontally or in both directions.
Figure 12-14. Position Expert
One of the more helpful features of this Expert is that the user can move the object around
the display while the configuration box is open. This allows the user to move the object to
the intended start and/or finish points and use the Get Value buttons to automatically grab
the Minimum Offset (start) and the Maximum Offset (finish). These will define the position
range.
The Rectangle in the System Tree has been assigned five animations: The Linear4
animation is for Position, the Linear3 animation is for Scale, the Linear2 animation is for
Rotate, Linear1 animation is for Fill, and the Lookup1 animation is for ForegroundColor.
Figure 12-15. Position Animation in the System Tree
12-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
Visibility
Visibility is a little different. The values acceptable to the Visible property are True or False.
This makes it very similar to digital tags in that it only allows two states. Because almost
any numeric data source could be used, it must be defined when the value will result in True
or False. Like with Color animations this is best done with a lookup table and range
comparison.
The difference is that the Visibility Expert will create the lookup table based on a conditional
True/False statement. The user supplies the conditions for which an object is visible using
<, > or = operators.
All other conditions render the object invisible.
Figure 12-16. Visibility Expert
The Rectangle in the System Tree has been assigned six animations: The Lookup2
animation is for Visibility, Linear4 animation is for Position, the Linear3 animation is for
Scale, the Linear2 animation is for Rotate, Linear1 animation is for Fill, and the Lookup1
animation is for ForegroundColor.
Figure 12-17. Visibility Animations in the System Tree
GFS-154K
Education Services
12-11
Proficy iFIX Fundamentals - Animations
The DataLink Revisited
The DataLink is actually a Text object with an animation object attached to its Caption
property. This Animation object does not convert or map the data source to a property, it
simply formats the data as alphanumeric or numeric text with specific digits, accuracy, and
justification.
The Animation Expert is just a configuration interface built into the DataLink to make
deployment easier for developers. In the System Tree the animation object shows up as a
Format animation.
Figure 12-18. DataLink Configuration
Figure 12-19. DataLink in the System Tree
12-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
Basic Animation Dialog
There are drawbacks to using the Animation Experts. Developers can only set one
animation at a time, and they can only delete them using the System Tree. Also, there is no
feedback mechanism to tell other developers what animations have been configured for an
object.
Luckily, there is the Basic Animation Dialog. It is a friendly summary interface that can be
opened to show and delete animations, as well as launch the animation experts. It can be
opened in a number of ways:
 Double-clicking on most objects
 Right-click menu Animations
 Click the expand arrow under Animations in the Tools Ribbon.
Figure 12-20. Basic Animation Dialog
The Basic Animation Dialog enumerates all animations attached to an object and displays
them in an intuitive interface. Note that there are extra options available for color not
included in the Toolbox, though they are in the Experts toolbar.
Clicking on the various Expert buttons will launch the expert to assist with assigning the
animation.
Un-checking an animation will delete the animation object associated with that property.
At the top of the dialog, the developer can enter a description to be used for the object.
Enable ToolTip will show this description as context-sensitive help for operators.
GFS-154K
Education Services
12-13
Proficy iFIX Fundamentals - Animations
Advanced Animation Dialog
The Basic Animation Dialog is a helpful interface and the most common choice for
developers when creating animations. However, there may be some cases where the
developer needs to create animations for properties not covered by the standard experts or
the Basic Animation Dialog. In these scenarios, the Advanced Animation Dialog allows a
developer to assign animations to any property.
It can be opened from the Basic Animation Dialog by clicking the Advanced Animations
Configure button.
Figure 12-21. Advanced Animation Dialog
The Advanced Animation Dialog combines the function of the experts with those of the
Property Window to give the developer access to every configurable property in an object.
The properties are organized into tabs to simplify navigation, and arrows are used to
indicate that at least one animation is present on the tab.
While incredibly flexible and powerful, the Advanced Animation Dialog does have two
significant drawbacks: it does not use the experts to define the animations themselves and
the interface is not as user-friendly. Assigning animations is a manual process left to the
developer. It requires that the developer knows the difference between Lookup Tables,
Linear conversions and Ranges, Format animations and Object animations.
However, after some practice, the Advanced Animations dialog, because it exposes all
properties of an object which can be animated, can become a far more flexible tool. The
Picture Preferences page of User Preferences even has a checkbox which if disabled, will
no longer show the Basic Animation dialog.
When adding animation in the Advanced Animations dialog simply:
 Locate the property to be animated
 Enable the Animate checkbox
 Select the Data Source for the animation
 Configure the animation type of Range, Table, Format or Object
12-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
Figure 12-22. Advanced Animation Dialog – Foreground Color
Figure 12-23. Advanced Animation Dialog - Datalink
GFS-154K
Education Services
12-15
Proficy iFIX Fundamentals - Animations
Animation Objects and Data Conversion
We have already discussed and seen three types of Animation Object in the System Tree:
Lookup Tables, Linear Range conversions and Format animations. Each of these objects will
be explored in more detail, in addition to a fourth animation type: the Object Animation.
Object
Object data conversion is the simplest of the four animations. It indicates that the user
intends the value to be passed through to the object property unchanged. Basically, this
takes raw data and writes it directly to the selected property. This is often used in text
objects.
Figure 12-24. Object (raw) Data Conversion
Format
Used for Numeric or Alphanumeric data display only. As per the Datalink.
Figure 12-25. Format Data Conversion (Datalink)
12-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
Range (aka Linear)
This is very similar to the interfaces found in the Fill, Position, Rotate and Scale experts, but
the labels are more generic to suit a wider range of properties. Though these data
conversions show up as Linear animations in the System Tree, Range is how they are
identified in the Advanced Animation Dialog. Input refers to values coming from the Data
Source, Output refers to values written to the property. These are used whenever the
property uses numbers as valid settings.
Figure 12-26. Range Data Conversion (Position)
Table (aka Lookup)
This resembles both Global Threshold tables and the Foreground Color Expert. Though
these data conversions show as Lookup animations in the System Tree, Table is how they
are identified in the Advanced Animation Dialog. Depending on the property, the entries will
allow colors, text, true/false or other numbers. To assign a Global Threshold table, use the
Advanced button and assign the table to the Shared Lookup Object.
Figure 12-27. Table Data Conversion (ForeGround Color)
GFS-154K
Education Services
12-17
Proficy iFIX Fundamentals - Animations
Troubleshooting Topic
User Preferences - Animation Error Defaults
The Workspace User Preferences can be used to customize certain animation features in
iFIX displays.
By default, iFIX is delivered with a set of error cues used with animations. These can be
customized in User Preferences using the Animations Data Error Defaults page. These are
very helpful when troubleshooting problems with data transfer, conversion, and display.
Figure 12-28. User Preferences – Animation Data Error Defaults
There are three sections, one for each of the animation object types of Linear, Format and
Lookup.
Example:
For instance, in the event of a Comm error, a Data link will display ????.
A developer could change this to display !COMM! which may be more meaningful.
Likewise, @@@@ usually indicates that a networked node has not been found.
A developer could set this to !NET! to indicate network issues.
12-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
eBooks Topic
The Advanced Animations Dialog exposes every property which can be animated.
Properties like the objects name and its description cannot be animated.
The properties exposed also depends upon the object type. Text and Rectangles for
example have some common and some unique properties.
Search the iFIX Online Help and search for “Advanced Animations Dialog Box” to investigate
the list of tabs that are possible across the range of object types.
Look for this topic and the linked topics when you have time.
Figure 11-29 Online Help – Advanced Animation Dialog Box
GFS-154K
Education Services
12-19
Proficy iFIX Fundamentals - Animations
12-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
Lab Exercises – Animations
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Animate two-state equipment and other indicators in the Ingredients picture
 Animate objects in the Packaging picture
Introduction
The Ingredients display is very close to being ready for use in an operational environment.
By adding animations, you will augment DataLinks and data entry mechanisms with intuitive
visual cues that will provide real-time feedback to the operator.
You will also complete the animation development of the Packaging display.
You will use Animation Experts, the Basic Animation Dialog and the Advanced Animation
Dialog to accomplish this.
Lab Exercise #1 – Animate Objects in the Ingredients
display
1. Ensure that Workspace is open in Configure mode.
2. Let’s start with only open pictures being those we wish to work on. From the View Ribbon,
click Close All.
3. On your keyboard, click Ctrl – O. This is a Workspace Configure keystroke to open a
document, the default type being a *.grf picture. Look for the Ingredients picture and Open it.
Recall, you saved a copy of the very basic Tank with Inlet and Outlet Pumps in a Dynamo
Set (MyDynamos) in an earlier lab. The Tank, Inlet and Outlet Pumps on the Cellulose E460
tank still have those basic simulation sources configured, i.e. not our real plant data sources.
4. Double click on the Cellulose_E460 Inlet Pump object. It is actually a Dynamo. The
configured source is still set to Fix32.THISNODE.TANK1>INLETPUMP.F_CV.
5. Click the ellipses button for Pump Tag and using the Expression Builder select the Model
tab, and then from Instances of your THISNODE, the Cellulose_E460 InletPump.
Click OK in the Expression Builder and then OK again to close the Dynamo.
GFS-154K
Education Services
12-21
Proficy iFIX Fundamentals - Animations
6. Repeat this last step for the Outlet Pump object of the Cellulose_E460 tank, selecting the
OutletPump of the Cellulose_E460 Ingredient from the Model.
Since this was a Dynamo the animation, and the Toggle Digital Point control were
embedded with the object.
7. Double click in the Tank object for the Cellulose_E460 tank (the polygon). The Basic
Animation Dialog will appear.
8. Notice that both the Foreground Color and the Fill animations are already set. In the Color
section click the Foreground button.
9. In the Data Source field at the top, notice it is still assigned to the basic Tank1>Level tag.
Click the ellipses button to browse the Expression Builder. Select the TankLevel from the
Cellulose_E460 Ingredient from the Model.
10. Click OK to close the Expression Builder. Do not close the Foreground Animation Expert yet.
12-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
11. At the bottom of this Foreground Color Expert, check the Use Shared Threshold Table
checkbox, then click the ellipses button in the Shared Table field.
12. A restricted view Expression Builder will open, notice many tabs are missing. Move to the
Globals tab and expand the User folder, then select the tblLevelColor threshold table you
created in the Globals chapter. Then click OK at the bottom.
13. The bottom section of the Foreground Color expert should look like this. Click OK to close the
Expert.
You have now successfully animated the Tank Foreground color where the values from the
tag are passed into the Global Threshold table tblLevelColor, which returns the relevant
color and sets it as the Tanks Foreground Color.
GFS-154K
Education Services
12-23
Proficy iFIX Fundamentals - Animations
14. Back in the Basic Animation Dialog, click the Fill button.
15. In the Data Source field at the top, notice it is still assigned to the basic Tank1>Level tag.
Click the ellipses button to browse the Expression Builder. Exactly the same as the
Foreground Color, select the TankLevel from the Cellulose_E460 Ingredient from the Model.
16. Click OK to close the Expression Builder.
17. Click OK now to close the Fill Animation Expert. Click OK to close the Basic Animation dialog.
18. Double click now the Datalink for the Inlet Pump immediately above the Dynamo. Notice it is
still assigned to the basic Tank1>InletPump tag. Change its source using the Expression
Builder to the InletPump of the Cellulose_E460 Ingredient of the Model.
19. In the Datalink Configuration dialog, you will need to manually modify the Data Source field
selected from F_CV to A_CV. Click OK to close the Datalink Configuration dialog.
20. Repeat for the Outlet Pump. Double click the Datalink for the Outlet Pump immediately
below the Dynamo. Notice it is still assigned to the basic Tank1>OutletPump tag. Change its
source using the Expression Builder to the OutletPump of the Cellulose_E460 Ingredient of
the Model.
21. In the Datalink Configuration dialog, you will need to manually modify the Data Source field
selected from F_CV to A_CV. Click OK to close the Datalink Configuration dialog.
22. Save the Ingredients picture (Ctrl-S).
23.Next double click the rectangle representing the Inlet Switch of the Cellulose E460 tank to
open the Basic Animation Dialog.
24.Click the Foreground Color Expert button.
12-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
25. When the Foreground Color Expert opens, in the Data Source field, click the ellipses button
to open the Expression Builder. Browse the Model (you are getting that hang of this now!)
and select the InletSwitch of the Cellulose_E460 Ingredient. Then click OK.
26. Back in the Foreground Color Expert, check the Use Shared Threshold Table checkbox, then
click the Shared Table ellipses button to browse the Expression Builder for the Global User
Threshold table of tblBoolean.
27. Click OK to close the Expression Builder, then click OK again to close the Foreground Color
Expert, then lastly click OK to close the Basic Animation Dialog.
GFS-154K
Education Services
12-25
Proficy iFIX Fundamentals - Animations
28. Repeat the last step but for the Outlet Switch rectangle of the Cellulose_E460 tank, this
time selecting its OutletSwitch from the Model in the Expression Builder. Use the same Global
Threshold Table tblBoolean.
29. Next, double click the rectangle representing the Inlet Rate of the Cellulose E460 tank to
open the Basic Animation Dialog.
30.Click the Fill Percentage button.
31. When the Fill Expert opens, in the Source field, click the ellipses button to open the
Expression Builder. Browse the Model and select the InletRate of the Cellulose_E460
Ingredient. Then click OK.
32. Back in the Fill Expert, checkbox, check the Horizontal Direction checkbox then uncheck the
Vertical Direction checkbox. Horizontal Fill Direction should be set to Left to Right.
33.Click OK to close the Fill Expert, then lastly click OK to close the Basic Animation Dialog.
34. Repeat the last step but for the Outlet Rate rectangle of the Cellulose_E460 tank, this time
selecting its OutletRate from the Model in the Expression Builder.
12-26
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
35.Save the Ingredients picture (Ctrl-S) then Switch to Run Mode.
36.Firstly, click the Inlet Switch rectangle, and choose Stop, then click OK to close the
Pushbutton form.
37. Make sure that the Outlet Switch is in its CLOSE state and the Outlet Pump is Running, and
that the Outlet Rate is above zero, e.g. 1.
The Cellulose_E460 tank should start to drain as there is no inflow, you set the Inlet Switch
to Open.
The Outlet Switch is Closed, the Outlet Pump is Running and the Outlet Rate is above zero.
(State A below)
38.When the Cellulose_E460 Tank level is zero, Stop the Outlet Pump and Open the Outlet
Switch.
Then set both the Inlet Rate and Outlet Rate to zero 0. (State B below).
39.Next, Close the Inlet Switch and set the Inlet Pump Running. Then set the Inlet Rate to 2
and the Outlet Rate to 1. (State C below).
The Tank will now fill 2 units at a time. The Cellulose_E460 % level Datalink, the Fill
animation, and the tank Foreground Color animation all confirming this.
40.Lastly, Close the Outlet Switch and set the Outlet Pump Running.
Since the Outlet Rate is 1 and the Inlet Rate is 2, the Tank will now gradually fill 1 unit at a
time, confirmed by the animations. (State D below).
41. Observe the other Tanks. They are kept in balance as their Inlet and Outlet rates are equal.
These too are fully controllable in the same way as the Cellulose_E460 Tank, which you
configured!
42.Switch back to Workspace Configure (Ctrl-Q).
43. Save and close the Ingredients picture.
State A
GFS-154K
State B
Education Services
State C
State D
12-27
Proficy iFIX Fundamentals - Animations
12-28
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
Lab Exercise #2 – Animate Objects in the Packaging display
Part A – Color Animations
1. Ensure that Workspace is open in Configure mode.
2. Make sure only the pictures we wish to work with are open. From the View Ribbon, click
Close All.
3. From the System Tree locate and Open the Packaging picture.
4. For this we will use the Experts Toolbar. If you closed it earlier, re-enable it from the Home
Ribbon – Settings – Toolbars – under the Picture owner.
5. In the Conveyor Manual Control section highlight the State Control button. Recall you added
data control to this button in an earlier lab, when clicked it will toggle the state of the
Packaging Conveyor.
6. In the Experts Toolbar click the Foreground Color Expert button.
7. When the Expert opens, click the ellipses button in the Data Source field to open the
Expression Builder.
8. In the FIX Database tab, select the PackagingConveyorControl tag and its F_CV from
THISNODE, then click OK.
GFS-154K
Education Services
12-29
Proficy iFIX Fundamentals - Animations
9. Back in the Foreground Color Expert, check the Use Shared Threshold Table checkbox, then
browse the Expression Builder in the Shared Table field to select the User Global table of
tblBoolean.
Click OK to close the Expression Builder and the OK again to close the Foreground Color
Expert.
10. Repeat this last step for the Palletizer manual control button setting the Data Source tag to:
Fix32.THISNODE.PACKAGINGPALLETIZERSTATUS.F_CV
Use the same tblBoolean Global Threshold table.
11. Let’s look at an alternate way of accessing the Animation Experts. This time highlight the
Speed Setpoint button.
12-30
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
12. With this button highlighted, from the Tools Ribbon, and under Animations, click Foreground
Color.
If you are in Full Screen in Configure mode, click the Alt key first to pop down the Ribbons
briefly.
13. Configure the Foreground Color Expert as shown. This time using the local default Threshold
table.
The only task here is to select from the Expression Builder the Data Source of:
Fix32.THISNODE.PACKAGINGCVSPEED.F_CV
Then click OK.
14. Remember, keep Saving the Packaging picture as you proceed. Ctrl-S.
GFS-154K
Education Services
12-31
Proficy iFIX Fundamentals - Animations
Part B Visibility and Movement Animations.
1. Locate and highlight the red colored pallet graphic, then right click to reveal the menu
options.
At the top is Animations, click this to open the Basic Animation Dialog.
2. In the Basic Animation Dialog, click the Visibility button.
12-32
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
3. As with any Animation Expert, always select the Data Source first, the other properties will
often reset when the data source is changed. In this case, browse the Expression Builder to
select the tag:
Fix32.THISNODE.PACKAGINGPALLETIZERSTATUS.F_CV
Then click OK to close the Expression Builder.
4. Configure the Visibility Expert with a Condition of = and a Condition Value of 0 and a
Tolerance of 0.
Then click OK to close the Visibility Expert.
5. Click OK once more to close the Basic Animation Dialog.
6. Next, highlight the green pallet graphic. Almost exactly as the last few steps, configure using
the Visibility Expert again, the source tag is identical, PACKAGINGPALLETIZERSTATUS.
However this time the Condition Value is 1.
7. Now, keeping the Basic Animation Dialog open for the green pallet, also configure its
Movement Position Animation, click the Position button.
GFS-154K
Education Services
12-33
Proficy iFIX Fundamentals - Animations
8. Firstly, using the Expression Builder, set the FIX Database Data Source to the simple
simulation tag:
FIX32.THISNODE.ROTATE.F_CV
If you still have the Tag *pack* filter applied you will need to modify (e.g. *) and click the F
button.
9. Ensure that the Position is set to Horizontal and the Position Type is Relative.
10. The next few steps are important and must be done in order.
a. Left click and hold on the green pallet graphic, then drag it right until it is on top of
the red pallet graphic.
b. Next, click the Get Value button in the Minimum Offset field. Once clicked the green
pallet will jump back to its default location.
c. Then, once the green pallet is at its default location, click the Get Value button in the
Maximum Offset field.
What you have just done is taken out any guess work as to the coordinates of the start and
end points for the animation. The Position Expert is the only expert where interaction with
the object is possible.
d. Click OK to close the Position Expert, then OK again to close the Basic Animation
Dialog.
11. Save the Packaging picture. (Ctrl-S)
12-34
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
12. Switch to Run mode to test the new animations.
13. Click the Conveyor State Control button. When the Conveyor is Running it will be green,
when stopped it will be HPCharcoal (OK a dark grey). These colors are coming from the
tblBoolean Global Threshold Table.
14. Click the Palletizer button. When the Palletizer is Feeding it will be green, when it is Not
Feeding, it will be HPCharcoal. Again, these colors come from the tblBoolean Global Threshold
Table.
Also when Feeding the green pallet graphic will be moving left to right, from and to the
positions you set.
The red pallet will not be visible.
When Not Feeding the green pallet graphic will no longer be visible. The red pallet will now be
visible.
15. If you click the Speed Setpoint button, the Ramp Data Entry form will appear, as you increase
the speed, the color of the button will change at each 20 unit steps. Obviously as you will see,
the conveyor will also change speed, this being another horizontal position animation.
16. Other Data Control methods which you have already used in the Ingredients picture are also
here in the Packaging picture, see if you can find them!
17. Switch back to Configure mode when done.
GFS-154K
Education Services
12-35
Proficy iFIX Fundamentals - Animations
Part C – Advanced Animations
1. Back in Configure mode, with the Packaging picture still open, duplicate one of the existing
Datalinks.
Place it top center of the picture.
2. Highlight the Packaging label and duplicate. Double click on this duplicated text object to
modify its caption to PackagingStatus. Place this to the right of the Datalink duplicated in
step 1.
3. You know already that double clicking a Datalink will open its Configuration window, however
it is simply an animated text object. With the duplicated Datalink highlighted, right click and
choose Animations from the top of the menu.
4. In the Basic Animation Dialog, notice that none of the Basic animations are enabled, but
Advanced Animations is checked. Click the Configure button under this Advanced
Animations checkbox.
5. Note the arrow on the Text tab. This indicates that at least one property under this tab has
been animated.
Here observe that it is the Caption property.
12-36
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
6. Currently the Data Source will be from whichever Datalink you duplicated. Click the ellipses
button to browse the Expression Builder and select from the FIX Database tab the tag:
Fix32.THISNODE.BATCHPACKAGINGSTATE.F_CV
7. Configure the rest of this page as shown below, make sure that Data Entry Type is In-Place.
Then click OK to close the Advanced Animations Dialog, then OK again to close the Basic
Animations Dialog.
8. Next, right click on the duplicated text object with the PackagingStatus caption and choose
Animations. Double clicking a text object allows you to edit the text, it does not open the
Basic Animation Dialog.
9. Like you did with the Datalink, click the Configure button under Advanced Animations.
10. Move to the Text tab, then check the Animate checkbox for Caption. Then from the drop
down list of recently connected Data Sources choose the tag:
Fix32.THISNODE.BATCHPACKAGINGSTATE.F_CV
GFS-154K
Education Services
12-37
Proficy iFIX Fundamentals - Animations
11. Captions are usually Format converted, i.e. the numbers, decimal places or characters are
controlled, however Advanced Animations allows you to overrule these defaults.
In the Data Conversion drop down, choose Table, then with Table selected click the
Advanced button.
12. This Advanced Lookup Options window allows selection of a Shared Lookup Object, which will
be our Global Threshold Table for the Unit Statuses. Click the ellipses button in this Table
field, a reduced Expression Builder will open, select the User Global Threshold table of
tblUnitStatus, then click OK to close the Expression Builder. Then OK again three more times
for Advanced Lookup, Advanced Animations and Basic Animation Dialog boxes.
Through Advanced Animation you have just modified this text object to read the F_CV
status of the Packaging area then pass that value into the Global UnitStatus table, which
then returns the relevant string value to the text objects caption.
13. Save the Packaging picture (Ctrl-S) and then Switch to Run mode.
12-38
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
14. In run mode, using the In-Place method of writing a value, click onto the Datalink for this
Packaging State and type in the number 0.
15. If in a Zero state, it would indicate Stopped. 1 is Starting, 2 is Execute, and so on.
Type in incrementing values and observe the Status message. 0 to 20 are valid.
The tblUnitStatus table contains status values across different Plant areas therefore some
returned Status messages will not be relevant for the Packaging area. e.g. a value of 6 will
show Collecting, this will only be used to indicate the status of the iFIX Data Collector for
Proficy Historian.
You will see in a later lab exercise when you configure the Area buttons in the Header
picture, both the Status Color and Status messages will be shown.
GFS-154K
Education Services
12-39
Proficy iFIX Fundamentals - Animations
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 12 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
12-40
Education Services
GFS-154K
Proficy iFIX Fundamentals - Animations
Review Questions
1.
What are the advantages of using Animation Experts?
2. What are the disadvantages of using the Basic Animation Dialog?
3. What are the advantages of using the Advanced Animation Dialog?
4. What are the four Animation data conversion types?
5. Can you set static properties with the Advanced Animation Dialog?
Electronic Books Research
6. In the Basic Animation Dialog, what do the Enable Highlight and Enable Select check
boxes do?
GFS-154K
Education Services
12-41
Proficy iFIX Fundamentals - Animations
Review
Now that you have completed this module, you should be able to:
 Define Graphic Experts
 Use the Basic Animation Dialog Box
 Describe the Advanced Animation Dialog Box
 Configure Animations and Global Threshold tables
 Classify the four types of Animation Object
12-42
Education Services
GFS-154K
0)
13
INTRODUCTION TO VBA
a
At the end of this module, you will be able to:
 Define Visual Basic for Applications
 Explain where VBA is used in iFIX
 Utilize the Visual Basic Editor
 Use VBA scripting in iFIX
 Explain iFIX and Microsoft VBA examples
65%
Proficy iFIX Fundamentals - Introduction to VBA
13-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to VBA
HMI
Overview
The Workspace comes with a wide variety of helpful and flexible tools to assist in HMI
development. However, there are limits to what these tools can do. For multi-step
operations, data management and logic evaluations, custom scripting is often the most
effective tool to deploy. To address this, the Workspace uses Visual Basic for Applications
(VBA) as its scripting engine.
VBA is an object-oriented scripting language that allows powerful and elegant features to
be built into iFIX displays. These scripts are part of the document and do not require
separate resource files to run. They are also interoperable with many third-party objects
and applications, providing the Workspace with impressive extensibility to other areas of
the organization.
By its very nature, VBA is event-driven and highly efficient. It does not require the
programmer to write cyclical evaluation steps to determine when to act, it uses an event
handler to detect object-dependent occurrences and respond with scripted actions. Many
scripts involve a single line of code, making it a reasonably friendly scripting language for
beginners.
Figure 13-1. Example of VBA scripting within an iFIX display
GFS-154K
Education Services
13-3
Proficy iFIX Fundamentals - Introduction to VBA
iFIX Workspace Scripting
Scripting can be used within iFIX to add elegant solutions to common HMI requirements.
The following list includes scenarios to which VBA is well suited.
 Incorporating intelligent display navigation
 Performing object manipulation (though duplicating animation features should be avoided)
 Expanding alarm display and acknowledgement functions
 Implementing additional security features
 Building custom data entry interfaces to read and write from data sources and tags
 Providing additional operator prompts
 Adding specialized forms
 Creating custom toolbars
 Launching other Windows based applications
 Calling external Functions contained in other DLLs, EXE, REST APIs or Python scripts
VBA should be used judiciously to extend the HMI environment, not to replace core features
for which there are already effective and efficient tools (such as animations and controls).
Warning
VBA is a tool from a toolchest.
If a screw is to secure a bracket onto a wall, a screwdriver is obviously the best
tool to choose. However very skilled use of a sledgehammer could also drive the
screw into the wall, but in the hands of most people it has the potential to knock
down the wall!
VBA is the sledgehammer! Always look to see if a better tool exists.
Sometimes however the task is to knock down the wall. In those cases, it is the
sledgehammer that is required. Sometimes only VBA is capable of delivering.
Visual Basic for Applications
Visual Basic for Applications (VBA) is an object-oriented and event-driven scripting
environment that supports Microsoft forms and Active X Controls. It is embedded within a
parent application and its documents. Scripts can only run when that parent application is
open and running. Thus, for VBA scripting to run within iFIX, the Workspace must be open
and in Run mode. VBA scripts in documents are sorted into projects. Each project has
multiple components such as objects, forms, modules, and references. The scripts belong
to the project, and the project in turn belongs to the document. For example, the
Ingredients, Blending, Granulation and Packaging pictures all have their own unique VBA
projects to handle their scripts. When a document or object is copied or moved, all
associated scripts are copied or moved as well.
Visual Basic (VB) is an application that is used by programmers to create applications (EXE
files), application resources (DLL files), forms (FRM files) and controls (OCX files). VB also
uses VBA as its scripting engine. Like the Workspace, it is a parent application for VBA and
is not to be confused with VBA itself.The Visual Basic Editor (VBE) is the primary interface
used to develop and manage VBA scripts. This interface can be accessed from the
Workspace in a variety of ways.
13-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to VBA
Visual Basic Editor Orientation
The Visual Basic Editor (VBE) can be opened from the Workspace in a number of different
ways. Scripts can be assigned or accessed by selecting an object and using the right-click
mouse menu. Near the bottom of the menu is Edit Script. This will automatically open the
VBE to the current document project and display any scripts assigned to the selected
object. If there are no scripts, an empty script will be created using the object defaults.
The VBE can also be accessed in a more generic way, without the benefit of automatically
selecting projects and objects. The Home Ribbon provides a button to access the VBE.
Figure 13-2. Accessing the VBE from the right mouse menu
Figure 13-3. The Visual Basic Editor
GFS-154K
Education Services
13-5
Proficy iFIX Fundamentals - Introduction to VBA
Project Explorer
The Workspace has many different documents open at any given time, most of which have
some form of scripting in them. The Project Explorer is a browser pane that allows the
developer to navigate through the available projects. In order for a picture project to appear
in this pane, it must be open. Pictures, toolbars and the User Global file are examples of
Workspace documents that appear in the Project Explorer.
Each project has multiple folders for organizing scripting essentials. General object scripts
fall under the Workspace Application folder. Additional support modules with extra scripts
are kept in a Modules folder, user Forms have their own location as well. Finally, when a
project requires resources from another project or application, the links to these resources
are enumerated in the References folder.
Code Pane
If a project is selected, the scripts for all the objects in the project will be shown in the Code
Pane, a text editor on the right side of the VBE. Each object with a script will be given its
own section of the code pane, delimited by horizontal break lines. Each script will be
initiated by an event associated with a target object. For example, a data entry script can
be fired by the Click event associated with a Pushbutton object. The script will run all
instructions in sequence until it reaches a terminating statement (for example, End Sub or
Exit Sub).
The instructions will not be executed again until the event recurs.
Objects and Events
There are two main methods for selecting objects to have scripts assigned.
The first method is from the Workspace. Select the object and then use Edit Script from
the right-click mouse menu.
The second method is from the VBE. It includes using the Object and Event selection boxes
at the top of the code pane. The object selection box will show all registered objects
available for scripting. Objects that are not found here may be manually added by using the
right-click mouse method of access. Once an object is selected, a new entry will be created
in the project using the default event (often Click or KeyDown). Alternate events can be
selected after the object is selected. As with properties, each object will have its own
unique set of events to choose from.
Property Window
The Property Window can be opened in the VBE by using the F4 key. It will show the same
information that is displayed using the Property Window in the Workspace.
13-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to VBA
Toolbars
Various Menus and Toolbars offer tools ranging from creation of Procedures and VBA forms,
to testing and debugging tools. Continued use and development of VBA will familiarize
users with the most common and useful features.
Figure 13-4. The Visual Basic Editor Toolbar
Help, Auto Quick Info and Auto Quick List
To help beginner and experienced programmers alike, VBA provides Help with commands,
objects and properties. For Help with Microsoft commands, objects and properties, the F1
key can be used. For iFIX objects, properties and subroutines, the iFIX Automation Help
found in the Help menu provides documentation to assist with writing scripts.
For either iFIX or Microsoft subroutines, just partially entering the proper syntax will prompt
a subscript guide for all necessary and optional parameters. This assistance is referred to
as Auto Quick Info. A bold font will indicate the programmer’s progress through the current
subroutine.
Figure 13-5. Example of Auto Quick Info for an iFIX and a Microsoft VBA subroutine
There is an Auto Quick List function that can accelerate the typing process and reduce
typographical or spelling errors. After partially typing the object or subroutine, use the
CTRL+SPACE keystroke. This function will automatically complete the entry, or it will
provide a list of options using the partial entry. When using Objects, VBA will automatically
provide the list of available options once the object name has been completely entered.
Figure 13-6. Example of Auto Complete with an iFIX object
Often the best way to learn is “as you go”. Take advantage of the experience of other
programmers. Also, read the examples of scripts that are present in the iFIX Automation
Help and examine those built by the various tools in the Workspace. Best practices, naming
conventions, tips, tricks and reusable code are all embedded in a wealth of existing iFIX
scripts.
GFS-154K
Education Services
13-7
Proficy iFIX Fundamentals - Introduction to VBA
Microsoft and iFIX Automation Help
VBA is a useful tool for customizing the HMI component of iFIX. Nearly all commands, from
data entry to navigation, are possible because of VBA. The Workspace comes with many
user-friendly, mouse-configurable tools to deploy VBA scripting. Nearly every facet of an
HMI can be built without scripting, but VBA provides many possibilities for better interfaces,
quicker and more efficient operation, and reliable and time saving automation of routine
tasks.
The root strength of VBA comes from the objects available in the parent application.
Scripted solutions are only as flexible and powerful as the objects they interact with.
Fortunately, iFIX provides a rich set of objects tailored to real-time control systems allowing
developers to mold creative customized solutions to fit specific industry requirements.
When combined with the many pre-built subroutines, programmers can quickly build and
deploy scripts to address nearly any problem or need.
Two separate help systems are available to the developer.
One contains references to the Microsoft VBA model including help on Objects,
Subroutines and Functions to name only a few.
Figure 13-7. Example of Function help in the Microsoft VBA Reference
13-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to VBA
The other is the iFIX Automation Reference which contains help on Objects, Properties,
Methods, Events, Subroutines and Functions included with iFIX.
Figure 13-8. Example of Subroutine help in the iFIX automation Reference
GFS-154K
Education Services
13-9
Proficy iFIX Fundamentals - Introduction to VBA
Objects
Objects are the cornerstones of VBA. So far, objects have been described primarily in terms
of their properties. It can be helpful to name objects when they are created in a picture to
make reference to their function or equipment representation.
e.g. If a number of Tanks in a picture are all left at their default name of Polygon1, Polygon2,
Polygon3, it makes it difficult to identify in the VB Editor which code belongs to which Tank.
If however the objects were given names relevant to the object type and its function, it
would be far clearer in the VB Editor, e.g. pgE460, pgE470b, pgpHStabilizer etc.
This is easily achieved by modifying the objects ‘name’ property in the Property Window.
Properties
We can set properties with VBA scripts by writing simple one-line statements (that look
much like equations). For example, when defining the RotationAngle property of Rect1, we
specify the object and property and then equate the property to a value. For RotationAngle,
this will be a number representing the number of degrees from zero to rotate the object
clockwise.
Rect1.RotationAngle = 45
For other properties, it may be an integer value, a true or false value or perhaps a text value.
Every property has a help entry that will reveal what is required to set its value (use the F1
key to open context-sensitive help).
Besides properties, objects have other qualities of specific interest to VBA.
Methods
Just as each object has a unique set of properties that describe it, objects also have a
unique set of behaviors that govern what they can do. These behaviors are known as
methods. Methods are like subroutines, invoked only by scripts, but are built into the object
itself.
For example, a chart can show data to a higher magnification by using its Zoom method.
Likewise, using the RefreshChartData method can refresh its data. Other shapes can
rotate, move or refresh using methods (rather like animations, but less efficient for rapidly
updating values). As with properties, methods have help to explain how to use them.
Sometimes all that is required is to invoke the method. For example:
Chart1.RefreshChartData
Other Methods may require extra parameters to control how they affect the object. For
instance, this Rotate method requires a numeric value to determine the angle to rotate, and
a parameter to define whether the angle is measured in radians (True) or degrees (False).
Rect1.Rotate 45, False
13-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to VBA
Events
Events are rarely used within scripts. Instead, they are associated with objects in order to
trigger script execution. As the majority of the objects in an HMI are graphical in nature, the
more important events concern operator interaction via the mouse or keyboard. However,
events can be generated as a result of other actions taken in the system. For instance,
pictures have an Initialize event (fired when the picture opens) that can trigger other script
execution. It can be taken advantage of to automatically “tag on” extra work specific to that
picture.
Events usually appear in tandem with objects as the header of a procedure.
For example:
RoundRect5_Click
This indicates that the associated script is only to be executed in response to an operator
mouse click on the RoundRect5 (a Rounded Rectangle) object. This action may be set with
the Object and Event selection boxes at the top of the code pane in the VBE.
Figure 13-9. Example of objects, properties, method and events
GFS-154K
Education Services
13-11
Proficy iFIX Fundamentals - Introduction to VBA
Subroutines
Subroutines are conveniently packaged commands that execute more complex operations
such as opening pictures or changing tag values. They generally boil multi-line scripts down
to a single statement with parameters to define how and what to do. The subroutines are
not specifically object-based and can be used anywhere in a script.
Command and Script Experts
The Commands tools on the Tools Ribbon has a number of commands that automatically
write scripts using parameters gathered through forms. These include navigation tasks,
alarm management and the data entry tasks discussed earlier.
Figure 13-10. Command experts
13-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to VBA
Commonly Used iFIX Subroutines and Functions
Subroutine/Function
Description
AcknowledgeAllAlarms
Acknowledges all the alarms for tags used in a specified
picture
DisableAlarm
Disables alarm detection for a specified tag
EnableAlarm
Enables alarm detection for a specified tag
CloseDigitalPoint
Closes a digital tag (sends a 1)
OpenDigitalPoint
Opens a digital tag (sends a 0)
ToggleDigitalPoint
Change a digital tag value to its opposite
ClosePicture
Closes the specified picture
OpenPicture
Opens the specified picture
ReplacePicture
Replaces a target picture with a new picture. The target
picture dimensions and location are maintained in the
new picture
OnScan, OffScan,
ToggleScan
Changes the scan status of a tag in the PDB
ReadValue, WriteValue
Allows VBA scripts to interact with values from the PDB
Login
Launches the security login form
Figure 13-11. Commonly used iFIX subroutines
GFS-154K
Education Services
13-13
Proficy iFIX Fundamentals - Introduction to VBA
Commonly used Microsoft Subroutines and Functions
MsgBox
Creates a custom dialog box for operator interaction
InputBox
Allows for simple operator interfaces
Format
Changes the format of values (ie. numeric to date and
time)
+, &
Adds numbers or text together to create larger results
If Then Else
Allows for simple conditional logic
For Next
Allows for evaluation loops
Exit Sub
Exits script immediately without finishing remaining
statements
Figure 13-12. Commonly used Microsoft Subroutines and Functions
13-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to VBA
Troubleshooting Topic
Badly written custom VBA is a sure-fire way to render an HMI useless.
One line of code has the potential to leave Workspace hanging in an infinite loop.
Remember VBA is the sledgehammer.
Write custom VBA code wisely.
The Command or VBA Experts provided are great at writing clean code automatically, one
action at a time.
The Multi Command Script Wizard, again automatically will add the required clean VBA
code, but for multiple actions at a time.
If custom VBA code is to be used, there are many rules to follow. The iFIX Scripting class is
a follow on course which teaches the basics of scripting, rules to follow, tips and techniques
to avoid those potential pitfalls.
Error Handling
Error Handling should be used with any custom VBA code.
Basically, if anything goes wrong during the execution of the VBA script, rather than
hanging, the script will typically jump out to a safe place.
Figure 13-13. Custom VBA Code with an Error Handler
GFS-154K
Education Services
13-15
Proficy iFIX Fundamentals - Introduction to VBA
eBooks Topic
If using the iFIX Command Experts, these call iFIX Subroutines which have Error Handlers
already build in. For writing to tag values using WriteValue, or ToggleDigitalPoint, the action
the in-built error handler takes can be controlled. The default, if only using the Expert and
not modifying anything in the VB Editor, is to provide the user with a friendly prompt. For
example, if trying to enter a value which is out of range, the prompt will inform of this
restriction.
This default of prompt can be overridden.
Search the iFIX Online Help and search for “Tracking Errors” to investigate the options when
using iFIX Subroutines. Take a look at this topic and its examples when you have time.
Figure 13-14 Online Help –Tracking Errors
13-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to VBA
Lab Exercises – Introduction to VBA
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Explore the User Project.
 Import a user form into the User Project.
 Write a script in the User Project and call from a picture.
 Modify the Packaging picture to interact with the operator using VBA.
Introduction
The User Project is the User Globals scripting area. We can view the User Project in the VB
Editor.
Anything stored in the User Global area and will be made available to all pictures throughout
the Workspace.
You will import a pre-made form for selections of Alarm Areas and later, call the forms from
a picture.
You will also write VBA scripts to interact with the operator, asking for setpoints and
through various prompts enter a Batch Order value.
Lab Exercise #1 – Project User and Forms
Part A – Investigate Project User
1. Ensure you are in Workspace Configure mode and
close all open pictures.
Use the Close All button in the View Ribbon.
2. Open the VB Editor, either from the Home Ribbon, or
from the Quick Toolbar, click the Visual Basic
Editor button.
GFS-154K
Education Services
13-17
Proficy iFIX Fundamentals - Introduction to VBA
3. Use the Project Explorer on the left to browse to Project_User.
Expand the Workspace Application Objects Folder and double-click the User globe icon.
The code pane should now be showing the User global scripts.
4. Observe the entries in the Code Pane. These are the Global Key Macros you created for
Ctrl-L to run the Security Login, and a yet to be created HMIReset when the Home key is
pressed.
The custom key macro for Ctrl-Q (Switch to Configure) is also present here.
Part B - Import a form to the User Project.
1. In the Project Explorer, right-click the Project_User (User*) folder. Choose Import File.
Navigate to the C:\ClassFiles\13. VBA\ folder and select the frmAreaChoose.frm file.
Then click Open.
It has Imported the form, you must follow the next step to view it. Do not try to import a
second time.
2. Examine the Project Explorer for Project_User. You should see a new Forms folder.
Expand the folder and double-click the frmAreaChoose form.
13-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to VBA
Eventually, we will use this form to assign filters to Alarm Summary tables in a later chapter.
The user will select the alarm areas and pass the result to a Global Variable. Objects can
then use this variable to assign filtering to the Alarm Summary table.
3. Save the User Project. Click Ctrl-S or click the Save icon (traditional floppy disk icon!) in the
toolbar.
Since Project User is contained inside the User.fxg file, any Globals, so Variables, Threshold
tables etc have also been saved.
Next you will write a script to launch the new form. This can be called from any picture as it
resides in Project_User.
4. Double click once more on the User Global icon in the VB Project Explorer to load the Code
window with the User code showing the Key Macros.
5. Next, click the Insert Menu and then Procedure.
6. You will be prompted for information by a brief dialog box. For Type, select Sub to create a
subroutine. We want to be able to use this procedure from anywhere, so set the Scope to
Public.
Name the Sub LaunchAreaForm.
7. Click OK to create the Procedure.
GFS-154K
Education Services
13-19
Proficy iFIX Fundamentals - Introduction to VBA
Notice how an empty procedure has been added to the Code Pane for the User project.
This is where we will write the script to open the Global Alarm Area form.
8. Under the LaunchAreaForm but before the End Sub, i.e. the blank line in the middle where the
cursor will be focused, type in:
frmAreaChoose.Show (False)
Note that the Auto Quick List window pops up as you terminate the frmAreaChoose object
with a period. You can continue typing the word Show, or you can choose it from the list.
The (False) parameter will ensure that the form runs regardless of its mode (an advanced
topic).
To call this procedure from a picture, we will use the name of the procedure
(LaunchAreaForm).
The completed User scripts should look like this:
9. When finished, click the Save button again in the VB Editor, or Ctrl-S.
This form will be called in a later lab exercise.
13-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to VBA
Lab Exercise #2 – Control using VBA in the Packaging
picture
Part A – Change a Setpoint using VBA
1. When in the VB Editor, in order to switch back to Workspace,
from the File menu, click Close and Return to Workspace Application, or Alt -Q on the
keyboard.
2. Now, open the Packaging picture. Either using the System Tree or from Workspace Open or
Ctrl-O.
You should have the hang of this by now.
3. From the Home Ribbon click Full Screen.
4. Locate in the Conveyor Manual Control section, the Speed Setpoint Datalink. Right click on it
and choose Edit Script.
The VB Editor will open, and a new Procedure will have been automatically created for the
Click event of this Datalink.
5. Start Typing in the VBA to write a value to a tag. Type in
Writevalue “15”, “PackagingCVSpeed”
6. Observe how the Writevalue iFIX Subroutine provides Quick Info about what is expected:
GFS-154K
Education Services
13-21
Proficy iFIX Fundamentals - Introduction to VBA
7. Close the VB Editor and return to Workspace. (Alt-Q).
8. In Workspace click Ctrl-S to save the picture. Since the VBA code belongs to the Datalink
which in turn belongs to the picture, saving the picture saves the VBA.
9. Switch to Run Mode, and make sure that the Conveyor Speed is not currently 15.
Click the Setpoint button to ramp the value up or down if needed.
10. Now click the Speed Setpoint Datalink to which you just added the VBA code.
The value changes to 15. The Writevalue Subroutine assumed the local THISNODE and the
F_CV field. If an alternate Node or field was desired, these will need to be added.
11. Switch back to Configure mode.
12. Open a Windows File Explorer and navigate to the folder: C:\ClassFiles\13. VBA\
Locate and open the text file SetpointVBA.txt in Notepad.
13. Highlight all the text in this file, then right click and choose Copy, or Ctrl-C.
14. Switch back to Workspace, and once again right click on Speed Setpoint Datalink and
choose Edit Script.
15. Highlight the WriteValue line only, and click delete, then either right click and choose Paste,
or click Ctrl-V.
16. Notice the line in green, this is a comment. On the line immediately after the comment type
in:
WriteValue strNewVal, “PackagingCVSpeed”
13-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to VBA
This VBA script you have added, uses two operator interaction functions. The Message Box
asking simple Yes , No type questions, and the InputBox facilitating a user defined entry
value.
VBA Variables are used as the inputs to both of these function.
Additionally, a VBA Error Handler is employed.
17. Close the VB Editor (Alt-Q). Save the Packaging Picture (Ctrl-S), then Switch to Run Mode.
18. Click the Speed Setpoint Datalink. A MessageBox appears asking if you wish to change the
Speed.
Click Yes.
19. Next, an InputBox will appear asking you to enter a new value. Type in a value between 0 and
100, e.g. 23. Then click the OK button.
20. Observe that the new value has been written and the Conveyor Speed has changed.
Try alternate buttons on the MessageBox, or different values in the InputBox.
You will have to de-select the Speed Setpoint Datalink by clicking else where in the picture
first, then clicking back on the Datalink once again.
21. When done, Switch back to Configure mode, and ensure that the Packaging picture has been
saved.
GFS-154K
Education Services
13-23
Proficy iFIX Fundamentals - Introduction to VBA
(Optional) Part B – Operator interaction using VBA
1. In the Conveyor Manual Control section, right click on the Unit Order button and choose Edit
Script.
2. In the VB Editor, in the Project Explorer, right click on the Packaging picture and choose
Import File.
3. In the Import File window, select from the folder C:\ClassFiles\13. VBA\ the file
modOrders.bas, then click Open.
13-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to VBA
4. When Imported, expand the Modules folder of the Packaging picture, observe the new
modOrders module.
Double click on modOrders to view its code window:
5. When jumping around in the VB Editor from code window to code window, it is sometimes
easier to switch back to Workspace in order find the code relating to a specific object.
Click Alt-Q to switch back to Workspace, then again as before, right click on the Unit Order
button and choose Edit Script.
6. Start to type in the name of the new Public Procedure imported with the modOrders module.
Type in only the letters Or. Then click Ctrl – Spacebar on your keyboard. This is the VB Editor
Auto Complete function. A list will appear.
7. OrderUpdate is the Procedure you need to select. Simply highlight OrderUpdate from the list
then click either the spacebar or enter on your keyboard to complete.
8. Switch back to Workspace (Alt-Q) and Save the Packaging picture (Ctrl-S).
9. Switch to Run mode.
10. Click the Unit Order button.
A MessageBox will ask if you wish to load a new Batch Order
from SQL. No, will terminate the process.
11. Click Yes.
GFS-154K
Education Services
13-25
Proficy iFIX Fundamentals - Introduction to VBA
A MessageBox will let you know that VBA
interaction with SQL is covered on the
Advanced iFIX class (sorry!).
12. Click OK.
13. But to processed in the meantime you can enter a
manual value. Click OK.
14. An InputBox will request a new value, type in a
new value, or leave at the default of 20,000.
Click OK.
15. Lastly a Confirmation is presented to accept
this new value,
click Yes.
Observe the changed Unit Order. The Completed % against Remaining % will indicate how
far through the Ordered batch the system currently is.
13-26
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to VBA
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 13 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
GFS-154K
Education Services
13-27
Proficy iFIX Fundamentals - Introduction to VBA
Review Questions
1.
What is the difference between VB and VBA?
2. Provide three examples of how VBA scripting can extend a normal HMI application?
3. What VBE tool allows you to browse projects for all open documents in the Workspace?
Provide two Workspace document types that can be browsed with this tool.
4. What is an Event? What is a Method. Give two examples of each.
5. Can scripts and forms be imported and exported through the VBE? If so, how?
Electronic Books Research
6. Using the Microsoft VBA Reference help, name the arguments that apply to the
Message Box function?
13-28
Education Services
GFS-154K
Proficy iFIX Fundamentals - Introduction to VBA
Review
Now that you have completed this module, you should be able to:
 Define Visual Basic for Applications
 Explain where VBA is used in iFIX
 Utilize the Visual Basic Editor
 Use VBA scripting in iFIX
 Explain iFIX and Microsoft VBA examples
GFS-154K
Education Services
13-29
Proficy iFIX Fundamentals - Introduction to VBA
13-30
Education Services
GFS-154K
0)
14
NAVIGATION
a
At the end of this module, you will be able to:
 Define general concepts of Navigation
 List tools for building iFIX HMI Navigation
 Configure a picture Navigation system
70%
Proficy iFIX Fundamentals - Navigation
14-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Navigation
HMI
Overview
Screen navigation is an important element of any HMI application. The users must be able
to switch between displays quickly and efficiently in order to address current operating
conditions. Certain methods lend themselves better to specific tasks, so varieties of
mechanisms are often used within the same project. The key is to make the navigation
features simple and intuitive to use, with consistent and efficient results.
The Workspace has a set of three command experts for simple navigation: Open, Close and
Replace Picture. These experts can be applied to any type of object, but it is best to use
the same types of objects throughout an application.
Figure 14-1. Navigation Buttons in a Header example
Using a separate picture as a Navigation tool does require a little more VBA work. It is not
wizard driven, but is probably the most common method found in use today with iFIX.
Figure 14-2. Menu Control - Productivity Pack
This Menu Control installs by default with the iFIX 2022 Integrated Installer and is part of the
Productivity Pack tools. This is a 3 rd party configurable ActiveX Control, which takes away
many of the traditional complexities of VBA.
VBA Forms, Combo boxes, Tree Controls, all again ActiveX Controls, are also excellent
alternatives, these however require even deeper levels of VBA to achieve a desirable result.
GFS-154K
Education Services
14-3
Proficy iFIX Fundamentals - Navigation
Navigation Essentials
Before implementing navigation in pictures, it is best to plan out a strategy to ensure the
most effective system for the user. How navigation is deployed will depend on a few
things. Whether the mouse or keyboard is the primary input interface, whether the pictures
will be built to use a separate navigation banner or picture, how many pictures need to be
opened and closed and how much space can be dedicated to navigation.
It is best to design a consistent look and feel for the user so that navigation is easy and
intuitive. Consistent standards for naming buttons or text labels, as well as color can prove
very helpful for identifying navigation links. These should be distinctive from other
onscreen text or objects, and consistent in each display so that the user does not need to
learn multiple systems for finding the information they are looking for. Locations for
navigation links should also be consistent, whether it is specific location in pictures, or
responses to actions on equipment or indicators.
The system should also be built with future growth in mind. Common or shared elements
such as forms, key macros and navigation banner and bars will help minimize maintenance
should the number of pictures grow. The navigation scheme should be able to
accommodate the addition of displays without a large burden of effort.
Common Navigation Schemes
Pop-up Pictures
Smaller pop-up or sub-pictures are often created to assist with data entry or detailed
analysis, usually for equipment within a larger screen or area. These pop-ups will be always
on top of the main screen and can be easily closed once the user is finished. For densely
populated graphics used by experienced users, these pop-ups navigation links can be
assigned directly to the equipment. For less densely populated screens or those used by
casual users, pop-up navigation should be assigned to a text label or nearby pushbutton.
This navigation method can be easily deployed using the Navigation experts.
Chain Navigation
Chain navigation works with full screen pictures and uses Previous and Next buttons to
move between areas depicted by the displays. This works well in certain processes where
materials flow from one location to the next in a prescribed order. For example in our
course system, Ingredients flow from the Ingredients Tanks to the Blending area then onto
the Granulation area, then on to Packaging.
Chain navigation allows the user to move forward and back through the process areas in a
prescribed order. For situations where there is parallel or lateral processing, other
navigation methods will have to be added to round out a user’s options. As with pop-up
pictures, the Navigation Experts can be used to provide quick development of these
features.
14-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Navigation
Point-to-Point Navigation
Point-to-point navigation is used within full screen pictures to navigate directly to a target
display. Compared to Chain navigation, this reduces the number of steps to get from one
display to another, but it also requires more space for extra buttons, as well as a higher
development effort for adding pictures later. These are highly intuitive however, and even
new users can navigate easily with this method. Each picture will use its own set of
navigation links and can be configured using the navigation experts.
Navigation Forms
Navigation forms are very economical space-wise as they can be hidden from view when
not required. They can contain and organize information effectively using tabs, text, and a
variety of buttons. Another benefit is the global nature of a form. Multiple pictures can use
a single interface. However, they must be launched before they can be used, adding at
least one extra step to navigation. Also, unless launched from clearly labelled objects, they
can be harder for casual users to employ. They also can be difficult to build and usually
require strong VBA scripting skills.
Navigation Banner or Bar
This method employs a side or banner picture to hold the common navigation links to be
used within the application. This picture will be permanently open and available to replace
the main process screens. It is a simple and intuitive method of presenting navigation
options to users, and the development effort to accommodate growth is much smaller than
for the point-to-point method. However, it leaves less room for the main process screens,
which need to be resized from full screen pictures to accommodate the Navigation picture.
As with the navigation form method, it also requires scripting capabilities.
Key Macros
This is the ultimate space-saving method of navigation, also providing the least amount of
effort to navigate directly to an intended screen. Global Key Macros can be used to open
displays from anywhere, at any time (using for example the function keys). Picture-based
key macros can be used to open specific pop-up screens from within the display itself.
Commands can be assigned using the Navigation experts, or scripting.
One drawback to this method is that keyboards are not always available at all plant
workstations. Another is that casual users may not be aware of many (or any) of the
keystrokes required for navigation.
GFS-154K
Education Services
14-5
Proficy iFIX Fundamentals - Navigation
Navigation Experts
Open Picture
The Open Picture Expert provides a very basic interface for opening pictures in a
designated location. Pictures can be browsed from anywhere on the network, though they
are generally stored in the project PIC path. The Picture Alias is optional and specifies a
temporary nickname that can be used by command experts or scripts, (such as Close
Picture and Replace Picture). This allows a developer to use a generic name (such as
“CurrentPic” or “PopUp”) to identify a picture.
Figure 14-3. Open Picture Expert
Position is measured in logical units (generally 100 wide by 75 high) from the top left corner
of the Workspace, regardless if using Enhanced Coordinates or not.
This expert will open the target picture on top of those already opened and, as such, is an
effective tool for opening pop-up or analytical pictures. As with all navigation experts, it can
be applied to any object and uses a single click to trigger the action. If opening a pop-up
type display, then it’s a good idea to set the picture property of Always on Top to true.
14-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Navigation
Close Picture
The Close Picture Expert simply closes a picture. It can close another target picture, or the
picture the navigation link resides in. The Picture Alias can also be supplied to close any
open picture using that Alias (such as the generic nickname “PopUp”).
Figure 14-4. Close Picture Expert
Replace Picture
The Replace Picture expert combines features from the Open and Close Picture experts. It
can replace any target picture (or simply the current picture) with a new display. In effect, it
closes the target picture and opens a new one. One interesting feature of this expert is how
the new picture inherits the size and location of the previous picture. If the pictures are
different sizes, the new picture will be scaled (sometimes with unintended results).
Figure 14-5. Replace Picture Expert
GFS-154K
Education Services
14-7
Proficy iFIX Fundamentals - Navigation
Scripts
Each navigation expert has an accompanying iFIX VBA Subroutine.
Private Sub cmdIngredientTank_Click()
OpenPicture “IngredientTank.grf”, , , , 1
End Sub
Figure 14-6. OpenPicture Subroutine
Private Sub cmdCloseMe_Click()
ClosePicture , 1
End Sub
Figure 14-7. ClosePicture Subroutine
Alternately, it could use the following VBA script with the PictureAlias:
Private Sub cmdClosePopUp_Click()
ClosePicture “Popup”, 1
End Sub
Figure 14-8. ClosePicture Subroutine using PictureAlias
Private Sub cmdBlending_Click()
ReplacePicture “Blending.grf”, “Granulation.grf”
End Sub
Figure 14-9. ReplacePicture Subroutine
In the ReplacePicture subroutine, the old picture name can be substituted with a
PictureAlias.
Private Sub cmdBlending_Click()
ReplacePicture “Blending.grf”, “CurrentPic”
End Sub
Figure 14-10. ReplacePicture Subroutine using PictureAlias
As we will see in our course Navigation system, when using the ReplacePicture subroutine,
the old picture name will be substituted using a Global Variable Current Value, already
formatted as a String.
Private Sub cmdBlending_Click()
ReplacePicture “Blending.grf”, user.varCurrentPicture.CurrentValue
End Sub
Figure 14-11. ReplacePicture Subroutine using a Global Variable
14-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Navigation
User Preferences
There are a few items that can be set in the Workspace User Preferences to affect the
navigation environment. We have discussed these in earlier chapters.
General Preferences
On the general tab, the Workspace can be set to use Full Screen in Run Mode, and to
automatically start in Run mode. If starting in Run Mode, the Startup Pictures list will be
used to open pictures automatically.
Figure 14-12. General Preferences
Picture Preferences
The picture cache size can be changed in the Picture Preferences page. This cache will
hold recently used pictures in memory for quick transition. There are two components to
this cache: a permanent cache (set in the FixuserPreferences.INI file) and a temporary FIFO
cache. Caching can be enabled or disabled, and the cache size (the total number of
pictures in the Permanent and FIFO cache) can be set.
Figure 14-13. Picture Preferences
GFS-154K
Education Services
14-9
Proficy iFIX Fundamentals - Navigation
Troubleshooting Topic
The ReplacePicture Expert using the ReplacePicture iFIX VBA Subroutine, should only be
used where the picture to close and the picture to open, are of the same dimensions and
location.
The rule here is that the picture to open will assume the same dimensions and location of
the picture being closed.
This can cause unintended consequences if not followed correctly.
A smaller picture opening could be stretched to fill the dimensions of a larger picture being
closed. Not so bad, but still a poor navigation technique.
A larger picture opening could be squashed to take up the dimensions of a smaller picture
being closed. A very poor navigation technique. The subsequently opened picture may have
its objects and text rendered unreadable.
Therefore, when using the ReplacePicture Expert make sure the dimensions and locations of
the two pictures are identical.
eBooks Topic
It is possible, and useful, to sometimes open Multiple Instances of the same pictures.
iFIX is Object orientated, objects are addressable by their name, and as such no two objects
with the same name can be active in Workspace at the same time.
iFIX employs an aliasing technique to allow Multiple copies of the same picture (same object
name) to be open at the same time.
Search the iFIX Online Help for “Multiple Picture Instances”. Look for this topic and take a
read at this topic when you have time.
Figure 14-14 Online Help – Multiple Picture Instances
14-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Navigation
Lab Exercises – Navigation
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Configure common VBA Subroutines for Navigation
 Configure Chain Navigation
 Use Navigation Experts in pictures
 Change User Preferences
Introduction
In these lab exercises, you will prepare each Main screen sized picture to use both Chain
navigation and the navigation buttons in the Header picture.
You will add buttons and experts to the Footer for easy Chain navigation.
Lab Exercise #1 – Prepare all Main screens for navigation
Part A – Add code to the picture Initialize event of the Template picture
1. Ensure that you are in Workspace Configure mode and close any open pictures. Use
Close All again from the View Ribbon.
2. On the System Tree, locate the Template picture and open it.
3. In the System Tree, right click on Template and choose Edit Script.
This Edit Script could also have been done in a blank area of the picture, or you could have
opened the VB Editor from the Home Ribbon or Quick Toolbar and then navigated to this
Template pictures code.
You will now add code to the Initialize Event of every main screen area picture. Since this is
the Template from where a Save As could have been used to create new subsequent
pictures, this Initialize event code would be useful. You however will add the code to each
main area picture.
GFS-154K
Education Services
14-11
Proficy iFIX Fundamentals - Navigation
4. The code window will be open for the Template. Observe that it has no VBA code as yet.
Also observe the two drop down boxes at the top of the code window. (General) is
selected for the Objects / Subroutine list, and (Declarations) for the Event list.
5. From the Object / Subroutine (General) list select CFixPicture. The first default Event of
KeyDown will have been selected. We do not wish to use this one.
6.
From the Event list select Initialize. The CFixPicture_KeyDown procedure can be deleted.
7. Under the Private Sub, above the End Sub, type in:
user.varPreviousPicture.CurrentValue = user.varCurrentPicture.CurrentValue
user.varCurrentPicture.CurrentValue = Me.Name
user.varNextPicture.CurrentValue = "<modify for Next Picture>.grf"
14-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Navigation
Recall you created the referenced User Global Variables in an earlier chapter.
The PreviousPicture variable will be loaded with the name of the picture which just closed
and whose name was already loaded into the CurrentPicture variable.
The CurrentPicture variable is then loaded with the Name of the picture this code belongs
to (Me).
Then, used with Chain Navigation, the next logical picture in the sequence is hardcoded, the
NextPicture variable is loaded with its name.
8. Switch back to Workspace, Alt-Q, then Save this Template picture.
GFS-154K
Education Services
14-13
Proficy iFIX Fundamentals - Navigation
Part B – Create additional pictures from the Template picture
You will have 2 more pictures, not yet created, which will use this same Template, lets
create them now.
1. From the Workspace button, click Save As. At the prompt name the new picture, Analytics.
2. Right click in a blank area of this new Analytics picture and choose Edit Script.
3. In the VB Editor, in the code windows for this picture, modify the varNextPicture variable
value to “Alarms.grf”.
4. Switch back to Workspace, Alt-Q, and Save this picture, Ctrl-S.
5. From the Workspace button, click Save As. At the prompt name the new picture, Alarms.
6. Right click in a blank area of this new Alarms picture and choose Edit Script.
7. In the VB Editor, in the code windows for this picture, modify the varNextPicture variable
value to “SystemInfo.grf”.
8. Highlight all 5 lines of code, including the Private Sub and End Sub, then click, Ctrl-C on your
keyboard to copy.
9. Switch back to Workspace, Alt-Q, and Save this picture, Ctrl-S.
10. From the Workspace button, or right clicking on the Alarms picture in the System Tree,
choose Close.
14-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Navigation
Part C – Add code to the picture Initialize event of all remaining Main area
pictures
1. From the System Tree open the Ingredients picture.
2. Right click this picture name in the System Tree and choose Edit Script.
3. Scroll to the very top of the code window for this picture, you may need to add a few spaces
at the top before the drop down boxes return to showing (General) and (Declarations) again.
4. In a blank space i.e. not inside any other existing code, click Ctrl-V to paste in the copied
CFixPicture_Initialize code.
5. The only modification required for our Chain Navigation design, is to change the
user.varNextPicture.CurrentValue target value to “Blending.grf”.
6. Switch back to Workspace, Alt-Q, and Save this picture, Ctrl-S.
7. From the Workspace button, or right clicking on this picture in the System Tree, choose
Close.
Repeat for the Blending picture.
8. From the System Tree open the Blending picture.
9. Right click this picture name in the System Tree and choose Edit Script.
10. Scroll to the very top of the code window for this picture, you will likely need to add a few
spaces at the top before the drop down boxes return to showing (General) and (Declarations)
again.
11. In a blank space i.e. not inside any other existing code, click Ctrl-V to paste in the copied
CFixPicture_Initialize code.
12. The only modification required for our Chain Navigation design, is to change the
user.varNextPicture.CurrentValue target value to “Granulation.grf”.
13. Switch back to Workspace, Alt-Q, and Save this picture, Ctrl-S.
14. From the Workspace button, or right clicking on this picture in the System Tree, choose
Close.
GFS-154K
Education Services
14-15
Proficy iFIX Fundamentals - Navigation
Repeat for the Granulation picture.
9. From the System Tree open the Granulation picture.
10. Right click this picture name in the System Tree and choose Edit Script.
11. Scroll to the very top of the code window for this picture, you will likely need to add a few
spaces at the top before the drop down boxes return to showing (General) and
(Declarations) again.
12. In a blank space i.e. not inside any other existing code, click Ctrl-V to paste in the copied
CFixPicture_Initialize code.
13. The only modification required for our Chain Navigation design, is to change the
user.varNextPicture.CurrentValue target value to “Packaging.grf”.
14. Switch back to Workspace, Alt-Q, and Save this picture, Ctrl-S.
15. Close this Granulation picture.
Repeat for the Packaging picture.
16. From the System Tree open the Packaging picture.
17. Right click this picture name in the System Tree and choose Edit Script.
18. Scroll to the very top of the code window for this picture, you will likely need to add a few
spaces at the top before the drop down boxes return to showing (General) and
(Declarations) again.
19. In a blank space i.e. not inside any other existing code, click Ctrl-V to paste in the copied
CFixPicture_Initialize code.
20. The only modification required for our Chain Navigation design, is to change the
user.varNextPicture.CurrentValue target value to “EnergyPlant.grf”.
21. Switch back to Workspace, Alt-Q, and Save this picture, Ctrl-S.
22. Close this Packaging picture.
Repeat for the Energy picture.
23. From the System Tree open the EnergyPlant picture.
24. Right click this picture name in the System Tree and choose Edit Script.
25. Scroll to the very top of the code window for this picture, you will likely need to add a few
spaces at the top before the drop down boxes return to showing (General) and
(Declarations) again.
26. In a blank space i.e. not inside any other existing code, click Ctrl-V to paste in the copied
CFixPicture_Initialize code.
27. The only modification required for our Chain Navigation design, is to change the
user.varNextPicture.CurrentValue target value to “Analytics.grf”.
28. Switch back to Workspace, Alt-Q, and Save this picture, Ctrl-S.
29. Close this Energy picture.
14-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Navigation
Repeat for the SystemInfo picture.
30. From the System Tree open the SystemInfo picture.
31. Right click this picture name in the System Tree and choose Edit Script.
32. Scroll to the very top of the code window for this picture, you will likely need to add a few
spaces at the top before the drop down boxes return to showing (General) and
(Declarations) again.
33. In a blank space i.e. not inside any other existing code, click Ctrl-V to paste in the copied
CFixPicture_Initialize code.
34. The only modification required for our Chain Navigation design, is to change the
user.varNextPicture.CurrentValue target value to “Main.grf”.
35. Switch back to Workspace, Alt-Q, and Save this picture, Ctrl-S.
36. From the Workspace button, or right clicking on this picture in the System Tree, choose
Close.
Repeat for the Main picture.
37. From the System Tree open the Main picture.
38. Right click this picture name in the System Tree and choose Edit Script.
39. Scroll to the very top of the code window for this picture, you will likely need to add a few
spaces at the top before the drop down boxes return to showing (General) and
(Declarations) again.
40. In a blank space i.e. not inside any other existing code, click Ctrl-V to paste in the copied
CFixPicture_Initialize code.
41. The only modification required for our Chain Navigation design, is to change the
user.varNextPicture.CurrentValue target value to “Ingredients.grf”.
42. Switch back to Workspace, Alt-Q, and Save this picture, Ctrl-S.
43. From the Workspace button, or right clicking on this picture in the System Tree, choose
Close.
44. From the View Ribbon, click Close All, if you have any other pictures still open.
GFS-154K
Education Services
14-17
Proficy iFIX Fundamentals - Navigation
14-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Navigation
Lab Exercise #2 – Configure the Header picture for
navigation
1. In Workspace Configure mode, open the Header picture.
(Open from System Tree or Workspace button or Ctrl-O, you choose!)
2. With the Ingredients button in the Header picture highlighted, go to the Tools Ribbon and
under Commands click Replace Picture.
3. When the Replace Picture Expert Opens, check the Use Alias button, and type in
CurrentPicture.
Although this Expert allows use of a Picture Alias, you entered CurrentPicture, this is not the
same as the Global Variable we wish to use. Referencing a Global Variable must be done in
the VB Editor.
GFS-154K
Education Services
14-19
Proficy iFIX Fundamentals - Navigation
4. In the New Picture field, click the ellipses button to browse and select the Ingredients
picture and click OK. Then click the OK button to close the Expert.
5. Right click on this Ingredients navigation button and choose Edit Script.
Here is the code added by the ReplacePicture Expert:
6. Lots of comments (in green) added by the Expert. Manually change the only executable line
(black text) in this procedure to:
ReplacePicture “Ingredients.grf”, user.varCurrentPicture.CurrentValue
The Autocomplete feature of the VB Editor will have listed for you the possible options when
typing. Note that the last part, the reference to the User Global is not inside quotes.
14-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Navigation
7. Switch back to Workspace (Alt-Q) . Then Save this Header picture. Ctrl-S.
8. Double click on this Ingredients navigation button. It’s a Dynamo and will open the Dynamo
form.
In the Status Tag(F_CV) field, change the data source in the Current Setting to:
Fix32.THISNODE.BATCHINGREDIENTSSTATE.F_CV
(you are familiar now with using the Expression Builder, the FIX Database tab and Tagname
Filters). Then click the OK button in the Dynamo form.
Using the ReplacePicture Expert was fine for the first button, but since you need to make
some changes in the VB Editor, and the actual procedure is only 1 line of code, it’s probably
easier and less click intensice to add the ReplacePicture code manually, then copy, paste,
modify.
9. Right click on the Blending navigation button and choose Edit Script.
This is a Dynamo, so already has an event configured, its Edit Event. This is the only event
which can be triggered in Workspace Configure mode, here running EditDynamo
10. From the Event drop down list (currently set to Edit), choose Click. Then type in the VBA
code:
ReplacePicture “Blending.grf”, user.varCurrentPicture.CurrentValue
GFS-154K
Education Services
14-21
Proficy iFIX Fundamentals - Navigation
11. Switch back to Workspace, Alt-Q.
12. Double click on this Blending navigation button and in the Status Tag(F_CV) Current Setting,
choose the tag: Fix32.THISNODE.BATCHBLENDINGSTATE.F_CV
Then click the OK button.
13. Save the Header picture, Ctrl-S.
14. Right click on the Granulation navigation button and choose Edit Script.
15. From the Event drop down list (currently set to Edit), choose Click. Then type in the VBA
code:
ReplacePicture “Granulation.grf”, user.varCurrentPicture.CurrentValue
16. Switch back to Workspace, Alt-Q.
17. Double click on this Granulation navigation button and in the Status Tag(F_CV) Current
Setting, choose the tag: Fix32.THISNODE.BATCHGRANULATIONSTATE.F_CV
Then click the OK button.
18. Save the Header picture, Ctrl-S.
19. Right click on the Packaging navigation button and choose Edit Script.
20. From the Event drop down list (currently set to Edit), choose Click. Then type in the VBA
code:
ReplacePicture “Packaging.grf”, user.varCurrentPicture.CurrentValue
21. Switch back to Workspace, Alt-Q.
22. Double click on this Packaging navigation button and in the Status Tag(F_CV) Current
Setting, choose the tag: Fix32.THISNODE.BATCHPACKAGINGSTATE.F_CV
Then click the OK button.
23.Save the Header picture, Ctrl-S.
24.Right click on the Energy navigation button and choose Edit Script.
25. From the Event drop down list (currently set to Edit), choose Click. Then type in the VBA
code:
ReplacePicture “EnergyPlant.grf”, user.varCurrentPicture.CurrentValue
26. Switch back to Workspace, Alt-Q.
27. Double click on this Energy navigation button and in the Status Tag(F_CV) Current Setting,
choose the tag: Fix32.THISNODE.ENERGYPLANTSTATE.F_CV
Then click the OK button.
28. Save the Header picture, Ctrl-S.
29. Right click on the Analytics navigation button and choose Edit Script.
30.From the Event drop down list (currently set to Edit), choose Click. Then type in the VBA
code:
ReplacePicture “Analytics.grf”, user.varCurrentPicture.CurrentValue
14-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Navigation
31. Switch back to Workspace, Alt-Q.
32. Double click on this Analytics navigation button and in the Status Tag(F_CV) Current
Setting, choose the tag: Fix32.THISNODE.COLLECTORSTATUS.F_CV
Then click the OK button.
33.Save the Header picture, Ctrl-S.
34.
Right click on the Alarms navigation button and choose Edit Script.
35.From the Event drop down list (currently set to Edit), choose Click. Then type in the VBA
code:
ReplacePicture “Alarms.grf”, user.varCurrentPicture.CurrentValue
36.Switch back to Workspace, Alt-Q.
37. Double click on this Alarms navigation button and in the Status Tag(F_CV) Current Setting,
choose the tag: Fix32.THISNODE.ALARMSSTATUS.F_CV
Then click the OK button.
38.Save the Header picture, Ctrl-S.
39.Right click on the System navigation button and choose Edit Script.
40.From the Event drop down list (currently set to Edit), choose Click. Then type in the VBA
code:
ReplacePicture “SystemInfo.grf”, user.varCurrentPicture.CurrentValue
41. Switch back to Workspace, Alt-Q.
42.Double click on this System navigation button and in the Status Tag(F_CV) Current Setting,
and type in manually (you cannot browse) the tag: Fix32.THISNODE.SYSTEM.A_CPS
Then click the OK button.
43.
Save the Header picture, Ctrl-S.
44.
Right click on the Home icon (also for navigation) at the far left of the header picture, and
choose Edit Script.
45.From the Event drop down list (currently set to Edit), choose Click. Then type in the VBA
code:
ReplacePicture “Main.grf”, user.varCurrentPicture.CurrentValue
46.Switch back to Workspace, Alt-Q.
47. Save the Header picture, Ctrl-S.
48.Close the Header picture, then close (Exit) Workspace.
49.Start Workspace from the desktop shortcut, it will open in Run mode the default Header,
Footer and Main pictures.
50. Try each of the navigation buttons in turn. Don’t forget to try the Home icon.
GFS-154K
Education Services
14-23
Proficy iFIX Fundamentals - Navigation
14-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - Navigation
(Optional) Lab Exercise #3 – Configure Footer navigation
1. In Workspace Configure mode, close all open pictures, then open the Footer picture.
(Open from System Tree or Workspace button or Ctrl-O, you choose!)
2. From the Home Ribbon, click Full Screen.
3. Using the Toolbox, insert three separate Rounded Rectangles and place at the bottom left of
the Footer picture and add to them three text objects with the labels:
<Previous
<Current Picture>
Next>
If you wish to use PushButtons, do so. Pushbuttons have a caption property so no need for
the additional text objects. However the style and position of separate text objects is easier
to control.
Modify the text Foreground Color, and adjust the Rounded Rectangle RoundnessX and Y
and Edge Style in the Property Window.
4. Right click on the <Previous label and choose Edit Script.
5. In the Click event for the object enter the code:
ReplacePicture user.varPreviousPicture.CurrentValue, user.varCurrentPicture.CurrentValue
6. Switch back to Workspace, Alt-Q.
7. Right click on the Next> label and choose Edit Script.
8. In the Click event for the object enter the code:
ReplacePicture user.varNextPicture.CurrentValue, user.varCurrentPicture.CurrentValue
9. Switch back to Workspace, Alt-Q.
10. On the <Current Picture> label, right click and choose Animations.
11. Click on Configure in Advanced Animations and in the Advanced Animations dialog, move
to the Text tab.
12. Check Animate for the Caption Property.
13. In the Data Source field, click the ellipses button to browse the Expression Builder and
select from the Globals tab User.varCurrentPicture.CurrentValue. Set the Chars/Line to 20.
See the next page for the example.
GFS-154K
Education Services
14-25
Proficy iFIX Fundamentals - Navigation
14. Click OK to close the Advanced Animation dialog, then OK again to close the Basic Animation
dialog.
15. Save then close the Footer picture then close (Exit) Workspace.
16. Start Workspace from the desktop shortcut. It will open in Run mode the default Header,
Footer and Main pictures.
17. Try each of the new Previous and Next buttons. The Current Picture text value should update
to show which Main area picture is currently open.
14-26
Education Services
GFS-154K
Proficy iFIX Fundamentals - Navigation
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 14 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
GFS-154K
Education Services
14-27
Proficy iFIX Fundamentals - Navigation
Review Questions
1.
Name three essential considerations that should be made prior to implementing
navigation.
2. When using the Replace Picture Expert, which picture sets the size and location of the
new picture?
3. What does the “Default Picture” property of the Menu Control achieve?
4. Where do you set the picture cache size?
5. What happens when the Workspace starts in Run mode?
Electronic Books Research
6. Why is the Index field important in the Menu Control when adding VBA Scripts to a sub
menu?
14-28
Education Services
GFS-154K
Proficy iFIX Fundamentals - Navigation
Review
Now that you have completed this module, you should be able to:
 Define general concepts of Navigation
 List tools for building iFIX HMI Navigation
 Configure a picture Navigation system
GFS-154K
Education Services
14-29
Proficy iFIX Fundamentals - Navigation
14-30
Education Services
GFS-154K
0)
15
MONITORING ALARMS
a
At the end of this module, you will be able to:
 Describe Alarm severity
 Discuss Alarm messages
 Deploy the Alarm Summary Object
 Use Alarm Counters
75%
Proficy iFIX Fundamentals - Monitoring Alarms
15-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
Process
Database
HMI
Overview
As discussed earlier, a primary responsibility of the SCADA server is to detect and generate
alarms based on pre-defined alarm limits and system conditions. These alarms are then
distributed through a series of queues to a variety of Alarm Services, each responsible for
producing some sort of Alarm output (e.g. printer, files, database entries).
One of the most important alarm feedback mechanisms for operators are HMI alarm
displays. These displays summarize and organize alarm messages in order of severity
and/or the time they were detected so that operators can take corrective measures before
serious or dangerous problems occur on the plant floor. There are three main methods of
displaying alarm data:
 The Alarm Summary Object
 Alarm Counters
 Alarm Fields
The Alarm Summary object allows tabular presentation of alarm messages, as well as
advanced sorting and filtering features. It is also the primary means of shelving,
acknowledging and clearing alarms. Alarm Counters and Alarm fields are used primarily
with DataLinks and animations to present alarm information in a text or visual format.
Figure 15-1. Real-time Alarm Monitoring
GFS-154K
Education Services
15-3
Proficy iFIX Fundamentals - Monitoring Alarms
Alarm Services Review
Alarm Printers
Any iFIX node (Client or SCADA) can send alarms to a maximum of four alarm printers.
These printers can be assigned to serial, parallel or USB ports. The output to the printer is
not a document, but a single line alarm message. For sheet feed printers, 50 lines are
buffered by default before a print job is sent. Dot matrix line printers are commonly used,
but in today’s environmentally conscious world, most users prefer alternate Alarm Services.
Alarm Summary
The Alarm Summary service is responsible for routing alarm messages to alarm summary
object(s) in displays. These interactive summary objects provide operators with a means to
interact with the alarm sub-system by reviewing, sorting, filtering, shelving, acknowledging
and clearing alarms. It also provides audible signals (Horn Support) to indicate that new
alarms are present in the summary table.
Alarm Files
The Alarm File service will write messages to simple text-based files in the Alarm path
(generally the ALM directory). As with the printers, the alarms are written line-by-line in
batches. The text-based files have an extension of .ALM, and are created daily using the
date stamp as the file name (YYMMDD). Throughout the day, alarms will be written to the
text file, which grows as large as is required.
Alarm History
The Alarm History service will provide messages to a viewer (ALMHIS.EXE) for review during
short-term troubleshooting. The Alarm History viewer only holds the alarms temporarily,.
The alarms will be displayed in a First In, First Out (FIFO) manner.
Alarm ODBC
The Alarm ODBC service is responsible for performing batch writes of alarm messages to
Relational Databases (RDBs) such as Microsoft SQL server or Oracle. This is an effective
tool for long-term alarm storage and analysis.
Alarm Network
The Alarm Network service enables network transmission of alarms between nodes
(SCADAs and Clients). When the Alarm Network service is enabled, a Network Alarm Client
task (NAC.EXE) is set up to request alarms from all SCADAs in the networked nodes list. A
Network Alarm Manager (NAM.EXE) is also created (on SCADA nodes only) to receive the
requests and then respond with the latest alarm messages. Thus, the Alarm Network
service must be enabled on every node that needs to receive or send alarms over the
network. Which Nodes receive which Alarms can be controlled. See the Troubleshooting
topic in this chapter.
Alarm Startup Queue
The Alarm Startup Queue service is responsible for populating Alarm service queues with
remote alarms that were generated while a node was shut down.
15-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
Alarm Messages
There are three types of alarm message: System, Application and Event (Alarm) messages.
System messages are generated by iFIX and pertain to activity occurring at start up or
during normal operation. These messages are generated by the various tasks and services
(such as I/O Drivers and network tasks) and can include system error information. These
messages are routed through SAC into the various Alarm Service queues. The only
exception is the Alarm Summary queue. Only Alarm messages appear in the Alarm
Summary.
Application messages are generated by user interactions with the system. Brief messages
can be generated by operator actions (such as changing set points or acknowledging
alarms). VBA scripts or program blocks can also generate pre-defined messages as part of
their normal execution. As with System Messages, these alarms are delivered to all Alarm
Services except the Alarm Summary Service.
Alarm messages are the high priority alarms that are generated by SAC based on the alarm
information configured for each PDB tag. These alarms may contain information from other
fields in the tag to help the operator identify the problem. These alarms are the only type to
arrive at the Alarm Summary Service.
Event Messages are similar, in that they are generated by SAC from certain Tag types,
however they do not require acknowledging and do not appear in the Alarm Summary.
Alarm Status and Severity
Operators can look at a tag’s current alarm or the latched alarm. The current alarm will
show the alarm state at the current instant in time, regardless of the recent history of the
alarm. The latched alarm will show the most severe unacknowledged alarm. This is very
important for viewing the recent alarm history of a tag, and a convenient way to make
operators aware of transient alarm conditions.
Alarm Severity
GFS-154K
Alarm State
Description
1
COMM
Communication Error (Bad Data Quality).
1
OCD
Open Circuit Detected.
1
IOF
General IO Failure.
1
FLT
Floating Point Error.
1
OVER
Over Range.
1
UNDER
Under Range.
1
ERROR
Any Statistical Data Block Alarm.
2
COS
Change of State (Digital tags).
2
CFN
Change From Normal (Digital tags).
2
HIHI
Block in HIHI State (Analog tags).
2
LOLO
Block in LOLO State (Analog tags).
3
RATE
Rate of change limit exceeded (Analog tags).
3
HI
Block in HI state (Analog tags).
3
LO
Block in LO state (Analog tags).
4
DEV
Deviation from target alarm (Analog Alarm
tags).
5
OK
Block in safe or normal state.
Table 15-1. Alarm Status and Severity
Education Services
15-5
Proficy iFIX Fundamentals - Monitoring Alarms
Alarm Summary
The Alarm Summary is a tabular interface for sorting, filtering, shelving, acknowledging and
clearing alarms. Operators can review alarms in the order they were detected, or by several
other criteria. Double-clicking on entries in the table will acknowledge the alarm and silence
an alarm horn or any blink animations. More important, it verifies that the operator received
the message and is aware of the problem.
Even when an alarm returns to a normal condition on its own, its alarm message will persist
in the alarm summary until it is acknowledged. Once an alarm has been acknowledged and
returns to normal, it will be cleared from the Alarm Summary. The Alarm Summary shows
only latched alarms for tags and does not allow System, Application or Event messages to
clutter the display.
Figure 15-2. Latched Alarm Transitions
This figure shows an example of how latched alarms work.
The tag value for a level begins to increase towards the center of this chart.
The moment it rises above the HI alarm limit, an alarm is generated and sent to all alarm
services.
The value continues to rise past the HIHI alarm limit and the message is resent with the new
status. At this point in time, before the operator takes any action, the current alarm and the
latched alarm are the same (HIHI). The operator does not acknowledge the alarm
immediately, but does take corrective action, reducing the level to a HI condition and then a
normal condition. At this point in time the current alarm will read OK, but because the alarm
is unacknowledged, the latched alarm will read HIHI. As soon as the operator acknowledges
that there was a HIHI alarm, the latched alarm would be cleared and again assume the same
value as the current alarm.
15-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
Alarm Summary Configuration
The Alarm Summary object is a complex iFIX object with its own configuration panel. Due to
the performance requirements of the Alarm Summary object, it is best to keep the number
of Alarm Summaries to a minimum (one or two open at a time) and segregated to their own
dedicated displays. Alarm Summary settings can be saved and used in subsequent Alarm
Summary objects to speed development and maintain a consistent interface.
Operator Tab
The Operator tab customizes operator run-time interaction capabilities, including a useful
right-click menu.
Figure 15-3. Alarm Summary Operator Tab
Alarm Deletion is usually set to automatic in the Alarm Summary service (in the SCU).
This deletes alarms which have returned to their normal conditions and have been
acknowledged. However, operators may be allowed to manually delete alarms if the option
is enabled.
GFS-154K
Education Services
15-7
Proficy iFIX Fundamentals - Monitoring Alarms
Filter Tab
As we saw in the SCU, alarm services can share Alarm Area filters or use their own custom
Alarm Area filter lists. The Alarm Summary service, as configured in the SCU, provides first
pass filtering for the Alarm Summary object based solely on Alarm Areas. The Filter tab
grants the Alarm Summary object with additional means of filtering alarms. Alarms can be
filtered by many IN or NOT IN criteria such as area, node, tagname, priority, time, date, etc.
Figure 15-4. Alarm Summary Filter Tab
Add Filter Condition provides a simple mouse-based browser allowing the use of custom
filter criteria. Many columns can be added to the filter criteria at once. This tab can be
made available at run-time if the appropriate option is selected on the Operator tab.
Display only Shelved Alarms. This checkbox, when enabled, will transform the Alarm
Summary Object to show only alarm messages from tags that have already been placed into
a Shelved state. This is useful to see which alarms are currently shelved and if displayed,
how long until they are automatically moved from Shelved back to active once again.
15-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
Model Context. One of the Filter Conditions that can be added is based on Model Context.
Either when configuring the Alarm Summary Object, or in Run mode, by selecting a new filter
and choosing Model Context will allow the user to browse through the available Asset
Model to set a Model based filter.
Figure 15-5. Model Context Filter
Sort Tab
The Sort tab configures organization of alarms using one of the visible columns.
Figure 15-6. Alarm Summary Sort Tab
GFS-154K
Education Services
15-9
Proficy iFIX Fundamentals - Monitoring Alarms
Color Tab
Color can be used to implement intuitive indication of alarm severity, priority and
acknowledgement status.
Figure 15-7. Alarm Summary Color Tab
Each alarm status can be given its own color code represented by the font color. Alarm
Priority is simultaneously assigned with the cell background color. For indication of
unacknowledged or paused alarms, separate color buttons are available. As with alarm
status, these are shown with the font color. Blinking can be used to draw extra attention to
certain conditions.
Warning
Be careful when configuring User defined color schemes in the Alarm Summary
Object.
e.g. if the background color is set to white to make alarms easier to read, then a
Rate of Change alarm, with its foreground color also being white, will be rendered
invisible!
15-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
Column Tab
The Column Tab allows the developer to determine which alarm message fields the
operator is shown. These settings override the Alarm Services message formats set in the
SCU. The User Defined Fields can be used to add any field supported by any tag in the
PDB.
Figure 15-8. Alarm Summary Column Tab
GFS-154K
Education Services
15-11
Proficy iFIX Fundamentals - Monitoring Alarms
Display Tab
This tab allows configuration of the how the Alarm Summary is displayed at real time. Scroll
bars, gridlines as well as column and row headers are controlled from this tab. Refresh
rates can also be set for the various data components of the Alarm summary. Configurable
rates include alarm and data refresh rates, as well as the blink update rate.
Figure 15-9. Alarm Summary Display Tab
15-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
Alarm Summary at RunTime
The Alarm Summary Object has several RunTime functions. As well as presenting the
configured Columns, showing information such as the Time the Alarm started, the Tagname,
Descriptions etc, the Alarm Summary can be used to perform actions such as
Acknowledging Alarms, either individually or by the visible page or, if enabled, All Alarms.
Additionally, sorting, filtering, shelving, setting properties, enabling or disabling the Alarm
Horn, hiding grid lines and pausing the display can all be achieved.
Alarm Shelving at Runtime
Recall that we discussed Alarm Shelving Policies in the Process Database chapters and
subsequently configured shelving for some of the course system Tags.
Alarm Shelving is ultimately a Runtime tool, helping operators to manage alarms, and where
appropriate hide the presentation of these alarms for a period of time.
Only when a Tag with a Shelving Policy configured is highlighted in the Alarm Summary
Object at Runtime, does the Shelve option appear in the right click menu. The Alarm
Summary is able to show a column which states if the Tag is Shelvable - YES or NO.
Figure 15-10. Alarm Summary at Runtime
If the Tag supports Shelving, when the Shelve…option is selected on the right-click menu, a
pop up appears to allow the operator to select the Shelve duration.
Once Shelved, the alarm will be hidden in the Alarm Summary before appearing once more
after the duration has elapsed. Alarms Shelving is a Security Application Feature.
Figure 15-11. Shelve Alarm Duration selection
GFS-154K
Education Services
15-13
Proficy iFIX Fundamentals - Monitoring Alarms
Scripting
There are certain iFIX VBA subroutines which can interact with the Alarm Summary Object.
The most common include the AcknowledgeAllAlarms and the AlarmHornEnabledToggle
subroutines and both can be set using Command Experts.
Helpful iFIX VBA alarming subroutines include:
 AlarmHornSilence
 AcknowledgeAnAlarm
Helpful Alarm Summary Object methods include:
(recall from the VBA Chapter, methods are in-built functions of an object itself)
 ShelveAlarm
 UnShelveAlarm
 GetSelectedRowAlarmInfo
 GetSelectedRowsAlarmInfo
 GetSelectedTagname
 GetSelectedAlmExt
 AckAlarmPage
15-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
DataLinks and Animations
Alarm Fields
Alarm Fields are commonly used with DataLinks and animations to provide helpful alarm
indications outside of the busy Alarm Summary object. The two most commonly used fields
are A_CUALM for the current alarm and A_LAALM for the latched alarm. These fields can be
browsed using the Expression Builder using the FIX Database tab, or for Model variables,
the Model tab.
Figure 15-12. Alarm field browsing with the Expression Builder
Alarm Counters
Alarm Counters are often used with DataLinks to provide an idea of how many alarms there
are in an area or combination of areas. Total unacknowledged alarms, acknowledged
alarms and overall totals can be especially helpful for operators when determining which
area of the plant is having problems. Alarm Counters have their own tab in the Expression
Builder and mathematical expressions can combine many areas into a single result.
Figure 15-13. Alarm Counter browsing with the Expression Builder
GFS-154K
Education Services
15-15
Proficy iFIX Fundamentals - Monitoring Alarms
Troubleshooting Topic
When a Client node has configured in the SCU – Networking a connection to a SCADA node,
it will by default will receive all alarms generated by the SCADA node.
Imagine a View node whose task is only to monitor and control one process area. Think of
our course system, it may have a View node assigned to the Ingredients area.
By default, this Ingredients View node will receive alarms for the Ingredients, Blender,
Granulation, Packaging etc. areas.
Yes, they can easily be filtered in the Alarm Summary object, but they have already been
sent to this Ingredients View node, taking up potentially valuable network bandwidth.
To reduce network traffic, it is possible on the source SCADA node to restrict which client
nodes are sent which alarms. This is achieved by mapping a specific View node to specific
Alarm Areas.
In Alarm Configuration of the SCU, the Options button opens the List of Alarm Clients
window.
Here the Client node, such as View1 is added along with its Alarm Area mapping.
Here in this example only Ingredients alarms will be sent to View1, reducing significantly the
Alarm traffic from SCADA to Client.
Figure 15-14. SCU – Alarms – Options – List of Alarm Clients
15-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
eBooks Topic
The Online Help discusses the use of this Alarm Clients window.
Search the iFIX Online Help for “List of Alarm Clients”. Take a read at this topic when you
have time.
Figure 15-15 Online Help – Alarm Clients
GFS-154K
Education Services
15-17
Proficy iFIX Fundamentals - Monitoring Alarms
15-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
Lab Exercises – Monitoring Alarms
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Create a main screen alarm summary picture
 Add an alarm summary banner to the Footer picture
 Add Filtering and Shelving components
 Add Alarm Counters
Introduction
You are going to build a main screen Alarms picture to show all alarms from your SCADA
node.
A permanently displayed list of Critical alarms will be shown on the Footer picture.
You will add some extra features in the main Alarms picture to allow Filtering using a VBA
form you imported in an earlier lab. You will also use Shelving, displaying a list of Shelved
alarms separately.
Alongside this you will display a set of Alarm Counters.
Lab Exercise #1 – Alarm Summary configuration
Part A – Configure the main area Alarms picture
1. Ensure you are in Configure mode. Close any open pictures and then open the Alarms
picture. This is a blank main screen area picture saved in a previous lab.
We will use this as starting point, recall this ensures the same dimensions and location for
all main screen area pictures.
2. From the Insert Ribbon, select the Objects / Links list and click Pushbutton to add a
button. It will appear center of the picture. Move it to the top right of this Alarms picture.
3. Double click this pushbutton and type in Area Filter as its caption.
4. With this pushbutton highlighted, either click F4 on the keyboard, or choose Property
Windows from its right click menu.
5. In the (Name) property, modify to cmdFilter. Modify Font if you wish, e.g. Bold 16 point.
6. Now right click on this Filter pushbutton and choose Edit Script.
7. In the VB Editor, add the VBA code user.LaunchAreaForm to call the Alarm Areas form
which you imported in the VBA Chapter lab.
The VB code should look like this:
8. Close the VB Editor, switch back to Workspace (Alt-Q).
GFS-154K
Education Services
15-19
Proficy iFIX Fundamentals - Monitoring Alarms
9. Next, from the Insert Ribbon, select the Objects / Links list and click Alarm summary.
A new default Alarm Summary Object will be added to the open picture. Resize so that it
covers most of the left side of the picture area. Use the example below as a guide shown
in Workspace Configure Full Screen.
10. Double-click the Alarm Summary object to open the configuration interface. Move to the
Operator tab. Enable all functions except Allow Alarm Deletion.
11. Move to the Column tab. Add the Area first, then Shelveable and Shelve Duration at the
bottom. Rearrange the column order using the arrow buttons so that your column tab
looks like this.
Again look at the example above showing the expected columns.
15-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
12. Next, move to the Display tab. Enable the settings as shown:
13. When finished, click the Save button and then OK.
14. Use the mouse to change the size of the columns by dragging the header border right or
left. The cursor does not change to indicate the column adjustment, simply left click and
drag on the divider in the Alarm Summary Object header.
Resize the column widths to your taste, following the example on the previous page.
15. Click a blank area of the picture once complete to deselect the Alarm Summary Object.
16. Save the Alarms picture – Ctrl-S.
GFS-154K
Education Services
15-21
Proficy iFIX Fundamentals - Monitoring Alarms
Part B – Add Filtering functionality
We will now tie this Alarm Summary object to the Global Variable
User.varAlarmArea.CurrentValue. We will link the Alarm Summary object FilterString
property to this variable. When the variable changes, the alarm summary will automatically
adjust to show only the alarms in the areas that are chosen. This variable is set by the
frmAlarmChoose form we imported in the VBA chapter and will show when the Filter button
added above is clicked.
1. Highlight the Alarm Summary object in the Alarms picture. Right-click and select
Animations.
The Basic Animation dialog will appear.
2. Click Configure to open the Advanced Animations dialog box. On the Misc tab locate the
FilterString property ( it is almost half way down) and enable its Animate checkbox.
3. Use the Expression Builder to link to the data source:
Globals - User - varAlarmArea - CurrentValue
4. Set the Data Conversion to Object (i.e. raw values).
It should look like this:
5. This ties the FilterString property to the desired Global variable.
Click OK twice to close the dialog boxes.
Save the Alarms picture.
6. From the System Tree open the Footer picture.
7. Either from the Home Ribbon or the Quick Access Toolbar click the Full Screen button
This will allow you to see the Footer picture.
15-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
8. Select the Alarm Summary object in the main Alarms picture, then right click and choose
Duplicate.
9. Resize to this duplicate to a small Alarm Summary object so only 3 Rows show.
Double click on this smaller Alarm Summary object and make the following changes:
a. Column tab: Only with Tagname, Description, Time In, Status, Value
b. Filter tab: choose Priority then click Add Filter Condition to >= “HIHI”
GFS-154K
Education Services
15-23
Proficy iFIX Fundamentals - Monitoring Alarms
c. Display tab: uncheck Show Status Bar and Show Scroll Bars
10. Click OK to close this smaller Alarm Summary object.
11. Now drag this resized Alarm Summary object into the Footer banner picture at the bottom of
the Workspace. It should now resemble the example given below.
Use this example below as a guide. If you completed the optional lab in the Navigation
chapter, you will have the <Previous; <Current Picture>; Next> buttons as shown.
You will add 2 more buttons to the right in a later lab exercise, so leave some space on the
right.
12. Save both the Alarms and Footer pictures.
13. Switch to Run Mode. The main screen Alarm Summary will show all alarms, and the one on
the Footer will show only alarms which are of a Priority HIH or above.
14. Click the Filter button in the Alarms picture to open the Alarm Area form.
Select an area such as Ingredients and click Filter.
15. Observe, both of the Alarm Summary Objects will update and be filtered by the selected area:
16. Right click on either of the Summary objects and try out the Runtime functions to
Acknowledge, Sort and Filter alarms.
15-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
17. Using the Area Filter form once more, check the All box and uncheck all others, then click
the Filter button. The Alarm Summary object will now show
all Alarms.
18. Next, right click on the Alarm Summary object and choose
Filter.
19. In the Filter Columns list select Model Context then click the Add Filter Condition button.
20. In the Add Model Context window, select the Include Children radio button, then click the
ellipses button.
GFS-154K
Education Services
15-25
Proficy iFIX Fundamentals - Monitoring Alarms
21. In the Model Browse window, select THISNODE as the SCADA and one of the Ingredients,
such as Cellulose_E463. Then click OK.
22. Click OK in the Add Model Context window, then OK to close the Alarm Summary Filter
window.
23.If any Alarms exist in this Model context, they will be the only alarms presented. If there are
still no alarms, select a different Ingredient, such as Cellulose_E460.
15-26
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
Part C – Add Shelving functionality
1. Ensure that you are in Workspace Configure. Close any open pictures except the Alarms
picture. i.e. make sure the Alarms picture is open.
2. As before, add a new Alarm Summary object from the Insert Ribbon – Objects/Links.
3. Double click on this new Alarm Summary object and set the following:
a. Filter tab: Enable the Display only Shelved Alarms checkbox
b. Column tab: Only Shelve Duration (HHH:MM) and Tagname
c. Display tab: Show Headers and Show Gridlines only
4. There is a trick to resize this new Shelved Alarms Summary to show only the 2 columns.
After the last step, resize by dragging the header columns so that only the Shelve and
Tagname show. There will also be an Ack column, but dragging the Shelve column all the
way to the left will push the Ack column off the side.
5. Position this new Alarm Summary on the right side at the bottom.
Use the example on the next page as a guide.
GFS-154K
Education Services
15-27
Proficy iFIX Fundamentals - Monitoring Alarms
6. Save the Alarms picture, then Switch to Run mode.
7. In the main Alarm Summary, look for a tag where the Shelvable column states YES.
The BLEND_MIXER_STATE Tag for example.
8. Left click once on any Shelvable tag to highlight its row, then right click and select Shelve.
9. In the Shelve Alarm pop up window, from the Preset Duration drop down,
choose the Preset1 (1 Minutes) duration. Now click the Shelve button.
10. Observe that the selected Alarm has now disappeared from the main Alarm Summary. After a
few seconds this same alarm for this tag will appear in the small Shelved Alarm Summary on
the right.
11. Wait for 1 minute and observe that it reappears once the duration selected has elapsed. It has
also now disappeared from the Shelved Alarm Summary.
12. Switch back to Configure when done and Save all open pictures.
15-28
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
Lab Exercise #2 – Alarm Counters
1. Ensure you are in Configure mode. Close any open pictures and then open the Alarms
picture.
Now we will add Alarm Counters to the Alarms picture.
2. Add 4 x text labels under the Area Filter button on the right of the Alarms picture.
Use the text object, with their captions as:
a.
b.
c.
d.
e.
Total Alarms:
UnAcknowledged Alarms:
Acknowledged Alarms:
Shelved Alarms:
Set their ForeGroundColor and Font Styles as you desire.
3. Next, add the DataLinks themselves, each case showing two (5) whole digits and zero (0)
decimal digits. Use the Alarm Counters tab in the Expression Builder to find these data
sources:
a.
b.
c.
d.
Total Alarms: FIX32.THISNODE.ALARMCOUNTERS.F_TOT
UnAcknowledged Alarms: FIX32.THISNODE.ALARMCOUNTERS.F_UNACKTOT
Acknowledged Alarms: FIX32.THISNODE.ALARMCOUNTERS.F_ACKTOT
Shelved Alarms: Fix32.THISNODE.ALARMCOUNTERS.F_SHELVETOT
The Alarm Counters area should now look like this:
4. Add divider lines if you wish or have time, change Foreground colors to match our HMI design.
5. Save the Alarms picture and switch to Run mode and inspect the Alarms picture.
Acknowledge a few alarms from the right click on the Alarm Summary object and watch the
alarm counters change. Be careful, you will also be showing Alarms from other nodes. The
counters are for your node only. Try Filtering the Alarm Summary for THISNODE only.
6. Switch back to Configure mode. Close and Save any open pictures.
GFS-154K
Education Services
15-29
Proficy iFIX Fundamentals - Monitoring Alarms
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 15 How To. This will open a
new browser tab and run the How To video.
End of Lab Exercises
15-30
Education Services
GFS-154K
Proficy iFIX Fundamentals - Monitoring Alarms
Review Questions
1.
Name the three types of Alarm messages? Which type is displayed in an Alarm
Summary?
2. What is Alarm Shelving, and how is it enabled at Runtime?
3. Which Alarm type is more severe – COMM or HIHI alarms?
4. How are alarm counters assigned to DataLinks?
5. How can Alarms be filtered based on Asset Models?
Electronic Books Research
6. What are the Arguments that can be passed to the UnShelveAlarm VBA Method?
GFS-154K
Education Services
15-31
Proficy iFIX Fundamentals - Monitoring Alarms
Review
Now that you have completed this module, you should be able to:
 Describe Alarm severity
 Discuss Alarm messages
 Deploy the Alarm Summary Object
 Use Alarm Counters
15-32
Education Services
GFS-154K
0)
16
REUSABLE DISPLAYS
a
At the end of this module, you will be able to:
 Create Reusable Displays
 Understand Model Substitution
 Discuss Tag Groups
80%
Proficy iFIX Fundamentals - Reusable Displays
16-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Reusable Displays
Asset
Models
HMI
Overview
HMI graphics often display many elements that, though different, can be depicted with the
same objects and pictures. For instance, multiple Process Units with same (or similar) I/O
data could be viewed and controlled using a common HMI Picture.
Re-usable displays allow a developer to define a universal template picture for use with
equipment with similar functions. The data sources normally defined in the picture as the
SERVER.NODE.TAG.FIELD in a Datalink or Color animation, a WriteValue or
ToggleDigitalPoint, have a placeholder, a symbol, instead which is identified using an @
character before and after the symbol in the data source value.
In Run mode the re-usable HMI picture has these symbols substituted with actual
SERVER.NODE.TAG.FIELD sources to show and control values pertaining to specific pieces
of equipment.
This feature not only speeds up development and simplifies maintenance, but it also builds
consistency and standards into the application, making it easier to use.
Figure 16-1. Re-Usable Example – Animations from Symbols
Model Substitution versus Tag Groups
iFIX Workspace has two methods of achieving this re-usable display functionality.
Asset models defined in Configuration Hub can use Substitution Parameters defined with
the Model Type to replace the @symbol@ in the HMI re-usable display in Run mode.
With Tag Groups, a separate Tag Group file must be created. This is a mapping list of
@symbol@ to actual data source. Again the @symbol@ is replaced in the HMI re-usable
display in Run mode.
Education Services
16-3
GFS-154K
Proficy iFIX Fundamentals - Reusable Displays
Asset Model Substitution
There are three main steps to deploying Asset Model substitution:
 Define in Configuration Hub an Asset Model with Substitution Parameters. This will have
already been done when building the SCADA system, thus no extra work at this step
 Build re-usable displays with Substitution Parameters incorporated into data sources
 Set Symbol Values to actual data sources in Run mode
Step 1: Build the Asset Model, using Substitution Parameters
This was discussed in an earlier chapter, refer back to the Process Database Thin Clients
chapter.
Essentially though, a deployed model must exist using one or more Substitution Parameters.
Step 2: Building re-usable displays
Re-usable displays regardless if used with Model Substitution Parameters, or Tag Group
files, are built using the same tools as normal displays. Objects, properties, animations, and
scripts are all deployed in the usual manner with one exception, symbols are used in lieu of
data sources. These symbols will be matched up with data sources in run mode through the
loading of symbol values, rather than being permanently defined as with normal pictures.
When configuring animations, experts, or scripts that will use symbols, usually a part of the
data source will use an “@” character to denote the start and end of the symbol. The
developer can supply a single symbol for the entire data source, and then substitute any
fully qualified tag name. For example, a linear (like a vertical fill) or format (a datalink)
animation normally uses the fully qualified data source syntax:
Fix32.THISNODE.ProficyPharma>Ingredients>phStabilizer>OutletRate.F_CV
With Tag Group Substitution, fully substituting this whole source is common, a generic
symbol would replace this entire data source:
@Ing_OutRate@
Partial substitution is how Model Substitution Parameters are designed to be used.
Partial Substitution also works well for Tag Groups. The generic symbol replaces only part
of the data source:
Fix32.THISNODE.ProficyPharma>Ingredients>@IngredientName@>OutletRate.F_CV
Likewise, more than one partial substitution can occur in the same data source, as long as
the multiple symbols are defined in the Model or Tag Group file.
Fix32.@NodeName@.ProficyPharma>Ingredients>@IngredientName@>OutletRate.F_CV
Finally, writing a value to the source can be achieved using an expert, which generates the
VBA required, or directly in the VB Editor.
ToggleDigitalPoint“Fix32.@NodeName@.ProficyPharma>Ingredients>@IngredientName@>InletPump”
16-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Reusable Displays
Figure 16-2. Model Substitution Parameter - definition
The Substitution Parameter of IngredientName was defined in this example Model and was
used when a Model instance was deployed to substitute part of the Description and I/O
Address. This speeded up the development of the Process Database Tags created to
support the model, and the Model itself which subsequently can be used for browsing data
sources in the Expression Builder.
Figure 16-3. Picture animation using the same Substitution Parameter
Reusable displays can make use of this exact same Substitution Parameter by placing it
within a Data Source value in any animation or supported expert. In Run mode a VBA
Subroutine is called to replace the element within the @ @ characters with a real process
unit value.
GFS-154K
Education Services
16-5
Proficy iFIX Fundamentals - Reusable Displays
Step 3: Set the Symbols in Run mode
Once the Asset Model and its Substitution Parameters exist and an HMI picture has been
developed using the @symbols@, these now can be substituted in Run mode.
A method of triggering the setting values to the symbol will be executed in Run mode. This
could be a pushbutton, text, or any object that typically is clicked.
A Command Expert can be used to apply the required VBA code.
The Set Symbol Values expert is used.
Figure 16-4. Set Symbol Values expert
The expert allows up to 5 symbols in the picture to be substituted at once on the click of the
relevant object.
In practice, since this is a defined Asset Model, it may only be one symbol which is replaced,
but since partial substitution would be used, it can potentially change 100’s of data sources
used in 100’s of animations in the re-usable display, at once.
The actual VBA Subroutine added is fairly straightforward and could be carried without the
expert for those confident in their VBA abilities.
SetValuesToSymbol "IngredientName", "pHStabilizer"
16-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Reusable Displays
Tag Group Substitution
There are three main steps to deploying tag group functionality:
 Build Tag Group displays with symbols instead of data sources
 Create Tag Group definition files matching symbols to data sources
 Set Tag Group navigation to substitute the data sources into the symbols
Step 1: Building Tag Group displays
Tag Group displays are built using the same tools as normal displays. Objects, properties,
animations, and scripts are all deployed in the usual manner with one exception: symbols
are used in lieu of data sources. These symbols will be matched up with data sources when
the picture is opened, rather than being permanently defined as with normal pictures.
When configuring animations, experts, or scripts that will use symbols, part or the entire
data source will use an “@” character to denote the start and end of the symbol. The
developer can supply a single symbol for the entire data source, and then substitute any
fully qualified tag name (or other data source). Similarly, a developer can use partial
substitution to define only a specific part of the data source.
For example, a linear (like a vertical fill) or format (a datalink) animation normally uses the
fully qualified data source syntax:
For example, a linear (like a vertical fill) or format (a datalink) animation normally uses the
fully qualified data source syntax:
Fix32.THISNODE.ProficyPharma>Ingredients>phStabilizer>OutletRate.F_CV
With Tag Group Substitution, fully substituting this whole source is common, a generic
symbol would replace this data source:
@Ing_OutRate@
Partial Substitution also works well for Tag Groups. The generic symbol replaces only part
of the data source:
Fix32.THISNODE.ProficyPharma>Ingredients>@IngredientName@>OutletRate.F_CV
Likewise, more than one partial substitution can occur in the same data source.
Fix32.@NodeName@.ProficyPharma>Ingredients>@IngredientName@>OutletRate.F_CV
Finally, writing a value to the source can be achieved using an expert, which generates the
VBA required, or directly in the VB Editor.
ToggleDigitalPoint “Fix32.@NodeName@.ProficyPharma>Ingredients>@IngredientName@>InletPump
Essentially, these symbols are placeholders for text to be substituted at run time. As such,
the symbol could represent a tag name, a node name, a value (such as 0 or 1) or text strings
(such as “Title” or “ID”). These substitutions are cross-referenced with their respective
symbols in the tag group definition file.
GFS-154K
Education Services
16-7
Proficy iFIX Fundamentals - Reusable Displays
Step 2: Create Tag Group Definition files
Tag Group Definition files are lists of symbols and substitutions that can be used with Tag
Group displays. Typically, these lists involve tags that describe the process as it relates to
a single piece of equipment or to a collection of equipment in a specific area. The
definitions can be used by more than one display at a time to show information in a different
context (e.g. In a main screen as well as a pop-up display).
The Tag Group Editor is a simple tool that creates cross-reference lists of symbols and
substitutions.
It could contain one symbol for substitution, the intelligence being in the re-usable display,
or it could contain 100’s.
Figure 16-5. Tag Group Editor
The Symbols appear in the Tag Group Definition (TGD) file without their “@” character
delimiters. The Substitution can be a fully qualified data source, a partially qualified data
source, a numeric value or plain text (framed with quotation marks). A Description is
included to assist developers and maintenance staff to decipher what information is being
cross-referenced.
Like picture files, TGD files are saved in the PIC directory. They can be found and opened
using the System Tree by expanding the Tag Group - Tag Group Files folder.
These substitutions can be loaded into pictures using the navigation command experts.
Figure 16-6. Tag Group Files
16-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Reusable Displays
Step 3: Add Tag Group navigation
The standard navigation experts can be added to push buttons or other objects to load tag
groups into tag group displays (including those that are already open). The animations and
DataLinks will show nothing until a tag group is loaded.
The Open Picture navigation expert is the most commonly used navigation method. Not
only can it be used to open tag group displays, but it can also load new lists while the tag
group display is already open (on-the-fly).
Figure 16-7. Open Picture navigation for tag group displays
There is also a simple tag group subroutine that can be used for in situ tag group
substitution from within a tag group display.
LoadTagGroupFile "E460"
Figure 16-8. LoadTagGroupFile subroutine
GFS-154K
Education Services
16-9
Proficy iFIX Fundamentals - Reusable Displays
Troubleshooting Topic
When a reusable display is loaded with the actual data sources values, either coming from
Asset Model Substitution Parameter values, or from a Tag Group file, the new datasource
may or may not have the same source limits as those defined in the animations of the
reusable display.
Here is an example.
If a Fill animation is used in the reusable display, the datasource will be an analog tag with a
value, a low limit and a high limit, its range.
If when the reusable display was created, and the animations were configured, the Input
Ranges were left at the defaults of 0 to 100, when a new datasource is loaded, its ranges
may, or may not be the same. This could result in an unexpected animation behavior.
Animation Experts have a Fetch Limits at Runtime checkbox.
This should nearly always be checked when animating reusable displays, to ensure that
when the new datasource is loaded, the animation can use a range defined from the new
datasource.
This does however add an, in all fairness insignificant, overhead since the picture is not only
asking for the current value from the new datasource, but also its low and high limits.
Figure 16-9. Animation – Fetch Limits at Runtime
16-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Reusable Displays
eBooks Topic
The Set Symbol Values Expert is used to configure how an Asset Model Substitution
Parameter is loaded in Run mode with specific values, a key step in reusable displays with
datasources from Asset Models.
Search the iFIX Online Help for “Set Symbol Values”. Take a read at this topic when you
have time.
Figure 16-10 Online Help – Set Symbol Values
GFS-154K
Education Services
16-11
Proficy iFIX Fundamentals - Reusable Displays
16-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Reusable Displays
Lab Exercises – Reusable Displays
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Review Asset Models and Substitution Parameters.
 Build a re-usable display.
 Load a re-usable display with Model Substitution Parameters.
Introduction
In this lab exercise you will build a re-usable display to present information from each of the
different Ingredient Tanks in our course system. You will add alarm information and a
method of loading this re-usable display with data from each of the Ingredient Tanks.
Lab Exercise #1 – Build a re-usable display
Part A – Review the course Asset Model
1. On the Windows desktop, double click the Configuration Hub shortcut.
2. Login to Configuration Hub as you did in previous labs.
3. Choose Model under your SCADA node in the Navigation Panel, then highlight
IngredientTank under Types, then click the ellipses button and choose Edit.
GFS-154K
Education Services
16-13
Proficy iFIX Fundamentals - Reusable Displays
4. Highlight one of the variables such as the InletPump. Observe the Parameter Name of
IngredientName in the Substitutions section on the left, and how this same parameter is
used in the Description and I/O Address of the variable, shown in the Details panel.
5. Close Configuration Hub when done.
Part B – Build a re-usable display
1. Open Workspace in Configure mode. Use Close All from the View Ribbon to close any
pictures.
2. From the Workspace button choose New then Picture and use the Create Picture Wizard to
Create a Picture from a Predefined Configuration.
3. At the Choose Configuration page, select the ¼ Faceplate.
4. When prompted save this picture as the IngredientTank.
16-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Reusable Displays
5. Next, from the System Tree open the HP_Class Dynamo set and locate the grpIngTank used
in an earlier lab. Drag this into the new blank IngredientTank picture and at the Update Source
prompt choose No.
Close the HP_Class Dynamo set.
6. Let’s investigate the sources in this Dynamo. Right click on the IngredientTank Dynamo and
choose Ungroup. Then click in a blank area of the picture to deselect all objects.
7. Double click on the Datalink for the InletRate.
Observe its Data Source, containing the @IngredientName@ Substitution Parameter, the
same as used in the Asset Model. Click OK to close the Datalink configuration.
GFS-154K
Education Services
16-15
Proficy iFIX Fundamentals - Reusable Displays
8. All data sources in this picture for animations and control contain this @IngredientName@
parameter. However, the Unit Name at the top is not animated. Highlight this
@IngredientName@ title text object, right click and choose Animations.
9. In the Basic Animation dialog, click the Configure button in Advanced Animation.
10. Move to the Text tab and check Animate for the Caption property.
11. Browse the Expression Builder and select from the Model tab the ParameterName from the
Cellulose_E460 Ingredient. Any Ingredient will be fine as this is the part we will modify
anyway.
12. Click OK to close the Expression Builder.
16-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Reusable Displays
13. Now in the Data Source field, manually modify the tag reference to replace Cellulose_E460
with @IngredientName@. The Data Source now being:
Fix32.THISNODE.ProficyPharma>Ingredients>@IngredientName@>ParameterName
14. Lastly set the Formatting Justify Text to Center, and the Chars/Line to 20.
Then click OK twice to close both Advanced Animations and Basic Animations dialogs.
Next you will add 4 x Datalinks and 5 x text objects, followed by a Pushbutton, all placed to
the right of the Ingredient Tank. The end result will look like this:
15. Add the 5 x Text objects as shown above for the Alarms title, then Current Alarm, Latched
Alarm, Unacknowledged Alarms? and Alarm Occurrences. Set their Foreground Color to
HPTrueBlack.
GFS-154K
Education Services
16-17
Proficy iFIX Fundamentals - Reusable Displays
16. Next add the Datalinks below each of these as follows:
a. Current Alarm:
Fix32.THISNODE.ProficyPharma>Ingredients>@IngredientName@>OutletRate.A_C
UALM
(for the first one to save typing errors, browse the Expression Builder and select the
A_CUALM field for one of the Ingredient OutletRate tags, then modify to replace the actual
Ingredient name with the parameter @IngredientName@ as shown.
b. Latched Alarm:
Fix32.THISNODE.ProficyPharma>Ingredients>@IngredientName@>OutletRate.A_L
AALM
c. Unacknowledged Alarms?:
Fix32.THISNODE.ProficyPharma>Ingredients>@IngredientName@>OutletRate.A_N
ALM
d. Alarm Occurences:
Fix32.THISNODE.ProficyPharma>Ingredients>@IngredientName@>OutletRate.F_AL
MOCCUR
17. Change the Foreground Color of the Datalinks to GEAqua if you wish to align all with the HMI
design.
18. Next add a Pushbutton (Toolbox or Insert Object/Links from the first 3 Ribbons), and double
click to set its Caption as Ack.
19. With this pushbutton highlighted, from the Tools Ribbon choose Commands then
Acknowledge All Alarms.
20. At the prompt for Picture Name, check the
Acknowledge All Alarms for Current Picture in Run Environment checkbox, then click OK.
21. Position the Pushbutton under the Alarm values.
22. Save the IngredientTank picture (Ctrl-S).
16-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Reusable Displays
Lab Exercise #2 – Load with Model Substitution Parameters
Part A – Add a method to load each individual Ingredient
1. With the IngredientTank picture open, add a new Pushbutton to the left of the Ingredient
Tank, set its Caption to Cellulose_E460. Resize to view the whole caption.
You will add pushbuttons for each of the 6 x Ingredients. Do not add them just yet.
2. With this first pushbutton for the Cellulose_E460 Ingredient highlighted, from the Tools
Ribbon under Commands, choose Set Symbol Values.
3. When the Set Symbols Values Expert opens, only row 1 needs to be configured.
Type in IngredientName as the Symbol and Cellulose_E460 as the Value.
4. Then click OK to close the Expert.
GFS-154K
Education Services
16-19
Proficy iFIX Fundamentals - Reusable Displays
5. Duplicate this first pushbutton and change its Caption to Cellulose_463.
6. Now right click on this duplicated pushbutton and choose Edit Script.
Observe the VB Code added, which contains the argument for the Value of the
IngredientName.
7. In the VB Editor, simply modify the fairly obvious part of the value to:
SetValuesToSymbol "IngredientName", "Cellulose_E463"
8. Close the VB Editor and switch back to Workspace (Alt-Q).
9. Repeat this duplication process to add 4 x more pushbuttons with the Captions and VBA
Argument for the Value set to:
a.
b.
c.
d.
pHStabilizer
Sodium_E468
Stearate_E470b
Water
You could have reused the Set Symbol Values expert, you can if you wish. Just make sure that
both the Symbol and Value are exactly as written above.
10. Save the IngredientTank picture once again.
It should now look like this:
16-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Reusable Displays
Part B – Test in Run mode
1. Switch to Run mode. Initially there is no data populating any animations, nothing is yet
loaded.
2. Click the Cellulose E460 button. Datalinks, animations, and the title will update.
3. Click the OutletRate rectangle to open the Slider Data Entry tool, set the value down to 7.
4. Observe that the Current Alarm and the Latched Alarm values have changed to LO.
5. Change again the OutletRate value, this time to 3.
6. Observe that the Current Alarm and Latched Alarm values have changed to LOLO. Also note
that the question of Unacknowledged Alarms? is YES and there has been 1 Alarm occurrence
since last acknowledgement or startup.
7. Change the OutletRate value, this time to 8.
8. Observe that the Current Alarm is back to LO, however the Latched Alarm has remained at
LOLO. This is because it is unacknowledged.
9. Change the OutletRate value, this time to 15.
10. Observe that the Current Alarm is back to OK, the Latched Alarm remains at LOLO. It has still
not been acknowledged.
11. Change again the OutletRate value, this time to 3.
12. Observe that the Current Alarm and Latched Alarm values have changed to LOLO. Also note
that the question of Unacknowledged Alarms? is still YES and there have now been 2 Alarm
occurrences.
13. Now click the ACK button. Observe that the question of Unacknowledged Alarms? is now NO
since you just acknowledged all alarms in this picture. The Alarm Occurrence has now also
been reset.
14. Change the OutletRate value, this time to 15. Observe that the Current and Latched Alarms
have cleared back to OK.
15. Cycle through all the other Ingredient buttons, observe that they are independent, the
obvious factors of the Inlet and Outlet Rates, as well as the title.
16. Switch back to Configure when done (Ctrl-Q the custom keystroke on the training system –
remember).
17. Close all open pictures and then from the System Tree open the Ingredients picture.
18. Enable the Toolbox and Switch to Full Screen in Configure mode – both in the Home Ribbon.
19. Using the Toolbox insert a Pushbutton, place it in the bottom left corner of the Ingredients
picture.
Set its Caption as Detailed View, and resize as required.
GFS-154K
Education Services
16-21
Proficy iFIX Fundamentals - Reusable Displays
20. With the Pushbutton highlighted, click the Open Picture Expert from the Toolbox.
21. In the Open Picture Expert, in the Picture Name field, click the ellipses button and select the
IngredientTank picture and click Open. Set the optional Picture Alias as PopUp then click
OK.
22. Save then close the Ingredients picture.
23.Exit Workspace, then start Workspace from your desktop shortcut.
24.Navigate to the Ingredients picture, test this new Detailed View button.
25. Challenge. Have a think how you could automatically load, for example, the Cellulose_E460
Ingredient into the IngredientTank reusable display when it opens. Remember the picture
Initialize Event!
16-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Reusable Displays
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 16 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
GFS-154K
Education Services
16-23
Proficy iFIX Fundamentals - Reusable Displays
Review Questions
1.
What two ways does iFIX offer to achieve re-usable displays?
2. Where are any Substitution Parameters declared?
3. How are data sources configured in a re-usable display? What is different to a
normal HMI display?
4. How are Substitution Parameters loaded with actual values? Think Expert.
5. What additional external component must be configured for Tag Groups to work?
Electronic Books Research
6. What is the format of exported Tag Group Definition Files?
16-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - Reusable Displays
Review
Now that you have completed this module, you should be able to:
 Create Reusable Displays
 Understand Model Substitution
 Discuss Tag Groups
GFS-154K
Education Services
16-25
Proficy iFIX Fundamentals - Reusable Displays
16-26
Education Services
GFS-154K
0)
17
HISTORICAL COLLECTION
a
At the end of this module, you will be able to:
 Understand Proficy Historian iFIX Collection
 Start the Proficy Historian iFIX Data Collector
 Configure the Proficy Historian iFIX Data
Collector
 Add iFIX tags to Proficy Historian
 Monitor Collected data
85%
Proficy iFIX Fundamentals - Historical Collection
17-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Historical Collection
Historical
Archiving
Overview
The Workspace is adept at delivering real-time information directly from data sources to
operators. Often, operations staff will want to look at trend data to understand data
progressions over time or to compare current conditions with those from different periods
of time. iFIX offloads the permanent storage of data to separate applications called
Historians. An iFIX SCADA license enables the Proficy Historian Essentials Edition. This
provides 2500 Tags on a 200 day buffer and up to 1000 permanent Tags.
Proficy Historian Essentials Edition is perfect as a local trend historian with great
performance and functionality. Proficy Historian Standard or Enterprise (or even Edge on
Linux) are viable Plant Wide or Enterprise destinations, with the local iFIX SCADA node
sending its data to these remote Historian servers. Plant Wide Standard or Enterprise
Historian servers are ideal for consolidating historical data from multiple SCADA Servers
across a site or enterprise plus other data sources typically found in an organization.
Proficy Historian compresses and stores data in proprietary archives located on the
Historian server platform. The iFIX Collector applications for Data or Alarms & Events
controlled directly by iFIX on the SCADA node.
Commonly, data collected and stored on a local Historian Essentials Edition server, will be
forwarded to a central Plant Wide Historian server using a ‘Server to Server’ collector.
When it comes to analyzing the archived data, it is viewed in a chart, table, or any
animation.
iFIX Integrated Installer
The iFIX Integrated Installer, if left at the default options will install both the iFIX SCADA
Server and the Proficy Historian Server including the Collectors for iFIX. The only steps
required after installation, when using this default option, is to add the iFIX Data or iFIX
Alarms & Events Collectors to the specific iFIX project and configure which tags from iFIX
are to be collected.
Figure 17-1. iFIX Integrated Installer – Historian option
GFS-154K
Education Services
17-3
Proficy iFIX Fundamentals - Historical Collection
iFIX Collector for Proficy Historian
The iFIX Data Collector is a Historian collector that was built specifically to connect to and
retrieve data from iFIX using the iFIX OPC/EDA communication layer. EDA, which stands for
Easy Database Access is the proprietary communications protocol for communication with
the iFIX process database. This provides for highly optimized direct communication with
tags in the iFIX process database.
While iFIX also has an OPC interface it is generally better to use the iFIX collector for speed
and reliability.
iFIX is primarily a data provider for Proficy Historian, so very little needs to be configured
within iFIX itself. The SCU Tasks list starts the iFIX Data Collector, and the Workspace uses
Charts and animations to retrieve data. Tags can be configured within Database Manager,
Configuration Hub, or the Historian Desktop Administrator to determine how Proficy
Historian collects iFIX PDB tag values.
SCU and the iFIX Data Collector
The iFIX Data Collector is a small application deployed by Proficy Historian to iFIX nodes to
assume primary data sampling, buffering and forwarding roles on behalf of the Historian. It
is able to carry out its sampling duties even when the Historian Server is not available,
forwarding all buffered data when the connection is restored.
The iFIX Data Collector is installed automatically when installing the Collectors option on any
iFIX SCADA node using the Historian installation media. It will be installed to the iFIX Base
directory with the rest of the iFIX applications. To set the iFIX Data Collector to
automatically start with iFIX and begin sampling immediately, use the SCU Tasks
configuration dialog to browse to the iHFIXCOLLECTOR.EXE application and add it as a
background task. A command line starting option such as NOSERVICE is required.
Figure 17-2. SCU Historian Tasks
17-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Historical Collection
Workspace as a Proficy Historian Client
Workspace trends and animations can access multiple Historian servers simultaneously. The
local default Historian Essentials server will already be configured, but if a plant wide
Historian server exists it will need to be added to the configuration.
Direct Configuration of iFIX Tags
Before any configuration changes can be made using Database Manager, there is some
housekeeping required to link the local iFIX node to an iFIX collector. To assist with this
configuration there is a configuration tool in the Administration Ribbon in Workspace.
Figure 17-3. Configure Historian Server
Configure Historian Server
This tool takes care of client access for data retrieval as well as connectivity for data
logging. To configure a link for the purposes of logging, use the Get Collectors button to
ensure that all local collectors can be used by the iFIX PDB to configure data sampling.
Figure 17-4. Configure Historian to iFIX connection– Workspace
GFS-154K
Education Services
17-5
Proficy iFIX Fundamentals - Historical Collection
Tag Configuration
Individual tags can be configured for collection in iFIX.
The Database Panel of Configuration Hub with a tag selected facilitates the addition of
individual tags and modification of the collection settings in the Details Panel. A Save and
Publish is required.
Using Database Manager, individual tags can be configured for collection in the Historian
tab.
The configuration setting will be forwarded to the destination Historian server automatically.
This method of adding tags for Historical collection is great when configuring the Process
database via a CSV import using either Configuration Hub or Database Manager as PDB
Tags AND Historian Tags are configured at once.
However, using the Collectors Panel in Configuration Hub or the Collectors page in the
Historian Desktop Administrator, provide much greater flexibility, especially when modifying
existing tags already collected.
Figure 17-5. Configure Tag for collection – Configuration Hub Database Panel
Tag description: An alphanumeric label for the tag data
Collect: Set the tag for collection
Collection interval: the period by which the tag value is sampled by the iFIX Collector
Collection offset: handy for performance purposes – large blocks of tags can be sampled
using the same period but at different instances in order to reduce huge spikes in CPU
demand
Time resolution: whether only whole seconds or milliseconds will be stored
Collector compression: This indicates whether the iFIX Collector will employ a method to
filter out successive duplicate values
Collector deadband: this is the tolerance for measuring equality between successive
values. (eg. 0.01 is close enough to be considered identical.). This can be measured in
absolute units (EGU) or in percentage
Compression type: whether the deadband value entered is absolute within the range of the
tag or as a percentage.
Compression timeout(ms): How often to take a “maintenance” poll regardless of filter
conditions for compression
17-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Historical Collection
Figure 17-6. Configure Tag for collection – Historian tab Database Manager
GFS-154K
Education Services
17-7
Proficy iFIX Fundamentals - Historical Collection
Collector Configuration
Both Configuration Hub and the Historian Desktop Administrator are capable of configuring
the iFIX Collector Data, that is setting conditions for sampling as well as determining which
tags and fields are sampled. A template is effectively configured which is then applied to all
subsequently added tags.
It is useful to configure the iFIX Collector settings, prior to adding any tags.
Tag types and fields to browse can be modified as well as the default acceptable deadband
limit with an optional timeout. Collector Compression should be enabled and set to a lowest
acceptable level for all process values which could potentially be collected. It is strongly
recommended to never leave disabled or with a deadband of zero!
Figure 17-7. iFIX Data Collector Configuration in Configuration Hub
Figure 17-8. iFIX Data Collector Configuration in the Desktop Administrator
17-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Historical Collection
Adding Tags to the iFIX Data Collector
It is far easier to add and modify tags on mass from one of these Administration interfaces.
Remember, Configuration Hub is a thin client solution, therefore tags could be added to the
iFIX Data Collector for any registered SCADA node, from any computer with a supported
browser. No Historian software needs to be installed.
The Desktop Administrator can perform the same tasks, however, must be installed locally
on the computer where the configuration is taking place.
In the Collectors Panel of Configuration Hub, the iFIX SCADA Database can be browsed,
following the Tag types and fields to browse criteria set in the Collector configuration. One
or more, or all tags found matching the filter can then be added and will inherit the tag
template settings configured for the Collector, importantly the Collector Compression
values.
Figure 17-9. Adding Tags collection – Configuration Hub
GFS-154K
Education Services
17-9
Proficy iFIX Fundamentals - Historical Collection
In the Historian Desktop Administrator, the Add Tags button will open a tag browser that will
allow the user to select multiple tags and add them all at once. Other tag information such
as description, engineering units and high and low limits will also be mapped to the Historian
Tag when using the iFIX Data Collector.
Figure 17-10. Configuring the iFIX Collector in the Historian Administrator
Both these interfaces are much easier and quicker for adding multiple tags than the
Historian section of a tag in Configuration Hub or the Historian tab in the PDB Tag
configuration. Color coding in both cases helps to indicate which tags are already set for
collection and which tags are available to be added.
Once set, the configuration information for tags, sample rates and compression are sent
back to the iFIX Data Collector on the iFIX SCADA node.
The Data Store property seen in both interfaces is the Archive container to be used.
SCADABuffer for the rolling 200 day storage. User for permanently stored tags.
17-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Historical Collection
Adding All iFIX Tags to the iFIX Data Collector
An option exists to automatically add all tags in the currently loaded iFIX Process Database
to the iFIX Data Collector. This setting is found in User Preferences in Workspace in the
Historian page.
Figure 17-11. Enabling All iFIX tags for collection – User Preferences
This comes with an understandable warning. If enabled any existing configuration settings
will be overridden. All tag types from the iFIX Process Database will be added using their
F_CV or A_CV field and Collector Compression will be disabled.
If the iFIX Data Collector is already running and set as the default collector, all tags will be
added after a Process Database reload, or an iFIX restart.
GFS-154K
Education Services
17-11
Proficy iFIX Fundamentals - Historical Collection
Troubleshooting Topic
Collector Compression and Overruns
These two are essentially cause and effect. Frequent overruns are unlikely in most systems
but can occur. Tuning the Collector Compression for each tag will reduce significantly the
likelihood of overruns ever becoming an issue.
Any tag in Proficy Historian coming from a Data Collector, such as the iFIX Collector, can
have a deadband applied. How much does its value need to change before it is collected,
forwarded and then stored in the Proficy Historian Archive. The lower the deadband, the
more frequent the values are collected. If a Collector is tasked with collecting vast
quantities of tags where their deadband is too low, the Collector may become overloaded
and therefore miss collecting when it should. This is an overrun.
Overruns are presented in the Performance view of a Collector in Configuration Hub,
alongside the reported Collector Compression being achieved.
Figure 17-12. Configuration Hub – Collector Performance
The Proficy Historian Desktop Administrator also reports the current Compression achieved
and Overruns as a statistic against each Collector.
Figure 17-13. Proficy Historian Desktop Administrator – Main - Collectors
If overruns occur, simply increase the Collector Compression, the deadband, for as many
tags belonging to the collector as possible.
17-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Historical Collection
eBooks Topic
In this chapter we have barely scratched the surface regarding how Proficy Historian is able
to collect and store data from iFIX. This is good, it proves how simple it is to configure using
the defaults.
The iFIX Online Help offers several topics on using the Proficy Historian iFIX Data Collector.
Search the iFIX Online Help for “Using iFIX with Proficy Historian”. Take a read at this topic
and the linked topics when you have time.
Figure 17-14 Online Help – Using iFIX with Proficy Historian
GFS-154K
Education Services
17-13
Proficy iFIX Fundamentals - Historical Collection
17-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Historical Collection
Lab Exercises – Review of Training Architecture
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Setup the iFIX Historian Collector to start automatically by adding it to SCU Startup Tasks
list
 Configure default options for the iFIX Collector
 Add tags from your SCADA server into your local instance of Proficy Historian
 Monitor collection using Configuration Hub
Introduction
In these lab exercises you will learn how to add the iFIX Data Collector to your SCADA
project. Then you will configure some of its default setting. You will then add tags to your
local Proficy Historian server from this iFIX Data Collector and monitor the collection
performance.
Lab Exercise #1 – Configure the iFIX Data Collector
Part A – iFIX Data Collector Startup
1. Shutdown iFIX if already running, since you are making changes in the SCU a fresh startup
is required.
2. Open the SCU, (you should know by now the various ways to open the SCU).
In the SCU select Configure – Tasks
3. Add to the task list the iFIX collector.
a. Click the
browse button to select the ihFIXCollector.exe application in the File
name field
b. Enter NOSERVICE in the Command Line options
c. Ensure Background is set as the Start Up Mode, then click Add
4. Click OK to close the Task Configuration. Save and close the SCU.
5. Now startup your iFIX SCADA# from the desktop shortcut. The iFIX Collector will start in
the background.
GFS-154K
Education Services
17-15
Proficy iFIX Fundamentals - Historical Collection
Part B – Configure the iFIX Data Collector
1. When Workspace opens, switch back to Configure mode.
2. From the Administration Ribbon, click Configure Historian then Configure Historian Server.
3. Observe the default configuration. Your local Historian Server will already be set as the
default Historian Server. The Computer name HOST-# where # is your student number, not
the iFIX Nodename.
4. Click the Get Collectors button at the bottom. Highlight the listed Collector, then click Set
Default. This is required for modifications made from the Historian section of a tag in
Configuration Hub, in the Historian tab of a tag in the process database or using the
Automatically configure tags option in User Preferences.
5. Click Close to close this Proficy Historian Server Configure window.
17-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Historical Collection
6. From the Applications Ribbon in Workspace click the Configuration Hub button. Log in to
Configuration Hub as you have done many times before.
7. When Configuration Hub opens expand your Historian server and click Collectors in the
Navigation Panel, then highlight your iFIX Data Collector.
8. With your iFIX Data Collector highlighted, view the Details Panel. Scroll to the Tag Browse
Criteria section and click the Modify Criteria icon.
GFS-154K
Education Services
17-17
Proficy iFIX Fundamentals - Historical Collection
9. In the Tag Browse Criteria window AI – Analog Input with its F_CV and B_CUALM is
automatically configured.
Click + Add Blocks to add a new block and field. Add the following tags and fields:
a.
b.
c.
d.
e.
f.
CA- Calculation – F_CV
DI – Digital Input – F_CV
TT – Totalizer – F_CV
TX – Text – A_CV
Uncheck the B_CUALM from the AI-Analog Input tag
Click Apply
10. Next scroll down to the Collector Compression section. Enable Collection Compression.
Then modify the following settings:
a.
b.
c.
d.
Deadband: Percent
Deadband value: 1
Compression Timeout: 1
Compression Timeout Interval: Hours
11. Click the Save button in the far top left of Configuration Hub. You should see a success
message for modified properties:
17-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Historical Collection
12. Now let’s add tags to the iFIX Data Collector.
With your iFIX Data Collector highlighted, click the ellipses button, and choose Add Tags.
13. When the Add Tag tab opens, click the Search Tags button.
Here you could add a filter on Tag Name, Description or All Source Tags, or those Not Yet
Collected.
14. A list of iFIX tags matching the tag types configured earlier will be listed.
Check the select all checkbox next to the TAG NAME column to select all tags.
15. Now click the Add Tags button at the bottom. Leave the DATASTORE field set to User.
16. You should see a success message for the newly added tags:
GFS-154K
Education Services
17-19
Proficy iFIX Fundamentals - Historical Collection
Part C – Monitor Collection
1. With your iFIX Data Collector highlighted, click the ellipses button again, but this time
choose View Collector Performance.
2. Scroll through the graphs presented. Note the Collector Compression graph, this will change
to very high, perhaps above ~90% after the collection has been running for a few minutes,
meaning that only ~10% of samples actually changed enough to warrant storage in the
Historian Archive. These graphs default to 1 hour but alternate time settings can be easily
applied. The graphs can also be expanded to fill the panel.
Try a few alternate times and views.
17-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Historical Collection
3. Next, click on Tags under your Historian in the Navigation Panel. Enter a TAG NAME Filter of
level, then highlight one of your TANKLEVEL tags, click the ellipses button and choose View
Last 10 Values.
This Last 10 Values view is incredibly useful when adding and tuning collection of tags. You
can check to see if these are the expected values. When Collector Compression settings are
tweaked, the resultant effect can be quickly monitored.
GFS-154K
Education Services
17-21
Proficy iFIX Fundamentals - Historical Collection
4. Lastly click the Trend button in order view the recent values as a trend chart.
5. Close Configuration Hub when completed.
17-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Historical Collection
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 17 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
GFS-154K
Education Services
17-23
Proficy iFIX Fundamentals - Historical Collection
Review Questions
1.
Historian Essentials has a time limited buffer.
How many tags can be collected in this SCADABuffer and what is the maximum age of
the data?
2. What are the two main settings which determine the actual values collected from the
iFIX tags?
3. Name three ways in which iFIX Tags can be added to the Collector?
4. How is the iFIX Collector for Proficy Historian started?
5. What two different ways can the Timestamp of the collected values be set?
Electronic Books Research
6. How does Compression Timeout work? (You will have to check the eBooks for Proficy
Historian)
17-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - Historical Collection
Review
Now that you have completed this module, you should be able to:
 Understand Proficy Historian iFIX Collection
 Start the Proficy Historian iFIX Data Collector
 Configure the Proficy Historian iFIX Data Collector
 Add iFIX tags to Proficy Historian
 Monitor Collected data
GFS-154K
Education Services
17-25
Proficy iFIX Fundamentals - Historical Collection
17-26
Education Services
GFS-154K
0)
18
ANALYTICAL DISPLAYS
a
At the end of this module, you will be able to:
 View Historical data with the Line Multiline Chart
Object
 Manipulate Display Time settings
 Use Workspace as a Historical HMI
90%
Proficy iFIX Fundamentals - Analytical Displays
18-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Analytical Displays
Historical
Archiving
HMI
Overview
Archived data is a valuable resource for trends, reports and other analysis that can help
improve the operation of the process. Once data has been stored in Proficy Historian, it is a
fairly straightforward task to retrieve it into Workspace displays.
A common object for data retrieval is the Line Multiline Chart Object. When it comes to
viewing, trending or analyzing data, this chart object can display Real Time data and
Historian data at the same time.
Workspace objects can also be animated from any Proficy Historian tag, therefore it is
possible to provide an HMI based on data from the past.
Historical Animations will be supplied the start date and time, the time zone, the historical
mode, duration, and update rate.
Figure 18-1.Analytical Display
GFS-154K
Education Services
18-3
Proficy iFIX Fundamentals - Analytical Displays
Line Multiline Chart Object
The Line Multiline Chart object is the primary trend tool in Workspace. It can be added from
the Charts section in the Insert Ribbon or from the ToolBox. There is also a standard
Dynamo Set named Chart_LineHist that provides a chart object equipped with functionality
to easily manipulate chart functions.
Line Multiline charts have great flexibility in their appearance, as well as their ability to
manage a subset of data in different ways. If needed, Line Multiline Charts can present
data using logarithmic scales. Tabular results and export capabilities are also available. The
X-Axis always represents time and both real time and historical data can co-exist within the
same Multiline chart object.
Configuration
There are several tabs for configuring the various aspects of the chart.
The General tab provides among many things Runtime functionality, appearance, update
rates, the duration of the chart, and zooming abilities.
Figure 18-2. General configuration tab
18-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Analytical Displays
Data Sources
This tab is where data source selection is made from Real Time or Historian data and
controls how data is retrieved, with Time and Historical mode settings.
Legend and Y Axis appearance is also configured here.
Figure 18-3. Data Sources configuration tab
Adding Pens
The Line Multiline Chart object will query batches of data from the Historian archives using
four criteria:
 Data source (Server.Node.Tag.Field)
 Time range (start and duration)
 Interval
 Historical Mode
Data sources (pens) are added using the Expression Builder from the Data Sources tab.
This exposes the Historian tab allowing Historian Server(s) to be browsed for tags.
GFS-154K
Education Services
18-5
Proficy iFIX Fundamentals - Analytical Displays
iFIX nodes can retrieve historical data from single or multiple Historian Servers at the same
time. The configuration of the connection to the Historian Servers is specified using
Configure Historian Server, found under Configure Historian in the Administration Ribbon in
Workspace.
When using Historian with a Line Multiline chart object, the data source pane will resemble
the list below. The list will include the HIST server name, the names of all the Historians, as
well as the nodes that the Historians sample from, and a combined entry for each
respective tag and field being sampled.
Figure 18-4. Expression Builder for Historian
Once the data source has been chosen, the Historical Mode can be selected. Historian
provides six historical modes that will supply a single aggregate result from a number of
samples within a specified time interval.
For any given Interval:
 Sample will retrieve the last sample
 Average will supply an average for all samples
 High returns the maximum value of all samples
 Low returns the minimum value of all samples
 Interpolated The data is interpreted by assuming that the line between two values is a
straight line. All points along that line are estimated except the starting point and the ending
point
 Trend The raw data for the minimum and maximum values for each interval is returned
18-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Analytical Displays
Chart Style
This tab exposes many features such as numerical precision of the data presented, grid
settings, legend settings and border styles. Particularly useful are the Y Axis styles of
Multiple, Stack and Single which if available, can be cycled through in Run mode. The
Thumbnail feature is also very useful, which allows real presentation of data in Run mode on
a very small ‘thumbnail’ sized chart object, with an ability to be expanded to full screen
instantly in a single click.
Figure 18-5. Chart Style configuration tab
Other tabs such as Subsets, Axis, Font and Color allow further appearance attributes to be
manipulated.
GFS-154K
Education Services
18-7
Proficy iFIX Fundamentals - Analytical Displays
Plotting Style
This tab provides pen color options, shadows and the plotting style such as Line, Bar, Area
or Point graphs plus combinations of styles.
Figure 18-6. Plotting Style configuration tab
18-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Analytical Displays
iFIX as a Historical HMI
iFIX animations can be connected to the Historian Server source instead of the Real Time
PDB Tags. This means that an HMI display can be created where the timeframe is
manipulated and effectively rolled back to a user’s defined period.
In practice, if a critical alarm or condition occurred at a point in time that can be identified,
rather than viewing a tabular list of values, alarms and statuses, a graphical representation
can be made of all relevant process values, and since the timeframe can be controlled,
users could view a process status immediately prior to the occurrence of any critical alarm
or condition.
Historical Datalink
This object shows Historical data for a single tag. The default will also provide the
TimeStamp of the data for reference. This is a Historical retrieval, so the normal factors of
Start Time, Duration and Historical Mode apply, however there is only ever one Interval in
the calculation. This is a useful object for providing rollup values in a display.
Figure 18-7. Historian Datalink
GFS-154K
Education Services
18-9
Proficy iFIX Fundamentals - Analytical Displays
Historical Animations
Objects can have almost any property animated from a Historical source. In the same way
as the Historical Datalink, Source, Start Time, Duration and Historical Mode must be
supplied, however again there is only one Interval.
Since it is possible to collect and store iFIX PDB Tag data using the iFIX Historian Data
Collector within milliseconds of a changing, it is possible to create a complete HMI to
monitor a process or plant using Historical sources.
Obviously, the data is read only therefore any control would have to be achieved via iFIX
PDB Tags.
Figure 18-8. Historical Animations
With Historical animations data can be retrieved using:
 Sample will retrieve the last sample
 Average will supply an average for all samples
 High returns the maximum value of all samples
 Low returns the minimum value of all samples
 Interpolated The data is interpreted by assuming that the line between two values is a
straight line. All points along that line are estimated except the starting point and the ending
point
 Current Value returns the most recent value stored in the archive
 Standard Deviation returns the standard deviation of all valid data found during the
specified interval
 Total returns the total of all valid data found during the specified interval
18-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Analytical Displays
Display Time Controls
Workspace provides a Global Time Control to manipulate Historical time settings within the
selected display. This means that a Historical HMI display can have the start time of all
Historically animated objects set to a new value instantly. It also controls the historical
duration of the display.
The Global Time Control is accessed in Run mode from the Workspace Historical Ribbon.
Figure 18-9. Global Time Control
This also includes a PlayBack function where a Historical HMI could replay at speed (e.g.
10x or up to 200x) process changes in a user defined time period.
The functions that the Global Time Control provide are also exposed through VBA, allowing
a developer to create objects on screen to control these historical time settings.
For example:
To scroll a display back in time, use in VBA:
System.GlobalScrollBackSlow
To scroll a display forward in time, use in VBA:
System.GlobalScrollForwardSlow
To set the end time of the display use in VBA:
System.SetGlobalMovingEndTimeToCurrent
Enable the Playback Function in VBA:
System.GlobalPlayback = True
Visiconx
The VisiconX tools allow SQL queries to return tabular data from a Historian Server (using
OLE DB) to iFIX Workspace screens. VisiconX tools have a wizard to make retrieval of
Historian Data and iFIX integration inside displays simple.
Note
VisiconX are a suite of ActiveX controls available to all iFIX Displays. These tools
are covered in detail in the iFIX Advanced class. Ask your instructor for a place on
the next class.
GFS-154K
Education Services
18-11
Proficy iFIX Fundamentals - Analytical Displays
Troubleshooting Topic
Interpreting Historical data can be an artform. Thankfully Proficy Historian Client tools, be
the destination a Workspace Chart or an animation, provide many functions to assist in this
craft.
Take for example a data source which is a sine wave with a 20 second periodicity. If
displaying in a chart with a 1 hour duration and using the 20 second or even a 10 second
Interval period, it is possible, albeit theoretical, to retrieve values as the sine wave passes
through zero.
Worse still is if the collection rate itself was also 20 seconds or 10 seconds, again the iFIX
Data Collector may only have collected values as the sine wave passed through zero.
When both collecting and retrieving historical data always think about the characteristics of
the process and how the combination of collection rate, span of retrieval and interval time
will affect the results.
Challenge what is presented. Adjust the Interval time to present more values than needed,
then back off, increase the Interval until a representation of the process for the reporting
needs is met.
Of course, this is all about tuning. When commissioning of a new project, the collection rates
for each process should be finely tuned (its Collector Compression – deadband setting), to
ensure that the values needed for any subsequent reporting are collected and archived,
avoiding the scenario of collecting only when the sine wave passes through zero. This of
course must be weighed up against overloading the Collector to avoid overruns.
Figure 18-10. Effective retrieval of a Sine value
Figure 18-11. Retrieval of the same Sine value with ineffective settings
Figure 18-12. Retrieval of the same Sine value with only values passing through zero
18-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Analytical Displays
eBooks Topic
In this chapter we looked at the Multiline Chart, also known as the Enhanced Chart.
It is possible to load different sets of pens in run mode. This allows the Charts to be
configured with, for example 10 pens, but only show 3 at a time.
The Subsets feature facilitates this.
Search the iFIX Online Help for “Subsets”. Take a read at this topic when you have time.
Figure 18-13 Online Help – Using Subsets
GFS-154K
Education Services
18-13
Proficy iFIX Fundamentals - Analytical Displays
18-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Analytical Displays
Lab Exercises – Analytical Displays
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Add a MultiLine Chart to the Analytics display.
 Add Historical rollup values using Historical Datalinks
 Manipulate time settings in the Historical display.
Introduction
In this lab exercise you will use the MultiLine chart to display the last 1 hour of data for the
Ingredient Tanks levels. You will also display the last 1 hour average for each tank level in
Historical Datalinks.
You will then use the Global Time control functions, from a pre-built dynamo, to control
display time.
Lab Exercise #1 – MultiLine Chart object
1.
Firstly, ensure that you have Workspace open in Configure mode. Close any pictures that may
be open.
2.
From the System Tree, or Ctrl-O, open the Analytics picture saved in an earlier lab.
3.
From the Insert Ribbon, click the Line Multiline Chart button. You will see the crosshairs, the
same as seen when creating a simple rectangle, draw a box on the right of the Analytics picture
using this crosshair. A new chart will appear, resize further as necessary.
Once tags are added plus optional cosmetic tweaks it will look like this:
4.
Double click on this new chart to start to configure its setting.
GFS-154K
Education Services
18-15
Proficy iFIX Fundamentals - Analytical Displays
5.
In the General tab modify as follows. The screenshot below highlights the important
modifications:
a. Object Name: IngredientChart
b. Time: 01:00:00
c. Enable or Disable checkboxes as shown
d. Historical Update Rate: 00:10:00
6.
Next move to the Data Sources tab and in the Data Sources List section click into the first row
followed by clicking the ellipses button to open the Expression Builder.
7.
Before any Historical Source is used from the Expression Builder, the Historian tab will be
hidden, click the down arrow on the right and then click Historian from the list.
18-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Analytical Displays
8.
In the Expression Builder, Historian tab, complete the following in order:
a. From the Servers drop down box, select your Historian server, it will be HOST-#, e.g.
HOST-1
b. In the Tag Filter field type in *level*
c. Click the Apply Filter button
d. Highlight from the list the tag
Hist.THISNODE.PROFICYPHARMA>INGREDIENTS>CELLULOSE_E460>TANKLEVEL.F
_CV
e. Then click OK
Notice that both your SCADA# and THISNODE are available. Using THISNODE makes this
picture reusable on other nodes, if student 2 on SCADA2 were to open this picture where
THISNODE is used, as long as the connected Historian contains these tags, it will instantly
work.
9.
Now add the other tags required. Click into the second row, under this first tag, it will highlight
in blue. Click once more then click the ellipses button to enter the Expression Builder.
Repeat the selection process above, but this time to add each of the following tags, one at a
time:
a.
b.
c.
d.
e.
Hist.THISNODE.PROFICYPHARMA>INGREDIENTS>CELLULOSE_E463>TANKLEVEL.F_CV
Hist.THISNODE.PROFICYPHARMA>INGREDIENTS>PHSTABILIZER>TANKLEVEL.F_CV
Hist.THISNODE.PROFICYPHARMA>INGREDIENTS>SODIUM_E468>TANKLEVEL.F_CV
Hist.THISNODE.PROFICYPHARMA>INGREDIENTS>STEARATE_E470B>TANKLEVEL.F_CV
Hist.THISNODE.PROFICYPHARMA>INGREDIENTS>WATER>TANKLEVEL.F_CV
GFS-154K
Education Services
18-17
Proficy iFIX Fundamentals - Analytical Displays
10.
In the section under the Data Source List, there are 4 x tabs. The Data tab defaults are fine.
Move to the Time tab and with the first tag highlighted set in this order:
a. Apply To All Data Sources: checked
b. Duration before now: 01:00:00
c. Click the Apply button
11.
When you click the Apply button, a Warning prompt will appear, click OK.
We want all sources to use the same time settings.
All other Data Sources tabs can stay at the default values.
18-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Analytical Displays
12.
Move now to the Chart Style tab. Make the following modifications, as highlighted in the
screenshot below:
a. Show Plotting Style Legend: Unchecked
b. Gridlines: None and One Pixel
c. Then click Apply
13.
Next move to the Font tab. If you wish, modify all fonts to use GE Inspira Sans. Click Apply.
14.
Move to the Color tab. Again, if you wish, modify some colors. For example, Desk and Graph
Foreground and Background Colors. Perhaps a Graph Background of white then click Apply.
15.
Lastly, in the Plotting Style tab, leave at the defaults, you could come back here later and modify
the Plotting Style to see the effects.
16.
Click OK to close the chart. Position and size as per the example at the start of this lab
exercise.
17.
Save this Analytics picture (Ctrl-S).
GFS-154K
Education Services
18-19
Proficy iFIX Fundamentals - Analytical Displays
18-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Analytical Displays
Lab Exercise #2 – Historical Datalinks
1. With this Analytics picture still open, add 6x text objects as labels for each of the Historical
Datalinks you will add. Set their captions to:
a. Cellulose E460 Level – Avg
b. Cellulose E463 Level – Avg
c. pH Stabilizer Level – Avg
d. Sodium E468 Level – Avg
e. Stearate E470b Level – Avg
f. Water Level – Avg
Once complete this section of the Analytics picture will look like this:
2. Next from the Toolbox, or the Insert Ribbon under Objects/Link choose the Historical
Datalink.
3. When the Historical Datalink window opens, configure as follows:
a. Source:
Hist.THISNODE.PROFICYPHARMA>INGREDIENTS>CELLULOSE_E460>TANKLEVEL.F_CV
b. Show Timestamp With Data: Enabled
c. Historical Mode: Avg
d. Duration Before Now: 1 Hours
e. Duration: 1 Hours
See the next page for how this Historical Datalink configuration will look.
GFS-154K
Education Services
18-21
Proficy iFIX Fundamentals - Analytical Displays
4. Then click OK and position under the Cellulose E460 label.
5. Repeat to add the other 5 x Tank Level Historical Datalinks under their relevant labels for:
a. Hist.THISNODE.PROFICYPHARMA>INGREDIENTS>CELLULOSE_E463>TANKLEVEL.F_CV
b. Hist.THISNODE.PROFICYPHARMA>INGREDIENTS>PHSTABILIZER>TANKLEVEL.F_CV
c. Hist.THISNODE.PROFICYPHARMA>INGREDIENTS>SODIUM_E468>TANKLEVEL.F_CV
d. Hist.THISNODE.PROFICYPHARMA>INGREDIENTS>STEARATE_E470B>TANKLEVEL.F_CV
e. Hist.THISNODE.PROFICYPHARMA>INGREDIENTS>WATER>TANKLEVEL.F_CV
6. Add divider lines if you wish to align with our HMI design.
Add an Analytics title text object.
The magnifying glass icon can be found in the GE_Icons Dynamo set.
Cosmetically modify as you see fit and have time for.
7. Save the Analytics picture.
18-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Analytical Displays
Lab Exercise #3 – Global Time Controls
1. With this Analytics picture still open, locate, and open the HP_Class Dynamo set.
2. Drag into the area under the Historical Datalinks, the GlobalTime Dynamo. This pre-built
dynamo has controls which are available from the Workspace Run mode Ribbon, but in one
easy to access place.
3. Right click on a blank area (no object selected) on this Analytics picture and choose Edit
Script.
4. Recall use of the picture Initialize event to run code when the picture opens.
From the left hand Object list select CFixPicture. The Initialize event script will be shown.
5. Add one more line to this Initialize script. Before End Sub type in:
System.SetGlobalMovingEndTimeToCurrent
6. Close the VB Editor (Alt-Q) and back in Workspace Save the Analytics picture.
7. Switch to Run mode to test this Historical Analytics picture.
GFS-154K
Education Services
18-23
Proficy iFIX Fundamentals - Analytical Displays
8. Display End Time should have updated to the current time. This was the VB added in the
Initialize event which achieved this.
9. Note that the Historical Datalinks and the chart will be showing data for the last 1 hour period.
If 1 hour has not yet elapsed, you will see &&&& in the value.
10. Click the 5m button in the Global Time Control Dynamo. The Historical Datalinks and the
Chart are now only looking at a 5 minute period with an ending time of now.
11. Click the << rewind icon a few times in the Global Time Control Dynamo. Observe the
Historical Datalink timestamps and the time frame of the chart rolling back.
12. Click the clock icon in the Global Time Control Dynamo, this will set the Display End Time
back to the Current Time.
13. Click the 1h button in the Global Time Control Dynamo. All are back to a 1 hour display.
14. Return to Workspace Configure mode when done. Save and close the Analytics picture.
18-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - Analytical Displays
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 18 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
GFS-154K
Education Services
18-25
Proficy iFIX Fundamentals - Analytical Displays
Review Questions
1.
Can Chart objects view real-time and historical data simultaneously?
2. What inputs are required when retrieving historical data into a Line Multiline chart
object?
Explain what Sample mode achieves?
3. What Y-Axis style are support in the Line Multiline Chart object?
4. With Historical Animations, name four properties that could be animated.
5. How is the Global Time Control normally accessed in Run Mode? What does
System.GlobalMovingEndTime return?
Electronic Books Research
6. What does the Standard Deviation mode of a Historical Datalink retrieve?
18-26
Education Services
GFS-154K
Proficy iFIX Fundamentals - Analytical Displays
Review
Now that you have completed this module, you should be able to:
 View Historical data with the Line Multiline Chart Object
 Manipulate Display Time settings
 Use Workspace as a Historical HMI
GFS-154K
Education Services
18-27
Proficy iFIX Fundamentals - Analytical Displays
18-28
Education Services
GFS-154K
0)
19
SECURITY
a
At the end of this module, you will be able to:
 Describe Layers of iFIX Security
 Understand Basic iFIX Security
 Secure Applications, Tags & Pictures
 Understand the concepts of Proficy
Authentication (UAA)
95%
Proficy iFIX Fundamentals - Security
19-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Overview
iFIX by default, can use its own stand-alone security sub-system, with very little interaction
with the Windows Security features. All security features must be assigned while iFIX is
running.
Windows Security accounts can very easily be applied as iFIX user accounts, allowing
Windows Security Policies to apply such as, maximum age and password complexity
enforcement.
iFIX Security Contains Users and Groups, with Users potentially members of one or more
Groups.
iFIX security allows different levels of restriction. Each Group and User can be assigned
rights to any of the iFIX Applications (such as Workspace or Database Manager). Within
these applications, certain features and functions require their own rights and privileges (for
example Workspace Runtime or Configure access).
Below the application level, Users are also restricted based on Security Areas. Restrictions
can be applied to Process Database tags and Workspace pictures. Who can write to a tag
value, who can open a picture?
For access across the network, the requesting user must have rights on the responding
node. Even network connections themselves can be secured.
In many cases iFIX security files are shared from a secure central folder.
In regulated industries, iFIX security can be synchronized to a Windows Domain, allowing
iFIX security assignments to be deployed by authorized IT administrators, who have may
have no access directly to iFIX.
In iFIX v2022, Proficy Authentication was introduced.
As the Proficy suite of applications accelerates its adoption of web-based interfaces, both
for development and client presentation, a web-based security architecture was required.
Proficy Authentication uses the User Account and Authentication (UAA) model and is based
on the OAuth2 standard.
Certificates are exchanges, account details are encrypted.
Proficy Authentication in iFIX is used primarily with Configuration Hub, which has been used
several times on this training course.
Other Proficy products such as Historian, Operations Hub and Plant Applications also use
Proficy Authentication.
Central development and maintenance of a security system is achieved through Proficy
Authentication.
In this iFIX Fundamentals course, we will focus mainly on the local security architecture of
iFIX.
GFS-154K
Education Services
19-3
Proficy iFIX Fundamentals - Security
Security Configuration
The Security Configuration Utility can be launched either from the Applications Ribbon in
Workspace, or from the SCU. This tool can only be used while iFIX is running, and specific
Security Configuration rights must be granted to the user.
Figure 19-1. Launch the iFIX Security Configuration Utility
The toolbox buttons in order, provide access to the functional areas of:
 Users
 Groups
 Configuration
 AutoLogin
 Areas
Figure 19-2. iFIX Security Configuration
19-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Specify Security File Locations
Since rights and privileges must be consistent amongst nodes on a network, it is common
for iFIX nodes to use a shared location for the main Security path, with the Backup path
configured to use a local set of copied files (or an alternative shared path). These locations
are where iFIX will look for the security configuration at startup.
Figure 19-3. Setting Security File locations
Specify Security Areas
Security Areas are applied to two areas in iFIX: tags and pictures. On tags, they restrict
write access. Read access is granted regardless of area. For pictures they restrict any
access at all (read or write).
Security configurations can contain up to 254 unique Security Areas. These are generally
created for equipment and plant areas, as well as for personnel responsibility or role levels.
Figure 19-4. Security Area Addition
GFS-154K
Education Services
19-5
Proficy iFIX Fundamentals - Security
Create Security Groups and Privileges
A Group account assigns access to the most commonly used privileges that two or more
users can share. When a User account is created, the User may be assigned to one or more
groups. Users inherit access to all the application features and security areas defined for
the group.
To create a group account
for…
Assign…
Database Designers
Database Manager, Database Reload, Database
Save, and Database Add/Delete application
features
Operator Display Designers
WorkSpace Configure, WorkSpace, Exit from Run
mode, Operator Task Switching, Database
Manager, Database Save, Database Reload, and
Database Add/Delete application features
Supervisors
WorkSpace, Exit from Run mode, Operator Task
Switching application features
Table 19-1: Group Profile Examples
Figure 19-5. Assigning Privileges and Areas to Security Groups
Configuration Hub Groups
Groups which are created in this Group Accounts window can also be added to Proficy
Authentication. The Add Groups button on the right will create the highlighted groups as a
Proficy Authentication Group. This is particularly important to allow users the ability to
perform such tasks as adding and publishing tags in Configuration Hub. The Groups
APPLICATION_DESIGNER and IFIX_PROFICY_AUTH_ADMIN are automatically created and
shared with Proficy Authentication during install of iFIX.
We will only scratch the surface on iFIX and Proficy Authentication in this class. Look out for
Online Training modules which will delve deeper into this subject.
19-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Define and Assign local iFIX Users
A User account defines the privileges assigned to one person.
A Security Administrator identifies each user account with a login name and a password.
Full name, Login Name, and Password must be defined.
Though privileges are best assigned with Group accounts, if a User needs additional
privileges, the specific Application Features and Security Areas can be added to that User
account.
Limit the length of time an operator remains logged in by entering a login timeout interval in
a user profile. This is NOT inactivity, but from the moment of logging in.
Figure 19-6: Building a local iFIX User Profile
GFS-154K
Education Services
19-7
Proficy iFIX Fundamentals - Security
Define and Assign Windows iFIX Users
If using Windows Security, the Password is controlled by either the local Windows system or
at a Domain level. Neither Login Name or Password is required at this stage, however the
Domain field must contain the Domain name used, or if local Windows security it can be left
blank.
A Windows account for use with iFIX must first exist, then after enabling the Use Windows
Security checkbox, User name is entered, identical to the Windows account to be used.
Security Group Membership, Areas and Application Features assignments are made in the
exact same way as a local iFIX user. In essence it is only the password policies which are
different.
Figure 19-7: Building a Windows based User Profile
19-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Auto Login
This panel assigns the User who automatically logs in when the iFIX node starts up. Only
local nodes should be configured if a shared security configuration is not being used.
However, if the security files are shared, every node using the files should be included.
The Auto Login user could be a local iFIX or Windows User.
Figure 19-8. Auto-Assign account configuration
Note
The System User is only required if using the feature to Synchronize security with
Windows.
GFS-154K
Education Services
19-9
Proficy iFIX Fundamentals - Security
Assign Security Areas to Tags and Pictures
Security Areas are applied to two areas in iFIX: tags and pictures. On tags, only Users who
are members of the specified Security Area(s) can write to or modify the tag. Any User can
read from the tag regardless of Area. For pictures, they restrict any access at all (read or
write).
Tags have a maximum of three (3) Security Area fields.
In addition to this, Electronic Signatures can be applied. This must be added to the license
key to be operational.
Figure 19-9: Setting Security Areas on Tags in Configuration Hub (list of available Areas)
Figure 19-10: Setting Security Areas on Tags in Database Manager (no list of available Areas)
19-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Pictures have a Security Area property.
Figure 19-11: Setting Security Areas on Pictures
VBA and Security
Both Application Features and Security Area membership can be tested in VBA. When
developing a script that does not relate to either a Process Database tag or a whole picture,
it can be useful to check if the logged in user has permissions.
To check permissions for a specific iFIX Application, for example Database Manager, use:
Result = System.FixCheckApplicationAccess(DatabaseManager)
To check permissions to a specific Area, the Area number must be used, for example use:
Result = System.FixCheckAreaAccess(17)
In both cases Result will be 1 if granted, or 0 if denied.
GFS-154K
Education Services
19-11
Proficy iFIX Fundamentals - Security
Setting Environment Protection for the Workspace
Workspace User Preferences has a page dedicated to preventing access to Workspace
features in Runtime. Only an Administrator can over-ride these settings. This protection
provides security above and beyond the privileges that are set in the Security Configuration
Utility, and it is extended to Workspace-specific features.
Figure 19-12: User Preferences Environmental Protection
Warning
Some of the experts within iFIX, such as navigation, offer the developer with the
ability to present operators with a file / folder selection. This exposes the Windows
Explorer object. If a developer wishes to apply the utmost security to an iFIX
system, ensure none of these methods are used.
User Information
The iFIX System object deserves more attention than we can give in this course. The
System object is addressable in VBA, but it is also accessible in Workspace animations,
however it is not browsable.
The currently logged in user, whether local iFIX, Windows or Proficy Authentication based,
has their Full Name stored in a system value. This can be entered as the Source in a
Datalink to show who is currently logged in: System.LoginUserFullName.
Figure 19-13: Currently Logged in User
19-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Logging into Security
Operators can log into iFIX manually or automatically. By logging in, operators identify
themselves as iFIX users and gain access to the pictures, tags and applications they are
authorized to use.
Figure 19-14: Security Login, iFIX or Proficy Authentication
This login can be called via VBA using the command Login. A button or a key macro can
trigger a script using this command. The Login prompt can also be launched from the iFIX
program group however, it is unlikely that users will have access to the Windows task bar in
Run mode.
Enabling Security
If Configuration Hub is to be used during any development, security must first be enabled.
However, if all development will be carried out without the use of Configuration Hub,
enabling security can be left until much later in the development cycle. In the Security
Configuration Utility under Edit, Configuration is selected. The radio button is then set to
Enabled.
Save the security files and copy them to all nodes that require common security access
(unless the security path is shared).
Figure 19-15: Enabling Security
GFS-154K
Education Services
19-13
Proficy iFIX Fundamentals - Security
Proficy Authentication
Proficy Authentication, is based on the security standard of User Account and
Authentication (UAA). This provides identity-based security for Proficy based applications
and APIs, and supports open standards for authentication and authorization, including
Oauth2.
Several Proficy products use Proficy Authentication, including iFIX, Historian, Plant
Applications, and Operations Hub. Each of these products can optionally install Proficy
Authentication, however it is recommended that a single instance of Proficy Authentication
is installed on one networked system.
Shared Proficy Authentication means that if it is installed with one Proficy product,
additional Proficy products installed afterwards can share the existing, already configured
Proficy Authentication architecture.
One very useful feature of Proficy Authentication is its ability to use an external identity
provider. This includes identity providers such as the Lightweight Directory Access Protocol
(LDAP) or the Security Assertion Markup Language (SAML). In practice this allows an
already existing security system in a corporate environment, such as a Windows Domain, to
control Users and their permission assignments.
With iFIX, a local iFIX Group is given the iFIX Security Area and Application Feature
permissions in the iFIX Security Configuration Utility.
In turn, the iFIX Security Group is automatically synchronized with Proficy Authentication.
Any Proficy Authentication Users, including those from a LDAP or SAML sources (e.g.
corporate Windows Domain accounts) can be mapped into the iFIX Security Group in Proficy
Authentication and thus inherit the iFIX permissions.
When a new employee joins a company, part of their onboarding could be to have their
Domain Account created and assigned to specific Domain Groups.
If those specific Domain Groups are already mapped to the iFIX Security Groups in Proficy
Authentication, the new employee automatically is assigned the iFIX permissions.
Therefore, no further configuration is required in iFIX to allow this new employee to start
working with the Plant SCADA / HMI.
Obviously, this same User configuration simplification can be achieved with Proficy
Historian, Plant Applications and Operations Hub.
Figure 19-16: Proficy Authentication in Configuration Hub – iFIX Groups
19-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Troubleshooting Topic
Audit Trail
The security system creates a text file to log activity. This File is located in the Project’s
Alarms path (ALM directory). The naming convention for the file that is created is
YYMMDD.LOG. Many security related events are recorded in this audit trail. By reviewing
the audit trail, the following can be learned:
 Who logged in and out
 When an operator failed to complete the login process
 When someone attempted to access a security area or application feature for which they
had no privilege
 When a user exceeded the length of time they can remain logged in
All Alarm Services except the Summary Service also record Security Audit information within
Operator messages.
The iFIX Advanced class looks at storing Alarms in a relational database (Microsoft SQL
Server), and in conjunction with the iFIX tool VisiconX, shows how easy it is to retrieve these
alarms into a display and filter by this message type.
Figure 19-17: Security Audit Trail, viewed and Searched in Notepad++
GFS-154K
Education Services
19-15
Proficy iFIX Fundamentals - Security
eBooks Topic
The iFIX System object can be used in both VBA and Animations.
Search the online Help for the System object. For example, start by
System.LoginUserFullName as discussed in this chapter, and look through the other linked
topics.
Figure 19-18: Online Help – System Object
19-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Lab Exercises – Security
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Add Security Areas, Groups and Users to iFIX Security and configure Auto Login
 Modify Tags and Pictures to apply Security and enable Environment Protection
 Use Security and check the Audit Trail
Introduction
You now need to secure our course system. Specifically, you need to secure control of the
Packaging area, and the restrict access to the System tools. You will give Security Area
rights to different users to ensure basic operators can view these production areas but are
prevented from controlling processes. Operators will be excluded from access the System
Info picture. You will also create Groups and then assign Users to access the areas.
You will modify the Auto Logon feature.
Lab Exercise #1 – Security Configuration Utility
Part A – Configure Security Areas
1. Open Workspace and switch to Configure mode.
2. From the Applications Ribbon, under Security, click Security Configuration Utility.
3. A warning regarding the default iFIX local accounts of Guest and Admin will appear.
Click OK at this prompt.
GFS-154K
Education Services
19-17
Proficy iFIX Fundamentals - Security
4. When the Security Configuration Utility opens, either from the Edit menu choose Areas or
click the button with 4 keys icon.
5. In the Security Area Naming window, scroll down and highlight Area number 17.
Then click the Modify button and provide the name PRODUCTION.
6. Click OK to close the Edit Security Area window.
7. Repeat to add 3 more Areas, as shown above, the additional Security Areas are:
a. 18: ENERGY
b. 19: SYSTEM
c. 20: PACKAGING
8. Click OK to close the Security Area Naming window.
19-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Part B – Configure Security Groups
1. Still in the iFIX Security Configuration Utility, from the Edit menu select Group Accounts.
2. In the Group Accounts window, click the Add button to add a new Group. In the Group Profile
window, type in PRODUCTION as the Group Name.
3. Next, click the Modify button under Security Areas. Highlight PRODUCTION from the
Available list and click the Add button. This Security Area you configured is now Authorized in
this new Group. Click OK to close the Security Area Selection window.
4. Next, click the Modify button under Application Features. Highlight Alarm Shelving and
click the Add button. This first Application Feature is now Authorized in this new Group.
5. Scroll down (almost to the bottom) in the Available Application features list to select and
Add in turn:
a. System User Login
b. System User Logout
c. Workspace Runtime
9. Click OK to close the Application Feature Selection, then OK twice again to close the
Group Profile and Group Accounts.
GFS-154K
Education Services
19-19
Proficy iFIX Fundamentals - Security
Part C – Configure Security Users
1. Still in the iFIX Security Configuration Utility, from the Edit menu select User Accounts.
2. In the User Accounts window, click the Add button. In the User profile window, enter the
following:
a.
b.
c.
d.
Full Name: Bill Clay
Password: proficy
Login Name: BILL
Then click the Modify button under Group Membership
3. In the Group Membership Selection window, highlight PRODUCTION from the Available list
and click the Add button. Bill is now an Authorized member of the Production Group,
therefore will inherit all the permissions (Areas / Application Features) of the Group.
4. Click OK to close the Group Membership selection.
19-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
5. Notice that Bill already was automatically given the Application Feature of Workspace
Runtime. This is considered the minimum right. It could be removed from the User Profile as a
tidy up task as it has already been given to Bill when he was added to the Production Group.
Click OK to close the User Profile.
6. A Password Confirmation will appear. Type in proficy again then click OK.
7. In the User Accounts window click the Add button to add a second new profile. This will be a
high level administration user for yourself.
8. In the new User Profile window, enter the following:
a.
b.
c.
d.
Full Name: <your own full name> e.g. Al Powell
Login Name: <your initials> e.g. AP
Password: proficy
Click Modify under Security Areas. In the Security Area Selection window, click
the Add All button then click OK. All 254 Areas, named or not named, have been
added.
e. Click Modify under Application Features. In the Application Feature Selection
window, click the Add All button then click OK. All Application Features, except
eSignature Bypass, have been added.
9. Click OK to close the new User Profile. Again, re-enter the password proficy when prompted
in the Password Confirmation dialog, then click OK.
GFS-154K
Education Services
19-21
Proficy iFIX Fundamentals - Security
10. Highlight the Administrator User and click the Modify button.
11. Observe that this is a Windows user, the Use Windows Security checkbox is enabled.
Note there are no password or login name fields.
12. Click the Modify button under Security Areas.
13. Click the Add All button, ensuring that the newly named Areas are listed in the Authorized
window.
14. Lastly, click OK 3 times to Security Area Selection, User Profile, and the User Accounts
window.
19-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Part D – Configure Auto Login and Security Paths
1. Still in the iFIX Security Configuration Utility, from the Edit menu select AutoLogin.
2. In the Automatic Login at Startup window, observe that your local SCADA node of SCADA#
(e.g. SCADA1) is already added. This was required in order for Configuration Hub to be used
without your intervention early in this class. The Add button would start the configuration of a
new Auto Login node.
However here, click the Modify button.
3. In the Automatic Login Node window, click the Application User ellipses button to open the
Select User window.
4. In the Select User window highlight BILL CLAY, our low level user, and click OK.
Click OK again in the Automatic Login Node window, and OK again to close the Automatic
Login at Startup window.
5. Lastly, from the File Menu click Save. Ctrl-S will do the same.
Note the Export and Import functions here. A local iFIX Security Configuration can be done in
a simple text file using Notepad or Notepad++ then Imported. Passwords are usually blank, so
no text file exists with passwords in plain text, however for iFIX local users, passwords can be
added to the file and imported.
GFS-154K
Education Services
19-23
Proficy iFIX Fundamentals - Security
6. Now from the Edit menu choose Configuration.
7. Simply observe that iFIX Security is already Enabled.
On a fresh install of iFIX this is Disabled.
8. Observe also the Security Path and the Backup Path.
The default location is the Project \LOCAL Path.
However, on a networked system with many iFIX
nodes, it is common to have one master node,
probably a SCADA server, where the Security Path of
all other nodes is a mapped drive or UNC path to
that remote server, but the Backup Path is a local
drive. This allows a common security system of
Users, Groups, Auto Logon and allocated
permissions to be used by all nodes.
9. Click OK without making any changes in this Configuration window.
10. Lastly close the Security Configuration Utility. Click OK at the warning prompt regarding
default Guest and Admin accounts.
11. Back in Workspace, from the Applications Ribbon, under Security, click Security Login.
12. At the Login prompt, click the Logout button, then Log in as the new admin user you created
for yourself, e.g. AP (Al Powell), with the password proficy, then click the Login button. Click
OK at the success message.
19-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Lab Exercise #2 – Securing Pictures and Tags
Part A –Securing Pictures
1. Open Workspace and switch to Configure mode.
2. From the System Tree open the SystemInfo picture.
3. Right click on a blank area (no objects selected) of this SystemInfo picture and choose
Property Window.
4. Locate the Security Area property and set its value to SYSTEM.
The Security Area name is validated here, although this does not facilitate a browse to the list
of Security Areas, if a non-existent name is entered, it will be rejected.
5. Save and close this SystemInfo picture.
6. Next, from the System Tree, open the Footer picture.
7. Make sure that the System Tree is open and undocked. From the Home Ribbon under Show /
Hide enable the System Tree if disabled. Left click and drag the top of the System Tree to
undock.
8. From the Home Ribbon choose Full Screen in Configure mode. The Footer picture should
now be visible. If you added the optional navigation buttons earlier, it will look like this:
GFS-154K
Education Services
19-25
Proficy iFIX Fundamentals - Security
9. Locate on the System Tree the Dynamo set HP_Class. Double click to open it and drag into
the Footer picture the btnStartLine and btnStopLine buttons.
Starting and Stopping the Plant? Operators, low level users, should be restricted. These
buttons kick off the Startup and Shutdown of the Plant, but the underlying Process Database
Tags have a Security Area configured, only high level uses will be able to carry out these
tasks. You will test this later.
10. Now Save the Footer picture. Close both the Footer and HP_Class Dynamo set.
19-26
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Part B –Securing Tags
1. Still in Workspace Configure mode, from the System Tree, open the Packaging picture.
2. Switch to Full Screen in Configure mode (in the Home Ribbon).
3. Locate the Datalink for the Speed Setpoint. Double click the Datalink to open its
configuration dialog. Then click the Modify button which will take you to the tag template in
the Process Database.
4. In this Tags template, move to the Advanced tab and double click to edit the first Security
Area, type in here Packaging.
5. Click Save to save and close the tag. At the Place Block On/Off Scan prompt click Yes.
6. Click OK to close the Datalink configuration dialog.
7. Save and close the Packaging picture.
Note, adding a Security Area to a Tag configuration can also be achieved in Configuration
Hub using the Database Panel. A list of Security Areas is available when configuring this
field in the Details Panel of a selected tag.
GFS-154K
Education Services
19-27
Proficy iFIX Fundamentals - Security
Part C –User interaction
1. Still in Workspace Configure mode, from the System Tree, open the Header picture.
2. Click the top banner to highlight the grouped object, then right click and choose Enter Drill
Down. Then in Drill down highlight the user icon.
Alternatively, it is easier to select this same user icon, bmpUser from the System Tree.
3. From either the System Tree, or on the drilled into bmpUser icon, right click and choose Edit
Script.
4. In the Click procedure for this object, before the End Sub type in login.
5. Close the VB Editor. Alt-Q.
6. Next, from the Insert Ribbon under Objects/Links, add a Datalink Stamper. Configure
manually (cannot browse for System properties) the Data Source as
System.LoginUserFullName. Check the Raw Format box then click OK.
7. Place this Datalink to the left of the bmpUser icon. Modify color and font as you wish.
8. Save and close the Header picture.
19-28
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Part D –Environment Protection
1. Still in Workspace Configure mode, from the Home Ribbon, choose Settings then User
Preferences.
2. Choose Environment Protection from the list of pages on the left.
3. Firstly, check the Enable Runtime Environment Protection checkbox. Then enable all other
checkboxes as per the example below:
4. Click OK to close User Preferences then close Workspace.
GFS-154K
Education Services
19-29
Proficy iFIX Fundamentals - Security
19-30
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Lab Exercise #3 – Running a Secure HMI
Part A –Testing your secure HMI
1. From your desktop shortcut, open Workspace. It will of course open in Run mode.
2. In the Header, it should indicate that the user you created for yourself, e.g. Al Powell is
currently logged in.
3. Using the Navigation buttons in the Header picture, open in turn the Ingredients, then
Blending, then Granulation, then Packaging HMI pictures.
4. In Packaging, use one of the configured methods (there are several) to modify the Conveyor
Speed, e.g. click the Speed Setpoint text label, then drag the Slider control to a new value of
95 and click OK.
The speed successfully changes. Do set it to 95 in order to generate an Alarm.
5. On the Header bar, click the User icon, which you added the Login code to earlier. The Login
prompt appears. Click Logout first and OK at the prompt, then enter the User as BILL and the
Password proficy, then click the Login button, then OK at the prompt.
6. Observe that the User Name shown in the Header is now BILL CLAY.
GFS-154K
Education Services
19-31
Proficy iFIX Fundamentals - Security
7. Now attempt again to modify the Conveyor Speed. This time when you click OK to commit,
the new value is rejected. This tag you are writing to is in the Packaging Security Area,
however Bill only has access to the Production Security Area.
8. Click OK on the Error prompt, and then close the data entry method used. (X on a slider, OK
on a Ramp etc).
9. Next using either the Navigation buttons in the Header, or if you completed the optional
<Previous and Next> buttons, click through to the Energy, Analytics and Alarms pictures.
10. Acknowledge any active Alarms. Specifically Acknowledge the Packing Conveyor Speed.
Since again Bill has no rights to write to this tag, a security prompt appears:
11. Click OK to close this prompt, then try to click the Navigation button for the System picture.
12. Since Bill also has no rights to the System Security Area assigned to the SystemInfo picture, it
will not open. Click OK to close the Unauthorized Access prompt.
13. On your keyboard click Ctrl-L. This is a Global Key Macro you set up to run Login. Click the
Logout button first then Login as the user you created for yourself, e.g. Al Powell, AP as the
Login name and proficy as the password.
14. Open the System picture. You have rights to do this, so it opens.
15. Try Stopping and Starting the Production Line with the Stop Line / Start Line buttons in the
Footer.
16. Switch to Configure mode. You have rights to this.
17. Lastly, close Workspace.
19-32
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Part B –Security Auditing
1. Open up a Windows File Explorer and navigate to the folder:
C:\Program Files (x86)\Proficy\iFIX\ALM\.
2. Sort by Date Modified so the newest files are at the top.
3. Look for a text file in the format YYMMDD.LOG, e.g. 220401.LOG. These are the simple text
files containing only Security messages from the project.
4. Right click on the latest LOG file and choose Edit with Notepad++. Windows Notepad or any
text editor will suffice.
5. Observe in the file messages relating to logging in and out and the Security Violations.
This is a simple text file. Anyone with permissions in Windows to this folder will be able to
access, and potentially modify the text file older than today. Today’s file is locked. iFIX can
send the same Security messages in either the ODBC Alarm Service or the Proficy Historian
Alarm & Event Collector, to secure destinations which can be secured to comply with the
strictest security polices.
6. Close Notepad++ when done.
GFS-154K
Education Services
19-33
Proficy iFIX Fundamentals - Security
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1. Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2. Click the link which will open EDGE and this iFIX Fundamentals course.
3. In the Course Activities section locate and click the Module 19 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
19-34
Education Services
GFS-154K
Proficy iFIX Fundamentals - Security
Review Questions
1. What do Security Areas restrict?
2. How many Security Areas can there be in one Security configuration?
3. Why do networked nodes need to share security files?
4. Name two features that can be restricted in the Environmental Protection?
5. Name some of the Proficy suite applications which can utilize the common security
provider of Proficy Authentication?
Electronic Books Research
6. What does the Security Synchronizer do?
GFS-154K
Education Services
19-35
Proficy iFIX Fundamentals - Security
Review
Now that you have completed this module, you should be able to:
 Describe Layers of iFIX Security
 Understand Basic iFIX Security
 Secure Applications, Tags & Pictures
 Understand the concepts of Proficy Authentication (UAA)
19-36
Education Services
GFS-154K
0)
20
IFIX THIN CLIENT ACCESS
a
At the end of this module, you will be able to:
 Investigate Configuration Hub
 Investigate Webspace
 Investigate Web HMI
 Discuss Remote Desktop
100%
Proficy iFIX Fundamentals - iFIX Thin Client Access
20-2
Education Services
GFS-154K
Proficy iFIX Fundamentals - iFIX Thin Client Access
Process
Database
I/O
Communications
Asset
Models
HMI
Historical
Archiving
Proficy iFIX Thin Client interfaces
When iFIX is installed as either a SCADA or a Client node, there are many local Thick Client
applications installed, from Database Development tools such as Database Manager, to HMI
Applications such as Workspace. Many more applications which iFIX relies upon such as the
System and Security Configuration Utilities are also installed and currently only available as
Thick Client applications.
In order to provide greater flexibility, some of the interfaces iFIX relies upon are available as
Thin client applications. i.e. no iFIX software is required on the computer used for the task.
Some of these are Runtime interfaces, some are Development tools.
Available today as Thin Client interfaces are:
Configuration Hub
Used for the development of iFIX Models, the OPC UA Driver and the Process Database.
Proficy Webspace
Provides a Workspace Runtime interface. Although Runtime only, any natively supported
functionality such as VBA, ActiveX, .NET can all be utilized within the Webspace Client.
Operations Hub (Web HMI)
Operations Hub is a web-based portal for many Proficy Applications, be it iFIX, CIMPLICITY,
Historian, Plant Applications, or Batch.
With iFIX, HMI pictures saved in Workspace can be Published to Operations Hub.
An Operations Hub App exposes the HMI, typically using Mimic widget and an Asset Model
for navigation.
Write access can be provided to iFIX Tags.
Alarms can be viewed, filtered and Acknowledged.
Web HMI in Operations Hub is a responsive, HTML5 Client dashboard for iFIX.
Read the Online Help regarding how to publish iFIX pictures, and the iFIX picture supported
object types.
Remote Desktop Services (RDP) (formerly Terminal Services Client)
With an iFIX TS Client, full development of iFIX can be achieved but most commonly it is
used for Workspace Runtime access. Any development, any natively supported functionality
such as VBA, ActiveX, .NET can all be utilized within the TS Client.
GFS-154K
Education Services
20-3
Proficy iFIX Fundamentals - iFIX Thin Client Access
Configuration Hub
Configuration Hub has been utilized many times during this training class.
As discussed, it is able to configure the iFIX components:
 OPC UA Client Driver
 Asset Models
 The Process Database
Additionally, it can configure:
 Proficy Authentication
 Proficy Historian Systems, Collectors and Tags
Figure 20-1. Configuration Hub – OPC UA Client Driver
Figure 20-2. Configuration Hub – Asset Models
20-4
Education Services
GFS-154K
Proficy iFIX Fundamentals - iFIX Thin Client Access
Figure 20-3. Configuration Hub – Process Database
Figure 20-4. Configuration Hub – Proficy Authentication
GFS-154K
Education Services
20-5
Proficy iFIX Fundamentals - iFIX Thin Client Access
Figure 20-5. Configuration Hub – Historian Systems
Figure 20-6. Configuration Hub – Historian Collectors
20-6
Education Services
GFS-154K
Proficy iFIX Fundamentals - iFIX Thin Client Access
Figure 20-7. Configuration Hub – Historian Tags
GFS-154K
Education Services
20-7
Proficy iFIX Fundamentals - iFIX Thin Client Access
Webspace
Proficy Webspace is an easy-to-use, full-featured Web and mobile client that enables full
control and visualization over a company’s Intranet or secure Internet without the need to
change or alter anything within iFIX Workspace.
Webspace extends 100% of the iFIX system viewing and control abilities into a Web browser
or tablet. A “zeroinstall” HTML5 client allows access to the HMI from popular Web browsers
on Windows, Mac, and Linux computers, providing a full-featured client and delivering
comprehensive functionality over a browser.
With support for up to 70 simultaneous clients, Webspace enables new and existing
systems to be dynamically expanded. The solution enhances the user experience with the
ability to run multiple Webspace clients and view many systems from one point.
Webspace easily and quickly harnesses the power of the iFIX HMI on an iPad or Android
device with minimal engineering effort. A SCADA app is available on the iOS App Store and
the Android Play Store, allowing instant connection to runtime projects, leverage the same
full-featured capabilities of a standard client with full HMI functionality, including third-party
app support with no screen conversions required.
Proficy Webspace leverages SSL/TLS Encryption (up to 256-bit AES) to ensure the security
of the data that is transmitted over the network.
A summary of features are:
 Increase information sharing across teams with a full-featured, secure-by-design Web and
mobile client for iFIX
 Speed the right actions with model-based navigation and quick access to information over
the Internet, anywhere
 Save time with zero client configuration and the ability to port screens instantly
 Decrease costs with one server that renders iFIX displays on the choice of client, including
iOS, Android, and browser access
 Boost flexibility by dynamically adjusting control points on the- fly and viewing multiple
systems simultaneously
 Improve analytical and planning abilities with real-time data and information viewing
Once a Proficy Webspace server is installed and licensed on a network containing iFIX
SCADA Server(s), a local iFIX Client Project containing all the HMI components required for
HMI display is configured as the iFIX Webspace Client project. Many other properties of the
Webspace Server itself and Client sessions can be configured using the Webspace
Administration Console.
20-8
Education Services
GFS-154K
Proficy iFIX Fundamentals - iFIX Thin Client Access
Figure 20-8. Proficy Webspace Admin Console
Figure 20-9. Proficy Webspace iFIX Application Properties
GFS-154K
Education Services
20-9
Proficy iFIX Fundamentals - iFIX Thin Client Access
Operations Hub (Web HMI)
Proficy Operations Hub is a centralized environment to rapidly build industrial applications
(data connectivity, aggregation and visualization), enabling improved plant operations
through comprehensive information that’s easier to analyze and act upon independently of
location. With Proficy Operations Hub, teams across all levels in an organization can
increase operational efficiency and make better decisions based on real-time and historical
plant-wide application data, including Historian, MES, analytics, and third party. Users can
monitor, control, provide data entry, and perform analysis all through Proficy Operations
Hub.
For iFIX data sources, Operations Hub is the key to the provision of a Web HMI.
Designed for the connected worker by providing a web-based, Web HMI designer that
supports Asset Models, mobile devices and centralized updates. Web HMI is the Next Gen
web-based HMI for iFIX that complements traditional thick clients. It is an integrated native
HMI builder utilizing Mimic and Alarm widgets. The Mimic widget being a container for HMI
displays published from iFIX Workspace.
Figure 20-10. Proficy Operations Hub – Web HMI
Asset Model context can be used to control the data and alarms sources to a myriad of
display widgets.
OPC UA is the connectivity protocol used to communicate with the source iFIX SCADA
node.
iFIX Workspace pictures can be used as the original source for the Mimic Widget.
20-10
Education Services
GFS-154K
Proficy iFIX Fundamentals - iFIX Thin Client Access
Exporting a Picture from Workspace
iFIX Workspace can connect to an Operation Hub server to which the Mimics will be
published. Not all object types in a traditional iFIX Picture are able to be published. Check
the Online Help for supported components.
In practice, the picture is analyzed, and supported objects, colors, threshold table settings
and importantly data sources are exported to a JSON file. This can be manually copied to
the Operations Hub, however it is quicker to perform a Publish instead where by the JSON
is automatically imported into Operations Hub to create a Mimic for the Web HMI.
In User Preferences a secure connection between the local iFIX node and the Operations
Hub server is configured. This is required for Publishing to Operations Hub and can be
secured by the Trusted SSL Certificate issued by the Operations Hub server.
Figure 20-11. Workspace User Preferences – Operations Hub Configuration
A Publish Picture tool is found in the Tools Ribbon.
Figure 20-12. Publish Picture
GFS-154K
Education Services
20-11
Proficy iFIX Fundamentals - iFIX Thin Client Access
The Publish to Operations Hub dialog allows selection of pictures to be Published, the
location and settings for the Export files if needed.
Figure 20-13. Publish Picture - Selection
The connection is then validated, and a password required to allow the Publish and
potential overwrite if the exported picture already exists.
Figure 20-14. Publish Picture confirmation and security
20-12
Education Services
GFS-154K
Proficy iFIX Fundamentals - iFIX Thin Client Access
Remote Desktop
TS Clients for iFIX provide a thin-client solution for HMI applications (same usage as any
thick Client node). Remote Desktop Service (formerly known as Terminal Services) allows
deployment to multiple users from a single server. Each user launches and runs sessions
using Remote Desktop Server Clients (Windows = TSAC, Citrix = ICA). They have no iFIX
software installed of the local machine as they interact with sessions running on a Remote
Desktop Server.
This has many benefits, the most obvious being a reduction in maintenance, patching and
hardware. It also provides a modicum of hardware and OS flexibility and in many cases
economy of scale for licensing (pooled licensing as opposed to individual licensing).
The standard features to help deploy for Remote Desktop Server clients in iFIX include:
 iFIX SCADA: iFIX SCADA can run on the Remote Desktop server machine
 iFIX Launch dialog box: (Launch.exe) that allows selection of an iFIX SCU file at startup or
predefine the SCU that launches for each Windows user
 Startup Profile Manager: configuration and management of iFIX SCU files for use with
Remote Desktop Services, which includes the ability to create a list of users and assign
Remote Desktop Services configurations to them based on roles
 Global Security Paths: enables all iFIX user sessions on a computer to share the same
security configuration. If using iFIX startup profiles created in the Startup Profile Manager,
this option should be enabled
The Remote Desktop Server must be licensed, either a Windows Remote Desktop Server or
Citrix. The number of concurrent remote sessions will be controlled by this license.
The iFIX License used must also support Remote Desktop sessions, again the number of
concurrent remote iFIX sessions will be controlled by this license.
Figure 20-15. Remote Desktop Services Role on Windows 2019 Server
GFS-154K
Education Services
20-13
Proficy iFIX Fundamentals - iFIX Thin Client Access
iFIX is then installed and licensed on the Remote Desktop Server computer.
An iFIX Project is configured which will run when a Remote Desktop user connects.
This could be one project that many users all individually start. 10, 20, or 30 + copies of the
same project could be running at once depending upon licenses (and physical resources).
Equally, there could be 10,20, or 30+ separate projects created and started by the Remote
Desktop users, however this is much more of a maintenance overhead.
The iFIX Startup Profile Manager assists in the task of associating a specific Windows user
with a specific Nodename and SCU to use. Think of it like the Launch application looked at
early in this course.
When the specific user starts an RDP session with the RDP Server, the Startup Profile
Manager already knows which nodename and SCU to start.
Figure 20-16. iFIX Startup Profile Manager & Adding a new Profile
20-14
Education Services
GFS-154K
Proficy iFIX Fundamentals - iFIX Thin Client Access
Troubleshooting Topic
Firewalls
When remotely connecting to any application, i.e. an application not running on the local
computer, the source, destination and path in between must be trusted.
The path in between, i.e. the network connections and the network itself, will likely be
configured to block any traffic that does not fit with the rules decided by the system
security administrator.
Typically, local computer and network Firewalls will be employed to block any traffic
deemed untrustworthy.
TCP or UDP Ports can be permitted or blocked on both local computer and network
Firewalls.
On the computer hosting the server application, e.g. a Webspace or Operations Hub server,
rules are usually automatically added permitting traffic on any or specific Ports for the
application, but since a network Firewall has no knowledge of the specific application, Port
rules will be required.
Therefore, when one of the Thin Client solutions discussed in this chapter is to be used,
Firewall rules to permit the traffic must exist.
Figure 20-17: Windows Firewall with Webspace Application Rules
Figure 20-18: Windows Firewall with Operations Hub Application Rules
Common Port which must be permitted are:
 Webspace: 491
 Operations Hub: 443
 Remote Desktop: 3389
Alternate Ports may however have been configured, therefore always check.
GFS-154K
Education Services
20-15
Proficy iFIX Fundamentals - iFIX Thin Client Access
eBooks Topic
Webspace, as well as Operations Hub are separate Proficy products, just like Historian.
Each have their own Online Help documentation.
The Proficy Webspace Online Help is accessed using the URL:
https://www.ge.com/digital/documentation/webspace
The shortcut already provided simply needs ifix replaced with webspace.
Search the Webspace Online Help for “Configuration Guidelines”. This will find the iFIX
Configuration topic. Read this topic when you have time.
Figure 20-19: Webspace Online Help – iFIX Configuration
20-16
Education Services
GFS-154K
Proficy iFIX Fundamentals - iFIX Thin Client Access
Lab Exercises – Thin Client Access
Lab Objectives
Upon successful completion of this lab exercise, the student will be able to:
 Investigate Configuration Hub access.
 Investigate Proficy Webspace access
 Investigate Operations Hub – Web HMI access
Introduction
In this lab exercise, you will revisit Configuration Hub as a reminder of the development
functionality it provides when working with iFIX. You will then access and view our courses
system through a Proficy Webspace session. Then you will access the Web HMI interface of
Operation Hub, navigating by Asset hierarchy, viewing Mimics, Alarms and controlling the
Ingredients processes.
Lab Exercise #1 – Investigate Configuration Hub
1.
On your student computer, ensure that iFIX is running.
2.
On the Windows Desktop locate and double click the Configuration Hub icon. Or if in
Workspace Configure mode, click Configuration Hub in the Applications Ribbon.
3.
Log in with the credential’s user: Administrator; password: as per the Administrator used
throughout this course, check the desktop PC Info file or ask your instructor.
4.
Observe and browse through the various panels:
5.
a. Proficy Authentication – Security: Identity providers; Groups; Users
b. SCADA#: Connections; Model; Database
c. Historian_host-#: Systems; Collectors; Tags
(Note Models in Historian AND Models in iFIX cannot coexist in Configuration Hub)
Close Configuration Hub when completed.
GFS-154K
Education Services
20-17
Proficy iFIX Fundamentals - iFIX Thin Client Access
20-18
Education Services
GFS-154K
Proficy iFIX Fundamentals - iFIX Thin Client Access
Lab Exercise #2 – Investigate a Webspace Session
1. On your student computer, open a Windows File Explorer and navigate to the folder:
C:\ClassFiles\20. Thin Client Access.
2. Double click on the Chrome shortcut Webspace Client.
3. At the Logon prompt, enter the following:
a. User name: Administrator
b. Password: < as per the Administrator used throughout this course, check the desktop
PC Info file or ask your instructor>
c. You can enable the Remember me on this computer checkbox. Your password will be
cached.
d. Then click the Sign In button
This is the Webspace session login.
4. Next you will be prompted to log in to iFIX. There is no concept of Auto Login on a
Webspace session, a user could be connecting from anywhere and therefore must enter
credentials. Again enter:
a. User name: Administrator
b. Password: < as per the Administrator used throughout this course, check the desktop
PC Info file or ask your instructor>
c. Then click the Logon button
When logging in to iFIX when using a Webspace session, only Windows Users will be
granted access, no iFIX local users can sign in.
5. The familiar layout of the iFIX Fundamentals course HMI will open.
Navigate around as you would normally. This is being viewed inside a Chrome browser, no
iFIX Software is required locally to use this Webspace client.
Start and Stop processes, change setpoints as you did before on your own Student
computer.
The SCADA source in this case is the Instructor’s computer – SCADA20.
6. Close the browser containing Webspace when done.
GFS-154K
Education Services
20-19
Proficy iFIX Fundamentals - iFIX Thin Client Access
20-20
Education Services
GFS-154K
Proficy iFIX Fundamentals - iFIX Thin Client Access
Lab Exercise #3 – Investigate Operations Hub - Web HMI
Part A WebHMI
1.
On your student computer, open a Windows File Explorer and navigate to the folder:
C:\ClassFiles\20. Thin Client Access.
2.
Double click on the Chrome shortcut WebHMI.
3.
At the Logon prompt, enter the following:
a. User name: Administrator
b. Password: < as per the Administrator used throughout this course, check the desktop
PC Info file or ask your instructor>
c. Then click the Sign In button
Web HMI will open showing a simple Ingredients Display with a Mimic widget using an
exported version of your re-usable IngredientTank picture. Gauges show the Inlet and
Outlet Rates and the selected tank level, and an Alarm Card presenting Alarms and
facilitating acknowledgments and filtering.
This is an Asset Context display.
4.
Observe in the top left what is called the Breadcrumb widget. This allows a drill down through
the configured Asset Model. Remember in your iFIX system the ProficyPharma – Ingredients –
Ingredients Tank model. The exact same model is used here.
5.
Click on the Breadcrumb icon.
GFS-154K
Education Services
20-21
Proficy iFIX Fundamentals - iFIX Thin Client Access
6.
Expand through the Breadcrumb to select one of the specific Ingredient Tank Assets, such as
Cellulose_E460.
When expanding the Breadcrumb, it does not actually expand to the right as in this screenshot
below, these child Objects appear in the same left hand column.
The display will now update to populate all the objects and alarms from only this specific
asset. There may be no alarms.
7.
Click into the OutletRate data value, this will allow writing a new setpoint. Type in 25 then click
Enter on the keyboard.
8.
Since this is writing to a remote SCADA value, iFIX user credentials are required. Enter
Administrator as the User and the usual Administrator password, then click the Submit button.
20-22
Education Services
GFS-154K
Proficy iFIX Fundamentals - iFIX Thin Client Access
9.
A Success banner will briefly appear. Confirm that the new value has been written.
Note, all students may have written to the same tag at the same time, last person wins!
10. Browse through the different Assets using the Breadcrumb widget to find an Asset with active
alarms. Highlight one of the alarms and click the Acknowledged Selected button.
Observe the Acknowledged status and icons.
Also afterwards, click the Filter icon. Here you can remove the auto Filtered by Asset to show all
alarms. Change the slider button from Context to All, then click Apply, and close the Filter
pane.
This might be useful if you cannot find any active alarms. Remember all students in the class are
using the same Instructor’s SCADA20 node, last person wins.
11. Close the browser when done.
GFS-154K
Education Services
20-23
Proficy iFIX Fundamentals - iFIX Thin Client Access
Part B Historian Analysis
1.
On your local Computer open a Windows File Explorer and navigate to the folder:
C:\ClassFiles\20. Thin Client Access.
2.
Double click the shortcut Trends.
3.
At the Logon prompt, enter the following:
a. User name: Administrator
b. Password: < as per the Administrator used throughout this course, check the desktop
PC Info file or ask your instructor>
c. Then click the Sign In button
4.
Again, this Historical Trend uses the Breadcrumb widget for Asset context navigation. Use the
Breadcrumb to select a specific Ingredient Tank Asset, e.g. Cellulose_E460.
5.
Spend a little time trying out the tools in this Analysis App.
6.
Close the browser when completed.
This is actually a different Operations Hub App. It is the Historical Analysis App, a feature
rich Trending tool allowing selection from both Asset models and tag sources from Proficy
Historian.
We only scratched the surface with Operations Hub on this course.
GE Digital Education Services offers several Online Training modules on Operations Hub as
well as an Instructor led class.
20-24
Education Services
GFS-154K
Proficy iFIX Fundamentals - iFIX Thin Client Access
(Optional) OLT Integrated Learning Lab
If you have completed all other labs in this chapter, and there is time in class, this Lab
Exercise will allow you to access an Online Training (OLT) ‘How To’ video based module.
1.
Return to your own local computer and locate the email received from GE Digital Education
Services containing the link to your course registration page.
2.
Click the link which will open EDGE and this iFIX Fundamentals course.
3.
In the Course Activities section locate and click the Module 20 How To. This will open a new
browser tab and run the How To video.
End of Lab Exercises
GFS-154K
Education Services
20-25
Proficy iFIX Fundamentals - iFIX Thin Client Access
Review Questions
1.
Name some of the Thin Client tools available for use with iFIX?
2.
Which iFIX components are exposed in Configuration Hub?
3.
Is it possible to modify a picture if using Webspace?
Is it possible to modify a picture if using iFIX with Remote Desktop Services?
4.
In your own words, what does the Publishing Tool achieve in iFIX Workspace?
5.
How are Web HMI displays navigated when using Asset context?
Electronic Books Research
6.
Search the eBooks for “Operations Hub Element Support” to learn about Supported iFIX Picture
components.
20-26
Education Services
GFS-154K
Proficy iFIX Fundamentals - iFIX Thin Client Access
Review
Now that you have completed this module, you should be able to:
 Investigate Config Hub
 Investigate Webspace
 Investigate WebHMI
 Discuss Remote Desktop
GFS-154K
Education Services
20-27
Proficy iFIX Fundamentals - iFIX Thin Client Access
20-28
Education Services
GFS-154K
PROFICY ® SOFTWARE
iFIX FUNDAMENTALS
STUDENT
MANUAL
GFS-154K
This training manual is designed to help you:
· Configure and launch iFIX projects.
· Define basic configurations with the SCU.
· Build and troubleshoot I/O driver configurations.
· Add, delete and modify tags using both thick and thin client tools.
· Create graphics, animations and control within the workspace
· Write and configure scripts with VBA in the Workspace Visual Basic Editor VBE .
· Understand and implement global objects.
· Create and maintain display navigation schemes including reusable displays.
· Manage and display process alarms and events.
· Archive and trend historical data.
· Deploy a system-wide security scheme.
About GE Vernova
Building on over 130 years of experience and proven innovation, GE Vernova brings together and harnesses the collective power
of GE’s portfolio of energy businesses including Power, Wind, and Electrification to focus on electrifying the world while simultaneously working to decarbonize it. With focus, GE Vernova is accelerating the path to more reliable, affordable, and sustainable
energy, while helping our customers power economies and deliver the electricity that is vital to health, safety, security, and improved quality of life.
© 2024 GE Vernova and/or its affiliates. All rights reserved.
Download