MatrikonOPC Client for ODBC

User’s Manual
MatrikonOPC Client for ODBC
User’s Manual

This manual is a product of Matrikon Inc.

Matrikon Inc.
Suite 1800, 10405 Jasper Avenue
Edmonton, AB T5J 3N4
Canada

Phone: +1.780.448.1010
Fax: +1.780.448.9191
www.matrikonopc.com

Document Revision History:

Document
Date Description Author
Version
2008-06-10 1.0 Initial User‟s Manual for newly designed DOC
MatrikonOPC Client for ODBC.

2008-07-29 1.1 Added point to note in Installation section LB

regarding need to un-install previous instances, if
applicable.

2008-08-19 1.2 Minor edits. LB

2008-09-17 1.3 Minor edits. MNA
Update information for new features in Write to
OPC Items Using a Select Statement section.
Updated the OPC ODBC folder (Table 2) in the
2009-03-20 1.4 Installed Files section. Updated access path in JDJ, LB
Starting the MatrikonOPC Client for ODBC and
Configuration Window sections. Appendix B –
ODBC DSN Configuration updated.

Added Beta tag lines. Updated software version to

3.1.1.0. IE 6 added to Software Requirements
section. DEP settings note removed from
2009-09-15 2.0 Installation section. Contacting Support section LB
updated. Updated Limitations section. Updated
introduction to Appendix A – Distributed COM
(DCOM). Updated DCOM Manual link.

Beta tag lines removed. Updated software version

2009-10-22 3.0 LB
to 3.1.2.0. Formatting fixes.

Updated the screenshot Select OPC Server

2010-08-06 4.0 Connection Window (Figure 20). Updated software BP, LB
version number to 3.1.3.0.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 2

2011-02-03 5.0 Updated software version number to 3.1.4.0. BP

Removed all references to Triggered Writes and

2011-02-08 5.1 updated screen shots to reflect that change. BP
Updated Installed Files and Limitations sections.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 3

SOFTWARE VERSION

Version: 3.1.4.0

DOCUMENT VERSION

Version: 5.1

COPYRIGHT INFORMATION

© Copyright 1997 - 2011, Matrikon Inc. 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 Inc.

CONFIDENTIAL

The information contained herein is confidential and proprietary to Matrikon Inc. It may not be disclosed or transferred,
directly or indirectly, to any third party without the explicit written permission of Matrikon Inc.

LIMITATIONS

Matrikon has made its best effort to prepare this manual. Matrikon makes no representation or warranties of
any kind with regard to the completeness or accuracy of the contents herein and accepts no liability of any kind
including without limitation warranties of merchantable quality, satisfactory quality, merchantability and
fitness for a particular purpose on those arising by law, statute, usage of trade, course of dealing or otherwise.
Matrikon shall not be liable for any losses or damages of any kind caused or alleged to be caused directly or
indirectly from this manual.

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:

Matrikon and MatrikonOPC are trademarks or registered trademarks of Matrikon Inc.

OTHER

MatrikonOPC™ is a division of Matrikon™ Inc.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 4

Table of Contents
Introduction ..................................................................................................................... 9
Who Should Use This Manual .............................................................................................. 9
Overview of Manual ........................................................................................................... 9
References ..................................................................................................................... 10
Document Terminology .................................................................................................... 10
Getting Started............................................................................................................... 11
System Requirements ...................................................................................................... 11
Software Requirements ................................................................................................. 11
Hardware Requirements ................................................................................................ 11
Installation ..................................................................................................................... 11
Installed Files.................................................................................................................. 20
Licensing ........................................................................................................................ 22
Contacting Support .......................................................................................................... 22
Configuration ................................................................................................................. 23
Starting the MatrikonOPC Client for ODBC .......................................................................... 23
Tool Tray Menu ............................................................................................................... 23
Configuration Window ...................................................................................................... 24
File Menu ..................................................................................................................... 26
Database Menu ............................................................................................................ 26
View Menu ................................................................................................................... 26
Help Menu ................................................................................................................... 27
MatrikonOPC Client for ODBC Configuration ........................................................................ 27
OPC Groups and Transaction Groups ............................................................................... 27
Connecting to a Database .............................................................................................. 27
Removing a Database Connection ................................................................................... 29
Creating a Transaction .................................................................................................. 30
Table Writes ................................................................................................................... 31
Defining a Table Write ................................................................................................... 33
Deleting a Table Write ................................................................................................... 40
Deleting a Transaction Tag............................................................................................. 40
Custom Writes ................................................................................................................ 41
Data Values Tab ........................................................................................................... 42
Transaction Options Tab ................................................................................................ 43
OPC Options Tab .......................................................................................................... 45
Transaction Results Tab ................................................................................................. 46
Current Transactions Tab ............................................................................................... 47
Executing Simple Queries .............................................................................................. 48
Using an OPC Item in a Transaction ................................................................................ 49
Creating an Insert Transaction using an OPC Item ............................................................ 51
Write to OPC Items Using a Select Statement .................................................................. 53
General Preferences ...................................................................................................... 54
Saving a Configuration ..................................................................................................... 59
Clearing a Configuration ................................................................................................... 59
Loading an Existing Configuration ...................................................................................... 59
Shutting Down the Server ................................................................................................ 60
Diagnostics .................................................................................................................... 61
Logging .......................................................................................................................... 61
Limitations ..................................................................................................................... 62
Troubleshooting ............................................................................................................. 63
Problems and Solutions .................................................................................................... 63

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 5

 Questions and Answers .................................................................................................... 64
Un-Installation ............................................................................................................... 66
OPC Compliance ............................................................................................................. 69

Table of Appendices
Appendix A Distributed COM (DCOM) ........................................................................ 70
DCOM Configuration Utility ............................................................................................... 70
Default Properties ............................................................................................................ 70
Security Permissions ........................................................................................................ 71
Server Identity ................................................................................................................ 75
Default Protocols ............................................................................................................. 75
Remote Program ID ......................................................................................................... 76
Appendix B ODBC DSN Configuration ......................................................................... 77
DSN Types Note .............................................................................................................. 77
Data Source Configuration ................................................................................................ 77

Table of Figures
Figure 1 - MatrikonOPC Welcome Screen ....................................................................... 12
Figure 2 - Read Me File Screen ....................................................................................... 13
Figure 3 - Choose Destination Location Screen .............................................................. 14
Figure 4 - Advanced Settings Window ............................................................................ 14
Figure 5 - Select Program Manager Group Screen .......................................................... 15
Figure 6 - Registration Information Screen .................................................................... 16
Figure 7 - Installation Information Screen ..................................................................... 17
Figure 8 - Transaction Number Screen ........................................................................... 17
Figure 9 - Licensing Screen ............................................................................................ 18
Figure 10 - Start Installation Screen .............................................................................. 19
Figure 11 - Installation Complete Screen ....................................................................... 19
Figure 12 - Tool Tray ...................................................................................................... 23
Figure 13 - Tool Tray Menu............................................................................................. 24
Figure 14 - Configuration Window .................................................................................. 25
Figure 15 - Database Connection Configuration Window ................................................ 28
Figure 16 - Deleting Database Connection ..................................................................... 30
Figure 17 - Database Deletion Confirmation Message .................................................... 30
Figure 18 - Table Write or Custom Write ........................................................................ 31
Figure 19 - Table Write Transaction Configuration Panel ............................................... 32
Figure 20 - Select OPC Server Connection Window ........................................................ 34
Figure 21 - Add OPC Item(s) Window ............................................................................ 35
Figure 22 - Browse OPC Item(s) Window ....................................................................... 36
Figure 23 - Set Transaction Properties Window ............................................................. 38
Figure 24 - Configured Table Write ................................................................................ 39
Figure 25 - Confirmation Message .................................................................................. 40
Figure 26 - Confirmation Message .................................................................................. 41
Figure 27 - Add Query Window - Data Values Tab .......................................................... 42
Figure 28 - Add Query Window - Transaction Options Tab ............................................. 43
Figure 29 - Add Query Window - OPC Options Tab ......................................................... 45

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 6

Figure 30 - Add Query Window - Transaction Results Tab .............................................. 46
Figure 31 - Add Query Window - Current Transactions Tab ............................................ 47
Figure 32 - Simple Select Transaction Results ................................................................ 48
Figure 33 - Table MS_SQL_TEST2 After Insert Statement .............................................. 49
Figure 34 - Syntax Example............................................................................................ 50
Figure 35 - Successfully Assigned OPC Item .................................................................. 51
Figure 36 - Custom Write GUI - Insert Statement .......................................................... 52
Figure 37 - Custom Insert Transaction Display .............................................................. 53
Figure 38 - Select Statement Example ............................................................................ 54
Figure 39 - Preferences Window - General Tab .............................................................. 55
Figure 40 - Preferences Window - Logging Tab .............................................................. 57
Figure 41 - Preferences Window - Advanced Tab ........................................................... 58
Figure 42 - Add/Remove Programs ................................................................................ 66
Figure 43 - Select Uninstall Method Window .................................................................. 67
Figure 44 - Perform Uninstall ......................................................................................... 67
Figure 45 - Remove Files? Window................................................................................. 68
Figure 46 - Distributed COM Configuration Properties Window ...................................... 72
Figure 47 - Distributed COM Configuration Security Tab ................................................ 73
Figure 48 - Registry Value Permissions Window ............................................................ 74
Figure 49 - Add Users and Groups Window .................................................................... 74
Figure 50 - ODBC Data Source Administration Screen Access Path ................................ 77
Figure 51 - ODBC Data Source Administrator (System DSN Tab) .................................... 78
Figure 52 - Create New Data Source Window ................................................................. 78
Figure 53 - ODBC Microsoft Access Setup Window ......................................................... 79
Figure 54 - Select Database Window .............................................................................. 80
Figure 55 - List of System DSNs ..................................................................................... 80

