OPC Desktop Historian Manual

MatrikonOPC Desktop Historian
User's Manual

User's Manual
This manual is a product of Matrikon International.
Matrikon International.
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:

Date
2003-08-06
Document
Version
Description
Author
1.0
1.1 1.7
Initial document.
THN
Updated for distribution. Changes to GUI. Excel

Plug-in section added. Branding fixes.
Screenshots updated. Updated with latest
screenshots for tag attributes. Updated with latest
screenshots. Updated data collection
THN,
SML, IMF,
EJM, EW
2006-03-30
2.0
Added section of Refresh Tag List. Added
EW
2006-10-04
2.1
Added information regarding implementation of
CAV
2007-01-12
3.0
Applied new template. Updated procedures, and
LB
4.0
Added Tag Management toolbar functionality;

added Tag Lifetime and Timestamp processing
attribute descriptions; added Analyzer install
information to Installation section.
CGAP, LB
2003-09-15
2005-10-18
2007-10-09
MatrikonOPC Desktop Historian v4.7.0 Users Manual
2007-11-29
2008-04-22
4.1 4.8
Changed versions to 3.3.0.0 for next release,

corrected support website, removed references to
NT in the DCOM appendix, corrected screen shots,
and added items to terminology section. Removed
any mention of the lifetime check multiplier, and
updated screenshot for the OPC client
configuration screen. OPC Compliance section
updated per #8592. Added configuration for the
storage engine, and a note indicating where the
documentation for Trender and OPC2XL can be
found. Updated the FF7 file size limitation for
clarity. Updated to reflect changes to the lifetime
feature and GUI. Added Result Log Configuration
tab information to FileCollector section, added
Advanced button and Advanced Tag Options
window to Data Collection Management section,
updated Version screenshots. Removed Enable
Lifetime for these tags checkbox description from
Table 16. Corrections and clarifications for lifetime
feature.
2008-08-26
5.0
Added section about the backup tool, updated

installation section.
CGAP
2008-12-16
6.0
Added content for the Backup GUI. Removed OPC

Compliance section. Updated screenshots to
reflect Backup Utility. Added Appendix H HDA
Relative Time Format.
CGAP, LB
2009-01-14
6.1
Replaced the following figures in Backup Utility

section with updated screenshots: 21, 35, 36, 39,
41, 43-45.
CGAP
2009-01-15
7.0
Added information for FF7 Rolling Buffer mode.
CHB
2009-02-11
7.1
Made corrections for UI changes.
CGAP, LB
2009-02-18
8.0
Added information regarding MatrikonOPC ODBC

Server for OPC demo license in Installation and
Licensing section.
LB
2009-03-03
8.1
Added information for Maximum Return Values

and Aggregate Overread features.
CHB
2009-03-17
8.2
Added additional password information for Backup

Utility.
CHB
9.0
Updated FF7 Configuration Options and FF4

Configuration Options sections. Added a note to
Backup Utility section. Replaced Figure 36 Create
New Scheduled Backup Wizard: Credentials and
Figure 45 Backup Now Wizard: Backup Operation
screenshots. Updated Command Line Options
section. Added item #8 to Limitations section.
TM
2009-04-28
CGAP, LB,
CHB
2009-06-03
9.1
Updated the following sections: Installed Files,

Contacting Support, FF7R Configuration Options,
OPC Server Configuration (Server Options page
components), Limitations. Added note to Data
Storage Management File Format Selection
section. Updated note in Appendix A File
Formats High Resolution Rolling Buffer (FF4)
section.
2009-06-12
9.2
Updated Contacting Support section. Added Quick

Start Guide to Installed Files section.
LB
9.3
Updated Software Requirements. Updated

introductory notes in File Format Selection.
Updated FF7R Configuration Options. Updated FF4
Configuration Options. Added introductory
statement to ODBC Server section. Updated
Renaming a Tag procedure in Tag Manager
Excel Plug-In section. Added Desktop Historian
instructional video to Installed Files section.
TM
2009-08-24
10.0
Updated backup utility command line and GUI

sections to include the restore feature. Removed
DEP settings note from Installation section.
Updated Installation section to include demo
install of Matrikon Analytics Excel Reporter.
Updated introduction in Appendix D DCOM.
CGAP, LB
2009-09-03
11.0
Updated software version to 4.3.0.0. Updated the

OPC server configuration section to include new
settings.
CGAP
2009-10-14
12.0
Updated software version to 4.4.0.0. Updated

Installation and Un-Installation sections. Updated
Installed Files section. Updated Licensing section.
Removed Windows 2000 from Software
Requirements section.
CGAP, LB
2009-10-22
12.1
Limitations section updated to include a limitation

regarding restore functionality.
LB
2010-02-03
13.0
Updated software version to 4.4.1.0.
CB, LB
13.1
Updated Software Requirements section,

OPC/data naming convention changed, replaced
the screenshots for the following figures: 50, 51,
60, 67.
CB, LB
2010-09-01
14.0

Software Requirements, Licensing, Contacting
Support, Troubleshooting, and Limitations
sections. Updated note in Tag Manager Excel
Plug-In section.
BP, LB
2010-09-03
14.1
Updated Software Requirements and Limitations

sections.
BP, LB
2009-06-26
2010-02-12
TM, LB
2012-01-10
15.0

Software Requirements and Limitations sections.
MRP, LB
2012-05-07
16.0

FF7R configuration options. Updated user
documentation suite to appropriate template.
LB
2012-08-17
17.0
Full port to TFS. Updated software version to

4.6.0. Updated Software Requirements and
Limitations sections, Appendix F Installed Files,
and Appendix H File Formats.
LB
2013-03-07
17.1
Updated Software Requirements section and Log

Settings screen shot.
Added Appendix N HDA Aggregate Functions.
SG
2016-03-09
17.2
Updated Software Release Version to 4.7.0.
SG
SOFTWARE VERSION
Version:
4.7.0
DOCUMENT VERSION
Version:
17.2
COPYRIGHT INFORMATION
Copyright 1997 - 2016, Matrikon International. All rights reserved. No part of this document may be reproduced,
stored in a retrieval system, translated, or transmitted in any form or by any means, electronic, mechanical, photocopying,
recording, or otherwise, without prior written permission of Matrikon International.
CONFIDENTIAL
The information contained herein is confidential and proprietary to Matrikon International. It may not be disclosed or
transferred, directly or indirectly, to any third party without the explicit written permission of Matrikon International.
IMPORTANT NOTICE
Although every endeavor has been made to ensure that the information contained within this document is up
to date and accurate, Matrikon cannot be held responsible for any inaccuracy or error in the information
contained within this document. Matrikon makes no warranty of any kind with regard to the information
contained within this document and Matrikon shall not be liable for any direct, indirect, incidental or
consequential damages which may arise in connection with the furnishing, reliance, or use of the information
contained within this document.
Specifications and statements as to performance in this document are Matrikon estimates, intended for general
guidance. Matrikon reserves the right to change the information contained within this document and any
product specification without notice.
Statements in this document are not part of a contract or program product licence insofar as they are
incorporated into a contract or licence by express preference. Issue of this document does not entitle the
recipient to access or use of the products described, and such access or use shall be subject to separate
contracts or licences.
The receiving party shall not disclose, publish, report, communicate, or otherwise transfer any information in
this document to any third party, and shall protect all information contained herein from unauthorized
disclosure. The receiving party shall permit access to this document only to its employees, agents,
subcontractors, and affiliates who reasonably require access to such information contained herein, have been
made aware of the confidential nature of this document and have executed a written employment or other
confidentiality agreement party to maintain the confidential status of this document.
LICENSE AGREEMENT
This document and the software described in this document are supplied under a license agreement and may only be used
in accordance with the terms of that agreement. Matrikon reserves the right to make any improvements and/or changes to
product specifications at any time without notice.
TRADEMARK INFORMATION
The following are either trademarks or registered trademarks of their respective organizations:
Matrikon and MatrikonOPC are trademarks or registered trademarks of Matrikon International.
OTHER
MatrikonOPC is a division of Matrikon International.
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit
(http://www.openssl.org/). Copyright 1998-2008 The OpenSSL Project. All rights reserved.
Table of Contents
Introduction ................................................................................................................... 15
Who Should Use This Manual ............................................................................................ 15
Overview of Manual ......................................................................................................... 15
References ..................................................................................................................... 17
Document Terminology .................................................................................................... 17
Getting Started............................................................................................................... 19
System Requirements ...................................................................................................... 19
Software Requirements ................................................................................................. 19
Hardware Requirements ................................................................................................ 20
Configuration ................................................................................................................. 21
Launching the MatrikonOPC Desktop Historian .................................................................... 21
Configuration Window ...................................................................................................... 21
Toolbar........................................................................................................................ 22
File Menu ..................................................................................................................... 24
Edit Menu .................................................................................................................... 24
View Menu ................................................................................................................... 25
Window Menu............................................................................................................... 25
Help Menu ................................................................................................................... 26
Starting and Stopping MatrikonOPC Desktop Historian ......................................................... 26
Generic Management...................................................................................................... 27
Log Settings ................................................................................................................... 27
Version Information ......................................................................................................... 29
Data Storage Management ............................................................................................. 30
File Format Selection ....................................................................................................... 31
FF7 Configuration Options ................................................................................................ 31
FF7R Configuration Options............................................................................................... 31
FF4 Configuration Options ................................................................................................ 33
Backup Utility ................................................................................................................. 35
Schedule Backup Operation .............................................................................................. 36
Modify Backup Operation .................................................................................................. 51
Remove Backup Operation ................................................................................................ 54
Perform Backup Now........................................................................................................ 55
Restore Backup ............................................................................................................... 57
Backup Utility Logging Options .......................................................................................... 59
Version .......................................................................................................................... 62
Command Line Use .......................................................................................................... 62
Accessing the Command Line ......................................................................................... 63
Command Line Options.................................................................................................. 63
Data Collection Management .......................................................................................... 67
Tag Browser ................................................................................................................... 68
Tag Workspace ............................................................................................................... 71
Tag Management Toolbar............................................................................................... 71
Tag Management Context Menu...................................................................................... 72
Tag Status ................................................................................................................... 73
Adding a Tag .................................................................................................................. 74
Removing a Tag .............................................................................................................. 75
Changing a Tag Attribute .................................................................................................. 76
Renaming a Tag .............................................................................................................. 77
Turning Tags On or Off ..................................................................................................... 78
Changing the Update Rate ................................................................................................ 78
Changing the Node Name and Process Name ...................................................................... 78

Invalid Attributes............................................................................................................. 79
Configuring Array Elements .............................................................................................. 80
Configuring Tag Lifetime and Timestamp Processing Attributes ............................................. 80
Refreshing the Tag List..................................................................................................... 82
Customizing the Display ................................................................................................. 84
Tag Browser Docking ....................................................................................................... 84
Visible Attributes .......................................................................................................... 85
Colour Legend................................................................................................................. 87
OPC Server Configuration ............................................................................................... 88
Alias Configuration .......................................................................................................... 88
Inserting Alias Groups ................................................................................................... 88
Adding New Aliases ....................................................................................................... 89
Editing Aliases ............................................................................................................ 108
Removing Aliases........................................................................................................ 109
Removing Alias Groups ................................................................................................ 109
Cloning Aliases ........................................................................................................... 110
Exporting Aliases ........................................................................................................ 110
Importing Aliases........................................................................................................ 110
Expression Wizard ...................................................................................................... 111
Logging Options ............................................................................................................ 113
Version ........................................................................................................................ 115
Server Options .............................................................................................................. 116
OPC Client Configuration .............................................................................................. 119
Client Settings Tab ........................................................................................................ 119
Logging Settings Tab ..................................................................................................... 120
Version ........................................................................................................................ 122
FileCollector ................................................................................................................. 123
ODBC Server................................................................................................................. 124
Databases Tab .............................................................................................................. 124
Configuring a New Database ........................................................................................ 125
Removing a Database.................................................................................................. 126
General Tab .................................................................................................................. 126
Version ........................................................................................................................ 127
Tag Manager Excel Plug-In ........................................................................................ 129
Installing Tag Manager Add-Ins ....................................................................................... 129
Connecting to Tag Manager ............................................................................................ 129
Loading Attributes ......................................................................................................... 130
Adding, Changing, and Deleting Tag Attributes.................................................................. 130
Renaming an Attribute ................................................................................................... 131
Loading Tags for Viewing ................................................................................................ 132
Filtering Tags ................................................................................................................ 132
Limiting Attribute Display ............................................................................................... 133
Adding OPC Tags ........................................................................................................... 133
Turning Tag Scanning On and Off .................................................................................... 134
Renaming a Tag ............................................................................................................ 135
Diagnostics .................................................................................................................. 136
Logging ........................................................................................................................ 136
Limitations ................................................................................................................... 137
Troubleshooting ........................................................................................................... 139
Problems and Solutions .................................................................................................. 139
Questions and Answers .................................................................................................. 141
Licensing ...................................................................................................................... 142
MatrikonOPC Desktop Historian Licensing....................................................................... 142

ODBC Server Licensing ................................................................................................ 143
Licensing OPC Trender................................................................................................. 143
Licensing ODBC Server for OPC, Matrikon Analytics Excel Reporter, and Performance Monitor
..............................................................................................................................143
Feature Licenses ......................................................................................................... 143
Contacting Support ........................................................................................................ 143
Table of Appendices
Appendix A
Distributed COM (DCOM)....................................................................... 145
DCOM Configuration Utility ............................................................................................. 145
Default Properties.......................................................................................................... 145
Security Permissions ...................................................................................................... 146
Server Identity.............................................................................................................. 150
Default Protocols ........................................................................................................... 150
Remote Program ID ....................................................................................................... 151
Appendix B
Aliases .................................................................................................. 152
Scaling Expressions ....................................................................................................... 152
Advanced Calculations.................................................................................................... 153
CSV File Format ............................................................................................................ 155
Scaling Algorithms ......................................................................................................... 157
Appendix C
Standard Data Types ............................................................................. 158
Appendix D
Security ................................................................................................ 159
Introduction.................................................................................................................. 159
OPC Security Implementation ......................................................................................... 159
MatrikonOPC Tag Security Configuration Utility ................................................................. 160
Security Details ............................................................................................................. 180
Appendix E
Installation ........................................................................................... 185
Appendix F
Installed Files ....................................................................................... 200
Appendix G
Un-Installation...................................................................................... 207
Appendix H
File Formats .......................................................................................... 212
High Resolution Rolling Buffer (FF4)................................................................................. 212
High Resolution Rolling Buffer (FF7R) ............................................................................... 212
Dynamic File Creation (FF7) ............................................................................................ 213
Appendix I
Attributes.............................................................................................. 214
Appendix J
Desktop Historian Data Types ............................................................... 216
Appendix K
Third-Party Licensing ............................................................................ 217
Syncfusion Essential Studio 4.4.0.51................................................................................ 217
Appendix L
Sample Custom Script ........................................................................... 218
Appendix M
HDA Relative Time Format .................................................................... 219
Appendix N
HDA Aggregate Functions ..................................................................... 221
Table of Figures
Figure 1 - Configuration Window .................................................................................... 22
Figure 2 - Windows Services Panel................................................................................. 26
Figure 3 - Log Settings Tab ............................................................................................ 28
Figure 4 - Version Information Tab ................................................................................ 29

Figure 5 - Data Storage Management Page .................................................................... 30
Figure 6 - FF7R Configuration Options............................................................................ 32
Figure 7 - FF4 Configuration Options .............................................................................. 34
Figure 8 - Backup Utility ................................................................................................. 36
Figure 9 - Create New Scheduled Backup Wizard: Backup Name .................................... 37
Figure 10 - Create New Scheduled Backup Wizard: Backup Operation ........................... 38
Figure 11 - Create New Scheduled Backup Wizard: Destination ..................................... 39
Figure 12 - Create New Scheduled Backup Wizard: Select Files...................................... 40
Figure 13 - Create New Scheduled Backup Wizard: Select Files (Delete or Move Operation
Selected) ........................................................................................................................ 40
Figure 14 - Create New Scheduled Backup Wizard: Select Files By Date......................... 41
Figure 15 - Create New Scheduled Backup Wizard: Select Files By Date (Move or Delete
Operation Selected) ....................................................................................................... 42
Figure 16 - Date Editor Window ..................................................................................... 43
Figure 17 - Create New Scheduled Backup Wizard: Schedule Type ................................. 44
Figure 18 - Create New Scheduled Backup Wizard: Daily Schedule ................................ 45
Figure 19 - Create New Scheduled Backup Wizard: Weekly Schedule ............................. 46
Figure 20 - Create New Scheduled Backup Wizard: Monthly Schedule............................ 47
Figure 21 - Create New Scheduled Backup Wizard: One Time Only Schedule ................. 48
Figure 22 - Create New Scheduled Backup Wizard: Credentials...................................... 49
Figure 23 - Create New Scheduled Backup Wizard: Summary ........................................ 50
Figure 24 - Create New Scheduled Backup: CompleteMonth........................................... 51
Figure 25 - Modify Scheduled Backup ............................................................................. 52
Figure 26 - Modify Scheduled Backup Wizard: Backup Name.......................................... 53
Figure 27 - Modify Scheduled Backup Wizard: Summary ................................................ 54
Figure 28 - Remove Scheduled Backup ........................................................................... 55
Figure 29 - Remove Scheduled Backup Confirmation...................................................... 55
Figure 30 - Run Backup Now .......................................................................................... 56
Figure 31 - Backup Now Wizard: Backup Operation ....................................................... 57
Figure 32 - Restore Backup Wizard: Choose Source ....................................................... 58
Figure 33 - Restore Backup Wizard: Summary ............................................................... 59
Figure 34 Logging Options Page .................................................................................. 60
Figure 35 - Backup Utility Version .................................................................................. 62
Figure 36 - Data Collection Management Page ............................................................... 67
Figure 37 - Tag Browser (with and without Flat Browse enabled) .................................. 68
Figure 38 - Advanced Tag Options Window .................................................................... 69
Figure 39 - Tag Workspace ............................................................................................. 71
Figure 40 - Tag Management Toolbar ............................................................................. 72
Figure 41 - Tag Management Context Menu ................................................................... 72
Figure 42 - Tag Status .................................................................................................... 73
Figure 43 - Data Collector State (showing Started and Stopped) ................................... 74
Figure 44 - Tag Workspace showing Tags Marked for Deletion....................................... 76
Figure 45 - Tag Workspace showing Changed Attribute ................................................. 77
Figure 46 - Changing Node Name and Process Name ..................................................... 79
Figure 47 - Invalid Attributes ......................................................................................... 80
Figure 48 - Configuring Array Elements.......................................................................... 80
Figure 49 - Lifetime and Timestamp Processing Attributes (with Lifetime Update Rate
Field Options Displayed) ................................................................................................ 81
Figure 50 - Refresh Tag List ........................................................................................... 83
Figure 51 - Tag Browser Title Bar ................................................................................... 84
Figure 52 - Auto-Hide Tag Browser Window ................................................................... 84
Figure 53 - Floating Tag Browser Window ...................................................................... 85
10
Figure 54 - Set Visible Attributes (First Approach) ......................................................... 86

Figure 55 - Set Visible Attributes (Second Approach)..................................................... 87
Figure 56 - Colour Legend .............................................................................................. 87
Figure 58 - New Alias Group Window ............................................................................. 88
Figure 59 - Alias Configuration Page .............................................................................. 89
Figure 60 - Alias Configuration Wizard - Step 1: Alias Type ............................................ 90
Figure 61 - Alias Configuration Wizard - Step 2: Alias Identity ....................................... 91
Figure 62 - Browse OPC Tag Window ............................................................................. 92
Figure 63 - Alias Configuration Wizard - Step 3: Alias Properties ................................... 93
Figure 64 - Alias Configuration Wizard - Step 4: Scaling Algorithms .............................. 94
Figure 65 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Linear Scaling)..... 95
Figure 66 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Square Root Scaling)
....................................................................................................................................... 96
Figure 67 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Gain/Offset Scaling)
....................................................................................................................................... 97
Figure 68 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Expression Scaling)
....................................................................................................................................... 98
Figure 69 - Expression Wizard........................................................................................ 99
Figure 70 - Select Function Window ............................................................................. 100
Figure 71 - Select Variable Window.............................................................................. 100
Figure 72 - Alias Configuration Wizard - Step 2: Alias Identity ..................................... 101
Figure 73 - Alias Configuration Wizard - Step 3: Alias Properties ................................. 102
Figure 74 - Alias Configuration Wizard - Step 4: Alias Calculation ................................ 103
Figure 75 - Alias Configuration Wizard - Alias Events ................................................... 104
Figure 76 - Manage Events Categories Window ............................................................ 105
Figure 77 - New Event Category Window ..................................................................... 106
Figure 78 - Alias Configuration Wizard - Step 2: Alias Identity ..................................... 107
Figure 79 - Alias Configuration Wizard - Step 3: Alias Properties ................................. 108
Figure 80 - Function Parameter Window ...................................................................... 112
Figure 81 - Operators Buttons ...................................................................................... 113
Figure 57 - Logging Options Page................................................................................. 113
Figure 82 - OPC Server Version Information Page ........................................................ 116
Figure 83 - Server Options Page ................................................................................... 117
Figure 84 - Client Settings Tab (OPC Client) ................................................................. 119
Figure 85 - Logging Settings (OPC Client) .................................................................... 121
Figure 86 - OPC Client Version Information Page ......................................................... 122
Figure 87 - Databases Tab ............................................................................................ 124
Figure 88 - New Database Created ............................................................................... 126
Figure 89 - General Tab ................................................................................................ 127
Figure 90 - ODBC Server Version Information Page ..................................................... 128
Figure 91 - Excel Title Bar ............................................................................................ 129
Figure 92 - Load Tags Window ..................................................................................... 132
Figure 93 - Add OPC Tags Window ............................................................................... 134
Figure 94 - Distributed COM Configuration Properties Window .................................... 147
Figure 95 - Distributed COM Configuration Security Tab............................................... 148
Figure 96 - Registry Value Permissions Window .......................................................... 149
Figure 97 - Add Users and Groups Window .................................................................. 149
Figure 98 - Start Menu Navigation................................................................................ 161
Figure 99 - Enter Server Password Window ................................................................. 161
Figure 100 - MatrikonOPC Tag Security Configuration Utility Main Screen ................... 162
Figure 101 - MatrikonOPC Tag Security Configuration Utility Main Screen: Users & Groups
..................................................................................................................................... 163
Figure 102 - Add User Window (NT) ............................................................................. 164
11
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
- Defined Users and Groups ........................................................................

- Add User Window (Private) ......................................................................
- Add Group Window (NT) ..........................................................................
- Add Group Window (Private) ...................................................................
- Enter New Name Window .........................................................................
- Edit <Username> Window (Permissions Tab) ..........................................
- Add Permission Screen (Server Address Space) .......................................
- Add User Permission Window...................................................................
- Add Permission Window: Browsing Server Address Space .......................
- Edit <Username>: Example ......................................................................
- Edit <Username> Window (General Tab) .................................................
- Reset Password Window ..........................................................................
- Edit <Groupname> Window (Permissions Tab)........................................
- Edit <Groupname> Window (General Tab) ..............................................
- Edit <Groupname> Window (Members Tab) ............................................
- Add Existing User Window........................................................................
- Change Password Window .......................................................................
- InstallAware Wizard Verification Window ................................................
- Pre-Requisites Screen ..............................................................................
- License Agreement Screen .......................................................................
- Product Registration Screen .....................................................................
- Setup Type Screen....................................................................................
- Destination Folder Screen ........................................................................
- Start Menu Screen ....................................................................................
- Enter Password Screen.............................................................................
- Licensing Screen ......................................................................................
- MatrikonOPC Performance Monitor Screen ...............................................
- Matrikon Analytics Excel Reporter ............................................................
- MatrikonOPC Trender Screen....................................................................
- Ready to Install Screen ............................................................................
- Installing MatrikonOPC Server Screen......................................................
- MatrikonOPC Server Setup Complete Screen ............................................
Add or Remove Programs ........................................................................
- Welcome to MatrikonOPC Desktop Historian Maintenance Screen ............
- Ready to Uninstall Screen.........................................................................
- Uninstalling MatrikonOPC Desktop Historian Screen ................................
- MatrikonOPC Desktop Historian Setup Complete Screen ..........................
165
166
167
168
168
170
171
172
173
174
175
175
176
177
178
179
180
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
207
208
209
210
211
Table of Tables
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
1 - Terms and Definitions......................................................................................

2 - Configuration Window Components .................................................................
3 - Toolbar Items ..................................................................................................
4 - File Menu Commands .......................................................................................
5 - Edit Menu Commands (Alias Group) ................................................................
6 - View Menu Commands .....................................................................................
7 - Window Menu Commands ................................................................................
8 - Help Menu Command .......................................................................................
9 - General Logging Options Settings Tab .............................................................
10 - FF7 Configuration Options .............................................................................
11 - FF7R Configuration Options ...........................................................................
18
22
23
24
25
25
26
26
29
31
32
12
Table 12 - FF4 Configuration Options ............................................................................. 33

Table 13 - Select Files Options ....................................................................................... 41
Table 14 - Select Files By Date Options .......................................................................... 42
Table 15 - Daily Schedule Options .................................................................................. 45
Table 16 - Weekly Schedule Options .............................................................................. 46
Table 17 - Monthly Schedule Options ............................................................................. 47
Table 18 - One Time Only Schedule Options ................................................................... 48
Table 19 - Logging Options Components ........................................................................ 62
Table 20 - General Options ............................................................................................. 64
Table 21 - Commands ..................................................................................................... 65
Table 22 - Valid Selections ............................................................................................. 65
Table 23 - Tag Browser Components .............................................................................. 69
Table 24 - Advanced Tag Options Window Components ................................................. 71
Table 25 - Tag Management Toolbar Components .......................................................... 72
Table 26 - Tag Management Context Menu Options ........................................................ 73
Table 27 - Timestamp and Lifetime Processing Attributes Descriptions ......................... 82
Table 29 - Alias Configuration Wizard - Alias Type Components ..................................... 90
Table 30 - Alias Configuration Wizard - Step 2: Alias Identity Components .................... 91
Table 31 - Browse OPC Tag Window Components .......................................................... 92
Table 32 - Alias Configuration Wizard - Step 3: Alias Properties Components ................ 93
Table 33 - Alias Configuration Wizard - Step 4: Scaling Algorithms Component ............. 94
Table 34 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Linear Scaling) ...... 95
Table 35 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Square Root Scaling)
Components ................................................................................................................... 96
Table 36 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Gain/Offset Scaling)
Components ................................................................................................................... 97
Table 37 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Expression Scaling)
Components ................................................................................................................... 98
Table 38 - Expression Wizard Components ..................................................................... 99
Table 39 - Select Function Window Components .......................................................... 100
Table 40 - Select Variable Window Components ........................................................... 101
Table 41 - Alias Configuration Wizard - Step 2: Alias Identity Components .................. 101
Table 42 - Alias Configuration Wizard - Step 3: Alias Properties Components .............. 102
Table 43 - Alias Configuration Wizard - Step 4: Alias Calculation Components ............. 103
Table 44 - Alias Configuration Wizard - Alias Events Components ................................ 105
Table 45 - Manage Event Categories Window Components........................................... 105
Table 46 - New Event Category Window Components .................................................. 106
Table 47 - Alias Configuration Wizard - Step 2: Alias Identity Components .................. 107
Table 48 - Alias Configuration Wizard - Step 3: Alias Properties Components .............. 108
Table 49 - Expression Wizard Options .......................................................................... 112
Table 28 Logging Options Page Components ............................................................. 115
Table 50 - Server Options Page Components ................................................................ 118
Table 51 - Client Settings (Connection Settings) Tab Components ............................... 120
Table 52 - Client Settings (Data Buffer Settings) Tab Components............................... 120
Table 53 - Logging Settings Tab Components ............................................................... 121
Table 54 - Databases Tab Components ......................................................................... 125
Table 55 - General Tab Components ............................................................................. 127
Table 56 - Feature Licenses .......................................................................................... 143
Table 57 - MatrikonOPC Support Regional Contact Information ................................... 144
Table 58 - After-Hours Support .................................................................................... 144
Table 59 - Expressions Constructs for Alias Scaling...................................................... 153
Table 60 - Calculation Operators for Alias Scaling ........................................................ 154
Table 61 - Calculation Functions for Alias Scaling ........................................................ 155
13
Table 62 - File Import/Export Field Descriptions.......................................................... 156

