Proficy HMI/SCADA - iFIX: OPC A + E S
Proficy HMI/SCADA - iFIX: OPC A + E S
Version 5.0
August 2008
All rights reserved. No part of this publication may be reproduced in any form or by any electronic or mechanical
means, including photocopying and recording, without permission in writing from GE Fanuc Intelligent Platforms, Inc.
Notice
©2008 GE Fanuc Intelligent Platforms, Inc. All rights reserved. *Trademark of GE Fanuc Intelligent Platforms, Inc.
Microsoft® is a registered trademark of Microsoft Corporation, in the United States and/or other countries.
All other brands or names are property of their respective holders.
We want to hear from you. If you have comments, questions, or suggestions about our documentation, send them to the
following email address:
[email protected]
Table of Contents
About This Guide ..............................................................................................................................1
Getting Started: OPC A&E Server ....................................................................................................3
Features of the OPC A&E Server .................................................................................................3
Unsupported Features ..............................................................................................................4
Setting up the OPC A&E Server ...................................................................................................4
Notes ........................................................................................................................................4
Running the OPC A&E Server with Other Proficy Products .........................................................5
Local Node Setup .....................................................................................................................5
Concentrator Node Setup .........................................................................................................6
OPC Overview ..............................................................................................................................7
How OPC Works.......................................................................................................................8
iFIX Message Mappings ...............................................................................................................9
Standard OPC Alarm Event Parameters for iFIX Alarm States .............................................10
Attributes Passed to the OPC A&E Client ..............................................................................11
Alarm Differences .......................................................................................................................15
Between FIX32 and iFIX .........................................................................................................15
Between the Server and the iFIX Alarm History or ALMODBC Utility ....................................16
Between Alarm Acknowledgements in iFIX and the OPC A&E Server ..................................16
Between Alarm States in iFIX and the OPC A&E Server .......................................................16
Proficy Alarm Viewer ..................................................................................................................17
Acknowledging Alarms with Electronic Signatures in the Client ............................................17
OPC Server Configuration ..............................................................................................................21
Understanding the Configure iFIX OPC A&E Server Dialog Box ...............................................21
Description of Configuration Fields.........................................................................................22
Running the OPC A&E Server When You Start iFIX..................................................................26
Synchronizing Network Clocks ...................................................................................................27
Connecting and Disconnecting from the Server .........................................................................27
Running Multiple Clients .............................................................................................................28
Browsing Sources and Areas .....................................................................................................28
Sources ...................................................................................................................................28
Areas ......................................................................................................................................29
Viewing Proficy iFIX OPC A&E Server Statistics .......................................................................29
Descriptions of iFIX OPC A&E Server Statistics ....................................................................29
Sample Period vs. the Refresh Rate ......................................................................................30
iii
OPC A+E Server
iv
About This Guide
This help system describe the OPC Alarms and Events (A&E) Server for the Proficy™ HMI/SCADA -
iFIX® product. The help includes the following sections:
• Getting Started: OPC A&E Server
• OPC Server Configuration
• How Do I...
• Advanced Features
• Troubleshooting
1
Getting Started: OPC A&E Server
The Proficy iFIX OPC Alarms and Events (A&E) Server reads alarm events and messages from a set
of iFIX SCADA servers and sends them to interested clients. External OPC A&E clients, such as the
Proficy Historian OPC A&E Collector, can connect to this server to acquire and analyze alarm data for
any of those SCADA nodes.
The Proficy iFIX OPC A&E Server converts all iFIX alarms and events (including 21 CFR 11
messages) to meet the OPC A&E standard. In addition to all iFIX alarms and events, the OPC A&E
Server generates messages in the following scenarios:
• Alarm Acknowledgements – In addition to the operator Tracking message, the iFIX OPC
A&E Server generates a Condition event about the Acknowledgement for this operator
message.
• Change of State (COS) Alarm – For every COS alarm, the iFIX OPC A&E Server
immediately generates an "OK" message.
• Bad Quality Notifications – When an open alarm is no longer found, the iFIX OPC A&E
Server generates a message indicating that an unknown event occurred.
The reason the Proficy iFIX OPC A&E Server does this is so that the alarm life cycle can properly
represented in the Historian Archiver, for instance. If you compare the events logged in the Alarm
ODBC (ALMODBC.exe) with the ones from the iFIX OPC A&E Server, you will obtain more
messages from the iFIX OPC A&E Server than found in the Alarm ODBC.
Refer to the following sections for additional information:
• For a list of supported and unsupported features for the Proficy iFIX OPC A&E Server, refer
to the Features of the OPC A&E Server section.
• For more information on how to setup the Proficy iFIX OPC A&E Server, refer to the Setting
up the OPC A&E Server section.
• For more information on how the Server works, refer to the Running the OPC A&E Server
with Other Proficy Products section.
• For more information on OPC in general, refer to the OPC Overview section.
• For details on the information retrieved for each alarm event, refer to the iFIX Message
Mappings section.
• For details on FIX32 and iFIX alarms or the Alarm History and ALMODBC utilities, refer to
the Alarm Differences section.
3
OPC A+E Server
Unsupported Features
The following features are not supported by the Proficy iFIX OPC A&E Server:
• Refresh capability for OPC A&E.
• DCOM support.
NOTE: The Proficy Historian OPC A&E Collector does not currently support DCOM either.
• Ability to display alarms from the OPC A&E Server in the Proficy iFIX WorkSpace.
• Migration of ALMODBC configuration.
• Running the OPC A&E Server as a service when iFIX is not running as a service.
4. Use the A&E OPC Client to view and analyze alarm data as desired.
Notes
The Proficy iFIX OPC A&E Server must be running as long as OPC A&E clients are accessing alarm
data. If you manually exit and close the server window, communications between the OPC A&E
Server and any connected clients will be lost.
OPC clients that connect to the Proficy iFIX OPC A&E Server must support the OPC A&E extension
of the OPC protocol.
A client receives event data starting only when it connects to the server, regardless of how long the
server has been generating alarms and events.
4
OPC A+E Server
5
OPC A+E Server
This setup ensures that all alarms and messages generated by the SCADA server are sent to Proficy
Historian in the event of a network failure between a SCADA node and View node. The Historian
OPC A&E Collector provides a store and forward feature, which means that even in the event of a
network failure between the SCADA node running the collector and the Historian Archive, all alarms
and messages will be sent to the Historian Archive.
6
OPC A+E Server
OPC Overview
OPC (OLE for Process Control) is a standard client/server protocol for the transfer of data and I/O
information between applications within a Windows® environment. OPC was developed by the not-
for-profit OPC Foundation, which makes specifications for OPC freely available.
OPC specifications are built upon Microsoft's OLE (Object Linking and Embedding) and DCOM
(Distributed Component Object Model) technologies. OPC is fully endorsed by Microsoft.
OPC was created to allow different automation applications to communicate with each other,
regardless of the manufacturer. This allows for greater flexibility and reliability when setting up
automation systems. The OPC A&E (Alarms and Events) protocol is an extension of the overall OPC
specifications, designed specifically for sharing alarm event information.
For manufacturers of OPC-compliant applications, it simplifies the development process, since they
only have to create one I/O interface. For consumers of OPC-compliant applications, it increases the
flexibility of their automation process—they're no longer limited to communicating with devices
specified by the applications' developers.
7
OPC A+E Server
Applications that use the OPC protocol implement a client/server relationship. You can think of OPC
Servers as being producers of information, and OPC Clients as being consumers:
• The OPC A&E Server has alarm and event data that it makes available to other computers as
OPC A&E data sources.
• The OPC A&E Client connects to the OPC A&E Server to gain access to its data.
The communication interfaces of an OPC server are made available to other programs by use of COM
(Component Object Model) and DCOM (Distributed Component Object Model) technology.
Essentially, this makes the existence of the OPC A&E Server known to other programs (that is, OPC
A&E Clients) that may want to connect to it on the network.
Since the OPC A&E Server and OPC A&E Client are simply programs or applications, they can run on
the same computer.
An OPC A&E Server running on the same computer as the OPC A&E Client is called a local server. A
server running on a different computer than the client is called a remote server. Since administrators
often set up security restrictions for communications between computers on a network, this distinction
can be important.
NOTE: Any clients that connect to the Proficy iFIX OPC A&E Server must specifically support the
OPC A&E protocol, not just the OPC protocol. With an ordinary OPC Client, you may be able to
connect to the Proficy iFIX OPC A&E Server, but any data you receive will be nearly useless.
While manufacturers of OPC-compliant applications use the same protocol to communicate data, how
OPC is configured within those applications can vary widely. Typically, in the client, you'll do the
following:
• Specify the address of the computer running the OPC A&E Server that you want to connect
to. Often, you can browse a network to find out what OPC A&E Servers are currently running
on each computer, much like browsing the Windows Network Neighborhood to find a
particular computer.
• If more than one OPC A&E Server is running on the same computer, you may have to select
the Proficy iFIX OPC A&E Server from a list or manually specify its name
(Proficy.OPCiFIXAE.1).
• Specify the alarm event data that you want the client to acquire. Typically, the configuration
utility for the OPC client will present you with a browse list or tree of OPC data sources. If
this is not available, you will have to manually specify the syntax for desired OPC data
8
OPC A+E Server
sources (refer to the Proficy iFIX OPC A&E Data Source Syntax section for details).
9
OPC A+E Server
10
OPC A+E Server
11
OPC A+E Server
The Simple attributes in the following table are included with all event types.
12
OPC A+E Server
Condition event types include the ones listed in the table below, in addition to the Simple event types.
13
OPC A+E Server
Alarm Ext Field1 - Alarm Vendor BSTR Alarm Ext Field1 - Alarm Ext
Ext Field2 (name can be Field2
changed by user)
User Field1 - User Field4 Vendor BSTR User Field1 - User Field4
(name can be changed by
user)
Tracking event types include the ones listed in the table below, in addition to the Simple event types.
14
OPC A+E Server
Alarm Differences
15
OPC A+E Server
returned to an "OK" state may not have always been sent by FIX. Therefore, the Proficy
Historian may not be able to properly represent the alarm life cycle (specifically, the time the
alarm was "closed") for these alarms.
Between the Server and the iFIX Alarm History or ALMODBC Utility
When using the re-alarming feature of AA or DA database blocks in iFIX, the OPC A&E Server may
not send all re-alarm notifications for those blocks to the client. When the block first enters the alarm
state, this initial alarm will always be sent. However, subsequent re-alarm notifications will only be
sent to the connected OPC A&E clients if the alarm has been acknowledged since the previous re-
alarm.
For example, if an AA or DA block generates the following sequence of events (as seen in the Alarm
History application):
(1) Hi, (2) Hi, (3) Hi, (4) Ack, (5) Hi, (6) Hi
The iFIX OPC A&E Server will only send these 3 messages:
(1) Hi, (4) Ack, (5) Hi
This differs both from what is seen in the Alarm History application and ALMODBC utility.
16
OPC A+E Server
life cycle appearing in the client applications that store information about the alarm's life cycle, such as
the Historian Archive.
You can use the Proficy Alarm Viewer client to display and manage data from the Proficy OPC A&E
Server. To insert Proficy Alarm Viewer into a WorkSpace picture, from the Insert menu, choose OLE
Object. The Insert Object dialog box appears. In the Object Type list, select ProficyAlarmViewer
Control and click OK to add the control to your picture. The following graphic shows an example of
the ActiveX control as it first appears in the iFIX WorkSpace.
You must configure a list of connections before the Alarm Viewer will display data. A connection
consists of an OPC Server address (including the address of the computer it runs on), the update rate of
its data, and a filter that determines the specific data that is acquired from the server. The Alarm
Viewer can be configured either online (connecting to OPC A&E Servers to determine the available
data) or off-line. For more information on configuring, refer to the Proficy Alarm Viewer online help.
To access the help, in the Alarm Viewer Properties dialog box, click the Help button.
IMPORTANT: When using the Alarm Viewer control in a picture, that picture should have picture
caching disabled. If you do not disable picture caching, when the picture comes out of cache, the
Alarm Viewer control does not reconnect to the A&E server even though it may appear to be
connected. To disable picture caching, in the WorkSpace configure mode, open the picture, right-click
the picture area, and select Picture... The Edit Picture dialog box appears. In the Cache area, select
the Disable Caching for this Picture check box, and click OK.
17
OPC A+E Server
click a block in the spreadsheet and select the Advanced tab to view the Unsigned Writes properties of
the tag. This field is only enabled if electronic signatures are configured for the block. By default,
unsigned writes are rejected in iFIX.
1. In the iFIX WorkSpace, open the picture to which you want to add the ActiveX control.
2. In Classic view, from the Insert menu, click OLE Object.
-Or-
In Ribbon view, on the Insert tab, in the Objects/Links group, click Objects/Links, and then
click OLE Object.
3. In the Object Type list, select ProficyAlarmViewer Control.
4. Click OK.
1. Double-click the Proficy Alarm Viewer control that you added to your picture.
2. Click the Help button to use the Proficy Alarm View Help to help you with the configuration.
TIP: If you filter alarms for a specific area, this by default excludes any alarms generated to
"ALL" areas. To also get the alarms generated to "ALL" areas, you need to add the specified
area and the ALL area to your area filter in the Proficy Alarm Viewer. To display the Filter
Properties dialog box, on the Connections tab, click Add, select the Enable Filter check box,
and then click Configure Filter. Select the Enable Area Filter check box and click Add. Add
your area, for example B, and then add the ALL area.
To acknowledge alarms with electronic signatures from a client, such as the Proficy
Alarm Viewer:
1. In Classic view, from the Proficy iFIX WorkSpace, click the Proficy iFIX Database Manager
button to launch the application.
-Or-
In Ribbon view, on the Applications tab, in the Process Database group, click Database
Manager.
2. Select Open Local Node, or the desired node, and click OK.
3. Double-click the block you want to change. The block properties dialog box appears.
TIP: If you do not know which tags have electronic signatures enabled, add the eSig Type
column to your spreadsheet and then sort by column to determine the blocks with electronic
signatures enabled. To add the Esig Type column to your spreadsheet, on the View menu, click
Properties. The Properties dialog box appears. Select Esig Type from the Available Columns
list and click Add to move it to the Display Columns list, and click OK.
18
OPC A+E Server
8. Restart iFIX.
19
OPC Server Configuration
When configuring the Proficy iFIX OPC A&E Server you should review these sections:
• Understanding the Configure iFIX OPC A&E Server Dialog Box
• Running the OPC A&E Server When You Start iFIX
• Synchronizing Network Clocks
• Connecting and Disconnecting from the Server
• Running Multiple Clients
• Browsing Sources and Areas
• Viewing Proficy iFIX OPC A&E Server Statistics
In the above illustration, User Field 1and Alarm Extension Fields 1 and 2 are selected. The default
attribute names of these iFIX fields are used: User Field1, Alm Ext Field1, and Alm Ext Field2,
respectively. The data source for User Field 1 is the A_CV field – the current value of the block
21
OPC A+E Server
displayed as text. The iFIX OPC A&E Server filters alarms for NODE1. The rest of the fields display
the default settings.
OPC Attributes
This table lists the attributes that the server can send to OPC A&E clients for the alarms and events it
handles. Select the check marks ( ) next to the attributes that you want to make available to the OPC
A&E client.
You can edit attribute names of User Fields and Alarm Extension Fields. Names of attributes that
appear in grey cannot be changed.
The table that follows describes the attributes passed to the collector.
Message Type The iFIX message type. For example: ALARM, OPERATOR,
ESIGNATURE, DELETE, and so on. Message types less than 11
characters in length use hard-coded trailing spaces to make up the
difference. For instance, the "ESIGNATURE " message type includes a
space at the end, and the "DELETE " message type includes five trailing
spaces. For more information on message types, refer to the Selecting
Specific Alarm and Message Fields section.
Alarm Priority Priority value before it is translated to a severity number. For example:
INFO, LOLO, LOW, MEDIUM, HIGH, HIHI, or CRITICAL.
Areas The iFIX alarm area to which the source belongs. iFIX provides 16 default
alarm areas, named A through P; however, you can rename the default
areas or add new ones. Each alarm area name is unique and can be up to 30
alphanumeric characters.
Node The node where this event occurred. This value is the logical node name.
Physical Node The physical node where this event occurred. This value is the local node
Name name.
22
OPC A+E Server
ApplicationVersion The version of the application responsible for this event. For example:
3.5.5717.0.
Message ID Globally Unique Identifier (GUID) that uniquely identifies the message.
This field does not contain a value for messages manufactured by the
server such as acknowledgements or bad data quality notifications.
Alarm Status The iFIX status, such as OK, LO, LOLO, and so on, before it is translated
to the sub-condition name.
EngUnitLabel The engineering unit label for the current value (CV).
Tag Description The tag's description field as entered in the process database.
User Field1–4 User-configurable field names. Spaces are allowed in this name.
NOTE: Only text data (the A_ fields) are supported as user-configurable
fields. Numeric data (the F_ fields) are not currently supported.
Alm Ext Field1–2 The text entered in the block's alarm extension field. Typically, the first
extension field contains the name of the picture that shows alarms from the
current block. Spaces are allowed in this name.
Operator Name When security is enabled, this field represents the name of the currently
logged in user.
NOTE: This value may be different than the Perform_Name value.
Operator Full When security is enabled, this field represents the full name of the
Name currently logged in user.
NOTE: This value may be different than the Perform_FullName value.
User Full Name The full name of the user associated with the event.
Operator Node The name of the SCADA node where the operator acknowledged the event.
Name
23
OPC A+E Server
Ack_By_FullName The full name of the user who acknowledged the alarm.
Perform_FullName The full name of the user who signed the first signature.
Verify_FullName The full name of the user who signed the second signature.
The Clear All button removes the check mark next to all items in the OPC Attributes list. The Restore
Defaults button clears all user entries and restores the check marks for the default attributes:
• SourceTag
• Message Type
• Node
• Alarm Status
• CV
• EngUnitLabel
If you select User Field 1, 2, 3, or 4 from the Attribute list, the fields become available in this group
box. Enter the iFIX data source tag name.
NOTE: Only text data (the A_ fields) are supported as user-configurable fields. Numeric data (the F_
fields) are not supported.
User Fields are implemented in the same manner as they are in the Alarm ODBC. If you configured
user fields in the Alarm ODBC, you need to configure them here as well. The values listed for the User
Fields are available in the iFIX ODBC Alarm Service Configuration dialog box. Access this dialog box
if you need to obtain User Field values for the iFIX OPC A&E Server configuration. Refer to the
"Configuring the Alarm ODBC Service" section in the iFIX Implementing Alarms and Messages
electronic book for more on how to access this dialog box.
24
OPC A+E Server
Advanced
The following table describes the fields in the Advanced group box.
Field Description
Priority Rank – By default, the INFO (Informational) priority alarms for iFIX tags map to an
INFO OPC severity number of 40.
This number is configurable. OPC Severity ranges from 1-1000, where 1000
is the most severe alarm or event.
The iFIX alarm priority tag that this field maps to is the
ALM_PRIORITY_INFO tag.
Priority Rank – By default, the LOLO (Low Low) priority alarms for iFIX tags map to an
LOLO OPC severity number of 80.
This number is configurable. OPC Severity ranges from 1-1000, where 1000
is the most severe alarm or event.
The iFIX alarm priority tag that this field maps to is the
ALM_PRIORITY_LOLO tag.
Priority Rank – By default, the LOW priority alarms for iFIX tags map to an OPC severity
LOW number of 150.
This number is configurable. OPC Severity ranges from 1-1000, where 1000
is the most severe alarm or event.
The iFIX alarm priority tag that this field maps to is the
ALM_PRIORITY_LOW tag.
Priority Rank – By default, the MEDIUM priority alarm for iFIX tags map to an OPC
MEDIUM severity number of 500.
This number is configurable. OPC Severity ranges from 1-1000, where 1000
is the most severe alarm or event.
The iFIX alarm priority tag that this field maps to is the
ALM_PRIORITY_MEDIUM tag.
Priority Rank – By default, the HIGH priority alarms for iFIX tags map to an OPC severity
HIGH number of 850.
This number is configurable. OPC Severity ranges from 1-1000, where 1000
is the most severe alarm or event.
The iFIX alarm priority tag that this field maps to is the
ALM_PRIORITY_HIGH tag.
Priority Rank – By default, the HIHI (High High) priority alarms for iFIX tags map to an
HIHI OPC severity number of 900.
25
OPC A+E Server
Field Description
This number is configurable. OPC Severity ranges from 1-1000, where 1000
is the most severe alarm or event.
The iFIX alarm priority tag that this field maps to is the
ALM_PRIORITY_HIHI tag.
Priority Rank – By default, the CRITICAL priority alarms for iFIX tags map to an OPC
CRITICAL severity number of 950.
This number is configurable. OPC Severity ranges from 1-1000, where 1000
is the most severe alarm or event.
The iFIX alarm priority tag that this field maps to is the
ALM_PRIORITY_CRITICAL tag.
Queue Size The maximum number of records that can be stored in the alarm queue.
You must restart iFIX for Queue Size changes to be applied. The iFIX
Queue design requires restart of iFIX if there is a change in queue size.
For tips on how to deal with issues with the alarm queue, refer to the
Troubleshooting section.
Only get alarms Select this option to filter the alarm by a the specified node name. Enter the
on node logical node name in the field next to this check box.
26
OPC A+E Server
NOTE: The path illustrated for the Proficy Historian OPC A&E Collector (ihIFIXAECollector.EXE)
in the above figure – that appears as the last item in the task list – is not the default path that the
collector installs to. Also, be aware that adding the Historian OPC A&E Collector to the SCU task list
is the preferred way to start this collector. The collector then starts automatically whenever you start
iFIX.
A percent sign (%) preceding a task means that Proficy iFIX Startup starts that task in the background.
To change the state of a task, select the task, select an option from the Start Up Mode group box, and
click Change. iFIX executes the tasks in the same order as they appear in the Configured Tasks list. To
remove a task from the list, select the task from the Configured Tasks list and click Delete.
After you add the Proficy iFIX OPC A&E Server to the task list, you must restart iFIX for your change
to take effect. For information on how to configure the SCU task list, refer to the Configure the Proficy
iFIX OPC A&E Server section.
27
OPC A+E Server
When shutting down the Proficy iFIX OPC A&E Server, the server behaves according to COM rules.
That is, whatever started the server must shut it down. So, if the client startup caused the server to start,
when the client shuts down, the server shuts down (as long as there are no other clients connected).
Under COM rules, a server should continue to run as long as there are connected clients. If the OPC
A&E Server started before the client started, however, the server will continue to run after the clients
disconnect.
The server delivers all the alarms and events generated from iFIX from the time the server starts up.
Therefore, the client receives alarms and events generated from the time it connects to the server. The
client has no knowledge of any events that occurred prior to its connection, including information
about alarms originating from iFIX database blocks during the startup.
To disconnect all connected clients from the Proficy iFIX OPC A&E Server, on the File menu, choose
Request Clients to Disconnect. For more information about disconnecting clients, refer to the
Disconnect All Clients section.
Sources
An OPC A&E client can request a list of sources from the server. The server returns a list of all
sources from which it currently obtains alarms. Each source name is in the "Node.Tag" format. The
node name appears as part of the tag name. Therefore, the user does not need to browse the node to
obtain the tag name. For an Alarm Source that is not associated with a specific tag (such as the SAC
Started or iFIX Shutdown event notification), the data source name is "iFIX."
NOTE: Only sources that went into an alarm state since the OPC A&E Server startup are available
when browsing.
As such, the list of returned sources may not match the actual list of sources. If the Proficy iFIX OPC
A&E Server processes the alarms for all nodes, such as when it acts as a concentrator node, then the
client can browse tags for all nodes.
28
OPC A+E Server
Areas
OPC A&E areas are represented by iFIX alarm areas. The client can request, from the iFIX OPC A&E
Server, a list of all the alarm areas that exist. The server responds to the browse request by retrieving a
list of alarm areas for each block which appears in the source browse.
For Proficy Historian, the source area(s) will be passed to the collector as a vendor attribute. Sending
an alarm for a source with multiple areas is valid, since the area is not part of the source name.
29
OPC A+E Server
Statistic Description
Sample Period The length of the sample period for the Num Events Last Sample Period
statistic, in milliseconds.
TIP: To change the Sample Period, on the Configure menu, choose Set
Refresh Rate. Enter the new value in the Alarm Refresh Rate field in seconds.
Num Event The number of OPC clients connected to this server. This is referred to as
Server Objects "Event Server Objects" because the iFIX OPC A&E Server instantiates a
separate event server object for each active client.
Num The number of active subscriptions to alarm and event data for all active
Subscriptions OPC clients.
Num Browser The number of OPC item browse sessions that are currently under way. Once
Objects they have connected to the iFIX OPC A&E Server, OPC clients that include
support browse capabilities can open a browsable list of available OPC items.
Users can then select which items to which they want to subscribe.
Num Events The total number of alarm events generated during this session. This includes
Generated events for all currently-active connections.
Num Client The total number of alarm event notifications that have been sent to OPC
Notifications clients.
NOTE: An alarm notification can contain data for multiple events. OPC
clients are notified of alarm events only if they have subscribed to the
relevant OPC items.
Num Events Last The number of alarm events generated during the last sample period. This
Sample Period includes events for all currently-active connections.
To access the Set Refresh Rate dialog box, on the Configure menu, choose Set Refresh Rate. The
Alarm Refresh Rate value sets how often the iFIX OPC A&E Server checks for new alarms. For
instance, say that you have your refresh rate set to 10 seconds. After the first 10 seconds, the Proficy
30
OPC A+E Server
iFIX OPC A&E Server finds 100 new alarms. It processes all of these alarms, and after processing
them the OPC A&E Server waits another 10 seconds to check again for new alarms.
The Data Refresh Rate sets how often the Proficy iFIX OPC A&E Server checks for an unexpected
deletion of an open alarm (such as HIHI, LO). In most cases, these events will not occur. Examples of
when unexpected deletions occur in open alarms include the following scenarios:
• A deleted tag
• Database reload
• An iFIX shutdown on a remote node
• Disabled alarming
• Remote node loses communication to iFIX (such as during a network failure)
• Tag placed off-scan
For example, if you delete a HIHI alarm from iFIX or reload the entire database, a bad data quality
notification occurs for each of the open alarms. The Data Refresh Rate determines how often the OPC
A&E Server checks for that notification.
31
How Do I...
This section outlines the steps perform the following tasks:
• Configure the Proficy iFIX OPC A&E Server
• Configure DCOM Settings in Windows XP, Windows Server 2003, and Windows Vista
• Filter Alarms and Events By Node Name
• Disconnect All Clients
Configuration Overview
After installing the Proficy iFIX OPC A&E Server, you need to configure it. To do so, run the
iFixOPCAESrv.exe file in your iFIX folder (C:\Program Files\GE Fanuc\Proficy iFIX, by default) and
enter the configuration information in the Configure iFIX OPC A&E Server dialog box.
If iFIX is already running as a service, do not run the iFIX OPC A&E Server by double-clicking the
iFixOPCAESrv.exe file. Instead, use the iFixOPCAESrv.exe -config command line to open the iFIX
OPC A&E Server and enter configuration information. Be aware that while iFIX is running as a
service, you must restart the iFIX OPC A&E Server for any configuration changes you make to take
effect.
To run the iFIX OPC A&E Server as a service, you need to run iFIX as a service. If iFIX is not already
configured as a service, enable the "Continue Running After Logoff" option in the Local Startup
Definition dialog box of the SCU. Before you can enable this option, you must exit iFIX. You can then
update the SCU task list by adding the Proficy iFIX OPC A&E Server. The next time you start iFIX, it
starts as a service along with the iFIX OPC A&E Server.
When running as a service, iFIX and the iFIX OPC A&E Server continue to run after you log off from
your Windows user account. For more information, refer to the Running iFIX as a Service section of
the Setting Up the Environment electronic book.
NOTE: When configured to run as a Windows' service, the OPC A&E Server appears as "Proficy iFIX
OPC Alarms and Events Server" in the list of services. iFIX appears as "Proficy HMI/SCADA iFIX
server" in the list of services. To view the Services window, from the Control Panel, point to
Administrative Tools, and then click Services.
To enter information in the Configure iFIX OPC A&E Server dialog box:
1. Start iFIX.
2. Open the Windows Explorer.
33
OPC A+E Server
3. Browse to the folder that contains the installed iFIX product. If you installed to the default
location, browse to the C:\Program Files\GE Fanuc\Proficy iFIX folder.
4. Double-click the iFixOPCAESrv.exe file. The Proficy iFIX OPC A&E Server appears.
NOTE: If iFIX is running as a service, the iFixOPCAESrv.exe file does not appear
automatically when you double-click it. Instead, on the Start menu, point to Run, and in the
Open field enter:
iFixOPCAESrv.exe -config
Click Run. The Proficy iFIX OPC A&E Server appears. Be aware that when iFIX is running as
a service, you must restart iFIX after entering your configuration changes.
5. On the Configure menu, click Configure Fields. The Configure iFIX OPC A&E Server dialog
box appears.
6. Enter the required information. For more information on these fields, refer to the Description
of Configuration Fields section.
7. Click OK to save the configuration.
IMPORTANT: You must restart iFIX for your changes, such as Queue Size, to be applied.
NOTE: In this configuration, no user interface displays. The iFIX OPC A&E Server
continues to run after you log off from your Windows user account.
34
OPC A+E Server
12. Restart iFIX to apply the configuration changes you made in the SCU task list. As iFIX
restarts it should start the Proficy iFIX OPC Alarms and Events Server as a service.
To verify that the Proficy iFIX OPC A&E Server is running after starting iFIX:
1. Start iFIX.
2. Press CTRL+ALT+DELETE and click the Task Manager button. The Windows Task Manager
appears.
3. Click the Processes tab.
4. Confirm that iFixOPCAESrv.exe appears in the list.
To verify that the Proficy iFIX OPC A&E Server is running as a service:
• Configuring the DCOM settings when the iFIX OPC A&E Server runs as a service
• Configuring the DCOM settings when the iFIX OPC A&E Server runs as a local server
To configure the DCOM settings when the iFIX OPC A&E Server runs as a service:
35
OPC A+E Server
To configure the DCOM settings when the iFIX OPC A&E Server runs as a local server:
1. Add the Proficy iFIX OPC A&E Server to the iFIX SCU task list, so that it runs with no
command line options:
a. In the SCU on the Configure menu, choose Tasks. The Task Configuration dialog
box appears.
b. In the Filename field, click the browse (...) button. The "Select file name to use..."
dialog box appears.
c. Browse to the Proficy iFIX installation folder. By default, this is C:\Program
Files\GE Fanuc\Proficy iFIX.
36
OPC A+E Server
4. Depending on the OPC A&E clients you use, you may also need to configure the OpcEnum
application in the same way that you configured the iFIX OPC Alarms and Events Server
application in the Distributed COM Configuration Properties dialog box.
IMPORTANT: If you want to always run the Proficy iFIX OPC A&E Server with the user
interface, you cannot run iFIX as a service.
1. Start the Proficy iFIX OPC A&E Server: double-click the iFixOPCAESrv.exe file in the iFIX
installation folder (by default, this is C:\Program Files\GE Fanuc\Proficy iFIX).
The Proficy iFIX OPC A&E Server dialog box appears.
2. On the Configure menu, click Configure fields. The Configure iFIX OPC A&E Server dialog
box appears.
3. Select the Only get alarms on node check box.
37
OPC A+E Server
4. Enter the logical node name in the field next to this check box.
TIP: For more information on this dialog box, refer to the Understanding the Configure iFIX
OPC A&E Server Dialog Box section.
5. Click OK.
6. Restart the Proficy iFIX OPC A&E Server.
1. Start the Proficy iFIX OPC A&E Server: double-click the iFixOPCAESrv.exe file in the iFIX
installation folder (by default, this is C:\Program Files\GE Fanuc\Proficy iFIX).
The Proficy iFIX OPC A&E Server dialog box appears.
38
Advanced Features
Advanced features of the Proficy iFIX OPC A&E Server are described in the following topics:
• Trace Logging OPC A&E Server Communications
• Proficy iFIX OPC A&E Data Source Syntax
• Failover Configuration Notes
The Proficy iFIX OPC A&E Server includes a built-in trace log feature to help diagnose issues with
your system. This feature logs communications with the OPC Server into a text file. Advanced users
can use this log file to trace a history of communication events dealt with by the OPC Server. The trace
log options are available from the Proficy iFIX OPC A&E Server's Trace menu.
The Trace Log file is a simple text file. To specify the name and location of the log file, on the Trace
menu, choose Set Trace File. By default, the trace file name is AETrace.txt, and it is saved to the My
Documents folder.
The information logged for each event includes:
• The date and time the event occurred.
• The type of event.
• Any parameters and attributes supplied with the event.
For an example of a trace log file, refer to the Example Trace Log File section.
39
OPC A+E Server
None Turns off logging for Connect, Server, Subscription, and Event items.
Connect Logs information on attempts by the Proficy iFIX OPC A&E Server to
connect or disconnect with the iFIX SCADA server target.
Subscription Logs attempts by external OPC clients to subscribe to data supplied by the
Proficy iFIX OPC A&E Server.
Event Logs information on alarm events read by the Proficy iFIX OPC A&E
Server from the iFIX targets it is connected with.
All Logs all types of events: Connect, Server, Subscription, and Event.
Enable COM Call Logs incoming and outgoing COM messages. This may be useful if an
Tracing administrator needs to diagnose COM or DCOM issues.
NOTE: Only one of Connect, Server, Subscription, and Event can be enabled at a time. If you want to
log information on more than one of those types of events, choose All.
Trace logging can be a CPU-intensive operation. It is recommended that you use trace logging only
when setting up your OPC Clients and Server or to diagnose communication problems, turning it off
when the system is functioning correctly.
40
OPC A+E Server
41
OPC A+E Server
42
Troubleshooting
The following are possible issues that can occur when processing alarms with the Proficy iFIX OPC
A&E Server:
• Alarm Queue Overflow
• Alarm Processing Rate Set Too Moderately
A possible indication that the Server is not processing all alarms is a discrepancy between the number
of events appearing in iFIX versus the number collected in the Historian archive.
If you experience problems starting the iFIX OPC A&E Server, it could be because you have more
than one instance of the iFIX OPC A&E Server running. In this case, the Server Starts in
Configuration Mode only.
This section provides tips for troubleshooting these issues and enhancing the performance of the
Proficy iFIX OPC A&E Server.
Issue
If the alarm queue for the iFIX OPC A&E Server overflows, the server could be dropping alarms
before it has a chance to process them. An iFIX error message may appear indicating that the queue
overflowed.
Possible Solution
Change the queue size. The queue size is the maximum number of records that can be stored in the
alarm queue. By increasing the queue size in the iFIX OPC A&E Server, you can prevent the alarm
loss.
43
OPC A+E Server
1. From the iFIX OPC A&E Server window, on the Configure menu, click Configure Fields.
The Configure Fields dialog box appears.
2. In the Queue Size field, enter a new value. This value can be any number from 1 to 32,767.
3. Restart the iFIX OPC A&E Server.
NOTE: Other iFIX applications, such as the Alarm ODBC service (ALMODBC.exe) require
the same queue size configuration. Refer to the "Configuring Alarms" section of the
Implementing Alarms and Messages electronic book for details on configuring the Alarm
ODBC Service and other alarm options.
Issue
If the iFIX OPC A&E Server does not send all events, the alarm processing rate may be set too
moderately. In this case, alarms appear to have dropped, but the alarm queue did not overflow. The
rate at which the iFIX OPC A&E Server processes alarms may not be fast enough.
Possible Solution
Tweak the server configuration to improve the throughput rate for alarm processing in the iFIX OPC
A&E Server.
1. From the iFIX OPC A&E Server window, on the Configure menu, click Set Refresh Rate.
The Set Refresh Rate dialog box appears.
2. Modify the values in these fields:
• Alarm Refresh Rate – the frequency (in seconds) that server looks for new alarms.
• Data Refresh Rate – the frequency (in seconds) that the server queries iFIX to send
bad data quality notifications.
Experiment with different values and see how they improve or hinder the alarm processing
rate.
For performance, set the Alarm Refresh Rate to 1 and the Data Refresh Rate to the highest
number that is acceptable for your application. For example, change the Alarm Refresh Rate
to 1 and the Data Refresh Rate to 500. The server will be able to process more new events at
once. This will be at the cost of delaying the time it takes to receive a bad quality notification
if a tag in the alarm is manual deleted.
44
OPC A+E Server
Issue
If a message appears when the iFIX OPC A&E Server starts, indicating that you are in configuration
mode, there is more than one instance of the OPC A&E Server running. Be aware that you are allowed
to run multiple server instances at one time, but only the first instance serves events to the clients.
Subsequent instances allow the configuration of the server from the user interface, but these instances
will not serve any events to clients.
If a message such as this appears and you did not intend to run in configuration mode, you may need to
perform one of the following tasks, and then restart the server:
• Reconfigure the SCU task list
• Apply additional settings for the Windows DCOM configuration if using multiple clients
• Shutdown iFIX or other applications
Possible Solution
Before deciding which task applies, you should verify the actual number of instances of the server that
are running. To verify the number of running instances, open the Windows Task Manager, click the
Processes tab, and count the number of iFIXOPCAESrv.exe processes that are running. If the
iFixOPCAESrv.exe appears more than once, the server is running more than one instance. The
solutions vary depending on the number of running instances of the server.
45
OPC A+E Server
preventing the server shutdown from occurring. One known application that will cause this behavior is
the iFIX ALMSTAT utility.
To verify that you can restart the server with its full functionality:
1. Shutdown the iFIX OPC A&E Server from the Windows Task Manager.
NOTE: If ALMSTAT is running in the Windows Task Manager, you must shut it down and
then restart it, since it is likely to be the offending application.
46
Index
A G
advanced features ............................................. 39 getting started, Proficy iFIX OPC A&E
Server............................................................. 3
alarm
I
differences (FIX32 and iFIX) ....................... 15
iFIX message mappings..................................... 9
processing rate .............................................. 44
L
queue overflow ............................................. 43
local node setup ................................................. 5
Alarm Viewer ................................................... 17
logged data....................................................... 39
areas, browsing ................................................. 28
M
attributes ........................................................... 11
message mappings, iFIX.................................... 9
B
multiple clients ................................................ 28
browsing sources and areas .............................. 28
N
C
node name filtering .......................................... 37
clients, disconnecting ....................................... 38
O
concentrator node setup ...................................... 6
OPC
configuration fields, described ......................... 22
overview ........................................................ 7
configuration mode, OPC A&E Server ............ 45
server configuration ..................................... 21
Configure iFIX OPC A&E Server dialog
box ................................................................ 21 OPC A&E Server............................................... 1
configuring, Proficy iFIX OPC A&E Server ....33 overflowed queue ............................................ 43
connecting and disconnecting ........................... 27 P
D passed attributes............................................... 11
data source syntax ............................................ 41 processing rate for alarms ................................ 44
DCOM configuration Proficy Alarm Viewer ..................................... 17
Windows XP and Windows Server 2003 .....35 Q
description queue overflow ................................................ 43
configuration fields ....................................... 22 R
server statistics ............................................. 29 running
disconnecting .................................................... 27 as a service ................................................... 26
F multiple clients ............................................ 28
failover ............................................................. 42 running, other Proficy products with the
OPC A&E Server........................................... 5
features ............................................................... 3
S
filtering by node name ...................................... 37
sample period vs. the refresh rate .................... 30
FIX32 ............................................................... 15
47
OPC A+E Server
48