Table of Tables
Table 1 - Terms and Definitions...................................................................................... 10
Table 2 - Files Installed in "OPC ODBC" Folder ............................................................... 21
Table 3 - Files Installed in "Common" Folder ................................................................. 21
Table 4 - MatrikonOPC Support Regional Contact Information ....................................... 22
Table 5 - After-Hours Support ........................................................................................ 22
Table 6 - Tool Tray Menu Commands .............................................................................. 24
Table 7 - Configuration Window Commands ................................................................... 25
Table 8 - File Menu Commands ....................................................................................... 26
Table 9 - Edit Menu Commands (Server Configuration) .................................................. 26
Table 10 - View Menu Commands ................................................................................... 27
Table 11 - Help Menu Commands ................................................................................... 27
Table 12 - Database Connection Configuration Window Components ............................. 28
Table 13 - Table Write Transaction Configuration Panel Components ............................ 33
Table 14 - Set Transaction Properties Window Components .......................................... 39
Table 15 - Add Query Window - Transaction Text Panel Components ............................. 42
Table 16 - Add Query Window - Data Values Tab Components ....................................... 43
Table 17 - Add Query Window - Transaction Options Tab ............................................... 44
Table 18 - Add Query Window - OPC Options Tab Components ...................................... 46
Table 19 - Add Query Window - Transaction Results Tab Components ........................... 47
Table 20 - Add Query Window - Current Transactions Tab Components ......................... 48
Table 21 - Preferences Window - General Tab Components ........................................... 56
Table 22 - Preferences Window - Logging Tab Components ........................................... 58

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 7

Table 23 - Preferences Window - Advanced Tab Components ........................................ 59

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 8

Introduction
Many industrial operations, such as plants and factories, generate large amounts of data. It is often
necessary to keep a historical record of this data. Trending, cost analysis and safety auditing are
common reasons to keep historical data.
It is common practice to store historical data in a database management system. Many database
vendors provide access to their databases using the Open Database Connectivity (ODBC)
connectivity standard. This standard allows a user to interact with the database using the Standard
Query Language (SQL). The MatrikonOPC™ Client for ODBC provides custom functionality for
transporting OPC data to and from an ODBC data source. Using the graphical configuration tool,
basic functionally to insert and update OPC information in a database can be configured without
specific knowledge of SQL. This software also allows a user to formulate custom queries using a
combination of the SQL, and data tags from the OPC data source.
The ODBC Client can be used for any application that requires DA OPC data to be stored in an
ODBC database. Examples of industries which may benefit from ODBC Client include but are not
limited to, Manufacturing, Oil and Gas, and Pulp and Paper.

Who Should Use This Manual

This manual is intended for use by all users of the MatrikonOPC Client for ODBC.
This manual explains how to install and configure the software, and how to perform common tasks.
In addition, technical information about OPC data items is included, along with sections on
diagnostics and troubleshooting.

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.

This symbol denotes important information that must be

acknowledged. Failure to do so may result in the software not
functioning properly.

Font displayed in this color and style indicates a hyperlink to the

BOLD applicable/associated information within this document, or if
applicable, any external sources.

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” will automatically take 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 instructions for installing the client, and how to contact
MatrikonOPC‟s Support team.
Configuration – shows how to start and configure the client, and describes each
component in detail, including windows/screens, panels, tabs, and menu commands.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 9

 Diagnostics – explains how to use logging, statistical items, data qualities, timestamps,
and result codes to get the most efficiency from the user‟s system.
Limitations – provides information on specific performance and operational limitations of
the software
Troubleshooting – provides solutions for common problems that may be encountered, and
answers to frequently asked questions.
Un-installation – provides instructions on un-installing software.
OPC Compliance – details on the OPC standard the client uses for communication.
Appendices:
o A – Distributed COM (DCOM)
o B – ODBC DSN Configuration

References
This document references information found within the following documents/sites:
www.opcfoundation.org
www.matrikonopc.com
www.opcsupport.com

Document Terminology
The terms screen and window are used interchangeably throughout this document.
Table 1 provides a list of definitions for terms used throughout this document.

Term/Abbreviation Description
Component Object Model. A method for organizing software, specifying how to
COM
build components that can be dynamically interchanged.
DA OPC Data Access. Provides access to real-time process data.
Distributed Component Object Model. An extension of COM that allows
DCOM
communication between COM components over a network.
Human Machine Interface. Device that allows interaction between the user and
HMI
machine. Typically used in process control applications.
Matrikon Matrikon Inc.
MatrikonOPC Matrikon‟s brand name for its OPC servers and clients.
A communication standard. Refer to www.opcfoundation.org for more
OPC
information.
PLC Programmable Logic Controller.
Open Database Connectivity. A standard defining a method for applications to
ODBC
interact with compliant databases.
Table 1 - Terms and Definitions

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 10

Getting Started
This chapter contains important information about installing the client and how to contact
Matrikon‟s Support team.
The System Requirements section shows how to avoid future problems by ensuring that the
system meets the minimum software and hardware requirements. Detailed step-by-step
instructions in the Installation section walks the user through the installation process and lists the
files that are installed during this process.
Once the client has been installed, refer to the Licensing Procedures document that was installed
along with the client and this User‟s Manual, to learn how to obtain the appropriate license. If any
problems are encountered during installation or licensing, refer to the Contacting Support section
for information about how to contact the MatrikonOPC Support team for assistance.

System Requirements
The software has minimum Software and Hardware system requirements. These requirements
must be met for the software to function properly.

Note: To install and configure a MatrikonOPC product, you must be

set up as an administrative user account rather than a restricted user
account.

Software Requirements
The product requires the following software:
Microsoft Windows XP or 2003 or 2000
Microsoft Internet Explorer 6 SP1 (or better)
.NET 1.1 Framework (included in install package)

Note: It is recommended that the most current service packs are

installed.

Hardware Requirements
The product requires the following hardware:
Intel® Pentium® 4 Processor
512 MB RAM
40 GB 7200 RPM hard drive

Installation
Once the system requirements have been met, you are ready to install the software.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 11

 Notes:
As part of the installation process, the MatrikonOPC Analyzer
tool is installed and used to detect the system settings that
affect the use of this software. No information is communicated
back to Matrikon. Information is stored on this system only for
future use by MatrikonOPC Support to assist with
troubleshooting, if required.
If you already have an instance of MatrikonOPC Client for
ODBC installed on your machine, you must completely un-
install the old ODBC client before you install the new
one. If you attempt to install one instance on top of another,
you will be required to perform a re-install.

To install the software:

1. Insert the MatrikonOPC Client for ODBC CD into the CD drive.
2. If the MatrikonOPC Welcome screen does not automatically appear, double-click the
MatrikonOPCODBCClient.EXE file. The MatrikonOPC Welcome screen (Figure 1) appears.
Note: The Version number located in the lower left corner of the screen indicates the
version number of the software that is being installed. The text “Version X.X.X.X” will be
replaced with the specific product version.

Figure 1 - MatrikonOPC Welcome Screen

3. Read the information displayed in the Welcome screen.

4. Click on the Next button.
5. The Read Me File (i.e., End-User License Agreement) screen (Figure 2) appears.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 12

 Notes:
From the Read Me File screen, you also have the option of clicking on the Back
button to return to the Welcome screen, or selecting the Do Not Accept button.
Selecting the Do Not Accept button displays an Install window which gives you the
option of either resuming the installation or quitting the setup.
From this point onward, the Back button is available allowing you to return to the
previous screen or screens.

Figure 2 - Read Me File Screen

6. Read the End-User License Agreement (EULA), using the scroll bar to view the entire
message.
7. Click on the Accept button. The Choose Destination Location screen (Figure 3) appears.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 13

 Figure 3 - Choose Destination Location Screen

8. Click on the Advanced button to display the Advanced Settings window (Figure 4).

Figure 4 - Advanced Settings Window

9. Leave all of the checkboxes selected to install all client components (you may clear any
components that you do not want to install). It is recommended that you install these files.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 14

 Notes:
At this point, users may also choose to change the Program ID used to connect to
the OPC server. It is recommended that users keep the default Program ID. Some
OPC clients may impose restrictions on the Program ID length, so it may be changed
if required.
Users may also choose to have the OPC server installed as a service and
automatically set the DCOM permissions.
The GDA plug-ins are listed in the Advanced Settings window. If some of these
components are not selected, this means that you do not currently have the
database client tools installed that are required for this plug-in to function properly.
If you require this plug-in, then install your database client tools on this PC, and
after that is complete run this installation package again.
10. Click OK to accept the changes. The Advanced Settings window will close and return you
to the Choose Destination Location screen.
11. Click on the Next button to install the client files into the default location. The Select
Program Manager Group screen (Figure 5) appears.
Note: To select an alternative installation folder, click on the Browse button on the
Choose Destination Location screen.

Figure 5 - Select Program Manager Group Screen

12. Click on the Next button to add the client icons to the default program manager group. If
required, scroll through the list to select another program manager group. The
Registration Information screen (Figure 6) appears.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 15

 Figure 6 - Registration Information Screen

13. Enter the name and email address, as well as the company’s name, address, and
telephone number in the appropriate fields. The Computer Name field is automatically
populated.

Note: It is important that you enter a valid email address in the

Registration Information screen, as this is used by the licensing
and registration programs.
14. Click on the Next button. The Installation Information screen (Figure 7) appears.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 16

 Figure 7 - Installation Information Screen

15. Select the I am evaluating this software option button to enable the software for a 30-
day evaluation period, or until a permanent license is obtained. Go to step 18.
16. If the user already has a transaction number, select the I have or will be purchasing the
software option button. Click on the Next button. The Transaction Number screen
(Figure 8) is displayed.

Figure 8 - Transaction Number Screen

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 17

 17. In the Transaction Number field, enter the number supplied by the MatrikonOPC Support
representative.
Note: When the transaction number is entered, a registration file (AuthorizeRequest.MTK)
is generated in the software installation directory. To receive the permanent license file
(Authorize.MTK), email the AuthorizeRequest.MTK file to the MatrikonOPC Licensing
department ([email protected]). For more information about licensing your
software, refer to the Licensing Procedures document that accompanies this manual and
your software.
18. The Licensing screen (Figure 9) appears displaying the status of the MatrikonOPC Client for
ODBC license.

Figure 9 - Licensing Screen

19. Click on the Next button. The Start Installation screen (Figure 10) appears.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 18

 Figure 10 - Start Installation Screen

20. Click on the Next button. The installation begins and the client 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.
21. When the installation has finished, the Installation Complete screen (Figure 11) appears.