Table 63 - Additional File Import/Export Field Descriptions - Linear/Square Root Scaling
..................................................................................................................................... 156
Table 64 - Additional File Import/Export Field Descriptions - Offset Scaling ................ 157
Table 65 - Additional File Import/Export Field Descriptions - Expression Scaling ........ 157
Table 66 - Additional File Import/Export Field Descriptions - Calculation Scaling ........ 157
Table 67 - Scaling Algorithms....................................................................................... 157
Table 68 - Standard Data Types ................................................................................... 158
Table 69 - Default Tag Security .................................................................................... 182
Table 70 - Example 1 .................................................................................................... 183
Table 71 - Example 2: Permissions ............................................................................... 183
Table 72 - Example 2: Groups and Members ................................................................. 183
Table 73 - Files Installed in Desktop Historian Folder ............................................... 200
Table 74 - Files Installed in "Core" Folder .................................................................... 201
Table 75 - Files Installed in "Database" Folder ............................................................ 201
Table 76 - Files Installed in "OPC Client" Folder ........................................................... 201
Table 77 - Files Installed in "OPC Server" Folder.......................................................... 203
Table 78 - Files Installed in "Task Scheduler" Folder ................................................... 203
Table 79 - Files Installed in "Util" Folder...................................................................... 204
Table 80 - Files Installed in "Util" Folder...................................................................... 204
Table 81 - Files Installed in Global Assembly Cache ..................................................... 204
Table 82 - Files Installed in "Common" Folder ............................................................. 206
Table 83 - Files Installed in "system32" Folder ............................................................ 206
Table 84 - Attributes .................................................................................................... 215
Table 85 - Desktop Historian Data Types ...................................................................... 216
Table 86 - Keywords..................................................................................................... 219
Table 87 - Offset Units ................................................................................................. 219
Table 88 - Relative Time Examples ............................................................................... 220
Table 89 - HDA Aggregate Functions ............................................................................ 221
14
Introduction
MatrikonOPC Desktop Historian is an economical, easy to install, easy to configure, and easy to
administer data archiving tool. It focuses on data collection, not data presentation and processing.
It is a solution for time-based data storage that can stand alone, or become part of a total
enterprise data historian solution. Desktop Historian is designed to be a low-maintenance data
storage solution.
Built on MatrikonOPC Integrated Configuration (iC!) architecture, Desktop Historian enables total
MatrikonOPC configuration management. Multiple Desktop Historians can be combined to create a
true distributed historian solution.
Desktop Historian provides storage for OPC Data and has three components:
Core
OPC Server
OPC Client
The embedded OPC client allows data collection from any OPC DA server. The embedded OPC
server allows any software package containing an OPC Client, to be used to inspect the data
contained in Desktop Historian. The Core acts as a storage space within Desktop Historian from
which the OPC server accesses the data.
Data is collected using OPC, and accessed using OPC. MatrikonOPC Desktop Historian is a
standards-based product that can be combined with any OPC product to create a best of breed
solution.
Who Should Use This Manual

This manual is intended for use by all users of the MatrikonOPC Desktop Historian.
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.
BOLD
Font displayed in this color and style indicates a hyperlink to the

applicable/associated information within this document, or if
applicable, any external sources.
The Users Manual has been designed as such so that you can click on references in the document
to jump to that referenced point without having to scroll through several pages (in some cases).
For example, if you were to see the sentence Refer to Figure 1 for more information, pressing the
CTRL key and clicking your mouse on the text Figure 1 automatically takes you to the location of
Figure 1 within the document.
This manual consists of several sections and is structured as follows:
15
Introduction this introductory chapter.
Getting Started provides system requirements information.
Configuration shows how to start and configure the product, and describes each
component in detail, including windows/screens, panels, tabs, and menu commands.
Data Storage Management shows how to customize historical data to be stored and
accessed.
Backup Utility shows how to schedule and manage backups on data stored in Desktop
Historian.
Data Collection Management shows how to customize data to be collected and

organized.
OPC Server Configuration shows how to start and configure Desktop Historians OPC
server.
OPC Client Configuration shows how to configure Desktop Historians OPC client.
FileCollector information regarding the MatrikonOPC FileCollector component.
ODBC Server shows how to configure the ODBC server component.
Tag Manager Excel Plug-in shows how Tag Manager is used to work with tags in
Desktop Historian.
Diagnostics explains how to use logging, statistical items, data qualities, timestamps,
and result codes to get the most efficiency from the users system.
Limitations provides information on specific performance and operational limitations of

the software.
Troubleshooting provides licensing, MatrikonOPC Support contact information, solutions

for common problems that may be encountered, and answers to frequently asked questions.
Appendices:
o
A - DCOM
B Aliases
C Standard Data Types
D Security
E Installation
F Installed Files
G Un-Installation
H File Formats
I Attributes
J Desktop Historian Data Types
K Third-Party Licensing
L Sample Custom Script
M HDA Relative Time Format
N HDA Aggregate Functions
16
References
This document references information found within the following documents/sites:
www.opcfoundation.org
www.matrikonopc.com
www.opcsupport.com
OPC Overview 1.0
OPC Common Definitions and Interfaces 1.0
OPC Data Access Specification 1.0a
OPC Data Access Specification 2.05
OPC Data Access Specification 3.00
OPC Historical Data Access Specification 1.2
OPC Alarms and Events Specification 1.10
OPC Security 1.00
Matrikon Analytics Excel Reporter Add-In Users Manual
MatrikonOPC Trender Users Manual
MatrikonOPC Server for Performance Monitor Users Manual
Document Terminology
The following terms are used interchangeably throughout this document:
screen and window
tab and panel
Table 1 provides a list of definitions for terms used throughout this document.
Term/Abbreviation
Description
A&E
OPC Alarms and Events. Provides access to process alarm and event data.
COM
Component Object Model. A method for organizing software, specifying how to

build components that can be dynamically interchanged.
DA
OPC Data Access. Provides access to real-time process data.
DCOM
Distributed Component Object Model. An extension of COM that allows

communication between COM components over a network.
DDE
Dynamic Data Exchange. Allows the transfer of data between two running
applications.
HDA
OPC Historical Data Access. Provides access to historical process data.
HMI
Human Machine Interface. Device that allows interaction between the user and
machine. Typically used in process control applications.
Matrikon
Matrikon International.
MatrikonOPC
Matrikons brand name for its OPC servers and clients.
ODBC
Open Database Connectivity a set of interfaces that allow any ODBC client to
17
Term/Abbreviation
Description
access any ODBC compatible database system using a consistent set of
commands.
ODH
MatrikonOPC Desktop Historian.
OPC
A communication standard. Refer to www.opcfoundation.org for more

information.
PLC
Programmable Logic Controller.

Table 1 - Terms and Definitions
18
Getting Started
This chapter contains important information about installing the product and how to contact the
MatrikonOPC 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 Appendix E - Installation walk you through the installation process. Appendix F
Installed Files lists the files that are installed during this process.
Once the software is installed, refer to the Licensing section for information on how to obtain the
appropriate license. The Licensing section will refer you to the Licensing Procedures document that
was installed along with the product and this Users Manual. 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 server, you must be set
up as an administrative user account rather than a restricted user
account.
Software Requirements
At the minimum, the product requires the following software:
Operating System
Microsoft Windows Server 2008 R2 (64-bit)
Microsoft Windows 7 (32-bit and 64-bit)

Note: Desktop Historian needs to be run as a Windows service.
Changing the service to start as a specific user restricts access to Desktop Historian.
Note: It is recommended that the most current service packs are
installed.
Software
Microsoft .NET 2.0 Framework
Internet Explorer 6.0, Service Pack 1 (or better)
For Matrikon Analytics Excel Reporter:
Microsoft Excel 97, 2000, 2003, 2007, or 2010
For Tag Manager:
Microsoft Excel 97, 2000, 2003, 2007, or 2010
Note: Tag Manager works with Excel 2007 versions 12.0.6425.1000 and higher. Microsoft Office
Service Packs SP1 and SP2 have to be installed for Tag Manager to work correctly.
19
Note: Tag Manager works with only 32-bit Microsoft Excel and it is
recommended that the most current service packs are installed.
Hardware Requirements
The product requires the following hardware:
Intel CORE2 Duo Processor
2 GB RAM
80 GB 7200 RPM Hard Drive
The software requires the following additional hardware to make use of the corresponding
functionality:
IP compatible network for remote OPC server access.
Free Hard Disk Space at least 200 MB of free disk space is recommended for the Historical
Data files. See Appendix H File Formats for specific size requirements, as most
installations will require more than 200 MB of free disk space.
20
Configuration
The products Graphical User Interface (GUI) allows users to view and alter configuration
parameters at run time. When you view a configuration parameter, the information is retrieved and
displayed. The updated parameters are sent as a group to the product when submitted.
Minimal configuration of the MatrikonOPC Desktop Historian is required for the product to function
properly, but you can customize the tools behavior as required. This section of the manual shows
you how to start and configure the tool and describes each component in detail, including the
windows, panels, and menu commands.
The Launching the MatrikonOPC Desktop Historian section of this manual shows you how to
start the software. Also described here, in detail, is the Configuration window.
Launching the MatrikonOPC Desktop Historian

