MatrikonOPC Server For Modbus User Manual
MatrikonOPC Server For Modbus User Manual
User's Manual
MatrikonOPC Server for Modbus
User's Manual
Phone: +1.780.448.1010
Fax: +1.780.448.9191
www.matrikonopc.com
Document
Date Description Author
Version
2006-06-01 1.0 Initial document
2006-10-18 1.1 Merge from old template and update for new CB
release.
2007-06-29 2.0 Update template, general edit, update for new CD
release (i.e., Omni functionality).
2007-11-12 2.1 Updated Item syntax and installed file sections. ZA
2008-07-01 2.2 Updates for 4.3.0.0. MH
DOCUMENT VERSION
Version: 10.5
COPYRIGHT INFORMATION
© Copyright 1997 - 2017, Matrikon International. All rights reserved. No part of this document may be
reproduced, stored in a retrieval system, translated, or transmitted in any form or by any means, electronic, mechanical,
photocopying, recording, or otherwise, without prior written permission of Matrikon International.
CONFIDENTIAL
The information contained herein is confidential and proprietary to Matrikon International. It may not be disclosed or
transferred, directly or indirectly, to any third party without the explicit written permission of Matrikon International.
IMPORTANT NOTICE
Although every endeavour has been made to ensure that the information contained within this document is up
to date and accurate, Matrikon cannot be held responsible for any inaccuracy or error in the information
contained within this document. Matrikon makes no warranty of any kind with regard to the information
contained within this document and Matrikon shall not be liable for any direct, indirect, incidental or
consequential damages which may arise in connection with the furnishing, reliance, or use of the information
contained within this document.
Specifications and statements as to performance in this document are Matrikon estimates, intended for general
guidance. Matrikon reserves the right to change the information contained within this document and any
product specification without notice.
Statements in this document are not part of a contract or program product licence insofar as they are
incorporated into a contract or licence by express preference. Issue of this document does not entitle the
recipient to access or use of the products described, and such access or use shall be subject to separate
contracts or licences.
The receiving party shall not disclose, publish, report, communicate, or otherwise transfer any information in
this document to any third party, and shall protect all information contained herein from unauthorized
disclosure. The receiving party shall permit access to this document only to its employees, agents,
subcontractors, and affiliates who reasonably require access to such information contained herein, have been
made aware of the confidential nature of this document and have executed a written employment or other
confidentiality agreement party to maintain the confidential status of this document.
LICENSE AGREEMENT
This document and the software described in this document are supplied under a license agreement and may only be used
in accordance with the terms of that agreement. Matrikon reserves the right to make any improvements and/or changes to
product specifications at any time without notice.
TRADEMARK INFORMATION
The following are either trademarks or registered trademarks of their respective organizations:
OTHER
MatrikonOPC™ is a division of Matrikon™ International.
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit
(http://www.openssl.org/). Copyright © 1998-2008 The OpenSSL Project. All rights reserved.
Table of Appendices
Appendix A Distributed COM (DCOM) ...................................................................... 115
DCOM Configuration Utility ............................................................................................. 115
Default Properties .......................................................................................................... 115
Security Permissions ...................................................................................................... 116
Server Identity .............................................................................................................. 119
Default Protocols ........................................................................................................... 119
Remote Program ID ....................................................................................................... 120
Appendix B Aliases .................................................................................................. 121
Scaling Expressions ....................................................................................................... 121
Advanced Calculations ................................................................................................... 122
CSV File Format ............................................................................................................ 124
Scaling Algorithms ......................................................................................................... 126
Appendix C Standard Data Types ............................................................................. 127
Appendix D Microsoft Excel as a DDE Client ............................................................. 128
DDE Read ..................................................................................................................... 128
DDE Write .................................................................................................................... 128
Net DDE ....................................................................................................................... 129
Appendix E Configuring Dynamic Data Exchange (DDE) .......................................... 130
Table of Figures
Figure 1 - Configuration Window .................................................................................... 17
Figure 2 - Modbus Ethernet PLC Configuration Page ...................................................... 25
Figure 3 - New Modbus Ethernet PLC Node .................................................................... 27
Figure 4 - Modbus Serial Port Configuration Page .......................................................... 28
Figure 5 - New Modbus Serial Port Node ........................................................................ 31
Figure 6 - Modbus Serial PLC Configuration Page ........................................................... 31
Figure 7 - New Modbus Serial PLC Object ....................................................................... 33
Figure 8 - Modbus Serial Slave Port Configuration Page ................................................. 34
Figure 9 - New Modbus Serial Slave Port Node ............................................................... 35
Figure 10 - Modbus Serial Slave PLC Configuration Page ................................................ 36
Figure 11 - New Modbus Serial Slave PLC Object ........................................................... 37
Figure 12 - Modbus Terminal Server Configuration Page ................................................ 38
Figure 13 - New Modbus Terminal Server Node .............................................................. 39
Figure 14 - Modbus Terminal Server PLC Configuration Page ......................................... 40
Figure 15 - New Modbus Terminal Server PLC Object ..................................................... 42
Figure 16 - Modbus UDP Port Configuration Page .......................................................... 42
Figure 17 - New Modbus UDP Port Node ........................................................................ 44
Figure 18 - Modbus UDP PLC Configuration Page ........................................................... 44
Figure 19 - New Modbus UDP PLC Object ....................................................................... 46
Figure 20 - Modbus+ SA85 or PCI85 Card Configuration Page ....................................... 46
Figure 21 - New Modbus+ SA85 or PCI85 Card Node ..................................................... 48
Figure 22 - Modbus+ Device Configuration Page ............................................................ 48
Figure 23 - New Modbus+ Device Object ........................................................................ 50
Figure 24 - New Alias Group Window ............................................................................. 52
Figure 25 - Alias Configuration Page .............................................................................. 52
Figure 26 - Alias Configuration Wizard - Step 1: Alias Type ............................................ 53
Figure 27 - Alias Configuration Wizard - Step 2: Alias Identity ...................................... 54
Figure 28 - Browse OPC Tag Window ............................................................................. 55
Figure 29 - Alias Configuration Wizard - Step 3: Alias Properties ................................... 56
Figure 30 - Alias Configuration Wizard - Step 4: Scaling Algorithms .............................. 57
Figure 31 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Linear Scaling) .... 58
Figure 32 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Square Root Scaling)
....................................................................................................................................... 59
Figure 33 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Gain/Offset Scaling)
....................................................................................................................................... 60
Table of Tables
Table 1 - Terms and Definitions...................................................................................... 14
Table 2 - Supported Features ......................................................................................... 16
Table 3 - Configuration Window Components ................................................................. 18
Table 4 - Toolbar Items .................................................................................................. 19
Table 5 - File Menu Command ........................................................................................ 20
Table 6 - Edit Menu Commands (Alias Group) ................................................................ 21
Table 7 - Edit Menu Commands (Redundancy Node) ...................................................... 21
Table 8 - View Menu Commands ..................................................................................... 22
Table 9 - Window Menu Command ................................................................................. 22
Table 10 - Help Menu Command ..................................................................................... 22
Table 11 - Modbus Ethernet PLC Configuration Page Components ................................. 26
Table 12 - Modbus Serial Port Configuration Page Components ..................................... 30
Table 13 - Modbus Serial PLC Configuration Page Components ...................................... 32
Table 14 - Modbus Serial Slave Port Configuration Page Components ............................ 35
Table 15 - Modbus Serial Slave PLC Configuration Page Components ............................. 37
Table 16 - Modbus Terminal Server Configuration Page Components ............................. 38
Table 17 - Modbus Terminal Server PLC Configuration Page Components ...................... 41
Table 18 - Modbus UDP Port Node Configuration Page Components ............................... 43
Table 19 - Modbus UDP PLC Configuration Page Components ........................................ 45
Table 20 - Modbus+ SA85 or PCI85 Card Configuration Page Components .................... 47
Table 21 - Modbus+ Device Configuration Page Components ......................................... 49
Table 22 - Alias Configuration Wizard - Alias Type Components ..................................... 53
Table 23 - Alias Configuration Wizard - Step 2: Alias Identity Components .................... 54
Table 24 - Browse OPC Tag Window Components .......................................................... 55
Table 25 - Alias Configuration Wizard - Step 3: Alias Properties Components ................ 56
Table 26 - Alias Configuration Wizard - Step 4: Scaling Algorithms Component ............. 57
Table 27 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Linear Scaling) ...... 58
Table 28 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Square Root Scaling)
Components ................................................................................................................... 59
Overview of Manual
This document uses icons to highlight valuable information. Remember these icons and what they
mean, as they will assist you throughout the manual.
The User’s Manual has been designed as such so that you can click on references in the document
to jump to that referenced point without having to scroll through several pages (in some cases).
For example, if you were to see the sentence “Refer to Figure 1 for more information”, pressing the
CTRL key and clicking your mouse on the text “Figure 1” automatically takes you to the location of
Figure 1 within the document.
This manual consists of several sections and is structured as follows:
Introduction – this introductory chapter.
Getting Started – provides system requirements information.
Configuration – shows how to start and configure the server, and describes each
component in detail, including windows/screens/pages, panels, tabs, and menu commands.
OPC Data Items – describes the server’s items.
Diagnostics – explains how to use logging, statistical items, data qualities, timestamps,
and result codes to get the most efficiency from the user’s system.
References
This document references information found within the following documents/sites:
www.opcfoundation.org
www.matrikonopc.com
www.opcsupport.com
www.modbus.org
OPC Overview 1.0
OPC Common Definitions and Interfaces 1.0
OPC Data Access Specification 2.05a
OPC Data Access Specification 3.00
OPC Historical Data Access Specification 1.2
OPC Alarms and Events Specification 1.10
Modicon Modbus Protocol Reference Guide
Modbus Application Protocol Specification
Document Terminology
The following terms are used interchangeably throughout this document:
screen and window
tab and panel
Table 1 provides a list of definitions for terms used throughout this document.
System Requirements
The software has minimum Software and Hardware system requirements. These requirements
must be met for the software to function properly.
Software Requirements
The server requires the following software:
Microsoft Windows 7 (32-bit and 64-bit) or
Microsoft Windows 10 or
Microsoft Windows 2008 SP2 (32-bit and 64-bit) or
Microsoft Windows 2008 Server R2 or
Microsoft Windows Server 2012 R2 or
Microsoft Windows Server 2016
Hardware Requirements
The server requires the following hardware:
Intel® Pentium® 4 Processor
Configuration Window
Following installation of the product, the Configuration window is accessed via the Windows
Start menu. The Configuration window is used to configure the server. It displays the current
configuration and allows you to change configuration parameters.
To view the Configuration window:
1. Click on the Windows Start button and select Programs -> MatrikonOPC -> Modbus,
and choose MatrikonOPC Server for Modbus.
2. The Configuration window appears and the Server Nodes Configuration pane (Figure 1)
is displayed on the left side of the window.
Component Description
Main Menu Provides access to the File, Edit, View, Window, and Help menus.
Provides items that make navigation within a configuration, easier. Refer to
Toolbar
Table 4 for more information.
Location Bar Allows you to track the current configuration’s location.
Displays a tree of configuration objects currently defined in the application.
Navigation Panel Select an object to display its current settings in the right-hand panel. This
panel is also referred to as the tree-view pane.
Displays the current settings of the item presently selected in the tree-view
Settings Panel
pane.
Table 3 - Configuration Window Components
The following sections describe the menus available from the Configuration window, and what
they are used for.
Toolbar
Table 4 describes those items available from the Toolbar.
Note: Depending on the node or item selected in the navigation pane will determine the items
displayed on the Toolbar.
Command Description
Returns you to the previous configuration.
Back
Moves you to the next configuration history.
Forward
Selects the node in the navigation pane that is above the currently-
Up selected node.
Selecting this item displays the Import Configuration window which
allows you to import configurations from previous versions of this server.
Import Configuration The imported configuration will be the default configuration for this server
the next time it starts up.
Selecting this item displays the Export Configuration window which
allows you to export the current configuration of your server in the form
Export Configuration
of an XML file.
Selecting this item (when it is enabled) allows you to create a new
configuration node.
This toolbar item is available only when you have selected an item in the
New Node Configuration window’s navigation pane that allows you to create a
configuration node below it. For example, when you select the Server
Nodes Configuration node, this item is enabled.
Selecting this item (when it is enabled) allows you to delete the selected
Delete node or item.
The following sections describe the menus available from the Configuration window, and what
they are used for.
File Menu
Table 6 describes the File menu commands.
Command Description
Selecting this menu option allows you to create a new configuration. If
New Configuration you choose to create a new configuration you are first given the option
of exporting the current configuration, or deleting it.
Selecting this menu option displays the Import Configuration window
which allows you to import configurations from previous versions of this
Import Configuration
server. The imported configuration is used as the default configuration.
Edit Menu
The Edit menu options are determined by the item selected in the navigation pane.
Table 6 describes the Edit menu commands that are available when an Alias Group is selected in
the navigation pane.
Command Description
Selecting this option allows you to create a new Alias Group by
accessing the New Alias Group window (Figure 24).
This menu option is available only when you have selected either the
New Group
Alias Configuration node in the Configuration window’s navigation
pane, or an existing Alias in the settings pane (i.e., pane on the right
side of the window).
Selecting this option allows you to create a new Alias by accessing the
Alias Configuration Wizard (Figure 26).
New Alias This menu option is available only when you have selected either the
Alias Configuration node in the Configuration window’s navigation
pane, or an existing Alias in the settings pane.
Select this option to display the Alias Configuration Wizard (Figure
26), allowing you to edit the selected alias.
Edit This menu option is available only when you have selected either the
Alias Configuration node in the Configuration window’s navigation
pane, or an existing Alias in the settings pane.
Select this option to display the Alias Configuration Wizard (Figure
26), allowing you to clone the selected alias.
Clone This menu option is available only when you have selected either the
Alias Configuration node in the Configuration window’s navigation
pane, or an existing Alias in the settings pane.
Selecting this option allows you to delete the selected Alias in the
Delete Configuration window’s settings pane.
Select this option to display the Import Alias File window which allows
you to select the .csv file you wish to import.
Import From CSV This menu option is available only when you have selected either the
Alias Configuration node or Alias Group in the Configuration
window’s navigation pane, or an existing Alias in the settings pane.
Select this option to display the Export Alias File window which allows
you to select the .csv file you wish to export.
Export To CSV
This menu option is available only when you have selected either the
Alias Configuration node or Alias Group in the Configuration
Table 7 describes the Edit menu commands that are available when either the Redundancy
Configuration node is selected in the navigation pane, or a Redundancy item is selected in the
settings pane.
Command Description
Select this option to display the New Redundancy window (Figure 48)
New Redundancy where you can then create and configure a new Redundancy node.
Select this item to display the Edit Redundancy window (Figure 53),
allowing you to edit the selected Redundancy item.
Edit This menu option is available only when you have selected an existing
Redundancy item in the settings pane (i.e., pane on the right side of
the window).
Select this item to display the Edit Redundancy window (Figure 53),
allowing you to clone the selected Redundancy configuration.
Clone
This menu option is available only when you have selected an existing
Redundancy item in the settings pane.
Selecting this option allows you to delete the selected Redundancy
Delete configuration in the Configuration window’s settings pane.
Table 7 - Edit Menu Commands (Redundancy Node)
View Menu
Table 8 describes the View menu commands.
Command Description
Toolbar When selected, the Toolbar appears below the Main Menu.
When selected, displays the Location Bar below the Main Menu and above
the navigation pane. The Location Bar allows you to track the current
configuration’s location. By clicking on each segment of the Location Bar,
you can easily navigate to the required configuration screen.
Location Bar
Each segment of the Location Bar also provides a drop-down menu that
allows you to browse to the next available configuration. To access the drop-
down menu, click on the arrow on the right side of the required Location
Bar segment.
When selected, displays the navigation pane including the navigation tree.
Navigation Tree Allows you to efficiently browse through the available configuration of the
current product.
When selected, shows the available windows tabs at the bottom of the
Configuration window. Allows you to view all currently-open configurations.
Window Tabs The currently-open configurations may be organized with options offered in
the Windows menu from the Main Menu.
Note: This option is not selected by default.
Start Page When selected, shows the current product Start Page.
Window Menu
Table 9 describes the Window menu commands that allow you to define how the settings of
pages/tabs are to appear on the right side of the Configuration window.
Command Description
Tile Vertically Vertically arranges the currently-opened windows within the configuration.
Help Menu
Table 10 describes the Help menu command.
Command Description
Displays an About screen, which includes information about the Integrated
About iC
Configuration (iC) configuration management system version.
Table 10 - Help Menu Command
This node is used as the Master to configure Modbus PLC devices over Modbus TCP protocol via
Ethernet.
Table 11 describes the components of the Modbus Ethernet PLC Configuration page.
Component Description
Name of the object, which becomes an element of the item ID for data items
Name under the object.
Automatically converted to title case for display purposes.
Use this checkbox to enable (i.e., checkbox is selected) or disable (i.e.,
Enabled checkbox is cleared) communication for the object.
By default, the checkbox is selected.
This field is optional, takes any user-defined text (64-character maximum) for
Description documentation purposes.
By default, this field is blank.
Hostname If this option is selected, you can specify the network name of the device.
IP Address If this option is selected, you can specify the IP address of the device.
Port Number Allows you to enter or select the TCP port on which the device is listening.
Allows you to enter or select the Modbus address of the device (maximum
length of 255). If set to 0, writing to this device will cause a Modbus broadcast
Modbus Address message to go out to all devices on the communications port, writing to all
devices simultaneously. When using a Modbus address of 0, you cannot
read tags through the device link. Change the address to match the
4. Click on the Create button. The new item is created and appears as a child of the Server
Nodes Configuration node in the navigation pane as shown in Figure 3.
Table 12 describes the components of the Modbus Serial Port Configuration page.
Component Description
Name of the object, which becomes an element of the item ID for data items
Name under the object.
Automatically converted to title case for display purposes.
Use this checkbox to enable (i.e., checkbox is selected) or disable (i.e.,
Enabled checkbox is cleared) communication for the object.
By default, the checkbox is selected.
This field is optional, takes any user-defined text (64-character maximum) for
Description documentation purposes.
By default, this field is blank.
Allows you to select, from the drop-down list, the serial port to which the
Port device is connected.
Default = COM1.
Allows you to define the communication rate by selecting a value from the
Baud Rate drop-down list. Values range between 110 and 256000.
Default = 9600.
Data Bits Allows you to define the number of data bits by selecting a value from the
RTS Rise Delay Allows you to enter or select the number of milliseconds (to a maximum of
1000) for rise delay. This option is available only when RTS Control is set to
Table 13 describes the components of the Modbus Serial PLC Configuration page.
Component Description
Name of the object, which becomes an element of the item ID for data items
Name under the object.
Automatically converted to title case for display purposes.
Use this checkbox to enable (i.e., checkbox is selected) or disable (i.e.,
Enabled checkbox is cleared) communication for the object.
By default, the checkbox is selected.
This field is optional, takes any user-defined text (64-character maximum) for
Description documentation purposes.
By default, this field is blank.
Modbus Address Allows you to enter or select the Modbus address of the device (maximum
Table 14 describes the components of the Modbus Serial Slave Port Configuration page.
Component Description
Name of the object, which becomes an element of the item ID for data items
Name under the object.
Automatically converted to title case for display purposes.
Use this checkbox to enable (i.e., checkbox is selected) or disable (i.e.,
Enabled checkbox is cleared) communication for the object.
By default, the checkbox is selected.
This field is optional, takes any user-defined text (64-character maximum) for
Description documentation purposes.
By default, this field is blank.
Allows you to select, from the drop-down list, the serial port to which the
Port device is connected.
Default = COM1.
Allows you to define the communication rate by selecting a value from the
Baud Rate drop-down list. Values range between 110 and 256000.
Default = 9600.
Allows you to define the number of data bits by selecting a value from the
Data Bits drop-down list. Values range between 4 and 8.
Default = 8.
Allows you to select, from the drop-down list, the type of parity to be used.
Parity
Options available are None, Odd, Even, Mark, and Space.
Table 15 describes the components of the Modbus Serial Slave PLC Configuration page.
Component Description
Name of the object, which becomes an element of the item ID for data items
Name under the object.
Automatically converted to title case for display purposes.
Use this checkbox to enable (i.e., checkbox is selected) or disable (i.e.,
Enabled checkbox is cleared) communication for the object.
By default, the checkbox is selected.
This field is optional, takes any user-defined text (64-character maximum) for
Description documentation purposes.
By default, this field is blank.
Allows you to enter or select the Modbus address of the device (maximum
length of 255). If set to 0, writing to this device will cause a Modbus broadcast
message to go out to all devices on the communications port, writing to all
Modbus Address
devices simultaneously. When using a Modbus address of 0, you cannot read
tags through the device link. Change the address to match the address of the
Modbus slave from which you wish to read data.
ASCII Mode If this checkbox is selected, communication will occur in ASCII mode.
Validate Items This field is not applicable for Modbus Serial Slave PLC Object.
Number of Retries This field is not applicable for Modbus Serial Slave PLC Object.
Reconnect Delay This field is not applicable for Modbus Serial Slave PLC Object.
Component Description
Name of the object, which becomes an element of the item ID for data items
Name under the object.
Automatically converted to title case for display purposes.
Use this checkbox to enable (i.e., checkbox is selected) or disable (i.e.,
Enabled checkbox is cleared) communication for the object.
By default, the checkbox is selected.
This field is optional, takes any user-defined text (64-character maximum) for
Description documentation purposes.
By default, this field is blank.
Hostname If this option is selected, you can specify the network name of the device.
IP Address If this option is selected, you can specify the IP address of the device.
Port Number Allows you to enter or select the TCP port on which the device is listening.
Allows you to enter or select the number of milliseconds to wait before a
Reply Timeout timeout occurs (maximum of 30000 milliseconds).
Default = 1000.
Create Select this button to confirm your creation of this node.
Cancel Select this button to cancel your process of creating a node.
Table 16 - Modbus Terminal Server Configuration Page Components
Table 17 describes the components of the Modbus Terminal Server PLC Configuration page.
Component Description
Name of the object, which becomes an element of the item ID for data items
Name under the object.
Automatically converted to title case for display purposes.
Use this checkbox to enable (i.e., checkbox is selected) or disable (i.e.,
Enabled checkbox is cleared) communication for the object.
By default, the checkbox is selected.
This field is optional, takes any user-defined text (64-character maximum) for
Description documentation purposes.
By default, this field is blank.
Allows you to enter or select the Modbus address of the device (maximum
length of 255). If set to 0, writing to this device will cause a Modbus broadcast
message to go out to all devices on the communications port, writing to all
Modbus Address devices simultaneously. When using a Modbus address of 0, you cannot
read tags through the device link. Change the address to match the
address of the Modbus slave from which you wish to read data.
Default = 0.
While adding the OPC items, if this checkbox is selected, the OPC server
validates whether the OPC items exist within your device and are valid.
The OPC items are rejected:
Validate Items
If the OPC server is not connected to the device or,
If the OPC items are not available in the device
By default, this checkbox is cleared.
Allows you to enter or select a value defining the number of retries if timeouts
Number of Retries
occur (maximum of 10).
Table 18 describes the components of the Modbus UDP Port Configuration page.
Component Description
Name of the object, which becomes an element of the item ID for data items
Name under the object.
Automatically converted to title case for display purposes.
Use this checkbox to enable (i.e., checkbox is selected) or disable (i.e.,
Enabled checkbox is cleared) communication for the object.
By default, the checkbox is selected.
This field is optional, takes any user-defined text (64-character maximum) for
Description documentation purposes.
By default, this field is blank.
Hostname If this option is selected, you can specify the network name of the device.
IP Address If this option is selected, you can specify the IP address of the device.
Port Number Allows you to enter or select the UDP port on which the device is listening.
Table 19 describes the components of the Modbus UDP PLC Configuration page.
Component Description
Name of the object, which becomes an element of the item ID for data items
Name under the object.
Automatically converted to title case for display purposes.
Use this checkbox to enable (i.e., checkbox is selected) or disable (i.e.,
Enabled checkbox is cleared) communication for the object.
By default, the checkbox is selected.
This field is optional, takes any user-defined text (64-character maximum) for
Description documentation purposes.
By default, this field is blank.
Table 20 describes the components of the Modbus+ SA85 or PCI85 Card configuration page.
Component Description
Name of the object, which becomes an element of the item ID for data items
Name under the object.
Automatically converted to title case for display purposes.
Use this checkbox to enable (i.e., checkbox is selected) or disable (i.e.,
Enabled checkbox is cleared) communication for the object.
By default, the checkbox is selected.
This field is optional, takes any user-defined text (64-character maximum) for
Description documentation purposes.
By default, this field is blank.
Allows you to enter a five-byte routing array. Each byte in the routing array
specifies the node address of the bridge, the destination node, or the path of
host-based adapter.
If the Modbus+ device is connected to a local network, enter only the
node address of the Modbus+ device.
Example: A routing array of 25.0.0.0.0 routes the message to the
Modbus+ device at node 25.
If the Modbus+ device is connected to a remote network through a
Modbus+Routing bridge, enter the node address of the bridges on the local and the
remote network, and then the node address of the Modbus+ device.
Example 1: A routing array of 14.36.0.0.0 routes the message first to
the bridge at node 14 on the local network, and then to the Modbus+
device at node 36 on the remote network.
Example 2: A routing array of 6.43.18.4.30 routes the message first to
the bridge at node 6 on the local network, and then to the bridges at
nodes 43, 18, and 4 on the remote networks in the same sequence, and
finally to the Modbus+ device at node 30.
Allows you to enter the number of milliseconds to wait before a timeout occurs,
Reply Timeout to a maximum of 30000 milliseconds.
Default = 1000.
Allows you to enter or select a value specifying the number of retries if
Retries timeouts occur, to a maximum of 10.
Default = 3.
Allows you to enter or select a value defining the number of milliseconds to
Reconnect Delay wait before re-trying the connection, to a maximum of 3600 seconds.
Default = 10.
Create Select this button to confirm your creation of this node.
Cancel Select this button to cancel your process of creating a node.
Table 21 - Modbus+ Device Configuration Page Components
Alias Configuration
MatrikonOPC servers, including this one, provide the ability to create user-defined aliases that can
be used in place of regular OPC items. This feature is particularly useful when the item path for a
given server is very complex or difficult to remember, for example: Com1.Radio1.Unit1.41.4.123.
Servers can also be configured so that client applications have access to configured aliases only,
rather than every available item.
This section of the manual describes how to create and edit aliases using the Configuration
window.
Note: It is not necessary to define aliases before accessing server data items from an OPC client.
Component Description
This Alias type is used to rename an item in this server. Basic Aliases also
Basic provide basic scaling options. Refer to Basic Alias Configuration for more
information.
Use this Alias type to define an Alias that is the result of a mathematical
Calculation equation involving one or more data items in the server. Refer to
Calculation Alias Configuration for more information.
Use this Alias type to create a brand new data item not associated with any
Holding item in the server. This type of item is useful for temporary items and
testing. Refer to Holding Alias Configuration for more information
Table 22 - Alias Configuration Wizard - Alias Type Components
Component Description
Displays the path where the new Alias item will reside once created.
Alias Group
This field is read-only.
Allows you to enter a name for the Alias you are creating. This name
Alias Name
must be unique within the Alias Group.
Allows you to enter or select a fully-qualified item ID for the OPC
item to which the Alias refers. Click on the Browse OPC Tag button
to display the Browse OPC Tag window which can be used to select
an existing OPC item on the server.
OPC Tag Alternatively, leave the item path blank to use the Alias as a general
in-memory variable. When doing so, either define the data type for
the Alias point as something other than Default, or have the Alias
set for reading and define the data type while writing values to the
Alias from an OPC client.
Table 23 - Alias Configuration Wizard - Step 2: Alias Identity Components
Component Description
Browser Allows you to browse the OPC servers available on your system.
Available Tags Displays the tags available in the selected OPC server.
Refresh Click on this button to refresh your browser.
Allows you to filter available tags using a string pattern. For example
*a will display all tags starting with the letter a. Enter a string pattern
Filter in the field to the left of the Filter button. Select the Filter button,
and all applicable tags are listed in the Available Tags screen
section.
Click on this button to confirm the tag you have selected, and to close
OK
the Browse OPC Tag window.
Click on this button to cancel your selection and return to the previous
Cancel
window.
Table 24 - Browse OPC Tag Window Components
Component Description
From the drop-down list, allows you to set the value of the OPC item
Data Type to the specified type unless Default is selected. Also serves as the
“canonical” data type for the Alias.
When this checkbox is selected, OPC clients are prevented from
Read-Only
writing values to the Alias.
Force alias to be updated If this checkbox is selected, the Alias value continues to be updated
even when no OPC clients at the specified update rate even if there are no OPC clients
are subscribed to it currently accessing the Alias.
This field is available only if the Force alias to be updated even
when no OPC clients are subscribed to it checkbox is selected. If
Forced Update Rate this field is available, you can enter or select a value indicating the
rate (in milliseconds) at which the update rate applies to the current
Alias when no OPC clients are connected to it.
Table 25 - Alias Configuration Wizard - Step 3: Alias Properties Components
Component Description
Allows you to select, from the drop-down list, the required scaling
Scaling
option for the Alias.
Table 26 - Alias Configuration Wizard - Step 4: Scaling Algorithms Component
Figure 31 shows the Linear Scaling configuration step when the Basic Alias configuration option
has been selected.
Component Description
Raw High Maximum expected raw value of the OPC item.
Raw Low Minimum expected raw value of the OPC item.
Maximum desired scaled value for the Alias (corresponds to Raw
Scaled High
High).
Minimum desired scaled value for the Alias (corresponds to Raw
Scaled Low
Low).
Clamp the scaled value at the high limit to prevent it from going out
Clamp High
of range.
Clamp the scaled value at the low limit to prevent it from going out
Clamp Low
of range.
Table 27 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Linear Scaling)
Figure 32 shows the Square Root Scaling configuration step when the Basic Alias configuration
option has been selected.
Component Description
Raw High Maximum expected raw value of the OPC item.
Raw Low Minimum expected raw value of the OPC item.
Maximum desired scaled value for the Alias (corresponds to Raw
Scaled High
High).
Minimum desired scaled value for the Alias (corresponds to Raw
Scaled Low
Low).
Clamp the scaled value at the high limit to prevent it from going out
Clamp High
of range.
Clamp the scaled value at the low limit to prevent it from going out
Clamp Low
of range.
Table 28 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Square Root Scaling) Components
Figure 33 shows the Gain/Offset configuration step when the Basic Alias configuration option has
been selected.
Component Description
Gain Scaling factor. (No limits are assumed.)
Offset Scaling offset.
Table 29 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Gain/Offset Scaling) Components
Figure 34 shows the Expression Scaling configuration step when the Basic Alias configuration
option has been selected.
Component Description
Simple text equation to apply to incoming values (reads). Click on the Editor button
Input to display the Expression Wizard screen used to help build a formula. For more
information, refer to the Expression Wizard section in this manual.
Simple text equation to apply to outgoing values (writes). Click on the Editor button
Output to display the Expression Wizard screen used to help build a formula. For more
information, refer to the Expression Wizard section in this manual.
Table 30 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Expression Scaling) Components
Figure 35 shows the Expression Wizard that is used to configure the input and output
expressions.
Notes:
The Expression Wizard appears and functions the same for an input expression as it does
for an output expression. The differences being the expression field label: Input
Expression, Output Expression, and that one is for reads and the other for writes.
If you are expecting to read a particular alias, create an Input Expression. If you are
expecting to write to a particular alias, create an Output Expression.
Please refer to the Expression Wizard section in this User’s Manual for examples.
Component Description
Displays the expression as it is created. This field is free-form which allows you to
Input/Output manually enter or edit information. This field reads Input Expression when
Expression creating an input or “read” expression. It reads Output Expression when
creating an output or “write” expression.
Select this button to display the Select Function window which allows you to
Function
select the necessary function from those available.
Select this button to display the Select Variable window which allows you to
Variable
select the necessary variable from those available.
Select the applicable button to add the corresponding operator or operators to the
Operators
expression.
Clear Select this button to clear the Input/Output Expression field.
OK Select this button to accept changes to (or the creation of) the expression.
Select this button to discard changes to (or abandon the creation of) the
Cancel
expression.
Table 31 - Expression Wizard Components
Component Description
Displays the available categories for selection. Allows you to select the
Category
required category.
Displays the available functions associated with the selected category.
Available Functions
Allows you to select the required function.
Select this button to accept the selections made and return to the
Continue
initial Expression Wizard window.
Select this button to disregard the selections made and return to the
Cancel
initial Expression Wizard window.
Table 32 - Select Function Window Components
Component Description
Displays the available variables for selection. Allows you to select the
Select variable
required variable.
Select this button to accept the selection made and return to the
OK
initial Expression Wizard window.
Select this button to disregard the selection made and return to the
Cancel
initial Expression Wizard window.
Table 33 - Select Variable Window Components
Table 34 describes the components of Alias Identity step when the Calculation Alias
configuration option has been selected.
Component Description
Displays the path where the new Alias item will reside once created. This field is
Alias Group
read-only.
Allows you to enter a name for the Alias you are creating. This name must be
Alias Name
unique within the Alias Group.
Table 34 - Alias Configuration Wizard - Step 2: Alias Identity Components
Component Description
From the drop-down list, allows you to set the value of the OPC item
Data Type to the specified type unless Default is selected. Also serves as the
“canonical” data type for the Alias.
Force alias to be updated If this checkbox is selected, the Alias value continues to be updated
even when no OPC clients at the specified update rate even if there are no OPC clients
are subscribed to it currently accessing the Alias.
This field is available only if the Force alias to be updated even
when no OPC clients are subscribed to it checkbox is selected. If
Forced Update Rate this field is available, you can enter or select a value indicating the
rate (in milliseconds) at which the update rate applies to the current
Alias when no OPC clients are connected to it.
Table 35 - Alias Configuration Wizard - Step 3: Alias Properties Components
Figure 40 shows the Alias Calculation configuration step when the Calculation Alias
configuration option has been selected.
Component Description
Alias Calculation Allows you to enter a calculation equation.
Select this button to display the Insert OPC Tag window (i.e., Tag
Insert OPC Tag Browser – Figure 28) allowing you to insert OPC tags as part of the
calculation formula.
This field lists a wide selection of mathematical functions that can be
used as part of your Alias calculation configuration. Double-click your
Insert Function
mouse on the required function and it appears in the calculation
equation displayed in the Alias Calculation screen section.
Table 36 - Alias Configuration Wizard - Step 4: Alias Calculation Components
Figure 41 shows the Alias Events configuration step when the Calculation Alias configuration has
been selected.
Component Description
When this checkbox is selected, Alias events are enabled for this
Enable events for this Alias
Alias item.
Source Allows you to enter the name of the source of the event.
Allows you to enter or select a value defining the severity of the
Severity
alarm. The allowable range is 1 through 1000.
Allows you to select, from the drop-down list, the event category
Category
under which the event is to be registered.
The Manage Categories button launches the Manage Event
Manage Categories Categories window (Figure 42) where you can create new
categories, as well as edit or delete existing categories.
Allows you to select, from the drop-down list, how the Alias event is
Trigger Condition
to be triggered: Value Change, Positive Edge.
Allows you to select, from the drop-down list, whether the
Timestamp Source timestamp for the Alias event is retrieved from the Server or the
Device (if it is different).
Allows you to enter a message that is to appear in the posted event.
This message can contain references to data items in the server.
Message
These references are replaced with the values of those items at the
time the event was generated.
Component Description
Select this button to access the New Event Category window (Figure 43) and
New
create a new category.
Select this button to edit the currently selected category.
Edit Note: This button is available only if at least one event category has been created
and selected.
Select this button to delete the selected category.
Delete Note: This button is available only if at least one event category has been created
and selected.
Select this button to close the Manage Event Categories window and return to
Close
Step 5 of the Alias Configuration Wizard.
Table 38 - Manage Event Categories Window Components
Component Description
This is an automatically-assigned field that identifies the newly-
Category ID
created category.
Name The name of the newly-created category.
Description A description of the newly-created category.
Table 39 - New Event Category Window Components
Table 40 describes the components of Step 2: Alias Identity when the Holding Alias
configuration option has been selected.
Component Description
Displays the path where the new Alias item will reside once created.
Alias Group
This field is read-only.
Allows you to enter a name for the Alias you are creating. This name
Alias Name
must be unique within the Alias Group.
Table 40 - Alias Configuration Wizard - Step 2: Alias Identity Components
Figure 45 shows the Alias Properties configuration when the Holding Alias configuration option
has been selected.
Component Description
From the drop-down list, allows you to set the value of the OPC item
Data Type to the specified type unless Default is selected. Also serves as the
“canonical” data type for the Alias.
When this checkbox is selected, OPC clients are prevented from
Read-only
writing values to the Alias.
Default Value The default value of the holding Alias item created.
Table 41 - Alias Configuration Wizard - Step 3: Alias Properties Components
Editing Aliases
To edit an Alias:
1. From the Alias Configuration panel, select the Alias item you wish to edit.
Removing Aliases
Note: Any Alias that was created can be removed.
To remove an Alias:
1. From the Alias Configuration panel, select one or more Aliases you wish to remove.
Exporting Aliases
Note: Use the Export Alias File window to export all currently configured Aliases to a CSV file.
To export all currently configured Aliases:
1. From the navigation pane, select the Alias Configuration node.
Importing Aliases
Note: Use the Import Alias File window to clear all Aliases and import new ones from a CSV file.
To import Aliases from a CSV file:
1. From the navigation pane, select either the Alias Configuration node.
Expression Wizard
The Expression form of scaling uses an Expression Wizard to build formulas. The created
formula is a simple text equation that is applied to either incoming values (i.e., reads), or outgoing
values (i.e., writes).
Examples
Example 1:
The following turns any number into a Boolean value. Any non-zero value shows up as a 1.
IF(INPUT = 0,0,1)
OUTPUT
Example 2:
The following takes the text out of SAMPLE and converts it to ON. All other values show as OFF. If
OUTPUT is specified in the Output field, then the value is transferred to the end OPC item. Using
this alias, you can write SAMPLE or any other value to the Alias to get the display to changed from
OFF to ON.
String comparisons are case-sensitive.
IF(INPUT = ‘SAMPLE’,’ON’,’OFF’)
OUTPUT
Table 42 describes the Expression Wizard fields.
Component Description
Displays the expression as it is created. This field is free-form which
allows you to manually enter or edit information. This field reads Input
Input/Output Expression
Expression when creating an input or “read” expression. It reads
Output Expression when creating an output or “write” expression.
Select this button to display the Select Function window which allows
Function
you to select the necessary function from those available.
Select this button to display the Select variable window which allows
Variable
you to select the necessary variable from those available.
Select the applicable button to add the corresponding operator or
Operators
operators to the expression.
Clear Select this button to clear the Input/Output Expression field.
OK Select this button to accept changes to (or the creation of) the
Notes:
The Expression Wizard appears and functions the same for an input expression as it does
for an output expression. The differences being the expression field label: Input
Expression, Output Expression, and that one is for reads and the other for writes.
If you are expecting to read a particular Alias, create an Input Expression. If you are
expecting to write to a particular Alias, create an Output Expression.
To create an Input or Output Expression:
1. When the Expression Wizard (Figure 35) is displayed.
2. Manually enter your new expression in the Input Expression field and proceed to step 8.
Or,
Perform steps 3 through 7 using a combination of the Function, Variable, and Operators
buttons to create your expression, which will be displayed in the Input/Output
Expression field as you build it.
3. Click on the Function button to go to the Select Function (Figure 36) window. After
selecting the required function, click on the Continue button to bring up the Function
Parameter (Figure 46) window.
4. Complete the parameters as required.
5. Click on the OK button.
6. Click on the Variable button to go to the Select variable (Figure 37) window. After
selecting the required variable, click on the OK button to close the Select variable window
and return to the Expression Wizard.
8. Click on the OK button on the Expression Wizard screen to close the wizard and display
the expression in either the Input or Output field, depending on which expression you
defined.
Mode Description
All redundant nodes are connected. Items are added only to the active
redundant node, but are not removed when a failover occurs. As failovers
Classic
occur and cause multiple redundant nodes to become active, the collection
state becomes the same as Hot.
All redundant nodes are connected. When items are added they are added
Hot to all redundant nodes in the Redundancy Group. This means that all
redundant nodes are actively collecting all the time.
All redundant nodes are connected. When items are added they are added
Warm to the active redundant node. When a failover occurs, the items will be
removed from the formerly active redundant node.
Only the active redundant node is connected. When items are added they
are added to the active redundant node. When a failover occurs the items
will be removed from the formerly active redundant node.
Cold
Note: When a redundant node is a member of a Cold mode Redundancy
node and not the active redundant node, then all communication through
that redundant node is disabled.
Table 43 - Redundancy Modes
Component Description
Allows you to enter the name of the redundant node, which becomes an
Name element of the item ID for data items.
Automatically converted to title case for display purposes.
Use this checkbox to enable (i.e., checkbox is selected) or disable (i.e.,
Enabled checkbox is cleared) communication for the object.
By default, the checkbox is selected.
Select this button to access the Add Failover Nodes(s) window (Figure
49) which allows you to define one or more Failover nodes and assign a
priority to them.
Add Failover Node(s) After defining the list of nodes, they will appear listed in the Failover
Nodes section of the New Redundancy window.
Note: Once you have added a node, you can make changes to it, or
delete it, or change its order within the list.
Select this button to access the Edit Failover Node window (Figure 50)
which allows you to update the selected node.
Edit
This button is only available once a Failover node has been added to the
list.
Select this button to delete the selected Failover node or nodes.
Delete This button is only available once a Failover node has been added to the
list.
Select this button to move the selected Failover node up through the list,
Move Up
according to priority.
Select this button to move the selected Failover node down through the
Move Down
list, according to priority.
Configuration Node Displays the names of the added Failover nodes.
Mode Description
Node(s) Name of the Failover node.
Allows you to select a priority (High, Medium, or Low) for the current
Priority redundant node from the drop-down list. Redundant nodes of higher
priority are preferred to those of lower priority.
OK Select this button to save any changes made and close the window.
Cancel Select this button to close the window without saving any changes made.
Table 45 - Add Failover Node(s) Window Components
Mode Description
Node Name of the selected Failover node.
Allows you to select a priority (High, Medium, or Low) for the current
Priority node from the drop-down list. Nodes of higher priority are preferred to
those of lower priority.
OK Select this button to save any changes made and close the window.
Cancel Select this button to close the window without saving any changes made.
Table 46 - Edit Failover Node Window Components
Server Options
The Server Options page is used to edit the general server options.
Component Description
Allows you to enter or select a value to define an OPC
Time Granularity group/subscription scan thread resolution (in milliseconds).
Default = 100.
Component Description
Selecting this checkbox enables general activity logging at the
Enable server activity specified detail level (High, Medium, Low, or None). If this
logging checkbox is cleared, all other fields on this page are disabled.
By default, this checkbox is selected.
Allows you to select, from the drop-down list, the level at which
general activity is to be logged.
Default = None.
Log Level
Note: Unless you are debugging a problem, it is recommended that
you set this field to None or Low so that server performance is not
affected.
Allows you to specify the full path for the log file. The default path is
Filename C:\Program Files\Matrikon\Common\PSTCFGModbus.1.LOG.
If required, select the Browse button adjacent to this field, to
Clearing a Configuration
Note: Starting a new configuration will clear the existing one.
To clear a configuration:
1. From the File menu, choose the New menu option.
2. A confirmation message appears asking if you wish to export the configuration for later use.
3. Select Yes if you wish to export the configuration.
Or,
Importing a Configuration
To import a configuration file:
1. From the navigation pane, right-click your mouse on the current server node, and either:
Exporting a Configuration
To export a configuration file:
1. From the navigation pane, right-click your mouse on the current server node, and either:
Modbus Items
The OPC item ID syntax of this OPC server is as follows with field descriptions defined in Table 50:
[PORT.]DEVICE.X:YYYYY{:N}{D|F|U|P|A}[S}[/ZZ}*
Field Description
Name of the SA85 Card, Serial Port, or UDP Port under which the Modbus device
PORT
appears. Not required for Modbus Ethernet.
DEVICE Name of the Modbus device link defined in the OPC server configuration.
Modbus register file number. Not all devices support all file types.
File Type Description Size Read Write
0 Digital Output Coil 1 bit
1 Digital Input Coil 1 bit
X
3 Analog Input Register 16 bits
4 Analog Output Register 16 bits
3W Non-Standard Analog Input Register** 32 bits
4W Non-Standard Analog Output Register** 32 bits
Modbus register address. Possible range is from 1 to 65535. The actual range
YYYYY
depends on the Modbus device configuration for the particular register file type.
Append a letter D to the end of an item ID to indicate that the 3X or 4X register
D pairs up with the next register to form a 32-bit integer. For example, 4:1D reads
the least significant word from 4:1 to the most significant word of 4:2.
Append a letter F to the end of an item ID to indicate that the 3X or 4X register
F
pairs up with the next register to form a 32-bit IEEE floating-point real.
Append a letter U to the end of an item ID to indicate that the 3X or 4X register
U
should be treated as an unsigned rather than a signed 16-bit integer.
Append a letter S to the end of an item ID after a D or an F to swap the word
S order from the default (least significant word in lowest address) reverse format
(most significant word in lowest address).
Append a letter P to the end of an item ID to indicate that the 4X register should
be written to using Function 6. This option may be used in conjunction with a U.
P
When doing so, the P should be placed after the U. This option is available only
with the Modbus Ethernet PLC and Modbus Serial devices.
Append a forward slash followed by an integer to the end of an item ID to access
ZZ an individual bit in a 3X or 4X register. The valid range for the bit index is 0 to
15 or, 0 to 31 if the D modifier is specified. These items are always read-only.
Append an A to the end of an item ID to indicate that the item should be parsed
A
as an ASCII String.
* The syntax does not support items with a combination of D, F, and U modifiers. Although the Tag
Studio allows these items to be added, the last letter in the combination is all that will be
interpreted when reading values. For example, Port.Device.X:YYYYYDU will act as an unsigned
16-bit value as the D is ignored.
** Registers 3W and 4W are provided in case your unit does not conform to standard Modbus
design. They should only be used in your Modbus unit uses the non-standard larger 32-bit
registers. Since 32-bit register design is not part of the standard Modbus protocol, we cannot claim
to successfully support his mode for any particular device.
Examples
Consider the configuration shown in Figure 60 .
X X
The Sample Item IDs shown in Table 51 are examples that could be created from the configuration
X X
shown in Figure 18 .
X X
The MatrikonOPC Server Framework creates a number of standard data items which can be used
for monitoring and controlling certain behaviour.
Table 52 describes the standard items available for most device links.
Field Description
This is a Boolean OPC tag which indicates whether or not the device link to
#Enabled which it belongs is enabled. If the value is True or a value of True is written
to this item then the device link is enabled.
Adding this item allows an OPC client to monitor the offline mode for that
location using read operations and provide the ability to toggle offline mode
#OfflineMode for that location using write operations. For more information, refer to
Appendix G - Offline Mode.
This is a Boolean OPC tag which indicates whether or not the device link is
@Connected connected to its resources. Typically True indicates that a connection of an
end device has been established.
Table 52 - Standard Data Items
Table 53 describes the standard items available for at the root branch of the server browse tree.
This is a read-only string item which lists the name of every client currently
@Clients
connected to the OPC server.
Table 53 - Server Data Items
Table 54 describes the statistical and control items available for the Redundancy node.
Field Description
Write to this control item to indicate which redundant node, to which the
Redundancy node is subscribed, is forced to be active whether or not it is
#Manual Device Link available. Clear the value of this control item to allow the OPC server to
decide which of the subscribed device links should be active, according to
their configured priorities and availabilities.
The current active redundant node, which will be the highest-priority of the
@Active Device Link
available device links on the Redundancy node’s subscription list.
A numbered list of redundant nodes to which the Redundancy node is
subscribed. They are ordered from highest to lowest priority. Writing a
numbered list of redundant nodes will modify the subscribed nodes for the
#Redundancy Group Redundancy node.
Note: Writing to this item is not supported if the redundant node name
contains colon “:” or bracket “()” characters.
Table 54 - Redundancy Node OPC Items
Table 55 describes the statistical and control items available for the Server Status node.
Field Description
A numbered list of the device links being monitored by the Server Status node.
@Monitor List The full path of the node is provided, as entered in the Server Status node’s
subscription list.
Indicates the customized status of the server based on the settings for the
@Server Status Server Status node. The status options are: Running, Failed, or No
Configuration (if the monitor list is empty).
Table 55 - Server Status List Device Link OPC Items
Logging
All MatrikonOPC servers produce log files that record errors and debugging information. The log
files can be extremely valuable for troubleshooting. As such, it is important to note that the default
log level is set to low. The Logging Options page in the main configuration window contains
settings to control server logging.
Activity Log Settings records information about the internal workings of the OPC server. It is useful
for troubleshooting problems with configuration and device communication. Interface Activity
Logging records information about the client/server OPC communication. It is useful for
troubleshooting compliance issues.
For general logging, the higher the log level, the more information that is recorded. However,
server performance may decrease at higher log levels. The recommended operating level is
Medium. More log levels are available for both types of logging which record more detailed
information, as well as the ability to output log statements to a console window at run time.
Contact MatrikonOPC support for further instructions on how to enable the higher log levels and
console logging.
For Interface logging, the log level can be considered very high and therefore should never be used
during normal operation of the OPC server unless specifically working on problems related to
interfacing.
MatrikonOPC Sniffer is a useful tool for logging OPC client/server communication. It enhances
the Interface Activity Logging by recording the client-side transactions. It can also be used with
other OPC servers. MatrikonOPC Sniffer is a utility used to troubleshoot OPC client/server
interoperability issues. Contact the MatrikonOPC Sales department for further information about
this product, or use the following link to access the MatrikonOPC Sniffer Download.
In general, the server logs all errors and other information of immediate importance to the user at
the low detail level, all warnings and other information of moderate importance to the user at a
medium detail level, and additional information concerning the normal functioning of the software
at a high detail level. The server also logs further information of concern to support personnel at
the debug log level.
Note: The higher the log level, the slower the performance of the
server. It is recommended that the log level be left at the default,
unless troubleshooting needs to be performed.
Refer to the MatrikonOPC Server for Modbus Release Notes for known issues.
Server stops updating client with item values after two hours
Problem: The server stops updating the client with item values after two hours.
Solution: The server may be licensed with a hardware key and the hardware key may not be
properly detected, or the software license has expired.
Alternatively, try running the MatrikonOPC Licensing utility from the shortcut menu.
Click on the Check Licenses button to see the status of all MatrikonOPC product
licenses.
Check that the correct HASP hardware key is securely fastened to the parallel port. If it
is, run the HINSTALL program that is located in the Program Files\Common
Files\MatrikonOPC\Common directory.
More than one HASP attached to parallel port, but only first one is recognized
Problem: There is more than one HASP hardware key from MatrikonOPC attached to the parallel
port, but the software recognizes only the first one.
Solution: HASP keys from the same vendor cannot be chained together. Send an email to the
OPC client unable to create or read items under configured object (device)
Problem: The OPC client is unable to create or read items under a configured object (device).
Solution: Check the object configuration (for more information, refer to Server Configuration).
Ensure the Enabled checkbox is selected.
Server does not show up in the list of locally available program IDs in OPC client
application
Problem: The server does not show up in a list of locally available program IDs in the OPC client
application.
Solution: Make sure that a user with local administrative rights installs the OPC server so that it
can create the necessary entries in the registry.
Ensure OPCEnum is registered as a service, DCOM permissions are configured
properly, and the OPCEnum service is running.
Also, especially for older OPC clients that do not use the OPC server browser, make
sure the client is running as a user that has read access to the registry.
Access denied or time-out error when connecting to remote server via DCOM
Problem: Access Denied error message appears, or time out occurs when trying to connect to
a remote OPC server via DCOM.
Solution: Ensure that the access and launch permissions for the OPC server are set correctly on
the server machine. For more information, refer to Appendix A – Distributed COM
(DCOM).
Reg 1
Reg 3 3 reads (because registers are not sequential)
Reg 5
Noisy communications
Problem: I am having interference problems when communication with my SCADA devices.
Solution: MatrikonOPC Modbus has some head and tail squall squelch capabilities. Consider
using MatrikonOPC SCADA Modbus for enhanced features.
Search the MatrikonOPC Support Knowledge Base at www.opcsupport.com to find the answers
to other commonly-asked MatrikonOPC Server for Modbus questions.
Licensing
Most MatrikonOPC products require that some form of licensing criteria be met for it to function
correctly. A license is required to enable the server’s functionality.
The MatrikonOPC Server for Modbus supports both software and hardware licensing.
Feature Licenses
Featured Component Default License State
Alias Events 30-Day Demo
Security 30-Day Demo
MatrikonOPC Server for Modbus 30-Day Demo
Table 56 - Feature Licenses
Note: MatrikonOPC Server for Modbus, Alias Events, and Security need to be licensed separately,
and by default, are delivered with only a 30-day demo. To purchase a full license for Alias Events,
MatrikonOPC Server for Modbus, or Security, please contact your MatrikonOPC Account Manager.
Contacting Support
The MatrikonOPC Customer Services department (www.opcsupport.com) is available 24 hours a
day, seven days a week.
Contact MatrikonOPC Support using the information below, or send an email
([email protected]).
For Monday to Friday daytime support requests, contact MatrikonOPC Support using the regional
phone numbers provided in Table 57.
For after-hours support in all regions, please use the following number. There is no extra charge
from MatrikonOPC for calling their after-hours support number.
Installation
The server is by default installed as a local out-of-process COM server and enters its registration
information in the Windows registry when instructed to do so with the /REGSERVER command-
line option. The server installs itself as a Windows service and enters its registration information in
the Windows registry when instructed to do so with the /SERVICE command-line option.
Version-independent program ID is Matrikon.OPC.Modbus.
Version-specific program ID is Matrikon.OPC.Modbus.1.
OPC sub-key and vendor information string.
Globally unique application ID (e.g., F8582CED-88FB-11D0-B850-00C0F0104305).
Globally unique class ID number (e.g., F8582CEC-88FB-11D0-B850-00C0F0104305).
Full path of 32-bit local server executable.
OPC Data Access Server 2.05a and 3.00 implemented component categories.
The server removes its registration information from the Windows registry when commanded to do
so with the /UNREGSERVER command-line option.
Common Interfaces
The server supports the mandatory functionality specified in OPC Common Definitions and
Interfaces. The server supports the following locales for result code translation:
US English (0x0409)
System default (0x0800)
User default (0x0400)
Neutral (0x0000).
The server allows the client to set the client name for each connection. The server supports the
shutdown event notification client-side interface.
Data Access
The server supports the mandatory functionality specified in the OPC Data Access Custom Interface
Standard.
Items
The server supports the addition, removal, and validation of items in a group. The server allows the
client to manage item configuration.
Active state
Requested data type
Dead-band (percent of analog item high-low range)
Sampling rate
Buffer values (used only when sampling rate is enabled and is sampling faster than the
group update rate).
I/O Operations
The server supports synchronous I/O operations.
Read active item values from cache.
Read item values from device.
Read items value from device based on how old the cache items value is.
Read items without adding the item to an OPC group.
Write control values to items (on device).
Notes:
The following steps are suggestions only. Ask your Windows
Network Administrator for more information about the settings
that you should use, especially between different domains.
The steps provided in this appendix apply to Windows NT
operating systems only. For information on how to configure
DCOM settings for newer Windows operating systems, please
refer to the MatrikonOPC Online Support page on DCOM
Settings.
Note: DCOM settings are stored in the registry and loaded by COM
(and OPC) servers at start-up. Therefore, server processes must be
shut down and re-started for these changes to take effect.
Default Properties
The Default Properties tab contains settings that affect all DCOM communication on the machine.
First of all, ensure that the Enable Distributed COM on this computer is selected in
so that the machine is available to others via DCOM.
Select the Enable COM Internet Services on this computer to allow DCOM access to
the machine from the Internet (check with your administrator).
In general, the other settings do not need to be changed.
The Authentication Level specifies when COM should authenticate the identity of calling clients
(each call, each packet, etc).
Normally, it should be set to Connect, indicating that COM should authenticate clients
when they first connect to a server. If it is set to None, then COM performs no
authentication and ignores any access permission settings.
Security Permissions
The most important DCOM settings for an OPC server are the security permissions. There are two
ways for you to set these:
1. Change the specific settings for the server (recommended).
2. Change the default settings (not recommended) and make sure that the OPC server will use
these.
Either way, be certain that the access and launch permissions are correct for the server.
Notes:
The Access Permissions contain an Access Control List of principals that are
allowed to interact with objects supplied by a server.
The Launch Permissions contain an Access Control List of principals that are
allowed to start up a server process or service.
6. Include the names of users or user groups from trusted domains that you wish to be able to
use the OPC server on this machine. Include the Everyone group to allow access to all
users on a particular domain.
7. To set the Access permissions, click Use custom access permissions and then click Edit.
8. The Registry Value Permissions window (Figure 63) appears.
11. To add a user to the list, select the user, and then click Add. If the user you wish to add
does not appear then click Show Users.
Server Identity
The Identity tab for a selected COM (or OPC) server specifies the user account that should be
used when COM starts up the process. The available settings are different for servers that run as
local executables as opposed to those that run as NT services.
Default Protocols
The Default Protocols tab specifies the communication protocols available to DCOM. The order
that protocols appear in the list indicates the priority in which they will be used (the topmost
having the highest priority).
The more protocols that appear in the list, the better the chances of connecting to an OPC server
on an unknown remote machine (such as at an OPC Interoperability Workshop). However, it may
also take longer for DCOM to time out if a server machine is not present since it has to try each
protocol in turn.
For most situations, it is best to remove all unused protocols from the list and only include those
that are necessary for your network. For example, on a TCP/IP network, one would include the
Connection-oriented TCP/IP protocol. Contact your IT personnel for more information about
your network.
Remote Program ID
Before the OPC Server Browser became available, OPC client applications had to search the
registry to generate a list of available OPC servers. Therefore, some older OPC clients need to have
a program ID in the local registry in order to connect to a particular OPC server.
The simplest solution is to install the OPC server software on the client machine even if it is not
used. Alternatively, use the following steps to copy a program ID to the client machine.
Note: This method may not work for every OPC client. Please check the client documentation for
more information.
Advanced Calculations
Calculations may contain references to any OPC item in the server’s syntax. However, they may
not contain references to other Alias items. There are no limits on how many items can be used in
a calculation. The only limiting factor may be performance related. To reference another OPC item
in the calculation, wrap the items full item path in square brackets. For example to add the items
Com1.Rtu.Reg1 and Com1.Rtu.Reg2 together, the correct expression would be:
[Com1.Rtu.Reg1] + [Com1.Rtu.Reg2]
If the OPC item being referenced in a calculation is not found within the servers address space, the
server attempts to add it.
In the event that the server cannot create a subscription to the OPC item, the Alias quality reports
Bad, bad configuration.
Advanced Alias calculations may use any of the operators listed in Table 60.
Alias scaling calculations may use any of the functions listed in Table 61.
Field Description
Name of the Alias Group folder where the Alias belongs. Periods in the name
Alias Group indicate subfolders below the root (e.g., North.FIC101 = Alias Group North
under the Alias Configuration root and Alias Group FIC101 under that).
Name of the alias. Full Alias path name composed of the Alias Group path, a
Alias Name
period, and the Alias name (e.g., North.FIC101.CV for an Alias named CV).
Fully qualified item ID for the OPC item to which the Alias refers. Leave this field
Item Path
blank to specify a holding register.
Data Type Decimal number indicating the data type for the alias.
Specifies whether the Alias is read-only or read-write.
Read-only 0 = read-write
1 = read-only
Scaling Option 1 High Raw, Gain, Input Expression, or Calculation, depending on the value
of Scaling.
Scaling Option 2 Low Raw, Offset, or Output Expression, depending on the value of Scaling.
Scaling Option 3 High Scaled if Scaling is 1 or 2.
Scaling Option 4 Low Scaled if Scaling is 1 or 2.
Scaling Option 5 Clamp if Scaling is 1 or 2.
Register Initial Initial value of a holding register.
Value
Event Enabled 0 if events are not to be generated, or 1 if events will be generated. If 0, all
other event fields can be left blank.
Event Source Text that appears as the data source in generated events.
ID of an event category for the generated events. If the category ID does not
Event Category ID exist at import time, the import will fail. To create custom categories, see
Configure Categories.
Event Severity Severity of the generated events. This can be a value from 1 to 1000.
Event Message Message to be included in generated events.
Table 62 - File Import/Export Field Descriptions
When the scaling field specifies linear (1) or square root (2) scaling, the five scaling option fields
are defined in Table 63.
Field Description
High Raw Raw value range (double-precision real).
Low Raw
High Scaled Scaled value range (double-precision real).
Low Scaled
Clamp options.
0 = none
Clamp 1 = clamp low value
2 = clamp high value
3 = clamp both high and low values
Table 63 - Additional File Import/Export Field Descriptions - Linear/Square Root Scaling
Field Description
Gain Scaling factor (double-precision real).
Offset Scaling offset (double-precision real).
Table 64 - Additional File Import/Export Field Descriptions - Offset Scaling
When the scaling field specifies expression (4) scaling, the first two scaling option fields are defined
as listed in Table 65. The other scaling option fields can be left blank.
Field Description
Input Expression Simple formula applied to the value read from the OPC item.
Simple formula applied to values written to the OPC item. The
Output Expression
output formula should be the reciprocal of the input formula.
Table 65 - Additional File Import/Export Field Descriptions - Expression Scaling
When the scaling field specifies calculation (5) scaling, the first scaling option field is defined as
listed in Table 66. The other scaling option fields can be left blank.
Field Description
Input Calculation Calculation applied to the value read from the OPC item.
Table 66 - Additional File Import/Export Field Descriptions - Calculation Scaling
Scaling Algorithms
For each type of scaling, a different algorithm (Table 67) is applied to values read from the OPC
item. A reverse algorithm is applied to any values written to the OPC item.
Gain/ x Offset
Gain x Offset
Offset Gain
Expression SQRT(INPUT) + 5 (OUTPUT – 5) * (OUTPUT – 5)
Table 67 - Scaling Algorithms
DDE Read
To perform a DDE Read using Excel, simply enter a DDE Item as a formula in some spreadsheet
cell:
=SERVICE|TOPIC! NAME
Excel will initiate a DDE Advise loop, or “hot link”, to the topic and item within the service. The DDE
Management system (in this case, Windows) will forward any update sent by the DDE service, to
the appropriate DDE client (in this case, Microsoft Excel). The DDE service is responsible for update
rate/behaviour.
To disable a specific hotlink in Excel, use the Links menu option under the Edit menu.
DDE Write
To perform any DDE command other than requests (read) or advise (hot link), a Visual Basic (VB)
function must be used. Most DDE commands are available by using the application object. For
example, the following function will poke (write) the contents of column 1, row 1 to an item in the
OPC Simulation server:
Sub WriteToDDE()
End Sub
NetDDE must first be configured using the DDEShare application (DDEShare.exe) as shown in
Figure 65. Each SERVICE and TOPIC pair, or “NetDDE Share”, that is to be available through
NetDDE must be assigned a unique name.
DDE service can be enabled or disabled using a checkbox (refer to Server Options for more
information, including the location of, this checkbox). Note that these options will not be available
if the server does not support DDE.
Items within the server can be referenced using the following syntax:
SERVICE_NAME |ITEM! SCANDETAILS
SERVICE_NAME represents the name of the DDE service. The first edit box specifies the service
name used by this server.
ITEM refers to an Item ID of a point within the server.
SCANDETAILS is a combination of the desired scan rate of the item, and an access path. One or
more delimiting characters separate the scan rate and access path. The second edit box can be
used to change the delimiters. The delimiting characters must be provided when referencing an
item in the server. However, the scan rate and access path are optional. If no scan rate is
specified, only data contained in the server cache is available through DDE, and an advise loop is
not created.
Changes to the DDE options do not take effect until the server is restarted.
Appendix Structure
This appendix is structured as follows:
Introduction – this introductory section.
OPC Security Implementation – description of user access dependencies.
MatrikonOPC Tag Security Configuration Utility – describes the utility that is used to
configure security for MatrikonOPC servers.
Security Details – describes how permissions are applied, how security settings are
stored, and other important details.
Identity
Using the IOPCSecurityNT interface for OPC Security, the identity of the OPC client is the domain
user that is running the OPC client and connecting to the OPC server. The OPC Framework will
attempt to impersonate the client that is connected to the server, and use the name from those
credentials for access control. This method does not require any implementation of OPC Security by
the OPC client, since no interface calls are necessary.
Using the IOPCSecurityPrivate interface for OPC Security, the OPC client must make a call to the
OPC server to log on with a user name and password. In this scenario, the OPC client must
implement and follow the OPC Security specification in terms of following the calls necessary to
provide credentials. The credentials provided through the private interface override those provided
from the NT interface. The OPC client may choose to log off, at which point the NT credentials are
used until the log on call is made again.
Location
Some of the interface calls made from an OPC client to an OPC server require the client to provide
an OPC item ID. The OPC Framework will take the OPC item ID provided, and determine whether
access to that location is allowed or not. A particular server installation may want to control access
to a particular device or branch in the hierarchy, and is able to do so by setting permissions for a
partial item ID or path.
Type
There are seven types of interface functionality in the OPC Framework (specifically the OPC Outer
Layer) that are controlled using OPC Security:
1. Browsing
2. Adding items
3. DA Reading
4. DA Writing
5. HDA Reading
6. HDA Writing
7. HDA Deleting
Browsing is the least intrusive, followed by adding items, reading values from the items, and finally
writing to the items being the most intrusive. There are multiple interfaces, and functions within
those interfaces, that can be used to perform the types of functionality listed above. Thus, security
control has been added to each possible entry. For example, read control has been added to group
subscriptions call-backs as well as synchronous reads and asynchronous reads – denying read
control would disable reads for the possible types.
A location that is being accessed by an OPC client may have different permissions for the different
types of access. For example, one particular item may be browseable, added, and read, but the
writing permissions might be restricted so that the user cannot interfere with the operation of the
end device.
Note: Of the seven functionality types listed above, six of them make use of the full OPC item ID
when an interface call is made from the client to the server: Adding Items, Reading, Writing, or
Deleting. When browsing, only a partial path leading to an OPC item may be known at any location
in the browsing hierarchy.
2. Enter the password created during the installation of the OPC server.
Note: The default password provided for you during installation (if you chose to use the
default) is MatrikonOPC.
3. Click on the OK button.
4. The MatrikonOPC Tag Security Configuration Utility screen (Figure 68) appears.
The MatrikonOPC Tag Security Configuration Utility screen displays the name of the OPC
server that is being configured for tag security. In Figure 68 above, the Utility screen shows that
the MatrikonOPC Server for Simulation and Testing tag security is being configured.
The left-hand side of the Utility screen shows a column of action icons that can be clicked upon.
These actions are further described later in this appendix. Some actions may not be applicable,
depending on the context in which they are used, and are identified by greyed-out icons.
In the center of the Utility screen there are descriptions for each of the actions that can be
performed. The appearance of these descriptions can be toggled at any time by clicking on the
Hide Help/Show Help link that exists in the bottom-right corner of the Utility screen. When the
Help screen is hidden, a list of users and groups that have been added appears (Figure 69). By
default, there is always a user named Everyone in the Users & Groups list. This user defines the
permissions used for other NT users that are not configured.
Note: After any action is performed, the changes made do not take effect until either the OK or
Apply button has been selected. Clicking on the OK button saves the changes and closes the
Utility screen. Clicking on the Apply button saves the changes and keeps the Utility screen open.
Clicking on the Cancel button or the X button on the top-right of the screen, discards any changes
made.
Add User
There are two types of users for which security can be configured: NT Users and Private Users.
Adding a user to the configuration will allow permissions to be defined for that user. For NT users,
the IOPCSecurityNT interface is used, and for Private users, the IOPCSecurityPrivate interface is
used.
NT User
To add an NT user:
1. From the MatrikonOPC Tag Security Configuration Utility main screen, click on the Add
User button.
3. By default, the local machine name appears in the From this Location field. To browse to
a different location, click the Locations button.
4. The User field can be entered manually. Clicking on the Check Name button performs
validation on the entered user. The user names are the same as the Windows NT domain
names used on the network. To avoid manually entering a user, click on the Search button,
and select a user from the displayed list of users.
5. To add the selected user, click on the OK button. The user is then added to the list of users
and/or groups currently defined (refer to Figure 71 for a sample list of defined users and
groups).
6. The Edit <Username> window (Figure 76) appears. Follow the instructions in the Edit
User section for adding permissions.
Private User
Private users have names and passwords associated with them, custom to the OPC client
application, which must implement the OPC Security Private interface for this section to be
meaningful. Private users exist only in the OPC server. They are not created in any NT domains.
To add a Private user:
1. From the MatrikonOPC Tag Security Configuration Utility main screen, click on the Add
User button.
2. The Add User window (Figure 70) appears.
3. Select the Private User option button (Figure 72).
Add Group
Groups are used to group users together so that they can share common permissions. Groups are
not necessary to use OPC Security. However, they are convenient when you need to apply common
permissions to multiple users. A group must contain at least one user, and any combination of
users can be grouped together.
Note: A user can exist in multiple groups, but if two or more of the groups have the same
configured path (refer to the Edit User section), and each group defines a permission (Allow/Deny)
for the type of access, then the group whose name alphabetically comes first is used.
There are two types of groups for which security can be configured: NT Groups and Private
Groups.
NT Group
To add an NT group:
1. From the MatrikonOPC Tag Security Configuration Utility main screen, click on the Add
Group button.
3. By default, the local machine name appears in the From this Location field. To browse to
a different location, click the Locations button.
4. The Group field can be entered manually. Clicking on the Check Group button performs
validation on the entered group. The group names are the same as the Windows NT domain
group names used on the network. To avoid manually entering a group, click on the Search
button, and select a group from the displayed list of groups.
5. To add the selected group, click on the OK button. The group is then added to the list of
users and/or groups currently defined (refer to Figure 71 for a sample list of defined users
and groups).
6. The Edit <Groupname> window (Figure 83) appears (for NT Groups, there is only the
Permissions tab). Follow the instructions in the Edit Group section for adding
permissions.
Private Group
To add a Private Group:
1. From the MatrikonOPC Tag Security Configuration Utility main screen, click on the Add
Group button.
2. The Add Group window (Figure 73) appears.
3. Select the Private Group option button (Figure 74).
4. Enter a name for the group to be created. The group is private and will only exist in the OPC
server. The group cannot be created if there is already a configured user or group with that
same name.
5. Click on the OK button to create the group. It will be added to the list of users and/or
groups currently defined (refer to Figure 71 for a sample list of defined users and groups).
6. The Edit <Groupname> window (Figure 83) appears. Follow the instructions in the Edit
Group section for adding permissions.
Duplicate
Another way to create a new user or group is to duplicate an existing one.
To create a new user or group via duplication:
1. From the MatrikonOPC Tag Security Configuration Utility main screen, right-click your
mouse on the user or group you wish to duplicate.
2. From the displayed menu, select Duplicate.
3. The Enter New Name window (Figure 75) appears.
Edit
Once the desired users and/or groups are defined, they must be edited to configure their
respective permissions.
Note: Permissions can also be defined for the user Everyone, which is defined as the default user.
For every NT user not configured in the MatrikonOPC Tag Security Configuration Utility, the user
Everyone is used for determining security permissions.
Permissions for allowing/denying browsing, adding items, reading items, and writing items can be
configured. Permissions are defined for users and groups for a particular location in the server’s
address space hierarchy. A location can either be a tag (i.e., OPC Item ID) or a path leading up to
an item.
Edit User
To edit a user:
1. From the MatrikonOPC Tag Security Configuration Utility main screen, either:
Double-click your mouse on the user you wish to edit, or
Right-click your mouse on the required user and select Edit User from the displayed
menu, or
Click your mouse on the required user, and then select the Edit button.
2. The Edit <Username> window (Figure 76) appears.
Notes:
In this example, the user being edited is User1 so the window’s title reads Edit
User1.
There are two tabs on this window: Permissions and General. The General tab
only appears for private users.
Permissions
On the Permissions tab, the permissions associated with this user relating to browsing, adding,
reading, and writing for any specific paths or OPC items are configured. The Configured Paths
screen section lists the paths and/or OPC items for which permissions are defined. The
Permissions screen section indicates those permissions with option buttons, which can be set to
Allow, Deny, or Unspecified. Selecting Unspecified directs the OPC Framework to look for the
permission higher up in the hierarchy.
From the Permissions tab, when the Add button is selected, the Add Permission screen is
displayed. In the Server Address Space screen section, folders and items are shown as nodes are
selected and expanded.
Red folders indicate a null branch. This means that the item names below this branch do not
contain the branch name, so permissions set on the branch will not reflect on Add, Write, Read,
and Delete permissions for the items below the branch. To properly set permissions on the items
below the branch, they have to be set on the items themselves.
Figure 77 provides an example of a null branch and items below it, all of which are outlined in
black.
When browsing, using the example in the diagram above, Simulation Items is a null branch
(identified by the red folder), Saw-toothed Waves is a non-null branch, and Int1 is an item.
Setting permissions on the Simulation Items branch does not affect Read, Write, Delete, and
Add permissions for the Saw-toothed Waves branch of the Int1 item below that. This is because
when adding the Int1 item, the item ID of the Int1 item is actually Saw-toothed Waves.Int1
and not Simulation Items\Saw-toothed Waves.Int1.
Setting Read, Write, Delete, and Add permissions for the Saw-toothed Waves branch will
affect the items below as Saw-toothed Waves is part of the item ID of the Int1 item (Saw-
toothed Waves.Int1), and therefore the Saw-toothed Waves folder does not appear as a red
folder like the Simulation Items folder does.
Note: User permissions override group permissions. For example, if a defined group is denied
writing privileges to an OPC item, Random.Int4, while a defined user (a member of that group) is
allowed writing privilege to Random items (Random.<itemID>), then the user permissions would
take precedence for that OPC item (even though the permissions relating to the group are a better
match for the OPC item, Random.Int4).
To edit a user’s permissions:
1. Click on the Add button to begin configuring permissions for the current user.
2. The Add User Permission window (Figure 78) appears. This window allows you to browse
the OPC server address space to find either a path in the hierarchy, or a particular OPC
item.
3. Expand on the server address space’s root node and continue to browse to the desired path
in the hierarchy, or the desired OPC item.
Note: Branches (i.e., folders) that are red in colour (see Figure 79) are not part of an item’s
path, but rather are used for browsing organization. Configuring permissions for adding,
reading, and writing will not affect items below it. For more information, refer to
Permissions.
On the General tab (Figure 81) of the Edit <Username> window, the name and password of the
user can be changed.
To edit a user’s name:
1. Enter a new name in the Name field.
2. Click on the OK button.
On the Permissions tab, the permissions associated with this group relating to browsing, adding,
reading, and writing for any specific paths or OPC items are configured. Refer to the Edit User
On the Members tab (Figure 85), the users that are part of the current group are defined. By
default, the Group Members screen section is empty. In Figure 85, User1 has been added to
Group1.
2. The Members screen section lists all the defined users from which you may choose. Select
one or more desired users to become members of the group.
3. Click on the OK button. The selected user or users appear in the Group Members screen
section on the Members tab (Figure 85).
To remove a user from the group:
1. Select that user in the Group Members screen section.
2. Click on the Remove button.
Notes:
If a user name and a group name (to which the user belongs) have permissions
defined for the same location, the user name will be used. If a user belongs to two
groups that have permissions defined for the same location, the group that is
alphabetically first will be used.
The exact location (full item ID for reading, writing, deleting, and adding, or the full
path for browsing) is always looked for first when determining the permission for a
particular user. If the exact location is not found, or is found but does not contain a
defined permission, then the closest match in location is looked at next, and so on.
The root location (i.e., empty string) will always match, and is used if no partial
location match is made.
Delete
To delete a previously added user or group:
1. From the MatrikonOPC Tag Security Configuration Utility main screen, either:
Select the required user or group from the list and click on the Delete button
(Figure 71), or
Change Password
To change the security password for the OPC server:
1. From the MatrikonOPC Security Configuration Utility main screen, click on the Change
Password button (Figure 68).
2. The Change Password window (Figure 87) appears.
Security Details
ACL File
The permissions that the MatrikonOPC Tag Security Configuration Utility creates are stored in
a file named ACL.sec that is located in the same directory as the MatrikonOPC server executable:
C:\Program Files\Matrikon\OPC\< OPC Server Name >\.
ACL.sec is encrypted with 256-bit AES using the password key that was provided during
installation (or changed in the security utility).
While the server is running, if the ACL.sec file is moved or deleted from its location above, security
functions as it did before the file was moved. If the server is re-started with the ACL.sec file
missing, no users will have permissions to do anything (i.e., browsing, adding, reading, writing)
and must re-configure their security settings.
Note: It is advised that this file is backed up and stored somewhere safe, once tag security
configuration has been completed. In the event that this file is lost or deleted by accident, simply
transfer the stored backup (if one was made) to the directory stated above. If ACL.sec becomes
deleted and no backup was made, tag security will need to be re-configured.
Determining Permission
Whenever a browsing, item addition, read, write, or delete operation is performed by the OPC
client, the OPC Framework will call a permission routine to determine if permission is allowed or
denied. Three pieces of information are always sent to this routine call:
1. Identity
2. Location
3. Type
Identity is the user name described in the previous section – either the NT domain name, a private
name, or the default user Everyone. In addition, identity includes any groups (private or NT) that
the user belongs to. Location is either the full item ID or a partial path in the server hierarchy.
Type is the access type: browsing, item addition, reading, or writing. Each piece of information is
checked in the order listed above.
The following information details the procedure used in determining permission rights:
1. Look for a permission match with the NT domain name or private name. This step occurs
only if the NT domain name or private name has been defined in the Users & Groups list.
Examples
This section contains examples of tag security settings made via the MatrikonOPC Tag Security
Configuration Utility, and the impact of these settings.
Default
The default tag security configuration provided is quite simplistic as is shown in Table 69:
As no users or groups are defined, any NT user connecting to the OPC server will use the
Everyone default user for permissions. Only the root level location is defined under the
Configured Paths list, which gives full permissions to the entire OPC server. An administrator will
want to change these default settings for the OPC server to provide more security on its tags.
At this point, more users can be added which belong to a more restricted group. This group may be
denied write capability or restricted to certain areas in the server hierarchy.
Example 2
Following is an example of a tag security configuration for the MatrikonOPC Server for Simulation
and Testing, with sample use-cases. Table 71 lists all defined users and groups and their
associated permissions. Table 72 indicates which users are members of the defined groups.
Unspec. permission indicates Unspecified. Groups in this example are Private Groups.
Case 1
User DOMAIN\no.name connects. This name is not defined, so the Everyone permissions are
used. At the root level location, the default user can browse but no more. The only other location
where permissions are defined for the default user is Configured Aliases where browsing is
Operational Effects
When offline mode is enabled at a particular location in a server’s hierarchy, there is no
communication between the server and the end-device/application to which the location refers.
To ensure that there is no communication when offline mode is enabled, the MatrikonOPC Server
Framework will disable the object associated with that branch. When an object is disabled due to
offline mode, the Enabled checkbox will be cleared (i.e., unselected) in its panel within the
configuration utility. Enabling the object will have no effect while the object has offline mode
enabled. When offline mode is disabled for that particular object, the MatrikonOPC Server
Framework will re-enable it and the Enabled checkbox will be selected (i.e., checked) once again.
3. Either a Pre-Requisites screen (Figure 89) appears, or you are taken directly to the
Licensing Agreement (Figure 90) screen. If the Licensing Agreement screen is the
displayed screen, go to step 5.
4. If the Pre-Requisites screen appears, then click on the Next button to install the listed
pre-requisites.
5. After all pre-requisites have been installed, the License Agreement screen (Figure 90)
appears.
Note: From the License Agreement screen, you have the option of selecting the I reject
the license agreement option. Selecting the I reject the license agreement option
button disables the Next button so your options are to return to the previous screen, cancel
the install by clicking on the Cancel button, or select the I accept the license agreement
option button enabling you to proceed through the install.
6. Read the Software License Agreement, using the scroll bar to view the entire message.
7. Select the I accept the license agreement option button.
8. Click on the Next button. The Setup Type screen (Figure 91) appears.
11. Select the folder in which to install the MatrikonOPC server, or accept the default location
displayed in the Folder path field.
12. Click on the Next button. The Start Menu screen (Figure 93) appears.
13. Select the Start Menu group and specify whether you want shortcuts created only for
yourself, or for all users, by selecting the applicable option button.
14. Click on the Next button. The Enter Password screen (Figure 94) appears.
15. A default password is supplied for you in the Password and Confirm Password fields.
Notes:
The default password provided for you is MatrikonOPC. Note
this password for future reference.
If you need to change the password at a later date, access the
Tag Security shortcut from the Start menu. Click on the
Windows Start button. Select Programs -> MatrikonOPC ->
<OPC Server Name> -> Tag Security. For more
information, refer to Appendix F – Security.
16. Click on the Next button to accept the default password. The Licensing screen (Figure 95)
appears.
19. Click on the Next button. The Installing MatrikonOPC Server for Modbus screen (Figure
97) appears, installation begins, and the product files are copied to the computer.
Note: Prior to starting the installation, you have the option of clicking on the Back button
to change any of the installation information. Click on the Cancel button if you wish to stop
or cancel the installation.
20. When the installation has finished, the MatrikonOPC Server for Modbus Setup
Complete screen (Figure 98) appears stating that the MatrikonOPC server has been
successfully installed.
21. At this point, you have the option of launching any or all of the following by selecting the
necessary checkbox or checkboxes:
Configuration panel
Release Notes
User’s Manual
Quick Start Guide
22. Click on the Finish button to complete the installation and exit the Wizard.
23. The necessary files have now been copied to the target computer, the software components
are registered, and shortcut icons are created in the Start menu.
The files listed in Table 75 are installed by default, in the following location:
C:\Program Files\Common Files\MatrikonOPC\Common
5. Click on the Remove button associated with the MatrikonOPC Server for Modbus program
to initiate the un-install process.
6. The MatrikonOPC Server for Modbus – InstallAware Wizard appears, and the
Welcome to MatrikonOPC Server for Modbus Maintenance screen (Figure 100) is
displayed.
7. Select the Remove option button to un-install MatrikonOPC Server for Modbus entirely.
8. Click on the Next button. The Ready to Uninstall screen (Figure 101) is displayed.
11. When the un-install has finished, the MatrikonOPC Server for Modbus Setup Complete
screen (Figure 103) appears stating that MatrikonOPC Server for Modbus was successfully
un-installed.
12. Click on the Finish button to complete the un-install and exit the Wizard.
13. The program no longer appears listed in the Add or Remove Programs window.