Figure 11 - Installation Complete Screen

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 19

 22. At this point, you have the option of launching any or all of the following by selecting the
necessary checkbox or checkboxes:
configuration video (.wmv)
user manual (.pdf)
release notes (.pdf)
23. Click on the Finish button to complete the installation and exit the installation program.
24. The necessary files are copied to the target computer, the software components are
registered, and shortcut icons are created in the Start menu.
Note: At this point, it is recommended that you verify the DCOM
settings. Reference to the DCOM configuration can be found in the
DCOM Manual. This configuration varies for different operating
systems.

Installed Files
The installation program copies all necessary files to the target computer and creates shortcut
icons in the Start menu.
The files listed in Table 2 are installed by default, in the following location:
C:\Program Files\Matrikon\OPC\OPC ODBC

File Name Description

A file used both to enable the trial license and to request a
AuthorizeRequest.MTK
permanent software license (please send to MatrikonOPC Licensing).
ClearFiles.exe Un-install program.
GDAODBC.dll Dynamic link library used for ODBC connectivity.
GDAODBCCfg.ocx Server ActiveX configuration panels.
INSTALL.LOG Installation log file.
Licensing Procedures.pdf Document describing the licensing procedures for this client.
LogLibrary.dll Log library file.
MatrikonOPC Client for ODBC
Release Notes.pdf Release Notes for the client.

MatrikonOPC Client for ODBC

User Manual.pdf This User’s Manual for the client.

Moses.log ODBC client GUI log.

Dynamic link library implementing portions of the graphical
MWCommon.dll
configuration tool
Dynamic link library implementing portions of the graphical
MWControls.dll
configuration tool
An XML schema definition for the configuration files used for the
OdbcClient.xsd ODBC Client. This file is necessary to validate that configuration files
are correct upon load.
ODBCClientConfiguration.wmv A tutorial video to configure the OPC Client for ODBC.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 20

 File Name Description
ODBCOPCCLIENT.exe Client executable.
OdbcOpcClientGui.exe Graphical client configuration executable.
ODBCOPCCLIENTps.dll The interface library between the GUI and the client.
ODBCOPCCLient.log ODBC Client log file.
Project Info.log Product version information for the current build.
SampleDB.mdb Sample database.
SampleMTKConfig.xml Sample configuration loaded on start-up.
UNWISE.EXE Un-install program for the client.
Table 2 - Files Installed in "OPC ODBC" Folder

The files listed in Table 3 are installed by default, in the following location:
C:\Program Files\Common Files\MatrikonOPC\Common

File Name Description

EULA.pdf License document.
MTKAUTHORIZE.EXE Matrikon product authorization utility.
MatrikonOPC Automation Component – enables developers to access OPC
OPCAuto.dll
data from client applications developed using Automation tools.
OPCDA20_AUTO.DOC MatrikonOPC Automation Component interface standard.
MatrikonOPC Automation Component – enables developers to access OPC
OPCDAAUTO.DLL data from client applications developed using automation tools (e.g., Visual
Basic, VBA, VB Script).
The proxy-stub files to allow OPC clients to make remote connections to an
opchda_ps.dll
OPC HDA Server.
opchda10_auto.doc Developer documentation for HDA Automation Component.
MatrikonOPC HDA Automation Component – enables developers to access
OPCHDAAuto.dll
OPC HDA Data from client applications developed using Automation tools.
PSTCFG.EXE Matrikon product configuration utility.
PSTCFGPS.DLL Matrikon product configuration marshalling library.
EULA.pdf End-User License Agreement in PDF format.
Hasp.exe Hardware Key Licensing Utility.
haspds_windows.dll Hardware Key Licensing Library.
Hinstall.exe Hardware Key Device Driver Installation Utility.
ACLConfig.exe GUI to Tag Security Utility
Table 3 - Files Installed in "Common" Folder

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 21

Licensing
Most MatrikonOPC products require some form of licensing criteria be met to ensure that it
functions successfully
The MatrikonOPC ODBC Client supports both software and hardware licensing.

IMPORTANT TO NOTE:
The following licensing information is described in detail within the
Licensing Procedures document which accompanies the ODBC Client
software and User’s Manual:
Requesting a software license.
Enabling a temporary software authorization.
Installing a permanent software license.
Generating a new AuthorizeRequest.MTK file.
De-licensing software.
Installing a Hardware licensing
Licensing Q&A and Troubleshooting.

Note: De-licensing deactivates the transactions and re-licensing does not activate them. You will
have to activate them again, manually.

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 4.

Region Office Hours Contact Information

North America
8:00 am-5:00 pm +1-877-OPC-4-ALL
UTC/GMT -7 hours (MST)
Europe /Africa * +49-221-969-77-0
9:00 am-5:00 pm
UTC/GMT +1 hours (CET) (Request OPC Support)
Australia/Asia * +61-2-4908-2198
9:00 am-5:00 pm
UTC/GMT +10 hours (AEST) (Request OPC Support)
* Toll-free regional numbers coming soon!
Table 4 - MatrikonOPC Support Regional Contact Information

For after-hours support in all regions, please use either of the following numbers. There is no
extra charge from MatrikonOPC for calling their after-hours support numbers.

Region Contact Information

+1-780-231-9480
All
+1-780-264-6714
Table 5 - After-Hours Support

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 22

Configuration
The client GUI allows users to view and alter configuration parameters at run time. When a user
views a configuration parameter, the information is retrieved and displayed. The updated
parameters are sent as a group to the client when submitted.
Minimal configuration of the MatrikonOPC Client for ODBC is required for the client to function
properly, but users can customize the client‟s behaviour as required. This chapter shows users how
to start and configure the client and describes each component in detail, including the windows,
panels, and menu commands.
The Starting the MatrikonOPC Client for ODBC section of this manual shows users how to start
the software. The next sub-sections describe the Tool Tray Menu, Control Panel, and
Configuration window, in detail.
At the end of this section are four sub-sections that cover saving, clearing, and loading
configuration settings, and shutting down the server.

Starting the MatrikonOPC Client for ODBC

To launch the MatrikonOPC Client for ODBC, choose the appropriate shortcut from the Start menu.
To start the MatrikonOPC Client for ODBC:
1. Click on the Windows Start button and select Programs -> MatrikonOPC -> OPC Client
for ODBC, and choose OPC Client for ODBC.
By default, the client is installed as a Windows service. The client can be installed as a
service during the installation process by selecting the Install as a service checkbox on
the Advanced Settings window (Figure 4) accessed via the Choose Destination
Location screen (Figure 3). When the client is installed as a service, the splash screen does
not appear, nor does the logo appear in the Tool Tray. Instead, the main Configuration
window is immediately displayed. If the client is installed as a Windows service, users can
also start it using the Service Control Manager applet (under the Windows Control
Panel).
2. If the client is not installed as a Windows service, the server starts and the Matrikon logo
appears in the Tool Tray (Figure 12), located by default in the system tray.

Figure 12 - Tool Tray

If the client is not installed as a Windows service, the Welcome screen appears briefly
when the client starts up.

Note: If the client is installed as a service, users can choose to run it

as an application by re-registering the OPC server executable using
the /REGSERVER command-line switch.

Tool Tray Menu

Note: If the client is installed as a Windows service, the Tool Tray and Tool Tray Menu are not
available.
The Tool Tray Menu provides access to the Configuration window, and the About screen. It also
contains the commands to shut down the server.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 23

To view the Tool Tray menu:

1. Right-click your mouse on the Matrikon logo .

2. The Tool Tray menu appears (Figure 13).

Figure 13 - Tool Tray Menu

Table 6 describes the commands in the Tool Tray menu.

Command Description
Configure Displays the main Configuration window.
Shutdown Shuts down the server.
Table 6 - Tool Tray Menu Commands

Configuration Window
Note: If the client is installed as a Windows service, the Tool Tray Menu is not available. In this
case, the Configuration window is then accessed via the Windows Start menu: Start ->
Programs -> MatrikonOPC -> OPC Client for ODBC -> OPC Client for ODBC
The Configuration window allows the user to configure database connections, table writes and
custom writes. These operations will be discussed in depth later in this section.
If the client runs as a local executable, it will remain running even after the main configuration
window is closed, even if no database transactions are configured.
If the client runs as an NT service, it will remain as long as it is not manually shut down. Closing
the main configuration window will shut down the configuration utility, but will not interfere with
the normal operation of the client.
To view the Configuration window:
1. From the Tool Tray Menu or the Control Panel, select Configure.
2. The Configuration window (Figure 14) appears.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 24

 Figure 14 - Configuration Window

Table 7 describes the commands in the main Configuration window.

Command Description
Main Menu Provides access to the File, Database, View, and Help menus.
Main Toolbar Provides shortcut buttons for commonly performed operations.
Launches the Database Connection Configuration window
Connect to Database… (Figure 15) to allow the user to configure the database connection.
Displays a tree of configured table writes. By right-clicking on a
Configuration Overview
component, the user can choose to delete the component.
Undoes changes to a transaction. By selecting this option, the
Undo
transaction is reverted to the last applied state.
Adds or updates the current transaction with the configuration
Apply
specified in the GUI.
Deletes the current database, transaction or OPC item from the
configuration. When deleting a database, transaction or OPC item,
Delete note its position in the Current Overview tree. The deletion
operation will delete the current tree leaf and every leaf below it.
Table 7 - Configuration Window Commands

The following sections describe the menus available from the Configuration window, and what
they are used for.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 25

 File Menu
Table 8 describes the File menu commands.

Command Description
Clears the current configuration and starts a new one. You will be given
New the option to save the current configuration before clearing the existing
one.
Clears the current configuration and loads a new one from an existing file.
Open Before clearing the old configuration, you are prompted to save the
current one. Displays the Open window to prompt for the file name
Saves the current configuration to an XML file. Displays the Save
Save Configuration window to prompt for a new file name if the configuration
is new and has not been saved before.
Saves the current configuration to an XML file. Displays the Save
Save As
Configuration window to prompt for a new file name.
Shuts down the MatrikonOPC Client for ODBC and closes the
Shutdown
Configuration window.
Closes the Configuration window. If the current configuration has not
been saved, you are prompted about whether or not to save the
Exit
configuration before closing. Upon exiting the window, the MatrikonOPC
Client for ODBC remains running in the background.
Table 8 - File Menu Commands