To launch the MatrikonOPC Desktop Historian, choose the appropriate shortcut from the Start
menu.
To start MatrikonOPC Desktop Historian (and access the Data Storage configuration):
1. Click on the Windows Start button and select Programs -> MatrikonOPC -> Desktop
Historian, and choose MatrikonOPC Desktop Historian.
Configuration Window
The Configuration window is used to configure the tool. It displays the current configuration and
allows users to change configuration parameters.
To view the Configuration window:
1. From the Windows Start button, access MatrikonOPC Desktop Historian (for assistance,
refer to Launching MatrikonOPC Desktop Historian.
2. The Configuration window appears and the Start Page is displayed (Figure 1).
21
Figure 1 - Configuration Window
Table 2 describes the components of the Configuration window.

Component
Description
Main Menu
Provides access to the File, Edit, View, Window, and Help menus.
Toolbar
Provides items that make navigation within a configuration easier. Refer to

Table 3 for more information.
Location Bar
Allows you to track the current configurations location.
Navigation Panel
Displays a tree of configuration objects currently defined in the application.

Select an object to display its current settings in the right-hand panel. This
panel is also referred to as the tree-view pane.
Settings Panel
Displays the current settings of the item presently selected in the tree-view
pane.
Table 2 - Configuration Window Components
The following sections describe the menus available from the Configuration window, and what
they are used for.
Toolbar
Table 3 describes those items available from the Toolbar.
Note: The node or item selected in the navigation pane will determine the items displayed on the
Toolbar.
22
Command
Description
Returns you to the previous configuration.
Back
Moves you to the next configuration history.
Forward
Selects the node in the navigation pane that is above the currentlyselected node.
Up
New Configuration
Import Configuration
Note: These options do not apply to MatrikonOPC Desktop Historian.
Export Configuration
Selecting this item (when it is enabled) allows you to create a new Alias
Group by accessing the New Alias Group window (Figure 57).
New Group
This toolbar item is available only when you have selected either the Alias
Configuration node, or an existing Alias Group, in the Configuration
windows navigation pane.
Selecting this item (when it is enabled) allows you to create a new Alias
by accessing the Alias Configuration Wizard (Figure 59).
New Alias
Edit
Clone
Delete
This toolbar item is available only when you have selected either the Alias
Configuration node, an existing Alias Group, or an existing Alias, in the
Configuration windows navigation pane.
Select this item to display the Alias Configuration Wizard (Figure 59),
allowing you to edit an Alias Group or Alias.
This toolbar item is available only when you have selected an existing
Alias in the Configuration windows settings pane (i.e., pane on the right
side of the window).
Select this item to display the Alias Configuration Wizard (Figure 59),
allowing you to clone the selected Alias.
This toolbar item is available only when you have selected an existing
Alias in the Configuration windows settings pane (i.e., pane on the right
Selecting this item (when it is enabled) allows you to delete the selected
node or item.
Import
Select this item to display the Import Alias File window which allows you
to select the .csv file you wish to import.
Export
Select this item to display the Export Alias File window which allows you
to select the .csv file you wish to export.
Table 3 - Toolbar Items
The following sections describe the menus available from the Configuration window, and what
they are used for.
23
File Menu
Table 5 describes the File menu commands.
New Configuration
Import Configuration
Note: These options do not apply to MatrikonOPC Desktop Historian.
Export Configuration
Exit
Selecting this menu option hides the main Configuration window.

Table 4 - File Menu Commands
Edit Menu
The Edit menu options are determined by the item selected in the navigation pane.
Table 5 describes the Edit menu commands that are available when an Alias Group is selected in
the navigation pane.
Command
Description
Selecting this option allows you to create a new Alias Group by
accessing the New Alias Group window (Figure 57).
New Group
This menu option is available only when you have selected either the
Alias Configuration node in the Configuration windows navigation
pane, or an existing Alias in the settings pane (i.e., pane on the right
Selecting this option allows you to create a new Alias by accessing the
Alias Configuration Wizard (Figure 59).
New Alias
pane, or an existing Alias in the settings pane.
Select this option to display the Alias Configuration Wizard (Figure
59), allowing you to edit the selected Alias.
Edit
Select this option to display the Alias Configuration Wizard (Figure
59), allowing you to clone the selected Alias.
Clone
Delete
Selecting this option allows you to delete the selected Alias in the
Configuration windows settings pane.
Import From CSV
Select this option to display the Import Alias File window which allows
you to select the .csv file you wish to import.
Alias Configuration node or Alias Group in the Configuration
windows navigation pane, or an existing Alias in the settings pane.
24
Command
Export To CSV
Description
Select this option to display the Export Alias File window which allows
you to select the .csv file you wish to export.
Alias Configuration node or Alias Group in the Configuration
windows navigation pane, or an existing Alias in the settings pane.
Table 5 - Edit Menu Commands (Alias Group)
View Menu
Table 6 describes the View menu commands.
Command
Description
Toolbar
When selected, the Toolbar appears below the Main Menu.
Location Bar
When selected, displays the Location Bar below the Main Menu and above
the navigation pane. The Location Bar allows you to track the current
configurations location. By clicking on each segment of the Location Bar,
you can easily navigate to the required configuration screen.
Each segment of the Location Bar also provides a drop-down menu that
allows you to browse to the next available configuration. To access the dropdown menu, click on the arrow on the right side of the required Location
Bar segment.
Navigation Tree
When selected, displays the navigation pane including the navigation tree.
Allows you to efficiently browse through the available configuration of the
current product.
Window Tabs
When selected, shows the available windows tabs at the bottom of the
Configuration window. Allows you to view all currently-open configurations.
The currently-open configurations may be organized with options offered in
the Windows menu from the Main Menu.
Note: This option is not selected by default.
Start Page
When selected, shows the current product Start Page.

When selected, allows you to quickly navigate to previously-accessed
configurations by moving Back, Forward, Up One Level, to another
window, and so on.
Go To
Select this option to refresh the display.

Refresh
Note: This option is disabled if it is not applicable.

Table 6 - View Menu Commands
Window Menu
Table 7 describes the Window menu commands that allow you to define how the settings of
pages/tabs are to appear on the right side of the Configuration window.
Command
Cascade
Description
Cascades the currently-opened windows within the configuration.
25
Command
Tile Horizontally
Tile Vertically
Close All
Description
Horizontally arranges the currently-opened windows within the
configuration.
Vertically arranges the currently-opened windows within the configuration.
Closes all currently-opened windows in the configuration. The product
continues to run even with the windows closed.
Table 7 - Window Menu Commands
Help Menu
Table 8 describes the Help menu command.
Command
About iC
Description
Displays an About screen, which includes information about the Integrated
Configuration (iC) configuration management system version.
Table 8 - Help Menu Command
Starting and Stopping MatrikonOPC Desktop Historian

MatrikonOPC Desktop Historian is installed as a 2000 service, and may be started using the Service
Control Manager applet (Start -> Control Panel -> Administrative Tools -> Services).
The MatrikonOPC Desktop Historian service name refers to the historical data component. The
MatrikonOPC Desktop Historian OPC Client service name refers to the data collection
component. The MatrikonOPC Server for Desktop Historian service name refers to the dataserving component. The MatrikonOPC Task Scheduler service name refers to the component
that interfaces the MatrikonOPC Desktop Historian configuration system with the task scheduler for
configuration of scheduled backups.
All services start automatically when the computer is turned on, and automatically restart if the
machine is reset (either manually or due to a system/power failure).
Figure 2 shows the MatrikonOPC Desktop Historian-specific services having been started. An item
entitled Matrikon Sauron Marshal must also appear in the list, with a status of Started.
Figure 2 - Windows Services Panel
26
Generic Management
Generic settings, including log settings and version information, can be accessed on the Desktop
Historian Options screen panel.
To access the Desktop Historian Options page:
1. From the configuration window, in the tree-view pane (navigation pane on the left side of
the screen), select and expand the following nodes:
Desktop -> Localhost -> OPC Desktop Historian -> Options -> Desktop
Historian Options
2. Click on the Configure item displayed under the Desktop Historian Options node. Figure
3 displays the navigation pane and Desktop Historian Options page.
Log Settings
The Log Settings screen allows for the editing of general logging options. The log files will be
contained within the following location ([ ] indicates the default installation path):
[C:\Program Files\Matrikon]\OPC\Desktop Historian\Core\Log
To view the General Logging Options:
1. From the Desktop Historian Options panel described above, select the Log Settings tab.
2. The Log Settings panel is displayed (Figure 3).
27
Figure 3 - Log Settings Tab
Table 9 describes the fields on the Log Settings tab.

Command
Description
Log File Locations

Diagnostic
Displays the default location where the system activity log file is
saved. To save the log file in a different location, click Browse.
Configuration
Displays the default location where the configuration activity log file
is saved. To save the log file in a different location, click Browse.
Audit
Displays the default location where the log action file is saved. To
save the log file in a different location, click Browse.
Log Detail Level

Diagnostic
Log system activity at the specified detail level (High, Medium,

Low, or None). Higher log levels include lower-level activities
Configuration
Log configuration activity at the specified detail level (High,

Medium, Low, or None). Higher log levels include lower-level
activities.
Audit
Log actions committed by users at the specified detail level (Data

Operations, Tag Operations, System Operations, or None).
28
Command
Description
Higher log levels include lower-level activities. The Data Operations
level also records Tag and System operations. The Tag Operations
level also records System operations.
Maximum Log File Size
Limits the number of log-statements that may be entered into a log

file. Once this file size is reached, earlier log-statements will be
erased, thus making room for more recent log statements.
Disable Log Cache
Every log statement is immediately committed to the hard drive.

Selecting this option will disable the Maximum Log size settings and
should only be used for the purpose of debugging.
Apply
Select this button to apply any changes made to the current page.
Cancel
Select this button to discard any changes made to the current page.
Table 9 - General Logging Options Settings Tab
Note: For the General Logging Options Settings to take effect, the Apply button
MUST be selected.
Version Information
Desktop Historian is composed of several components, each of which controls a different task. The
version number of each component used can be found under the Version Information tab (Figure
4) of the Desktop Historian Options panel. This information may be required when contacting
MatrikonOPC Support.
Figure 4 - Version Information Tab

29
Data Storage Management

Data Storage settings (including file type, location, size) can be accessed on the Data Storage
Management page.
To view the Data Storage Management configuration settings:
Desktop -> Localhost -> OPC Desktop Historian -> Options -> Data Storage
Management
2. Click on the Configure item displayed under the Data Storage Management node. Figure
5 displays the navigation pane and Data Storage Management page.
Figure 5 - Data Storage Management Page
The file format type (Desired file format field) and configuration settings (Configuration screen
section) for the selected file format can be selected on this tab.
30
File Format Selection

File format defines how historical data is stored to disk. Different file formats provide different
features and may require different settings. Appendix H File Formats describes the different
file formats in greater detail.
Notes:
Data stored in FF4 format cannot be read when you switch to an FF7 or FF7R
format, and vice versa. If the file format is changed, all access to prior historical
data is not available. The FF7R and FF7 configurations are compatible. However,
switching from FF7 to FF7R may cause some data to be deleted so that it fits
within the requested number of files. It is recommended that the file format be
chosen once, and that is when the system is first installed.
FF7R will be replacing FF4 in future versions of Desktop Historian. Users are
advised to upgrade their configurations. Upgrading from FF4 will result in FF4
no longer being an available file format for data storage. If users wish to
retain their FF4 data prior to switching to another storage format, they may do so
by porting it to another storage location using a tool that moves HDA data.
FF7 Configuration Options

As seen in Figure 5, the FF7 file format has the following configurable items (Table 10):
Item
Description
Historical data file directory
The directory in which to store the files. Defaults to

c:\Matrikon Data.
Store no more than [count] [units] of

history in each file.
Indicates how much data should be stored in each

file. Select the count and the units (weeks, days,
hours or minutes). Defaults to 2880 minutes.
Close and finalize the active data file
When checked, and the Apply button is selected,

Desktop Historian will close all open file handles, and
ensure that the current file has an accurate header.
This item will automatically return to unchecked
when the operation is complete. After completion,
Desktop Historian opens a new file to store further
history.
Apply
Select this button to apply any changes made in the

current page.
Cancel
Select this button to cancel all changes that have

been made in the current page.
Table 10 - FF7 Configuration Options
FF7R Configuration Options

If the FF7R file format is selected (Figure 6), the options listed in Table 11 are available.
Item
Description
The directory in which to store the files. The default

directory is c:\Matrikon Data.
Store the history in [count] 25MB files
Enter the number of 25 MB rolling history buffer files
31
to use. When all of the files have been used, the

oldest is erased and a new one is created.
Maximum value = 15000 25 MB files (assuming
sufficient hard drive space exists). Defaults to two 25
MB files.
Maximum number of files for available
space on hard drive
This field reports the amount of space available in 25

MB files. It is updated automatically when you change
the Historical data file directory.
Do not store values with timestamps

greater than
This field allows you to specify the maximum amount

of future timestamps allowed. This restricts invalid
future timestamps so that files no longer become
corrupted and data loss is minimal.
Default = 10080 Minutes (1 Week)
Apply
Select this button to apply any changes made in the

current page.
Cancel
Select this button to cancel all changes that have

been made in the current page.
Table 11 - FF7R Configuration Options
Figure 6 - FF7R Configuration Options
32
FF4 Configuration Options

IMPORTANT: FF4 is not a file format option unless an upgrade of Desktop Historian is
performed over a previous version where FF4 is currently selected as the storage format.
Support for the FF4 format is going to be removed in future versions of Desktop
Historian, in favour of FF7R. It is recommended that users of FF4 consider upgrading
their configurations to FF7R. It should be noted, however, that switching from FF4 to
FF7R makes data collected in FF4 unavailable for reading. Once the switchover is
completed it will not be possible to revert to FF4.
If the FF4 file format is selected (Figure 7), the following options are available (Table 12):
Item
Description
The directory in which to store the files. Defaults to

c:\Matrikon Data.
Store the history in [count] 25MB files
Enter the number of 25 MB rolling history buffer files

to use. When all of the files have been used, the
oldest is erased and a new one is created.
Maximum value = 15000 25 MB files (assuming
sufficient hard drive space exists). Defaults to two 25
MB files.
Maximum number of files for available

space on hard drive
This field reports the amount of space available in 25

MB files. It is updated automatically when you change
the Historical data file directory.
Apply
Applies the changes made.
Cancel
Cancel all changes that have been made to these

settings.
Table 12 - FF4 Configuration Options
33
Figure 7 - FF4 Configuration Options
34
Backup Utility
MatrikonOPC Desktop Historian includes a utility to configure and schedule backup procedures.
WARNING: The Backup Utility can cause data loss to occur if used
incorrectly.
To prevent this from occurring, the backup command should be
written to only those backup files that are older than the possible
range of insertions, and should not include the active file.
The Backup Utility locks the data files, one at a time, while it is
copying them. While a file is locked, it cannot be written to, and
therefore writes will fail. This means that if data is being archived by
the ODH OPC client with timestamps that fall within the locked file, or
if an OPC HDA client is pushing data into the historian through the
OPC server for ODH with timestamps in the past, those data points
may not be written.
If you need assistance regarding these issues, please contact
Notes:
The Backup Utility requires the entry of a user name and
password for use in executing backup tasks. It is recommended
that the user that is used (i.e., entered) does not change the
password. If the password is changed then each configured
backup task must be updated with the new password.
The Backup Utility can only be used with the FF7 storage
format. While FF7R or FF4 is selected in the Data Storage
Management configuration, backups cannot be scheduled. If
backups are scheduled, and the storage format is changed
from FF7 to FF7R or FF4, the configured backups will not be
executed.
Backups created by the Backup Utility require manual steps to

restore data into a running system. Contact OPC Support for
assistance.
The Backup Utility makes use of the Windows Task Scheduler built into the Microsoft Windows
operating system to schedule the tasks. Scheduled backup operations created by the Backup
Utility are visible in the Microsoft Windows Scheduled Tasks control panel, and can be edited
there as well. However, the Backup Utility provides an easier-to-use means of configuring the
options to the command-line tool that performs the backup operation.
To access the Backup Utility configuration settings:
1. From the Configuration window, in the tree-view pane (navigation pane on the left side of
Desktop -> Localhost -> OPC Desktop Historian -> Backup Utility
2. Click on the Configure item displayed under the Backup Utility node. Figure 8 displays
the navigation pane and the Backup Utility pane.
35
Figure 8 - Backup Utility
Four operations are available from the Backup Utility pane:
Schedule Backup Operation
Modify Backup Operation
Remove Backup Operation
Perform Backup Now
Restore Backup
Schedule Backup Operation

The Schedule Backup Operation is used to create a new scheduled task that executes a backup
operation.
To create a new scheduled backup operation:
1. From the Backup Utility page (Figure 8), click on the Schedule Backup Operation icon.
The Create New Scheduled Backup Wizard is displayed (Figure 9).
Note: The Back button may be used to return to an earlier step at any time to change
values entered. However, the Back button is not displayed unless there is a step to go back
to. The Next button takes you to the next pane, and is only be available if the values
entered in the current pane are valid selections. The Cancel button discards all changes
made so far return to the Backup Utility configuration panel.
36
Figure 9 - Create New Scheduled Backup Wizard: Backup Name
2. Enter a Backup Name and Comment to identify and describe the task being created.
3. Click on the Next button to go to the backup operation selection screen (Figure 10).
37
Figure 10 - Create New Scheduled Backup Wizard: Backup Operation
4. Select the required backup operation option.

5. Click on the Next button to go to the next screen. If either the Copy or Move options are
selected, the Destination screen (Figure 11) appears. If the Delete option is selected, the
Select Files screen (Figure 123) is displayed.
38
Figure 11 - Create New Scheduled Backup Wizard: Destination
6. From the Destination screen, select the destination to which you want the backup files
sent. The backup can either place the files in a folder, or it can compress the files into a ZIP
file. In either case, a copy of the current tag database files will be included in the folder or
compressed file. The Overwrite existing file(s) option is selected by default. With that
option selected, the Backup Utility overwrites existing data files in the selected folder, or
overwrites the entire compressed backup file. If the Overwrite existing file(s) option is
not selected and the backup operation runs and determines that the files already exist in
the selected destination, the backup operation fails without backing up the data.
7. Click on the Next button to proceed to the Select Files screen (Figure 12).
39
Figure 12 - Create New Scheduled Backup Wizard: Select Files
Figure 13 - Create New Scheduled Backup Wizard: Select Files (Delete or Move Operation Selected)
40
8. The Select Files pane is used to set the criteria by which the Backup Utility will choose
which files are to be included in the backup. See Table 13 for a description of each of the
options. See Figure 14 and Table 14 for more details about the Select Files By Date
option.
Option
Description
All Non-Active Files
Selecting this option instructs the Backup Utility to choose all of the data files
in the data directory, except for the one file that is considered the active file.
The active file is the file to which new data points are being written.
Selecting this option selects just the active file.
The Active File
Note: If the Move or Delete command is selected, this option is not available
(Figure 13).
Selecting this option includes all files in the directory.
All Files
Note: If the Move or Delete command was selected, this option is not
available (Figure 13).
Select Files By Date
Selecting this option allows for the selection of data files according to the date
range of data that they contain. Selecting this option causes the Select Files
screen to display the date selection options (Figure 14).
Table 13 - Select Files Options
Figure 14 - Create New Scheduled Backup Wizard: Select Files By Date
41
Figure 15 - Create New Scheduled Backup Wizard: Select Files By Date (Move or Delete Operation Selected)
Option
Description
Date
Select which of the dates associated with each data file to use for the
selection. Each data file contains all the data between a Start and End date.
The Last Modified of a data file is maintained by the operating system, and
is the date and time to which the file was last written.
Comparison
Select the comparison to use. For the Before and After options, only one of
the two date expression fields will be available. The Between option requires
entries in both of the date expression fields.
[date expression]
and [date
expression]
Enter the date(s) or date expression(s) to set the range of files to be selected
by the backup utility for inclusion in the backup. HDA relative time
expressions may be used or specific dates can be entered. For more
information refer to Appendix M HDA Relative Time Format in this
manual.
Each of the fields has an ellipsis button adjacent to it which displays a form to
simplify the entry of these fields (Figure 16).
Allow the active file

to be selected by
date
The active file is normally excluded from selections by date. If the Date,
Comparison, and date expression(s) include the active file, and this option is
checked, then the Backup Utility includes the active file in the backup.
Note: This option is not available if the Move or Delete operation is selected
(Figure 15).
Table 14 - Select Files By Date Options
42
9. If the ellipsis button for a time expression is selected, the Date Editor window (Figure 16)
appears. Select either a Fixed Date or a Relative Time Expression, and fill out the
associated fields. Click on the Ok button to return to the Select Files By Date screen of
the Create New Scheduled Backup Wizard, with the selected date or date expression in
the date expression field. Clicking on the Cancel button discards any changes made in the
form and returns you to the Select Files By Date screen.
Figure 16 - Date Editor Window
10. From the Select Files By Date screen, click on the Next button to continue to the schedule
type selection screen (Figure 17).
43
Figure 17 - Create New Scheduled Backup Wizard: Schedule Type
11. Select one of the scheduling options and click on the Next button to proceed to the specific
configuration panel for the selected schedule type (listed below). The When my computer
starts option does not have any additional configuration options. Clicking on the Next when
that option is selected will skip ahead to the applicable Credentials screen (Figure 22).
Daily Schedule
Weekly Schedule
Monthly Schedule
One Time Only Schedule
12. The Daily Schedule type (Figure 18) configuration screen has the options described in
Table 15.
44
Figure 18 - Create New Scheduled Backup Wizard: Daily Schedule
Option
Description
Start Time
The time of day to run the backup. The time of day will be formatted
according to the computers configured regional settings. Seconds, if
displayed, are ignored in the schedule.
Every Day
The default option. When selected, the backup is performed every day at the
selected Start time.
Weekdays
When selected, the backup is performed only on weekdays (Monday through

Friday), at the selected Start time.
Every [x] days
When selected, the numeric selection box is enabled. Enter the period in days
after each scheduled run before the next run should occur.
Start Date
The date at which the schedule becomes active.

Table 15 - Daily Schedule Options
13. Click on the Next button to go to the Credentials screen (Figure 22).
14. The Weekly Schedule type configuration screen (Figure 19) has the options described in
Table 16.
45
Figure 19 - Create New Scheduled Backup Wizard: Weekly Schedule
Option
Description
Start Time
The time of day to run the backup. The time of day

will be formatted according to the computers
configured regional settings. Seconds, if displayed,
are ignored in the schedule.
Every [x] Weeks
Defines whether the backup should be run every

week, every other week, every third week, etc.
Monday, Tuesday, Wednesday, Thursday,

Friday, Saturday, Sunday
Select which day or days of the week on which the

backup should run.
Table 16 - Weekly Schedule Options
16. The Monthly Schedule type configuration screen (Figure 20) has the options described in
Table 17.
46
Figure 20 - Create New Scheduled Backup Wizard: Monthly Schedule
Option
Description
Start Time
The time of day to run the backup. The time of day

will be formatted according to the computers
configured regional settings. Seconds, if displayed,
are ignored in the schedule.
Day
The day of the month on which the backup should

run.
The [ordinal] [weekday]
Select which week of the month and day of that week

on which the backup should run. For example, the
First Sunday, or the Second Tuesday.
Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep,

Oct, Nov, Dec
Select which months in which the backup should run.

The Select All and Clear All buttons will check or
uncheck, respectively, all of the months.
Table 17 - Monthly Schedule Options
18. The One Time Only schedule type configuration screen (Figure 21) has the options
described in Table 18.
47
Figure 21 - Create New Scheduled Backup Wizard: One Time Only Schedule
Option
Description
Date
The date on which the backup should be run.
Time
The time of day to run the backup. The time of day will be formatted according
to the computers configured regional settings. Seconds, if displayed, are
ignored in the schedule.
Table 18 - One Time Only Schedule Options
20. The Credentials Panel (Figure 22) requires the entry of a user name and password for a
Windows account that has privileges to connect to the Desktop Historian service, read
from the data and database directories, and write to the selected destination directory. If
the account selected does not have sufficient permissions for those tasks, the backup
operation is not able to execute or complete. Enter the full DOMAIN\Username and enter
the Password for the account. You need to enter the password a second time to confirm it
was typed correctly.
48
Figure 22 - Create New Scheduled Backup Wizard: Credentials
21. Click on the Next button to continue. The Wizard tests the user name and password to
ensure that it is a valid combination. If the user name and password combination do not
work, a warning is displayed and you are returned to the Credentials panel. If the user
name and password are valid, the Summary screen is shown.
Notes:
The check performed does not ensure the user has adequate permissions to perform
the operation, only that the password is correct for the provided user name.
It is recommended that the user that is used (i.e., entered) does not change the
password. If the password is changed then each configured backup task must be
updated with the new password.
22. The Summary screen (Figure 23) is displayed which provides a textual summary of the
scheduled backup item to create. If any of the settings need to be changed, the Back
button can be used to go backwards through the Wizard sequence to reach the appropriate
screen where the settings can be changed.
49
Figure 23 - Create New Scheduled Backup Wizard: Summary
23. Confirm that the settings are correct.

24. Click on the Finish button to create the scheduled task.
25. The scheduled task is created, and the Backup Utility configuration screen is displayed,
with a message appearing at the bottom indicating whether the backup creation was
successful (Figure 24).
50
Figure 24 - Create New Scheduled Backup: CompleteMonth
Modify Backup Operation

The Modify Backup Operation task is used to modify the backup parameters or schedule of a
backup that was already scheduled.
To modify an existing operation:
1. Click on the Modify Backup Operation icon from the Backup Utility configuration panel
(Figure 8). The Modify Scheduled Backup screen (Figure 25) appears.
51
Figure 25 - Modify Scheduled Backup
2. The Modify Scheduled Backup screen lists all of the scheduled backup operations. Each
operation can be enabled or disabled by toggling the Enabled checkbox. A disabled backup
will not be run. Selecting the Back button returns you to the Backup Utility configuration
screen (Figure 8.) Selecting the Modify button on any of the listed backups opens the
Modify Scheduled Backup Wizard on the Backup Name panel (Figure 26.)
Note: The Backup Name cannot be changed when modifying a task.
52
Figure 26 - Modify Scheduled Backup Wizard: Backup Name
3. Modify the task as required. The Modify Scheduled Backup Wizard uses the same
sequence of panels as the Create New Scheduled Backup Wizard. Use the Next and
Back buttons to navigate through the Wizard screens. Use the Cancel button at any time
to discard any changes made and return to the Modify Scheduled Backup list (Figure 25).
When you reach the Summary panel (Figure 27), the Finish button is available. Click on
the Finish button to commit the changes and return to the Modify Scheduled Task list
(Figure 25).
53
Figure 27 - Modify Scheduled Backup Wizard: Summary
Remove Backup Operation

The Remove Backup Operation task is used to modify the backup parameters or schedule of a
backup that was already scheduled.
To remove a scheduled backup:
1. Click on the Remove Backup Operation icon from the Backup Utility configuration
screen (Figure 8). The Remove Scheduled Backup list (Figure 28) appears.
54
Figure 28 - Remove Scheduled Backup
2. Click on the Remove button associated with the backup you wish to remove. A confirmation
message (Figure 29) appears. Click OK to confirm the task deletion, or click on Cancel to
return to the Remove Scheduled Backup list (Figure 28).
Figure 29 - Remove Scheduled Backup Confirmation
3. If the OK button was selected, the task is removed and the Remove Scheduled Backup
list is shown with a confirmation message. If the last task was removed, the Backup Utility
configuration screen (Figure 8) is displayed with a confirmation message.
Perform Backup Now

The Perform Backup Now task is used to immediately run a backup operation.
55
To perform a backup operation immediately:

1. Click on the Perform Backup Now icon from the Backup Utility configuration screen
(Figure 8). The Perform Backup Now list is displayed (Figure 30).
Figure 30 - Run Backup Now
2. The Custom Backup entry on the list can be used to configure the backup and run it right
away. Select the Create and Execute button to build a backup operation. Each of the
configured scheduled backups is also listed. If you select the Execute button on one of the
scheduled backups, the settings for that scheduled backup are used to set the options for
the backup operation.
Note: Changing the settings for an existing backup for the Backup Now operation will not
change the settings for the scheduled backup. Those changes apply for the immediate
backup operation only.
3. If the Custom Backup items Create and Execute option was chosen, the Backup Now
Wizard is displayed showing the Backup Operation panel (Figure 31).
56
Figure 31 - Backup Now Wizard: Backup Operation
4. The Backup Now Wizard uses the Backup Operation, Destination, Select Files,
Credentials, and Summary screens in the same way as the Create New Scheduled
Backup Wizard and the Modify Scheduled Backup Wizard. Clicking on the Finish
button on the Summary screen executes the backup.
5. If the Execute button on one of the existing Scheduled Backup operations is selected, the
Backup Now Wizard will skip to the Summary screen. The Back button can be used to
access the other portions of the Wizard.
Note: The credentials stored for a scheduled task are lost if you click on the Back button
(from the Summary screen in this case). You are required to re-enter the password for the
account to execute the backup.
Restore Backup
The Restore Backup Operation is used to get data files stored in a backup location and add them
to the live system.
To restore data files from a backup:
1. Click on the Restore Backup icon from the Backup Utility configuration panel (Figure 8).
2. The Restore Backup screen (Figure 32) appears.
57
Figure 32 - Restore Backup Wizard: Choose Source
3. Select the applicable option indicating either a folder source (Folder) or zip file
(Compressed ZIP file) from which the backup is to be restored.
4. Click on the Next button to proceed to the Select Files screen (Figure 12).
Note: The Select Files pane is used to set the criteria by which the Backup Utility
chooses which files from the backup set are to be restored to the live system. See Table 13
for a description of each of the options. See Figure 14 and Table 14 for more details about
the Select Files By Date option.
IMPORTANT: A backup can only be restored to the live system if the
following conditions are met:
The tag database file in the backup system must exactly match
the tag database in the live system.
The selected files from the backup source must not contain
time ranges that overlap or replace any files in the live system.
Use the Select Files screen on the Restore Backup Operation to

limit the files in the backup set which are to be considered for this
test. When the Restore Backup Operation in the GUI cannot restore
a backup to the live system, the Command Line Backup Utility can
be used to obtain more information.
6. The Credentials Panel (Figure 22) requires the entry of a user name and password for a
Windows account that has privileges to connect to the Desktop Historian service, read
from the data and database directories, and write to the selected destination directory. If
58
the account selected does not have sufficient permissions for those tasks, the backup
operation will not be able to execute or complete. Enter the full DOMAIN\Username and
enter the Password for the account. You will need to enter the password a second time to
confirm it was typed correctly and to enable the Next button.
7. Click on the Next button.
8. The Summary screen (Figure 33) is displayed which provides a textual summary of the
Restore Backup Operation to complete. If any of the settings need to be changed, the
Back button can be used to go backwards through the Wizard sequence to reach the
appropriate screen where the settings can be changed.
Figure 33 - Restore Backup Wizard: Summary
9. Confirm that the settings are correct.

10.Click on the Finish button to run the Restore Backup Operation.
11. The Backup Utility configuration screen is displayed, with a message appearing at the
bottom indicating whether the restore operation was successful (Figure 24). You may need
to wait several minutes depending on the size of the backup file for this to complete.
Backup Utility Logging Options

Backup Utility settings, including logging and filtering, can be accessed via the Logging Options
page.
Note: Logging Options settings are saved once the Apply button is
selected. However, they do not take effect until the back-end server is
re-started.
59
To view logging settings:

1. On the navigation pane of the Configuration window, select and expand the following
nodes:
2. Click on the Logging Options item displayed under the Backup Utility node. Figure 34
displays the navigation pane and Logging Options page.
Figure 34 Logging Options Page
Table 49 describes the components of the Logging Options page.

Command
Enable server activity
logging
Description
Selecting this checkbox enables general activity logging. If this
checkbox is not selected (i.e., the checkbox is cleared), none of the
fields on the Logging Options page are available.
By default, this checkbox is selected.
Activity Log Settings

If this field is enabled, allows you select from the drop-down list, the
amount of detail to be provided in the log file:
None
Low Errors (default setting)
Log Level
Medium Errors and Warnings

High Errors, Warnings, and Information
If the Enable server activity logging checkbox is not selected
(i.e., the checkbox is cleared), this field is not available.
Default = Low.
Filename
If this field is enabled, allows you to enter a full path for the activity
log file.
Log files for individual backup jobs also appear in this same
60
Command
Description
directory. Individual job logs are named [JobName].log. The
default path is: C:\Program Files\Matrikon\OPC\Desktop
Historian\TaskScheduler\Log\TaskScheduler.log.
Browse
Select this button to access the Open window which allows you to
locate and select the necessary log file. The selected file is displayed
in the Filename field.
Overwrite old log

information
If enabled, selecting this checkbox ensures that the old log file is
overwritten each time the server starts up. Otherwise, the old log file
is renamed with an underscore (_) prefix.
By default, this checkbox is cleared.
Commit all log file writes
Wrap log file if it exceeds
If enabled, selecting this checkbox ensures that the file buffer is

flushed after each message logged, in case the server is crashing.
This checkbox is available only if the:
Wrap log file if it exceeds checkbox is cleared, and
Enable server activity logging checkbox is selected
By default, this checkbox is neither enabled or selected.
If enabled, selecting this checkbox specifies that the log file is
wrapped when it exceeds the defined value (in MB).
If this checkbox is selected, the Commit all log file writes
checkbox is unavailable.
Filtered Log Settings
Filter String
If this field is enabled, allows you to enter a match string for filtered
log.
Filename
If this field is enabled, allows you to enter a full path for the filtered
log file.
Browse
locate and select the necessary log file. The selected file is displayed
Apply
Use this button to commit any changes made on the Logging

Options page.
Cancel
Use this button to discard any changes made on the Logging

Options page.
61
Table 19 - Logging Options Components
Version
This page is display only and shows OPC product version information.
To view Backup Utility version information:
nodes:
2. Click on the Version item displayed under the Backup Utility node. Figure 35 displays the
Version page.
Figure 35 - Backup Utility Version
Command Line Use

The Backup Utility can also be accessed from the windows command line, or through any tool that
can execute command line programs.
Note: A command line utility is an executable program intended to
be run from the command line (also known as the DOS Prompt in
older versions of Microsoft Windows). This tool may be run manually,
incorporated into Batch Files, called from a third-party backup
program, or scheduled to run automatically through the Microsoft
Windows Scheduled Tasks system.
The backup tool is installed by default into the following location:
C:\Program Files\Matrikon\OPC\Desktop Historian\Util\BackupTool.exe
62
The backup utility has the following features:
Lists the data files and provides information about them including the time range of the data
stored within them. By default, all files that are part of the historical data storage are listed.
However, a subset of files may be listed as well.
Ability to copy or move data files to another folder while ensuring that those files cannot be
changed during the copy. Different subsets of data files can be selected based on the time
ranges, and current status of each data file. Data files may also be stored in a compressed
(ZIP) archive file.
Can close and finalize the active data file to allow that file to be included in a backup.
Read header information about a data file or backup zip file or directory.
Test if a restore operation could succeed
Restore a backup from a zip file, or directory.
Provides a synopsis of how to use the backup utility.
Accessing the Command Line

The command line can be accessed in several ways:
From the Start Menu, choose Run, and type in the full command line in the resulting box.
From the Start Menu, choose Run, and type in the command cmd and press the Enter
key. This will launch the command interpreter which can then be used to run the backup
tool.
From the Start Menu, choose All Programs -> Accessories -> Command Prompt. This
launches the command interpreter which can then be used to run the backup tool.
Command Line Options

BackupTool [-?] [-H] [-V] [-F] [-S "selection"] [-M|-C] "destination path" [-L]
[--DELETE][--RESTORE] [-RH] [-RV] [--FORCE] [--OVERWRITE] [--CONTINUE] [-NONINTERACTIVE]
[--OUT output file] [--CSV]
General Options
Option
Description
-F
Closes and finalizes the active file. This will allow new data to go into a new
active file, and the current active file will become inactive. This is
recommended for any backup situation where the active file needs to be
backed up.
-V
Verbose logging. This will provide more detailed log messages on the console.
-S selection
Select which files to act on. See Valid Selections for more information.
--FORCE
Forces the move and deletes commands to take files offline without user input.
--OVERWRITE
Allows the Move and Copy commands to overwrite existing files in the
destination folder, or to overwrite an existing zip file.
--CONTINUE
When there is an error moving or copying individual files, --CONTINUE will

cause the command to report the error, but continue to process other selected
63
Option
Description
files.
--NONINTERACTIVE
This option indicates that the backup utility is being run in the background (by
the task scheduler).
The backup command overwrites files only if --OVERWRITE was specified,
and deletes or move files offline only if the --FORCE option was specified.
--OUT output file
Specify a file to which to direct console text. Using the option forces the
--NONINTERACTIVE option to be applied as well. If the specified output file
already exists, it will be overwritten.
--CSV
Causes the L, -RH, -RV and --RESTORE commands to list the information
about each data file in a comma separated values format.
-?, -H
Displays these usage directions.

Table 20 - General Options
Commands
Only one command may be used at a time.
Command
Description
-L
Lists selected files. If no selection is made, all files are listed.
-C "destination path"
Copies selected files to the destination path.
-M "destination path"
Moves selected files to the destination path. Selected files will not be
available in the historian following this command.
-CZ "destination file"
Copies selected files to the destination zip file. The destination file should
end in the extension .zip, If it does not, .zip will be added to the end of
the provided name.
-MZ "destination file"
Moves selected files to the destination zip file. Selected files will not be
available in the historian following this command. The destination file
should end in the extension .zip, If it does not, .zip will be added to the
end of the provided name.
-U
Unlocks all files. The selection is ignored. This is intended to help recover
from a crash during the backup process.
--DELETE
Deletes selected files. This takes the data off line. This will cause data
loss and is not recommended.
--RESTORE source
Attempts to restore data from a backup. The source may be a single data
file, a backup zip file, or a backup folder. The restore command can only
complete a restore operation if data files do not overlap, and if the tag
database in the backup source (n/a for single data files) matches the tag
database in the live system. A S SELECTION option may be used to
specify which data files in the backup source to restore.
-RH source
Reads and lists the file information for a target zip file or directory. The
S SELECTION option will allow a specific sub set of the files to be
listed. source may be a backup folder, zip file, or single data file.
-RV source
Tests if a target zip file or directory can be restored to the live system.
The S SELECTION option will allow a specific sub set of the files to be
64
Command
Description
listed. source may be a backup folder, zip file, or single data file. If
the test passes, then the same command can be executed again replacing
RV for --RESTORE to run a restore command that can be expected to
work (provided the live system has not changed in such a way to prevent
the restore from succeeding.)
Table 21 - Commands
Valid Selections
Only one selection command may be used.
Command
Description
-S "NONACTIVE"
Select all non active files (default).
-S "ALL"
Select all files.
-S "ACTIVE"
Select only the active file.

Select files by date or date range.
<timetype> is one of:
STARTS: The earliest possible timestamp in the file.
ENDS: The latest possible timestamp in the file.
MODIFIED: The system last modified time for the
file.
<timecomp> is one of:
BEFORE: Where the selected <timetype> comes
before the <dateexpr>.
-S "<timetype> <timecomp>
<dateexpr>[ AND <dateexpr>][ ACTIVE]"
AFTER: Where the selected <timetype> comes after

the <dateexpr>.
BETWEEN: Where the selected <timetype> falls
between the two date expressions. When BETWEEN is
used, two date expressions must be entered with AND
in between them. The date expressions may be in any
order.
<dateexpr> is either a date/time or an HDA relative
date/time expression.
The ACTIVE option, if specified after the date or date
range means that the active file will be included
provided that it also is selected by the date(s)
entered. The active file will not be selected otherwise,
even if it meets the date requirement.
Table 22 - Valid Selections
Selection Examples
All files that start prior to one week before this week began.
-S "STARTS BEFORE WEEK-1W"
65
All files that start some time in the last month. Include the active file if it is in that time range.
-S "STARTS AFTER NOW-1MO ACTIVE"
All files that end more than three full calendar months ago.
-S "ENDS BEFORE MONTH-3MO"
All files last modified during January 2008.
-S "MODIFIED BETWEEN 2008-01-01 00:00 AND 2008-02-01 00:00"
66
Data Collection Management

Data Collection settings (e.g., OPC Item selection, Tag update parameters) can be accessed on the
Data Collection Management page.
To view the Data Collection Management configuration settings:
Desktop -> Localhost -> OPC Desktop Historian -> Data Collection
Management
2. Click on the Configure item displayed under the Data Collection Management node.
Figure 36 displays the navigation pane and Data Collection Management page.
Figure 36 - Data Collection Management Page
The Data Collection Management tab consists of the following sections which are described in
more detail below:
Tag Browser
Tag Workspace
Data Collector
67
Tag Browser
The Tag Browser (Figure 37) provides features for locating data servers and items. It provides
both hierarchical and flat browsing to the data server. This simplifies the process of adding tags to
the Tag Workspace. Refer to Adding a Tag for more information about adding tags to Desktop
Historian.
Figure 37 - Tag Browser (with and without Flat Browse enabled)
Table 23 describes the components of the Tag Browser screen section.

Component
Description
Source Data Server
Enter the name of a data server in this field, or if required, use

the ellipsis button adjacent to this field to select a server from a
list of installed data servers.
Tag Name Filter
If required, enter a server-specific filter string.
Flat Browse
Select this checkbox to enable flat browsing, or clear the

checkbox to use hierarchical browsing. If required, use flat
browsing mode to view all items on a server without the branch
structure.
Browse
Use this button to return a list of branches and items available in

the server.
Item Display
Displays the applicable items allowing you to select those to be
68
Component
Description
archived.
Enable Archiving of these Tags
Default Update Rate (ms)
Select this checkbox to allow the selected tags to be archived.

Clear the checkbox if the selected tags are not to be archived.
Allows you to determine the default update rate for the selected
tag or tags (in milliseconds) by either manually entering a value
in this field, or by using the increase and decrease arrows
adjacent to the field to adjust the value.
Note: If the tags Update Rate is set to 0 then all item updates
are ignored including Lifetime updates.
Default Data Type
From the drop-down list, allows you to select a data type that will
be applied to the item if the source items data type cannot be
found, or is not supported by Data Storage.
Advanced
Select this button to access the Advanced Tag Options window

(Figure 38) where you can enable and define Timestamp
Processing and Tag Lifetime.
Add Selected Tags
Select this button to create new OPC Desktop Historian tags in

the workspace.
Table 23 - Tag Browser Components
Figure 38 displays the Advanced Tag Options window which is accessed via the Advanced
button on the Tag Browser (Figure 37). The window components are described in Table 24.
Figure 38 - Advanced Tag Options Window
69
Component
Description
Timestamp Processing
Select this checkbox to replace the server-provided timestamp
with one from the system clock on the Desktop Historian
computer, for the selected items.
Use System Timestamp
Timestamp Bias
If this checkbox is not selected, and the Enable Tag Lifetime

checkbox is selected, a warning is displayed stating: The
lifetime feature will not record tag values correctly unless the
OPC server provides updated timestamps, or the Use System
Timestamp option is selected.
Enter or select a value (in milliseconds) to adjust the timestamp
for the selected tags before storing them. The Timestamp Bias
is added to the timestamp provided by the server, or if Use
System Timestamp is selected, then the bias is added to the
system timestamp for this value. The bias may be positive or
negative.
Tag Lifetime
Select this checkbox to enable the Tag Lifetime feature for the
selected tags. Tags using the feature are periodically polled
according to the Lifetime Update Rate when values have not
changed in that time period.
Enable Tag Lifetime
Selecting this checkbox enables the Lifetime Update Rate and

Units fields. If this checkbox is selected, and the Use System
Timestamp checkbox is not selected, a warning message is
displayed. See Use System Timestamp for message
information.
Note: If the tags Update Rate is set to 0 then this setting is
ignored and Lifetime updates will not occur.
Lifetime Update Rate
If available, this field allows you to enter a value defining the

update rate. The update rate unit of time (e.g., milliseconds,
seconds, minutes, etc.) is defined in the Units field.
The minimum acceptable Lifetime Update Rate is 100 ms. The
maximum acceptable Lifetime Update Rate is 42 days.
Update Rate Units
If available, from the drop-down list, select an update rate unit

of time (e.g., milliseconds, seconds, minutes, etc.).
Lifetime Read Interface
Select the appropriate read interface option: AsyncIO, SyncIO.

If AsyncIO is selected, Desktop Historian data client will
attempt to perform an asynchronous command to obtain the
most recent value, quality, and timestamp for a lifetime read.
The SyncIO option will cause the data client to use a
synchronous command instead.
Accept
Select this button to commit any changes made in the

Advanced Tag Options window. These changes apply to the
tags selected in the Tag Browser when the Add Selected Tags
button (in the Tag Browser) is selected.
Cancel
Select this button to discard any changes made in the Advanced
70
Component
Description
Tag Options window.
Table 24 - Advanced Tag Options Window Components
Tag Workspace
The Tag Workspace (identified as Tag Management screen section) contains all tags in Desktop
Historian. Each tag (row) represents a piece of data to be archived. Each tag consists of several
attributes (cells) that include a unique display name, matching data item, and several data update
parameters.
The Tag Workspace can be used to add new tags, remove tags, or modify the update behavior of
a tag.
The Apply button (located in the bottom right corner of the tab) synchronizes Desktop Historian
with the workspace by adding, removing, and modifying tags to match the contents of the
Workspace.
The Cancel button (located in the bottom right corner of the tab) resets the workspace with the
last known configuration. This effectively ignores any changes to the Workspace since the last time
the Apply button was used, or since the tab was opened.
The workspace cells change colour based on the expected action to be performed, and the results
of an action. Refer to Colour Legend for more information.
Figure 39 - Tag Workspace
Tag Management Toolbar

The Tag Management toolbar (Figure 40) provides commonly-used commands to modify selected
tags and access to the display preferences tool.
71
Figure 40 - Tag Management Toolbar
Table 25 describes the components of the Tag Management toolbar.

Component
Description
Cuts selected values/rows to clipboard.
Cut
Copy
Copies selected values/rows to clipboard.
Paste
Pastes values from clipboard into selected rows.
Mark Items for Deletion
Marks all selected tags for deletion. Tags will be deleted with the
Commit button has been pressed.
Unmark Items for Deletion
Unmarks all selected tags for deletion. This may be used after
tags have been marked for deletion, but before the Commit
button has been pressed.
Visible Attributes
Opens the Preferences window which allows the user to select

which attributes should be displayed in the Tag Workspace. For
more information, refer to Visible Attributes.
Set Default Visible Attributes
Resets the visible attributes to only those displayed by default.
Refresh Tags
Refreshes the tag list from the tag database. This will cause all
pending changes to be lost.
Show Legend
Shows/hides the Colour Legend window. Refer to Colour

Legend for more information.
Table 25 - Tag Management Toolbar Components
Tag Management Context Menu

The context menu (Figure 41) on the Tag Workspace provides options for selecting visible
attributes, and other for modifying selected tags. To display the context menu, right-click your
mouse anywhere in the Tag Workspace screen section.
Refer to Customizing the Display for more information about the Preferences window which
also allows you to define which attributes are visible in the workspace.
Figure 41 - Tag Management Context Menu

72
Table 26 describes the components of the Tag Workspace context menu.

Component
Description
Cuts selected values/rows to clipboard.
Cut
Copy
Copies selected values/rows to clipboard.
Paste
Pastes values from clipboard into selected rows.
Mark Tag For Deletion
Marks all selected tags for deletion.
Unmark Tag For Deletion
Unmarks all selected tags for deletion.

Displays a list of visible attributes allowing you to select or
deselect those attributes you want shown in the Tag
Workspace. For more information, refer to Visible Attributes.
Set Visible Attributes

(Shortcut)
Opens the Preferences window which allows the user to select

which attributes should be displayed in the Tag Workspace. For
more information, refer to Visible Attributes.
Set Visible Attributes

Set to Default Visible
Attributes
Resets the visible attributes to only those displayed by default.
Refresh Tag List
Refreshes the tag list from the tag database. This will cause all
pending changes to be lost.
Legend
Shows/hides the Colour Legend window. Refer to Colour

Legend for more information.
Table 26 - Tag Management Context Menu Options
Tag Status
The Tag Status (Figure 42) is found at the bottom of the Tag Workspace and displays the
following:
Total number of tags
Number of marked, deleted tags
Number of changed tags
Number of tags with invalid attributes
Figure 42 - Tag Status
Data Collector State

Desktop Historian uses an OPC Client to collect data related to each tag. The current state (i.e.,
status) of either Started or Stopped (Figure 43) is reported on the Data Collector screen
section. Refer to Turning Data Collection On or Off for more information.
Pressing the action button to the right of the status display will toggle the current Data Collector
state. When Data Collector is started, the action button will display Stop. When the Data Collector
is stopped, the action button will display Start.
73
Figure 43 - Data Collector State (showing Started and Stopped)
Note: When the Data Collector is stopped, the OPC client configuration node will go offline.
Adding a Tag
Tags can be added using the Tag Browser (Figure 37). A data server may provide a list of item
IDs contained in the server. Retrieving this list is referred to as browsing. The Tag Browser can
be used to find and select data items to archive.
To add a tag:
1. In the Tag Browser, enter or select the source data server you want to browse in the
Source OPC Server field.
2. If required, enter a filter string in the Tag Name Filter field.
3. If required, select the Flat Browse checkbox.
Note: Leaving this checkbox cleared will mean that hierarchical browsing will occur rather
than flat browsing. Refer to Figure 37 which shows how the Tag Browser screen section
appears when the Flat Browse checkbox is cleared, and when it is selected.
4. Click on the Browse button. This will retrieve the list of OPC items available in the selected
OPC server.
5. Select the tag or tags you wish to add.
Note: Typical Windows functionality can be used to select multiple items. To select nonadjacent items, select one item and then hold down the CTRL key and click on each
additional item. To select adjacent items, select the first item in the sequence and then hold
down the SHIFT key and click on the last item in the sequence.
6. If required, make changes to the following fields: Enable Archiving of these Tags,
Default Update Rate, Default Data Type.
7. If required, click on the Advanced button.
8. The Advanced Tag Options window (Figure 38) appears.
9. Enable and define the Timestamp Processing and Tag Lifetime options as necessary.
10. Click on the Accept button to close the Advanced Tag Options window and return to the
Tag Browser.
Note: Any changes you made in the Advanced Tag Options window and then accepted
will be reflected in field below the Advanced button in the Tag Browser.
11. Click on the Add Selected Tags button (which is now enabled) to create the new Desktop
Historian tags in the workspace.
Note: The tags are added to MatrikonOPC Desktop Historian immediately after the Add
Selected Tags button is pressed.
74
Removing a Tag
Notes:
Removing a tag from Desktop Historian is an irreversible
event. When a tag is removed, all access to the tags
historical data will be lost. Adding a new tag with the same
name as the previously removed tag will NOT allow access to
previously collected history.
All rows in the Tag Workspace can be selected (i.e.,

highlighted) by clicking in the top uppermost cell on the left
side of the grid. Click in the cell again to de-select all rows.
The Mark Tag For Deletion and Unmark Tag For Deletion
menu options are enabled only when rows have been selected.
The tags will not be removed from Desktop Historian until the
Commit button has been selected.
To remove/delete a tag:
1. In the Tag Workspace, highlight the tag or tags you want to remove. Clicking in the item
number column will highlight the required row/tag.
Note: Typical Windows functionality can be used to select multiple items. To select nonadjacent items, select one item and then hold down the CTRL key and click on each
additional item. To select adjacent items, select the first item in the sequence and then hold
down the SHIFT key and click on the last item in the sequence.
2. Right-click your mouse and select the Mark Tag For Deletion option from the displayed
context menu. The tag is now highlighted in red to acknowledge the request.
Or,
Select the Mark Items for Deletion button
on the Tag Management toolbar.
Notes:
Once the Mark Items for Deletion button has been selected, the selected tag or
tags appear highlighted in red to acknowledge the request (Figure 44).
If required, you can unmark those tags marked for deletion by selecting Unmark
Tag for Deletion from the context menu, or by selecting the Unmark Items for
Deletion button from the toolbar. For more information refer to Tag Management
Context Menu.
The Mark Tag For Deletion and Unmark Tag For Deletion context menu options
are enabled only when rows have been selected.
75
Figure 44 - Tag Workspace showing Tags Marked for Deletion
3. Click on the Commit button. The selected tag or tags are removed.
Changing a Tag Attribute

Changes can be made to the tag attributes simply by entering a value in an attribute cell.
Note: A tags data type can modified only as it is being created. This
ensures that all historical data is stored in a consistent manner for a
specific tag.
To change an attribute for a tag:
1. In the Tag Workspace, click in the cell for which you want to change the value.
2. Make the required change.
3. Press Enter on your keyboard, or click anywhere outside of the changed cell.
4. The attribute is now highlighted in blue (Figure 45) to acknowledge the request.
76
Figure 45 - Tag Workspace showing Changed Attribute
5. Click on the Commit button.

6. The attribute change is displayed.
Renaming a Tag
A tags display name can be modified just like any other attribute. For more information, refer to
Changing a Tag Attribute.
Note: Deleting a tag and then creating a new tag with the same name
will not recover old tag data.
To rename a tag:
1. In the Tag Workspace, click in Item Name field you want to change.
2. Make the required name change.
Note: A tags display name MUST be unique. If not, once the
Commit button is selected, the cell is highlighted in yellow to
acknowledge an invalid name and the change will not be applied. In
that case, click on the Cancel button and the cell value will revert back
to its original value.
3. Press Enter on your keyboard, or click your mouse anywhere outside of the changed cell.
4. The display name is now highlighted in blue to acknowledge the request.
5. Click on the Commit button.
6. The changed name is displayed in the workspace.
77
Turning Tags On or Off

Note: A tag that is turned off cannot be read from or written to. To
turn off only tag updates (but allow reads). Refer to Changing the
Update Rate.
A tag can be turned on or off by modifying the tags archiving attribute. Changes to this attribute
can be made by simply selecting or clearing the checkbox in the Archiving field. The display name
is then highlighted in blue to acknowledge the request.
Changing the Update Rate

A tags Update Rate can be modified just like any other attribute (for more information, refer to
Changing a Tag Attribute). The Update Rate can be changed by clicking the increase or
decrease buttons on the right side of the column to provide a new rate, and then press Enter or
click anywhere outside the cell. The display name is then highlighted in blue to acknowledge the
request.
Note: If a tags Update Rate is 0, the tag disables all point updates
including Lifetime updates. This setting does not prevent OPC clients
from writing to the tag via the OPC server.
Changing the Node Name and Process Name

The Node Name and Process Name attributes can be changed manually by editing the cell
directly, or by browsing the Server Browser window (Figure 46). Click the button (outlined in red
in the diagram below) on the right side of the Process Name cell to access the Server Browser
window.
78
Figure 46 - Changing Node Name and Process Name
Invalid Attributes
Invalid attributes are highlighted in yellow with a red triangle displayed in the top right corner of
the cell, as show in Figure 47. When your cursor is moved over the red triangle, a comment
window is displayed with a detailed explanation of why that particular attribute is invalid.
Note: Tags are updated only once all invalid attribute fields are
corrected.
79
Figure 47 - Invalid Attributes
Configuring Array Elements

MatrikonOPC Desktop Historian does not support tags of array data type. However, it is possible to
store individual elements.
To store an element of an array tag, set the Array Index attribute for the tag. By default, the
Array Index attribute is not visible. Refer to Visible Attributes for information on how to set
visible tag attributes.
The Array Index is a zero-based index. For example, if you want to store the first element in the
array, set the Array Index to 0 (Figure 48).
Figure 48 - Configuring Array Elements
Configuring Tag Lifetime and Timestamp Processing Attributes

In some cases, it is necessary to change how MatrikonOPC Desktop Historian handles tags that do
not change frequently (i.e., process set points and similar items). In previous versions of Desktop
80
Historian, those tags would only record a data point when they are changed. However, some
trending and analysis packages cannot properly display that item as a flat line if its value has not
been updated recently. To accommodate those situations, the following tag attributes have been
added to the application: Tag Lifetime Enabled, Lifetime Update Rate, Lifetime Read
Interface, Use System Timestamp, and Timestamp Bias (Figure 49).
Note: Timestamp Bias and Lifetime Read Interface are not visible by default. Refer to Visible
Attributes for more information.
Figure 49 - Lifetime and Timestamp Processing Attributes (with Lifetime Update Rate Field Options Displayed)
Table 27 describes the aforementioned attributes (displayed in Figure 49).

Attribute
Tag Lifetime Enabled
Description
If this checkbox is selected, lifetime processing is enabled. A tag
with lifetime processing enabled will be demand-read from the
OPC server if the lifetime expires without an update from the
data server.
Note: If the tags Update Rate is set to 0 then this setting is
ignored and Lifetime updates will not occur.
The amount of time to wait after the last updated value from the
data server before attempting a demand-read to refresh the tag
value and timestamp.
Clicking on the down arrow displayed on the right side of this
field displays two additional fields:
Lifetime Update Rate - this field allows you to enter a value

defining the update rate. The update rate unit of time (e.g.,
milliseconds, seconds, minutes, etc.) is defined in the Units field.
If this field is left blank or set to 0, MatrikonOPC Desktop
Historian will never attempt a demand-read to refresh the item.
Units - If available, from the drop-down list, select an update
rate unit of time (e.g., milliseconds, seconds, minutes, etc.).
The minimum acceptable value is 100 ms. The maximum
acceptable value is 42 days.
This is an advanced option, hidden by default. The attribute

selects which type of interface to use when requesting a demand
read to refresh an item with the Tag Lifetime Enabled checkbox
selected. The default method is to use ASYNC communications to
refresh the item. If SYNC is selected in this field, the item will
read using synchronous calls to the data server to read the item.
81
Attribute
Description
Note: MatrikonOPC does not recommend changing this option
unless it is necessary to address known issues and the data
server providing the data.
If it is necessary to match the timestamp between lifetime and

non-lifetime-enabled tags, or when the server providing the data
is unable to provide a reliable or consistent timestamp, then this
checkbox may be selected. Selecting the checkbox causes all
values recorded for the item to use the system time of the
computer running MatrikonOPC Desktop Historian instead of the
timestamp provided by the data server.
For more details, refer to the Troubleshooting section.
Timestamp Bias
This attribute accepts a number of milliseconds to add to the

timestamp for the item (which may be positive or negative)
before recording it to MatrikonOPC Desktop Historians database.
If the Tag Lifetime Enabled or Use System Timestamp
checkboxes are selected, the timestamp will be recorded as the
local system time plus the Timestamp Bias. For all other items,
the recorded timestamp will be the timestamp provided by the
OPC server plus the Timestamp Bias. This can be used to
synchronize distant sources, or adjust for time zone configuration
issues.
Table 27 - Timestamp and Lifetime Processing Attributes Descriptions
Notes:
As per all other attributes, changes to those items listed in
Table 27 will take effect only once the Commit button is
selected.
If the configured tag does not have an external source
configured, then configuring Lifetime Processing will have no
effect.
Refreshing the Tag List

Refreshing the tag list is useful if tags are changed through the Tag Workspace.
To refresh the tag list:
1. Right-click your mouse in the Tag Workspace.
2. From the displayed menu, select the Refresh Tag List option.
Or,
Select the Refresh Tag List button on the Tag Management toolbar.
82
Figure 50 - Refresh Tag List
3. A message appears asking you to confirm the action.

4. Click on the Yes button.
5. The Tag Workspace is refreshed.
83
Customizing the Display

Tag Browser Docking
You can auto-hide the Tag Browser window by clicking on the push pin icon found in the righthand corner of the Tag Browser title bar (as shown in Figure 51). The Tag Browser window
hides itself toward the left edge of the panel. Once hidden, clicking on the vertical Tag Browser
button that appears on the left side of the window will once again, display the Tag Browser
window.
To disable the auto-hide feature, float your mouse over or click on the vertical Tag Browser
button that appears on the left side of the window to display the Tag Browser window. The push
pin icon is displayed horizontally. Click on the push pin icon to disable the auto-hide feature. The
icon is then displayed vertically and the Tag Browser window remains unhidden.
Figure 51 - Tag Browser Title Bar
Figure 52 - Auto-Hide Tag Browser Window
You also have the option of floating the Tag Browser window by clicking on the Tag Browser
screen section title bar, and dragging it anywhere on the screen (Figure 53). To return the Tag
Browser to its locked-in position, double-click your mouse on the Tag Browser title bar.
84
Figure 53 - Floating Tag Browser Window
Visible Attributes
Note: For a detailed list of all attributes, refer to Appendix I Attributes.
When the Tag Workspace is initially displayed, only the attributes for an OPC tag are displayed.
There are two methods by which to display select attributes.
1. First Approach:
a. Right-click your mouse anywhere in the Tag Workspace.
b. From the displayed menu, select the Set Visible Attributes (Shortcut) menu
option (Figure 54).
c. A sub-menu is displayed listing the available attributes. The currently visible
attributes are checked.
d. Click on an attribute to make it visible (checked) or invisible (not checked).
85
Figure 54 - Set Visible Attributes (First Approach)
2. Second Approach:
The Preferences window can also be used to select which attributes are visible in the Tag
Workspace. This window provides detailed information (Name, Data Type, and Description) for
each attribute and allows you to perform multiple changes at once.
a. Right-click your mouse anywhere in the Tag Workspace.
b. From the displayed menu, select the Set Visible Attributes menu option.
c. The Preferences window (Figure 55) is displayed.
d. Click on an attribute to make it visible (checked) or invisible (not checked).
e. Click on the Apply button to accept the attribute selection, and to close the
Preferences window to return to the Tag Workspace.
86
Figure 55 - Set Visible Attributes (Second Approach)
Colour Legend
The Legend window illustrates the different colours used for different information, including
deleted tags, changed attributes, invalid attributes, etc.
To display the Legend window:
1. Right-click your mouse anywhere in the Tag Workspace.
2. From the displayed menu, select the Legend menu option.
Or,
Click on the Show Legend button on the Tag Management toolbar.
3. The Legend window appears.
Figure 56 - Colour Legend
87
OPC Server Configuration

Desktop Historians OPC server runs properly without any configuration, but you can customize the
servers behavior as required. This section instructs you on how to start and configure the OPC
server settings, log settings and also displays OPC product version information.
Alias Configuration
MatrikonOPC servers, including this one, provide the ability to create user-defined aliases that can
be used in place of regular OPC items. This feature is particularly useful when the item path for a
given server is very complex or difficult to remember, for example: Com1.Radio1.Unit1.41.4.123.
Servers can also be configured so that client applications have access to configured aliases only,
rather than every available item.
This section of the manual describes how to create and edit aliases using the Configuration
window.
Note: It is not necessary to define aliases before accessing server data items from an OPC client.
Inserting Alias Groups

Notes:
Creating an Alias Group is optional. You can create an Alias without grouping it.
Alias Groups are used to contain one or more configured Aliases.
To add a new Alias Group:

1. From the Configuration window, in the navigation pane, select and expand the following
nodes:
Desktop -> Localhost -> OPC Desktop Historian -> Options -> OPC Server
2. Select the Alias Configuration item displayed under the OPC Server node, and either:
Select the New Group option from the Edit menu.

Or,
Select the New Group button from the Toolbar.

Or,
Right-click your mouse on the Alias Configuration item in the navigation pane, and
select New Group from the displayed menu.
3. The New Alias Group window (Figure 57) appears.
Figure 57 - New Alias Group Window
88
4. Enter a name for the new Alias Group.

5. Click on the OK button.
6. The new Alias Group appears in the list displayed on the Alias Configuration page in the
settings pane, as well as under the Alias Configuration node in the navigation pane.
Figure 58 - Alias Configuration Page
Adding New Aliases

To add a new Alias:
1. In the navigation pane, select a previously-created Alias Group, and either:
Select the New Alias option from the Edit menu.

Or,
Select the
Or,
button from the Toolbar.
Right-click your mouse on the selected Alias Group in the navigation pane, and select
New Alias from the displayed menu.
2. The Alias Configuration Wizard (Figure 59) appears. The wizard provides the necessary
guidance to create your own Alias.
89
Figure 59 - Alias Configuration Wizard - Step 1: Alias Type
Table 28 describes the Alias Type configuration components.

Component
Description
Basic
This Alias type is used to rename an item in this server. Basic Aliases also
provide basic scaling options. Refer to Basic Alias Configuration for more
information.
Calculation
Use this Alias type to define an Alias that is the result of a mathematical
equation involving one or more data items in the server. Refer to
Calculation Alias Configuration for more information.
Holding
Use this Alias type to create a brand new data item not associated with any
item in the server. This type of item is useful for temporary items and
testing. Refer to Holding Alias Configuration for more information.
Table 28 - Alias Configuration Wizard - Alias Type Components
Basic Alias Configuration

Figure 60 shows the Alias Identity configuration step when the Basic Alias configuration option
has been selected in Step 1 of the Alias Configuration Wizard (Figure 59).
90
Figure 60 - Alias Configuration Wizard - Step 2: Alias Identity
Table 29 describes the Alias Identity configuration components.

Component
Description
Alias Group
Displays the path where the new Alias item will reside once created.
This field is read-only.
Alias Name
Allows you to enter a name for the Alias you are creating. This name
must be unique within the Alias Group.
OPC Tag
Allows you to enter or select a fully-qualified item ID for the OPC

item to which the Alias refers. Click on the Browse OPC Tag button
to display the Browse OPC Tag window which can be used to select
an existing OPC item on the server.
Alternatively, leave the item path blank to use the Alias as a general
in-memory variable. When doing so, either define the data type for
the Alias point as something other than Default, or have the Alias
set for reading and define the data type while writing values to the
Alias from an OPC client.
Table 29 - Alias Configuration Wizard - Step 2: Alias Identity Components
Figure 61 shows the Browse OPC Tag window which allows you to browse for tags on existing
OPC servers.
91
Figure 61 - Browse OPC Tag Window
Table 30 describes the Browse OPC Tag window components.

Component
Description
Browser
Allows you to browse the OPC servers available on your system.
Available Tags
Displays the tags available in the selected OPC server.
Refresh
Click on this button to refresh your browser.
Filter
Allows you to filter available tags using a string pattern. For example
*a will display all tags starting with the letter a. Enter a string pattern
in the field to the left of the Filter button. Select the Filter button,
and all applicable tags are listed in the Available Tags screen
section.
OK
Click on this button to confirm the tag you have selected, and to close
the Browse OPC Tag window.
Cancel
Click on this button to cancel your selection and return to the previous
window.
Table 30 - Browse OPC Tag Window Components
Figure 62 shows the Alias Properties configuration step when the Basic Alias configuration option
has been selected.
92
Figure 62 - Alias Configuration Wizard - Step 3: Alias Properties
Table 31 describes the Alias Properties configuration components.

Component
Description
Data Type
From the drop-down list, allows you to set the value of the OPC item
to the specified type unless Default is selected. Also serves as the
canonical data type for the Alias.
Read-Only
When this checkbox is selected, OPC clients are prevented from

writing values to the Alias.
Force alias to be updated

even when no OPC clients
are subscribed to it
If this checkbox is selected, the Alias value continues to be updated

at the specified update rate even if there are no OPC clients
currently accessing the Alias.
Forced Update Rate
This field is available only if the Force alias to be updated even

when no OPC clients are subscribed to it checkbox is selected. If
this field is available, you can enter or select a value indicating the
rate (in milliseconds) at which the update rate applies to the current
Alias when no OPC clients are connected to it.
Table 31 - Alias Configuration Wizard - Step 3: Alias Properties Components
Figure 63 shows the Scaling Algorithm configuration step when the Basic Alias configuration
option has been selected.
93
Figure 63 - Alias Configuration Wizard - Step 4: Scaling Algorithms
Table 32 describes the Scaling Algorithms configuration component.

Component
Scaling
Description
Allows you to select, from the drop-down list, the required scaling
option for the Alias.
Table 32 - Alias Configuration Wizard - Step 4: Scaling Algorithms Component
Figure 64 shows the Linear Scaling configuration step when the Basic Alias configuration option
has been selected.
94
Figure 64 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Linear Scaling)
Table 33 describes the Linear Scaling configuration components.

Component
Description
Raw High
Maximum expected raw value of the OPC item.
Raw Low
Minimum expected raw value of the OPC item.
Scaled High
Maximum desired scaled value for the Alias (corresponds to Raw

High).
Scaled Low
Minimum desired scaled value for the Alias (corresponds to Raw

Low).
Clamp High
Clamp the scaled value at the high limit to prevent it from going out
of range.
Clamp Low
Clamp the scaled value at the low limit to prevent it from going out
of range.
Table 33 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Linear Scaling)
Figure 65 shows the Square Root Scaling configuration step when the Basic Alias configuration
95
Figure 65 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Square Root Scaling)
Table 34 describes the Square Root Scaling components.

Component
Description
Raw High
Maximum expected raw value of the OPC item.
Raw Low
Minimum expected raw value of the OPC item.
Scaled High
Maximum desired scaled value for the Alias (corresponds to Raw

High).
Scaled Low
Minimum desired scaled value for the Alias (corresponds to Raw

Low).
Clamp High
Clamp the scaled value at the high limit to prevent it from going out
of range.
Clamp Low
Clamp the scaled value at the low limit to prevent it from going out
of range.
Table 34 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Square Root Scaling) Components
Figure 66 shows the Gain/Offset configuration step when the Basic Alias configuration option has
been selected.
96
Figure 66 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Gain/Offset Scaling)
Table 35 describes the Gain/Offset Scaling configuration components.

