Access Manager User's Guide: Foxboro Evo Process Automation System
Access Manager User's Guide: Foxboro Evo Process Automation System
Access Manager User's Guide: Foxboro Evo Process Automation System
*B0750AD* *S*
B0750AD
Rev S
August 29, 2018
All rights reserved. No part of this documentation shall be
reproduced, stored in a retrieval system, or transmitted by any means,
electronic, mechanical, photocopying, recording, or otherwise,
without the prior written permission of the Schneider Electric
Systems USA, Inc. No copyright or patent liability is assumed with
respect to the use of the information contained herein. Although
precautions have been taken in the preparation of this documentation,
the publisher and the author assume no responsibility for errors or
omissions. Neither is any liability assumed for damages resulting
from the use of the information contained herein.
The information in this documentation is subject to change without
notice and does not represent a commitment on the part of Schneider
Electric Systems USA, Inc. The software described in this
documentation is furnished under a license or nondisclosure
agreement. This software may be used or copied only in accordance
with the terms of these agreements.
Trademarks
Schneider Electric, ArchestrA, Invensys, Foxboro, Foxboro Evo, and
Wonderware are trademarks of Schneider Electric SE, its subsidiaries
and affiliates.
All other brand names may be trademarks of their respective owners.
iii
Contents
Contents..............................................................iii
Safety Information.............................................vii
Index ................................................................149
Important Information
Read these instructions carefully and look at the equipment to
become familiar with the device before trying to install, operate, ser-
vice, or maintain it. The following special messages may appear
throughout this manual or on the equipment to warn of potential
hazards or to call attention to information that clarifies or simplifies
a procedure.
DANGER
DANGER indicates a hazardous situation which, if not avoided, will
result in death or serious injury.
WARNING
WARNING indicates a hazardous situation which, if not avoided, could
result in death or serious injury.
CAUTION
CAUTION indicates a hazardous situation which, if not avoided, could
result in minor or moderate injury.
NOTICE
NOTICE is used to address practices not related to physical injury.
Please Note
Electrical equipment should be installed, operated, serviced, and main-
tained only by qualified personnel. No responsibility is assumed by
Schneider Electric for any consequences arising out of the use of this
material.
A qualified person is one who has skills and knowledge related to the con-
struction, installation, and operation of electrical equipment and has
received safety training to recognize and avoid the hazards involved.
ix
Access Manager
This book summarizes the functions, features, the ways and means of using the
Access Manager Suite of programs. The programs provide infrastructure
integration with Foxboro Evo™ system real-time data and messaging for real-
time data read-write access for process variables, historical data and process
system alarms. The Access Manager includes optional parameter-level security
and special components to use the Foxboro Evo services such as the Object
Manager (OM). The data flow diagram in Figure 0-1 identifies the Access
Manager Subsystems for Alarms, Data, History, and Security.
Revision Information
Revision S includes these changes:
Chapter 2, “I/A Series Device Integration Objects”
• Added a note to Table 2-2.
• Added a note to Table 2-7.
Workstation Types
The various types of workstations and their definitions that you need to know
are given in this table.
Term Definition
Foxboro Evo workstation Any workstation installed with a Foxboro Evo software component,
including Control Core Services, Control Software, Wonderware
Historian, I/A Series software, FCS or any combination thereof.
Control Core Services Any Foxboro Evo workstation installed with Control Core Services or
workstation I/A Series software. This workstation is connected to the Mesh
network.
non-Control Core Services Any Foxboro Evo workstation that does not have Control Core
workstation Services or I/A Series software installed. This type of workstation is
not connected to the Mesh network, but can have Control Software
installed on it.
Control Software Any Foxboro Evo workstation installed with Control Software
workstation components, including Control Editors, Control HMI, Wonderware
Historian, or other components installed as part of Control Software.
This workstation may or may not also be a Control Core Services
workstation.
Reference Documents
The Control Software reference documents, Foxboro Evo system documents
and Wonderware® software reference documents are given in these sections.
During the Control Software installation, generally the documents associated
with the software components being installed are also installed. These
documents can be viewed from the Start >All Programs >Foxboro Evo
>Control Software menu. These documents are also provided on the Control
Software’s installation media.
Additionally, updated user documentation can be found on the Global
Customer Support (GCS) website: https://pasupport.schneider-electric.com.
Wonderware Documentation
For additional information about InTouch® software, the Wonderware
Historian, and other ArchestrA® components, refer to these Wonderware
documents:
• Application Server Scripting Guide
• Application Server User's Guide
• Creating and Using ArchestrA Graphics
• Galaxy Database Manager User's Guide
• Historian Client User's Guide
• Historian Database Reference
• InTouch Alarm and Events Guide
• InTouch Application Management and Extension Guide
• InTouch ArchestrA Integration Guide
• InTouch Concepts and Capabilities Guide
• InTouch Data Management Guide
• InTouch Documentation Guide
• InTouch ITModernApp Guide
• InTouch HMI Documentation Addendum
• InTouch Protocol Guide
• InTouch Scripting and Logic Guide
• InTouch Smart Symbols Guide
• InTouch Supplementary Components User's Guide
• InTouch Visualization Guide
• InTouch XML Importer User Guide
• InTouchTagViewer
• Object Viewer User's Guide
• Platform Manager User's Guide
C H A P T E R 1
This chapter discusses the operation of the I/A Series Galaxy Browser, that
identifies the available compound and block parameters in a Galaxy database.
The browser is used to configure references to the control block parameters for
Foxboro Evo Control HMI (hereinafter to be referred as Control HMI)
displays, and for application objects being configured with the Control Editors.
The I/A Series Galaxy Browser appears as a tab in the Galaxy Browser
application. The tab identifies compounds, strategies, and blocks in a Galaxy
configuration. Other objects in the Galaxy database are displayed in the
Attribute Browser tab.
Contents
• Accessing the I/A Series Galaxy Browser
• I/A Series Browser Tab Components
• Browser Cache Files
Note The InTouch Documentation refers to the Galaxy Browser as the Tag
Browser.
Click here to
open the browser
4. Click beside the PV input source text box in the I/O group box to
invoke the Galaxy Browser (Figure 1-2) for the process variable input.
The browser opens the Attribute Browser tab, which is a standard IDE
tool for configuring application objects. This browser allows you to view
the exposed attributes of each tag and add references to the attributes and
to their properties. The Attribute Browser tab is not used to configure
points for the Control HMI.
block parameter, and optional extensions. These items are selected and
displayed in these I/A Series Browser tab (Figure 1-3) components:
1. The I/A Configuration pane is used to view the compounds, strategies,
and blocks in the Galaxy database.
2. The Parameter pane on the right displays the parameters of the block or
compound selected in the I/A Configuration pane.
3. The DI & Extensions view, which can be displayed below the parameter
pane (as in Figure 1-3) or minimized to its title, is used to select an
I/A Series Device Integration Object and scan group, and to specify
extensions to the parameter.
Note The DI drop-down box contains only instances of I/A Series Device
Integration Objects. As a result, you will be able to create tags only for
I/A Series Device Integration Objects.
If you want to refer to an I/A Series OPC Device Integration Object, then you
need to manually enter it in the Value field. This is used to support backward
compatibility.
4. The Value text box shows the tag that results from selections in the I/A
Configuration pane, Parameter pane, and DI & Extensions view.
When a compound or block is selected in the tree view, its parameters are
displayed in the Parameter pane to the right, that allows you to select the
parameter and construct the tag. No attributes are displayed on the right pane
when a strategy is selected, because strategies do not have attributes. Strategies
are container objects in the Control Editors that are not downloaded to the
control processor.
• Select or clear Display Strategies check box to show or hide strategies in
the Configuration view.
Search View
To find a specific item in the configuration:
1. Click in the I/A Configuration pane to open the Search view
(Figure 1-6).
The Search view consists of tools for specifying the search criteria and a
table listing the results from the latest search. The results can be saved
from one use of the I/A Series Galaxy Browser to the next.
Results
2. Use the three fields at the top of the view to specify the search criteria:
Field Description
Name Enter the name of the element to be found. Leave the field
blank to find the elements in the selected category. Use the
(wildcard) * and ? characters to specify names that contain the
specified string.
Element Use the drop-down list to select an object category:
• Block
• Compound including control, ECB, and station
compounds
• ECB for equipment control blocks
• SpecialBlock that includes primary FBMs (ECBPs) and
station blocks
• Strategy
• None
Type Use the pull-down list to select a type within the element
category. For example, when you select Blocks in Element,
select All or a specific block type such as PID or AIN.
Parameter Pane
When a block or compound is selected in the I/A Configuration pane, its
parameters are displayed in tabular form in the Parameter pane on the right
side of the browser (Figure 1-7). The object name and type are shown at the
top of the pane (AOUT_1 [AOUT] in Figure 1-7). The first available
parameter in the table is automatically selected and added to the tag string in
the Value text box (ACHNGE in Figure 1-7).
Name and
and type
Selected
parameter Click here to
is added hide the DI &
to the value Extensions view
string
Column Description
Name The block parameter name. The name may vary from the
name used in various Control Editors.
Data Type Parameter data type can be any one of these:
• All
• Bool (Boolean)
• Character
• Integer
• Long Int (Long Integer)
• Packed Long (Long Packed Boolean)
• Packed Bool (Short Packed Boolean)
• Short Int (Short Integer)
• String
• Real
Security Access permission needed for a user to set the parameter
in the run-time system. This permission is configured in
the Control Editors using ArchestrA security levels. See
“I/A Series Security Provider” on page 139 for additional
information concerning the access permissions.
Connectable Type of block connection that can be made to the
parameter in the Control Editors or other configuration
editors:
• Source can be read by another parameter
• SourceAndSink can be read from and written to
• DataConnectionSourceAndSink is connection
made in the configurator to copy scaling parameters
from a source block.
• None
Configurable States whether the parameter can be changed in the
Control Editors or other configuration editors:
• Once (when the block or compound is created)
• Always
• Never
Settable States whether the parameter can be set by a user with the
appropriate security access permission; either Always or
Never
Parameter
list filters
Click this
Click the button to open
header to the Columns
sort rows by Settings dialog
the column box
Click here to
display the DI &
Extensions view
4. Use the Category and Type drop-down lists below the object name to
filter the parameter display.
In Figure 1-9 for example, Connectable has been selected in Category
and SourceAndSink in Type to display only parameters that allow read-
write access.
5. Click to the right of the Category and Type drop-down lists to open
the Column Settings dialog box (Figure 1-9), clear the check boxes against
the columns you do not want to display, and click OK.
When using the browser for Control HMI or InTouch software displays:
1. Use the DI down-down list to select InTouch Default.
2. Leave the ScanGroup set to default.
These selections specify IADAS as the first element in the value string
(Figure 1-10).
When using the browser in the Control Editors:
1. Use the drop-down list to select an I/A Series Device Integration Object
(AWKE03_IADI in Figure 1-11).
2. Select a ScanGroup or leave the box set to default.
Figure 1-11 shows the selection of a I/A Series DI Object and the default
scan group.
3. When you are entering a reference to I/A Series OPC Device Integration
Object manually, enter device node IASeries in the Value field.
Extensions Group
Use the Extensions group to select the extensions for a particular parameter.
You can select from these four types of extensions, as shown in Figure 1-12:
• Access Extension
• Frequency Extension
• Data Extension
• Packing Extension
The extensions available change depending on the parameter selected.
Likewise, the drop-down lists for Value text box to the right of Frequency and
Data text boxes vary depending on the options already selected.
As you select extensions, they are added to the string in the Value text box
using the truncated form and separated from the parameter name and preceding
extensions by the # symbol.
In Figure 1-12, two extensions have been specified: Access has been set to
Read Only (#AR) and a deadband of 0.1 has been specified with a Deadband
extension (#D0.1). Frequency and Packing extensions have not been set; the
frequency and packing defaults set in the DI object will be applied. See
“Configuring the I/A Series OPC Device Integration Object” on page 42 for
information on setting the defaults for the I/A Series Device Integration
Object.
Value Field
The Value Field displays the extended name for the element selected in the
browser. The Galaxy name is not shown in the Value Field. The format for the
remainder of the string is dependent on the element type.
For I/A Series Device Integration Object:
For block parameters, the format is:
DI.ScanGroup.Compound.Block.Parameter#Extensions
For compound parameters, the format is:
DI.ScanGroup.Compound.Parameter#Extensions
For I/A Series OPC Device Integration Object
For block parameters, the format is:
DI.ScanGroup.IASeries.Compound.Block.Parameter#Extensions
For compound parameters, the format is:
DI.ScanGroup.IASeries.Compound.Parameter#Extensions
Extensions selected in the Extensions pane are displayed in this field in their
truncated format.
The scan group and extensions are optional for both DI Objects.
The IASeries, which is device node in the IADAS, is necessary for I/A Series
OPC Device Integration Object.
The parameter names with IASeries device node could be used for I/A Series
DI Object. Although that is not recommended, but it will not affect the DI
Object performance.
When the I/A Series Galaxy Browser is opened (that is, when you start the
browser and then select the I/A Series Browser tab), the browser searches for
the cache files in this directory:
<ArchestrAFrameworkDir>\FileRepository\IASeriesBrowserCache\
<GalaxyName>
In a typical example, the browser would search for files in this location:
D:\ProgramFiles\ArchestrA\Framework\FileRepository\IASeriesBrowserCach
e\AGalaxy. If cache files are not available when the I/A Series Browser tab is
selected, the browser displays the message shown in Figure 1-13.
Figure 1-13. Message Shown When Cache Files Are Not Available
6. If it is the first time the browser is invoked on the workstation after server-
side cache generation, you need not press the browser Refresh button; the
browser automatically copies the local cache from the server.
7. Open the I/A Series Galaxy Browser and check the Refresh Date
information in the lower left corner of the I/A Configuration pane to verify
that the browser is using the correct files.
C H A P T E R 2
Contents
• Installation
• I/A Series Device Integration Object Data Flow
• I/A Series OPC Device Integration Object Data Flow
• Extensions
• DI Object Logs
Installation
The I/A Series Device Integration Object is installed and deployed on the
runtime workstations as part of the Control Software’s installation. The object
is instantiated as an ArchestrA application object and assigned to an
application engine. The Device Integration Object is not assigned to an area.
The installation program names the object and the host application engine by
appending _IADI and _AppE, respectively, to the workstation name
(letterbug). The Deployment view in Figure 2-1 shows the device integration
object and application engine on the workstation AWXP05.
Note This section does NOT apply to the I/A Series OPC Device Integration
Object.
Application Engine
I/A Series Device
Integration Object
The OM List Manager is a shared library that provides clients with read/write
access to Foxboro Evo data through the Object Manager (OM), including
process variables, application objects, and other shared variables and aliases.
The OM List Manager provides Foxboro Evo data directly to the I/A Series
History Provider (Chapter 3, “I/A Series History Provider”). Other
applications, such as the Control HMI, access the OM List Manager through
the I/A Series Device Integration Object. The DI Object configures the OM
List Manager. There is a one-to-one relationship between an instance of the
I/A Series Device Integration Object and the OM List Manager.
Note Do not end the aaengine.exe process from the Windows Task Manager.
Terminating the Engine in this way will orphan any open Object Manager lists
in the I/A Series Device Integration Object. Instead, to stop the DI Object,
undeploy the DI Object from the Control Editors. The I/A Series Device
Integration Object can also be stopped from the SMC by stopping the “AppE”
application engine that hosts the I/A Series Device Integration Object.
The I/A Series Device Integration Object communicates with the I/A Series
Security Provider to retrieve control block parameter’s Security Classification
and Security Group.
General Tab
The I/A Series Device Integration Object Editor’s General tab will contains
parameters applicable to the I/A Series Device Integration Object
configuration only.
Figure 2-4. I/A Series Device Integration Object Editor General Tab
Table 2-1 lists the configurational attributes of the General Tab of an I/A Series
Device Integration Object Editor.
Table 2-1. I/A Series Device Integration Object Editor General Tab
Attributes
Attribute Description
Force all Tag Names to Check this option to maintain compatibility
Upper Case between InTouch tag names, which are not case-
sensitive, and Object Manager object names,
which are case-sensitive. If InTouch software is
not being used, this box may be unchecked.
Uncheck this box to access application objects
through the Device Integration Object when the
application objects have case-sensitive names.
Tag Initial Quality This option enables the DI Object to return any tag
Quality after a tag is added to the OM List
Manager. This option may be set to any desired
tag quality, using base 10 decimal notation.
Range: 0 to 65535, Default: 32
Tag Quality after This option defines tag's quality that will be
Timeout returned to the client after initial timeout if the
OM List Manager doesn't provides tag's value or
quality.
Range: 0 to 65535, Default: 0
Tag Initial Timeout This option defines initial timeout.
Range: 0 to 60000, Default: 5000, Units: ms.
defined as OPC quality Bad (0x00). Any valid OPC quality can be used for the
DI Object configuration. For more information about available OPC qualities
see Appendix A, “ArchestrA OPC Quality Word”.
Table 2-2 lists the configuration options for the OM List Manager tab.
Attributes Description
OM Simulation Mode When OM simulation mode check box is
selected, the DI Object provides simulated data
for the requested tags rather than actually
providing access to the Foxboro Evo system
through the OM. Select this option for testing and
troubleshooting.
In simulation mode, the DI Object returns a
floating point value that increments at a rate of
100 ms for each tag (unless preconfigured to
return a different type). When a tag is written to,
the write is silently rejected. A diagnostic
message is logged in the SMC log file whenever
the DI Object is started in simulation mode,
because this is not a normal mode of operation.
Attributes Description
OM List Open Delay The Device Integration Object may need to open
multiple OM Lists in order to satisfy a set of
parameter requests. This option specifies the time
in milliseconds to delay before a subsequent OM
Open is done. This delay places an upper limit on
the frequency in which broadcasts are issued from
this DI Object, which allows the stations time to
process the broadcasts.
Range: 0 to 12000, Default: 200, Units:
milliseconds.
OM Poll Rate Default This option specifies the default poll rate for
nonconnectable parameters.
Range: 500 to 86,400,000, Default: 2,000, Units:
milliseconds.
OM Poll Rate Manual This option specifies the multiplication factor
Factor used to convert scan rates to poll rates for use
with the #FM option. For example, if a parameter
with a #FM500 option is a nonconnectable
parameter and the PollRateManualFactor is 4, the
parameter will be added to the poll publisher with
period of 500 ms * 4 = 2,000 ms.
Range: 1 to 255, Default: 4, Scope: #FM option
OM Poll Rate Retry This option specifies the Poll rate retry factor for
Factor an unsuccessful omget. When an OM get is not
successful for a particular parameter, that
parameter is retried at its original Poll Rate
multiplied by the PollRateRetryFactor. For
example, if a parameter
that was Polled at a 1,000 ms interval with a
PollRateRetryFactor of 60 ms, detected an error,
it would not be retried for another 1000 * 60 =
60,000 ms or 1 minute.
Range: 1 to 255, Default: 60, Scope: Polled
Parameters
OM Deadband This option specifies the default deadband (delta
value) for parameters (objects) added to an OM
List.
The default is used if the Item does not have a
deadband specified in a tag name extension.
Range: 0 or 0.000001 to 1000000.0,
Default:0.01, Units: Engineering Units.
Table 2-3 lists the configuration options for the Cached Strings tab.
Attributes Description
Enabled When the Enabled check-box is selected, the String
Caching feature is enabled.
Default: Unchecked
Cache Size Max This option defines the Cache's maximum size. When
the Cache exceeds this size, the oldest parameter value
is removed from the Cache.
Range: 1000 - 250000
Default: 100000
Parameters to Cache This option allows you to select what parameters to
cache.
Default: All parameters are selected (all parameters
from the list are cached).
Attributes Description
Rate This option allows you to specify how often the
parameters that are configured to be cached and that
have value in the Cache are added to the OM List
Manager.
Default: 250 ms
Range: 100 ms - 1000 ms
Number of This option allows you to specify how many
Parameters parameters that are configured to be cached and that
have value in the Cache are added to the OM List
Manager. The actual number of parameters added to
the OM List Manager per second can be roughly
calculated as:
1000
---------- * Number of Parameters
Rate
Default: 8
Range: 1 - 10
Field Description
Scan Group A unique name for a scan group in the DI Object from
which you want to receive data.
To add a group: Click and type in the name of
the group.
To delete a group: Select the topic in the list and click
.
Update Interval The rate, in milliseconds, at which the object is to
receive updated data values for the scan group. The
default is 500.
Field Description
Attribute A user-defined name, or alias, for an item reference.
You can pre-configure up to 5000 attributes.
Item Reference The item name in the DI Object can be in one of these
forms:
Compound.Block.Parameter[#Extensions]
Compound.Parameter[#Extensions]
Shared variable[#Extensions]
Refer to “Accessing Foxboro Evo Data” on page 57
for details on the tag syntax.
Element Description
Galaxy Name of the Galaxy repository followed by a colon.
When constructing the tag using the I/A Series Browser,
the Galaxy is automatically added to the tag, but not
displayed in the Value field in the browser with the other
elements.
DI Object Name of the I/A Series Device Integration object
Scan Group Optional scan group tag. The default is used if none is
specified. See “Cached Strings Tab” on page 27 for
information on setting up scan groups.
Item Foxboro Evo path with optional extensions. Elements
within the Foxboro Evo path are separated by a period.
The path and the extensions are separated by a #.
For a compound parameter, use:
Compound.Parameter[#Extension]
For a block parameter, use:
Compound.Block.Parameter[#Extension]
For a shared variable name, use:
Variable[#Extension]
References to shared variables cannot be
constructed using the I/A Series Browser.
InfoDiItemsCount
This indicates the number of tags added by the clients including tags with
$tag$prefix tag items.
Range: from 0 to number of tags
InfoDiGoodItemsCount
This indicates the number of tags added by the clients with good quality.
Range: from 0 to number of tags
InfoDiBadItemsCount
This indicates the number of tags added by the clients that have bad quality.
Range: from 0 to number of tags
InfoDiWaitingItemsCount
This indicates the number of tags added by the clients that are waiting for
initial respond.
Range: from 0 to number of tags
InfoDiNotFoundItemsCount
This indicates the number of tags added by the clients that were not found (no
response from OM).
Range: from 0 to number of tags
InfoDiUncertainItemsCount
This indicates the number of tags that have the Uncertain quality.
Range: from 0 to number of tags
InfoDiTagItemsCount
This indicates the number of tags with $tag$ prefix added by the clients.
Range: from 0 to number of tags
InfoOmListCountAvailable
This is the number of OM Lists that are available for use by the DI Object and
subsequently the client. This number is OmListCountMaximum minus the
number of reserved lists (OmListCountReserved) and the current number of
OM Lists opened by the DI Object.
Range: 0 to OmListCountMaximum
InfoOmListsUsed
This indicates the number of used OM lists by all clients.
Range: from 0 to maximum lists limit.
InfoOmListsFree
This indicates the number of used OM lists available for use (not containing
any tags).
Range: from 0 to maximum lists limit.
InfoOmPollItemsCount
This indicates the number of tags added by the clients that OM List Manager is
currently polling for.
Range: from 0 to number of tags
InfoOmRetryItemsCount
This indicates the number of tags added by the clients that OM List Manager is
currently retrying.
Range: from 0 to number of tags
InfoOmScanItemsCount
This indicates the number of tags added by the clients that OM List Manager
maintains in the OM lists.
Range: from 0 to number of tags
InfoOmPollOverrunItemsCount
This indicates the number of tags that were polled with slower rate that is
configured.
Range: from 0 to number of tags
InfoOmListCountClientLimit
This is the total number of OM Lists that may be used by the client, which is
OmListCountReserved less than OmListCountMaximum, to allow for list
packing. This value is static since it is determined through configuration.
Range: N/A
InfoDICachedStringsCount
This indicates the number of the parameter's values in the Cache.
Range: from 0 to 250000
InfoDICachedStringsUsed
This indicates the number of the cached values currently used by the DI
Object.
Range: N/A
Although tags appear to be ordinary data with respect to the client, the values
are not acquired from the Foxboro Evo system. Tag values are generated from
the tag name itself. The syntax is as follows (two forms are supported):
Galaxy:IADI.$tag$COMP.BLOCK.PARAM#Extensions
or
Galaxy:IADI.$tag$.COMP.BLOCK.PARAM#Extensions
Either of the above tags will return the following:
COMP.BLOCK.PARAM#Extensions
String Caching
The String Caching feature is used to improve the call up time of InTouch
windows that have large numbers of string parameters (example: descriptions,
engineering units, alarm texts, and others).
The feature only supports string parameters that are non-connectable and non-
settable. Configure the parameters that you need to cache by selecting them
from the provided list of supported parameters. When this feature is enabled,
the DI Object builds a cache of the parameter's values, which is used for a
quick lookup of the parameter's value.
Note The NAME parameter is implicitly cached and cannot be removed from
the selection. Therefore, the NAME parameter will display as selected in the
list and cannot be unselected.
Note The Tag Quality After Timeout option is not supported for parameters
that have cached values.
When the DI Object receives a value for the parameter from the OM List
Manager that is configured to be cached, the DI Object stores the value into the
cache and passes the value to InTouch.
Note If the parameter value was changed after it was saved in the cache (the
block was redeployed with a different parameter's value) and Windows is
opened in InTouch, the parameter value from the cache is shown first followed
with a correct value from the CP.
The DI Object builds the cache from the file during its startup. The DI Object
persists the cache into a file during its shutdown. The file is protected against
tampering. The DI Object rejects the tampered file and starts with an empty
cache.
The cache has a configured maximum size limit. When the cache exceeds this
limit, the oldest parameter's value is removed from the cache.
Parameters configured with the extensions provided here cannot be cached and
are ignored by the caching logic:
#FP, #FA, #FM, #TD, #B, #M, and #S.
The OM List Manager processes parameters that do not have a cached value at
a higher priority than values that are already cached. This is to provide a faster
retrieval from the Control Processor for the requested parameters.
Updating the Cache is given a lower priority. If a cached value is updated while
the InTouch window is open, the field within the window will be updated with
the new string value. Remember that the update of a cached value has to be a
rare occurrence. The cache only holds strings that are defined as non-
connectable and non-settable. An update to this type of string value needs a
deployment from the Configuration Tool.
DI Object Logs
This section describes the procedure for using the Log Flag Editor to capture
I/A Series Device Integration Object log messages. The SMC provides the
ability to capture I/A Series Device Integration Object log messages. Logging
may be configured by using the Log Flag Editor, as shown in Figure 2-11.
Under normal operating conditions, enable only these Log Flags: Error,
Warning, and Info. When troubleshooting a general problem, it is often useful
to enable Trace. Verbose can be used in combination with any Log Flag. This
Log Flag will allow the I/A Series Device Integration Object to log more
detailed information; however, it may produce a very large number of log
messages.
Log Flags
There can be different types of log flags in OM List Manager. They are
explained in the below sections.
Configure
The Configure log flag is used to log OM List Manager configuration changes.
With the verbose flag, adding and removing tags is logged.
Receive
The Receive log flag is used to log actions resulting in data being read or
received from control block parameters or shared variables. With the Verbose
flag, the results of conversions to other data types, such as .NET or ArchestrA,
from Foxboro Evo data types are logged. This includes value, quality and
timestamp conversions.
Send
The Send log flag is used to log actions resulting in data being sent or written
to control block parameters or shared variables. With the Verbose flag, the
results of conversions from other data types, such as .NET or ArchestrA, to
Foxboro Evo data types are logged. This includes value, quality and timestamp
conversions.
Update
The Update log flag is used to log parameter updates to timestamp, value
and/or status as they are received from the OM through the OM List Managers
scan or poll mechanism.
Note Above mentioned log flags will allow the OM List Manager to log more
detailed information; however it may produce a very large number of log
messages. These are basically for troubleshooting the detected problems.
Security
The Security log flag is used to log information related to retrieving
parameter's classification and Security Group information from the I/A Series
Security Provider.
CachedStrings
The CachedStrings log flag is used to log information related to the String
Caching feature execution. When CachedStrings is enabled, the DI Object
generates messages when tags are added to the DI Object, and when
parameters that have a cached value are passed to the OM List Manager.
When the CachedStrings flag is combined with a verbose flag, the DI Object
generates these messages:
• A message for every value added or updated in the cache.
• A message for every added parameter that is configured to be cached and
has a cached value.
• A message for every added parameter that is configured to be cached and
does not have a cached value.
• A message for every parameter that has a cached value and is passed to the
OM List Manager.
AddRemoveItems
• The AddRemoveItems log flag is used to log the number of items added to
or removed from the DI Object, as well as the item's type.
Figure 2-12. I/A Series OPC Device Integration Object Data Flow
The IADAS is a DA server that provides OPC clients with read/write access to
Foxboro Evo data through the Object Manager (OM), including process
variables, Foxboro Evo application objects, and other shared variables and
aliases.
The I/A Series OPC Device Integration Object configures, starts, and stops the
IADAS. There is a one-to-one relationship between an instance of the
I/A Series OPC Device Integration Object and the IADAS. There could only
be one deployed I/A Series OPC DI Object per workstation.
Note Do not end the IADAS.exe process from the Windows Task Manager or
make Foxboro.IASeries.DAServer.1 unavailable from the SMC DAServer
Manager. Terminating the IADAS in this way will orphan any open Object
Manager lists. Instead, to stop the IADAS service, undeploy the I/A Series
OPC DI Object from the Control Editors. The IADAS service can also be
stopped from the SMC by stopping the “AppE” application engine that hosts
the I/A Series OPC DI Object.
The I/A Series OPC DI Object supports these operations in the I/O points of
the IADAS:
• Subscriptions, which are implemented through scan groups, as described
on page 58
• Read transactions, which are implemented through block reads, as
described on page 58
• Write transactions, which are implemented through block writes, as
described on page 58
The I/A Series OPC Device Integration Object communicates with the
I/A Series Security Provider, which supplies tag Security Classification and
Security Group information to ArchestrA security. The I/A Series Security
Provider is described in Chapter 6, “I/A Series Security Provider”.
General Tab
Figure 2-15. I/A Series OPC Device Integration Object General Tab
Table 2-6 lists the configurable options for the General tab.
Field Description
Server node The name of the computer on which the IADAS is running. This
field has to be blank (default) as the IADAS is assumed to be
running on the local node. The I/A Series OPC Device
Integration Object does not support remote IADAS connections.
Server name Use the pull-down list to select the desired version of IADAS
software. The default is the initial version of the server,
Foxboro.IASeries.DAServer.1.
Run server out-of-proc This checkbox has to be checked so that the IADAS operates
out-of-process. An in-process OPC DA Server runs as a .dll
within the engine process. An out-of-process OPC DA Server
runs as a stand-alone executable. Currently, only one IADAS
may be active on a workstation at any one time, so the out-of-
process option has to be used to enforce this.
Use scan group name as Unchecked by default. If checked, the name of the scan group
access path has to be IASeries since this group is used for the OPC access
path, or topic.
Restart attempts The maximum number of times that the I/A Series OPC Device
Integration Object attempts to restart a non-functioning IADAS
within the time specified in Restart period.
Restart period The time period, in milliseconds, over which the maximum
number of Restart attempts applies. If this time period elapses
before the maximum number of restarts is exceeded, the restart
count is set to 0.
Detect restart alarm If enabled, an alarm is triggered when the number of attempts to
start the IADAS has exceeded the allowed maximum specified
in Restart attempts.
Priority Specify the alarm priority to be displayed in the InTouch Alarm
Panel for a restart alarm. The range of alarm priorities in the
InTouch panel is 1 (highest priority) to 999. The default is 500.
Connection heartbeat The interval, in milliseconds, at which the I/A Series OPC
period Device Integration Object checks its connection to the IADAS.
Detect connection If checked, an alarm is triggered when the I/A Series OPC
alarm Device Integration Object can no longer communicate with the
IADAS.
Priority Specify the alarm priority to be displayed in the InTouch Alarm
Panel for a connection alarm. The range of alarm priorities in the
InTouch panel is 1 (highest priority) to 999. The default is 500.
Restart reset security Used to set security for restarting the IADAS.
Force all Tag Names to This option has to be checked to maintain compatibility between
Upper Case InTouch tag names, which are not case-sensitive, and Object
Manager object names, which are case-sensitive. If InTouch
software is not being used, this box may be unchecked. This box
has to be unchecked to access application objects through the
I/A Series OPC Device Integration Object when the application
objects have case-sensitive names.
DAServer Tab
The IADAS is configured on the DAServer tab. The default settings shown in
Figure 2-16 are generally sufficient for the systems. The IADAS attributes are
described in Table 2-7.
Attribute Description
OM Simulation Mode When OM simulation mode check box is selected,
the IADAS provides simulated data for the
requested tags rather than actually providing
access to the Foxboro Evo system through the
OM. Select this option for testing and
troubleshooting.
In simulation mode, the IADAS returns a floating
point value that increments at a rate of 100 ms for
each tag (unless preconfigured to return a different
type). When a tag is written to, the write is silently
rejected. A system message is logged in the SMC
log file whenever the IADAS is started in
simulation mode, because this is not a normal
mode of operation.
Attribute Description
OM Deadband Specifies the default deadband (delta value) for
items added to an OM list. The default is used if
the item does not have a deadband specified in an
extension (as described in “Deadband” on
page 77). The deadband is the minimum change in
the parameter value since the last update for
another update to be sent to the client.
The range is 0 or 0.000001 (default) to 1000000.0
engineering units.
OM List Open Delay The IADAS may need to open multiple OM lists
in order to satisfy a set of item requests. This
option specifies the time in milliseconds to delay
before a subsequent OM open list is done. This
delay places an upper limit on the frequency with
which broadcasts are issued from this IADAS. The
delay allows Foxboro stations time to process the
broadcasts. This value has to be increased if a
display that has more than 255 tags is missing
data.
The range for OM List Open Delay is 0 to 12000
ms; the default is 200.
Field Description
Scan Group A unique name for a scan group in the IADAS from
which you want to receive data.
To add a group: Click and type in the name of
the group.
To delete a group: Select the topic in the list and click
.
Update Interval The rate, in milliseconds, at which the object is to
receive updated data values for the scan group. The
default is 500.
Field Description
Attribute A user-defined name, or alias, for an item reference.
You can pre-configure up to 5000 attributes.
Item Reference The item name in the IADAS can be in one of these
forms:
Compound.Block.Parameter[#Extensions]
Compound.Parameter[#Extensions]
Shared variable[#Extensions]
Refer to “Accessing Foxboro Evo Data” on page 57
for details on the tag syntax.
2. Click in the Item Reference field to browse for and select the point in
the Foxboro Evo system.
Edit the Item Reference field to add extensions (as described in
“Extensions” on page 63), if necessary.
Note Select an attribute and click to delete the attribute from the group
or block.
Field Description
Block Read A unique name for a block read group.
To add a group: Click and type in the name
of the group.
To delete a group: Select the topic in the list and
click .
Transaction The time, in milliseconds, allowed for the block
read transaction to be completed. The default
value is 0 (no transaction timeout).
Access Path The OPC address path. The path syntax is specific
to the type of OPC Server.
Field Description
Attribute A user-defined name for an item reference. This
name is also known as the alias. You can pre-
configure up to 5000 attributes.
Item Reference The item name in the IADAS can be in one of
these forms:
Compound.Block.Parameter[#Extensions]
Compound.Parameter[#Extensions]
Shared variable[#Extensions]
Refer to “Accessing Foxboro Evo Data” on
page 57 for details on the tag syntax.
Field Description
Block Write A unique name for a block write group.
To add a group: Click and type in the name
of the group.
To delete a group: Select the topic in the list and
click .
Transaction Timeout The time, in milliseconds, allowed for the block
write transaction to be completed. The default
value is 0 (no transaction timeout).
Access Path The OPC address path. The path syntax is specific
to the type of OPC Server.
Attribute A user-defined name for an item reference. This
name is also known as the alias. You can pre-
configure up to 5000 attributes.
Item Reference The item name in the IADAS can be in one of
these forms:
Compound.Block.Parameter[#Extensions]
Compound.Parameter[#Extensions]
Shared variable[#Extensions]
Refer to “Accessing Foxboro Evo Data” on
page 57 for details on the tag syntax.
Rule File
The IADAS rule file (IADAS.aarul) specifies that only one instance of the
IADAS is allowed on any particular workstation, and defines the default
attributes and values for that Server instance. The rule file is an XML file, but
under normal circumstances and for most configurations, do not edit it.
Incorrect modification to this file will cause the server to not function properly.
Configuration File
The IADAS stores its configurable attributes in a configuration file
(IADAS.aacfg). This file contains system variables and DeviceNode
configuration information. This file is read when the IADAS service is first
started manually or when the associated I/A Series OPC Device Integration
Object is deployed.
The configuration file is automatically updated when the I/A Series OPC
Device Integration object is deployed or undeployed through the ArchestrA
IDE. When the I/A Series OPC Device Integration object is deployed, a
DeviceNode with the appropriate attributes is added to this file, and when the
I/A Series Device Integration object is undeployed, the DeviceNode is
removed.
This DeviceNode contains the configuration of the I/A Series OPC Device
Integration object. The name of the DeviceNode will be the same as the name
of the instance of the I/A Series OPC Device Integration object created in the
IDE. The values for the DeviceNode’s attributes can be customized in the
I/A Series OPC Device Integration object’s WinForm. Therefore, when
deploying and starting the I/A Series OPC Device Integration object using the
ArchestrA IDE, do not modify this file.
Figure 2-18 shows the default contents of the IADAS.cfg configuration file.
The file looks like this before the I/A Series OPC Device Integration object is
deployed.
<DASConfiguration>
<System NAME="SYSTEM" TYPE="SYSTEM">
<_ImageId>0</_ImageId>
<CaseSensitive>1</CaseSensitive>
<DefaultDelimiter>.</DefaultDelimiter>
<DefaultPokeMode>0</DefaultPokeMode>
<EnableSystemItems>1</EnableSystemItems>
<LinkTopicCache>0</LinkTopicCache>
<LockConfigurationFile>0</LockConfigurationFile>
<ProtocolTimerTick>50</ProtocolTimerTick>
<SimulationMode>0</SimulationMode>
<SlowPollInterval>10000</SlowPollInterval>
<SubscriptionTransactionRatio>2</SubscriptionTransactionRatio>
<TransactionsBacklog>20</TransactionsBacklog>
<TransactionTimeout>2000</TransactionTimeout>
<UniqueDeviceGroup>1</UniqueDeviceGroup>
<UpdateInterval>1000</UpdateInterval>
<InitialStatus>8</InitialStatus>
</System>
</DASConfiguration>
Figure 2-19 shows an example configuration file that could be used to support
third-party OPC clients. The configuration file is an XML file and it can be
modified using a text editor. However, this is only useful in the unusual case
where the I/A Series OPC Device Integration object cannot be used to
configure the IADAS and the configuration file has to be customized to
support third-party OPC client access. The values for the attributes under the
DeviceNode shown in the example may be customized as needed, subject to
the ranges specified. Additional device nodes can be added as needed. The
default configuration file does not contain the OMProxy1 device node (as this
is only an example).
<DASConfiguration>
<System NAME="SYSTEM" TYPE="SYSTEM">
<_ImageId>0</_ImageId>
<CaseSensitive>1</CaseSensitive>
<DefaultDelimiter>.</DefaultDelimiter>
<DefaultPokeMode>0</DefaultPokeMode>
<EnableSystemItems>1</EnableSystemItems>
<LinkTopicCache>0</LinkTopicCache>
<LockConfigurationFile>0</LockConfigurationFile>
<ProtocolTimerTick>50</ProtocolTimerTick>
<SimulationMode>0</SimulationMode>
<SlowPollInterval>10000</SlowPollInterval>
<SubscriptionTransactionRatio>2</SubscriptionTransactionRatio>
<TransactionsBacklog>20</TransactionsBacklog>
<TransactionTimeout>2000</TransactionTimeout>
<UniqueDeviceGroup>1</UniqueDeviceGroup>
<UpdateInterval>1000</UpdateInterval>
<InitialStatus>8</InitialStatus>
</System>
<DeviceNode NAME="OMProxy1" TYPE="MESH_ADAPTER" DELIMITER=".">
<OmListCountMaximum>200</OmListCountMaximum>
<OmListScanRateDefault>500</OmListScanRateDefault>
<OmListSizeMaximum>255</OmListSizeMaximum>
<OmObjectDeadbandDefault>0.0000001</OmObjectDeadbandDefault>
<SimulationMode>0</SimulationMode>
<UpdateInterval>100</UpdateInterval>
</DeviceNode>
</DASConfiguration>
Configurable Attributes
The IADAS has the following configurable attributes. Refer to Figure 2-18 for
examples of attribute definitions in the configuration file.
Case Sensitivity
Case sensitivity is not configurable. This option is true by default because the
Foxboro Evo references are case-sensitive.
Tag: <CaseSensitive>1</CaseSensitive>
Range: 1
Default: 1
Scope: All Topics
Delimiter
The Delimiter option sets the default value for the delimiter to be used between
hierarchies in the Item ID, if not specified at each hierarchy.
Tag: <DefaultDelimiter>.</DefaultDelimiter>
Range: String
Default: .
Scope: All Topics
Initial Status
The Initial Status option enables the IADAS to return any OPC Quality after an
item is activated or none at all. In the later case, the IADAS relies on the DAS
Engine to provide the appropriate quality (see below). This option may be set
to any desired OPC quality, using base 10 decimal notation. Since OPC Quality
is usually documented in hexadecimal, a conversion to decimal is necessary
before being used in the IADAS.AAcfg file. The default value for this option is
BAD_NOTCONNECTED (<InitialStatus>8</InitialStatus>). If InitialStatus is
set to BAD_WAITINGFORINITIALDATA (<InitialStatus>32</InitialStatus>)
the IADAS will not force a status update, instead it depends on the DAS
Engine to update clients when the item becomes active. If Initial Status is set to
<InitialStatus>288</InitialStatus>, the IADAS will force a status update, so
BAD_WAITINGFORINITIALDATA can be forced in this way. Note that only
the standard OPC quality and status bits are passed to the DAS Engine on
initial updates. The vendor quality bits are not passed so that the clients
interpret them correctly.
Tag: < InitialStatus>10</ InitialStatus>
Range: 0 to 65535
Default: 8
Scope: All Subscription Topics
Poke Mode
This option is disabled and not configurable. The value is 0 by default, control
mode. The data is written in the order it is received.
Tag: <DefaultPokeMode>0</DefaultPokeMode>
Range: 0
Default: 0
Scope: All Topics
Simulation Mode
When Simulation Mode is 0, the IADAS accesses data from the Foxboro Evo
system. When Simulation Mode is 1, the IADAS provides simulated data for
the requested tags, rather than actually providing access to the Foxboro Evo
system through the OM. Simulation Mode is useful for testing and
troubleshooting. A system message is logged in the SMC log file whenever the
IADAS is started in Simulation Mode indicating that this option is on.
Tag: <SimulationMode>0</SimulationMode>
Range: 0 or 1
Default: 0
Scope: All Topics
Transactions Backlog
The Transactions Backlog option specifies the number of completed
transactions kept in the diagnostic viewer.
Tag: <TransactionsBacklog>20</TransactionsBacklog>
Range: 0 to 50
Default: 20
Scope: Transaction Topics
Transaction Timeout
The Transaction Timeout option specifies the maximum time allowed in
milliseconds for a message participating in a transaction to complete.
Tag: <TransactionTimeout>6000</TransactionTimeout>
Range: 10 to 60000
Default: 6000
Scope: Transaction Topics
Update Interval
The Update Interval is the rate, in milliseconds, for the Message Processing.
This is the rate at which the DAS Engine will scan for changes. The Update
Interval has to be set at a very high rate to help ensure timely updates, but
generally no faster than 100 ms. The value can be decreased (that is, set to a
faster rate) at run time using the $SYS$UpdateInterval system item. See
“$sys$UpdateInterval (VT_UI4/Read, Write)” on page 62.
Tag: <UpdateInterval>100</UpdateInterval>
Range: 0 to 100000
Default: 100
Scope: All Topics
Element Description
Galaxy Name of the Galaxy repository followed by a colon.
When constructing the tag using the I/A Series Browser,
the Galaxy is automatically added to the tag, but not
displayed in the Value field in the browser with the other
elements.
DI Object Name of the I/A Series device integration object
(AWKE03_IADI for example).
Scan Group Optional scan group tag. The default is used if none is
specified. See “Scan Group Tab” on page 46 for
information on setting up scan groups.
IASeries The device node or topic name is IASeries by default.
Item Foxboro Evo path with optional extensions. Elements
within the Foxboro Evo path are separated by a period.
The path and the extensions are separated by a #.
For a compound parameter, use:
Compound.Parameter[#Extension]
For a block parameter, use:
Compound.Block.Parameter[#Extension]
For a shared variable name, use:
Variable[#Extension]
References to shared variables cannot be
constructed using the I/A Series Browser.
Commands
Commands provide a way to dynamically control certain aspects of the IADAS
at run time. Supported commands are listed in these subsections.
OnPollNow
When a value is written to the system item $SYS$PollNow in a subscription
topic (device scan group), the server updates the items in that subscription
topic. This is used to update items when the data is needed before the regular
update occurs, which is governed by the device scan groups update interval.
This command forces a read of the OM list associated with the Device Scan
Group, which will gather only the data that has changed since the OM list was
last read (that is, dqlist). It does not update the entire data from the OM list
(that is, omread), but only the data that has changed.
Store Settings
When a value is written to the system item $SYS$StoreSettings of a device
scan group, the IADAS stores any changed settings in the configuration file.
Update Interval
When a value is written to the system item $SYS$UpdateInterval of a
subscription topic (device scan group), the update interval is changed to that
value.
System Items
System items provide access to IADAS status and diagnostic information as
well as special functions. This data can be acquired through subscription.
Although system items appear to be ordinary data with respect to the client,
these items are not acquired from the Foxboro Evo system. System item values
are generated through internal calculations, measurements, and tracking by the
DAS Engine.
System Item Tags are case-insensitive in the IADAS. For example,
$SYS$OMLISTCOUNTAVAILABLE and $Sys$OmListCountAvailable will
address the same system item.
$sys$OmListSizeMaximum(VT_I4/Read)
This is the maximum number of OM objects that will be added to an OM
list before the list is considered full. This value is static because it is
determined through configuration.
Range: 1 to 255, Default: N/A
$sys$OmListCountClientLimit(VT_I4/Read)
This is the total number of OM lists that will be used by the client, which
is OmListCountReserved minus OmListCountMaximum, to allow for list
packing. This value is static because it is determined through
configuration.
Range: N/A, Value: OmListCountMaximum - OmListCountReserved,
Default: N/A
$sys$ItemCount (VT_UI4/Read)
This indicates the number of items (both active and inactive) added to a
specific device scan group by the clients.
Range: Number of items on a device scan group
$sys$Licensed (VT_BOOL/Read)
This reflects the licensed state of the DAServer. When this is false, the
DAServer will stop updating values, and new items cannot be added. This
value will be true by default. The IADAS has no licensing mechanism
independent of ArchestrA licensing.
Range:
True (-1) when licensed.
False (0) when not licensed.
$sys$MaxInterval (VT_UI4/Read)
This is the maximum device update interval that has been measured for a
specific device group.
Range: Maximum device update interval for a device scan group, in
milliseconds
$sys$PollNow (VT_BOOL/Read, Write)
This allows the client to cause the device subscription messages to become
due for a specific device scan group. Writing a value of ‘1’ will initiate the
poll. Other values are ignored. This item will return a value of ‘0’ when
read.
Range: Always zero
$sys$ReadComplete (VT_I4/Read, Write)
This is set to a nonzero value when a read transaction completes for a
specific device scan group. It can be written by the client to zero, and the
change back to nonzero will indicate read-complete.
Range: Nonzero when a read completes for a device scan group, zero
when written by client
$sys$Status (VT_BOOL/Read)
This is a binary status indication of the connection state to the device
(hierarchy level) to which the item is attached. The status can be good
even if individual items have errors detected in them.
Range:
• True (-1): IADAS connection to the device is intact.
• False (0): Error detected in communicating with the device.
The server-specific code signals this state to the DAS Engine after
evaluating protocol access return codes.
Tag Items
Tag Items provide clients with the ability to obtain the control block parameter
name and extension as a string without performing any additional parsing
operations. This data can be acquired through a transaction or subscription
mechanism.
Although tag items appear to be ordinary data with respect to the client, the
values are not acquired from the Foxboro Evo system. Tag Item values are
generated from the tag name itself. The syntax is as follows (two forms are
supported):
Galaxy:IADI.IASeries.$tag$COMP.BLOCK.PARAM#Extensions
or
Galaxy:IADI.IASeries.$tag$.COMP.BLOCK.PARAM#Extensions
Either of the above tags will return the following:
COMP.BLOCK.PARAM#Extensions
DI Object Logs
This section describes the procedure for using the Log Flag Editor to capture
I/A Series OPC Device Integration Object log messages. The SMC provides
the ability to capture I/A Series OPC Device Integration Object log messages.
Logging may be configured by using the Log Flag Editor, as shown in
Figure 2-20. Under normal operating conditions, only these Log Flags need be
enabled: Error, Warning, and Info. When troubleshooting any general problem
detected, it is often useful to enable Trace. Verbose can be used in combination
with any Log Flag. This Log Flag will allow the I/A Series OPC Device
Integration Object to log more detailed information; however, it may produce a
very large number of log messages. Use Security log flag to trace security
information provided by the I/A Series Security Provider. Use Security log flag
to trace security information provided by the I/A Series Security Provider.
Extensions
Note This section is common for I/A Series Device Integration Object and
I/A Series OPC Device Integration Object
OM List Manager (in case of I/A Series Device Integration Object) and
IADAS (in case of I/A Series OPC Device Integration Object) use List
Manager. The List Manager is a common component responsible for managing
OM Lists. The tag's extension rules implemented by the List Manager are
described here.
A parameter or shared variable can have one or more extensions added to the
tag name to specify custom, non-default processing for the tag.
There are four extension categories: access, data, frequency, and packing. Only
one extension from each category can be applied to a tag at any one time.
Table 2-12 summarizes the available tag extensions. For each extension, the
table lists the extension name as used in the I/A Series Browser extension
drop-down lists and the form.
Note The concepts of Secured Write and Confirmed Write differ from those
terms as used in relation to ArchestrA security. Refer to Object Manager Calls
(B0193BC) for a description of these terms as used in the Object Manager
software.
Table 2-13 provides some examples of using tag extensions. The examples are
not meant to be exhaustive.
“Connectable & Non Settable” row, you can see that AW, AWC, AWS,
AX, AXC, and AXS options are removed because this is a connectable,
non-settable parameter. Choosing the FP column further restricts the
options by removing the P1 option (follow the FP column down). You can
still select the AR, S, and TD options if needed.
Example 2:
For the PIDA parameter FFTBLK (a connectable, settable, long integer),
choose “Long_Int” and “Connectable & Settable” rows. Looking across
the “Long_Int” row, you can see that selecting this parameter does not
restrict the selection of any additional options, all the options are checked.
(However, some options are read-only.) Choosing the AXS column
restricts the options by removing FO, FP, FT, B, M, certain Status bits, and
the P1 options from the browser’s drop-down list.
Access Extensions
Access extensions specify the access privilege (read-only, write, or read-write)
and write method (separate, confirmed, or secured) for data access.
The write method defaults to separate if no other write method is specified. If
an access extension is not specified, the access privilege is governed by the
data extension, in combination with the OM data type. If no data extension is
specified or the specified data extension does not limit the access privilege, the
access privilege defaults to read-write (#AX).
The access extensions are listed in Table 2-14.
Notes
1. If the secured write method is specified for an object that is unsecurable,
no objects within the same OM list as the unsecurable object are
accessible and their status remains bad or pending. This is an OM
limitation.
2. The List Manager writes secured objects one at a time so there is no
performance improvement over separate writes.
3. If the confirmed write method is specified, the List Manager makes a
synchronous write to I/A, waiting for a response from the destination.
4. The write separate method (#AW) does not need the destination to
respond. In this case, writes are faster and success is assumed if the local
OM returns success. However, in the case of #AW, whether or not the
destination accepted the write may be unknown, as the value may not be
updated. If updates are desired, use the #AX extension (which is the
default).
5. Tags with the #AW, #AWC, or #AWS extensions will not have their values
updated periodically unless another tag with read options (#AR, #AX,
#AXC, #AXS) and the same path name was added previously to the List
Manager. In this case, the data and status of the new tag will be updated
when the other tag is updated. This is because the List Manager is
designed to reuse compatible existing objects, rather than creating new
objects for each item added.
6. Tags with a secured write extension (#AXS or #AWS) are not multiplexed
(shared) with other tags with the same path, as the purpose of a secured
write is to connect one parameter to another and allow writes only through
that parameter. When a tag with a secured write extension is added, it is
placed on a new OM list. If the Tag is identical with another existing tag,
the List Manager treats it as the same Tag and does not provide it to the
List Manager. This violates the Foxboro Evo concept of the secured write,
but ArchestrA software is designed to work this way.
7. Write secured extensions (#AWS, #AXS) cannot be used with the #B, #M,
or #T extension, as the OM List API does not support writing bit masks or
type. If these extensions are used, reads may be possible but the writes will
not contain the necessary mask information.
8. Write secured extensions (#AWS, #AXS) cannot be used with the #FP or
#FO extensions, because these Frequency modes do not use OM lists.
9. Write secured extensions (#AWS, #AXS) cannot be used with the #FA or
#FC extension if the control block parameters are not connectable, since
non-connectable parameters cannot be written through OM lists.
10. Tags with a write secured extension (#AWS, #AXS) cannot be packed.
These parameters work as if the #P0 extension were specified. If
parameters with write secured extensions have compatible options and are
added at the same time, they are placed on the same OM list (which has
the same effect as list packing).
Frequency Extensions
The frequency extension specifies the minimum rate at which data is read from
the OM and the method of data access. When a frequency extension is not
specified, the List Manager uses the rate specified in OM List Scan Rate
Default in the DI Object editor tab (specified in DI Object configuration)
(Table 2-7 on on page 45). The default method of access is connectable (#FC).
The frequency extension has five forms (Table 2-15).
With the exception of Once mode (#FO), a scan rate (time period) can be
specified in milliseconds. When a time period is specified, the extension
instructs the List Manager to provide data on a change basis, at the specified
rate or faster, that is, if the data changes, the change has to be reported within
the period of time specified, but not later. The List Manager is free to provide
the data sooner (at a higher rate) if it is already reading the same parameter at
this higher rate. This characteristic is a result of the List Manager multiplex
optimization, that allows many items to be associated with a single compatible
OM object.
Browser
Selection Form Description
Automatic #FAperiod The List Manager will determine the correct mode to obtain
periodic change-driven updates for the parameter, either Scan
mode or Poll mode. If the parameter becomes temporarily
unavailable (for example, undeployed, disconnected, or station
reboot), it will automatically reconnect after the parameter
becomes available again. This option has to be used for
unattended applications that need to automatically recover from
temporary communication disruptions, such as the History
collector.
period can be set at 100 or in the range from 500 to 120000 in
500 ms increments.
Examples:
CMP1.CALC0.II01#FA
CMP1.CALC0.II01#FA500
CMP1.CALC0.II01#FA1000
CMP1.CALC0.II01#FA2000
Connectable #FCperiod Connectable parameters are updated on a periodic basis. Non
connectable parameters are updated when the parameter is
added to the DI Object (if the parameter exists), and the
parameter quality is changed to Good. This is the default mode
for the tags, and is suitable for HMI or query type applications
that need a current snapshot of the data, with periodic change-
driven updates for connectable parameters only. Strings and
character arrays are non connectable parameters, so these and
other non connectable parameters are not updated after their
initial value and status are returned.
period can be set at 100 or in the range from 500 to 120000 in
500 ms increments.
Examples:
CMP1.CALC0.II01#FC
CMP1.CALC0.II01#FC2000
Browser
Selection Form Description
Manual #FMperiod Connectable parameters are updated on a periodic change basis.
When applied to non connectable parameters, periodic data
updates are provided only while the parameter remains deployed
or the station remains connected to the network. Otherwise, the
parameter’s status is set to disconnected and the updates stop. In
this case, updates will not automatically begin again when data
becomes available; the tag has to be manually removed and
added to start the updates again. This option avoids workstation
data delays which can occur when the retry feature of automatic
mode is active. The FM option may be used when manual
intervention is possible, such as HMI applications, but not to be
used for unattended applications, such as the History collector.
period can be set at 100 or in the range from 500 to 120000 in
500 ms increments.
Examples:
CMP1.CALC0.II01#FM
CMP1.CALC0.II01#FM500
PollMode #FPperiod The data is collected (polled) without the use of an OM list.
period can be set at 100 or in the range from 500 to 86400000 in
500 ms increments.
NOTICE
POTENTIAL DATA LOSS
Examples:
CMP1.CALC0.II01#FP
CMP1.CALC0.II01#FP10000
ScanMode #FSperiod When scan mode is specified, the data is collected using an OM
list. If the data is non connectable, no data will be returned.
period can be set at 100 or in the range from 500 to 120000 in
500 ms increments.
Examples:
CMP1.CALC0.II01#FS
CMP1.CALC0.II01#FS2000
Browser
Selection Form Description
Once Mode #FO Once mode (not periodically). om_object_type and
om_object_type, om_data_type are optional for reading, but are necessary for
om_data_type writing. If not specified, om_object_type defaults to VARIABLE
and om_data_type defaults to UNKNOWN, unless they are
already known by the List Manager, in which case the List
Manager provides the correct type in place of the default. OM
lists are not used for Once mode.
Examples:
CMP1.CALC0.II01#FO
CMP1.CALC0.II01#AW#FO1,2
Browser
Selection Form Description
Trigger Mode #FT The trigger parameter is placed on scan. When the trigger
trigger_parameter@ parameter’s value changes the parameter is read (polled).
period
Note The parameter generates a value only when both the
parameter and the trigger parameter exist and are in the Good
state.
Notes
1. A periodic frequency specification (#FA, #FP, #FT or #FS) is meaningless
in combination with the #AW, #AWC, or #AWS write extensions, as write
parameters are not scanned or polled periodically. #AW and #AWC
parameters do not use OM lists. #AWS parameters do use OM lists but
they do not use the change notify option.
2. Write secured extensions (#AWS, #AXS) cannot be used with the #FP or
#FO extensions, because these Frequency modes do not use OM lists.
3. Write secured extensions (#AWS, #AXS) cannot be used with the #FA or
#FC extension if the control block parameters are non connectable, as non
connectable Parameters cannot be written through OM lists.
4. om_object_type and om_data_type are specified using integer values
(base10). Table 2-16 shows the mapping between OM object type and the
integer values. Table 2-17 shows the mapping between OM data types and
integer values.
Data Extensions
Bit
The List Manager provides bit extensions for reading single bits from integer
and OM long integer data types, and for read-write access to single bits in a
packed boolean. The List Manager does not provide the facility to write one or
more bits at a time for Integer types (INTEGER, OM_LNG_INT), as the OM
does not provide this ability and the possibility of non exclusive access makes
this operation unsafe.
Form: #Bn
where n is the bit number, least significant bit (LSB) first. This differs from the
standard Foxboro Evo style representation of the most significant bit (MSB)
first.
Range: 0 to 31 (0 extracts the LSB)
Examples:
C.B.P#B0 extracts the LSB of a 32 bit value
C.B.P#B0 extracts the LSB of a 16 bit value
C.B.P#B31 extracts the MSB of a 32 bit value
C.B.P#B15 extracts the MSB of a 16 bit value)
Items with a bit extension default to a deadband of 1.
To specify a bit extension when using the I/A Series Browser:
• Select Bit in the Data field and then use the drop-down list in the Value
field to the right to select to bit number (0 is the LSB).
The bit numbers listed depend on the data type of the selected parameter.
Bytes
Bytes extensions can only be used with packed long values (OM_L_PKBOL)
and packed short values (OM_S_PKBOL). Extensions allow access to two out
of four bytes’ values.
Form: #LB
When specified, the DI Object masks two higher bytes (0xFFFF0000
mask).
Form: #HB
When specified, the DI Object shifts two higher bytes into two low bytes
positions and masks two higher bytes (0xFFFF0000 mask).
Note The BYTES extensions are only available in the I/A Series Device
Integration Object starting as of release v7.0.
Deadband
A deadband extension, which specifies an absolute range beyond which the
value of the parameter has to change before it is reported as having changed, is
provided for the data types.
When a deadband extension is not specified, the deadband for the tag is set
according to the OM Deadband specified in the DI Object Editor
(Figure 2-16).
When a deadband extension is provided, the extension value overrides the
default.
Form: #Dn
where n is the deadband in engineering units.
Range: 0 to 100000.0 (7 digits)
Examples:
C.B.P#D0.000001
C.B.P#D0.123456
C.B.P#D123.4567
C.B.P#D123456.7
To specify a deadband extension when using the I/A Series Browser:
• Select Deadband in the Data field and enter the data in the Value field to
the right.
Notes
1. The deadband is a floating-point value within a specified range. A
deadband of 0 indicates that the value of the parameter has to be updated
every scan cycle.
2. A deadband applied to a CHARACTER or a STRING data type is
ignored, as both CHARACTER and STRING data types are represented as
strings in the List Manager.
3. The smallest fractional deadband that can be configured is 0.000001, as
there is a limit of 7 digits in the configuration file.
4. Deadband is the delta value and is only meaningful for connectable
parameters that are accessed through an OM list. Deadband is ignored
when used in combination with #FP or #FO and when the #FA or #FC
option is used to access a non connectable parameter.
5. For OM_BOOL types (digital I/O) use a deadband of 1 (#D1). Bit
extensions (#B) default to a deadband of 1.
Mask
The mask extension provides the ability to read integer and packed boolean
values (INTEGER, OM_LNG_INT, CIO_SHORT, OM_S_PKBOL,
OM_L_PKBOL) while ignoring bits within the value that are not specified
within the mask. If the value provided for the mask is out of range, the mask is
set to 0 and no masking is done. This is equivalent to specifying FFFFFFFF as
a mask. Mask extensions are ignored when writing values.
Form: Mmask
where mask denotes the bit positions to be read.
Range: 1 (reads the LSB only) to 0xFFFFFFFF (reads all bits)
To specify a bit extension when using the I/A Series Browser:
• Select Mask in the Data field and then enter the mask in the Value field
(1 to FFFFFFFF).
Status
The status extension allows read and read-write access to selected bits in the
Foxboro Evo status word. Tags with a status extension return a Boolean value
corresponding to the Foxboro Evo value status of the parameter, instead of
returning the parameter value. Likewise, writing a Boolean value to a tag with
a status extension sets the Foxboro Evo value status of the parameter, not the
value of the parameter assuming the status bit has read-write access.
There are two forms for specifying a status extension:
#Sbit where bit is the bit number as listed in Table 2-18.
#sMN where MN is the mnemonic of the status bit as shown Table 2-18.
.
Type
The type extension reads the OM data type from the OM object specified by
the tag name.
Form: #TD
The List Manager returns an integer representing the OM data type
(Table 2-17).
To select the Type extension when using the I/A Series Browser:
• Select Type in the Data field.
The Value field to the right displays Data Type, the only available
selection.
Packing Extensions
The packing extensions (Table 2-19) specify the data organization in an OM
list. The default packing mode is #P2, Automatic packing, which is usually
sufficient for clients.
Browser
Selection Form Description
None #P0 No packing is performed. The List Manager adds the parameter to a new
or compatible currently filling OM list. The server does not add the
parameter to an OM list that is already open. This represents the lowest
latency (that is, best response) mode. Applications that need consistent
performance has to use this mode. However, when the OM List Count
Maximum set in the DI Object Editor tab (Figure 2-16) is reached, no
additional parameters need to be added to the List Manager. This mode
may result in the under utilization of OM lists if fewer than 255 items are
added per list.
Always #P1 Always adds the parameter to a compatible currently filling OM list or to
an open compatible OM list if it has space; otherwise, a new OM list is
created. This mode maximizes list packing at the expense of the time
needed to copy the contents of one list to another. Applications that need
a large amount of data throughput, where startup latency is not
important, such as a Historian, have to select this mode.
Automatic #P2 Automatic packing adds the parameter to a new or compatible currently
filling OM list. If the OM List Count Maximum set in the DAServer tab
(Figure 2-16) has been reached, the parameter is added to an OM list that
is already open. This is the default mode of operation and provides an
adaptive function, combining the other two modes. Applications that
need good performance and scalability have to use this mode. The
performance comes down after the OM List Count Maximum set in the
DI Object Editor tab (Figure 2-16) has been reached.
Note Tags with a write secured extension (#AWS, #AXS) cannot be packed.
These parameters work as if the #P0 extension were specified. If parameters
with write secured extensions have compatible options and are added at the
same time, they are placed on the same OM list that has the same effect as list
packing.
C H A P T E R 3
This chapter describes setup, management, and use of the I/A Series History
Provider. This application consists of an ArchestrA application object (history
object) operating on a workstation that collects data from the Foxboro Evo
system and delivers the sample data to the Wonderware Historian for bulk
storage and access by InTouch and Wonderware Historian clients and other
applications. Figure 3-1 illustrates the I/A Series History Provider data flow.
Contents
• I/A Series History Provider Installation
• Wonderware Historian Installation
• Configuring Historian Collectors
• Configuring the I/A Series History Provider
• Configuring Historian Connections
• Starting and Stopping the Wonderware Historian
• Verifying History Storage
• History Object Log Flags
• Manually Changing Time Backwards in Wonderware Historian
Note It is recommended that you do not deploy the I/A Series History
Provider application object if the workstation is not to be used for data
collection. Undeploying the object reduces load on the workstation and the
Galaxy Sync Service, which has to periodically respond to the I/A Series
History Provider application objects that are on scan.
Application Engine
Area
When deployed and on scan, the I/A Series History Provider performs these
functions:
• Interacts with the Galaxy Sync Service (described in Chapter 5, “Galaxy
Sync Service”) to determine the points that are identified for collection,
and the sample rate, delta, and other collection attributes configured for
each point.
Compound and block parameters are selected for collection in the Block
Configurator History tab as described in “Configuring Historian
Connections” on page 95. The History tab determines which points are
collected and when they are to be collected.
Configuration of the compound also identifies the workstation (and thus
the I/A Series History Provider) that will provide the data collection for
the compound’s historized parameters and those of its assigned blocks.
• Interfaces with the OM List Manager to subscribe for and collect sample
data from the Foxboro control processors.
• Registers the Foxboro Evo tags with Wonderware Historian Server so that
ArchestrA clients can access the sample data without invoking a
specialized browser.
• Delivers the sample data to the designated Wonderware Historian Server
for bulk storage.
Application engines can be configured to collect platform and application
engine statistics, as described in “Collecting Platform and Application Engine
Statistics” on page 93.
Note The Historian needs to have a Fox Administrator account, with the
associated fixed password. The Control Software’s installation program
automatically creates this account.
Note The I/A Series History Provider needs the Historian system time to be
synchronized with Foxboro Evo system time. This is done automatically by the
master timekeeper for the Foxboro stations. For non- Control Core Services
stations, either an alternate means of time synchronization has to be used or
history data has to be collected using the IDAS instead of the I/A Series
History Provider.
Hardware Requirements
The minimum hardware requirements for the Wonderware Historian are based
on the tag count and the anticipated data throughput. If the Historian’s tag
count exceeds 70,000 tags or if the anticipated data storage rate exceeds 30,000
values per second, a more powerful server has to be used or a proportional
number of AW70/WSVR70 servers have to be added to the system. As
multiprocessor and multicore AW70/WSRV70 servers are not currently
available, if a more powerful server is selected, it has to be located on a
separate network, because only Foxboro stations can be connected to The
Foxboro Evo Control Network. Consult the IndustrialSQL Server 9.0
Installation Guide for guidance on selecting a non-Control Core Services
server.
Note Each collecting workstation can collect upto 30,000 tags. If more
tags are needed, a proportional number of collecting workstations will be
needed. Refer to Foxboro Evo Control Software Deployment Guide
(B0750BA) for additional sizing considerations.
3. Once the redundant configuration has loaded, perform this action to sync
up the existing tags to the redundant collector:
• Perform Refresh History from IDE Menu
NOTICE
POTENTIAL DATA LOSS
After this step is completed, the list of tags to be historized for each
primary collector is duplicated and downloaded to the backup collector.
Any subsequent deployment of newly historized tags will follow the rules
defined in the redundant configuration file. The newly deployed tags will
be historized by both the primary and backup history collectors.
Restrictions
1. Primary-Backup association is one to one only.
a. There is only one backup collector per primary collector.
b. A collector can backup only one primary collector.
2. A collector cannot be used as both a primary and a backup collector. For
example, if AW001A is configured as the collector for one or more
compounds in Control Editors, it can't also be specified as a backup
collector in the redundant configuration XML file.
3. Every time the redundant configuration file is loaded, a new redundant
configuration database is created, replacing the previous redundant
specification. Therefore, the redundant configuration file needs to contain
the redundant collector definitions, as the previous redundant definitions
are removed and are not collected in the backup collector.
4. Redundant configuration data is stored in InFusionDeployedDB, which is
a runtime database and is not backed up. Save the redundant configuration
XML file in a separate location - it needs to be backed up manually in
order to add, modify, or delete the collectors.
5. While the redundant configuration is being loaded, do not perform
deployment operation.
Note With this method, the Wonderware Historian can either be configured to
use redundancy (by specifying a Failover Node) or can operate in Store
Forward Mode, but not both.
When configuring InSQL to collect from the IADAS, use these settings for the
IDAS configuration:
• Create IADAS: Import I/A Series OPC DI Object into a Galaxy,
create an instance of the OPC DI Object and assign it to an
Application Engine. Refer to “I/A Series OPC Device Integration
Object Import and Assignment” on page 40 for information to import
and deploy the OPC DI object.
• Set Application to IADAS.exe
• Set Topic to IASeries
Note The I/A Series Device Integration Object does not use the IADAS.
Therefore, you need to create and deploy the I/A Series OPC DI Object to
enable this method.
Figure 3-5. I/A Series History Object Editor - OM List Manager Tab
Table 3-1 lists the configuration options for the OM List Manager tab.
Attributes Description
OM Simulation Mode When OM simulation mode checkbox is selected,
the History Object provides simulated data for the
requested tags rather than actually providing
access to the Foxboro Evo system through the
OM. This option has to be selected for testing and
troubleshooting.
In simulation mode, the History Object returns a
floating point value that increments at a rate of
100 ms for each tag (unless preconfigured to
return a different type). When a tag is written to,
the write is silently rejected. A system message is
logged in the SMC log file whenever the History
Object is started in simulation mode, because this
is not a normal mode of operation.
Note If Enable Tag Hierarchy option is not selected, you can still select
tags under All Analog Tags, All Discrete Tags, or All String Tags.
4. Click to the right of the Historian text box to browse for and select an a
Wonderware Historian Server, if the correct workstation is not already
selected.
5. Save the changes and close the editor.
Redundant History
To implement redundant history collection, if the history object is present on
the backup workstation, it has to be removed, and the primary workstation has
to be identified in the compounds from which the samples are to be collected.
The steps given here provide an overview of setting up redundant collection.
For detailed instructions, refer to Wonderware FactorySuite A2 Deployment
Guide.
1. Select the backup workstation in the Deployment tab, if present; undeploy
and delete the History App Engine, its Area, and History Object (that were
created and deployed by the Control Software’s install program), if
present.
2. Enable redundancy using the Redundancy tab of the Primary App Engine.
3. Drag the backup out of the Unassigned Host folder to the Backup
Platform, as shown in Figure 3-7.
The table at the top of the tab lists the currently selected parameters with their
scan rate, dead band, and other collection attributes described in Table 3-2.
Attribute Description
Description This optional description of the point can be up to
512 characters long.
Engineering Units A text string with a length up to 32 characters that
is used to identify the unit of measure.
Force Storage Period The interval, in milliseconds, at which the value
has to be stored even if it has not changed by at
least the dead band. This timer is reset each time
the value is stored. Set the attribute to 0 to disable
forced storage. Set the attribute to a value
between 0 and the scan rate to store the value with
every scan.
Scan Rate The rate, in milliseconds, at which the Object
Manager scans the point for collection.
Trend High, Trend Low Default maximum and minimum of the default
value scale for trend clients.
Dead Band Minimum change in the value for the value to be
stored. The value is not stored if the change since
the last time the value was stored is less than the
dead band. Set the attribute to 0 to store the value
at every scan.
On Message, Off Message Custom message strings of up to 64 characters
each for Boolean-type parameters. The default on
and off messages are TRUE and FALSE,
respectively.
Field Description
TagCntTotal Total tags configured, that is, added to the
History object
TagCntAddedToLM Tags added to the OM List Manager
TagCntConnectedToIA Tags successfully opened in OM list
TagCntRegisteredToBHP Tags requested to be registered with the
Wonderware Historian
TagCntReadyToHistorize Tags successfully registered with the
Wonderware Historian
Field Description
ExecutionCnt Increments each application engine scan cycle
TotalSampleCnt Total count of samples sent to the Wonderware
Historian
SamplesPerSecond Samples per second sent to the Wonderware Historian
OMScansPerSecond OM scans per second, per configured scan rates
HistInfoFilter Specifies which tags will be logged into the SMC. It
allows the ‘*’ wild character in the filter. This attribute
has to be used with combination of
“HistTagDataChangeDetail” log flag. If this log flag is
set in the SMC, the entries will be logged in the SMC
based on the value of the HistInfoFilter.
The filter setting that can be applied in HistInfoFilter
is:
• " ": log no parameter and history data will not be
generated. This is the default setting.
• <blank>: log all the tags
• *: log all the tags
• CompName.*: log all the tags for the
CompName compound
• CompName*: log all the tags for the compounds
for which the name starts with CompName
• CompName.BlockName.*: log all the tags for
the block present in the specified compound name
• *.ParamName: log all the tags for the specified
parameter.
• CompName.BlockName. ParamName: log the
tag for the specified parameter in the given
compound block hierarchy.
Examples of the filter string:
1)“COMPND_001*” -log all tags into SMC for any
compound the starts with COMPND_001
2)“*.MEAS” - log all tags into SMC with parameter
MEAS
3)“*” - log all tags into SMC
4. Run SMC. To view messages from the I/A Series History Provider and
other ArchestrA components, select:
Log Viewer > Galaxy > Lbug_Plat
where Lbug is the name (letterbug) of the collecting workstation.
These custom log flags are used to specify where to dump the requested data.
1. HistDumpToSMC
This flag is used to log the data in the SMC for the specified dump log
flag.
The dump files are created in the <FoxDrive:/>.HistoryObjectDumps
directory. The dump file names will be in the format of
<DumpLogFlagName><Index>.txt.
For example, if HistDumpConfig flag is set along with the
HistDumpToFile flag, a log file with the name HistDumpConfig1.txt is
created for the entire log associated with HistDumpConfig at this location:
D:\HistoryObjectDumps\HistDumpConfig1.txt
2. HistDumpToFile
This flag is used to log the data in file for the specified dump log flag.
If both the above flags are not set (unchecked state), then the History
Object generates an info message in the SMC and does not execute dump.
These five dump log flags can be used to dump to the SMC or to a file,
based on the selection of HistDumpToFile flag or HistDumpToSMC flag:
a. HistDumpCfg
b. HistDumpSampleCount
c. HistDumpRuntime
d. HistDumpRuntimeDetail
e. HistDumpTimes
3. HistConfigureTagsDetail
This flag logs the data in the SMC on configuring such as adding or
modifying any history parameter. For example, if the user changes
historize MEAS parameter from 10 to 20, an entry is logged for modifying
the value to 20.
For the I/A Series Data Server (IADAS), refer to Industrial SQL Server
Historian Administration Guide.
2. Stop the InSQL Data Acquisition System (IDAS). You have to always stop
the InSQL service if manually changing the clock backwards.
3. Record the time at which the Historian Collectors are stopped.
4. Double-click the clock in the Windows Taskbar. In the Date and Time
Properties dialog box, change the time backwards.
5. Wait the amount of time which you changed the station time in step 2. If
you changed the time from 5:45 AM to 5:15 AM, wait 30 minutes until the
time is 5:45 AM again.
6. Start your Historian Collectors as described above.
NOTICE
POTENTIAL DATA LOSS
NOTICE
POTENTIAL DATA LOSS
Time Change
Figure 3-11. Time Changed in an Incorrect Manner in
SMC Log Viewer
If you need to manually change the time on your workstation, first create four
history blocks to cover the data produced during the time change. For example,
if the time is to roll back one hour at 9AM (9:00), you would create these four
history blocks:
• History block 1 - covers the time that occurs between the time of the
automatic block changeover to when the time is physically changed back;
for example, 0:00 to 8:00.
• History block 2 - covers the time between the time to which the computer
time will be rolled back, through the time at which the rollback will occur;
for example, 8:00 to 9:00
• History block 3 - after the rollback occurs, handles the time between the
start of the rollback and the time at which the rollback was scheduled to
occur; for example, 8:00 to 9:00 (after the rollback - 8:00 is the same
moment as 9:00 before the rollback as the rollback occurred at that
moment). This is referred to as the “second pass”.
• History block 4 - covers the time from when the time was physically
changed, going forward; for example, 9:00 to 24:00.
History block 1 will automatically start at the correct time; it needs to be
punctuated before you change the clock. Using the example times listed above,
you would manually force a block change at 8:00 through the SMC or using
the SQL xp as described below.
Proceed as follows:
1. Create history blocks 1 through 4.
2. Stop the Wonderware Historian Server on the workstation on which you
want to change the time manually.
a. Select Start -> Run, type “services.msc” and press <Enter>.
b. In the Services dialog box, select the Wonderware Historian Server.
On the left-hand side, click Stop the service. (It is not necessary to
disable it.)
3. If you have data coming in from remote IDAS or a remote AppServer
platform configured for Store/Forward (S/F), it is recommended that you
repeat step 2 to stop those services before changing their clocks too, if
possible. If it is not possible to stop your remote IDAS or workstation,
make any time adjustments on those workstations before stopping the
Wonderware Historian Server. This is recommended because when the S/F
mechanism kicks in upon Wonderware Historian Server stoppage, it will
use the correct time rather than forwarding incorrect timestamps later
when the Wonderware Historian Server comes back online.
4. Move the second history block to an offline folder; not in one of History
Server’s storage location folders (i.e. do not use Circular, Alternate,
Buffer, or Permanent). If you do not need to keep the “first pass” data in
this block (that is, the data in the block before the rollback), you may
delete this block.
5. Change the time manually on the relevant workstations as discussed in the
“Setting Time” section of Time Synchronization User’s Guide (B0700AQ).
6. Start the Wonderware Historian Server.
C H A P T E R 4
The I/A Series Alarm Provider reports control process alarms and system
alarms to the Control HMI and the Wonderware Alarm subsystem (Figure 4-1).
This chapter covers setup and management of this application.
Contents
• Alarm Provider Components
• Redeploying Alarm Provider
• Alarm Provider Configuration
Application Engine
Alarm Area
5. Right-click the host application engine again, select Deploy from the drop
menu, and select the Cascade Deploy option in the Deploy dialog box.
If the Alarm Provider is not functioning due to Historian settings made for the
AppA, proceed as follows to resolve it:
1. Undeploy AppA. The AppA is the application engine host of the
AlarmProvider object.
2. Open the AppA configuration in the ArchestrA IDE.
3. Verify that the Enable storage to Historian option is turned Off.
4. Redeploy AppA.
5. Reboot the workstation. (This step may not be necessary in the cases.)
Attribute Description
Discard Sort Order Use the drop-down list to select a rule for dropping alarms from the alarm
database whenever the total number of alarm items exceeds Alarm
Database Size:
• LowestPriorityOldest (default)
Remove the lowest priority alarms first; within each priority level,
remove the oldest first.
• OldestAlarms
Remove the oldest alarms first.
• AckedOldestThenUnAckedOldest
Remove the acknowledged alarms first, starting with the oldest; then
remove unacknowledged alarms, taking the oldest first.
• AckState-Priority-Time
Remove acknowledged alarms first, starting with the lowest priority
and the oldest within each priority; then remove unacknowledged
alarms, taking the lowest priority first and the oldest within each
priority.
• Rtn/Alm-AckState-Priority-Time
Remove alarms where the condition has returned to normal, starting
with acknowledged alarms in accordance with their priority and age.
Alarm Database Size Set the maximum number of alarms to be stored in the database. The
default is 2000. You can specify any value within the range of 10 to 32000.
Alarm Priority Specify the mapping between each of the five process control alarm
Mapping priorities and the priority to be displayed in the InTouch Alarm Panel. The
range of alarm priorities in the InTouch panel is 1 to 999. In Figure 4-3, for
example, process control priority 1 alarms are being mapped to priority 12,
and will be displayed as such in the InTouch Alarm Panel.
Note Verify that the mapping is in increasing order so that the relative
priority remains meaningful.
Alarm Recovery
The I/A Series Alarm Provider can be configured to recover the alarm states
for workstations when there is an upset in the alarm system, such as a
workstation reboot. Use the Process Alarm Recovery tab (Figure 4-4) to enable
or disable the recovery feature.
System Alarms
To view system alarms within the Alarm Panel, the System Monitor has to be
configured to send alarm messages to the workstation and the Alarm Provider
object on the workstation has to have system alarming enabled. System
alarming is enabled by default.
To configure System Monitor to send system alarms to the Alarm Provider:
• Specify a workstation as the Printer and/or Historian destination for the
messages.
This configuration is done at system definition.
The system alarms are the System Monitor (SysMon - configured as Printer
target), Historian and OAJ messages. By default I/A Series Alarm Provider
objects are enabled to receive system alarms and reported under its area (alarm
group) IASMGT.
• Use the query \IASeries!IASMGT to view only system alarms.
System alarms can be viewed in the History view only.
Note For more details, refer to the section “Alarming Overview” in Framer
and Alarm Management User’s Guide (B0750AR).
C H A P T E R 5
When compounds and blocks are configured within the Control Editors for
history and security and are deployed, the Control Editors notify the Galaxy
synchronization service (Galaxy Sync Service) to collect the configuration data
and then distribute the data to the history and security clients on the network.
Figure 5-1 depicts the Galaxy Sync Service data flow.
This chapter provides information on the Galaxy Sync Service, and describes
the refresh command and optional configuration of the service.
Contents
• Sync Service Components
• Sync Service Features
• Refreshing the History and Security Database
• Custom Configuration
• Galaxy Sync Service Utility
• Additional Configuration Details
NOTICE
POTENTIAL DATA LOSS
This procedure is designed for use after a system has been initially
configured (that is, near the end of system commissioning) or
substantially re-configured (that is, during a shutdown or maintenance
period). It may also be used after a catastrophic breakdown has
occurred that caused a database to be corrupted or similar problem.
Note The Control Editors are not able to perform deploy, undeploy, or edit
actions while the refresh process is in progress. Users have to avoid using
DirectAccess or Galaxy Sync Utility on any workstation in the Galaxy during
the refresh process.
The refresh operation process has two stages, the first of which involve
populating the security/history database with the latest deployed information,
and second stage involves transmitting the new data to the clients.
The time of these operations is dependent upon the number of CPs and other
objects deployed in the Galaxy. It could take several minutes for the first phase
to be completed. The security information will be transmitted at a rate of
60,000 tags per minute, and history tags will be transmitted 18,000 tags per
minute to the clients.
When the History information is refreshed, the second stage causes a gap in
history collection if done on a running system, because points are not
historized until the History collector object (or IASeriesHistory object)
receives the refreshed set of tags, subscribes them with OM, and registers the
tags in the designated Wonderware Historian Server. Security is retained with
the old values that last deployed until refresh operation is completed.
Refresh Procedure
The refresh operation may be performed for either:
• Security database only
• History database only
• History and Security databases simultaneously in one operation
Proceed as follows to perform the refresh operation:
1. Login as a user with Administrator privileges.
2. Check in the templates and instances.
Note If any templates or instance is checked out before the operation, this
message(Figure 5-3) will be displayed to indicate the objects have to be in
checked-in state:
9. Click Yes to initiate the Refresh process. The buttons are grayed-out and
status messages are displayed in the status listbox.
Note If more than one ArchestrA IDE is open when attempting a Refresh
operation, this dialog box(Figure 5-6) will be displayed.
Figure 5-6. More Than One ArchestrA IDE Session Dialog Box
10. When the first stage of the Refresh process is successfully completed, the
Refresh Successful dialog box is displayed (Figure 5-7).
Client workstations start receiving the history and security data as soon as the
refresh operation is done.
Note The Galaxy database will be locked briefly while the refresh operation
is in progress. During this period, users cannot open another session of
ArchestrA IDE that connects to this Galaxy.
NOTICE
POTENTIAL DATA LOSS
Custom Configuration
The Galaxy Sync Service, the SyncAgentProxy (used by the History and
Security Providers) and the SyncAgentCollector (used by the Control Editors)
can be configured using configuration files. Use of these configuration files is
optional. Each is explained in the following sections.
Note This file is read when the Galaxy Sync Service starts. If the file is
changed while the Galaxy Sync Service is running, the Galaxy Sync Service
has to be stopped and restarted, and then the database refreshed (see
“Refreshing the History and Security Database” on page 117) for the changes
to take effect.
</appSettings>
</configuration>
Key Description
SyncServerPort The port to use for the ClientActivatedObjects
other than the default port of 6523. If you change
the port, you have to change the default in the
proxy configuration file (see below) as well to
match.
SecurityMessageSize Defines how many tags are sent to Security
objects per call to the ClientActivatedObject
method GetData. Use this parameter for
performance tuning and to throttle the size of
messages traveling across the network.
HistoryMessageSize Defines how many tags are sent to History objects
per call to the ClientActivatedObject method
GetData. Use this parameter for performance
tuning and to throttle the size of messages
traveling across the network.
MutexLockEnable Enables or disables the mutex locking code used
by the Control Editors to control access to critical
resources.
BatchSize Size of bulk inserts performed for security data.
You have to cascade redeploy the local platform and restart the Control Editors
for the changes to take effect. The format for the SyncAgentProxyConfig.xml
file is as follows:
<Configuration>
<GalaxyMachineName Name=“GalaxyMachine” />
<Port Value=“6523” />
</Configuration>
Service
The Service tab page allows you to get the status of the Galaxy Sync Service
(InFusionSyncService) and to start or stop it. The location of the Galaxy Sync
Service (the name of the server where it is installed) has to be provided in the
Server name text box.
If the workstation (where the Galaxy Sync Service Utility was run) was
configured correctly, the name of the server (where the Galaxy Sync Service is
installed) will be automatically added to the Server name text box. This name
is read from the SyncAgentProxyConfig.xml file or from the Platform
mapping file.
Click the Connect button to get the current status of the Galaxy Sync Service
running on the server identified in the Server name box. This gets the current
service status and enables or disables the Start and Stop buttons, depending on
the service status. The service status may be either “Unknown”, “Error”,
“Stopped”, or “Running”.
When the utility is first started, the service status will be “Unknown” and the
Start and Stop buttons are both disabled. When the service status is “Stopped”
or “Running”, the Start and Stop buttons are enabled or disabled, respectively.
Click the Start or Stop button to start or stop the Galaxy Sync Service. The
start and stop function works just like the Windows Services control panel,
except it can be done remotely from any Foxboro Evo Control client.
NOTICE
POTENTIAL DATA LOSS
Note The Galaxy Sync Service will log start and stop messages and certain
warning and error conditions. Check the SMC Log Viewer if there are any
problems detected with the service.
If the Galaxy Sync Service Utility cannot obtain the name of the Galaxy
machine from either the Platform mapping file or from the
syncAgentProxyConfig.xml, it will display a period (“.”) in the Server
name text box, as shown in Figure 5-9. This can happen if a platform is not
deployed on the workstation where the Galaxy Sync Service Utility was
started, or if the SyncAgentProxyConfig.xml file was not found.
The period indicates that the Galaxy Sync Service Utility will use the local
host name when trying to connect to the Galaxy Sync Service. Unless the
Galaxy Sync Service Utility is run from the Galaxy server, this default is NOT
appropriate.
If you know the name of the machine that hosts the Galaxy, enter that name in
the Server name text box, otherwise, quit the utility, deploy the platform for
this workstation, or fix the configuration and try again.
Note The Galaxy Sync Service is installed by default on the server that hosts
the Galaxy so you have to type that name into the Server name text box or use
that name in the SyncAgentProxyConfig.xml file.
Initialization
The Initialization tab page allows the user to reset the deployment
synchronization locks that are managed by the Galaxy Sync Service and to
initialize the SQL Server database tables owned by the Galaxy Sync Service.
The function of the Reset Locks button is explained in this section (see
“Initialization” on page 131 for information about the Initialize History and
Security database button).
The Reset Locks button allows you to reset the Galaxy database deployment
and synchronization locks. This is necessary only in the unlikely event that an
instance of the Control Editors, running on a particular workstation, locked the
database and subsequently had an unrecoverable fault, where the Control
Editors cannot be restarted on that particular workstation. In this case, clicking
this button will allow the user to perform deployment and bulk generation
operations on another workstation.
Note Do not click the Reset Locks button while another instance of the
Control Editors (that has not had an unrecoverable failure) are accessing the
Galaxy database. Resetting the locks causes the Galaxy Sync Service to release
and reset the Galaxy database locks. This allows any other instance of the
Control Editors to concurrently access the database, which may cause
corruption of the Galaxy.
The Initialize History and Security database button is enabled when the
Galaxy Sync Service Utility is run on the Galaxy server; otherwise it is
disabled (see “Initialization” on page 131).
Security Db
The Security Db tab page allows the user to change the Security configuration
by adding transactions to the security database. The Security Db tab is only
available when the Galaxy Sync Service Utility is run on the Galaxy server.
The total number of security database transactions is also shown in this dialog.
This value is updated every five seconds.
To add transactions to the database, enter the pathname to the XML file that
contains the configuration transactions in the text box (see “History and
Security Configuration Without Using Foxboro Evo Control Editors” on
page 132 for XML file format). The buttons beside the text box can be used to
browse for and select multiple files (see Table 5-2 below). These files have to
be accessible from the station where the Galaxy Sync Service is running.
Button Description
Expand the drop down list of files.
Browse for and add files to the drop down list of files.
When new files are added to the text box, the Validate button is enabled. Click
this button to validate the XML files against the IaSecurity.xsd schema.
The number of errors detected (if any) will be shown in a status message. A
detailed description of each error detected will be added to the SMC Log. If
there are no errors detected, the Load button is enabled.
Click the Load button to add the validated transactions to the database. After
you click the Load button, the files will be removed from the text box and the
security database transaction number will increase by the number of
transactions added to the database. Since the server has to load, parse, and
validate the files, the update may take several seconds to finish.
Note When you refresh history and security, the security XML files gets
loaded at once in order to process the Reset Done command.
History Db
The History Db tab page allows you to change the History configuration by
adding transactions to the history database. The History Db tab is available
only when the Galaxy Sync Service Utility is run on the Galaxy server.
The total number of history database transactions per letterbug is shown in this
dialog box. This value is updated every five seconds.
To add transactions to the database, enter the pathname of the XML file that
contains the configuration transactions, in the text box (see “History and
Security Configuration Without Using Foxboro Evo Control Editors” on
page 132 for XML file format). The buttons beside the text box can be used to
browse for and select multiple files (see Table 5-3 below). These files have to
be accessible from the station where the Galaxy Sync Service is running.
Button Description
Expand the drop-down list of files.
When new files are added to the text box, the Validate button is available.
Click this button to validate the XML files against the IaHistory.xsd
schema. The number of errors detected (if any) will be shown in a status mes-
sage. A detailed description of each error detected will be added to the SMC
Log. If there are no errors detected, the Load button is available.
Click the Load button to add the validated transactions to the database. After
the Load button is clicked, the files will be removed from the text box and the
history database transaction number per letterbug will increase by the number
of transactions added to the database. Since the server has to load, parse, and
validate the files, the update could take several seconds to finish.
Initialization
The Initialization tab page allows you to reset the deployment
synchronization locks that are managed by the Galaxy Sync Service and to
initialize the SQL Server database tables owned by the Galaxy Sync Service.
The function of the Initialize History and Security database button is
explained in this section (see “Initialization” on page 126 for information
about the Reset Locks button).
Clicking the Initialize History and Security database button will initialize
the SQL Server database tables owned by the Galaxy Sync Service.
Initialization removes the History and Security data from the SQL Server
database tables and increments the database reset count. This returns the
database to its original state and prepares it for an entirely new data set. This
button has to only be used if the Galaxy Sync Service Utility will be used
subsequently to load History and Security configuration data for compounds
and blocks. This button is available when the Galaxy Sync Service Utility is
run on the Galaxy server; otherwise it is not available.
Note The XML file has to be in UTF-8 format. Verify that your XML editor is
set to this format.
Note It is recommended that either the Control Editors or XML files are used
to configure history or security, but NOT both. This is because these two
configuration mechanisms are independent of each other and changes made
using XML files are NOT reflected in the Control Editors (or vice versa).
History Configuration
History XML files can be used to configure historical data collection on
systems that do not use the Control Editors to configure compounds and
blocks. Historical data can be collected for both compound and block
parameters.
To configure historical data collection without the Control Editors, create one
<Parameter /> node for each compound or block parameter you want to
collect historical data for. These nodes have to be child nodes of a
<Compound /> or <Block /> node. The exact format of the History XML
file is specified in the history schema file IAHistory.xsd. This specification
is summarized below.
The History XML file has the format as shown in this example.
<Compound Name="COMPND_001">
<HistoryTarget Name="AWXP05" />
<Parameter Name="ON" DBAction="Delete" />
</Compound>
</Deployment>
</HistoryData>
The Compound and Block nodes are used to identify the compound or block
for which historical data has to be collected. These nodes have to be nested
within a <Deployment> node, which have to be nested within a
<HistoryData> node as shown in Figure 5-15.
When a Compound node is used, the Compound attribute Name is needed. Each
Compound has to have one HistoryTarget node. The HistoryTarget
attribute Name is needed.
When a Block node is used, the Block attributes Name and Compound are
needed. Each Block has to have one HistoryTarget node. The
HistoryTarget attribute Name is needed.
The HistoryTarget attribute Name is the letterbug of the workstation that
will be historizing the tags in the Compound or Block. For a redundant
application engine pair, this has to be the letterbug of the primary workstation
in the redundant pair.
For both Compound and Block, the Parameter node attributes Name and
DBAction are needed. Other Parameter attributes are optional. The default and
valid range of each Parameter is shown in Table 5-4
Compound Attributes
Name N/A (required) 1 to 12 characters
Block Attributes
Name N/A (required) 1 to 12 characters
Compound N/A (required) 1 to 12 characters
HistoryTarget Attributes
Name N/A (required) 6 characters
DBAction N/A (optional) “Add”, “Modify”, or “Delete”
Parameter Attributes
Name N/A (required) 1 to 6 characters
DBAction N/A (required) “Add”, “Modify”, or “Delete”
Description “” (empty string) 0 to 512 characters
EngUnit “” (empty string) 0 to 32 characters
ForceStoragePeriod 0 Minimum value of 0 to maximum
integer value
OnMsg “TRUE” 0 to 64 characters
OffMsg “FALSE” 0 to 64 characters
ScanRate 1000 100 and 500 to 10,000 in
increments of 500
TrendHigh 100.0 Any valid floating point value
TrendLow 0.0 Any valid floating point value
ValueDeadBand 0.1 0.0 and 0.000001 to 1000000.0
The purpose of the History Collection Attributes is described in “Configuring
Historian Connections” on page 95.
Tip Consider creating one History XML file for each I/A Series History
Provider and naming the files history_<LETTERBUG>.xml, where
<LETTERBUG> corresponds to the station name where the I/A Series History
Provider is deployed (History Target Name).
Default Value
You can modify the default values of schema files if needed. The defaults are
defined in the following section of the IAHistory.xsd file. To change a
default value, verify that you change only the text within the quotes (“”) after
default=. Be careful not to modify any other portion of this file, since other
changes can cause the system to not function properly. While changes to the
defaults are validated, there is no meta-schema to validate changes to other
portions of the schema.
<xs:group name="targetContent">
<xs:sequence>
<xs:element name="Parameter" minOccurs="1" maxOccurs="unbounded" >
<xs:complexType>
<xs:attribute name="Description" type="Description" default="default=""
use="optional" />
<xs:attribute name="EngUnit" type="EngUnits" default=""
use="optional" />
<xs:attribute name="ForceStoragePeriod" type="ForcedStoragePeriod"
default="0" use="optional" />
<xs:attribute name="OnMsg" type="Message" default="TRUE"
use="optional" />
<xs:attribute name="OffMsg" type="Message" default="FALSE"
use="optional" />
<xs:attribute name="ScanRate" type="ScanRate" default="1000"
use="optional" />
<xs:attribute name="TrendHigh" type="xs:float" default="100.0"
use="optional" />
<xs:attribute name="TrendLow" type="xs:float" default="0.0"
use="optional" />
<xs:attribute name="ValueDeadBand" type="DeadBand" default="0.1"
use="optional" />
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:group>
To configure security without the Control Editors, create one <Parameter />
node for each compound or block parameter for which you want to set
parameter Write security. These nodes have to be child nodes of a <Compound
/> or <Block /> node. The exact format of the Security XML file is specified
in the security schema file IASecurity.xsd. This specification is
summarized below.
The security XML file has the format as shown in this example.
<SecurityData>
<Deployment>
</Deployment>
</SecurityData>
The Compound and Block nodes are used to identify the compound or block
for which a non-default Security Classification is to be used. These nodes have
to be nested within a <Deployment> node, which have to be nested within a
<SecurityData> node as shown in Figure 5-17.
When a Compound node is used, the Compound attribute Name is needed. Each
Compound has to have one SecurityGroup node. The SecurityGroup
attribute Name is needed.
When a Block node is used, the Block attributes Name and Compound are
needed.
For both Compound and Block, the Parameter node attributes Name and
DBAction are needed. The default and valid range for each parameter is
shown in Table 5-5.
Compound Attributes
Name N/A (required) 1 to 12 characters
Block Attributes
Name N/A (required) 1 to 12 characters
Compound N/A (required) 1 to 12 characters
SecurityGroup Attributes
Name N/A (required) any valid string
DBAction N/A (optional) “Add”, “Modify”, or “Delete”
Parameter Attributes
C H A P T E R 6
Contents
• Introduction
• Security Information Distribution
• Using Write Access Security
• Security Database
• Enabling Galaxy Authentication
Introduction
Each block parameter and compound parameter has one of these ArchestrA
Security Classifications:
Security
Classifications Description
Free Access Any user can write to these attributes. Needs no
privileges.
Operate Operators can write to these attributes during normal day-
to-day operations. This the default setting.
Tune Engineers involved in a tuning activity can write to these
attributes.
Configure Writing to these attributes involves a significant
configuration change, requiring the object to be off scan.
Secured Write Operators can write to these attributes with a forced re-
authentication.
Verified Write Operators can write to these attributes. Similar to Secured
Write, except that a second user authorization is also
needed.
Read Only Attributes are not written in the Foxboro Evo system
environment.
Each parameter is also associated with a Security Group, as defined by the user
in the IDE or by using DirectAccess.
Note Foxboro Evo shared variables are not configured in the Control Editors.
Tags of this type have the Free Access Security Classification by default and
are members of the Default Security Group.
Note While on scan, the Configure Security Classification functions like the
Read Only Security Classification. This means that any tag with the Configure
classification is read-only by default when accessed through the I/A Series
Device Integration Object.
Note Foxboro Evo shared variables are not configured in the Control Editors.
Tags of this type have the Free Access Security Classification by default and
are members of the Default Security Group.
Security Database
The local security database is a Microsoft SQL Express database containing
custom and default Security Classifications for parameters and compounds.
Additionally, you can configure system-wide initial security in the default
security parameter XML file and those values for default parameter and default
Group are also stored in the local database. See the Chapter 5, “Galaxy Sync
Service” for more information on the SecurityParameterDefaults.xml file.
This security database is built during the installation of the Control Software.
A P P E N D I X A
ArchestrA uses OPC quality value. Table A-1 provides a quick reference for
OPC quality values (consult the OPC documentation for more information).
The low 8 bits of the OPC Quality Word are defined in the form of three bit
fields; Quality, Sub-status and Limit status. The high 8 bits of the Quality Word
are reserved for Vendor Quality. The Quality Word is arranged as shown in
Table A-1, where Q = Quality, S = Status, L = Limits and V = Vendor.
The Vendor Quality is as shown in Table A-3. Foxboro defines these values,
since Foxboro is the Vendor of this product.
Table A-4 shows the mapping between I/A Value Status and OM Connection
Status to OPC and Vendor Quality.
Note Although Table A-4 appears to show a direct correlation between I/A
Status and Vendor quality, the mapping is not direct, because OPC Quality
(with the exception of Limits) is mutually exclusive and I/A Status is not. For
example, when I/A Value Status is both Bad and Out Of Service,
OPC_QUALITY_OUT_OF_SERVICE will be set.
Table A-4. Value Status and OM Connection Status to OPC Vendor Quality Mapping
Propagation Error
Single Connect
Out Of Service
Disconnected
No Response
Limited High
Limited Low
On Scan
Init ACK
Deleted
Secure
Quality
OPC_LIMIT_OK
OPC_LIMIT_LOW X
OPC_LIMIT_HIGH X
OPC_LIMIT_CONST
Table A-4. Value Status and OM Connection Status to OPC Vendor Quality Mapping
(Continued)
Downstream Error
Propagation Error
Single Connect
Out Of Service
Disconnected
No Response
Limited High
Limited Low
On Scan
Init ACK
Deleted
Secure
OPC and Vendor
Bad
Quality
OPC_QUALITY_BAD X[1] X[1] X[3] X[1] X[1]
OPC_QUALITY_CONFI X
G_ERROR
OPC_QUALITY_NOT_C X[2]
ONNECTED
OPC_QUALITY_DEVIC X
E_FAILURE
OPC_QUALITY_SENSO
R_FAILURE
OPC_QUALITY_LAST_ X[4]
KNOWN
OPC_QUALITY_COMM X[4]
_FAILURE
OPC_QUALITY_OUT_O X
F_SERVICE
OPC_QUALITY_WAITI X[2]
NG_FOR_INITIAL_DAT
A
OPC_QUALITY_UNCER X
TAIN
OPC_QUALITY_LAST_
USABLE
OPC_QUALITY_SENSO
R_CAL
OPC_QUALITY_EGU_E
XCEEDED
OPC_QUALITY_SUB_N
ORMAL
OPC_QUALITY_GOOD
OPC_QUALITY_LOCAL
_OVERRIDE
VENDOR_STATUS_NO
NE
VENDOR_STATUS_ON_ X
SCAN
Table A-4. Value Status and OM Connection Status to OPC Vendor Quality Mapping
(Continued)
Downstream Error
Propagation Error
Single Connect
Out Of Service
Disconnected
No Response
Limited High
Limited Low
On Scan
Init ACK
Deleted
Secure
OPC and Vendor
Bad
Quality
VENDOR_STATUS_SEC X
URE
VENDOR_STATUS_DO X
WN_STREAM_ERROR
VENDOR_STATUS_INIT X
_ACK
Notes:
1. When any OPC bad quality sub-status is set, it also indicates
OPC_QUALITY_BAD.
2. When an Item is first requested from the ArchestrA client, its quality will
be set to OPC_QUALITY_WAITING_FOR_INITIAL_DATA. Once the
client accepts the request, the quality will be set to
OPC_QUALITY_NOT_CONNECTED. Once the client has received data
from I/A, the quality will be set according to the mapping. If the Item was
placed on an OM List and the Item is not found, the quality will remain
OPC_QUALITY_NOT_CONNECTED. This may happen if the station
was disconnected when the client made the request, since the OM does not
automatically reconnect OM Lists for disconnected stations (this is an OM
limitation).
3. Data obtained without using an OM Connection has a NoResponse OM
Connection Status by default and this is not mapped to
OPC_QUALITY_BAD.
4. OPC Quality is set to OPC_QUALITY_LAST_KNOWN when a value
was previously returned for that data Item; otherwise OPC Quality is set to
OPC_QUALITY_COMM_FAILURE. When OPC Quality is set to
OPC_QUALITY_COMM_FAILURE, no value or type information will
accompany the data Item. OPC_QUALITY_COMM_FAILURE will only
be returned for polled Items. Scanned Items will return either
OPC_QUALITY_LAST_KNOWN or
OPC_QUALITY_NOT_CONNECTED in this situation (see note 2
above).
OPC Quality and Vendor Quality are shown in the SMC as a single hex value.
Some common values are shown in Table A-5. Note that this table does not
provide the possible combinations of OPC Quality and Vendor Quality, only
some common examples.
B E
BatchSize in the Sync Service configuration extensions 63
file 122 access 68
bit data extensions 76 bit data extensions 76
block parameters in Foxboro Evo tags 30, 58 bytes data extensions 76
Block Read and Block Write tabs data 76
exporting and importing blocks 47 deadband data extensions 77
Block Read tab 48 frequency 70
Block Write tab 49 mask data extensions 77
bytes data extensions 76 packing 79
status data extensions 78
C
summary of tag extensions rules 65
collecting workstation for Wonderware
type data extensions 79
Historian 95
compound parameter in Foxboro Evo tags 30, Extensions pane 13
58 extensions to Foxboro Evo tags
configuration files for the Galaxy Sync packing 79
Service 120
Configuration Generator 15 F
configuring historian connections 95 Force all Tag Names to Upper Case 43
configuring the I/A Series Device Integration Foxboro Evo Control HMI 1
Object 42 frequency extensions to Foxboro Evo tags 70
configuring the I/A Series History Provider 89
configuring the IADAS 44 G
Connection heartbeat period 43 Galaxy Browser 1
Control Editors 2 Galaxy in a Foxboro Evo tag 30, 58
Galaxy Sync Service 115, 117
D configuration file parameters 122
DAServer tab for the I/A Series Device configuring the Sync Agent 122
Integration Object 44 custom configuration 120
data extensions to Foxboro Evo tags 76
149
B0750AD – Rev S Index
150
Index B0750AD – Rev S
T
tag syntax 57
topic in a Foxboro Evo tag 58
type data extensions 79
U
Use scan group name as access path 43
V
Value field in the I/A Series Browser 14
Verifying 98
W
Wonderware Historian 81
collecting platform and application engine
statistics 93
configuring historian connections 95
configuring the I/A Series History Provider 89
151
Schneider Electric Systems USA, Inc.
38 Neponset Avenue
Foxborough, MA 02035-2037
United States of America
www.schneider-electric.com