Database Menu
Table 9 describes the Database menu commands used to configure database connections and
transactions.

Command Description
Connects an ODBC data source to the client. Selecting Connect to
Connect to Database Database will launch the Database Connection Configuration
window (Figure 15).
Begins configuring a new table write transaction for the selected
Table Write database. This option is greyed out when the currently selected tree
leaf is not a database.
Begins configuring a new custom write for the selected database. This
option opens the Custom Write configuration window. The custom
Custom Write
write option is greyed out when the currently selected tree leaf is not a
database.
Table 9 - Edit Menu Commands (Server Configuration)

View Menu
Table 10 describes the View menu command.

Command Description
Displays the Preferences window which is described in detail in the
Options section General Preferences of this manual. The Preferences window

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 26

 Command Description
allows you to configure General, Logging and Advanced options.
Table 10 - View Menu Commands

Help Menu
Table 11 describes the Help menu command.

Command Description
Displays the Welcome screen, which includes information about the
About
software version.
Table 11 - Help Menu Commands

MatrikonOPC Client for ODBC Configuration

The MatrikonOPC Client for ODBC requires minimal configuration to setup OPC server and database
communication. Communication between OPC servers and databases is defined by transactions.
The term “transaction” refers to a mapping between a set of OPC items and a single database
table. A configured transaction specifies how OPC item data is written to a database table, how
database table information is written to OPC items or a combination of both.
The MatrikonOPC Client for ODBC defines two types of transactions: table writes and custom
writes, both of which are discussed later in this manual.

OPC Groups and Transaction Groups

OPC servers use the concept of groups to define communication properties for a set of OPC items.
When configuring a transaction, MatrikonOPC Client for ODBC will automatically create the
necessary groups. However, transactions will assume a number of properties of these groups.
These properties remain configurable. To fully utilize the MatrikonOPC Client for ODBC, it is
necessary to have a basic understanding of how these properties affect the behaviour of a
transaction.
The update rate for an OPC group defines the minimum time (in milliseconds) between updates for
an OPC item. If this value is set too low, the OPC server may become overwhelmed trying to obtain
fresh values from the device. This value should never be set below 100 milliseconds.
The I/O type refers to how data for items in this group will be retrieved from the OPC server.
Communication with an OPC server may either be synchronous or asynchronous. When using
synchronous communication, the OPC server polls the device for the values of OPC items. The
frequency of this polling will be no lower than the group update rate.
The asynchronous communication I/O type does not periodically poll the values of OPC data items.
Rather, this communication type creates a subscription to each item in the OPC group. Whenever a
subscribed item changes, the server reports the new values to the client. The number of changes
reported is limited by the group update rate. If the value changes more than once during the
update rate, only one of these values will be reported.
The chosen I/O type affects how transactions are executed. If synchronous I/O is chosen, the
transaction is executed for each OPC item once per polling period. If asynchronous I/O is chosen, a
transaction will only be executed for an item when a change in data values is reported.

Connecting to a Database
Before configuring a transaction, it is necessary to define a database connection. The database
connection is configured in the Database Connection Configuration window (Figure 15).

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 27

 Figure 15 - Database Connection Configuration Window

The Database Connection Configuration window components are described in Table 12.

Command Description
The name of the data source, which can be obtained from the ODBC “Data
Database Sources” section in the Windows Control Panel. For more detailed
information, refer to Appendix B - ODBC DSN Configuration.
Select this button to refresh the Database list. This option is used to
allow newly configured ODBC data sources to be shown in the Database
dropdown.
Selecting this button will access the ODBC Data Source Administrator
Configuration window. This option provides the ability to configure new ODBC data
sources.
The name of the user that the MatrikonOPC Client for ODBC must use to
connect to the database.
User Name
Note: This field is dependent upon the setup of your database. If the
database does not require authentication, then this field can be left blank.
The password for the above user name.
Password Note: This field is dependent upon the setup of your database. If the
database does not require authentication, then this field can be left blank.
The amount of time (in seconds) that the MatrikonOPC Client for ODBC
Timeout(s)
must wait for the ODBC data source before declaring a timeout.
Specifies whether the MatrikonOPC Client for ODBC is permitted only to
Read Only read from the database (i.e., checkbox is selected), or if it can write as
well (i.e., checkbox is cleared).
Table 12 - Database Connection Configuration Window Components

To define and connect to a database:

1. From the main Configuration window (Figure 14), select the ODBC Configuration node in
the Configuration Overview pane on the left, choose one of:
Click on the Connect to Database button in the Database Connection panel on
the right side of the screen, or

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 28

 Click on the Connect To Database icon on the toolbar, or
Select the Connect To Database menu option from the Database menu.
2. The Database Connection Configuration window (Figure 15) is displayed.
3. Select an ODBC data source from the Database drop-down list.
4. If the desired ODBC data source is not configured, use the Configuration button to
configure it without leaving the ODBC Client Configuration window (refer to Appendix B -
ODBC DSN Configuration).

Note: Clicking on the Configuration button (on the Database

Connection Configuration window) takes you to the ODBC Data
Source Administrator screen where you can create a data source
configuration. Once you finish the new ODBC data source
configuration and return to the Database Connection Configuration
window, you MUST click on the Refresh ( ) button to refresh the list
of available ODBC data sources.

5. If a username and password are required for the database, enter them in the User Name
and Password fields.
6. Click on the OK button to add the database. The Database Connection Configuration
window closes.

Removing a Database Connection

To remove/delete a database connection:
1. From the Configuration window, in the Configuration Overview pane, highlight the
database you wish to remove and do one of:
Right click your mouse on the desired database icon in the Configuration
Overview pane and select Delete (highlighted in red in Figure 16) from the
displayed menu, or
Click on the Delete button (highlighted in blue in Figure 16) at the bottom right of
the Configuration window, or

Click on the Delete icon (highlighted in green in Figure 16) on the toolbar.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 29

 Figure 16 - Deleting Database Connection

2. A confirmation message (Figure 17) appears asking you to confirm the action and warning
that deleting a database connection also deletes any table and custom writes configured for
the database.

Figure 17 - Database Deletion Confirmation Message

3. Click on the OK button. The confirmation message closes and you are returned to the
Configuration window and the selected database is no longer listed in the Configuration
Overview pane.

Creating a Transaction
Note: Before creating a table write, a database connection must be configured. For assistance,
refer to Connecting to a Database.
To create a transaction:
1. To create a table write for a database select the desired database node from the
Configuration window in the Configuration Overview pane.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 30

 2. The Transaction Configuration and Configuration Parameters screen sections are
displayed in the right pane of the Configuration window (Figure 18).
3. From this screen, you can create either a Table Write or Custom Write transaction.

Figure 18 - Table Write or Custom Write

Table Writes
Table writes are used to write attributes of an OPC item to a database table. The user selects a set
of OPC items to be associated with each transaction.
A table write may be classified as either an insert or an update. Both inserts and updates are
analogous to their corresponding SQL operation. An insert transaction writes a new table entry to
the database each time it is executed. An update transaction updates each entry in the database
meeting the update criteria. A table write update will only ever update database entries with the
same item name. Additionally, you may specify whether to update database entries only if their
quality matches that of the current OPC item. The behaviour of update transactions for this query
is subtly different than SQL updates. There is one minor difference between an ODBC client update
and an SQL update. For ODBC client updates where there are no table entries that match the
update criteria, an entry with the new OPC item information is inserted into the database.
To launch the table write transaction configuration panel:
1. From the Configuration window, in the Configuration Overview pane, select the required
database (Figure 18).

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 31

 2. Either click on the Table Write button, or select the Table Write menu option under the
Database menu.
3. The table write transaction configuration panel (Figure 19) is displayed.

Figure 19 - Table Write Transaction Configuration Panel

The configuration panel components are described in Table 13.

Command Description
Allows you to enter the name used to identify a transaction. When a
Transaction Name
transaction is first created, it is given an automatically generated name.
Click on this button to access the Set Transaction Properties window
which is used to define custom properties for the transaction. See
Properties
Customize the OPC Specific Settings to view the window and for an
explanation of these properties.
The name of the computer containing the OPC server. If applicable, this
Computer Name name includes the network path. This field can be entered manually, or
populated using the Browse Servers command.
The ProgID for the OPC server. This field can be entered manually, or
OPC Server
populated using the Browse Servers command.
Use this button to browse for the OPC server to use with the transaction.
Browse Servers OPC servers can be browsed on the local machine or, if applicable, the
network neighbourhood.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 32

 Command Description
The OPC items for the transaction. This field can be entered manually, or
OPC Items
populated using the Configure command.
Configure Browse and select the OPC items involved in this transaction.
Transaction Table The name of the table for the transaction.
Click on this button to manually refresh the list of tables available from this
Refresh database.
Transaction Type Used to specify whether the transaction will be an insert or update.
OPC Item Attribute to Used to specify the table columns where the Name, Value, Quality and
Database Column Timestamp data are to be written. To be a validate Table Write, a column
Mapping mapping must be chosen for at least one of the OPC item attributes.
Table 13 - Table Write Transaction Configuration Panel Components

Defining a Table Write

A table write can be defined in as few as five steps, with two optional steps as described below.
1. Choose a Transaction Name (Optional)
Enter a name for the table write in the Transaction Name field. This name must be unique, it
cannot match the name of other table or custom write transactions. By default, a unique name of
the form Transaction_X, where X is a number, is generated when the query is created.

2. Choose an OPC Server

To browse the OPC server, click on the Browse Servers button to launch the Select OPC Server
Connection window (Figure 20).

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 33

 Figure 20 - Select OPC Server Connection Window

From the Select OPC Server Connection window, select a server from either a local or network
machine. This option will automatically populate the Computer Name and OPC Server fields.
Alternately, these names can be entered directly into these fields.
Click on the OK button to close the Select OPC Server Connection window.
3. Choose OPC Items
To browse OPC items, from the table write transaction configuration panel on the Configuration
screen, click on the Configure button to display the Add OPC Item(s) window (Figure 21).

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 34

 Figure 21 - Add OPC Item(s) Window