Component
Description
Gain
Scaling factor. (No limits are assumed.)
Offset
Scaling offset.
Table 35 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Gain/Offset Scaling) Components
Figure 67 shows the Expression Scaling configuration step when the Basic Alias configuration
97
Figure 67 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Expression Scaling)
Table 36 describes the Expression Scaling configuration components.

Component
Description
Input
Simple text equation to apply to incoming values (reads). Click on the Editor button
to display the Expression Wizard screen used to help build a formula. For more
information, refer to the Expression Wizard section in this manual.
Output
Simple text equation to apply to outgoing values (writes). Click on the Editor button
to display the Expression Wizard screen used to help build a formula. For more
information, refer to the Expression Wizard section in this manual.
Table 36 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Expression Scaling) Components
Figure 68 shows the Expression Wizard that is used to configure the input and output
expressions.
Notes:
The Expression Wizard appears and functions the same for an input expression as it does
for an output expression. The differences being the expression field label: Input
Expression, Output Expression, and that one is for reads and the other for writes.
If you are expecting to read a particular alias, create an Input Expression. If you are
expecting to write to a particular alias, create an Output Expression.
Please refer to the Expression Wizard section in this Users Manual for examples.
98
Figure 68 - Expression Wizard
Table 37 describes the Expression Wizard components.

Component
Description
Input/Output
Expression
Displays the expression as it is created. This field is free-form which allows you to
manually enter or edit information. This field reads Input Expression when
creating an input or read expression. It reads Output Expression when
creating an output or write expression.
Function
Select this button to display the Select Function window which allows you to
select the necessary function from those available.
Variable
Select this button to display the Select Variable window which allows you to
select the necessary variable from those available.
Operators
Select the applicable button to add the corresponding operator or operators to the
expression.
Clear
Select this button to clear the Input/Output Expression field.
OK
Select this button to accept changes to (or the creation of) the expression.
Cancel
Select this button to discard changes to (or abandon the creation of) the
expression.
Table 37 - Expression Wizard Components
Figure 69 shows the Select Function options of the Expression Wizard.
99
Figure 69 - Select Function Window
Table 38 describes the components of Select Function window

Component
Description
Category
Displays the available categories for selection. Allows you to select the
required category.
Available Functions
Displays the available functions associated with the selected category.

Allows you to select the required function.
Continue
Select this button to accept the selections made and return to the
initial Expression Wizard window.
Cancel
Select this button to disregard the selections made and return to the
Table 38 - Select Function Window Components
Figure 70 shows the Select Variable window of the Expression Wizard.
Figure 70 - Select Variable Window

100
Table 39 describes the Select Variable window components.

Component
Description
Select variable
Displays the available variables for selection. Allows you to select the
required variable.
OK
Select this button to accept the selection made and return to the
Cancel
Select this button to disregard the selection made and return to the
Table 39 - Select Variable Window Components
Calculation Alias Configuration

Figure 71 shows the Alias Identity configuration step when the Calculation Alias configuration
option has been selected in Step 1 of the Alias Configuration Wizard (Figure 59).
Table 40 describes the components of Alias Identity step when the Calculation Alias
configuration option has been selected.
Component
Description
Alias Group
Displays the path where the new Alias item will reside once created. This field
is read-only.
Alias Name
Allows you to enter a name for the Alias you are creating. This name must be
unique within the Alias Group.
101
Figure 72 shows the Alias Properties configuration step when the Calculation Alias configuration
Table 41 describes the Alias Properties configuration components.

Component
Description
Data Type
Force alias to be updated

even when no OPC clients
are subscribed to it
If this checkbox is selected, the Alias value continues to be updated

at the specified update rate even if there are no OPC clients
currently accessing the Alias.
Forced Update Rate
This field is available only if the Force alias to be updated even

when no OPC clients are subscribed to it checkbox is selected. If
this field is available, you can enter or select a value indicating the
rate (in milliseconds) at which the update rate applies to the current
Alias when no OPC clients are connected to it.
Figure 73 shows the Alias Calculation configuration step when the Calculation Alias
102
Figure 73 - Alias Configuration Wizard - Step 4: Alias Calculation
Table 42 describes the Alias Calculation configuration components.

Component
Description
Alias Calculation
Allows you to enter a calculation equation.
Insert OPC Tag
Select this button to display the Insert OPC Tag window (i.e., Tag
Browser Figure 61) allowing you to insert OPC tags as part of the
calculation formula.
Insert Function
This field lists a wide selection of mathematical functions that can be

used as part of your Alias calculation configuration. Double-click your
mouse on the required function and it appears in the calculation
equation displayed in the Alias Calculation screen section.
Table 42 - Alias Configuration Wizard - Step 4: Alias Calculation Components
Figure 74 shows the Alias Events configuration step when the Calculation Alias configuration has
been selected.
103
Figure 74 - Alias Configuration Wizard - Alias Events
Table 43 describes the Alias Events configuration components.

Component
Description
Enable events for this Alias
When this checkbox is selected, Alias events are enabled for this
Alias item.
Source
Allows you to enter the name of the source of the event.
Severity
Allows you to enter or select a value defining the severity of the

alarm. The allowable range is 1 through 1000.
Category
Allows you to select, from the drop-down list, the event category
under which the event is to be registered.
Manage Categories
The Manage Categories button launches the Manage Events

Categories window (Figure 75) where you can create new
categories, as well as edit or delete existing categories.
Trigger Condition
Allows you to select, from the drop-down list, how the Alias event is
to be triggered: Value Change, Positive Edge.
Timestamp Source
Allows you to select, from the drop-down list, whether the

timestamp for the Alias event is retrieved from the Server or the
Device (if it is different).
Message
Allows you to enter a message that is to appear in the posted event.

This message can contain references to data items in the server.
These references are replaced with the values of those items at the
time the event was generated.
104
Component
Insert OPC Tag
Description
Select this button to display the Browse OPC Tag window (Figure
61) which is used to add item paths to this field.
Table 43 - Alias Configuration Wizard - Alias Events Components
Figure 75 displays the Manage Event Categories window.
Figure 75 - Manage Events Categories Window
Table 44 describes the Manage Event Categories window components.

