Guide Openenterprise Opc Client Rdi Configuration Reference Guide en 132836
Guide Openenterprise Opc Client Rdi Configuration Reference Guide en 132836
D301518X412
April 2012
Contents
1 OPC Client RDI Configuration Tool........................................................................................ 1
1.1.1 Initial Use of the Configuration Tool ............................................................................. 1
1.2 The OPC Client RDI Tables................................................................................................ 1
1.3 The Main Interface .............................................................................................................. 2
1.3.1 File Menu ...................................................................................................................... 2
1.3.1.1 Export..................................................................................................................... 3
1.3.1.2 Import ..................................................................................................................... 3
1.3.1.3 Exit ......................................................................................................................... 3
1.3.2 Help Menu .................................................................................................................... 3
1.3.3 Initial Node.................................................................................................................... 3
1.3.3.1 Context Menu......................................................................................................... 4
1.3.4 OPC Client Driver Node ............................................................................................... 4
1.3.4.1 Context Menu......................................................................................................... 4
1.3.5 OPC Server Node......................................................................................................... 4
1.3.5.1 Context Menu......................................................................................................... 4
1.3.6 OPC Device Node ........................................................................................................ 5
1.3.6.1 Context Menu......................................................................................................... 5
1.3.7 OPC Group Node ......................................................................................................... 5
1.3.7.1 Context Menu......................................................................................................... 5
1.3.8 OPC Item Node ............................................................................................................ 6
1.3.8.1 Context Menu......................................................................................................... 6
1.3.9 Add Button .................................................................................................................... 6
1.3.10 Modify Button ............................................................................................................ 6
1.3.11 Delete ........................................................................................................................ 7
1.3.12 Close Button.............................................................................................................. 7
1.4 The Configuration Dialogs .................................................................................................. 7
1.4.1 OPC Driver Dialog ........................................................................................................ 7
1.4.1.1 OPC Driver Name .................................................................................................. 7
1.4.1.2 OPC Driver Address............................................................................................... 8
1.4.1.3 Disable ................................................................................................................... 8
1.4.1.4 Retry Period ........................................................................................................... 8
1.4.1.5 Check Period.......................................................................................................... 8
1.4.1.6 Access Area ........................................................................................................... 8
1.4.1.7 Convert Timestamp................................................................................................ 8
1.4.2 OPC Server Dialog ....................................................................................................... 9
1.4.2.1 OPC Server Name ................................................................................................. 9
1.4.2.2 Driver Name ........................................................................................................... 9
1.4.2.3 Disable ................................................................................................................... 9
1.4.2.4 OPC Server Prog ID............................................................................................... 9
1.4.2.5 OPC Server Location ........................................................................................... 10
1.4.2.6 OPC Server Status Check Enable ....................................................................... 10
1.4.2.7 OPC Server Status Check Period........................................................................ 10
1.4.2.8 OPC Server Status Check Timeout ..................................................................... 10
1.4.2.9 OPC Server Auto Restart Enable ........................................................................ 10
1.4.2.10 OPC Server Restart Period ................................................................................ 10
1.4.2.11 OPC Server Locale............................................................................................. 10
1.4.2.12 Access Area........................................................................................................ 10
-i-
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.4.2.13 OK Button ........................................................................................................... 10
1.4.2.14 Cancel Button ..................................................................................................... 10
1.4.3 OPC Device Dialog..................................................................................................... 11
1.4.3.1 OPC Device Name............................................................................................... 11
1.4.3.2 OPC Network Name............................................................................................. 11
1.4.3.3 Disable ................................................................................................................. 11
1.4.3.4 Access Area ......................................................................................................... 11
1.4.3.5 OK Button............................................................................................................. 11
1.4.3.6 Cancel Button....................................................................................................... 11
1.4.4 OPC Group Dialog...................................................................................................... 12
1.4.4.1 OPC Group Name................................................................................................ 12
1.4.4.2 Device Name........................................................................................................ 12
1.4.4.3 Disable ................................................................................................................. 12
1.4.4.4 OPC Group Update Rate ..................................................................................... 12
1.4.4.5 OPC Group Percent Deadband ........................................................................... 12
1.4.4.6 OPC Group Locale............................................................................................... 12
1.4.4.7 OPC Group Time Bias ......................................................................................... 13
1.4.4.8 OPC Group Active................................................................................................ 13
1.4.4.9 OPC Group Cache Poll Type............................................................................... 13
1.4.4.10 OPC Group Device Poll Type ............................................................................. 13
1.4.4.11 Access Area........................................................................................................ 13
1.4.4.12 OK Button ........................................................................................................... 13
1.4.4.13 Cancel Button ..................................................................................................... 13
1.4.5 OPC Item Dialog......................................................................................................... 14
1.4.5.1 OPC Item Name................................................................................................... 14
1.4.5.2 Device Name........................................................................................................ 14
1.4.5.3 OPC Group .......................................................................................................... 14
1.4.5.4 Disable ................................................................................................................. 15
1.4.5.5 Tag Definition ....................................................................................................... 15
1.4.5.6 Browse for Signal Tag.......................................................................................... 15
1.4.5.7 OPC Request Data Type ..................................................................................... 15
1.4.5.8 OPC Database Table ........................................................................................... 15
1.4.5.9 OPC Item Description .......................................................................................... 15
1.4.5.10 OPC Item Units ................................................................................................... 16
1.4.5.10.1 Digital OPC Item Special Fields ................................................................... 16
1.4.5.10.2 String OPC Item............................................................................................ 16
1.4.5.11 Open Contact Label............................................................................................ 16
1.4.5.12 Close Contact Label ........................................................................................... 16
1.4.5.13 OPC Access Path ............................................................................................... 16
1.4.5.14 OPC Item Active ................................................................................................. 16
1.4.5.15 OPC Item Cache Poll Type................................................................................. 16
1.4.5.16 OPC Item Device Poll Type ................................................................................ 16
1.4.5.17 Access Area........................................................................................................ 16
1.4.5.18 Plant Area ........................................................................................................... 17
1.4.5.19 Alarm Condition Button....................................................................................... 17
1.4.5.20 OK Button ........................................................................................................... 17
1.4.5.21 Cancel Button ..................................................................................................... 17
1.4.6 Multiple OPC Tag Selection Dialog ............................................................................ 17
1.4.6.1 Flat Hierarchy - Automatic ................................................................................... 17
1.4.6.1.1 Flat Hierarchy Example .................................................................................. 18
- ii -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.4.6.1.1.1 Step 1 - Get Tags ..................................................................................... 18
1.4.6.1.1.2 Step 2 - Return Tags ................................................................................ 18
1.4.6.1.1.3 Step 3 - Select Flat Hierarchy Automatic option ...................................... 18
1.4.6.1.1.4 Step 4 - Add a New Device and Group .................................................... 19
1.4.6.1.1.5 Step 5 - Multiple Tags Added................................................................... 20
1.4.6.2 Device Based Hierarchy - Automatic ................................................................... 20
1.4.6.2.1 Device Based Example - Automatic ............................................................... 21
1.4.6.2.1.1 Step 1 - Get Tags ..................................................................................... 21
1.4.6.2.1.2 Step 2 - Return Tags ................................................................................ 21
1.4.6.2.1.3 Step 3 - Select Device-based Automatic option....................................... 21
1.4.6.2.1.4 Step 4 - Add OPC Item Dialog ................................................................. 22
1.4.6.2.1.5 Step 5 - Tags Added ................................................................................ 23
1.4.6.3 Device Based Hierarchy - Manual ....................................................................... 24
1.4.6.3.1 Device Based Example - Manual ................................................................... 24
1.4.6.3.1.1 Step 1 - Get Tags ..................................................................................... 24
1.4.6.3.1.2 Step 2 - Return Tags ................................................................................ 24
1.4.6.3.1.3 Step 3 - Select Device-based Manual option........................................... 25
1.4.6.3.1.4 Step 4- Add OPC Item Dialog .................................................................. 25
1.4.6.3.1.5 Step 5 - Tags Added ................................................................................ 26
1.4.7 Add OPC Items Dialog ............................................................................................... 27
1.4.7.1 OPC Server.......................................................................................................... 28
1.4.7.2 OPC Device ......................................................................................................... 28
1.4.7.3 New OPC Device ................................................................................................. 28
1.4.7.4 OPC Group .......................................................................................................... 28
1.4.7.5 New OPC Group .................................................................................................. 28
1.4.7.6 Add MultipleTags ................................................................................................. 28
1.4.7.7 Cancel Return of Tags ......................................................................................... 29
1.4.7.8 Cancel All Tags .................................................................................................... 29
1.5 OPC Tag Browser ............................................................................................................. 29
1.5.1 Accessing the OPC Tag Browser ............................................................................... 29
1.5.1.1 The Browse Button on the OPC Server dialog .................................................... 30
1.5.1.2 The Get Tags context menu item......................................................................... 30
1.5.1.3 The Get Tags button ............................................................................................ 30
1.5.2 Adding OPC Servers .................................................................................................. 30
1.5.3 Adding OPC Tags....................................................................................................... 31
1.5.3.1 Selecting Single Tags .......................................................................................... 31
1.5.3.2 Selecting Multiple Tags........................................................................................ 31
1.5.4 Multiple Tags - Server Node....................................................................................... 31
1.5.5 Multiple Tags - Device Node ...................................................................................... 32
1.5.6 Multiple Tags - Group Node ....................................................................................... 32
1.6 SQL Export-Import File Dialog .......................................................................................... 33
1.6.1 File Name ................................................................................................................... 33
1.6.2 File Browse Button ..................................................................................................... 33
1.6.3 OK Button ................................................................................................................... 34
1.6.3.1 Import Warning..................................................................................................... 34
1.6.4 Cancel Button ............................................................................................................. 34
1.6.5 Help Button ................................................................................................................. 34
1.7 File Import Status Dialog................................................................................................... 34
1.7.1 Import Button .............................................................................................................. 35
1.7.2 Save to File Button ..................................................................................................... 35
- iii -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.7.3 Status Pane ................................................................................................................ 35
1.7.4 Status Message.......................................................................................................... 35
1.7.5 Close Button ............................................................................................................... 35
1.7.6 Help Button ................................................................................................................. 35
2 Glossary ................................................................................................................................. 36
3 Index ....................................................................................................................................... 37
- iv -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
Additionally, the configuration tool is able to take a snapshot of the current OPC Client RDI
configuration from within an OpenEnterprise Database, and export this to an SQL script file which can
in return be imported in order to rebuild the database contents at a later date. The OPC Client RDI
Configuration tool is a member of the Toolbox suite of configuration editors, and is available from the
Toolbox window.
However, if on start-up the OPC Client RDI Configuration Tool detects that no OPC Driver table
entries are defined, it will present the user with the option to automatically add these essential table
entries.
For a more detailed explanation of the files used by the OPC Client RDI component, see the OPC
Client RDI help file.
-1-
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
At each level, the [Add], [Modify] and [Delete] buttons enable the user to add, modify or delete items
below the selected node. A context menu providing the same functionality is also available.
-2-
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.3.1.1 Export
The ability to create an Export file will only be available to the standard SYSTEM user. The
functionality will be provided through a menu on the OPC Client RDI Configuration Tool. Selection of
this option will initially cause the SQL Export-Import File Dialog to open. This dialog enables the user
to select a different Export file.
The OPC Client RDI configuration tool will then query the applicable tables and produce the required
script file. A message will inform the user that the Export file has been created.
File Menu
1.3.1.2 Import
As well as providing the ability to create a new Export file, the OPC Client RDI Configuration Tool will
also provide the ability to Import a previously created Export file. Given the potential damage that an
import might cause on an already configured system, the Import functionality will only be available to
the standard SYSTEM user.
By selecting this option the user will be presented with the SQL Export-Import File Dialog, which
enables the user to override the default Import file.
Upon selecting a file name and location the File Import Status dialog will be presented.
1.3.1.3 Exit
-3-
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
This is the initial node of the RDI Client configuration tool. The configuration tool will insert an entry into
the OPC Driver table when the tool is first used. This will show as an OPC Client RDI Driver node,
placed automatically under the initial node, eliminating the need to add this Driver yourself.
A context menu is available from this node, which enables you to Add an OPC Driver object.
Selection of the Add option will display the OPC Driver Dialog.
This is the parent node for the OPC Client RDI. For every distinct OPC Client RDI process that is to be
used on an OE Server a separate entry must be created in the OPCDriver table. Each entry will define
a unique TCP/IP socket over which the OE Database will attempt to connect to that OPC Client RDI
instance.
Note, that an entry in this table is automatically created when the OPCClientRDIDef.sql file is
included. However, it is perfectly feasible that this entry can be deleted or modified, and that
additional OPCDriver table entries can also be defined.
A context menu is available from this node, which enables you to Add an OPC Server object or to
Modify or Delete the selected OPC Driver object
The Add option will display the OPC Server Dialog, and the Modify option will display the OPC Driver
Dialog.
This node represents an entry in the OPC Server table. Entries within the OPCServer table define the
Prog ID and network location of any OPC Server with which the OPC Client RDI is to communicate.
Each OPCServer entry must be associated with a parent entry in the OPCDriver table.
A context menu is available from this node, which enables you to Add, Modify or Delete an OPC
Device object, and also to Get Tags from the selected OPC Server object.
-4-
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
The Add option will display the OPC Device Dialog, the Modify option will display the OPC Server
Dialog, and the Get Tags option will display the OpenEnterprise Tag Browser with the selected OPC
Server object already selected for browsing.
This node represents an entry in the OPCDevice table. The OPCDevice table is a placeholder table
used to allow an arbitrary grouping of signals into real or virtual field devices. The OPC Data Access
standard has no concept of devices, and this table is required purely to conform to the table
architecture required by OpenEnterprise device drivers.
Each OPCDevice table entry will reference a parent OPCServer table entry.
A context menu is available from this node, which enables you to Add a Group to the selected OPC
Device, pr to Modify or Delete the selected Device object. A fourth option enables you to Get Tags
from the OPC Server to which the selected Device belongs.
The Add option will display the OPC Group Dialog, the Modify option will display the OPC Device
Dialog, and the Get Tags option will display the OpenEnterprise Tag Browser with the selected OPC
Server object already selected for browsing.
This node represents an entry in the OPCGroup table. The OPCGroup table is used to group OPC
Items together and defines how the OPC Client RDI should collect those items from the parent OPC
Server.
Each OPCGroup table entry must be associated with a parent OPCDevice table entry.
A context menu is available from this node, which enables you to Add an OPC Item object or to
Modify or Delete the selected OPC Group object.
-5-
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
The Add option will display the OPC Item Dialog, the Modify option will display the OPC Group Dialog,
and the Get Tags option displays the OpenEnterprise Tag Browser with the selected OPC Server
object already selected for browsing.
This node represents an individual entry in one of the OPCItem tables, and refers directly to signal
data. There are four OPC Item tables; one for each of the signal data types currently supported by
OpenEnterprise.
• OPCItemRealAnalog
• OPCItemIntegerAnalog
• OPCItemDigital
• OPCItemString
Each OPC Item must be associated with a parent OPCDevice and OPCGroup table entry.
Note, that different types of OPC Item can be added to the same OPC Group, (and OPC Device).
Some of the Items in different Groups have been left to show their value as returned from the
relevant OPC Server (i.e. as a Tag String). Other Items have been modified to remove all but the
signal name from the Tag.
A context menu is available from any OPC Item node, which enables you to Modify or Delete the
selected OPC Item object.
Configuration Dialogs
Configuration Dialogs
-6-
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.3.11 Delete
This option allows you to delete the selected node, the database entry that it represents and any
dependant configuration - e.g. if an OPC Group entry is deleted, then all OPC Items that reference
that Group will be deleted also. A confirmation dialog will require you to confirm the deletion before it
takes place. At this stage it is possible to abort the deletion by selecting the [No] button. If the [Yes]
button is selected, the deletion takes place immediately.
The OPC Driver name must be unique within the OPCDriver table.
-7-
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.4.1.2 OPC Driver Address
The OPC Driver address is the name of a TCP port defined in the Services file found in the
\Windows\System32\Drivers\Etc directory. The OPC Client RDI connects to the OpenEnterprise
database via this port. If a second OPC Driver is required, then a new TCP port will need to be
defined.
1.4.1.3 Disable
Checking this option will disable the object being configured. It can be enabled at a later stage by
selecting the box again, which will remove the check.
Specifies the minimum time in seconds that will elapse before the OpenEnterprise database attempts
another connection with the OPC Client RDI, should there be a connection failure. Possible values
for this field lie within the range of 1 to 20,864 seconds.
This is the time period that the OpenEnterprise database checks the OPC Client RDI driver, to see if it
is working when no other activities are going on.
This field defines the Access Area of the object. A drop-down list reveals all available Access Areas
for selection.
Indicates to the OPC Client RDI instance whether it should convert timestamps sourced from the OPC
Server into UTC based on the timezone of the OpenEnterprise Server.
-8-
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
The OPC Server name must be unique within the OPCServer table.
This non-editable field displays the OPC Client Driver that is referenced by this OPC Server.
1.4.2.3 Disable
Checking this option will disable the object being configured. It can be enabled at a later stage by
selecting the box again, which will remove the check.
This field must contain the Program ID of the OPC Server. If you are unsure as to what this Program
ID is, it can be browsed for by selecting the Browse button [...] to the right of the field. This will open
the OpenEnterprise Tag Browser, which will enable you to select the required OPC Server.
-9-
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.4.2.5 OPC Server Location
If the OPC Server is located on a remote computer, the name of the remote computer should be
entered here. It will be placed here automatically after using the Browse [...] button to search for a
remote OPC Server.
If this box is checked, status checking of the OPC Server by the OPC Client RDI is enabled.
This is the period, in seconds that will elapse between successive checks of the OPC Server's status.
Possible values lie in the range of 1 to 20, 864 seconds.
This is time that is allowed to elapse for a reply to an OPC Server status check before the current
status check is aborted and the OPC Client RDI assumes that the OPC Server is dead. If Auto
Restart of the OPC Server is enabled, the OPC Client RDI will then attempt to restart the OPC Server.
If this box is checked, then auto restart of the OPC Server by the OPC Client RDI will be enabled.
If an attempted restart of the OPC Server fails, this is the period that the OPC Client RDI will wait
before another restart attempt.
The Locale drop down is populated by querying the OPC Server for its available locales. However an
OPC Server may be unable to offer this information in which case the only value will be 2048, which
indicates that the native locale of the host computer will be used.
This field defines the Access Area of the object. A drop-down list reveals all available Access Areas
for selection.
1.4.2.13 OK Button
If this button is selected, the dialog will close, and changes made on the dialog will be entered into the
OpenEnterprise database.
If this button is selected, the dialog will close, but no transaction with the OpenEnterprise database
will be made. Changes made on the dialog will be lost.
- 10 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
The OPC Device name must be unique within the OPCDevice table.
This read only field displays the OPC Server with which this OPC Device is associated.
1.4.3.3 Disable
Checking this option will disable the object being configured. It can be enabled at a later stage by
selecting the box again, which will remove the check.
This field defines the Access Area of the object. A drop-down list reveals all available Access Areas
for selection.
1.4.3.5 OK Button
If this button is selected, the dialog will close, and changes made on the dialog will be entered into the
OpenEnterprise database.
If this button is selected, the dialog will close, but no transaction with the OpenEnterprise database
will be made. Changes made on the dialog will be lost.
- 11 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
The OPC Group name must be unique within the OPCGroup table.
This read only field displays the OPC Device with which this OPC Item is associated.
1.4.4.3 Disable
Checking this option will disable the object being configured. It can be enabled at a later stage by
selecting the box again, which will remove the check.
The period, in milliseconds, at which the OPC Client RDI requires any changes in data or quality, for
OPC Items within the group, to be reported.
Applicable only to real analog OPC Items within the Group and specifies the percentage change in
value within the update period which is required for a data value change to be reported to the OPC
Client RDI, by the OPC Server.
Indicates the locale in which data for this group should be returned. The default value indicates that
data should be returned using the default system locale.
- 12 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.4.4.7 OPC Group Time Bias
Used to indicate a difference in time zone between the device(s) from which the data for this group
was collected, and that in which the client and server are located. This is ignored by the Server and is
used by the OPC Client in providing correct time stamp conversion to UTC for all OPC Items within
the group. This is on top of any time zone and DST conversion configured within the OpenEnterprise
Server.
Indicates whether the OPC Group is Active and therefore if it will report unsolicited data changes to
the OPC Client RDI. As a general rule, set the OPC Group and it's OPC Items to be Active.
Indicates that when performing a force poll the item values are requested from the OPC Servers
cache rather than the device.
Indicates that when performing a force poll the item values are requested from the OPC Server's
device rather than the OPC Server's cache.
This field defines the Access Area of the object. A drop-down list reveals all available Access Areas
for selection.
1.4.4.12 OK Button
If this button is selected, the dialog will close, and changes made on the dialog will be entered into the
OpenEnterprise database.
If this button is selected, the dialog will close, but no transaction with the OpenEnterprise database
will be made. Changes made on the dialog will be lost.
- 13 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
The OPC Item name must be unique within the OPC Item tables.
This read only field displays the OPC Device with which this OPC Item is associated.
This read only field displays the OPC Group with which this OPC Item is associated.
- 14 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.4.5.4 Disable
Checking this option will disable the object being configured. It can be enabled at a later stage by
selecting the box again, which will remove the check.
The OPC Tag definition is to be entered here. It can be entered here automatically by using the
OpenEnterprise Tag Browser, which can be accessed by selection of the [Browse] button to the right
of this field.
When this button is selected, the OpenEnterprise Tag Browser opens, and the user is able to select
the OPC Server and the required Tag item. The Tag is then passed back to the Tag Definition field on
the OPC Item dialog of the OPC Client RDI configuration tool. For more information on this
component, see the OpenEnterprise Tag Browser help file.
The data format with which the OPC Client RDI will request the value for the item from the OPC
Server. This field is filled in automatically when a Tag is imported from the OpenEnterprise Tag
Browser.
The table to which the OPC Item belongs, based upon its Data Type. This field is filled in
automatically when a Tag is imported from the OpenEnterprise Tag Browser.
The user can provide a helpful description of the OPC Item here.
- 15 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.4.5.10 OPC Item Units
Special fields are displayed in this position on the dialog, depending on the type of OPC Item that is
being added. This example displays the dialog as it appears when an Realanalog or Integeranalog
Item is being added.
For Realanalog or Integeranalog types of OPC Item, the units can be added here, or may be defined
automatically if the associated OPC Server provides that information.
Different fields are displayed if the OPC Item is a Digital signal. The image below displays the fields
that would be in this position if this were the case.
If the OPC Item is a String signal, then there are no special fields to configure in this position on the
dialog.
Appropriate text should be entered here to describe the state of the signal when the contact is Open.
Appropriate text should be entered here to describe the state of the signal when the contact is Closed.
An optional attribute, which is used to specify to the OPC Server a preferred access path by which the
value for the OPC Item should be obtained.
The Active attribute, if set to FALSE, is used to indicate to the OPC Server that the OPC Client RDI is
not interested in unsolicited changes in value or quality for the item, but that it should still be available
for specific read and write events instigated by the OPC Client.
Indicates that when performing a force poll the OPC Item value should be requested from the OPC
Server's cache.
Indicates that when performing a force poll the OPC Item value should be requested from the OPC
Server's device.
This field defines the Access Area of the object. A drop-down list reveals all available Access Areas
for selection.
- 16 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.4.5.18 Plant Area
This is the PlantArea attribute of the OPC Item. It normally provides information on the location of the
actual device that the signal belongs to. It is automatically populated based on the contents of the
Plant Area table.
This button launches the Alarm Condition Configuration Tool for the configuration of local alarm
conditions for OPC Items. The identity of the OPC Item is not passed directly to the Alarm Condition
Configuration tool, so it would be advisable to copy the name of the signal from its Tag before using
this button.
1.4.5.20 OK Button
If this button is selected, the dialog will close, and changes made on the dialog will be entered into the
OpenEnterprise database.
If this button is selected, the dialog will close, but no transaction with the OpenEnterprise database
will be made. Changes made on the dialog will be lost.
This option enables you to add the returned tags to any specific single OPC Device and Group. The
Device or the Group may have been already configured, or may be configured from the Add OPC
Item dialog before the tags are added.
- 17 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
When the OK button is selected, if no Devices or Groups have yet been configured, the Add OPC
Item dialog will be presented with the OPC Device and OPC Group lists empty, and you will have to
create a new Device and Group before the Items can be added.
This example displays how the OPC Client RDI will add multiple tags from the Tag Browser when the
Flat Hierarchy: Automatic option is selected from the Multiple OPC Tag Selection dialog. Only the
OPC Server has been configured within the OPC Client RDI configuration tool prior to returning
multiple tags: -
- 18 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
Click on the New OPC Device button and add a new Device. Then click on the New OPC Group
button and add a new Group. In this example the Device will be called MyDevice and the Group will
be called MyGroup. Then click the OK button.
While the tags are being written to the OpenEnterprise database, you may see this message
informing you of the reason for any delay.
- 19 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
Each tag will have been added to the database according to its data type, to one of the following
OPCItem tables:-
• OPCItemRealAnalog
• OPCItemIntegerAnalog
• OPCItemDigital
• OPCItemString
Note that the name of each tag when first added is equivalent to its OPC String. This can be a
problem when displaying the tag name in a mimic. Since the datumaddress attribute of each OPCItem
is the actual tag name without the rest of the OPC string, the name can be changed within the
database with a single SQL statement:-
This option enables you to assign all returned tags to a single OPC Device that has already been
configured within the configuration tool. Groups will be created automatically for you, based on the
configuration of Groups within the OPC Server.
- 20 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
When the OK button is selected, the Add OPC Items dialog will appear, reflecting this configuration
option.
This example displays how multiple tags will be returned when the Device Based:Automatic option is
selected from the Multiple OPC Tag Selection dialog. A single Device has been configured in the
configuration tool prior to getting the tags from the Tag Browser.
- 21 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
While the tags are being written to the OpenEnterprise database, you may see this message
informing you of the reason for any delay.
- 22 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
Each tag will have been added to the database according to its data type, to one of the following
OPCItem tables:-
• OPCItemRealAnalog
• OPCItemIntegerAnalog
• OPCItemDigital
• OPCItemString
Note that the name of each tag when first added is equivalent to its OPC String. This can be a
problem when displaying the tag name in a mimic. Since the datumaddress attribute of each OPCItem
is the actual tag name without the rest of the OPC string, the name can be changed within the
database with a single SQL statement:-
- 23 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.4.6.3 Device Based Hierarchy - Manual
This option allows the user to make choices regarding the OPC Device or OPC Group name for each
Tag Group that is returned from the Tag Browser. This is done through the Add OPC Item dialog,
which displays each Tag Group in turn. The user can then use the default OPC Device and Group
name provided, or create a new OPC Device and Group to which the tags in the Group will be added.
When the OK button is selected, the Add OPC Items dialog will appear for each Tag Group returned
from the Tag Browser.
This example displays how multiple tags will be returned when the Device Based:Manual option is
selected from the Multiple OPC Tag Selection dialog. A single Device has been configured in the
configuration tool prior to getting the tags from the Tag Browser.
- 24 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
- 25 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
There are four options available with regard to each OPC Group that it presents to us: -
1. Accept the Group name as it is by clicking on the OK button. The OPC Client RDI
configuration tool will then present us with the name of the next Group until we have decided
what to do with each Group, or selected the Cancel All button.
2. We can rename the Group by selecting the new button and creating a new Group.
3. We can decide not to include this Group or its tags by selecting the Cancel button.
4. We can terminate the returning of the Multiple tags by selecting the Cancel All button. Any
tags from Groups that have already been accepted because we selected the OK button will
still be added.
- 26 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
Each tag will have been added to the database according to its data type, to one of the following
OPCItem tables:-
• OPCItemRealAnalog
• OPCItemIntegerAnalog
• OPCItemDigital
• OPCItemString
Note that the name of each tag when first added is equivalent to its OPC String. This can be a
problem when displaying the tag name in a mimic. Since the datumaddress attribute of each OPCItem
is the actual tag name without the rest of the OPC string, the name can be changed within the
database with a single SQL statement:-
- 27 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
This field will display any configured OPC Devices. If the Get Tags menu was selected from a Device
node, the Device will be selected and disabled. Otherwise, the field will either be blank or will be filled
with the same name as the Tag Group being returned. If the field is enabled, the New button to the
right of it will also be enabled, allowing you to create a new OPC Device.
This button opens the OPC Device dialog, enabling you to add a new OPC Device, to which the
multiple tags can be added.
This field may be filled with an OPC Group that has been configured prior to the return of tags from
the Tag Browser. It may also be filled with a Tag Group name that has been returned from the OPC
Server, or be blank, depending on what option was chosen from the Multiple OPC Tag Selection
dialog. A new OPC Group name can be created by selecting the New button.
When enabled, this button opens the OPC Group dialog, enabling you to create a new OPC Group
that the current batch of tags will belong to. Its operation depends on the option selected from the
Multiple OPC Tag Selection dialog.
When the OK button is selected, multiple tags will be returned from the OPC Server to the OPC Client
RDI configuration tool. Behaviour then depends on the option selected from the Multiple OPC Tag
Selection dialog,
- 28 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.4.7.7 Cancel Return of Tags
If the Cancel button is selected, the OPC Client RDI tool will not enter the current Tag Group from the
OPC Server into the database. If you elected to return tags by Device manually, you may be
presented with the next Group of tags from the OPC Server. Otherwise, the adding of Tags will cease,
and the Add OPC Item dialog will close.
When the option to Add multiple tags by Device manually has been selected from the Multiple OPC
Tag Selection dialog, selecting the Cancel All button stops the returning of any more Tag Groups with
their tag items. Any Groups and tags that have been accepted until the point when this button is
selected will be added to the OpenEnterprise database.
- 29 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.5.1.1 The Browse Button on the OPC Server dialog
The OPC Server Dialog is shown when you select the Add Server context menu option from the OPC
Client RDI driver node.
The Get Tags context menu item is available when you select an OPC Server, OPC Device or OPC
Group node.
The Get Tags button becomes available for use when you select an OPC Server, OPC Device or
OPC Group Node.
When the OPC Tag Browser is accessed from the OPC Server dialog, only the OPC Servers
themselves can be selected. When accessed from the Get Tags context menu or button, the Tag
Browser can be used to browse for individual or multiple tags. After the tag or tags have been
selected, a further dialog enables the user to determine how the tags should be added to the OPC
RDI Configuration.
To enable remote OPC Servers to be selected, the appropriate DCOM Security Settings must be
enabled on the remote machine to allow the current local Windows user to have access to that OPC
Server.
When the white arrow, indicated by the cursor in the image below, is selected, the Tag Browser
closes and places the Program ID of the selected OPC Server into the OPC Server Prog ID field.
- 30 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
The example below shows the selection of a single tag. The single Value tag of the
AGITATOR.SPEED.MIN Group of tags will be returned to the OPC Client RDI configuration tool.
Multiple contiguous tags can be selected by selecting various nodes from the OPC Tag Browser.
- 31 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
When this option is selected, because of the sheer number of tags that may need to be returned, you
may have to wait while the OPC Tag Browser retrieves the tags. A message will be displayed
informing you of the possibility of a delay while this process is being completed.
When the tags have been retrieved, the Multiple OPC Tag Selection dialog will be displayed. This
enables you to decide how to add the tags to your OPC Client RDI configuration.
When this option is selected, because of the sheer number of tags that may need to be returned, you
may have to wait while the OPC Tag Browser retrieves the tags. A message will be displayed
informing you of the possibility of a delay while this process is being completed.
When the tags have been retrieved, the Multiple OPC Tag Selection dialog will be displayed. This
enables you to decide how to add the tags to your OPC Client RDI configuration.
- 32 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
When the tags have been retrieved, the Multiple OPC Tag Selection dialog will be displayed. This
enables you to decide how to add the tags to your OPC Client RDI configuration.
When Importing or Exporting, this file will be selected automatically and placed in the File Name field.
The user will however have the ability to override both the name and location if they so require, using
the browse button, or by manually editing the filename.
- 33 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
1.6.3 OK Button
When selected, the appropriate action will be commenced, using the file specified in the File Name
field.
If the user is about to Import a previous configuration from a saved SQL file, then the user will also be
presented with an additional confirmation dialog, to ensure that they are aware that they are about to
overwrite their entire existing OPC Client RDI Configuration. If the [OK] button is selected from this
Message, the user will be presented with the File Import Status Dialog.
- 34 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
The entire contents of the pane can be saved to a text file by selecting the [Save to File] button.
- 35 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
2 Glossary
OE: OpenEnterprise
OPC: Object Linking and Embedding for Process Control. The industry standard COM based
method of obtaining data for commercial consumption from all kinds of process control
devices.
RDI: Realtime Device Interface. The interface between the Windows application (i.e.
OpenEnterprise) and the process control devices from which it is collecting data.
SQL: Structured Query Language. A language for interrogating and retrieving data from
Relational Databases. It is used from the SQL Client to query the OpenEnterprise database.
TCP: Transmission Control Protocol
- 36 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
3 Index
1
A OPC Driver Dialog ............................................10
Access Area ............................. 11, 12, 13, 15, 18 OPC Driver Name .............................................10
Add Button ......................................................... 9 OPC Group .......................................................16
Alarm Condition Button .................................... 18 OPC Group Active ............................................15
B OPC Group Cache Poll Type............................15
Browse ....................................................... 17, 31 OPC Group Device Poll Type ...........................15
OPC Group Dialog ............................................13
C
OPC Group Locale............................................14
Cancel Button................................. 12, 13, 15, 19
OPC Group Name.............................................14
Check Period.................................................... 11
OPC Group Node................................................8
Close Button....................................................... 9
OPC Group Percent Deadband ........................14
Configuration Dialogs....................................... 10
OPC Group Time Bias ......................................14
Convert Timestamp.......................................... 11
OPC Group Update Rate..................................14
D OPC Item Active ...............................................18
Delete Button ..................................................... 9 OPC Item Cache Poll Type...............................18
Device Name.............................................. 14, 16 OPC Item Description .......................................17
Disable ..................................... 10, 12, 13, 14, 16 OPC Item Device Poll Type ..............................18
Driver Name ..................................................... 11 OPC Item Dialog ...............................................15
E OPC Item Name................................................16
Exit ..................................................................... 6 OPC Item Node...................................................8
Export ................................................................. 6 OPC Item Units .................................................17
H OPC Network Name .........................................13
Help Menu .......................................................... 6 OPC Request Data Type ..................................17
OPC Server.......................................................31
I
OPC Server Auto Restart Enable .....................12
Import ................................................................. 6
OPC Server Dialog ...........................................11
Initial Node ......................................................... 6
OPC Server Locale ...........................................12
M OPC Server Location ........................................12
Modify Button ..................................................... 9 OPC Server Name ............................................11
O OPC Server Node ...............................................7
OK Button....................................... 12, 13, 15, 19 OPC Server Prog ID .........................................12
OPC Access Path ............................................ 18 OPC Server Restart Period ..............................12
OPC Client Driver Node ..................................... 7 OPC Server Status Check Enable....................12
OPC Client RDI Configuration Overview ........... 4 OPC Server Status Check Period.....................12
OPC Client RDI Configuration Tool Interface .... 5 OPC Server Status Check Timeout ..................12
OPC Client RDI Tables ...................................... 4 P
OPC Database Table ....................................... 17 Plant Area .........................................................18
OPC Device Dialog .......................................... 13
R
OPC Device Name........................................... 13
Retry Period ......................................................10
OPC Device Node.............................................. 8
OPC Driver Address......................................... 10 S
- 37 -
Reference Guide
D301518X412
April 2012 OPC Client RDI Configuration
Signal Tag ........................................................ 17 Tag Definition....................................................17
T
- 38 -
Reference Guide
D301518X412
April 2012
DISCLAIMER
Bristol, Inc., Bristol Babcock Ltd, Bristol Canada, BBI SA de CV and the Flow Computer Division , are wholly owned subsidiaries of Emerson Electric Co. doing business
as Remote Automation Solutions (“RAS”), a division of Emerson Process Management. ROC, FloBoss, ROCLINK, Bristol, Bristol Babcock, ControlWave, TeleFlow and
Helicoid are trademarks of RAS. AMS, PlantWeb and the PlantWeb logo are marks of Emerson Electric Co. The Emerson logo is a trademark and service mark of the
Emerson Electric Co. All other marks are property of their respective owners.
The contents of this publication are presented for informational purposes only. While every effort has been made to ensure informational accuracy, they are not to be
construed as warranties or guarantees, express or implied, regarding the products or services described herein or their use or applicability. RAS reserves the right to
modify or improve the designs or specifications of such products at any time without notice. All sales are governed by RAS’ terms and conditions which are available upon
request. RAS does not assume responsibility for the selection, use or maintenance of any product. Responsibility for proper selection, use and maintenance of any RAS
product remains solely with the purchaser and end-user.