To instantiate a browse for available items, click on the Browse button on the Add OPC Item(s)
window. This will launch the Browse OPC Item(s) window (Figure 22) containing the browsed
items.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 35

 Figure 22 - Browse OPC Item(s) Window

Multiple items can be selected from the Browse OPC Item(s) window. Browsing items will
populate the OPC Items field in the table write transaction configuration panel on the
Configuration screen. Items may also be typed directly into the OPC Items field. If the server
address space cannot be browsed, OPC items may be entered manually.
Select the item or items you wish to add.
Click on the Add Item button. The Browse OPC Item window closes and you are returned to the
Add OPC Item(s) window where the selected item or items are now listed.
Click on the OK button to close the Add OPC Item(s) window and return you to the
Configuration window where the selected items are now listed in the OPC Items field.

4. Choose a Transaction Table

From the table write transaction configuration panel on the Configuration screen, in the
Transaction Table field, select a table from the database to write to. If the name of the table is
known, it can be typed directly into the Transaction Table field. Otherwise, the table can be
selected from the drop-down list.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 36

 Notes:
Selecting the drop-down list may trigger the warning that it
could take several minutes to load the table names. For many
databases, this operation will take no more than a few seconds
even though the warning appears. However, in some instances
it may take several minutes to gather this information. This
does not affect the operation of previously configured
transactions.
The GUI will only re-load table information for a database if
you navigate away from the database or any of its configured
transactions. In instances where loading the table names is a
slow process, further delays can be avoided by configuring all
desired transactions for a database before moving onto the
next database.

5. Choose a Transaction Type

In the Transaction Type field on the table write transaction configuration panel, select whether
the transaction should be an Insert or Update operation from the drop-down list. Note that
choosing Update exposes the Update by Quality checkbox in the OPC Item Attribute to
Database Column Mapping screen section.

6. Choose an OPC Item Attribute to Database Column Mapping

The OPC Item Attribute to Database Column Mapping screen section is used to specify which
database columns the attributes of OPC items are written to in the database. For the OPC Name,
Value, Quality and Timestamp attributes, the associated column is selected from a drop-down
list of available columns for that table specified in the Transaction Table field.
It is not necessary to map each attribute to a database column. However, only the mapped
attributes will be written to the table. Each table write must define at least one attribute to column
mapping. Additionally, more than one attribute cannot be mapped to the same table column. If the
Transaction Type field is set to Update, the Update by Quality checkbox is displayed. To filter
updates by quality, select that checkbox.

7. Customize the OPC Specific Settings (Optional)

To customize the transaction group properties click on the Properties button next to the
Transaction Name field (Figure 19) to display the Set Transaction Properties window (Figure
23). A description of each of these options is presented in Table 14.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 37

 Figure 23 - Set Transaction Properties Window

Table 14 describes the Set Transaction Properties window components.

Command Description
OPC Server Displays the ProgID for the OPC server.
Displays the machine and network information where the OPC server
Mchine
resides.
The name of the current transaction. This name may be modified in this
Transaction Name
window.
The minimum update rate (in milliseconds) for the transaction group. This
Update Rate(ms) corresponds to the update rate for the OPC group containing each of the
items in this transaction.
A value which is used for asynchronous communication to specify what
constitutes a change in an OPC item. For example, a dead-band value of
%Deadband
10% means that the value must change by at least 10% to be considered a
change.
Allows you to specify (by selecting an option from the drop-down list) how
data for items in this group will be retrieved from the OPC server. Selecting
a synchronous type tells the client to make a request for data and wait until
the server retrieves it. Selecting an asynchronous type means that the
client makes a request for data, but does not wait for the server to retrieve
the data. Rather, the server responds with an update only after retrieval,
I/O Type and only if item values in the group have changed.
Note that each type in this drop-down list refers to an OPC communication
standard. Not all standards may be implemented by your OPC server.
Selecting Autodetect attempts to automatically choose the I/O type.
Autodetect will attempt to choose an asynchronous type first, but will
default to synchronous if this fails.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 38

 Command Description
By default, OPC timestamps are based on UTC standard time. This field
allows you to select or enter a value to define a time bias that is to be used
to convert this time to local time. The time bias specifies the number of
Time Bias(min) minutes to subtract from UTC time. For example, a time bias of 420 means
420 minutes will be subtracted from the UTC time.
Note: This field is disabled if the Auto Detect Time Bias checkbox has
been selected.
Advanced option to specify the number of SQL statements to bundle as a
Queries/Transaction
single SQL transaction for a MatrikonOPC Client for ODBC transaction.
Selecting this checkbox will result in the automatic calculation of the time
Auto-detect Time Bias
bias setting based on the local settings of the local machine.
Active This checkbox specifies whether or not this transaction is active.
Table 14 - Set Transaction Properties Window Components

After completing these five steps (and two optional steps, if required), click on the Apply button to
activate this transaction. A transaction cannot be executed until it has been applied. Figure 24
shows a complete example transaction.

Figure 24 - Configured Table Write

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 39

Deleting a Table Write
To remove/delete a table write:
1. In the Configuration Overview pane, select the transaction you wish to delete, do one of:
Right click your mouse on the item in the Configuration Overview pane and select
Delete from the displayed menu, or
Click on the Delete button in the bottom right of the Configuration window, or

Click on the Delete icon in the toolbar.

2. Before deleting the transaction, a message (Figure 25) appears asking that you confirm the
deletion of the transaction.

Figure 25 - Confirmation Message

3. Click on the OK button. The confirmation message closes. You are returned to the
Configuration window and the selected transaction is no longer listed in the
Configuration Overview pane.

Deleting a Transaction Tag

Individual OPC items may also be deleted from a table write and can be performed in a few
different ways.
To remove/delete a transaction tag (Method 1):
1. From the Configuration window, in the Configuration Overview pane, select the
transaction from which you wish to delete a tag or tags.
2. In the OPC Items field, highlight those items you wish to remove.
3. Right-click your mouse and select either the Cut or Delete menu option from the displayed
menu.
4. The deleted items no longer appear in the OPC Items field.
5. Click on the Apply button to commit the change.
To remove/delete a transaction tag (Method 2):
1. In the Configuration Overview pane, select the transaction from which you wish to delete
a tag or tags.
2. The items associated with the selected transaction are listed below the transaction.
3. Select the transaction tag you wish to delete, and either:
Right click your mouse on the item select Delete from the displayed menu, or
Click on the Delete button in the bottom right of the Configuration window, or

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 40

 Click on the Delete icon in the toolbar.
4. Before deleting the tag, a message (Figure 26) appears asking that you confirm the deletion
of the tag.

Figure 26 - Confirmation Message

5. Click on the OK button. The confirmation message closes and you are returned to the
Configuration window and the selected tag is no longer listed in the Configuration
Overview pane.

Custom Writes
Using table write transactions, simple insert and update transactions can be configured with a
minimum amount of effort. Sometimes, more sophisticated data manipulation is required.
The MatrikonOPC Client for ODBC can be used to construct complex SQL statements using OPC
item characteristics (name, value, timestamp or quality) and database table columns as
parameters.
To launch the custom write editor:
1. Ensure that you have first created a database connection, described previously in the
section Connecting to a Database.
2. Once a database connection has been established, highlight the database in the
Configuration Overview pane for which you wish to create a custom write. The
Configuration screen will appear similar to that shown in Figure 18.
3. To launch the custom write editor, either click the Custom Write (SQL) button, or select
the Custom Write option from the Database menu. The Add Query window (also referred
to as the custom write editor) appears (Figure 27).
The custom write editor is composed of two panes. The pane on the left (labelled Transaction
Text) is where the SQL statements are entered. The right pane contains a series of tabs used to
configure transaction options, display results of executed transactions, and display query results.
The following sections explain the Add Query window tabs, and illustrate how custom writes are
used by presenting examples.
The Add Query window includes five tabs:
Data Values
Transaction Options
OPC Options
Transaction Results
Current Transactions

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 41

 Data Values Tab
The Data Values tab is displayed in Figure 27.

Figure 27 - Add Query Window - Data Values Tab

The options available in the Transaction Text panel are described in Table 15. These fields appear
in this panel regardless of which tab is selected.

Command Description
Transaction Text Allows you to enter the required SQL statements.
Transaction Name Allows you to enter the name used to identify this custom transaction.
Select this button to create a new blank custom query with a unique,
New Transaction
automatically-generated name.
Select this button to execute the transaction displayed in the Transaction
Text field. This option executes this custom transaction only once, and does
Execute (F5)
not add it to the scheduled transactions for the client. Pressing the F5 key
in the query editor will also execute the query.
Table 15 - Add Query Window - Transaction Text Panel Components

Table 16 describes the components of the Data Values tab.

Command Description
Use this drop-down list to choose which connected database for which to
Database
configure a custom write.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 42

 Command Description
This table column is used to specify the names of variables entered in the
Variable Name Transaction Text pane. There will be a variable definition for each unique
variable name.
This table column is used to specify the values of the variables
Variable Value corresponding to each variable name entered in the Transaction Text
pane. There will be a variable definition for each unique variable name
This pane provides a legend specifying how to define variables in
Variable Declaration statements entered in the Transaction Text window. This legend will
Syntax change to match the start/end delimiters defined in the Transaction
Options tab.
Select this button to accept any changes made in the Add Query window.
Apply
Note: This button stays consistent across all tabs.
Select this button to cancel any changes made and close the Add Query
Close window.
Note: This button stays consistent across all tabs.
Table 16 - Add Query Window - Data Values Tab Components

Transaction Options Tab

Figure 28 displays the Transaction Options tab. The tab components are described in Table 17.

Figure 28 - Add Query Window - Transaction Options Tab

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 43

 Command Description