Component
New
Description
Select this button to access the New Event Category window (Figure 76) and
create a new category.
Select this button to edit the currently selected category.
Edit
Note: This button is available only if at least one event category has been created
and selected.
Select this button to delete the selected category.
Delete
Close
Note: This button is available only if at least one event category has been created
and selected.
Select this button to close the Manage Event Categories window and return to
Step 5 of the Alias Configuration Wizard.
Table 44 - Manage Event Categories Window Components
Figure 76 displays the New Event Category window.
105
Figure 76 - New Event Category Window
Table 45 describes the New Event Category window components.

Component
Description
Category ID
This is an automatically-assigned field that identifies the newlycreated category.
Name
The name of the newly-created category.
Description
A description of the newly-created category.

Table 45 - New Event Category Window Components
Holding Alias Configuration

Figure 77 displays the Alias Identity configuration step when the Holding Alias configuration
106
Table 46 describes the components of Step 2: Alias Identity when the Holding Alias
Component
Description
Alias Group
Displays the path where the new Alias item will reside once created.
This field is read-only.
Alias Name
Allows you to enter a name for the Alias you are creating. This name
must be unique within the Alias Group.
Figure 78 shows the Alias Properties configuration when the Holding Alias configuration option
has been selected.
107
Table 47 describes the components of Step 3: Alias Properties.

Component
Description
Data Type
Read-only
When this checkbox is selected, OPC clients are prevented from

writing values to the Alias.
Default Value
The default value of the holding Alias item created.

Editing Aliases
To edit an Alias:
1. From the Alias Configuration panel, select the Alias item you wish to edit.
2. Click on the
Or,
button.
Select Edit from the Edit menu.

Or,
Right-click your mouse on the Alias item you wish to edit, and select Edit from the
displayed menu.
108
3. The Alias Configuration Wizard appears.

4. Make the changes as required.
5. Click on the Finish button to confirm your edit details.
Removing Aliases
Note: Any Alias that was created can be removed.
To remove an Alias:
1. From the Alias Configuration panel, select one or more Aliases you wish to remove.
2. Click on the
Or,
button.
Select Delete from the Edit menu.

Or,
Right-click your mouse on the highlighted Alias item or items you wish to remove, and
select Edit from the displayed menu.
3. A message appears asking you to confirm the deletion.
4. Select the Yes button.
5. The Alias is removed.
Removing Alias Groups

Notes:
Any Alias Group that was created can be removed.
Deleting an Alias Group removes that group and all of its contents (i.e., Aliases).
To remove an Alias Group:

1. In the navigation pane, select and expand the Alias Configuration node.
2. All associated Alias Groups are listed in the Alias Configuration panel.
3. Select the Alias Group or Groups you wish to remove.
4. Click on the
Or,
button.
Select Delete from the Edit menu.

Or,
Right-click your mouse on the highlighted Alias Group or Groups you wish to remove, and
select Edit from the displayed menu.
5. A message is displayed asking you to confirm the action.
6. Click on the Yes button.
7. The Alias Group is removed.
109
Cloning Aliases
To clone an Alias:
1. From the Alias Configuration panel, select the Alias that you wish to clone.
2. Click on the
button.
Or,
Select Clone from the Edit menu.
Or,
Right-click your mouse on the Alias you wish to clone, and select Clone from the displayed
menu.
3. The Alias Configuration Wizard appears.
4. By default, the Alias Name will be the name of the selected Alias item with a number
appended in parentheses. For example, Alias_003 (1).
5. Configure the cloned Alias, as required.
6. Click on the Finish button when you have completed the configuration.
Exporting Aliases
Note: Use the Export Alias File window to export all currently configured Aliases to a CSV file.
To export all currently configured Aliases:
1. From the navigation pane, select the Alias Configuration node.
2. Click on the
Or,
button.
From the File menu, select the Export To CSV menu option.
Or,
Right-click your mouse and select the Export To CSV option from the displayed menu.
3. The Export Alias File window appears.
4. Enter a file name for the CSV export file and specify a location for it.
5. Click Save.
6. The Aliases are exported.
Importing Aliases
Note: Use the Import Alias File window to clear all Aliases and import new ones from a CSV file.
To import Aliases from a CSV file:
1. From the navigation pane, select the Alias Configuration node, and either:
Click on the
Or,
button.
110
From the File menu, select the Import To CSV menu option.
Or,
Right-click your mouse and select the Import To CSV option from the displayed menu.
2. The Import Alias File window appears.
3. Browse to the required CSV file name.
4. Click Open.
5. The previous Aliases are cleared and the new ones are imported.
Expression Wizard
The Expression form of scaling uses an Expression Wizard to build formulas. The created
formula is a simple text equation that is applied to either incoming values (i.e., reads), or outgoing
values (i.e., writes).
Examples
Example 1:
The following turns any number into a Boolean value. Any non-zero value shows up as a 1.
IF(INPUT = 0,0,1)
OUTPUT
Example 2:
The following takes the text out of SAMPLE and converts it to ON. All other values show as OFF. If
OUTPUT is specified in the Output field, then the value is transferred to the end OPC item. Using
this alias, you can write SAMPLE or any other value to the Alias to get the display to changed from
OFF to ON.
String comparisons are case-sensitive.
IF(INPUT = SAMPLE,ON,OFF)
OUTPUT
Table 48 describes the Expression Wizard fields.
Component
Description
Input/Output Expression
Displays the expression as it is created. This field is free-form which

allows you to manually enter or edit information. This field reads Input
Expression when creating an input or read expression. It reads
Output Expression when creating an output or write expression.
Function
Select this button to display the Select Function window which allows
you to select the necessary function from those available.
Variable
Select this button to display the Select variable window which allows
you to select the necessary variable from those available.
Operators
Select the applicable button to add the corresponding operator or

operators to the expression.
Clear
Select this button to clear the Input/Output Expression field.
OK
Select this button to accept changes to (or the creation of) the
111
Component
Description
expression.
Select this button to discard changes to (or abandon the creation of) the
expression.
Cancel
Table 48 - Expression Wizard Options
Notes:
The Expression Wizard appears and functions the same for an input expression as it does
for an output expression. The differences being the expression field label: Input
Expression, Output Expression, and that one is for reads and the other for writes.
If you are expecting to read a particular Alias, create an Input Expression. If you are
expecting to write to a particular Alias, create an Output Expression.
To create an Input or Output Expression:

1. When the Expression Wizard (Figure 68) is displayed, manually enter your new
expression in the Input Expression field and proceed to step 7.
Or,
Perform steps 3 through 7 using a combination of the Function, Variable, and Operators
buttons to create your expression, which will be displayed in the Input/Output
Expression field as you build it.
2. Click on the Function button to go to the Select Function (Figure 69) window. After
selecting the required function, click on the Continue button to bring up the Function
Parameter (Figure 79) window.
Figure 79 - Function Parameter Window
3. Complete the parameters as required.

5. Click on the Variable button to go to the Select variable (Figure 70) window. After
selecting the required variable, click on the OK button to close the Select variable window
and return to the Expression Wizard.
112
6. The Operators buttons (Figure 80) allow you to enter an operation descriptor based on the
selected button.
Figure 80 - Operators Buttons
7. Click on the OK button on the Expression Wizard screen to close the wizard and display
the expression in either the Input or Output field, depending on which expression you
defined.
Logging Options
The Logging Options page allows you to customize the way error and debug information is
recorded by the server.
Note: Logging Options settings are saved once the Apply button is
selected. However, they do not take effect until the back-end server is
re-started.
To view logging options:
nodes:
2. Click on the Logging Options item displayed under the OPC Server node. Figure 81
displays the navigation pane and Logging Options page.
Figure 81 - Logging Options Page
113
Table 49 describes the components of the Logging Options page.

Command
Enable server activity
logging
Description
Selecting this checkbox enables general activity logging. If this
checkbox is not selected (i.e., the checkbox is cleared), none of the
fields on the Logging Options page are available.
Activity Log Settings

If this field is enabled, allows you to select from the drop-down list,
the amount of detail to provide in the log file:
None
Log Level

Default = Low.
Filename
If this field is enabled, allows you to enter a full path for the activity
log file. The default path is: C:\Program Files\Common
Files\MatrikonOPC\Common\
PSTCFGMatrikon.OPC.DesktopHistorian.1.log.
Browse
locate and select the necessary log file. The selected file is dislayed
Overwrite old log

information
If enabled, selecting this checkbox ensures that the old log file is
overwritten each time the server starts up. Otherwise, the old log file
is renamed with an underscore (_) prefix.
By default, this checkbox is cleared.
Wrap log file if it exceeds
If enabled, selecting this checkbox ensures that the file buffer is

flushed after each message logged, in case the server is crashing.
This checkbox is available only if the:
Wrap log file if it exceeds checkbox is cleared, and
Enable server activity logging checkbox is selected
By default, this checkbox is neither enabled or selected.
If enabled, selecting this checkbox specifies that the log file is
wrapped when it exceeds the defined value (in MB).
If this checkbox is selected, the Commit all log file writes
checkbox is unavailable.
114
Command
Description
Filtered Log Settings
Filter String
If this field is enabled, allows you to enter a match string for filtered
log.
If this field is enabled, allows you to enter a full path for the filtered
log file.
Filename

Browse
locate and select the required filtered log file. The selected file is
dislayed in the Filename field.
Apply

Options page.
Cancel

Options page.
Table 49 Logging Options Page Components
Version
This page is display only and shows OPC server version information.
To view OPC server version information:
nodes:
2. Click on the Version item displayed under the OPC Server node. Figure 82 displays the
Version page.
115
Figure 82 - OPC Server Version Information Page
Server Options
Note: Server Options settings take effect only once the Apply
button is selected.
To view server settings:

nodes:
Desktop -> Localhost -> OPC Desktop Historian -> Options -> OPC Server ->
Server Options
2. Click on the Configure item displayed under the Server Options node. Figure 83 displays
the navigation pane and Server Options page.
116
Figure 83 - Server Options Page
Table 50 describes the components of the Server Options page.

Command
Description
Allows you to set a maximum number of values that can be returned
from an HDA ReadRaw request. If an HDA client makes a request
which exceeds this value, then no data is returned and the client
receives an error code indicating that they exceeded the servers
limit. Setting this value to 0 means that no limit is enforced on the
number of items returned.
Default value = 0.
Maximum Return Values
Apply Maximum Return

Values to Processed Reads
Notes:
This limit is not enforced for Browsing operations.
This limit is only enforced for the number of data points

returned to the OPC HDA Client making the read request. The
number of data points retrieved in internal Read Raw
operations (performed to gather the data needed to make
aggregate calculations) is not limited. Therefore, load issues
can still occur when a Maximum Return Values limit is in
place.
Applies the Maximum Return Values limit to the HDA

ReadProcessed requests. The limit is applied to the underlying
ReadRaw request that gathers the data necessary to calculate the
aggregate. If this limit is reached, the aggregate data returned will
not cover the entire requested time range.
117
Command
Description
When an aggregate calculation is performed the server performs a
ReadRaw operation internally to gather the data needed to perform
the calculation. This option modifies the time span of this ReadRaw
call. If this option is 0, then the ReadRaw call uses the start and end
times from the ReadProcessed call. If this option is non-zero then the
time extends the start and end times of the ReadRaw call by the
number of intervals configured.
An interval is defined as the interval requested in the ReadProcessed
call. See the example below for further explanation.
Default value = 0.
Aggregate Overread
Note: The maximum ReadRaw timespan is three times the original

ReadProcessed timespan, regardless of the number of intervals
configured in this field.
Apply
Use this button to commit any changes made on the Server

Options page.
Cancel
Use this button to discard any changes made on the Server Options
page.
Table 50 - Server Options Page Components
Aggregate Overread Example:

An OPC HDA client requests an aggregate:
Start Time: 9:00:00.000 AM
End Time: 10:00:00.000 AM
Interval: 5 minutes
Aggregate Overread is set to 0:
The OPC server will conduct a ReadRaw:
Start Time: 9:00:00.000 AM
End Time: 10:00:00.000 AM
Aggregate Overread is set to 2:
The OPC server will conduct a ReadRaw:
StartTime: 8:50:00.000 AM
End Time: 10:10:00.000 AM
118
OPC Client Configuration

You can customize Desktop Historians OPC Client behavior by changing the clients settings
through the configuration panels. This section shows how to configure the OPC client and client
logging settings, and also displays OPC client version information.
There are two groups of settings that you can customize:
Client Settings (includes connection and data buffer settings)
Logging Settings
Client Settings Tab

Connection Settings and Data Buffer Settings can be configured through the Client Settings
tab of the OPC Client Configuration page.
To view client settings:
nodes:
Desktop -> Localhost -> OPC Desktop Historian -> Options -> OPC Client
2. Click on the Configure item displayed under the OPC Client node. Figure 84 displays the
navigation pane and OPC Client Configuration page with the Client Settings tab
selected.
Figure 84 - Client Settings Tab (OPC Client)
Client Settings tab variables (i.e., fields) and functions are described in Table 51.
119
Command
Description
Delay after connection
Allows you to enter a value (in milliseconds) indicating the time

to wait before adding any items after connecting to the OPC
server.
Delay to retry adding items
Allows you to enter a value (in milliseconds) indicating the time

to wait before retrying to add the failed items.
Maximum retries during startup
Allows you to enter a value defining the maximum number of

retries to add items during start up.
Table 51 - Client Settings (Connection Settings) Tab Components
The Data Buffer Settings manage how the OPC client will buffer the received data before sending
it to the core. The OPC client will first store data (buffer) in the memory. When the amount of
buffered data in memory exceeds certain limits, the OPC client will start buffering data in files. All
of these operations are transparent to the user, but you can customize how much data is to be
buffered in memory and in the data files.
The Data Buffer Settings variables and functions are described in Table 52.
Command
Description
Data buffer directory
Allows you to enter the directory where the data files will be created.
By default, this directory is: C:\Program Files\Matrikon\OPC\Desktop
Historian\OPC Client\Data Buffer\.
Maximum number of data in

cache
Allows you to enter a value to define the maximum number of data to

be buffered in memory. By default, this value is 5,000,000. The OPC
client will make an intelligent judgement as to when to start buffering
data to files, based on the current number of data in cache and this
maximum value.
Maximum number of files
Allows you to enter the maximum number of files to be created. By

default, this value is 20.
Maximum file size
Allows you to enter the maximum file size (in MB) for each file. By
default, this value is 25 MB.
Apply
Use this button to commit any changes made on the Client Settings
tab.
Cancel
Use this button to discard any changes made on the Client Settings
tab.
Table 52 - Client Settings (Data Buffer Settings) Tab Components
Logging Settings Tab

Note: If all of the configured data files have been used, the OPC
Client does not generate any new data files. If both data files and
configured cache are used up, the OPC Client starts to drop data. This
information is logged at a log level of Medium.
The Logging Settings tab (Figure 85) allows you to edit OPC client general logging options. The
log files will be contained in the following location ([ ] indicates the default installation path):
[C:\Program Files\Matrikon]\OPC\Desktop Historian\OPC Client\Log]
120
Figure 85 - Logging Settings (OPC Client)
The Logging Settings tab variables (i.e., fields) and functions are described in Table 53.
Command
Log file directory
Description
Displays the log file directory (read-only).
Allows you to select from the drop-down list, the amount of detail to
provide in the log file:
Log level
None
Default = Low.
Log file size
Allows you to define the maximum size of the log file (in MB). Once
this size is reached, the oldest data in the file is erased at the same
rate that new information is written to the log file. This value will be
ignored if Forced writing is activated.
Indicates how often the log is to be written to. If the checkbox is

selected, statements must be written to the log file as soon as they
are reported. No caching may be used.
Apply

Settings tab.
Cancel

Settings tab.
Table 53 - Logging Settings Tab Components
121
Version
This page is display only and shows OPC client version information.
To view OPC client version information:
nodes:
Desktop -> Localhost -> OPC Desktop Historian -> Options -> OPC Client
2. Click on the Version item displayed under the OPC Client node. Figure 82 displays the
Version page.
Figure 86 - OPC Client Version Information Page
122
FileCollector
FileCollector is an OPC client that transfers historical process data from a Comma Separated Value
(CSV) file to the MatrikonOPC Desktop Historian via OPC HDA. This product will monitor a specified
directory for the new CSV files. If a CSV file is found, this product will read the data and transfer it
to the Desktop Historian. Depending on the configuration, the process file will either be deleted, or
moved to a back-up directory.
For more information about the FileCollector component, refer to the MatrikonOPC FileCollector
Users Manual.
123
ODBC Server
The ODBC Server component allows ODBC clients to read data from Desktop Historian. You may
configure the ODBC server and view the applicable version information.
To access the Matrikon ODBC Server for OPC page:
1. From the main Configuration window, select and expand the following nodes:
Desktop -> Localhost -> ODBC Server
2. Click on the Configure item under the ODBC Server node.

3. The Matrikon ODBC Server for OPC page (Figure 87) is displayed.
The ODBC Server page consists of two tabs:
Databases
General
Databases Tab
The Databases tab is shown in Figure 87 and the components are described in Table 54.
Figure 87 - Databases Tab
Command
Description
Name
Allows you to enter a name for the database.
Description
If required, enter a description of the current database.
HDA Server Host
Allows you to specify the host where the OPC HDA server resides.
HDA Server ProdID
Allows you to specify the OPC HDA server program ID for the database.
124
Command
Description
New
Select this button to clear the Database Configuration settings fields

allowing you to create a new database. For more information, refer to
Configuring a New Database.
Delete
Select this button to remove the selected database from the list on the
left side of the page.
Apply
Select this button to commit any changes made.
Refresh
Select this button to refresh the Databases tab, clearing the fields in
the Database Configuration panel.
Note: Although the fields are cleared, no saved information is lost.
Table 54 - Databases Tab Components
Configuring a New Database

To configure a new ODBC server database:
2. Select the Configure item under the ODBC Server node.

3. The Matrikon ODBC Server for OPC page appears.
4. If not already displayed, select the Databases tab (Figure 87).
5. Click on the New button.
7. Although a name is automatically populated in the Name field, you can overwrite it and
enter a name for the new database.
8. If required, enter a Description, HDA Server Host, and HDA Server ProgID.
Note: You can use the Browse (ellipsis) button adjacent to the HDA Server ProgID field
to browse for and select the necessary OPC HDA server for this database.
9. Click on the Apply button to create the database.
10. The newly created database is now listed (Figure 88) in the pane on the left of the panel.
125
Figure 88 - New Database Created
Removing a Database
To remove/delete an existing database:
2. Select the Configure item under the ODBC Server node.

3. The Matrikon ODBC Server for OPC page appears with the Databases tab already
selected.
4. In the list of databases displayed in the left pane of the tab, either:
Right-click your mouse on the database you want to remove and select Delete from
the displayed menu.
Or,
Select the Delete button on the right side of the page.
5. A message is displayed asking you to confirm the action.

7. The Databases tab is refreshed and the removed database no longer appears listed.
General Tab
The General tab is shown in Figure 89 and the components are described in Table 55.
126
Figure 89 - General Tab
Command
Description
Disconnect Delay
Allows you to specify the amount of time (in seconds) the OPC server
remains running after all clients have disconnected.
Log File Directory
Allows you to enter the directory of the log file, or accept the default
directory.
Log Level
Allows you to specify the amount of detail to be provided in the log file:
None, Low, Medium, or High.
Log Size
Allows you to specify the maximum size of the log file.
Force File Writes
Select this checkbox to force the log to be written.
Apply
Select this button to commit any changes made on this tab.
Refresh
Select this button to refresh the General tab.

Table 55 - General Tab Components
Version
This page is display only and shows ODBC server version information.
To view ODBC server version information:
nodes:
2. Click on the Version item displayed under the ODBC Server node. Figure 90 displays the
Version page.
127
Figure 90 - ODBC Server Version Information Page
128
Tag Manager Excel Plug-In

Tag Manager is used to work with tags in Desktop Historian and runs as an add-in to Microsoft
Excel. Tag Manager can be used to view, add, change, or delete tags, and to turn tag scans on
and off.
Note: Tag Manager works with Excel 2007 versions 12.0.6425.1000
and higher. Microsoft Office Service Packs SP1 and SP2 have to be
installed for Tag Manager to work correctly.
Installing Tag Manager Add-Ins

To install the Tag Manager add-in:
1. The Tag Manager add-in is automatically installed and configured by the Desktop
Historian installation package.
2. When Microsoft Excel is opened, the Excel menu bar should include a Desktop Historian
menu item (outlined in red in Figure 91). If not, you can manually configure the Tag
Manager add-in for use (refer to steps 3 through 7).
Figure 91 - Excel Title Bar
3. From the Excel Tools menu, select the Add-Ins menu option. The Add-Ins window
appears.
4. From the Add-Ins window, click on the Browse button. The Browse window appears.
5. In the Browse window, navigate to [C:\Program Files\Matrikon\OPC\]Desktop
Historian\Utils.
Note: [ ] indicates the default installation path.
6. Click on the TagMgr.xll file.
7. The entry Matrikon Desktop Historian Tag Manager should now appear selected in
the list of add-ins. Click on the OK button to close the dialog box.
Connecting to Tag Manager

When started, Tag Manager will connect to the local Desktop Historian. If this initial connection
cannot be established, a warning message is displayed.
Manually connecting to Desktop Historian should be required only if the Tag Manager has been
disconnected manually, or if the initial connection could not be established.
To connect to Tag Manager:
Note: This procedure will guide you through the steps needed to connect to Tag Manager. You
are instructed to create a new workbook in Excel which will be used to complete other tasks
outlined in this manual.
1. From the Excel Desktop Historian menu, select the Connect menu option.
2. From the Excel File menu, select the New menu option.
3. Create a new workbook. You will use this file to view and manipulate tag information.
129
Loading Attributes
To load tag attributes:
Note: Use the new Excel work book you created in the previous procedure (Connecting to Tag
Manager).
1. From the Excel Desktop Historian menu, select the Load Attributes menu option.
2. The default OPC tag attributes are loaded into the Excel worksheet and the following
columns are displayed: Action, Attr Name, Data Type, and Description.
Adding, Changing, and Deleting Tag Attributes

The Tag Manager supports the standard OPC tag attributes. You can also add tag attributes to the
archive database. Only those tag attributes that you have added can be changed or deleted.
Default OPC attributes cannot be changed or deleted.
To add a tag attribute:
Note: Use the Excel worksheet complete with loaded default OPC tag attributes (Action, Attr
Name, Data Type, Description) from the previous procedure (Loading Attributes).
1. Click on an empty row in the Action column and type ADD.
2. Enter the necessary information in the new row under each of the following columns: Attr
Name, Data Type, Description.
3. Click your mouse anywhere outside of the new row.
4. From the Excel Desktop Historian menu, select the Commit Changes menu option.
5. A message appears stating that all changes were committed successfully.
To change a tag attribute:
CAUTION: You may NOT change any of the default OPC attributes.
Note: Use the existing Excel worksheet complete with loaded default OPC tag attributes and the
new attribute you added above.
1. Click in the Action column for the row you want to change, and type MOD.
2. Change the existing information in the same row under any of the following columns: Attr
Name, Data Type, Description.
3. Click your mouse anywhere outside of the changed row.
130
To delete a tag attribute:

CAUTION: You may NOT delete any of the default OPC attributes.
Note: Use the existing Excel worksheet complete with loaded default OPC tag attributes and the
new attribute you added and then changed, previously.
1. Click in the Action column for the row you want to delete, and type DEL.
2. Click your mouse anywhere outside of the row.
Renaming an Attribute
To rename a tag attribute:
1. Using the Excel worksheet, in the Attr Name column, select the name you want to change.
2. In the Action column, type MOD next to the name to be changed.
3. In the Excel formula bar, type REN before the existing name, place quotation marks
around the existing name, add a space and type in the new name surrounded by quotation
marks. For example, REN Existing Name New Name.
4. Click your mouse anywhere outside of the row.
8. From the Excel Desktop Historian menu, select the Load Tags menu option.
9. The Load Tags window appears listing all selected tags (refer to Figure 92).
131
Figure 92 - Load Tags Window
10. Click on the OK button to add all tags and tag attributes.
11. The worksheet refreshes and the change is displayed.
Loading Tags for Viewing

To load tags for viewing:
1. From the Excel Desktop Historian menu, select the Load Tags menu option.
2. The Load Tags window (see Figure 92) appears.
3. Click on the OK button to add all selected tags and tag attributes.
Note: You can also filter tags by Tag Name, Data Type, or limit the attributes to be
displayed. Refer to Filtering Tags and Limiting Attribute Display.
Filtering Tags
Note: Data Type and Name filters may be combined.
To filter tags by name:
1. On the Load Tags window, in the Name Filter field, enter the tag name (or part of tag
name) that you want to match. Use an asterisk as a wildcard character.
And/or,
132
In the Data Type Filter field, from the drop-down list, select the data type to which you
want to match tags.
3. Those tags that meet the filter specification are loaded into an Excel worksheet.
Limiting Attribute Display

To limit attribute display:
1. On the Load Tags window, in the Name column, clear the checkbox adjacent to the
attribute or attributes you do not want displayed.
Or,
Select the checkbox adjacent to the attribute or attributes you want displayed.
Adding OPC Tags

Adding an OPC tag:
1. From the Desktop Historian menu, select the Add OPC tags menu option.
2. The Add OPC Tags window is displayed (Figure 93).
3. In the Host field, select a host from the drop-down list.
4. In the Server field, select a server from the drop-down list.
5. Click on the
button adjacent to the Server field.
6. Expand the navigation tree in the left pane to display the available tags.
133
Figure 93 - Add OPC Tags Window
7. In the pane on the right side of the window, double-click your mouse on the tag you want to
add. The tag is added to the Excel worksheet.
Note: Tags can also be added by right-clicking your mouse on the tag you want to add and
selecting Add Selected from the menu that appears. This is particularly useful when adding
multiple tags.
Turning Tag Scanning On and Off

To turn tag scanning on or off:
1. From the Excel spreadsheet, in the Archiving column for the tag you want to change, enter
either TRUE (scanning is on) or FALSE (scanning is off).
134
Renaming a Tag
To rename a tag:
1. Using the Excel spreadsheet, load the tags present in Desktop Historian.
2. In the Action column, type MOD next to the name to be changed.
3. In the Tag Name column, type REN before the existing name, place quotation marks
around the existing name, add a space and type in the new name surrounded by quotation
marks. For example, REN Existing Name New Name.
135
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 on the Options window in the main configuration
screen 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 MatrikonOPC Sniffer Download.
In general, the server logs all errors and other information of immediate importance to the user at
the low detail level, all warnings and other information of moderate importance to the user at a
medium detail level, and additional information concerning the normal functioning of the software
at a high detail level. The server also logs further information of concern to support personnel at
the debug log level.
Note: The higher the log level, the slower the performance of the
server. It is recommended that the log level be left at the default,
unless troubleshooting needs to be performed.
136
Limitations
MatrikonOPC Desktop Historian has the following limitations:
1. Microsoft Windows NT is not supported if running MatrikonOPC Desktop Historian on
the Windows NT operating system, users will experience problems while adding, changing,
and removing tags.
2. MatrikonOPC Performance Monitor, File Collector and ODBC server - currently not
supported on Windows 7 and Windows 2008.
3. Array data type is not supported MatrikonOPC Desktop Historian does not support
storing tags of Array data type. However, it is possible to store individual elements. To store
an element of an array tag, please refer to Configuring Array Elements.
4. String data type is not supported in FF4 storage format.
5. Insert/Replace is not supported in FF7R and FF4 storage formats. All data insertions
must be done using the Insert method call.
6. Maximum string length supported in FF7 storage format is 2,033 if the input string
length is longer than 2,033, the string will be truncated before being stored.
7. Storage format FF7 will not store data properly when the DAT file size exceeds 4
gigabytes (232 bytes). In the Data Storage Management window, the Store no more
than xxx minutes of history in each file option must be set to prevent the DAT file from
exceeding this size, and leave at least 10 percent for overhead. For example, with 5,000
tags at a 1 second update rate, this configuration setting should be set to no more than 420
minutes (7 hours) of history in all file.
Total file size = 15 [bytes/value] * 5000[values/second] * 60[seconds/minute] *
420[minutes] * 1.1 [overhead factor of 10%] < 232 [bytes]
Refer to Appendix H File Formats of the Users Manual for specific size requirement of
storage format FF7.
8. FF7R size limits not strictly enforced - the 25MB file size is not strictly enforced. If data
is written to Desktop Historian that is older than the latest data written (i.e., back filling),
then the data files may grow to exceed the target 25 MB. If the .DAT file size is greater than
3.5 GB, or the data point time stamp is too far in the future when compared to the (latest
time stamp + configured offset time), the data is rejected and recorded in a .CSV file for
future use. The .CSV file location is C:\matrikon data\Exempt_FF7R.
9. Pasting large number of rows into tag configuration - the configuration tools Tag
Management screen does not work properly when pasting large number of rows into the
tag configuration.
Workaround: Paste the desired rows in smaller batches, or use the Excel plug-in to
configure large numbers of tags.
10. Scheduled backups with concurrent execution times if multiple backups are
scheduled to run concurrently, it is possible that some of these backups will not execute.
11. Scheduled backups during Desktop Historian upgrade if any backups are scheduled
to take place while an upgrade to a newer version of Desktop Historian is performed, it is
possible that some of these backups will not execute.
12. Maximum Return Values does not avoid all load issues - this limit is not enforced for
browsing operations. It is only enforced for the number of data points returned to the OPC
HDA client making the read request. The number of data points retrieved in internal Read
137
Raw operations (performed to gather the data needed to make aggregate calculations) is
not limited unless the Apply Maximum Return Values to Processed Reads option is
enabled. In that case, the limit applies to the underlying request for raw data necessary to
compute the requested aggregate. Therefore, load issues can still occur when a Maximum
Return Values limit is in place.
13. Restore functionality - a backup can only be restored to the live system if the following
conditions are met:
The tag database file in the backup system must exactly match the tag database in
the live system.
The selected files from the backup source must not contain time ranges that overlap
or replace any files in the live system.
14. Communication failure - if communication failure occurs with a source OPC server,
Desktop Historian records a bad quality point in history. When communication is reestablished, Desktop Historian does not record a good quality point until the point value at
the data source changes.
Workaround: Enabling the lifetime functionality for tags that rarely change prevents
points from appearing bad in history for extended periods.
Refer to the MatrikonOPC Desktop Historian Release Notes for known issues.
138
Troubleshooting
This section is intended to assist you by providing licensing information and MatrikonOPC
Support contact information. Also addressed here are 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

OPC server stops updating client after two hours
Problem:
My OPC client stops receiving item values after two hours.
Solution:
The OPC server is licensed with a hardware or software key, and the demonstration
period for the server has expired.
Cannot configure client access paths or item options

Problem:
A third-party OPC client does not provide a means to configure access paths, making it
difficult to correctly specify the data acquisition options for the items.
Solution:
The server provides a global parameter for configuring an escape character to allow
users to append communication options to the end of an Item ID to accommodate
those clients that do not support access paths.
Perform the following steps:
1. Create a string value named ItemIDEscapeCharacter in the following
location: HKEY_CLASSES_ROOT\CLSID\{20DE4721-17CD-4912-AD78B3702370B733}\Options.
2. To create a new value, select the Options key and then choose New String
Value from the Edit menu.
3. Set the value of ItemIDEscapeCharacter entry a single character such as |
(pipe).
4. To edit the value, select the entry and choose Modify from the Edit menu.
5. Shut down the server and restart it for the change to take effect.
6. Configure the ItemIDEscapeCharacter Item ID in the OPC Client with the
access path appended to the end with the configured escape character (e.g.,
ITEMID|ACCESSPATH).
More than one HASP attached to parallel port, but only first one is recognized
Problem:
There is more than one HASP hardware key from MatrikonOPC attached to the parallel
port, but the software only recognizes the first one.
Solution:
HASP keys from the same vendor cannot be chained together. Contact your Account
Manager to obtain a HASP key containing the combined codes of all installed
139
MatrikonOPC servers.
OPC server does not show up as local program in OPC client application
Problem:
The OPC server does not show up in a list of locally available program IDs in a thirdparty OPC client application.
Solution:
Make certain that a user with local administrative rights installs the OPC server so that
it can create the necessary entries in the registry.
Also, particularly for older OPC clients that do not use the OPC Server Browser, make
certain that the client is running as a user that has Read access to the registry.
In addition, make sure that Microsoft Execution Prevention (DEP) is not on during
installation.
Unable to browse any OPC server from ODH

Problem:
None of the OPC servers shows up in a list of locally available program IDs under ODH.
Solution:
Make sure that a user with local administrative rights installs ODH so that it can
create the necessary entries in the registry.
Ensure OPCEnum is registered as a service, DCOM permissions are configured
properly, and the OPCEnum service is running.
If OPCEnum is not running as a service, perform the following steps:
1. Open Command Prompt with Administrator Rights.
2. Go to Windows directory by below command
cd C:\Windows\System32 -for 32 bit operating systems
Or,
cd C:\Windows\SysWOW64 - for 64 bit Operating Systems.
3. Type command in following order:
OpcEnum.exe /unregserver
OpcEnum.exe /regserver
OpcEnum.exe /service
4. Start the OpcEnum service from Service Manager.
Data is not being updated

Problem:
The OPC server does not report any new data for tags that should be updating.
140
Solution:
Check that the Data Collector (Desktop Historian OPC Client Service) has been started,
and that the Archiving attribute for the tags of interest is set to True, or
There may be a problem with either the tag configuration, or communication to the
OPC server. Both of these conditions will be reported in the OPC client log file. This
may include incorrect parameters (such as invalid Item IDs, or an unknown OPC
Server Program ID), as well as communication failure codes (such as a failure to
connect to a remote OPC server), or
If an OPC server is not active when the OPC client attempts to connect, the OPC server
may not have sufficient time to configure itself for proper use. To avoid this, the OPC
client has the ability to pause during the connection operation at several stages and
retry communication if a full or partial communication failure is encountered. Contact
MatrikonOPC Support for instructions on customizing the connection behavior of the
OPC client.
Unknown error when applying FF4 file format settings

Problem:
An Unknown error message appears when setting the FF4 file format in the Data
Storage Management window.
Solution:
One of the possible reasons for getting this error message is because there is not
enough disk space for the number of files you specified. If you have specified the
history is to be stored in 1,000 25 MB files, make sure you have at least 25G of disk
space free.
ODH does not install on 64-bit Windows 2003 operating system

Problem:
Installation stops and an error message indicating that a Microsoft update is not
present, is displayed.
Solution:
The installation stops as it cannot find the necessary Microsoft hotfixes. Install the
KB973687-64 and msxml6_x64.msi updates from the Microsoft website and then
install ODH again.
Questions and Answers

Using Pi OPC client
Problem:
How is the Pi OPC client to be used with MatrikonOPC servers, if applicable?
Solution:
When using the Pi OPC client with MatrikonOPC servers, please go into the OPC server
Advanced Options setting and select the Enable Mass Tag Adding checkbox. This
causes Pi to validate and add all tags in one group at a time rather than one tag at a
time, resulting in significant improvements in time and network bandwidth used when
initializing. Although this is highly recommended with any MatrikonOPC server, the
difference is most noticeable when using products such as MatrikonOPC SCADA servers
and Tunneller where each OPC operation has a high latency.
Implementing ReadProcessed INTERP Aggregate function in MatrikonOPC Server for

Desktop Historian
141
Question:
How is the OPC HDA ReadProcessed INTERP Aggregate function implemented in the
MatrikonOPC Server for Desktop Historian?
Answer:
This varies depending on whether the stepped attribute for a particular item is set to
True or False within Desktop Historian. In the case where the stepped attribute for
an item is set to True, stepped interpolation is used between data points. In the case
where the stepped attribute for an item is set to False, linear interpolation is used
between data points. In both cases, stepped extrapolation is used at end boundary
conditions.
Adding a large number of tags to Desktop Historian

Question:
How can I add a large number of tags to Desktop Historian?
Answer:
MatrikonOPC Desktop Historian includes a Tag Manager that allows you to add, change
or delete tags in Excel. Refer to the Tag Manager Excel Plug-In section in this
manual for more information.
Lifetime Enabled tags do not receive new timestamps at every lifetime interval
Question:
How can I configure lifetime tags to properly apply updated timestamps?
Answer:
Tags that are configured to use the Lifetime feature must have the Use System
Timestamp option configured properly for the system that is being read from.
If Use System Timestamp is disabled then MatrikonOPC Desktop Historian will
always use the timestamp that is provided by the OPC Server that is providing the
data. This behavior is desirable if the data source updates its timestamps frequently
but does not send new data to MatrikonOPC Desktop Historian unless the value
changes.
If Use System Timestamp is enabled then MatrikonOPC Desktop Historian will use
the current time from the computer on which it is installed to timestamp all data
points that are read for the configured tag. This is the desired setting when using
Lifetime configuration on tags that do not get updated timestamps on the OPC server.
Search the MatrikonOPC Support Knowledge Base at www.opcsupport.com to find the answers
to other commonly-asked MatrikonOPC Desktop Historian questions.
Licensing
Most MatrikonOPC products require that some form of licensing criteria be met for it to function
correctly. A license is required to enable the servers functionality.
The MatrikonOPC Desktop Historian supports both software and hardware licensing.
MatrikonOPC Desktop Historian Licensing
142
IMPORTANT TO NOTE:
The following licensing information is described in detail within the
Licensing Procedures document which accompanies the MatrikonOPC
Desktop Historian software and Users Manual:
Hardware and software key licensing information.
Information about the MatrikonOPC Licensing Utility that is

used to license driver software, and the variety of ways in
which licenses can be obtained (e.g., Internet Connection, Web
Page, Email).
Licensing Q&A and Troubleshooting.
ODBC Server Licensing

Note: The following ODBC Server licensing information is described in
detail within the Licensing Procedures document which accompanies
the MatrikonOPC Desktop Historian Users Manual:
Requesting a software license.
Enabling a temporary software authorization.
Installing a permanent software license.
Generating a new AuthorizeRequest.MTK file.
De-licensing software.
Licensing Q&A and Troubleshooting.
Licensing OPC Trender

OPC Trender is automatically installed with MatrikonOPC Desktop Historian and requires software
licensing. You need to send an AuthorizeRequest.MTK file for this component to be licensed.
Licensing ODBC Server for OPC, Matrikon Analytics Excel Reporter, and
Performance Monitor
A 30-day demo license for MatrikonOPC ODBC Server for OPC is included in the MatrikonOPC
Desktop Historian installation.
Note: The demo license is a time-limited license. The product is fully functioning until the demo
period has expired, after which it will cease to function. A permanent MatrikonOPC ODBC Server for
OPC license is not included with MatrikonOPC Desktop Historian and must be purchased
separately. Contact your Account Manager for assistance and more information.
During the installation of MatrikonOPC Desktop Historian, you are given the option of installing a
demonstration version of MatrikonOPC Performance Monitor, and/or Matrikon Analytics Excel
Reporter, and/or MatrikonOPC Trender. If a permanent license is required, contact your Account
Manager for more information.
Feature Licenses
Featured Component
Default License
State
30-Day Demo
MatrikonOPC ODBC Server for OPC
30-Day Demo
Security
30-Day Demo
143
MatrikonOPC Performance Monitor (optional)
30-Day Demo
Matrikon Analytics Excel Reporter (optional)
30-Day Demo
MatrikonOPC Trender
30-Day Demo
Table 56 - Feature Licenses
Note: MatrikonOPC Desktop Historian, Security, Performance Monitor, Excel Reporter, and Trender
need to be licensed separately, and by default, are delivered with only a 30-day demo. To purchase
a full license for any or all components, please contact your MatrikonOPC Account Manager.
Contacting Support
The MatrikonOPC Customer Services department (www.opcsupport.com) is available 24 hours a
day, seven days a week.
Contact MatrikonOPC Support using the information below, or send an email
(support@MatrikonOPC.com).
For Monday to Friday daytime support requests, contact MatrikonOPC Support using the regional
phone numbers provided in Table 57.
Region
Office Hours
North America
8:00 am-5:00 pm
UTC/GMT -7 hours (MST)

Europe /Africa *
9:00 am-5:00 pm
UTC/GMT +1 hours (CET)

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

Table 57 - MatrikonOPC Support Regional Contact Information
For after-hours support in all regions, please use the following number. There is no extra charge
from MatrikonOPC for calling their after-hours support number.
Region
All
Contact Information
+1-780-231-9480
Table 58 - After-Hours Support
144
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 do not 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.
145
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 94) appears.
146
Figure 94 - 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 95) appears.
147
Figure 95 - 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 96) appears.
148
Figure 96 - Registry Value Permissions Window
9. To add users to the list click Add.

10. The Add Users and Groups window (Figure 97) appears.
Figure 97 - 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.
149
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
clientthis 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.
150
Note: Evidence indicates that there are problems with the datagramoriented 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 MatrikonOPC 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.
151
Appendix B
Aliases
Scaling Expressions
Alias scaling expressions may use any of the expression constructs listed in Table 59.
Construct
Description
Examples
Text value (single quotation marks).
hello
Joes Alias
+ - * /
Addition (or Append), Subtraction,

Multiplication, and Division.
(3 * 7 + 1) / 8 2
hi + there
= < > <> <= >=
Equal To, Less Than, Greater Than,

Unequal To, Less or Equal To,
Greater or Equal To.
3<4
Not And Or
Logical Not, Logical And, Logical Or.

May also be used for binary math.
(7 >= 3) And (1 <> 0)

(12 And 5) = 4
TIME
Current time as text.
The time is + TIME
DATE
Current date as text.
Today is + DATE
INT(x)
Returns the integer part of x.
INT(3.14) = 3
FRAC(x)
Returns the fractional part of x.
FRAC(3.14) = 0.14
SQRT(x)
Returns the square root of x.
SQRT(16) = 4
DIV(x, y)
Divides x by y.
DIV(42, 7) = 6
IF(expr, x, y)
Returns x if expression evaluates to

TRUE, otherwise returns y.
IF(6 <= 12, OK, Bad) = OK
TRUE FALSE
Constant Boolean true and false.
(5 > 6) = FALSE
TYPEOF(x)
Returns the data type of x as a text

description (STRING, INTEGER,
FLOAT, BOOLEAN, ERROR).
TYPEOF(hello) = STRING
STR(x)
Converts the numeric value x to

text.
STR(3.14) = 3.14
UPPER(x)
LOWER(x)
PRETTY(x)
Converts the text value x to all

upper case or lower case letters, or
the first letter upper case and the
rest lower.
UPPER(alarm) = ALARM
LOWER(ALARM) = alarm
PRETTY(ALARM) = Alarm
COPY(x, start, length)
Returns a sub-string of the x,

copying length characters starting at
start.
COPY(FIDDLE, 2, 4) = IDDL
FORMATNUMERIC(mask, x)
Converts the numeric value x to text

using the format mask.
FORMATNUMERIC('####.#',
123.4567) = 123.5
INPUT
The incoming value read from OPC.
INPUT * 3.1415
OUTPUT
The outgoing value written to OPC.
OUTPUT / 3.1415
text
152
Construct
Description
Text value (single quotation marks).
text
Examples
hello
Joes Alias
Table 59 - Expressions Constructs for Alias Scaling
Advanced Calculations
Calculations may contain references to any OPC item in the servers syntax. However, they may
not contain references to other alias items. There are no limits on how many items can be used in
a calculation. The only limiting factor may be performance related. To reference another OPC item
in the calculation, wrap the items full item path in square brackets. For example to add the items
Com1.Rtu.Reg1 and Com1.Rtu.Reg2 together, the correct expression would be:
[Com1.Rtu.Reg1] + [Com1.Rtu.Reg2]
Advanced alias calculations may use any of the operators listed in Table 60.
Construct
Description
Examples
Minus operator.
x-y
Unary minus operator.
-x
Not logical operator.
Returns 1 if x is 0, else returns 0.

Not equal logical operator.
Returns 1 if true, 0 if false.
!=
Modulo; find remainder of the division
of x by y.
!x
x != y
x%y
&
And logical operator.

x&y
Multiplication operator.
x*y
Division operator.
x/y
Calculates x raised to the power of y.
x^y
Or logical operator.
x|y
Addition operator.
x+y
<
Lesser than logical operator.

x<y
<=
Lesser than or equal logical operator.

==
Equal logical operator.

>
Greater than logical operator.

>=
Greater than or equal logical operator.
x <= y
x == y
x>y
x >= y
153
Construct
Description
Examples

Table 60 - Calculation Operators for Alias Scaling
Alias scaling calculations may use any of the functions listed in Table 61.
Construct
Description
Examples
abs
Absolute value.
abs(x)
acos
Arccosine
acos(x)
asin
Arcsine
asin(x)
atan
Arctangent
atan(x)
avg
Returns the average of a set of

values.
avg(v1,v2,v3,...)
bin
Converts a binary number to a
bin(binNumber)
decimal number.
ceil
Ceiling.
ceil(x)
cos
Cosine.
cos(x)
cosh
Hyperbolic cosine.
cosh(x)
fact
Returns the factorial of x: x*(x1)*(x-2)*...(x-x+1).
fact(x)
floor
Floor.
floor(x)
hex
Converts an hexadecimal number

to a decimal number.
hex(hexNumber)
if
If the condition is true, returns
if(condition, val1, val2)
val1 else returns val2.

isNaN
Returns 1 if the number is a NaN value.
isNaN(value)
log
Natural logarithm.
log(x)
log10
Base-10 logarithm
log10(x)
max
Returns larger of a set of values.
max(v1,v2,v3,...)
max
Returns larger of two values.
max(x,y)
max
Returns larger of three values.
max(x,y,z)
min
Returns smaller of a set of values.
min(v1,v2,v3,...)
Min
Returns smaller of two values.
min(x,y)
Min
Returns smaller of three values.
min(x,y,z)
Rand
Random value between 0 and 1.
rand()
Rand
Random value between min and

max.
rand(min, max)
154
Construct
Description
Examples
Round
Round the fractional part of a number.
round(x)
Sin
Sine.
sin(x)
Sinh
Hyperbolic sine.
sinh(x)
Sqrt
Square root.
sqrt(x)
Sum
Returns the sum of a set of values.
sum(v1,v2,v3,...)
Tan
Tangent.
tan(x)
Tanh
Hyperbolic tangent.
tanh(x)
Table 61 - Calculation Functions for Alias Scaling
CSV File Format