These options specify how the transaction is scheduled in the client.
If the Execute Transaction When Values Arrive option button is
selected, the transaction will be executed when new values are received for
one or more of the associated OPC items.
If the Execute Transaction At Time Interval option button is selected,
the transaction will be scheduled to be executed at fixed intervals,
Transaction Execution regardless of whether or not any associated OPC item values have changed.
Options This option should be used to ensure that transactions with no associated
OPC items are executed. If this option is selected, the Transaction
Frequency field is enabled.
The Transaction Frequency field is available only if the Execute
Transaction At Time Interval option button is selected. If enabled, this
field allows you to enter or select a value that specifies the frequency (in
milliseconds) at which the transaction is executed.
The Start Delimiter field allows you to select from the drop-down list, the
sequence of special characters used to delimit the beginning of an OPC item
in a custom transaction. Values may either be chosen from the set { <<, {,
{{, [, [[ }, or entered manually. If chosen from the aforementioned set,
the value for the end delimiter automatically matches this choice.
OPC Item Delimiters
The End Delimiter field allows you to select from the drop-down list, the
sequence of special characters used to delimit the end of an OPC item in a
custom transaction. Values may be chosen from the set { >>, }, }}, ], ]]
}. If chosen from the aforementioned set, the value for the start delimiter
automatically matches this choice.
Transaction Text Allows you to select from the Text Size drop-down list, the size of the text
Options displayed in the Transaction Text window.
When it is time to execute a transaction, there may be multiple values
returned for an OPC item.
Select the …write ALL the values to the OPC Item option button to
OPC Return Items
execute the transaction for each value in the set.
Select the …write ONLY THE LAST value returned option button to
execute the transaction for only the most recent value in this set.
Allow you to select which attribute or attributes are to be enclosed in
Quotation Marks
quotation marks: Name, Value, Quality, Timestamp.
Allows you to select the option button that defines the automatic use of
either single quotation marks (‘(Single Quote)) or double quotation marks
Style
(“(Double Quote)) for each of the selected attributes (see Quotation
Marks).
Select this button to accept any changes made in the Add Query window.
Apply
Note: This button stays consistent across all tabs.
Select this button to cancel any changes made and close the Add Query
Close window.
Note: This button stays consistent across all tabs.
Table 17 - Add Query Window - Transaction Options Tab

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 44

 OPC Options Tab
The OPC Options tab is displayed in Figure 29 and the tab components are described in Table 18.

Figure 29 - Add Query Window - OPC Options Tab

Command Description
Allows you to enter or select the minimum update rate (in milliseconds) for
Update Rate (ms) the OPC group(s) associated with the transaction. This will be the minimum
time between entries for an OPC item in the database.
Allows you to enter or select a value which is used for asynchronous
communication to specify what constitutes a change in an OPC item. For
% Deadband
example, a deadband value of 10% means that the value must change by
at least 10% to be considered a change.
Allows you to specify (by selecting an option from the drop-down list) how
data for items in this group will be retrieved from the OPC server. Selecting
a synchronous type tells the client to make a request for data and wait until
the server retrieves it. Selecting an asynchronous type means that the
client makes a request for data, but does not wait for the server to retrieve
IO Type the data. Rather, the server responds with an update only after retrieval,
and only if item values in the group have changed.
Note that each type in this drop-down list refers to an OPC communication
standard. Not all standards may be implemented by your OPC server.
Selecting Autodetect attempts to automatically choose the I/O type.
Autodetect will attempt to choose an asynchronous type first, but will

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 45

 Command Description
default to synchronous if this fails.
By default, OPC timestamps are based on UTC standard time. This field
allows you to select or enter a value to define a time bias that is to be used
to convert this time to local time. The time bias specifies the number of
Time Bias minutes to subtract from UTC time. For example, a time bias of 420 means
420 minutes will be subtracted from the UTC time.
Note: This field is disabled if the Auto Detect Time Bias checkbox has
been selected.
When this checkbox is selected, the time bias is automatically calculated
Auto Detect Time Bias based on the system time zone settings.
Note: If this checkbox is selected, the Time Bias field is disabled.
Select this button to accept any changes made in the Add Query window.
Apply
Note: This button stays consistent across all tabs.
Select this button to cancel any changes made and close the Add Query
Close window.
Note: This button stays consistent across all tabs.
Table 18 - Add Query Window - OPC Options Tab Components

Transaction Results Tab

The Transaction Results tab is displayed in Figure 30 and the tab components are described in
Table 19.

Figure 30 - Add Query Window - Transaction Results Tab

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 46

 Command Description
Displays the Name, Quality, Value, and Timestamp results for the
Results Grid
transaction.
Result Status Displays the transaction query execution results.
Clear Select this button to clear the tab.
Select this button to accept any changes made in the Add Query window.
Apply
Note: This button stays consistent across all tabs.
Select this button to cancel any changes made and close the Add Query
Close window.
Note: This button stays consistent across all tabs.
Table 19 - Add Query Window - Transaction Results Tab Components

Current Transactions Tab

The Current Transactions tab is displayed in Figure 31 and the tab components are described in
Table 20.

Figure 31 - Add Query Window - Current Transactions Tab

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 47

 Command Description
This pane displays all current transactions and associated items. Select and
Display
expand the nodes to view and transactions.
Refresh Click on this button to refresh the current view in the display.
Select this button to accept any changes made in the Add Query window.
Apply
Note: This button stays consistent across all tabs.
Select this button to cancel any changes made and close the Add Query
Close window.
Note: This button stays consistent across all tabs.
Table 20 - Add Query Window - Current Transactions Tab Components

Executing Simple Queries

SELECT * FROM...
The Add Query window can be used to execute SQL statements that do not involve OPC items or
table column parameters. In the Transaction Text field, enter a simple select * from
table_name. Ensure that the table table_name exists in the selected database (as shown on the
Data Values tab). Next, press either the Execute button or the F5 key to execute the query.
Figure 32 shows an example from a sample database containing a table named MS_SQL_TEST2,
with the columns TestName, TestValue, TestQuality and TestTimeStamp.

Figure 32 - Simple Select Transaction Results

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 48

UPDATE...
In the Transaction Text field, enter the following: update MS_SQL_TEST2 set TestValue =
‘55’ where TestValue = ‘5’. Note that the Bucket Brigade.Int1 value that was previously 5 has
been changed to 55.

Figure 33 - Table MS_SQL_TEST2 After Insert Statement

As you can see, the MatrikonOPC Client for ODBC can act as a query analyzer for your databases.
The range of queries that can be executed by the client is limited only by the database that you are
connected to, and the ODBC driver that you are using to connect to the database.

Using an OPC Item in a Transaction

One of the most powerful features of custom writes is the ability to use OPC item attribute values
as parameters for transactions. Each OPC item has four attributes: Name, Value, Quality, and
Timestamp. The MatrikonOPC Client for ODBC defines a syntax allowing each of these attributes
to be used in custom writes.
The first step is to specify an OPC item variable. OPC item variables are declared inside of the SQL
statement using two string delimiters. These delimiters may be chosen from several pre-defined
options. However, the default start and end delimiters are << and >>. Each example for custom
writes will use the default delimiters.
To specify an OPC item variable, the prefix i: is used. Based on the default delimiters, the
declaration for a variable named itemname is: <<i:itemname>>
To access the Name, Value, Quality, and Timestamp attributes of an OPC item, the suffixes .n,
.v, .q, and .t respectively are used. Thus <<i:itemname>>.n is used to access the name
attribute of item name. The following example illustrates how these can be used:
1. From the Add Query window, click on the Transaction Options tab.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 49

 2. Note which characters are being used to enclose an OPC item in the OPC Item Delimiters
screen section. By default, the Start Delimiter is << and the End Delimiter is >>.
Ensure that these delimiter values are selected.
3. In the Transaction Text field enter <<i:itemname>> followed by a space.
4. The pane on the right of the screen displays one row with itemname as an Argument
Name, and a red Tag button adjacent to a blank field in the Argument Value column
(Figure 34).

Figure 34 - Syntax Example

5. Click on the Tag button.

6. The Select OPC Item window appears. Use this window to browse the list of available
servers and choose a tag to associate with the variable.
7. Double-click your mouse on an OPC item set the Argument Value. The Tag button will
turn green, and the field adjacent to the button is populated with the item name information
as shown in Figure 35.
When a variable is properly declared in the Transaction Text pane, the start and end
delimiters are highlighted. This can be seen in Figure 35, where the << and >> delimiters are
both displayed in green.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 50

 Figure 35 - Successfully Assigned OPC Item

Creating an Insert Transaction using an OPC Item

The following example illustrates how to use OPC item variables in an SQL insert statement. For
this example, create a database table named MS_SQL_TEST2 with four columns:
1. TestName of type varchar
2. TestValue of the type associated with OPC item
3. TestQuality of type varchar or number
4. TestTimestamp of type datetime or varchar
Then perform the following steps to create the insert transaction:
1. Enter the following string into the Transaction Text field:
insert into "MS_SQL_TEST2"
values(<<i:item1>>.n,<<i:item1>>.v,<<i:item1>>.q,<<i:item1>>.t)
Note: After entering the above string, the Add Query screen will appear as it does in
Figure 36. In the display, the variable delimiters will be highlighted in green, and SQL
keywords highlighted in blue.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 51

 Figure 36 - Custom Write GUI - Insert Statement

2. Select an OPC item that will provide the values for the transaction. To associate an OPC
item with this transaction, following the procedure described in Using an OPC Item in a
Transaction.
3. Click on the Apply button. This will schedule the transaction for execution. The GUI will
switch to the Current Transactions tab.
Note: On the Current Transactions tab, after expanding each node in the tree, the
transaction is displayed as shown in Figure 37.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 52

 Figure 37 - Custom Insert Transaction Display

Write to OPC Items Using a Select Statement

An SQL select statement can be used to write a value from a database to an SQL item. Database
column variables are declared using a slightly different syntax. Instead of i:, the syntax c: is used
to specify that the variable refers to a column. The only OPC attribute used for the table column
custom writes is the value. Thus, table column variables do not have an attribute suffix associate
with them.
Using MS_SQL_TEST2 as our database table, an example transaction using a table column
variable is as follows. Enter the following into the Transaction Text field on the screen:
select <<c:TestValue>> from MS_SQL_TEST2 where TagName = ‘BucketBrigade.Int2’

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 53

 Figure 38 - Select Statement Example

Similar to transactions using OPC item variables, a tag must be chosen for this transaction. Click on
the red Tag button to browse the available servers, and select a tag from one of these servers.
This chooses the tag that is to receive database column information. The above example may
return more than one value to be written to the selected OPC item. Depending on the options
selected, the client will either write only the latest value returned, or each of the values returned.