Note: The CSV file format does not support Alias Event custom category configuration settings. If
aliases referencing custom categories are exported to CSV, all custom categories must be created
before import.
The alias import/export file contains lines of comma-separated values. Each line contains the fields
listed in Table 62.
Values containing commas are enclosed in double-quotation marks ( ).
Double-quotation marks occurring inside quoted values are escaped with an extra doublequotation mark.
Lines beginning with a hash mark (#) are ignored (used for comments).
Field
Description
Alias Group
Name of the alias group folder where the alias belongs. Periods in the name
indicate subfolders below the root (e.g., North.FIC101 = alias group North
under the Alias Configuration root and alias group FIC101 under that).
Alias Name
Name of the alias. Full alias path name composed of the alias group path, a
period, and the alias name (e.g., North.FIC101.CV for an alias named CV).
Item Path
Fully qualified item ID for the OPC item to which the alias refers. Leave this field
blank to specify a holding register.
Data Type
Decimal number indicating the data type for the alias.
Read-only
Specifies whether the alias is read-only or read-write.

0 = read-write
1 = read-only
Poll Always
Specifies whether the alias is polled continuously or not.

0 = only poll as requested by an OPC client (normal)
1 = poll continuously at the specified update rate
Update Rate
Update rate (milliseconds) to use with the Poll Always option.
Scaling
Scaling type for the alias.

0 = none
1 = linear
155
Field
Description
2
3
4
5
=
=
=
=
square root
gain/offset
expression
calculation
Scaling Option 1
High Raw, Gain, Input Expression, or Calculation, depending on the value

of Scaling.
Scaling Option 2
Low Raw, Offset, or Output Expression, depending on the value of Scaling.
Scaling Option 3
High Scaled if Scaling is 1 or 2.
Scaling Option 4
Low Scaled if Scaling is 1 or 2.
Scaling Option 5
Clamp if Scaling is 1 or 2.
Register Initial
Value
Initial value of a holding register.
Event Enabled
0 if events are not to be generated, or 1 if events will be generated. If 0, all

other event fields can be left blank.
Event Source
Text that appears as the data source in generated events.
Event Category ID
ID of an event category for the generated events. If the category ID does not
exist at import time, the import will fail.
Event Severity
Severity of the generated events. This can be a value from 1 to 1000.
Event Message
Message to be included in generated events.
Event Trigger Type
Trigger type for the alias event.

0 = value change
1 = positive edge
Event Timestamp
Type
Timestamp type for the alias event.

0 = server generated
1 = device generated
Table 62 - File Import/Export Field Descriptions
When the scaling field specifies linear (1) or square root (2) scaling, the five scaling option fields
are defined in Table 63.
Field
High Raw
Description
Raw value range (double-precision real).
Low Raw
High Scaled
Scaled value range (double-precision real).
Low Scaled
Clamp
Clamp options.
0 = none
1 = clamp low value
2 = clamp high value
3 = clamp both high and low values
Table 63 - Additional File Import/Export Field Descriptions - Linear/Square Root Scaling
156
When the scaling field specifies gain/offset (3) scaling, the first two scaling option fields are defined
as listed in Table 64. The other scaling option fields can be left blank.
Field
Description
Gain
Scaling factor (double-precision real).
Offset
Scaling offset (double-precision real).
Table 64 - Additional File Import/Export Field Descriptions - Offset Scaling
When the scaling field specifies expression (4) scaling, the first two scaling option fields are defined
as listed in Table 65. The other scaling option fields can be left blank.
Field
Description
Input Expression
Simple formula applied to the value read from the OPC item.
Output Expression
Simple formula applied to values written to the OPC item. The

output formula should be the reciprocal of the input formula.
Table 65 - Additional File Import/Export Field Descriptions - Expression Scaling
When the scaling field specifies calculation (5) scaling, the first scaling option field is defined as
listed in Table 66. The other scaling option fields can be left blank.
Field
Description
Input Calculation
Calculation applied to the value read from the OPC item.
Table 66 - Additional File Import/Export Field Descriptions - Calculation Scaling
Scaling Algorithms
For each type of scaling, a different algorithm (Table 67) is applied to values read from the OPC
item. A reverse algorithm is applied to any values written to the OPC item.
Scaling
Linear
Square
Root
Gain/
Offset
Expression
Algorithm/Example
Scaled High Scaled Low
Scaled Low
Raw
Raw
High
Low
x RawLow
Scaled
Scaled Low
High
Scaled
x RawLow
Low
Raw
Raw
High
Low
Reverse Algorithm/Example
x Scaled Low
x Scaled Low 2
RawHigh RawLow
Scaled
Scaled
High
Low
RawLow
RawHigh RawLow
Scaled
Scaled
High
Low
Raw Low
Gain x Offset
x Offset
Gain
SQRT(INPUT) + 5
(OUTPUT 5) * (OUTPUT 5)
Table 67 - Scaling Algorithms
157
Appendix C
Standard Data Types
The Standard data types and their descriptions are listed in Table 68.
Hex
Dec
Data Type
Description
0000
VT_EMPTY
Default/Empty (nothing)
0002
VT_I2
2-byte signed integer
0003
VT_I4
0004
VT_R4
4-byte (single-precision) real
0005
VT_R8
8-byte (double-precision) real
0006
VT_CY
Currency
0007
VT_DATE
Date
0008
VT_BSTR
Text (UNICODE)
000A
10
VT_ERROR
Error code
000B
11
VT_BOOL
Boolean (TRUE = -1, FALSE = 0)
0011
16
VT_I1
0012
17
VT_UI1
1-byte unsigned integer
0013
18
VT_UI2
0014
19
VT_UI4
2002
8194
VT_ARRAY | VT_I2
Array of 2-byte signed integers
2003
8195
VT_ARRAY | VT_I4
Array of 4-byte signed integer
2004
8196
VT_ARRAY | VT_R4
Array of 4-byte (single-precision) real
2005
8197
VT_ARRAY | VT_R8
Array of 8-byte (double-precision) real
2006
8198
VT_ARRAY | VT_CY
Array of currency values
2007
8199
VT_ARRAY | VT_DATE
Array of dates
2008
8200
VT_ARRAY | VT_BSTR
Array of text values
200A
8202
VT_ARRAY | VT_ERROR
Array of error codes
200B
8203
VT_ARRAY | VT_BOOL
Array of Boolean values
2011
8208
VT_ARRAY | VT_I1
Array of 1-byte signed integers
2012
8209
VT_ARRAY | VT_UI1
Array of 1-byte unsigned integers
2013
8210
VT_ARRAY | VT_UI2
2014
8211
VT_ARRAY | VT_UI4
Table 68 - Standard Data Types
158
Appendix D
Security
Introduction
The OPC Framework has implemented the OPC Security Customer Interface version 1.0 of the
specification. Both the IOPCSecurityNT and IOPCSecurityPrivate interfaces are fully supported
(there are no optional pieces).
IOPCSecurityNT describes how NT authentication is used in OPC Security. IOPCSecurityPrivate
describes how proprietary user credentials are used in OPC Security. The OPC Security specification
defines how user credentials are passed from client to server, but very little else. The type of
functionality in an OPC server that is controlled by OPC Security is vendor-determined.
Appendix Structure
This appendix is structured as follows:
Introduction this introductory section.
OPC Security Implementation description of user access dependencies.
MatrikonOPC Tag Security Configuration Utility describes the utility that is used to
configure security for MatrikonOPC servers.
Security Details describes how permissions are applied, how security settings are
stored, and other important details.
OPC Security Implementation

Whether a user has access or not will depend on:
1. Identity the user behind the OPC clients actions.
2. Location the OPC item ID or hierarchy path being accessed.
3. Type the type of functionality the user is trying to perform.
Identity
Using the IOPCSecurityNT interface for OPC Security, the identity of the OPC client is the domain
user that is running the OPC client and connecting to the OPC server. The OPC Framework will
attempt to impersonate the client that is connected to the server, and use the name from those
credentials for access control. This method does not require any implementation of OPC Security by
the OPC client, since no interface calls are necessary.
Using the IOPCSecurityPrivate interface for OPC Security, the OPC client must make a call to the
OPC server to log on with a user name and password. In this scenario, the OPC client must
implement and follow the OPC Security specification in terms of following the calls necessary to
provide credentials. The credentials provided through the private interface override those provided
from the NT interface. The OPC client may choose to log off, at which point the NT credentials are
used until the log on call is made again.
Location
Some of the interface calls made from an OPC client to an OPC server require the client to provide
an OPC item ID. The OPC Framework will take the OPC item ID provided, and determine whether
access to that location is allowed or not. A particular server installation may want to control access
to a particular device or branch in the hierarchy, and is able to do so by setting permissions for a
partial item ID or path.
159
Other interface calls do not provide an ID, but may depend on the state of the server with respect
to previous calls. OPC Browsing (DA 2.0) is an example of this. In this case, the full path up to that
particular location is used for determining access rights.
Type
There are seven types of interface functionality in the OPC Framework (specifically the OPC Outer
Layer) that are controlled using OPC Security:
1. Browsing
2. Adding items
3. DA Reading
4. DA Writing
5. HDA Reading
6. HDA Writing
7. HDA Deleting
Browsing is the least intrusive, followed by adding items, reading values from the items, and finally
writing to the items being the most intrusive. There are multiple interfaces, and functions within
those interfaces, that can be used to perform the types of functionality listed above. Thus, security
control has been added to each possible entry. For example, read control has been added to group
subscriptions call-backs as well as synchronous reads and asynchronous reads denying read
control would disable reads for the possible types.
A location that is being accessed by an OPC client may have different permissions for the different
types of access. For example, one particular item may be browseable, added, and read, but the
writing permissions might be restricted so that the user cannot interfere with the operation of the
end device.
Note: Of the seven functionality types listed above, six of them make use of the full OPC item ID
when an interface call is made from the client to the server: Adding Items, Reading, Writing, or
Deleting. When browsing, only a partial path leading to an OPC item may be known at any location
in the browsing hierarchy.
MatrikonOPC Tag Security Configuration Utility

The tag security settings for MatrikonOPC servers are configured and managed via the
MatrikonOPC Tag Security Configuration Utility, a tool that is installed with the server. This
utility allows users to define, per MatrikonOPC server, the following:
Who has permission
Which tags/locations they have permissions for
The type of permissions for those locations
Security settings configured using this utility are read by the OPC Framework and populated in
memory upon server start-up, and are monitored for changes.
Note: In order for the MatrikonOPC Tag Security Configuration Utility to work properly, the
windows user running the utility must have Administrator rights to the computer.
The MatrikonOPC Tag Security Configuration Utility is a component of an OPC server
installation, and is installed in the following location:
C:\Program Files\Common Files\MatrikonOPC\Common\ACLConfig.exe
160
The MatrikonOPC Tag Security Configuration Utility can be run either directly from its
installed location, or from a shortcut found in the Start Menu. If the utility is run from the installed
location, then the user must select the OPC server for which security will be configured. If the
MatrikonOPC Tag Security Configuration Utility is run from the shortcut, then it will configure
security for the OPC server to which the shortcut belongs.
To run the MatrikonOPC Tag Security Configuration Utility from its shortcut:
1. Click on the Windows Start button.
2. Select Programs -> MatrikonOPC -> <OPC Server Name> ->Tag Security.
Figure 98 - Start Menu Navigation
Note: The MatrikonOPC Tag Security Configuration Utility

requires administrator permissions to run. If a standard user runs this
application, either an error message will appear or a
username/password is dislayed asking for administrator access.
After the MatrikonOPC Tag Security Configuration Utility is run:
1. A window appears asking for a password to be entered. This protects the security settings
and prevents unauthorized individuals from accessing these settings. For servers that
required a security password to be entered during their installation, the Enter server
password window (Figure 99) appears.
Figure 99 - Enter Server Password Window
2. Enter the password created during the installation of the OPC server.
Note: The default password provided for you during installation (if you chose to use the
default) is MatrikonOPC.
4. The MatrikonOPC Tag Security Configuration Utility screen (Figure 100) appears.
161
Layout
Figure 100 - MatrikonOPC Tag Security Configuration Utility Main Screen
The MatrikonOPC Tag Security Configuration Utility screen displays the name of the OPC
server that is being configured for tag security. In Figure 100 above, the Utility screen shows that
the MatrikonOPC Server for Simulation and Testing tag security is being configured.
The left-hand side of the Utility screen shows a column of action icons that can be clicked upon.
These actions are further described later in this appendix. Some actions may not be applicable,
depending on the context in which they are used, and are identified by greyed-out icons.
In the center of the Utility screen there are descriptions for each of the actions that can be
performed. The appearance of these descriptions can be toggled at any time by clicking on the
Hide Help/Show Help link that exists in the bottom-right corner of the Utility screen. When the
Help screen is hidden, a list of users and groups that have been added appears (Figure 101). By
default, there is always a user named Everyone in the Users & Groups list. This user defines the
permissions used for other NT users that are not configured.
162
Figure 101 - MatrikonOPC Tag Security Configuration Utility Main Screen: Users & Groups
Note: After any action is performed, the changes made do not take effect until either the OK or
Apply button has been selected. Clicking on the OK button saves the changes and closes the
Utility screen. Clicking on the Apply button saves the changes and keeps the Utility screen open.
Clicking on the Cancel button or the X button on the top-right of the screen, discards any changes
made.
Add User
There are two types of users for which security can be configured: NT Users and Private Users.
Adding a user to the configuration will allow permissions to be defined for that user. For NT users,
the IOPCSecurityNT interface is used, and for Private users, the IOPCSecurityPrivate interface is
used.
NT User
To add an NT user:
1. From the MatrikonOPC Tag Security Configuration Utility main screen, click on the Add
User button.
163
2. The Add User window (Figure 102) appears. The NT User option button is selected by
default. This will allow the addition of a user from a Windows NT Domain.
Figure 102 - Add User Window (NT)
3. By default, the local machine name appears in the From this Location field. To browse to
a different location, click the Locations button.
4. The User field can be entered manually. Clicking on the Check Name button performs
validation on the entered user. The user names are the same as the Windows NT domain
names used on the network. To avoid manually entering a user, click on the Search button,
and select a user from the displayed list of users.
5. To add the selected user, click on the OK button. The user is then added to the list of users
and/or groups currently defined (refer to Figure 103 for a sample list of defined users and
groups).
6. The Edit <Username> window (Figure 108) appears. Follow the instructions in the Edit
User section for adding permissions.
164
Figure 103 - Defined Users and Groups
Private User
Private users have names and passwords associated with them, custom to the OPC client
application, which must implement the OPC Security Private interface for this section to be
meaningful. Private users exist only in the OPC server. They are not created in any NT domains.
To add a Private user:
User button.
2. The Add User window (Figure 102) appears.
3. Select the Private User option button (Figure 104).
165
Figure 104 - Add User Window (Private)
4. In the Username field, enter a user name.

5. In the Password field, enter a password.
6. In the Password Confirmation field, re-enter the new password.
7. Click OK to create the Private user. It will be added to the list of users and/or groups
currently defined (refer to Figure 103 for a sample list of defined users and groups).
Note: The user name cannot be added if there is already a configured User or Group with
that same name.
Add Group
Groups are used to group users together so that they can share common permissions. Groups are
not necessary to use OPC Security. However, they are convenient when you need to apply common
permissions to multiple users. A group must contain at least one user, and any combination of
users can be grouped together.
Note: A user can exist in multiple groups, but if two or more of the groups have the same
configured path (refer to the Edit User section), and each group defines a permission (Allow/Deny)
for the type of access, then the group whose name alphabetically comes first is used.
There are two types of groups for which security can be configured: NT Groups and Private
Groups.
NT Group
To add an NT group:
Group button.
166
2. The Add Group window (Figure 105) appears. The NT Group option button is selected by
default. This will allow the addition of an NT group from a Windows NT Domain.
Figure 105 - Add Group Window (NT)
3. By default, the local machine name appears in the From this Location field. To browse to
a different location, click the Locations button.
4. The Group field can be entered manually. Clicking on the Check Group button performs
validation on the entered group. The group names are the same as the Windows NT domain
group names used on the network. To avoid manually entering a group, click on the Search
button, and select a group from the displayed list of groups.
5. To add the selected group, click on the OK button. The group is then added to the list of
users and/or groups currently defined (refer to Figure 103 for a sample list of defined users
and groups).
6. The Edit <Groupname> window (Figure 115) appears (for NT Groups, there is only the
Permissions tab). Follow the instructions in the Edit Group section for adding
permissions.
Private Group
To add a Private Group:
Group button.
2. The Add Group window (Figure 105) appears.
3. Select the Private Group option button (Figure 106).
167
Figure 106 - Add Group Window (Private)
4. Enter a name for the group to be created. The group is private and will only exist in the OPC
server. The group cannot be created if there is already a configured user or group with that
same name.
5. Click on the OK button to create the group. It will be added to the list of users and/or
groups currently defined (refer to Figure 103 for a sample list of defined users and groups).
6. The Edit <Groupname> window (Figure 115) appears. Follow the instructions in the Edit
Group section for adding permissions.
Duplicate
Another way to create a new user or group is to duplicate an existing one.
To create a new user or group via duplication:
1. From the MatrikonOPC Tag Security Configuration Utility main screen, right-click your
mouse on the user or group you wish to duplicate.
2. From the displayed menu, select Duplicate.
3. The Enter New Name window (Figure 107) appears.
Figure 107 - Enter New Name Window
168
4. Enter a name for the new user or group to be created.

5. Click on the OK button. There must not already be a configured user or group with that
same name. The new user or group will then appear in the list, and will contain the same
properties as the duplicated parent (i.e., original) user or group.
Edit
Once the desired users and/or groups are defined, they must be edited to configure their
respective permissions.
Note: Permissions can also be defined for the user Everyone, which is defined as the default user.
For every NT user not configured in the MatrikonOPC Tag Security Configuration Utility, the user
Everyone is used for determining security permissions.
Permissions for allowing/denying browsing, adding items, reading items, and writing items can be
configured. Permissions are defined for users and groups for a particular location in the servers
address space hierarchy. A location can either be a tag (i.e., OPC Item ID) or a path leading up to
an item.
Edit User
To edit a user:
1. From the MatrikonOPC Tag Security Configuration Utility main screen, either:
Double-click your mouse on the user you wish to edit, or
Right-click your mouse on the required user and select Edit User from the displayed
menu, or
Click your mouse on the required user, and then select the Edit button.
2. The Edit <Username> window (Figure 108) appears.

Notes:
In this example, the user being edited is User1 so the windows title reads Edit
User1.
There are two tabs on this window: Permissions and General. The General tab
only appears for private users.
169
Figure 108 - Edit <Username> Window (Permissions Tab)
Permissions
On the Permissions tab, the permissions associated with this user relating to browsing, adding,
reading, and writing for any specific paths or OPC items are configured. The Configured Paths
screen section lists the paths and/or OPC items for which permissions are defined. The
Permissions screen section indicates those permissions with option buttons, which can be set to
Allow, Deny, or Unspecified. Selecting Unspecified directs the OPC Framework to look for the
permission higher up in the hierarchy.
From the Permissions tab, when the Add button is selected, the Add Permission screen is
displayed. In the Server Address Space screen section, folders and items are shown as nodes are
selected and expanded.
Red folders indicate a null branch. This means that the item names below this branch do not
contain the branch name, so permissions set on the branch will not reflect on Add, Write, Read,
and Delete permissions for the items below the branch. To properly set permissions on the items
below the branch, they have to be set on the items themselves.
Figure 109 provides an example of a null branch and items below it, all of which are outlined in
black.
170
Figure 109 - Add Permission Screen (Server Address Space)
When browsing, using the example in the diagram above, Simulation Items is a null branch
(identified by the red folder), Saw-toothed Waves is a non-null branch, and Int1 is an item.
Setting permissions on the Simulation Items branch does not affect Read, Write, Delete, and
Add permissions for the Saw-toothed Waves branch of the Int1 item below that. This is because
when adding the Int1 item, the item ID of the Int1 item is actually Saw-toothed Waves.Int1
and not Simulation Items\Saw-toothed Waves.Int1.
Setting Read, Write, Delete, and Add permissions for the Saw-toothed Waves branch will
affect the items below as Saw-toothed Waves is part of the item ID of the Int1 item (Sawtoothed Waves.Int1), and therefore the Saw-toothed Waves folder does not appear as a red
folder like the Simulation Items folder does.
Note: User permissions override group permissions. For example, if a defined group is denied
writing privileges to an OPC item, Random.Int4, while a defined user (a member of that group) is
allowed writing privilege to Random items (Random.<itemID>), then the user permissions would
take precedence for that OPC item (even though the permissions relating to the group are a better
match for the OPC item, Random.Int4).
To edit a users permissions:
1. Click on the Add button to begin configuring permissions for the current user.
2. The Add User Permission window (Figure 110) appears. This window allows you to browse
the OPC server address space to find either a path in the hierarchy, or a particular OPC
item.
171
Figure 110 - Add User Permission Window
3. Expand on the server address spaces root node and continue to browse to the desired path
in the hierarchy, or the desired OPC item.
Note: Branches (i.e., folders) that are red in colour (see Figure 111) are not part of an
items path, but rather are used for browsing organization. Configuring permissions for
adding, reading, and writing will not affect items below it. For more information, refer to
Permissions.
172
Figure 111 - Add Permission Window: Browsing Server Address Space

5. The selected path or item will be listed in the Configured Paths screen section of the Edit
User window. Permissions can now be assigned, as in the example depicted in Figure 112.
Note: In this example, User1 is allowed to browse the Random path of the OPC servers
address space. Adding privileges are denied, and Reading and Writing privileges are
unspecified.
173
Figure 112 - Edit <Username>: Example
On the General tab (Figure 113) of the Edit <Username> window, the name and password of
the user can be changed.
To edit a users name:
1. Enter a new name in the Name field.
174
Figure 113 - Edit <Username> Window (General Tab)
To change the users password:

1. Click on the Reset Password button. The Reset Password window (Figure 114) appears.
Figure 114 - Reset Password Window
2. Enter the new password in the Password field.

3. Re-enter the password in the Password Confirmation field.
175
Edit Group
To edit a group:
Double-click your mouse on the group you wish to edit, or
Right-click your mouse on the required group and select Edit Group from the
displayed menu, or
Click your mouse on the required group and then select the Edit button.
2. The Edit <Groupname> window (Figure 115) appears.

Notes:
In this example, the group being edited is Group1 so the windows title reads Edit
Group1.
For Private Groups, there are three tabs on this window: Permissions, General,
and Members. For NT Groups, there is only the Permissions tab.
Figure 115 - Edit <Groupname> Window (Permissions Tab)
On the Permissions tab, the permissions associated with this group relating to browsing, adding,
reading, and writing for any specific paths or OPC items are configured. Refer to the Edit User
176
section regarding configuration on the Permissions tab. Group and user permissions are
configured in the same way.
On the General tab (Figure 116) of the Edit <Groupname> window, the name of the group can
be changed.
To edit a groups name:
1. Enter a new name in the Name field.
Figure 116 - Edit <Groupname> Window (General Tab)
On the Members tab (Figure 117), the users that are part of the current group are defined. By
default, the Group Members screen section is empty. In Figure 117, User1 has been added to
Group1.
177
Figure 117 - Edit <Groupname> Window (Members Tab)
To add one or more members to the group:

1. Click on the Add button. The Add Existing User window (Figure 118) appears.
178
Figure 118 - Add Existing User Window
2. The Members screen section lists all the defined users from which you may choose. Select
one or more desired users to become members of the group.
3. Click on the OK button. The selected user or users appear in the Group Members screen
section on the Members tab (Figure 117).
To remove a user from the group:
1. Select that user in the Group Members screen section.
2. Click on the Remove button.
Notes:
If a user name and a group name (to which the user belongs) have permissions
defined for the same location, the user name will be used. If a user belongs to two
groups that have permissions defined for the same location, the group that is
alphabetically first will be used.
The exact location (full item ID for reading, writing, deleting, and adding, or the full
path for browsing) is always looked for first when determining the permission for a
particular user. If the exact location is not found, or is found but does not contain a
defined permission, then the closest match in location is looked at next, and so on.
The root location (i.e., empty string) will always match, and is used if no partial
location match is made.
Delete
To delete a previously added user or group:
Select the required user or group from the list and click on the Delete button
(Figure 103), or
179
For a group, right-click your mouse on the required group and select Delete Group
from the displayed menu, or
For a user, right-click your mouse on the required user and select Delete User from
the displayed menu
Change Password
To change the security password for the OPC server:
1. From the MatrikonOPC Security Configuration Utility main screen, click on the Change
Password button (Figure 100).
2. The Change Password window (Figure 119) appears.
Figure 119 - Change Password Window
3. Enter the old password for the current OPC server.

4. Enter and confirm the desired new password.
Note: Changes are applied in the Utility main window by clicking on either the OK or
Apply button.
Security Details
ACL File
The permissions that the MatrikonOPC Tag Security Configuration Utility creates are stored in
a file named ACL.sec that is located in the same directory as the MatrikonOPC server executable:
C:\Program Files\Matrikon\OPC\< OPC Server Name >\.
ACL.sec is encrypted with 256-bit AES using the password key that was provided during
installation (or changed in the security utility).
While the server is running, if the ACL.sec file is moved or deleted from its location above, security
functions as it did before the file was moved. If the server is re-started with the ACL.sec file
missing, no users will have permissions to do anything (i.e., browsing, adding, reading, writing)
and must re-configure their security settings.
Note: It is advised that this file is backed up and stored somewhere safe, once tag security
configuration has been completed. In the event that this file is lost or deleted by accident, simply
transfer the stored backup (if one was made) to the directory stated above. If ACL.sec becomes
deleted and no backup was made, tag security will need to be re-configured.
180
Run-Time Tag Security Configuration

Tag security can be configured and updated while a MatrikonOPC server is running. This run-time
security configuration can be controlled using the #MonitorACLFile OPC item (found in the root
branch when browsing the server).
The #MonitorACLFile is a boolean OPC tag that has a default value of True when the server
starts which indicates that the tag security permissions are monitored and applied while the server
is running. By adding this item to an OPC group and writing a value of False to this item, the
server no longer applies tag security configuration changes while the server is running. The server
would need to be stopped and restarted for the changes to take effect.
By disabling the ability of run-time tag security configuration, a malicious user that has access to
the machine cannot delete the ACL file and thus remove all user permissions for OPC security. Runtime tag security configuration can be re-enabled when changes to the tag security need to be
made, and then disabled again once they have been applied.
Security should be applied to the #MonitorACLFile tag so that unauthorized users are unable to
control this ability described above.
Client Connections and Private Log On

When an OPC client connects to the server, the OPC Framework impersonates the client and
determines the name of the NT user that is running the client. This client name (consisting of the
domain name and the user for that domain) is what the OPC Framework uses when checking
permissions set in the MatrikonOPC Tag Security Configuration Utility. If this NT user was not
added in the Users & Groups list (Figure 103), then the user Everyone is used instead.
If the OPC client chooses to use the IOPCSecurityPrivate interface, it must call the Logon() function
and provide a name and password. The OPC Framework will immediately look for the private user
in the Users & Groups list (Figure 103). If the user is found and the password provided is correct,
the Logon() result is successful and the user name provided replaces the NT user that was obtained
through impersonation. If not found, the Logon() result is failure and the NT user remains as the
name used for security permissions. When the OPC client calls Logoff(), the NT user becomes the
name used for security permissions.
Determining Permission
Whenever a browsing, item addition, read, write, or delete operation is performed by the OPC
client, the OPC Framework will call a permission routine to determine if permission is allowed or
denied. Three pieces of information are always sent to this routine call:
1. Identity
2. Location
3. Type
Identity is the user name described in the previous section either the NT domain name, a private
name, or the default user Everyone. In addition, identity includes any groups (private or NT) that
the user belongs to. Location is either the full item ID or a partial path in the server hierarchy.
Type is the access type: browsing, item addition, reading, or writing. Each piece of information is
checked in the order listed above.
The following information details the procedure used in determining permission rights:
1. Look for a permission match with the NT domain name or private name. This step occurs
only if the NT domain name or private name has been defined in the Users & Groups list.
181
2. If a permission match was not yet found, look for one using each group defined in the
Users & Groups list that the NT domain name or private name belongs to. The first group
that contains a permission match will be the one used. An NT domain name does not need
to be defined in the Users & Groups list for a group it belongs to, to have a permission
match. The NT domain name must be part of Group Members for private groups, or in the
Active Directory for NT groups.
3. If a permission match was not yet found, look for a permission match using the default user
Everyone.
The procedure used in finding a permission match for a particular identity is as follows:
1. Check whether the exact location is found in the Configured Paths list for the identity. If
found:
a. Check whether the permission type (browse, add, read, write, or delete) is
specified (Figure 112). If the permission type is specified for the action being
performed, a match is found and the permission (either allow or deny) is used.
2. If a permission match was not found in step 1a, check whether a partial match of the
location is found in the Configured Paths list for the identity. A partial match is always a
sub-string of the given location that starts with the same characters. This represents
starting from the root location and moving down the browsing hierarchy.
For example, the location Random is a partial match of the full item ID Random.String.
However, String is not a partial match (even if it is a sub-string) because it does not match
the first seven characters. The root location \ is considered a partial match for every full
item ID.
For each partial match from step 2, apply step 1a. The best partial match (i.e., the one that
has the most characters) that is successful in step 1a is the one whose permission is used.
Examples
This section contains examples of tag security settings made via the MatrikonOPC Tag Security
Configuration Utility, and the impact of these settings.
Default
The default tag security configuration provided is quite simplistic as is shown in Table 69:
User/Group
Everyone
Configured Paths
\
Browse
Allow
Add
Allow
Read
Allow
Write
Allow
Table 69 - Default Tag Security
As no users or groups are defined, any NT user connecting to the OPC server will use the
Everyone default user for permissions. Only the root level location is defined under the
Configured Paths list, which gives full permissions to the entire OPC server. An administrator will
want to change these default settings for the OPC server to provide more security on its tags.
182
Example 1
Table 70 contains a possible tag security configuration enforces complete restricted access except
for the NT user DOMAIN\Admin:
User/Group
Configured Paths
Browse
Add
Read
Write
Everyone
Deny
Deny
Deny
Deny
DOMAIN\Admin
Allow
Allow
Allow
Allow
Table 70 - Example 1
At this point, more users can be added which belong to a more restricted group. This group may be
denied write capability or restricted to certain areas in the server hierarchy.
Example 2
Following is an example of a tag security configuration for the MatrikonOPC Server for Simulation
and Testing, with sample use-cases. Table 71 lists all defined users and groups and their
associated permissions. Table 72 indicates which users are members of the defined groups.
Unspec. permission indicates Unspecified. Groups in this example are Private Groups.
User/Group
Configured Paths
Browse
Add
Read
Write
Everyone
Allow
Deny
Deny
Deny
Everyone
Configured Aliases
Deny
Unspec.
Unspec.
Unspec.
Deny
Allow
Allow
Deny
Common (group)
Allow
Allow
Allow
Deny
Common (group)
Triangle Waves
Deny
Deny
Deny
Deny
Admin (group)
Allow
Allow
Allow
Allow
Admin (group)
Bucket Brigade.Int4
Unspec.
Unspec.
Unspec.
Deny
DOMAIN\john.doe
DOMAIN\fred.stone
DOMAIN\sally.simpson
DOMAIN\the.admin
Supervisor
Restricted (group)
Table 71 - Example 2: Permissions
User/Group
Configured Paths
Restricted
DOMAIN\john.doe
Common
DOMAIN\fred.stone, DOMAIN\sally.simpson
Admin
DOMAIN\the.admin
Table 72 - Example 2: Groups and Members
Case 1
User DOMAIN\no.name connects. This name is not defined, so the Everyone permissions are
used. At the root level location, the default user can browse but no more. The only other location
where permissions are defined for the default user is Configured Aliases where browsing is
183
denied, and adding, reading, and writing permissions are not defined. Thus, DOMAIN\no.name
will be able to browse the entire server except the Configured Aliases branch and all aliases
under it. Also, DOMAIN\no.name will not be able to do any item addition, reading, or writing.
Since item addition, reading, and writing permissions were not defined for the default user under
Configured Aliases - it would use the permissions defined at the root level.
Case 2
User DOMAIN\john.doe connects. No permissions have been defined for this user name or the
Restricted group to which it belongs - the Everyone permissions apply. The user has no access to
any tags under the Configured Aliases path but has Browse access to the rest of the address
space.
Case 3
User DOMAIN\fred.stone connects. This user belongs to the defined group Common. At the root
level, the group Common can browse, add, and read items, but writing is denied. The only other
location which defines permissions for this group is Triangle Waves. This location has denied all
permissions for the Common group.
Case 4
User Supervisor connects through the private security interface and logs on. This user does not
belong to any group, but its name has a root level permission which allows it to add and read
items. No other locations have permissions defined. Since the user cannot browse, it will need to
know the item syntax for any items it wishes to add and read.
Case 5
User DOMAIN\the.admin connects. This user belongs to the Admin group, which at the root
level has all permissions allowed. The only other location where the Admin group has permissions
defined, is the full item ID Bucket Brigade.Int4. This user is unable to write to that item.
However, the root permissions for browsing, adding, and reading the item apply as they are not
defined at this level.
184
Appendix E
Installation
Once the system requirements have been met, you are ready to install the software.
Notes:
MatrikonOPC Desktop Historian may not be installed on a

computer that has MatrikonOPC Buffer installed.
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.
To install the software:

1. Insert the MatrikonOPC Desktop Historian CD into the CD drive.
2. If the MatrikonOPC InstallAware screen does not automatically appear, double-click the
installation .exe file. The MatrikonOPC Server InstallAware Wizard verifies its
contents (Figure 120).
Figure 120 - InstallAware Wizard Verification Window
3. Either a Pre-Requisites screen (Figure 121) appears, or you are taken directly to the
License Agreement (Figure 122) screen. If the License Agreement screen is the
displayed screen, go to step 5.
4. If the Pre-Requisites screen appears, then click on the Next button to install the listed
pre-requisites.
185
Figure 121 - Pre-Requisites Screen
5. After all pre-requisites have been installed, the License Agreement screen (Figure 122)
appears.
Note: From the License Agreement screen, you have the option of selecting the I reject
the license agreement option. Selecting the I reject the license agreement option
button disables the Next button so your options are to return to the previous screen, cancel
the install by clicking on the Cancel button, or select the I accept the license agreement
option button enabling you to proceed through the install.
186
Figure 122 - License Agreement Screen
6. Read the End-User License Agreement, using the scroll bar to view the entire message.
7. Select the I accept the license agreement option button.
9. Click on the Next button. The Product Registration screen (Figure 123) appears.
187
Figure 123 - Product Registration Screen
10. Enter the required registration information.

Notes:
The Next button is not available until all fields have been
entered.
Ensure the E-mail Address is valid as that is the address to

which the license file is sent.
11. Click on the Next button. The Setup Type screen (Figure 124) appears.
188
Figure 124 - Setup Type Screen
12. Select the type of setup to be performed.

Note: Matrikon recommends that you select the Complete Setup option.
13. Click on the Next button. The Destination Folder screen (Figure 125) appears.
189
Figure 125 - Destination Folder Screen
14. Select the folder in which to install MatrikonOPC Desktop Historian, or accept the default
location displayed in the Folder path field.
15. Click on the Next button. The Start Menu screen (Figure 126) appears.
190
Figure 126 - Start Menu Screen
16. Select the Start Menu group and then specify whether you want shortcuts created only for
yourself, or for all users, by selecting the applicable option button.
17. Click on the Next button. The Enter Password screen (Figure 127) appears.
191
Figure 127 - Enter Password Screen
18. A default password is supplied for you in the Password and Confirm Password fields.
Notes:
The default password provided for you is MatrikonOPC. Note
this password for future reference.
If you need to change the password at a later date, access the

Tag Security shortcut from the Start menu. Click on the
Windows Start button. Select Programs -> MatrikonOPC ->
<OPC Product Name> -> Tag Security. For more
information, refer to Appendix D Security.
19. Click on the Next button to accept the default password. The Licensing screen (Figure
128) appears.
192
Figure 128 - Licensing Screen
20. Select the applicable licensing option.

Notes:
A 30-day demo of MatrikonOPC ODBC Server for OPC is
installed with MatrikonOPC Desktop Historian. For more
information, refer to Licensing MatrikonOPC ODBC Server
for OPC.
MatrikonOPC Trender, Matrikon Analytics Excel Reporter, and
Performance Monitor are optional components that are installed
by the typical installation type, or if selected for a custom
installation. Please consult the Users Manuals installed with
those programs separately for more information on how to use
those products. When these components are installed, those
Users Manuals are available through the Start menu in the
following location:
Programs -> MatrikonOPC -> Desktop Historian -> Help > [Product Name] Manual
21. Click on the Next button. The MatrikonOPC Performance Monitor screen (Figure 129)
appears.
193
Figure 129 - MatrikonOPC Performance Monitor Screen
22. If you would like to install a demonstration (i.e., evaluation) version of MatrikonOPC Server
for Performance Monitor, select the Yes option button. If the product is not required, select
No.
Note: A permanent MatrikonOPC Server for Performance Monitor license is not included
with MatrikonOPC Desktop Historian and must be purchased separately. Contact your
Account Manager for assistance and more information.
23. Click on the Next button. The Matrikon Analytics Excel Reporter screen (Figure 130)
appears.
194
Figure 130 - Matrikon Analytics Excel Reporter
24. If you would like to install a demonstration version of Matrikon Analytics Excel Reporter,
select the Yes option button. If the product is not required, select No.
Notes:
If you do not have Microsoft Excel installed on your machine, this screen is not
displayed. Instead, you are notified that your machine does not meet the
requirements needed to install Excel Reporter. You will need to exit the install, install
Excel, and then re-start the Micro Historian installation. For assistance, contact
A permanent Matrikon Analytics Excel Reporter license is not included with

MatrikonOPC Desktop Historian and must be purchased separately. Contact your
Account Manager for assistance and more information.
If you have OPC2XL installed on your machine, and you select the Yes option,
OPC2XL will be removed during the install of this demonstration version.
25. Click on the Next button. The MatrikonOPC Trender screen (Figure 131) appears.
195
Figure 131 - MatrikonOPC Trender Screen
26.If you would like to install a demonstration version of MatrikonOPC Trender, select the Yes
option button. If the product is not required, select No.
Notes:
If the Sun Java Virtual Machine option on your machine is enabled, this screen is not
displayed. Instead, you are notified that your machine does not meet the
requirements needed to install Trender. You will need to exit the install, clear the
option, and then re-start the Micro Historian installation. For assistance, contact
A permanent MatrikonOPC Trender license is not included with MatrikonOPC Micro