Note: Care needs to be taken to ensure that the aforementioned

transaction is actually scheduled to execute. By default, custom writes
are scheduled to execute whenever a change in the associated OPC
item is detected. If this transaction was scheduled in that manner, it
would only be executed whenever an external source modified the
OPC item. It is unlikely that this is the desired behaviour. Such a
schedule should be scheduled to execute at fixed intervals. This can
be done on the Transaction Options tab.

General Preferences
The Preferences window is used to configure basic client behaviour, logging and performance
settings. This window is accessed by choosing the Options menu item from the View menu. This
window consists of three tabs:
General
Logging
Advanced

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 54

 General Tab
The General tab (Figure 39) allows you to customize configuration files, and how quality values
are reported. The General tab components are described in Table 21.

Figure 39 - Preferences Window - General Tab

Command Description
Selecting this option specifies that the ODBC client should save its current
configuration whenever the client is shutdown. This option refers to the
Save current shutdown of the entire client, not just the configuration GUI. The
configuration on configuration is saved to the file name displayed in the textbox shown in
shutdown Figure 39.
Note: This option is only applied after the ODBC client restarts.
Load this Selecting this checkbox enables the text field and Browse button below the
configuration on checkbox, allowing you to select and load the ODBC configuration file when
startup the client starts up.
Click on this button to display the Open window to select an existing file
Browse name. For this button to be enabled, the Load this configuration on
startup checkbox must be selected.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 55

 Command Description
Allows you to choose a method by which to browse for OPC servers, by
OPC Server Browsing
selecting the necessary checkbox: OPC Enum or Registry.
If this checkbox is selected, this option will display the OPC item quality as a
user-friendly text string. If the checkbox is cleared, this value will be
Display quality as text
displayed as an integer. The default is to display the OPC item quality as a
user-friendly text string.
Selecting this button commits any changes made in the Preferences
OK window and closes the window.
Note: This button stays consistent across all tabs.
Selecting this button cancels any changes made in this window.
Cancel
Note: This button stays consistent across all tabs.
Selecting this button commits any changes made in the window.
Apply
Note: This button stays consistent across all tabs.
Table 21 - Preferences Window - General Tab Components

Logging Tab
The Logging tab (Figure 40) allows you to customize error and debug information. The tab
components are described in Table 22.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 56

 Figure 40 - Preferences Window - Logging Tab

Command Description
Minimum log file size This option cannot be changed. 500 KB is the minimum default log file size.
Maximum log file size Sets the maximum log file size before logs will wrap.
Sets the general logging activity logging at the specified detail level (High,
Log Level
Medium, Low, or None).
Log File Name Displays the full path for the general activity log file.
Click on the Browse button to display the Open window used to select an
Browse
existing file name.
Commit all log file Purges the file buffer after each message is logged in the event of an
writes unexpected server shut down.
Overwrite old log Overwrites the old log file each time the server starts up, if selected.
information Otherwise, rename the old log file with a (*.bak) suffix.
Selecting this button commits any changes made in the Preferences
OK
window and closes the window.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 57

 Command Description
Note: This button stays consistent across all tabs.
Selecting this button cancels any changes made in this window.
Cancel
Note: This button stays consistent across all tabs.
Selecting this button commits any changes made in the window.
Apply
Note: This button stays consistent across all tabs.
Table 22 - Preferences Window - Logging Tab Components

Advanced Tab
The Advanced tab (Figure 41) is used to define the request queue settings. The tab components
are described in Table 23.

Figure 41 - Preferences Window - Advanced Tab

Command Description
Allows you to specify the maximum number of ODBC Client transactions
Maximum Requests
that can be queued. Setting this value to 0 means that there is no
Queued
maximum value for the queue size.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 58

 Command Description
Allows you to specify how often to report discarded transactions in the log
file. Consider a value of n for this field. When the number of discarded
Interval to Report
transactions reaches a multiple of n the total number of processed and
Discarded Requests
discarded transactions is logged. Note that this only occurs if logging is
enabled.
Selecting this button commits any changes made in the Preferences
OK window and closes the window.
Note: This button stays consistent across all tabs.
Selecting this button cancels any changes made in this window.
Cancel
Note: This button stays consistent across all tabs.
Selecting this button commits any changes made in the window.
Apply
Note: This button stays consistent across all tabs.
Table 23 - Preferences Window - Advanced Tab Components

Saving a Configuration
Note: When the client configuration is complete, use the Save Configuration window to save the
configuration to an XML file.
To save a configuration to an XML file:
1. From the File menu, select the Save As menu option.
2. The Save Configuration window appears.
3. Enter a file name if saving the file for the first time.
4. Click Save.
5. The configuration is saved.

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. You will be prompted as to whether or not you want to save the configuration, select Yes to
save the configuration, No to clear without saving, and Cancel to retain the current
configuration.
3. If you have not selected Cancel, the configuration is cleared.

Loading an Existing Configuration

Note: If you have previously saved a configuration, you can clear the current configuration and
then load the saved configuration file.
To load an existing configuration file:
1. From the File menu, select the Open menu option
2. The Open Configuration window appears.
3. Browse for the configuration file that you want to load.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 59

 4. Click Open.
5. Click OK.
6. The old configuration is cleared and the new configuration is loaded from the file.

Shutting Down the Server

Note: The MatrikonOPC Client for ODBC will run until a shutdown has been requested.
To shut down the server:
1. On either the Control Panel or the Tool Tray Menu, select Shutdown. If the server is
running as a local executable, choose Shutdown Server from the File menu or right-click
the MatrikonOPC Client for ODBC icon and select shutdown.
2. The server is shut down.

Note: The shutdown command is not available for the server if it runs
as a Windows service. Services can be shut down only from the
Service Control Manager applet in the Windows Control Panel.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 60

Diagnostics
The server supplies diagnostic information to assist operators and support personnel with
troubleshooting communication problems and software faults.

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 General Logging tab of the Options dialogue in the main configuration
window contains settings to control server logging.
General Activity Logging 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 Matrikon 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.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 61

Limitations
MatrikonOPC Client for ODBC has the following limitations:
1. Table Writes for Oracle - do not support the TimeStamp<> syntax required by Oracle
databases. For Oracle ODBC data sources, table write functionality can be configured as a
custom write.
2. Stored Procedure and Triggered Write Configuration – customers who upgrade from
the old version to the new version of ODBC Client should note that the new GUI does not
allow Triggered Writes and Stored Procedures to be configured graphically.
3. Display for legacy configuration files – the new GUI of this client does not display each
of the transaction types from the previous version of the client. Triggered Writes and Stored
procedures are not displayed in the new GUI, and the OPC item to table column mappings
will not show up in the new GUI.
4. Custom Write Variable – the custom variable c: syntax does not allow the variable name
to contain the „[„ or „]’ characters. For example, the variable name
<<c:[ColumnName]>> is not valid. Rather, <<c:ColumnName>> should be used. One
side effect of this limitation is that users may not use column names with spaces for c:
variables, as they must be delimited using „[„ and „]‟.

Refer to the MatrikonOPC Client for ODBC Release Notes for known issues.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 62

Troubleshooting
The following section addresses some of the most common problems encountered, and questions
asked, while using this OPC server. Please check the following Problems/Solutions and
Questions/Answers sections before contacting the MatrikonOPC Support team.

Problems and Solutions

Client cannot be configured; no Matrikon logo in Tool Tray

Problem: The client cannot be configured because there is no Matrikon logo in the Tool
Tray.
Solution: If the client is running as a service, the Matrikon logo does not appear in the Tool
Tray.
To configure the client, start the configuration utility by using the shortcut to the OPC
server in the Windows Start menu (this shortcut starts the Configuration utility as
well as the OPC Server).

Registered ODBC data sources not visible from the configuration GUI

Problem: When connecting to a database, a registered ODBC data source does not appear in the
dropdown list.
Solution: ODBC data sources must be registered as either a system, file or user DSN. If the
data source is registered as a user DSN, it may be necessary to execute the client as
that user. If the client runs as a service, make sure the service is set to execute as
the appropriate user.

Server does not retain settings

Problem: The client does not retain its previous settings and needs to be reconfigured each time
it starts up.
Solution: In the Configuration window, choose Options from the View menu. Under the
General tab, ensure that the Load this configuration on start-up checkbox is
selected and that the correct file name appears in the edit box.

Server cannot save configuration in XML format

Problem: The OPC client cannot save the configuration in XML format.
Solution: Microsoft Internet Explorer 4.01 (or later) must be installed to use the .XML format.

Server does not show up as remote program in OPC client application

Problem: The OPC server I wish to connect to, does not show up in a list of remotely available
program IDs in the client application.
Solution: Follow the steps found in Appendix A – Distributed COM (DCOM) to copy the

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 63

 program ID from the server machine to the client machine.

Access denied or time-out error when connecting to remove server via DCOM

Problem: Access Denied error message appears, or time out occurs when trying to connect to
a remote OPC server via DCOM.
Ensure that the access and launch permissions for the OPC server are set correctly on
Solution:
the server machine. For more information, refer to Appendix A – Distributed COM
(DCOM).

Server does not start up or client cannot connect

Problem: The client tries to connect to the server and fails, or the server does not start up.
Solution: Ensure that the access and launch permissions for the OPC server are set correctly.
For more information, refer to Appendix A – Distributed COM (DCOM).

About screen and Configuration window do not show up

Problem: The About screen and Configuration window do not show up when a remotely
connecting client or a client that runs as a service (such as the Aspen Technologies
CIMIO OPC Manager) tries to launch the OPC server.
Solution: Either set the identity for the OPC server to the interactive user, or consider running
the server as a service. For more information, refer to Appendix A – Distributed
COM (DCOM).

DA 2.05 asynchronous I/O does not work

Problem: After installing an older OPC server, DA 2.05 asynchronous I/O no longer works.
Solution: The old installation program installed and registered its own (older) version of the OPC
proxy/stub DLL.
Reinstall the standard OPC proxy/stub DLLs, using an up-to-date installation program
or re-register them using the REGSVR32 command-line utility.

Questions and Answers

How do I remove the server as a service?

Problem: How do I remove the client as a service?