Historian and must be purchased separately. Contact your Account Manager for
assistance and more information.
27. Click on the Next button. The Ready to Install screen (Figure 132) appears.
196
Figure 132 - Ready to Install Screen
28. Click on the Next button. The Installing MatrikonOPC Desktop Historian screen (Figure
133) appears, installation begins, and the product files are copied to the computer.
Note: Prior to starting the installation, you have the option of clicking on the Back button
to change any of the installation information. Click on the Cancel button if you wish to stop
or cancel the installation.
197
Figure 133 - Installing MatrikonOPC Server Screen
29. When the installation has finished, the MatrikonOPC Desktop Historian Setup Complete
screen (Figure 134) appears stating that the MatrikonOPC server has been successfully
installed.
198
Figure 134 - MatrikonOPC Server Setup Complete Screen
30. At this point, you have the option of launching any or all of the following by selecting the
necessary checkbox or checkboxes:
Configuration panel
Release Notes
Users Manual
Quick Start Guide
31. Click on the Finish button to complete the installation and exit the Wizard.
32. The necessary files have now been copied to the target computer, the software components
are registered, and shortcut icons are created in the Start menu.
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.
199
Appendix F
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 73 are installed by default, in the following location:
C:\Program Files\Matrikon\OPC\Desktop Historian
File Name
Description
Licensing Procedures for Desktop

Historian.pdf
Licensing Procedures for Desktop Historian.
Licensing Procedures for ODBC.pdf
Licensing Procedures for ODBC Server and FileCollector.

Quick Start.pdf
Quick Start Guide for this product.

Release Notes.pdf
Release Notes document for this product.
MatrikonOPC Desktop Historian User

Manual.pdf
OPC Desktop Historian Users Manual.
Table 73 - Files Installed in Desktop Historian Folder
C:\Program Files\Matrikon\OPC\Desktop Historian\Core
File Name
Description
Log\
Archiver log information.
ArchiveDB.dll
ODH Archive Database.
ArchiveDBps.dll
ODH Archive Database.
Archiver.exe
ODH Core Archive Executable.
ArchiverCoreNode.dll
User Interface for System Settings.
archiverps.dll
ODH Core Archive Proxy Stub.
ArchiverStorageEngineNode.dll
User interface for Data Store Engine tab in ODH.
ArchiverTagnode.dll
User Interface for Data Collection Settings.
CodeTranslator.dll
Error Code Translation Library.
CodeTranslatorps.dll
Error Code Translation Library.
DesktopHistorian.iC
iC Configuration Interface.
lsapiw32.dll
Licensing DLL.
RmsApiProxy.dll
Licensing Engine file.
security.cfg
Security Settings.
StorageEngine_FF4.dll
Storage Engine File Format 4.
StorageEngine_FF7.dll
Storage Engine File Format 7.
StorageEngineConfigps.dll
Storage Engine Configuration Library.
StorageEngineps.dll
Storage Engine Library.
200
File Name
Description
SysMatLogEx.dll
Log Library.
SysMatLogExps.dll
Log Library file.
TagDB.dll
Tag Database Library.
TagDBps.dll
Tag Database Library.
UnLicensedNode.dll
User Interface for Unlicensed Product.
UserDB.dll
User Database Library.
UserDBps.dll
User Database Library.

Table 74 - Files Installed in "Core" Folder
C:\Program Files\Matrikon\OPC\Desktop Historian\Database
File Name
Description
Archive_20030827052840.ECF
Holds the information about the storage engine type, location, and
configuration.
Attribute_20080327150700.ECF
Holds the list of configurable attributes for each item (i.e., not the
attribute values, just the meta information about the attribute
itself).
Tag_20090507192209.ECF
Holds the final version of the configured tags on clean ODH

shutdown for future use.
Tag_20120416215101.ELF
Holds the tags and the attribute values for the tags
User_20030527183812.ECF
This is intended for user access control and holds defaults included
with the install.
Table 75 - Files Installed in "Database" Folder
C:\Program Files\Matrikon\OPC\Desktop Historian\OPC Client
File Name
Description
Log\ ArchiverOPC.log
ArchiverOPC Log information.
ArchiverOPC.exe
ODH OPC Client Executable.
ArchiverOPCClientConfigControl.dll
User Interface for ODH OPC Client.
lsapiw32.dll
Licensing DLL.
ProductInfoChannelControl.dll
User Interface for Product Information.
security.cfg
Security Settings.
Table 76 - Files Installed in "OPC Client" Folder
201
C:\Program Files\Matrikon\OPC\Desktop Historian\OPC Server
File Name
Description
Plugins\Calculations\SimpleMath.dll
Plugins\Couriers\
Resources\CalcEngineServerResource\EN.res
Resources\CalcEngineServerResource\EN_CA.res
Resources\CalcEngineServerResource\root.res
Resources\CoreLibraryResource\EN.res
Resources\CoreLibraryResource\EN_CA.res
Resources\CoreLibraryResource\root.res
Resources\NetPortalQueryServerResource\EN.res
Resources\NetPortalQueryServerResource\EN_CA.res
Resources\NetPortalQueryServerResource\root.res
Resources\OpcDataDeliveryResource\EN.res
Resources\OpcDataDeliveryResource\EN_CA.res
Resources\OpcDataDeliveryResource\root.res
Resources\ProcessNetDataDeliveryResource\EN.res
Resources\ProcessNetDataDeliveryResource\EN_CA.res
Resources\ProcessNetDataDeliveryResource\root.res
Resources\SchedulerResource\EN.res
Resources\SchedulerResource\EN_CA.res
Resources\SchedulerResource\root.res
Resources\SimpleMathResource\EN.res
Resources\SimpleMathResource\EN_CA.res
Resources\SimpleMathResource\root.res
AliasControl.dll
Altova.dll
AltovaXML.dll
CalcEngine.dll
CalcEngineResource.dll
CalcEngineServerPS.dll
CalcEngineWrapper.dll
CalculationGraph.dll
clipsdll.dll
DotNetControlsLib.dll
icudt40.dll
icuin40.dll
icuuc40.dll
LogOptions.dll
js32.dll
log4cxx.dll
PreRegistration.LOG
ProcessNetDataDelivery.dll
Scheduler.dll
ScriptLibrary.dll
xerces-c_2_8.dll
Calculation Engine binary files.
ACL.sec
Access control list containing users
202
File Name
Description
and permissions configured for the
server.
ACLSecure.exe
Command-line security utility used to

encrypt/decrypt the ACL file.
AliasCalculationLib.dll
MatrikonOPC Calculation Engine

wrapper.
AliasControl.dll
OPC server alias configuration panel

DLL.
ProgID.txt
Security information file used by the

encryption utility.
DefaultConfig.xml
Retains Alais configuration information

on server restart.
OPCMatArc.exe
ODH OPC Server Executable.
OptionChannelControl.dll
OPC server Channel Control panel DLL.
RmsApiProxy.dll
Licensing Engine file.
security.cfg
Security settings.
ServerConfigControl.dll
OPC server configuration control panel

DLL.
ServerOpts.ini
OPC Server Option files.

Table 77 - Files Installed in "OPC Server" Folder
C:\Program Files\Matrikon\OPC\Desktop Historian\Task Scheduler
File Name
Description
Log\ TaskScheduler.log
TaskScheduler log information.
LogOptions.dll
User Interface for Logging Options.
security.cfg
Security Settings.
TaskScheduler.exe
ODH Task Scheduler Service.
TaskScheduler.ic
IC file for Task Scheduler.
TaskSchedulerControl.dll
User Interface for the Backup Utility (Task Scheduler).
Table 78 - Files Installed in "Task Scheduler" Folder
The files listed in Table 79 are stored in the following directory:

C:\Program Files\Matrikon\OPC\Desktop Historian\Util
File Name
7z.dll
Description
Zip utility for backup functionality.
203
File Name
Description
Command-line tool for backing up stored data.
BackupTool.exe
Table 79 - Files Installed in "Util" Folder
Note: If Microsoft Excel is present on the machine, the file listed in Table 80 is installed by
default in the following location:
C:\Program Files\Matrikon\OPC\Desktop Historian\Util
File Name
Description
Tag Manager Excel Add-in.
TagMgr.xll
Table 80 - Files Installed in "Util" Folder
The files listed in Table 81 are installed in the systems Global Assembly Cache
(C:\WINDOWS\assembly):
File Name
Description
Syncfusion.Core.dll
Syncfusion Library, Version 4.401.0.51
Syncfusion.Core.dll
Syncfusion.Edit.Windows.dll
Syncfusion.Edit.Windows.dll
Syncfusion.Grid.Base.dll
Syncfusion.Grid.Base.dll
Syncfusion.Grid.Windows.dll
Syncfusion.Grid.Windows.dll
Syncfusion.Shared.Base.dll
Syncfusion.Shared.Base.dll
Syncfusion.Shared.Windows.dll
Syncfusion.Shared.Windows.dll
Syncfusion.Tools.Base
Syncfusion.Tools.Base
Syncfusion.Tools.Windows.dll
Syncfusion.Tools.Windows.dll
Table 81 - Files Installed in Global Assembly Cache
C:\Program Files\Common Files\MatrikonOPC\Common
File Name
Description
ACLConfig.exe
MatrikonOPC Tag Security Configuration Utility

that configures tag-level security in MatrikonOPC
servers.
ClientToolkit.dll
ClientToolkit.dll
204
File Name
Description
DotNetControlsLib.dll
Common controls file.
EULA.pdf
License document.
EventLogger.dll
EventLogger.dll
iC.exe
MatrikonOPC Product Configuration Utility.
LicenseRemover.exe
License Removal Utility.
LicenseWizard.exe
License Wizard Utility.
LogLibrary.dll
LogLibrary.dll
Marshal.exe
Marshal.log
Marshal.log.bak
Marshal backup log file.
Moces.log
Log file for MatrikonOPC iC configuration tool.
MocesInterfaces.dll
MatrikonOPC Product Configuration Library.
MTKAuthorize.exe
To detect hardware license for ODH.
ODH.ver
MatrikonOPC Desktop Historian version file.
OEM_Matrikon_OPC.dll
MatrikonOPC OEM Badge Library.
OPCAuto.dll
MatrikonOPC Automation Component enables

developers to access OPC data from client
applications developed using Automation tools
such as Visual Basic, VBA, and VB Script.
opcda20_auto.doc
MatrikonOPC Automation Component Interface

Standard
OPCDAAuto.dll
MatrikonOPC Automation Component enables

developers to access OPC data from client
applications developed using Automation tools
opchda10_auto.doc
Developer documentation for the HDA

Automation Component.
opchda_ps.dll
The proxy-stub file to allow OPC Clients to make

remote connections to an OPC HDA server.
OPCHDAAuto.dll
MatrikonOPC HDA Automation Component

enables developers to access OPC HDA data from
client applications developed using Automation
tools.
PSTCFG.exe
PSTCFGInterface.dll
MatrikonOPC Product Configuration Library.
PSTcfgps.dll
MatrikonOPC Product Configuration Marshalling

Library.
PSTCFGMatrikon.OPC.DesktopHistorian.1.log
ODH log information.
205
File Name
Description
PSTCFGMatrikon.OPC.DesktopHistorian.1.log.bak
ODH log information backup.
Table 82 - Files Installed in "Common" Folder
The files listed in Table 83 are installed in the WINDOWS\system32 folder:

File Name
Description
EXPREVAL.DLL
Expression Evaluation Library for Alias Equations.
OPC_AEPS.DLL
OPC Alarms and Events 1.0 Interfaces Marshalling Library.
OPCBC_PS.DLL
OPC Batch Custom 2.00 Proxy/Stub Library.
OPCCOMN_PS.DLL
OPC Common Interfaces and Marshalling Library.
OPCDAAuto.dll
MatrikonOPC Automation Component enables developers to access

OPC data from client applications developed using Automation tools
OPCDXPS.DLL
OPC Data eXchange 1.00 Proxy/Stub Library.
OPCENUM.EXE
OPC Server List Component.
OPCHDA_PS.dll
OPC Historical Data Access 1.20 Proxy/Stub Library.
OPCPROXY.DLL
OPC Data Access 2.0 and 1.0a Interfaces and Marshalling Library.
OPCSEC_PS.DLL
OPC Security 1.00 Proxy/Stub Library.
ACTXPRXY.DLL
ActiveX Interface Marshalling Library.

Table 83 - Files Installed in "system32" Folder
206
Appendix G
Un-Installation
To successfully un-install MatrikonOPC Desktop Historian, using the Add or Remove Programs
from the Microsoft Windows Control Panel is recommended.
Note: Matrikon strongly recommends that you back up all history and
configuration files prior to upgrading or re-installing the software.
To un-install MatrikonOPC Desktop Historian:
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 (Figure 135) is displayed.
4. Scroll through the list of currently installed programs and updates to find and select
MatrikonOPC Desktop Historian.
Figure 135 Add or Remove Programs
5. Click on the Remove button associated with the MatrikonOPC Desktop Historian program to
initiate the un-install process.
207
6. The MatrikonOPC Desktop Historian InstallAware Wizard appears, and the

Welcome to MatrikonOPC Desktop Historian Maintenance screen (Figure 136) is
displayed.
Figure 136 - Welcome to MatrikonOPC Desktop Historian Maintenance Screen
7. Select the Remove option button to un-install MatrikonOPC Desktop Historian entirely.
8. Click on the Next button. The Ready to Uninstall screen (Figure 137) is displayed.
208
Figure 137 - Ready to Uninstall Screen

10. The Uninstalling MatrikonOPC Desktop Historian screen (Figure 138) appears and the
un-install takes place.
209
Figure 138 - Uninstalling MatrikonOPC Desktop Historian Screen
11. When the un-install has finished, the MatrikonOPC Desktop Historian Setup Complete
screen (Figure 139) appears stating that MatrikonOPC Desktop Historian was successfully
un-installed.
210
Figure 139 - MatrikonOPC Desktop Historian Setup Complete Screen
12. Click on the Finish button to complete the un-install and exit the Wizard.
13. The program no longer appears listed in the Add or Remove Programs window.
211
Appendix H
File Formats
A file format defines how historical data is placed in a data file. Each file format offers trade-offs
between performance and space requirements.
Note: File formats are NOT interchangeable. Data stored in files that
do not conform to the current file format will not be available. It is
recommended that the file format be selected once and that is when
the product is installed. If you need to convert data from one file
format to another, contact MatrikonOPC Support.
High Resolution Rolling Buffer (FF4)

Note: FF4 is not a file format option unless an upgrade of Desktop
Historian is performed over a previous version where FF4 is currently
selected as the storage format. Support for the FF4 format is going to
be removed in future versions of Desktop Historian, in favour of FF7R.
It is recommended that users of FF4 consider upgrading their
configurations to FF7R. It should be noted, however, that switching
from FF4 to FF7R makes data collected in FF4 unavailable for reading.
Once the switchover is completed you cannot revert to FF4.
A Rolling Buffer file format uses a constant amount of disk space. The specific amount of disk
space used is defined by the user, and is allocated as 25 MB files when the system starts. Up to
15,000 rolling files can be configured.
The files of a rolling buffer are filled, one at a time. Once a specific file becomes full, it is closed,
and the next file will begin to fill. Once all files are filled, the oldest file is erased, and reused.
The High Resolution Rolling Buffer rounds the timestamp of historical data samples, to the nearest
millisecond. This would result in a historical data sample approximately 21 to 27 bytes in size (per
item). For example, 1,000 units would require 1,000 x 21 to 27 bytes in size.
Limitations:
The High Resolution Rolling Buffer file format does not support String data types. If String
data is required then MatrikonOPC Desktop Historian must be configured to use FF7.
The High Resolution Rolling Buffer file format only supports data insertion via the OPC Insert
method and will reject all calls to the OPC InsertReplace method.
High Resolution Rolling Buffer (FF7R)

A Rolling Buffer file format uses a constant amount of disk space. The specific amount of disk
space used is defined by the user, and is allocated as 25 MB files when the system starts.
The files of a rolling buffer are filled one at a time. Once a specific file becomes full, it is closed and
the next file begins to fill. Once all files are filled, the oldest file is erased, and reused.
The High Resolution Rolling Buffer rounds the timestamp of historical data samples to the nearest
item). For example, 1,000 units would require 1,000 x 11 to 15 bytes in size. String data is larger
and can be calculated as 15 + (2 x string length) bytes.
212
Limitations:
The maximum string length supported in FF7 storage format is 2,033 characters. If the
input string length is longer than 2,033 characters, the string is truncated before being
stored.
The High Resolution Rolling Buffer file format supports only data insertion via the OPC Insert
method and will reject all calls to the OPC InsertReplace method.
The 25MB file size is not strictly enforced. If data is written to Desktop Historian that is
older than the latest data written (i.e., back filling), then the data files may grow to exceed
the target 25 MB.
If the .DAT file size is greater than 3.5 GB, or the data point time stamp is too far in the
future when compared to the (latest time stamp + configured offset time), the data is
rejected and recorded in a .CSV file for future use. The .CSV file is located in C:\matrikon
data\Exempt_FF7R.
Dynamic File Creation (FF7)

A Dynamic File Creation file format does not consume any initial disk space. Disk space will be
allocated only when the Desktop Historians data collector (OPC Client) receives new data samples.
Each data file will contain a block of historical data sample that lies within a constant time range,
which has been defined by the user. If a data sample does not belong in any existing file, then a
new file is created.
The Dynamic File Creation format rounds the timestamp of historical data samples to the nearest
item). String values may be stored in an FF7 file and require 15 + (2 x string length) bytes for
storage.
The total file size can be calculated as follows:
Total file size (non-strings) = 15 [bytes/value] * (number of values per second) *
60[seconds/minute] * (number of minutes per file) * 1.1 [overhead factor of 10%]
Total file size (strings) = (15+2*string length) [bytes/value] * (number of values per second)
* 60[seconds/minute] * (number of minutes per file) * 1.1 [overhead factor of 10%]
For Example:
If the configuration is configured with 5000 integer tags with 1 second update rates and the
maximum file contents is 60 minutes then the total file size will be approximately 284MB.
297000000 bytes = 15 [bytes/value] * 5000[values/second] * 60[seconds/minute]
* 60[minutes] * 1.1 [overhead factor of 10%]
Limitations:
The maximum string length supported in FF7 storage format is 2,033 characters. If the
input string length is longer than 2,033 characters, the string will be truncated before being
stored.
The maximum file size must be configured to be less than 4 GB. The data points are
rejected when the file size exceeds 3.5 GB and the rejected data points are stored in the
.CSV file for future use. The .CSV file is located in C:\matrikon data\Exempt_FF7.
213
Appendix I
Name
Attributes
Data Type
Description
Description
String
Describes the tag.
Engineering Units
String
The tags units.
Stepped
Boolean
Determines whether historical data should be

displayed as stepped or interpolated.
Archiving
Boolean
Determines whether the system is currently recording

data for the tag.
Node Name
String
The source machine for this tag.
Process Name
String
The source process for this tag. If the source is OPC,

this represents an OPC Server.
Source Name
String
The source name of the tag. If the source is OPC, this

represents an Item ID.
Source Type
String
What sort of source provides data for this tag. The

default source is OPC.
Normal Maximum
Floating Point
The upper limit for the tags normal value range.

Values collected that are above this value will be
replaced with the normal maximum
Normal Minimum
Floating Point
The lower limit for the tags normal value range.

Values collected that are below this value will be
replaced with the normal minimum.
Floating Point
The changed amount must be greater than the

exception deviation value for the new tag value to be
recorded. This is ignored if the Deviation Type is
disabled.
Exception Deviation Value
Determines whether the Exception Deviation

Algorithm is:
Exception Deviation Type
Integer
An absolute change.
A percentage change of the High/Low span.
A percentage change from the previous value.
Ignored/disabled.
By default, Exception Deviation is disabled.

High Limit
Floating Point
Highest valid value for a tag top of span. Values

outside the range bound by the High and Low limit
will not be archived.
Low Limit
Floating Point
Lowest valid value for a tag bottom of span. Values

outside the range bound by the High and Low limit
will not be archived.
Array Index
Integer
Element of an array that this tag references (zero-
214
Name
Data Type
Description
based index).
Access Path
String
Provides additional item access details. Specific to

OPC.
Update Rate
Integer
The real-time update rate for the tag (in

milliseconds).
Boolean
Determines if the Desktop Historian computer system

clock time should be used instead of the OPC serverprovided time.
Timestamp Bias
Integer
The number of milliseconds (positive or negative)

that should be added to the timestamp to adjust for
differences between clocks.
Tag Lifetime Enabled
Boolean
Determines if the Tag Lifetime feature is enabled for a

tag.
Integer
If the Tag Lifetime feature is enabled, and a tag has

not had an updated value sent to the Desktop
Historian OPC client for this amount of time in
milliseconds, a read command will be used to obtain
an updated value.
String
Selects that the OPC client should use either

Synchronous IO (SYNC) or Asynchronous (ASYNC)
IO to read a tag for a lifetime update.
Table 84 - Attributes
215
Appendix J
Desktop Historian Data Types
Data Type
Description
NONE
Default empty
BOOL
1-byte Boolean (FF7 & FF7R storage formats only)
INT1
INT2
INT4
UINT1
1-byte unsigned signed integer
UINT2
UINT4
FLT4
4-byte real
FLT8
8-byte real (FF7 & FF7R storage formats only)
STR
Text (UNICODE) (FF7 & FF7R storage formats only)

Table 85 - Desktop Historian Data Types
216
Appendix K
Third-Party Licensing
Syncfusion Essential Studio 4.4.0.51

2001-2005 Copyright Syncfusion Inc.
217
Appendix L
Sample Custom Script
218
Appendix M
HDA Relative Time Format
Relative times are optionally used to specify the start and end times for a range of time that is of
interested for trending.
Relative times are specified using an optional keyword (Table 86) to indicate the starting point,
followed by one or more offsets that applied to that starting point. Relative times are always
applied with respect to the local time clock on the OPC HDA server providing the data. Uppercase
letters should be used, as per the HDA standard. However, the Backup Utility also accepts lower or
mixed case.
Keyword
Description
NOW
The current time. If no keyword is supplied, NOW is assumed.
SECOND
The start of the current second. For example, if the time is now 08:54:20.999,
then SECOND would choose a time of 08:54:20.000.
MINUTE
The start of the current minute.
HOUR
The start of the current hour.
DAY
The start of the current day.
WEEK
The start of the current week.
MONTH
The start of the current month.
YEAR
The start of the current year.

Table 86 - Keywords
Relative time offsets consist of a sign (e.g., + or -), an integer count, and an offset unit (Table 87).
If no sign is used between offsets, then the last sign used in the offset will be used. If no sign has
been used in the relative time string yet, the assumed sign is +.
Offset Unit
Description
Second
Minute
Hour
Day
Week
MO
Month
Year
Table 87 - Offset Units
Table 88 lists some sample relative times.

Relative Time
Example
Description
If NOW is 2008-01-02
6:30:27.525 AM UTC, then
NOW-1D
DAY-1D
Exactly one day ago from now.

Yesterday at 12:00 a.m.
2008-01-01 6:30:27.525 AM
2008-01-01 12:00:00.000 AM
DAY-1D+2H
2008-01-01 2:00:00.000 AM
219
Relative Time
Example
Description
If NOW is 2008-01-02
6:30:27.525 AM UTC, then
DAY-1D+2h+30M
DAY-1D+2H30M
Yesterday at 2:30 a.m. The second plus

sign (+) can be omitted because it is
assumed.
-1W
Equivalent to NOW-1W which is one week

ago from the current time.
2007-12-26 6:30:27.525 AM
Note that 2008-01-02 fell on a

Wednesday, and assuming the locale
starts the week on Sunday.
2007-12-30 12:00:00.000 AM
WEEK
Note that 2008-01-02 fell on a

Wednesday, and assuming the locale
starts the week on Sunday.
2007-12-23 12:00:00.000 AM
WEEK-1W
2008-01-02 5:00:27.525 AM
-1H30M
One hour and 30 minutes ago from now.

Since no keyword was provided, NOW
was assumed. The sign on 30M is
assumed to be negative (-) because that
was the last sign used. This is equivalent
to NOW-1H-30M.
SECOND-30M
Thirty minutes before the current second.
2008-01-02 6:00:27.525 AM
2008-01-01 2:30:00.000 AM
2008-01-01 2:30:00.000 AM
Table 88 - Relative Time Examples
220
Appendix N
HDA Aggregate Functions
The following HDA aggregate functions are available in the MatrikonOPC Desktop Historian:
Function
Description
Interpolative
Performs a straight line interpolation between the known data

points within the selected interval.
TimeAverage
Time weighted average data over the line produced by the

interpolative aggregate.
MinimumActualTime
The minimum raw GOOD value that occurs within the selected
interval. This value is returned with the time stamp at which it
occurs. If there are multiple occurrences, then the oldest time
stamp is returned.
Minimum
The same as the MinimumActualTime aggregate except that

the time stamp returned is the beginning of the selected
interval.
MaximumActualTime
The maximum raw GOOD value that occurs within the selected
interval. This value is returned with the time stamp at which it
occurs. If there are multiple occurrences, then the oldest time
stamp is returned.
Maximum
The same as the MaximumActualTime aggregate except that

the time stamp returned is the beginning of the selected
interval.
MatrikonAggregate_TrendFriendly
Interpolates both end points, divides the time between timeold

and timenew into intervals and returns the lowest or highest
value for each interval.
* timeold and timenew are the bounds of the selected interval.
Table 89 - HDA Aggregate Functions
221

OPC Desktop Historian Manual

Încărcat de

Informații document

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

OPC Desktop Historian Manual

Încărcat de

Drepturi de autor:

Formate disponibile

MatrikonOPC Desktop Historian

MatrikonOPC Desktop Historian

Document Revision History:

Updated for distribution. Changes to GUI. Excel

Added section of Refresh Tag List. Added

Added information regarding implementation of

Applied new template. Updated procedures, and

Added Tag Management toolbar functionality;

MatrikonOPC Desktop Historian v4.7.0 Users Manual

Changed versions to 3.3.0.0 for next release,

Added section about the backup tool, updated

Added content for the Backup GUI. Removed OPC

Replaced the following figures in Backup Utility

Added information for FF7 Rolling Buffer mode.

Made corrections for UI changes.

Added information regarding MatrikonOPC ODBC

Added information for Maximum Return Values

Added additional password information for Backup

Updated FF7 Configuration Options and FF4

MatrikonOPC Desktop Historian v4.7.0 Users Manual

Updated the following sections: Installed Files,

Updated Contacting Support section. Added Quick

Updated Software Requirements. Updated

Updated backup utility command line and GUI

Updated software version to 4.3.0.0. Updated the

Updated software version to 4.4.0.0. Updated

Limitations section updated to include a limitation

Updated software version to 4.4.1.0.

Updated Software Requirements section,

Updated software version to 4.4.2.0. Updated

Updated Software Requirements and Limitations

MatrikonOPC Desktop Historian v4.7.0 Users Manual

Updated software version to 4.4.3.0. Updated

Updated software version to 4.5.0.0. Updated

Full port to TFS. Updated software version to

Updated Software Requirements section and Log

Updated Software Release Version to 4.7.0.

MatrikonOPC Desktop Historian v4.7.0 Users Manual

MatrikonOPC Desktop Historian v4.7.0 Users Manual

Changing the Node Name and Process Name ...................................................................... 78

MatrikonOPC Desktop Historian v4.7.0 Users Manual

MatrikonOPC Desktop Historian Licensing....................................................................... 142

MatrikonOPC Desktop Historian v4.7.0 Users Manual

Figure 4 - Version Information Tab ................................................................................ 29

Figure 54 - Set Visible Attributes (First Approach) ......................................................... 86

- Defined Users and Groups ........................................................................

1 - Terms and Definitions......................................................................................

MatrikonOPC Desktop Historian v4.7.0 Users Manual

Table 12 - FF4 Configuration Options ............................................................................. 33

Table 62 - File Import/Export Field Descriptions.......................................................... 156

MatrikonOPC Desktop Historian v4.7.0 Users Manual

Who Should Use This Manual

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

Introduction this introductory chapter.

Getting Started provides system requirements information.

Data Collection Management shows how to customize data to be collected and

FileCollector information regarding the MatrikonOPC FileCollector component.

ODBC Server shows how to configure the ODBC server component.

Limitations provides information on specific performance and operational limitations of

Troubleshooting provides licensing, MatrikonOPC Support contact information, solutions

C Standard Data Types

J Desktop Historian Data Types

L Sample Custom Script

M HDA Relative Time Format