Solution: Re-register the OPC server executable using the /REGSERVER command-line switch.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 64

How can I get OPC data into other applications?

Problem: How can I get OPC data into Microsoft Excel, Microsoft Word, or another application
with support for Visual Basic, VBA, or VB Script?
Solution: Use the MatrikonOPC Automation Component to create a Visual Basic script that
connects to a server, creates groups and items, and receives data change updates.
Contact Support for examples of how to do this in Excel, Visual Basic, or an HTML
document.

Search the MatrikonOPC Support Knowledge Base at www.opcsupport.com to find the answers
to other commonly-asked MatrikonOPC Client for ODBC questions.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 65

Un-Installation
To successfully un-install MatrikonOPC Client for ODBC, using the Add or Remove Programs from
the Microsoft Windows Control Panel is recommended.
To un-install MatrikonOPC Client for ODBC:
1. Click on the Start button and highlight the Control Panel item.
2. From the displayed menu, select Add or Remove Programs.
3. The Add or Remove Programs window is displayed.
4. Scroll through the list of currently installed programs and updates to find and select
MatrikonOPC Client for ODBC (Figure 42).

Figure 42 - Add/Remove Programs

5. Click on the Change/Remove button associated with the MatrikonOPC Client for ODBC
program to initiate the un-install process.
6. The Select Uninstall Method window appears (Figure 43).

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 66

 Figure 43 - Select Uninstall Method Window

7. From the Select Uninstall Method window, select the required option button.
Note: MatrikonOPC recommends the Automatic option method of un-installing.
8. Click on the Next button.
9. The Perform Uninstall window (Figure 44) is displayed.

Figure 44 - Perform Uninstall

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 67

 10. Click on the Finish button.
11. The Remove Files? window (Figure 45) appears.

Figure 45 - Remove Files? Window

12. The Remove Files? window asks whether to remove all log and configuration files. To keep
all log and configuration files, clear the Remove all log files and Remove all
configuration files checkboxes. By default, both checkboxes are selected, indicating that
all log and configuration files are to be removed.
13. Click on the Next button.
14. The Remove Files? window closes and you are returned to the Perform Uninstall window
and the un-install process continues.
15. When the un-install is complete the Perform Uninstall window closes and the program no
longer appears listed in the Add or Remove Programs window.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 68

OPC Compliance
For more information on OPC, view the documents listed below (as well as other OPC
Specifications) at http://www.opcfoundation.org. The MatrikonOPC Client for ODBC can
connect to OPC servers that implement the following interfaces:
OPC Data Access Custom Interface Standard 2.05

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 69

Appendix A Distributed COM (DCOM)
DCOM is an object protocol that enables COM components (such as OPC clients and servers) to
communicate directly with each other across a network. A certain amount of configuration is
required on the system where the OPC server is installed to allow remote clients to connect to it
over the network.
Readers should be familiar with DCOM and with Windows 2000 security features and security
administration. Information regarding Distributed COM and various links to related sites, white
papers, specifications, and so on, can be found at
http://www.microsoft.com/com/default.mspx.

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.

DCOM Configuration Utility

Start the DCOM configuration utility either from the server configuration utility or from the
command-line (DCOMCNFG). Answer, yes to any message boxes that appear (allowing the utility to
assign application ID entries to those servers that don't already have them).
The main window for DCOMCNFG allows the user to either configure default settings for all COM
servers or else to configure settings for a specific server chosen from the list. The former will affect
all servers configured to use the default settings. The latter will affect the selected server only.

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.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 70

The Impersonation Level specifies whether servers can ascertain the identity of calling clients
and whether they can then perform operations on the client's behalf (as if the server is the client).
Normally, it should be set to Identify, allowing the server to identify the calling client to
see if it is allowed access to a certain resource but not to actually access any of these
resources as the client.
Select the Provide additional security for reference tracking to make even the
reference counting on COM objects secure. This setting is not generally required.

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.

Setting Security Permissions

To set the security permissions for an OPC Server:
1. Open the DCOM configuration utility.
2. Select the OPC server, and then click Properties.
3. The Distributed COM Configuration Properties window (Figure 46) appears.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 71

 Figure 46 - Distributed COM Configuration Properties Window

4. Click on the Security tab to set the security for the server.
5. The Distributed COM Configuration Security tab (Figure 47) appears.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 72

 Figure 47 - Distributed COM Configuration Security Tab

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 48) appears.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 73

 Figure 48 - Registry Value Permissions Window

9. To add users to the list click Add.

10. The Add Users and Groups window (Figure 49) appears.

Figure 49 - Add Users and Groups Window

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.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 74

 12. When you are done adding users, click OK to close the Add Users and Groups window.
You can then choose to Allow Access or Deny Access for each user.
Notes:
The procedure to set the launch permissions is similar to the above, but instead of
choosing Allow Access for a user you would choose Allow Launch.
The Configuration Permissions contain an Access Control List of principals that are
allowed to modify the configuration information for a server. In other words, it
indicates who is allowed to alter the registry entries for installed servers as well as
who is able to access the registry for the purposes of installing new servers. It is
usually simpler to install and configure servers as a user with local administrative
rights.
13. To connect to an OPC server from outside of the domain, create a local user account on
both the server and the client machine with identical username and password. Then, add
the local user on the OPC server to the DCOM permissions. Use the local account on the
client machine to connect to the OPC server.

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.

Note: It is strongly recommended that OPC servers should be

installed to run as NT services if they are going to be accessed by
remote clients via DCOM. This ensures that the server can always be
accessed even if no one is presently logged on to the machine, and
only one server process ever starts up. It also adds a greater degree
of security in terms of who is able to shut down the server process.

Servers that run as local executables have the option of running as the launching user (the calling
client–this is the default), the interactive user (the one currently logged onto the machine), or a
specified user. It is usually best to use the interactive user or a specified user. Otherwise, remote
clients might start up multiple separate server processes that are not accessible to others.
Servers that run as NT services should generally run as the local System account. Alternatively,
the server can be set to run as a specified user, although this is usually done from the Service
Control Manager applet rather than DCOMCNFG. Access and Launch permissions are particularly
important when installing a server to run as an NT service.

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.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 75

 Note: Evidence indicates that there are problems with the datagram-
oriented protocols (such as UDP/IP) that can cause memory leaks in
DCOM. Therefore, it is strongly recommended that these protocols be
removed from the list of default protocols. Datagram-oriented
protocols are not supported under Windows 2000 at all (although the
DCOM configuration utility still allows you to configure them).

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.

WARNING: Any changes made to the registry must be made with

extreme caution!

1. Back up your registry.

2. On the server machine, run REGEDIT as a user that has access rights to the local registry.
3. Expand the HKEY_CLASSES_ROOT key.
4. Find the program ID(s) for the desired OPC server(s).
Note: In the case of Matrikon OPC Servers, the ID has the form Matrikon.OPC.Device. If
you quickly type the first few letters then REGEDIT should jump to the location of that key.
Some servers may have both a version-specific as well as a version-independent program
ID. In this case both IDs should be copied to the client machine.
5. For each program ID, select the key and choose Export Registry File from the Registry
menu. Enter a file name, and then click Save. Be careful not to overwrite other export files
that you are creating.
6. Copy the exported REG files to the client machine.
7. Merge the REG files into the registry of the client machine.
Note: This should simply be a matter of double clicking on the file from the desktop of the
client machine. Alternatively, run REGEDIT on the client machine and choose Import
Registry File from the Registry menu, selecting each file in turn. This must be done as a
user who has write access to the local registry.
8. Use REGEDIT to check that the program IDs have in fact, been copied.
9. Delete the REG files since they are no longer needed.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 76

Appendix B ODBC DSN Configuration
This section provides you with step-by-step instructions on how to properly configure your OPC
server to connect with the sample Microsoft Access database supplied.

DSN Types Note

Microsoft Windows supports the configuration of three types of ODBC data sources:
1. System: A registered data source that can be used by any user of the system.
2. User DSN: A data source defined for a specific user.
3. File DSN: A data source intended for use by multiple users on potentially different
machines. These DSN settings are saved in a file with a .DSN extension.

Data Source Configuration

Note: The MatrikonOPC Client for ODBC communicates with databases that are registered as ODBC
data sources. An example for registering a database as a system DSN is presented below.
1. From the Start button, select Control Panel -> Administrative Tools -> Data Sources
(ODBC), or select the configuration tool right from the MatrikonOPC Client for ODBC by
clicking Configure on the Database Connection Configuration Window shown in Figure
50.

Figure 50 - ODBC Data Source Administration Screen Access Path

2. The ODBC Data Source Administrator screen appears.

3. Select the System DSN tab (Figure 51).

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 77

 Figure 51 - ODBC Data Source Administrator (System DSN Tab)

4. Click on the Add button.

5. The Create New Data Source window (Figure 52) appears.

Figure 52 - Create New Data Source Window

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 78

 6. Select the driver for your data source. The sample that is provided uses the Microsoft
Access driver, if you are connecting to an Oracle database ensure you use the driver
provided by the Oracle Client tools installation and not the Microsoft ODBC for Oracle driver.
Select that option from the list.
7. Click on the Finish button.
8. The ODBC Microsoft Access Setup window (Figure 53) appears.

Figure 53 - ODBC Microsoft Access Setup Window

9. Now you need to configure the name of the DSN. Enter TestDatabase in the Data Source
Name field. Note: This name can be anything you would like, however, the configuration
file that is included with this installation assumes that you will name the DSN as
TestDatabase.
10. Click on the Select button.
11. The Select Database window (Figure 54) appears.
12. Browse to the OPC server installation directory path and select the SampleDB.mdb file.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 79

 Figure 54 - Select Database Window

13. Click on the OK button to close the Select Database window and return to the ODBC
Microsoft Access Setup window.
14. From the ODBC Microsoft Access Setup window, click on the OK button to finish your
DSN configuration.
15. TestDatabase should now appear in the list of system DSNs (Figure 55) that you see in
the ODBC Data Source Administrator window.

Figure 55 - List of System DSNs

Note: If you have moved your database location, you need to update your DSN information.
Otherwise 11616 will occur. Please refer to the Release Notes to read about the bug.

MatrikonOPC Client for ODBC v3.1.4.0 User’s Manual 80