OPC Desktop Historian Manual PDF

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:
Document
Date Description Author
Version
2003-08-06 1.0 Initial document. THN
2003-09-15 1.1 – 1.7 Updated for distribution. Changes to GUI. Excel THN,
2005-10-18 Plug-in section added. Branding fixes. SML, IMF,
Screenshots updated. Updated with latest EJM, EW
screenshots for tag attributes. Updated with latest
screenshots. Updated data collection
management. Added OPC Client configuration.
2006-03-30 2.0 Added section of “Refresh Tag List”. Added EW

section on how to configure array elements.
Added
Added information regarding
section on OPC2XL andimplementation
OPC Trender of
2006-10-04 2.1 CAV
ReadProcessed
licensing. INTERP method.
Applied new template. Updated procedures, and

2007-01-12 3.0 LB
screenshots to reflect ODH software v3.0.1.0.
Added Tag Management toolbar functionality;

2007-10-09 4.0 added Tag Lifetime and Timestamp processing CGAP, LB
attribute descriptions; added Analyzer install
information to Installation section.
MatrikonOPC Desktop Historian v5.1.0 User’s Manual 2

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
2007-11-29 documentation for Trender and OPC2XL can be CGAP, LB,
4.1 – 4.8
2008-04-22 found. Updated the FF7 file size limitation for CHB
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.
Added section about the backup tool, updated
2008-08-26 5.0 CGAP
installation section.
Added content for the Backup GUI. Removed OPC
Compliance section. Updated screenshots to
2008-12-16 6.0 CGAP, LB
reflect Backup Utility. Added Appendix H – HDA
Relative Time Format.
Replaced the following figures in Backup Utility
2009-01-14 6.1 section with updated screenshots: 21, 35, 36, 39, CGAP
41, 43-45.
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
Added information regarding MatrikonOPC ODBC
2009-02-18 8.0 Server for OPC demo license in Installation and LB
Licensing section.
Added information for Maximum Return Values
2009-03-03 8.1 CHB
and Aggregate Overread features.
2009-03-17 8.2 Added additional password information for Backup CHB

Utility.
Updated FF7 Configuration Options and FF4
Configuration Options sections. Added a note to
Backup Utility section. Replaced Figure 36 Create
2009-04-28 9.0 New Scheduled Backup Wizard: Credentials and TM
Figure 45 Backup Now Wizard: Backup Operation
screenshots. Updated Command Line Options
section. Added item #8 to Limitations section.

Updated the following sections: Installed Files,
Contacting Support, FF7R Configuration Options,
OPC Server Configuration (Server Options page
components), Limitations. Added note to Data
2009-06-03 9.1 TM, LB
Storage Management – File Format Selection
section. Updated note in Appendix A – File
Formats – High Resolution Rolling Buffer (FF4)
section.
Updated Contacting Support section. Added Quick

2009-06-12 9.2 LB
Start Guide to Installed Files section.
Updated Software Requirements. Updated
introductory notes in File Format Selection.
Updated FF7R Configuration Options. Updated FF4
Configuration Options. Added introductory
2009-06-26 9.3 TM
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.
Updated backup utility command line and GUI
sections to include the restore feature. Removed
DEP settings note from Installation section.
2009-08-24 10.0 CGAP, LB
Updated Installation section to include demo
install of Matrikon Analytics Excel Reporter.
Updated introduction in Appendix D – DCOM.
Updated software version to 4.3.0.0. Updated the
2009-09-03 11.0 OPC server configuration section to include new CGAP
settings.
Updated software version to 4.4.0.0. Updated

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

2009-10-22 12.1 LB
regarding restore functionality.
2010-02-03 13.0 Updated software version to 4.4.1.0. CB, LB

Updated Software Requirements section,
OPC/data naming convention changed, replaced
2010-02-12 13.1 CB, LB
the screenshots for the following figures: 50, 51,
60, 67.
Software Requirements, Licensing, Contacting
2010-09-01 14.0 Support, Troubleshooting, and Limitations BP, LB
sections. Updated note in Tag Manager – Excel
Plug-In section.
Updated Software Requirements and Limitations

2010-09-03 14.1 BP, LB
sections.

2012-01-10 15.0 MRP, LB
Software Requirements and Limitations sections.
2012-05-07 16.0 FF7R configuration options. Updated user LB
documentation suite to appropriate template.
Full port to TFS. Updated software version to
4.6.0. Updated Software Requirements and
2012-08-17 17.0 LB
Limitations sections, Appendix F – Installed Files,
and Appendix H – File Formats.
Updated Software Requirements section and Log

2013-03-07 17.1 Settings screen shot. SG
Added Appendix N HDA Aggregate Functions.
2013-04-29 17.2 Updated software release version to 4.6.1. SG
2013-07-29 17.3 Updated software release version to 4.6.2. MK
Updated software release version to 5.0.0. New

sections added are Importing and Exporting tags
from and to CSV files, Managing Desktop
Historian Instances, Scheduled Transfers,
Scheduled Transfer Redundancy, Redundancy
Overview, Configuration Settings, No
2014-06-06 18.0 Redundancy, Primary Node Configuration, Backup SN, AC
Node Configuration, Redundancy Status, Manually
Synchronizing the Configuration, Saving and
Loading Scheduled Transfer Configurations,
Connecting to another Desktop Historian
Instance. Updated Contacting Support and
Appendix F – Installed Files section.
2017-01-16 19.0 Updated software release version to 5.1.0. MB

SOFTWARE VERSION
Version: 5.1.0
DOCUMENT VERSION
Version: 19.0
COPYRIGHT INFORMATION
© Copyright 1997 - 2017, Matrikon International, a business unit of Honeywell Limited (“Matrikon International” or
“Matrikon”). 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 license insofar as they are
incorporated into a contract or license 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 licenses.
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 Honeywell International Inc.

Table of Contents
Introduction ................................................................................................................... 17
Who Should Use This Manual ............................................................................................ 17
Overview of Manual ......................................................................................................... 17
References ..................................................................................................................... 19
Document Terminology .................................................................................................... 19
Getting Started............................................................................................................... 21
System Requirements ...................................................................................................... 21
Software Requirements ................................................................................................. 21
Hardware Requirements ................................................................................................ 22
Configuration ................................................................................................................. 23
Launching the MatrikonOPC Desktop Historian .................................................................... 23
Configuration Window ...................................................................................................... 23
Toolbar........................................................................................................................ 25
File Menu ..................................................................................................................... 26
Edit Menu .................................................................................................................... 26
View Menu ................................................................................................................... 27
Window Menu .............................................................................................................. 28
Help Menu ................................................................................................................... 28
Starting and Stopping MatrikonOPC Desktop Historian ......................................................... 28
Generic Management ...................................................................................................... 30
Log Settings ................................................................................................................... 30
Version Information ......................................................................................................... 32
Data Storage Management ............................................................................................. 33
File Format Selection ....................................................................................................... 34
FF7 Configuration Options ................................................................................................ 34
FF7R Configuration Options .............................................................................................. 35
Backup Utility ................................................................................................................. 36
Schedule Backup Operation .............................................................................................. 38
Modify Backup Operation .................................................................................................. 52
Remove Backup Operation ................................................................................................ 55
Perform Backup Now ........................................................................................................ 57
Restore Backup ............................................................................................................... 58
Backup Utility Logging Options .......................................................................................... 60
Version .......................................................................................................................... 63
Command Line Use .......................................................................................................... 64
Accessing the Command Line ......................................................................................... 64
Command Line Options ................................................................................................. 64
Data Collection Management .......................................................................................... 68
Tag Browser ................................................................................................................... 69
Server Browser ............................................................................................................... 70
Tag Workspace ............................................................................................................... 72
Tag Management Toolbar .............................................................................................. 73
Tag Management Context Menu ..................................................................................... 74
Tag Status ................................................................................................................... 75
Importing tags from CSV files ........................................................................................... 76
Exporting tags to CSV files ............................................................................................... 77
Adding a Tag .................................................................................................................. 77
Removing a Tag .............................................................................................................. 78
Changing a Tag Attribute .................................................................................................. 79
Renaming a Tag .............................................................................................................. 80

Turning Tags On or Off ..................................................................................................... 81
Changing the Update Rate ................................................................................................ 81
Changing the Node Name and Process Name ...................................................................... 81
Invalid Attributes............................................................................................................. 82
Configuring Array Elements .............................................................................................. 83
Configuring Tag Lifetime and Timestamp Processing Attributes ............................................. 84
Refreshing the Tag List .................................................................................................... 86
Managing Desktop Historian Instances ............................................................................... 86
Adding Instance ........................................................................................................... 87
Removing Instance ....................................................................................................... 88
Renaming Instance ....................................................................................................... 89
Setting up security for an Instance ................................................................................. 89
Scheduled Transfer .......................................................................................................... 91
History Transfer Configuration ........................................................................................ 91
History Transfer Properties ............................................................................................ 92
Browse for HDA Servers ................................................................................................ 95
History Transfer Tag Mapping ......................................................................................... 95
Importing tag mappings ................................................................................................ 97
Exporting tag mappings ................................................................................................. 97
Scheduled Transactions Options ..................................................................................... 97
Scheduled Transfer Redundancy ..................................................................................... 99
Redundancy Overview ................................................................................................. 100
Configuration Settings ................................................................................................. 102
Configuring Redundancy Settings ................................................................................. 106
Manually Synchronizing the Configuration ...................................................................... 107
Saving and Loading Scheduled Transfer Configurations ...................................................... 107
Managing Historian Transfer Instances ............................................................................. 108
Adding Instance ......................................................................................................... 108
Removing Instance ..................................................................................................... 108
Renaming Instance ..................................................................................................... 109
Event Transactions ....................................................................................................... 110
Starting and Stopping Event Triggered Data Transfer ......................................................... 110
Event Transaction Configuration ...................................................................................... 110
Accessing Event Transaction Management ..................................................................... 114
Creating and Configuring an Event Source ..................................................................... 114
Creating and Configuring an Event Transaction ............................................................... 120
Changing an Event Transaction .................................................................................... 122
Removing an Event Transaction .................................................................................... 122
Viewing Transaction History ......................................................................................... 123
Clearing Transaction History ........................................................................................ 123
Refreshing Transaction History List ............................................................................... 124
Removing Item Mappings ............................................................................................ 124
Event Transaction Configuration Screen ........................................................................... 124
Transaction Options .................................................................................................... 125
Tag Mapping .............................................................................................................. 126
Loading and Saving Event Transaction Configurations ........................................................ 131
Options ........................................................................................................................ 131
Accessing Event Transaction Options ............................................................................. 133
Configuring Event Transaction Options .......................................................................... 133
Version Information ....................................................................................................... 134
Accessing Version Information ...................................................................................... 134
Customizing the Display ............................................................................................... 135
Tag Browser Docking ..................................................................................................... 135

Visible Attributes ........................................................................................................ 136
Colour Legend ............................................................................................................... 138
OPC Server Configuration ............................................................................................. 139
Alias Configuration ........................................................................................................ 139
Inserting Alias Groups ................................................................................................. 139
Adding New Aliases ..................................................................................................... 140
Editing Aliases ............................................................................................................ 160
Removing Aliases ....................................................................................................... 161
Removing Alias Groups ................................................................................................ 161
Cloning Aliases ........................................................................................................... 162
Exporting Aliases ........................................................................................................ 162
Importing Aliases........................................................................................................ 162
Expression Wizard ...................................................................................................... 163
Logging Options ............................................................................................................ 165
Version ........................................................................................................................ 167
Server Options .............................................................................................................. 168
OPC Client Configuration .............................................................................................. 171
Client Settings Tab ........................................................................................................ 171
Logging Settings Tab ..................................................................................................... 172
Version ........................................................................................................................ 174
FileCollector ................................................................................................................. 175
Tag Manager – Excel Plug-In ........................................................................................ 176
Installing Tag Manager Add-Ins ....................................................................................... 176
Connecting to Tag Manager ............................................................................................ 176
Loading Attributes ......................................................................................................... 177
Adding, Changing, and Deleting Tag Attributes .................................................................. 177
Renaming an Attribute ................................................................................................... 178
Loading Tags for Viewing ................................................................................................ 179
Filtering Tags ................................................................................................................ 179
Limiting Attribute Display ............................................................................................... 180
Adding OPC Tags ........................................................................................................... 180
Turning Tag Scanning On and Off .................................................................................... 181
Renaming a Tag ............................................................................................................ 182
Connecting to another Desktop Historian Instance ............................................................. 182
Diagnostics .................................................................................................................. 183
Logging ........................................................................................................................ 183
Limitations ................................................................................................................... 184
Troubleshooting ........................................................................................................... 186
Problems and Solutions .................................................................................................. 186
Questions and Answers .................................................................................................. 188
Licensing ...................................................................................................................... 192
MatrikonOPC Desktop Historian Licensing ...................................................................... 192
Licensing MatrikonOPC Easy Trender ............................................................................. 192
Licensing Matrikon Analytics Excel Reporter ................................................................... 192
Feature Licenses ......................................................................................................... 192
Contacting Support ........................................................................................................ 193

Table of Appendices
Appendix A Distributed COM (DCOM) ...................................................................... 194
DCOM Configuration Utility ............................................................................................. 194
Default Properties .......................................................................................................... 194
Security Permissions ...................................................................................................... 195
Server Identity .............................................................................................................. 199
Default Protocols ........................................................................................................... 199
Remote Program ID ....................................................................................................... 200
Appendix B Aliases .................................................................................................. 201
Scaling Expressions ....................................................................................................... 201
Advanced Calculations ................................................................................................... 202
CSV File Format ............................................................................................................ 204
Scaling Algorithms ......................................................................................................... 206
Appendix C Standard Data Types ............................................................................. 207
Appendix D Security ................................................................................................ 208
Introduction .................................................................................................................. 208
OPC Security Implementation ......................................................................................... 208
MatrikonOPC Tag Security Configuration Utility ................................................................. 209
Security Details ............................................................................................................. 229
Appendix E Installation ........................................................................................... 234
Appendix F Installed Files ....................................................................................... 250
Appendix G Un-Installation ..................................................................................... 258
Appendix H File Formats .......................................................................................... 263
High Resolution Rolling Buffer (FF7R) ............................................................................... 263
Dynamic File Creation (FF7) ............................................................................................ 263
Appendix I Attributes ............................................................................................. 265
Appendix J Desktop Historian Data Types ............................................................... 267
Appendix K Third-Party Licensing ............................................................................ 268
Syncfusion Essential Studio 4.4.0.51 ................................................................................ 268
Appendix L Sample Custom Script ........................................................................... 269
Appendix M HDA Relative Time Format .................................................................... 270
Appendix N HDA Aggregate Functions ..................................................................... 272
Appendix O MatrikonOPC Desktop Historian 5.1.x.x. or Higher Version Compatibility
Matrix ............................................................................................................. 273
Table of Figures
Figure 1 - Configuration Window .................................................................................... 24
Figure 2 - Windows Services Panel................................................................................. 29
Figure 3 - Log Settings Tab ............................................................................................ 31
Figure 4 - Version Information Tab ................................................................................ 32
Figure 5 - Data Storage Management Page .................................................................... 33
Figure 6 - FF7R Configuration Options ........................................................................... 36
Figure 7 - Backup Utility ................................................................................................. 38
Figure 8 - Create New Scheduled Backup Wizard: Backup Name .................................... 39
Figure 9 - Create New Scheduled Backup Wizard: Backup Operation ............................. 40
Figure 10 - Create New Scheduled Backup Wizard: Destination ..................................... 41
Figure 11 - Create New Scheduled Backup Wizard: Select Files ..................................... 42
Figure 12 - Create New Scheduled Backup Wizard: Select Files By Date ........................ 43

Figure 13 - Create New Scheduled Backup Wizard: Select Files By Date (Move or Delete
Operation Selected) ....................................................................................................... 43
Figure 14 - Date Editor Window ..................................................................................... 44
Figure 15 - Create New Scheduled Backup Wizard: Schedule Type ................................ 45
Figure 16 - Create New Scheduled Backup Wizard: Daily Schedule ................................ 46
Figure 17 - Create New Scheduled Backup Wizard: Weekly Schedule ............................. 47
Figure 18 - Create New Scheduled Backup Wizard: Monthly Schedule ........................... 48
Figure 19 - Create New Scheduled Backup Wizard: One Time Only Schedule ................. 49
Figure 20 - Create New Scheduled Backup Wizard: Credentials ..................................... 50
Figure 21 - Create New Scheduled Backup Wizard: Summary ........................................ 51
Figure 22 - Create New Scheduled Backup: Complete Month.......................................... 52
Figure 23 - Modify Scheduled Backup ............................................................................. 53
Figure 24 - Modify Scheduled Backup Wizard: Backup Name ......................................... 54
Figure 25 - Modify Scheduled Backup Wizard: Summary ................................................ 55
Figure 26 - Remove Scheduled Backup ........................................................................... 56
Figure 27 - Remove Scheduled Backup Confirmation ..................................................... 56
Figure 28 - Run Backup Now .......................................................................................... 57
Figure 29 - Backup Now Wizard: Backup Operation ....................................................... 58
Figure 30 - Restore Backup Wizard: Choose Source ....................................................... 59
Figure 31 - Restore Backup Wizard: Summary ............................................................... 60
Figure 32 – Logging Options Page .................................................................................. 61
Figure 33 - Backup Utility Version .................................................................................. 63
Figure 34 - Data Collection Management Page ............................................................... 68
Figure 35 - Tag Browser (with and without Flat Browse enabled).................................. 69
Figure 36 - Server Browser ............................................................................................ 70
Figure 37 - Advanced Tag Options Window .................................................................... 71
Figure 38 - Tag Workspace ............................................................................................. 73
Figure 39 - Tag Management Toolbar ............................................................................. 73
Figure 40 - Tag Management Context Menu ................................................................... 74
Figure 41 - Tag Status .................................................................................................... 75
Figure 42 - Data Collector State (showing Started and Stopped) ................................... 75
Figure 43 – Filter field .................................................................................................... 76
Figure 44 – Importing CSV file ....................................................................................... 76
Figure 45 – Import tags from file result ......................................................................... 76
Figure 46 - Tag Workspace showing Tags Marked for Deletion ...................................... 79
Figure 47 - Tag Workspace showing Changed Attribute ................................................. 80
Figure 48 - Changing Node Name and Process Name ..................................................... 82
Figure 49 - Invalid Attributes ......................................................................................... 83
Figure 50 - Configuring Array Elements ......................................................................... 84
Figure 51 - Lifetime and Timestamp Processing Attributes (with Lifetime Update Rate
Field Options Displayed) ................................................................................................ 84
Figure 52 - Refresh Tag List ........................................................................................... 86
Figure 53 – Desktop Historian Instances Manager ......................................................... 87
Figure 54 – Adding New instance ................................................................................... 88
Figure 55 – Removing Existing Instance ........................................................................ 88
Figure 56 – Renaming Existing instance ......................................................................... 89
Figure 57 – Setting up Security for an Existing Instance ................................................ 90
Figure 58 – Instance Version Dependent ProgId ............................................................ 90
Figure 59 – Instance Windows Services ......................................................................... 90
Figure 60 – Scheduled Transfer Component ................................................................... 91
Figure 61 – History Transfer Configuration .................................................................... 91
Figure 62 – History Transfer Properties ......................................................................... 93
Figure 63 – Browse for HDA Servers .............................................................................. 95

Figure 64 – History Transfer Tag Mapping ...................................................................... 96
Figure 65 – Browse Filter ............................................................................................... 96
Figure 66 – Scheduled Transactions Options .................................................................. 98
Figure 67 – Scheduled Transfer Redundancy................................................................ 100
Figure 68 - Typical Deployment for History Transfer Redundancy ................................ 101
Figure 69 - Scheduled Transfer Redundancy Page ........................................................ 103
Figure 70 - Redundancy Configuration Note ................................................................. 103
Figure 71 - Primary Node Configuration Settings ......................................................... 104
Figure 72 - Backup Node Configuration Settings .......................................................... 105
Figure 73 - Redundancy Status .................................................................................... 106
Figure 74 – History Transfer Instances Manager .......................................................... 108
Figure 75 – Adding New instance ................................................................................. 108
Figure 76 – Removing Existing Instance ...................................................................... 109
Figure 77 – Renaming existing instance ....................................................................... 109
Figure 78 – History Transfer Instance Windows Services ............................................. 109
Figure 79 - Windows Services Panel ............................................................................. 110
Figure 80 - Start Page (Event Transactions Node) ....................................................... 111
Figure 81 - Event Transactions Node Expanded ............................................................ 112
Figure 82 - Event Transaction Management Page ......................................................... 113
Figure 83 - Event Source Configuration Screen ............................................................ 115
Figure 84 - New Event Source ...................................................................................... 115
Figure 85 - New Event Condition .................................................................................. 117
Figure 86 - Event Source Configuration ........................................................................ 118
Figure 87 - Configured Event Source ............................................................................ 119
Figure 88 - Configured Condition .................................................................................. 120
Figure 89 - Transaction Configuration Screen .............................................................. 121
Figure 90 - Event Transaction Management (Transactions) ......................................... 122
Figure 91 - Event Transaction Management (Selected Transaction History)................. 123
Figure 92 - Mapped Items for Removal ........................................................................ 124
Figure 93 - Batch Capture Transaction Options ............................................................ 125
Figure 94 - Trip Capture Transaction Options ............................................................... 126
Figure 95 - Tag Mapping Editor .................................................................................... 127
Figure 96 - Historical Data Source ................................................................................ 127
Figure 97 - HDA Read Properties .................................................................................. 128
Figure 98 - Historical Data Destination ........................................................................ 128
Figure 99 - HDA Write Properties ................................................................................. 128
Figure 100 - Browse Filter ............................................................................................ 129
Figure 101 - Renaming a Tag ....................................................................................... 129
Figure 102 - Map Two Tags Together ........................................................................... 130
Figure 103 - Map Two Tags Together ........................................................................... 130
Figure 104 - Mapped Tags ............................................................................................ 130
Figure 105 - Event Transaction Options Page ............................................................... 132
Figure 106 - Event Transaction Version Information Panel .......................................... 134
Figure 107 - Tag Browser Title Bar ............................................................................... 135
Figure 108 - Auto-Hide Tag Browser Window ............................................................... 135
Figure 109 - Floating Tag Browser Window .................................................................. 136
Figure 110 - Set Visible Attributes (First Approach) ..................................................... 137
Figure 111 - Set Visible Attributes (Second Approach) ................................................ 138
Figure 112 - Colour Legend .......................................................................................... 138
Figure 113 - New Alias Group Window ......................................................................... 139
Figure 114 - Alias Configuration Page .......................................................................... 140
Figure 115 - Alias Configuration Wizard - Step 1: Alias Type ........................................ 141
Figure 116 - Alias Configuration Wizard - Step 2: Alias Identity................................... 142

Figure 117 - Browse OPC Tag Window ......................................................................... 143
Figure 118 - Alias Configuration Wizard - Step 3: Alias Properties ............................... 144
Figure 119 - Alias Configuration Wizard - Step 4: Scaling Algorithms .......................... 145
Figure 120 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Linear Scaling) 146
Figure 121 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Square Root
Scaling) ........................................................................................................................ 147
Figure 122 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Gain/Offset
Scaling) ........................................................................................................................ 148
Figure 123 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Expression Scaling)
..................................................................................................................................... 149
Figure 124 - Expression Wizard .................................................................................... 150
Figure 125 - Select Function Window ........................................................................... 151
Figure 126 - Select Variable Window ............................................................................ 151
Figure 127 - Alias Configuration Wizard - Step 5: Configure Alias Events ..................... 152
Figure 130 - Alias Configuration Wizard - Step 4: Alias Calculation .............................. 155
Figure 131 - Alias Configuration Wizard - Alias Events ................................................. 156
Figure 132 - Manage Events Categories Window .......................................................... 157
Figure 133 - New Event Category Window ................................................................... 158
Figure 136 - Function Parameter Window .................................................................... 164
Figure 137 - Operators Buttons .................................................................................... 165
Figure 138 - Logging Options Page .............................................................................. 165
Figure 139 - OPC Server Version Information Page ...................................................... 168
Figure 140 - Server Options Page ................................................................................. 169
Figure 141 - Client Settings Tab (OPC Client) ............................................................... 171
Figure 142 - Logging Settings (OPC Client) .................................................................. 173
Figure 143 - OPC Client Version Information Page ....................................................... 174
Figure 144 - Excel Title Bar .......................................................................................... 176
Figure 145 - Load Tags Window ................................................................................... 179
Figure 146 - Add OPC Tags Window ............................................................................. 181
Figure 147 – Desktop Historian Instance Selector ....................................................... 182
Figure 148 - Distributed COM Configuration Properties Window .................................. 196
Figure 149 - Distributed COM Configuration Security Tab ............................................ 197
Figure 150 - Registry Value Permissions Window ........................................................ 198
Figure 151 - Add Users and Groups Window ................................................................ 198
Figure 152 – Desktop Historian Instance Manager ....................................................... 210
Figure 153 - Enter Server Password Window ............................................................... 210
Figure 154 - MatrikonOPC Tag Security Configuration Utility Main Screen ................... 211
Figure 155 - MatrikonOPC Tag Security Configuration Utility Main Screen: Users & Groups
..................................................................................................................................... 212
Figure 156 - Add User Window (NT) ............................................................................. 213
Figure 157 - Defined Users and Groups ........................................................................ 214
Figure 158 - Add User Window (Private) ...................................................................... 215
Figure 159 - Add Group Window (NT) .......................................................................... 216
Figure 160 - Add Group Window (Private) ................................................................... 217
Figure 161 - Enter New Name Window ......................................................................... 217
Figure 162 - Edit <Username> Window (Permissions Tab) .......................................... 219
Figure 163 - Add Permission Screen (Server Address Space) ....................................... 220
Figure 164 - Add User Permission Window ................................................................... 221
Figure 165 - Add Permission Window: Browsing Server Address Space ....................... 222

Figure 166 - Edit <Username>: Example ...................................................................... 223
Figure 167 - Edit <Username> Window (General Tab) ................................................. 224
Figure 168 - Reset Password Window .......................................................................... 224
Figure 169 - Edit <Groupname> Window (Permissions Tab) ....................................... 225
Figure 170 - Edit <Groupname> Window (General Tab) .............................................. 226
Figure 171 - Edit <Groupname> Window (Members Tab) ............................................ 227
Figure 172 - Add Existing User Window ....................................................................... 228
Figure 173 - Change Password Window ....................................................................... 229
Figure 174 - InstallAware Wizard Verification Window ................................................ 234
Figure 175 - License Agreement Screen ....................................................................... 235
Figure 176 - Product Registration Screen ..................................................................... 236
Figure 177 - Setup Type Screen ................................................................................... 237
Figure 178 - Destination Folder Screen ........................................................................ 238
Figure 179 - Start Menu Screen .................................................................................... 239
Figure 180 - Enter Password Screen ............................................................................ 240
Figure 181 - Licensing Screen ...................................................................................... 241
Figure 182 - Matrikon Analytics Excel Reporter ............................................................ 242
Figure 183 - MatrikonOPC Easy Trender Screen ........................................................... 243
Figure 184 - MatrikonOPC Desktop Historian – Installation Type Screen ..................... 244
Figure 185 - MatrikonOPC OPC Tunneller ..................................................................... 245
Figure 186 - Ready to Install Screen ............................................................................ 246
Figure 187 - MatrikonOPC Desktop Historian - Pre-Requisites ..................................... 247
Figure 188 - MatrikonOPC Desktop Historian Pre-Requisites........................................ 248
Figure 189 - MatrikonOPC Desktop Historian Setup Complete Screen .......................... 249
Figure 190 – Add or Remove Programs ........................................................................ 258
Figure 191 - Welcome to MatrikonOPC Desktop Historian Maintenance Screen ............ 259
Figure 192 - Ready to Uninstall Screen ........................................................................ 260
Figure 193 - Uninstalling MatrikonOPC Desktop Historian Screen ................................ 261
Figure 194 - MatrikonOPC Desktop Historian Setup Complete Screen .......................... 262
Table of Tables
Table 1 - Terms and Definitions...................................................................................... 20
Table 2 - Configuration Window Components ................................................................. 24
Table 3 - Toolbar Items .................................................................................................. 25
Table 4 - File Menu Commands ....................................................................................... 26
Table 5 - Edit Menu Commands (Alias Group) ................................................................ 27
Table 6 - View Menu Commands ..................................................................................... 27
Table 7 - Window Menu Commands ................................................................................ 28
Table 8 - Help Menu Command ....................................................................................... 28
Table 9 - General Logging Options Settings Tab ............................................................. 32
Table 10 - FF7 Configuration Options ............................................................................. 34
Table 11 - FF7R Configuration Options ........................................................................... 35
Table 12 - Select Files Options ....................................................................................... 42
Table 13 - Select Files By Date Options .......................................................................... 44
Table 14 - Daily Schedule Options .................................................................................. 46
Table 15 - Weekly Schedule Options .............................................................................. 47
Table 16 - Monthly Schedule Options ............................................................................. 48
Table 17 - One Time Only Schedule Options ................................................................... 49
Table 18 - Logging Options Components ........................................................................ 63
Table 19 - General Options ............................................................................................. 65

Table 20 - Commands ..................................................................................................... 66
Table 21 - Valid Selections ............................................................................................. 67
Table 22 - Tag Browser Components .............................................................................. 70
Table 23 - Advanced Tag Options Window Components ................................................. 72
Table 24 - Tag Management Toolbar Components .......................................................... 74
Table 25 - Tag Management Context Menu Options ........................................................ 75
Table 26 - Timestamp and Lifetime Processing Attributes Descriptions ......................... 85
Table 27 - History Transfer Configuration Components .................................................. 92
Table 28 - History Transfer Properties ........................................................................... 95
Table 29 – Scheduled Transaction Options Components ................................................ 99
Table 30 - Primary Node Configuration Components .................................................... 105
Table 31 - Backup Node Configuration Components ..................................................... 106
Table 32 - Transaction Buttons .................................................................................... 113
Table 33 - Transaction History Buttons ........................................................................ 114
Table 34 - Condition Builder Fields ............................................................................... 118
Table 35 - Event Transaction Types .............................................................................. 125
Table 36 - Event Transaction Options Components ...................................................... 133
Table 37 - Alias Configuration Wizard - Alias Type Components ................................... 141
Table 38 - Alias Configuration Wizard - Step 2: Alias Identity Components .................. 142
Table 39 - Browse OPC Tag Window Components ........................................................ 143
Table 40 - Alias Configuration Wizard - Step 3: Alias Properties Components .............. 144
Table 41 - Alias Configuration Wizard - Step 4: Scaling Algorithms Component ........... 145
Table 42 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Linear Scaling) .... 146
Table 43 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Square Root Scaling)
Components ................................................................................................................. 147
Table 44 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Gain/Offset Scaling)
Components ................................................................................................................. 148
Table 45 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Expression Scaling)
Components ................................................................................................................. 149
Table 46 - Expression Wizard Components ................................................................... 150
Table 47 - Select Function Window Components .......................................................... 151
Table 48 - Select Variable Window Components ........................................................... 152
Table 49 - Alias Configuration Wizard - Step 5: Configure Alias Events ........................ 153
Table 52 - Alias Configuration Wizard - Step 4: Alias Calculation Components ............. 155
Table 53 - Alias Configuration Wizard - Alias Events Components ................................ 157
Table 54 - Manage Event Categories Window Components .......................................... 157
Table 55 - New Event Category Window Components .................................................. 158
Table 58 - Expression Wizard Options .......................................................................... 164
Table 59 – Logging Options Page Components ............................................................. 167
Table 60 - Server Options Page Components ................................................................ 170
Table 61 - Client Settings (Connection Settings) Tab Components ............................... 172
Table 62 - Client Settings (Data Buffer Settings) Tab Components .............................. 172
Table 63 - Logging Settings Tab Components ............................................................... 173
Table 64 - Feature Licenses .......................................................................................... 193
Table 65 - MatrikonOPC Support Regional Contact Information ................................... 193
Table 66 - After-Hours Support .................................................................................... 193
Table 67 - Expressions Constructs for Alias Scaling ..................................................... 202
Table 68 - Calculation Operators for Alias Scaling ........................................................ 203
Table 69 - Calculation Functions for Alias Scaling ........................................................ 204

Table 70 - File Import/Export Field Descriptions ......................................................... 205
Table 71 - Additional File Import/Export Field Descriptions - Linear/Square Root Scaling
..................................................................................................................................... 205
Table 72 - Additional File Import/Export Field Descriptions - Offset Scaling ................ 206
Table 73 - Additional File Import/Export Field Descriptions - Expression Scaling ........ 206
Table 74 - Additional File Import/Export Field Descriptions - Calculation Scaling ........ 206
Table 75 - Scaling Algorithms ....................................................................................... 206
Table 76 - Standard Data Types ................................................................................... 207
Table 77 - Default Tag Security .................................................................................... 231
Table 78 - Example 1 .................................................................................................... 232
Table 79 - Example 2: Permissions ............................................................................... 232
Table 80 - Example 2: Groups and Members ................................................................. 232
Table 81 - Files Installed in “Desktop Historian” Folder ............................................... 250
Table 82 - Files Installed in "Core" Folder .................................................................... 251
Table 83 - Files Installed in "Database" Folder ............................................................ 251
Table 84 - Files Installed in "OPC Client" Folder ........................................................... 251
Table 85 - Files Installed in "OPC Server" Folder ......................................................... 253
Table 86 - Files Installed in "Task Scheduler" Folder ................................................... 253
Table 87 - Files Installed in "Util" Folder...................................................................... 254
Table 88 - Files Installed in "Vigilant" Folder ............................................................... 254
Table 89 - Files Installed in " Historical Data Transporter" Folder ............................... 254
Table 90 - Files Installed in Global Assembly Cache ..................................................... 255
Table 91 - Files Installed in "Common" Folder ............................................................. 256
Table 92 - Files Installed in "system32" Folder ............................................................ 257
Table 93 - Attributes .................................................................................................... 266
Table 94 - Desktop Historian Data Types ...................................................................... 267
Table 95 - Keywords..................................................................................................... 270
Table 96 - Offset Units ................................................................................................. 270
Table 97 - Relative Time Examples ............................................................................... 271
Table 98 - HDA Aggregate Functions ............................................................................ 272
Table 99 - MatrikonOPC Desktop Historian Compatibility ............................................. 273

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.
Font displayed in this color and style indicates a hyperlink to the

BOLD applicable/associated information within this document, or if
applicable, any external sources.
The User’s Manual has been designed as such so that you can click on references in the document
to jump to that referenced point without having to scroll through several pages (in some cases).
For example, if you were to see the sentence “Refer to Figure 1 for more information”, pressing the
CTRL key and clicking your mouse on the text “Figure 1” automatically takes you to the location of
Figure 1 within the document.

This manual consists of several sections and is structured as follows:
 Introduction – this introductory chapter.
 Getting Started – provides system requirements information.
 Configuration – shows how to start and configure the 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 Historian’s OPC
server.
 OPC Client Configuration – shows how to configure Desktop Historian’s OPC client.
 FileCollector – information regarding the MatrikonOPC FileCollector 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 user’s 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
o B – Aliases
o C – Standard Data Types
o D – Security
o E – Installation
o F – Installed Files
o G – Un-Installation
o H – File Formats
o I – Attributes
o J – Desktop Historian Data Types
o K – Third-Party Licensing
o L – Sample Custom Script
o M – HDA Relative Time Format
o N – HDA Aggregate Functions

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 User’s Manual
 MatrikonOPC Easy Trender User’s 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.
Component Object Model. A method for organizing software, specifying how to
COM
build components that can be dynamically interchanged.
DA OPC Data Access. Provides access to real-time process data.
Distributed Component Object Model. An extension of COM that allows
DCOM
communication between COM components over a network.
Dynamic Data Exchange. Allows the transfer of data between two running
DDE
applications.
HDA OPC Historical Data Access. Provides access to historical process data.
Human Machine Interface. Device that allows interaction between the user and
HMI
machine. Typically used in process control applications.
Matrikon Matrikon International.
MatrikonOPC Matrikon’s brand name for its OPC servers and clients.
ODH MatrikonOPC Desktop Historian.
OPC A communication standard. Refer to www.opcfoundation.org for more

Term/Abbreviation Description
information.
PLC Programmable Logic Controller.
Table 1 - Terms and Definitions

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 User’s 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:
 Microsoft Windows 7 or
 Microsoft Windows Server 2008 R1 32Bit or
 Microsoft Windows 10, or
 Microsoft Windows Server 2012, or
 Microsoft Windows Server 2016
 Internet Explorer 6.0 (or better)
 Microsoft .NET Framework 2.0
 Desktop Historian needs to be run as a Windows service.
Note: 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.
For Matrikon Analytics Excel Reporter:

 Microsoft Excel 97, 2000, 2003, 2007, 2010, 2013 or Office 365
For Tag Manager:
 Microsoft Excel 97, 2000, 2003, 2007, 2010, 2013 or Office 365

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.
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 CORE i5 Processor
 4 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.

Configuration
The product’s 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 tool’s 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).

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.
Provides items that make navigation within a configuration easier. Refer to
Toolbar
Table 3 for more information.
Location Bar Allows you to track the current configuration’s location.
Displays a tree of configuration objects currently defined in the application.
Navigation Panel Select an object to display its current settings in the right-hand panel. This
panel is also referred to as the tree-view pane.
Displays the current settings of the item presently selected in the tree-view
Settings Panel
pane.
Table 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.
Command Description
Returns you to the previous configuration.
Back
Moves you to the next configuration history.
Forward
Selects the node in the navigation pane that is above the currently-
Up selected node.
New Configuration Note: This option does not apply to MatrikonOPC Desktop Historian.
Selecting this item (when it is enabled) allows you to create a new Alias
Group by accessing the New Alias Group window (Figure 113).
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
window’s navigation pane.
Selecting this item (when it is enabled) allows you to create a new Alias
by accessing the Alias Configuration Wizard (Figure 115).
This toolbar item is available only when you have selected either the Alias
New Alias
Configuration node, an existing Alias Group, or an existing Alias, in the
Configuration window’s navigation pane.
Select this item to display the Alias Configuration Wizard (Figure 115),
allowing you to edit an Alias Group or Alias.
Edit This toolbar item is available only when you have selected an existing
Alias in the Configuration window’s settings pane (i.e., pane on the right
side of the window).
Select this item to display the Alias Configuration Wizard (Figure 115),
allowing you to clone the selected Alias.
Clone This toolbar item is available only when you have selected an existing
Alias in the Configuration window’s settings pane (i.e., pane on the right
Selecting this item (when it is enabled) allows you to delete the selected
Delete node or item.
Select this item to display the Import Alias File window which allows you
Import to select the .csv file you wish to import.
Select this item to display the Export Alias File window which allows you
Export 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.
File Menu
Table 4 describes the File menu commands.
New Configuration This option does not apply to MatrikonOPC Desktop Historian.
Import Configuration This option does not apply to MatrikonOPC Desktop Historian.
Export Configuration This option does not apply to MatrikonOPC Desktop Historian.
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 113).
This menu option is available only when you have selected either the
New Group
Alias Configuration node in the Configuration window’s navigation
pane, or an existing Alias in the settings pane (i.e., pane on the right
Selecting this option allows you to create a new Alias by accessing the
Alias Configuration Wizard (Figure 115).
New Alias This menu option is available only when you have selected either the
pane, or an existing Alias in the settings pane.
Select this option to display the Alias Configuration Wizard (Figure
115), allowing you to edit the selected Alias.
Edit This menu option is available only when you have selected either the
Select this option to display the Alias Configuration Wizard (Figure
115), allowing you to clone the selected Alias.
Clone This menu option is available only when you have selected either the
Selecting this option allows you to delete the selected Alias in the
Delete Configuration window’s settings pane.
Select this option to display the Import Alias File window which allows
you to select the .csv file you wish to import.
Import From CSV
This menu option is available only when you have selected either the
Alias Configuration node or Alias Group in the Configuration

Command Description
window’s navigation pane, or an existing Alias in the settings pane.
Select this option to display the Export Alias File window which allows
you to select the .csv file you wish to export.
Export To CSV This menu option is available only when you have selected either the
Alias Configuration node or Alias Group in the Configuration
window’s 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.
When selected, displays the Location Bar below the Main Menu and above
the navigation pane. The Location Bar allows you to track the current
configuration’s location. By clicking on each segment of the Location Bar,
you can easily navigate to the required configuration screen.
Location Bar
Each segment of the Location Bar also provides a drop-down menu that
allows you to browse to the next available configuration. To access the drop-
down menu, click on the arrow on the right side of the required Location
Bar segment.
When selected, displays the navigation pane including the navigation tree.
Navigation Tree Allows you to efficiently browse through the available configuration of the
current product.
When selected, shows the available windows tabs at the bottom of the
Configuration window. Allows you to view all currently-open configurations.
Window Tabs The currently-open configurations may be organized with options offered in
the Windows menu from the Main Menu.
Note: This option is not selected by default.
Start Page When selected, shows the current product Start Page.
When selected, allows you to quickly navigate to previously-accessed

Go To configurations by moving Back, Forward, Up One Level, to another
window, and so on.
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 Description
Cascade Cascades the currently-opened windows within the configuration.
Horizontally arranges the currently-opened windows within the

Tile Horizontally configuration.
Tile Vertically Vertically arranges the currently-opened windows within the configuration.
Closes all currently-opened windows in the configuration. The product

Close All continues to run even with the windows closed.
Table 7 - Window Menu Commands
Help Menu
Table 8 describes the Help menu command.
Command Description
Displays an About screen, which includes information about the Integrated
About iC
Configuration (iC) configuration management system version.
Table 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 data-
serving 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

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

Figure 3 - Log Settings Tab
Table 9 describes the fields on the Log Settings tab.
Command Description
Log File Locations
Displays the default location where the system activity log file is
Diagnostic
saved. To save the log file in a different location, click Browse.
Displays the default location where the configuration activity log file
Configuration
is saved. To save the log file in a different location, click Browse.
Displays the default location where the log action file is saved. To
Audit
save the log file in a different location, click Browse.
Log Detail Level
Log system activity at the specified detail level (High, Medium,
Diagnostic
Low, or None). Higher log levels include lower-level activities
Log configuration activity at the specified detail level (High,
Configuration Medium, Low, or None). Higher log levels include lower-level
activities.
Audit Log actions committed by users at the specified detail level (Data

Command Description
Operations, Tag Operations, System Operations, or None).
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.
Limits the number of log-statements that may be entered into a log
Maximum Log File Size file. Once this file size is reached, earlier log-statements will be
erased, thus making room for more recent log statements.
Every log statement is immediately committed to the hard drive.
Disable Log Cache 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

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> Main Storage
2. Click on the Configure item displayed under the Main Storage 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.
Note: To change the Data Storage Management configuration setting for another
instance, select the appropriate instance under Data Storage Management (as shown in
Figure 5), then click on configure.

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
The directory in which to store the files. Defaults to
Historical data file directory
c:\Matrikon Data.
Indicates how much data should be stored in each
Store no more than [count] [units] of
file. Select the count and the units (weeks, days,
history in each file.
hours or minutes). Defaults to 2880 minutes.
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.
Close and finalize the active data file This item will automatically return to unchecked
when the operation is complete. After completion,
Desktop Historian opens a new file to store further
history.
Select this button to apply any changes made in the
Apply
current page.
Select this button to cancel all changes that have
Cancel
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
Historical data file directory
directory is c:\Matrikon Data.
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.
Store the history in [count] 25MB files
Maximum value = 15000 25 MB files (assuming
sufficient hard drive space exists). Defaults to two 25
MB files.
This field reports the amount of space available in 25
Maximum number of files for available
MB files. It is updated automatically when you change
space on hard drive
the Historical data file directory.
This field allows you to specify the maximum amount
of future timestamps allowed. This restricts invalid
Do not store values with timestamps future timestamps so that files no longer become
greater than corrupted and data loss is minimal.
Default = 10080 Minutes (1 Week)
Select this button to apply any changes made in the
Apply
current page.
Select this button to cancel all changes that have
Cancel
been made in the current page.
Table 11 - FF7R Configuration Options

Figure 6 - FF7R Configuration Options
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. When FF7R 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, 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 7 displays
the navigation pane and the Backup Utility pane.

Figure 7 - 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 7), click on the Schedule Backup Operation icon.
The Create New Scheduled Backup Wizard is displayed (Figure 8).
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.

Figure 8 - 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 9).

Figure 9 - 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 10) appears. If the Delete option is selected, the
Select Files screen (Figure 11) is displayed.

Figure 10 - 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 11).

Figure 11 - Create New Scheduled Backup Wizard: Select Files
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 12 for a description of each of the
options. See Figure 12 and Figure 13 for more details about the Select Files By Date
option.
Option Description
Selecting this option instructs the Backup Utility to choose all of the data files
All Non-Active 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.
Selecting this option includes all files in the directory.
All Files
Note: If the Move or Delete command is selected, this option is not available.
Selecting this option allows for the selection of data files according to the date
Select Files By Date range of data that they contain. Selecting this option causes the Select Files
screen to display the date selection options (Figure 12).
Table 12 - Select Files Options

Figure 12 - Create New Scheduled Backup Wizard: Select Files By Date
Figure 13 - Create New Scheduled Backup Wizard: Select Files By Date (Move or Delete Operation Selected)

Option Description
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.
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.
Select the comparison to use. For the Before and After options, only one of
Comparison the two date expression fields will be available. The Between option requires
entries in both of the date expression fields.
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
[date expression] expressions may be used or specific dates can be entered. For more
and [date information refer to Appendix M – HDA Relative Time Format in this
expression] manual.
Each of the fields has an ellipsis button adjacent which displays a form to
simplify the entry of these fields (Figure 14).
The active file is normally excluded from selections by date. If the Date,
Allow the active file Comparison, and date expression(s) include the active file, and this option is
to be selected by checked, then the Backup Utility includes the active file in the backup.
date Note: This option is not available if the Move or Delete operation is selected
(Figure 13).
Table 13 - Select Files By Date Options
9. If the ellipsis button for a time expression is selected, the Date Editor window 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 14 - 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 15).
Figure 15 - 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 20).
 Daily Schedule
 Weekly Schedule
 Monthly Schedule
 One Time Only Schedule
12. The Daily Schedule type (Figure 16) configuration screen has the options described in
Table 14.

Figure 16 - Create New Scheduled Backup Wizard: Daily Schedule
Option Description
The time of day to run the backup. The time of day will be formatted
Start Time according to the computers configured regional settings. Seconds, if
displayed, are ignored in the schedule.
The default option. When selected, the backup is performed every day at the
Every Day
selected Start time.
When selected, the backup is performed only on weekdays (Monday through
Weekdays
Friday), at the selected Start time.
When selected, the numeric selection box is enabled. Enter the period in days
Every [x] days
after each scheduled run before the next run should occur.
Start Date The date at which the schedule becomes active.
Table 14 - Daily Schedule Options
13. Click on the Next button to go to the Credentials screen (Figure 20).
14. The Weekly Schedule type configuration screen (Figure 17) has the options described in
Table 15.

Figure 17 - Create New Scheduled Backup Wizard: Weekly Schedule
Option Description
The time of day to run the backup. The time of day
will be formatted according to the computers
Start Time
configured regional settings. Seconds, if displayed,
are ignored in the schedule.
Defines whether the backup should be run every
Every [x] Weeks
week, every other week, every third week, etc.
Monday, Tuesday, Wednesday, Thursday, Select which day or days of the week on which the
Friday, Saturday, Sunday backup should run.
Table 15 - Weekly Schedule Options
16. The Monthly Schedule type configuration screen (Figure 18) has the options described in
Table 16.

Figure 18 - Create New Scheduled Backup Wizard: Monthly Schedule
Option Description
The time of day to run the backup. The time of day
will be formatted according to the computers
Start Time
configured regional settings. Seconds, if displayed,
are ignored in the schedule.
The day of the month on which the backup should
Day
run.
Select which week of the month and day of that week
The [ordinal] [weekday] on which the backup should run. For example, the
First Sunday, or the Second Tuesday.
Select which months in which the backup should run.
Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep,
The Select All and Clear All buttons will check or
Oct, Nov, Dec
uncheck, respectively, all of the months.
Table 16 - Monthly Schedule Options
18. The One Time Only schedule type configuration screen (Figure 19) has the options
described in Table 17.

Figure 19 - Create New Scheduled Backup Wizard: One Time Only Schedule
Option Description
Date The date on which the backup should be run.
The time of day to run the backup. The time of day will be formatted according
Time to the computers configured regional settings. Seconds, if displayed, are
ignored in the schedule.
Table 17 - One Time Only Schedule Options
20. The Credentials Panel (Figure 20) 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.

Figure 20 - 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 21) 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.

Figure 21 - 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 23).

Figure 22 - Create New Scheduled Backup: Complete Month
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 22). The Modify Scheduled Backup screen (Figure 23) appears.

Figure 23 - 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 7). Selecting the Modify button on any of the listed backups opens the
Modify Scheduled Backup Wizard on the Backup Name panel (Figure 24).
Note: The Backup Name cannot be changed when modifying a task.

Figure 24 - 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 23).
When you reach the Summary panel (Figure 25), the Finish button is available. Click on
the Finish button to commit the changes and return to the Modify Scheduled Task list
(Figure 23).

Figure 25 - 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 7). The Remove Scheduled Backup list (Figure 26) appears.

Figure 26 - Remove Scheduled Backup
2. Click on the Remove button associated with the backup you wish to remove. A confirmation
message (Figure 27) appears. Click OK to confirm the task deletion, or click on Cancel to
return to the Remove Scheduled Backup list (Figure 26).
Figure 27 - 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 7) is displayed with a confirmation message.

Perform Backup Now
The Perform Backup Now task is used to immediately run a backup operation.
To perform a backup operation immediately:
1. Click on the Perform Backup Now icon from the Backup Utility configuration screen
(Figure 7). The Perform Backup Now list is displayed (Figure 28).
Figure 28 - 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 item’s Create and Execute option was chosen, the Backup Now
Wizard is displayed showing the Backup Operation panel (Figure 29).

Figure 29 - 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 7).
2. The Restore Backup screen (Figure 30) appears.

Figure 30 - 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 11).
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 12
for a description of each of the options. See Figure 12 and Table 13 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 20) 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 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 21) 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 31 - 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 22). 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.

To view logging settings:
1. On the navigation pane of the Configuration window, select and expand the following
nodes:
 Desktop -> Localhost -> OPC Desktop Historian -> Backup Utility
2. Click on the Logging Options item displayed under the Backup Utility node. Figure 32
displays the navigation pane and Logging Options page.
Figure 32 – Logging Options Page
Table 18 describes the components of the Logging Options page.
Command Description
Selecting this checkbox enables general activity logging. If this
Enable server activity checkbox is not selected (i.e., the checkbox is cleared), none of the
logging 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.

Command Description
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
directory. Individual job logs are named [JobName].log. The
Filename
default path is: C:\Program Files\Matrikon\OPC\Desktop
Historian\TaskScheduler\Log\TaskScheduler.log.
Select this button to access the Open window which allows you to
Browse locate and select the necessary log file. The selected file is displayed
in the Filename field.
If enabled, selecting this checkbox ensures that the old log file is
overwritten each time the server starts up. Otherwise, the old log file
Overwrite old log is renamed with an underscore (_) prefix.
information If the Enable server activity logging checkbox is not selected
By default, this checkbox is cleared.
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:
Commit all log file writes
 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
Wrap log file if it exceeds checkbox is unavailable.
Filtered Log Settings
If this field is enabled, allows you to enter a match string for filtered
log.
Filter String
If this field is enabled, allows you to enter a full path for the filtered
log file.
Filename
Apply Use this button to commit any changes made on the Logging

Command Description
Options page.
Use this button to discard any changes made on the Logging
Cancel
Options page.
Table 18 - Logging Options Components
Version
This page is display only and shows OPC product version information.
To view Backup Utility version information:
nodes:
 Desktop -> Localhost -> OPC Desktop Historian -> Backup Utility
2. Click on the Version item displayed under the Backup Utility node. Figure 33 displays the
Version page.
Figure 33 - 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
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
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
-F
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.
Allows the Move and Copy commands to overwrite existing files in the
--OVERWRITE
destination folder, or to overwrite an existing zip file.
When there is an error moving or copying individual files, --CONTINUE will
--CONTINUE cause the command to report the error, but continue to process other selected
files.
This option indicates that the backup utility is being run in the background (by
the task scheduler).
--NONINTERACTIVE
The backup command overwrites files only if --OVERWRITE was specified,
and deletes or move files offline only if the --FORCE option was specified.
Specify a file to which to direct console text. Using the option forces, the
--OUT “output file” --NONINTERACTIVE option to be applied as well. If the specified output file
already exists, it will be overwritten.
Causes the –L, -RH, -RV and --RESTORE commands to list the information
--CSV
about each data file in a comma separated values format.
-?, -H Displays these usage directions.
Table 19 - 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.
Moves selected files to the destination path. Selected files will not be
-M "destination path"
available in the historian following this command.
Copies selected files to the destination zip file. The destination file should
-CZ "destination file" end in the extension .zip, If it does not, .zip will be added to the end of
the provided name.
Moves selected files to the destination zip file. Selected files will not be
available in the historian following this command. The destination file
-MZ "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

Command Description
from a crash during the backup process.
Deletes selected files. This takes the data off line. This will cause data
--DELETE
loss and is not recommended.
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
--RESTORE “source”
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.
Reads and lists the file information for a target zip file or directory. The –
-RH “source” 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.
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
listed. “source” may be a backup folder, zip file, or single data file. If the
-RV “source” 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 20 - 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.
-S "<timetype> <timecomp> <timecomp> is one of:
<dateexpr>[ AND <dateexpr>][ ACTIVE]"
BEFORE: Where the selected <timetype> comes
before the <dateexpr>.
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

Command Description
order.
<dateexpr> is either a date/time or an HDA relative
date/time expression 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 21 - Valid Selections
Selection Examples
All files that start prior to one week before this week began.
-S "STARTS BEFORE WEEK-1W"
All files that start sometime 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"

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 34 displays the navigation pane and Data Collection Management page.
Figure 34 - 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
 Filter and Sort
 Scheduled Transfer

Tag Browser
The Tag Browser (Figure 35) 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 35 - Tag Browser (with and without Flat Browse enabled)
Table 22 describes the components of the Tag Browser screen section.
Enter the name of a data server in this field, or if required, use
Source Data Server 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.
Select this checkbox to enable flat browsing, or clear the
checkbox to use hierarchical browsing. If required, use flat
Flat Browse
browsing mode to view all items on a server without the branch
structure.
Use this button to return a list of branches and items available in
Browse
the server.
Item Display Displays the applicable items allowing you to select those to be

archived.
Select this checkbox to allow the selected tags to be archived.
Enable Archiving of these Tags
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
Default Update Rate (ms) 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.
From the drop-down list, allows you to select a data type that will
Default Data Type be applied to the item if the source item’s data type cannot be
found, or is not supported by Data Storage.
Select this button to access the Advanced Tag Options window
Advanced (Figure 37) where you can enable and define Timestamp
Processing and Tag Lifetime.
Select this button to create new OPC Desktop Historian tags in
Add Selected Tags
the workspace.
Table 22 - Tag Browser Components
Server Browser
The Server Browser (Figure 36) locates OPC classic servers.
Figure 36 - Server Browser
Figure 37 displays the Advanced Tag Options window which is accessed via the Advanced
button on the Tag Browser (). The window components are described in Table 23.

Figure 37 - Advanced Tag Options Window
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 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
Timestamp Bias
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.
If available, this field allows you to enter a value defining the
update rate. The update rate unit of time (e.g., milliseconds,
Lifetime Update Rate 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.
If available, from the drop-down list, select an update rate unit
Update Rate Units
of time (e.g., milliseconds, seconds, minutes, etc.).
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
Lifetime Read Interface
most recent value, quality, and timestamp for a lifetime read.
The SyncIO option will cause the data client to use a
synchronous command instead.
Select this button to commit any changes made in the
Advanced Tag Options window. These changes apply to the
Accept
tags selected in the Tag Browser when the Add Selected Tags
button (in the Tag Browser) is selected.
Select this button to discard any changes made in the Advanced
Cancel
Tag Options window.
Table 23 - 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 38 - Tag Workspace
Tag Management Toolbar

The Tag Management toolbar (Figure 39) provides commonly-used commands to modify selected
tags and access to the display preferences tool.
Figure 39 - Tag Management Toolbar
Table 24 describes the components of the Tag Management toolbar.
Cut Cuts selected values/rows to clipboard.
Copy Copies selected values/rows to clipboard.
Paste Pastes values from clipboard into selected rows.
Marks all selected tags for deletion. Tags will be deleted with the
Mark Items for Deletion Commit button has been pressed.
Unmarks all selected tags for deletion. This may be used after
Unmark Items for Deletion tags have been marked for deletion, but before the Commit
button has been pressed.
Opens the Preferences window which allows the user to select
Visible Attributes 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.
Refreshes the tag list from the tag database. This will cause all
Refresh Tags pending changes to be lost.
Shows/hides the Colour Legend window. Refer to Colour
Show Legend Legend for more information.
Import Tags Import tags from CSV files to Grid.
Export Tags Exports tags from Grid to CSV files.
Table 24 - Tag Management Toolbar Components
Tag Management Context Menu

The context menu (Figure 40) 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 40 - Tag Management Context Menu
Table 25 describes the components of the Tag Workspace context menu.
Cut Cuts selected values/rows to clipboard.
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

Set Visible Attributes deselect those attributes you want shown in the Tag
(Shortcut) Workspace. For more information, refer to Visible Attributes.

Opens the Preferences window which allows the user to select
Set Visible Attributes which attributes should be displayed in the Tag Workspace. For
more information, refer to Visible Attributes.
Set to Default Visible Resets the visible attributes to only those displayed by default.
Attributes
Refreshes the tag list from the tag database. This will cause all
Refresh Tag List pending changes to be lost.
Shows/hides the Colour Legend window. Refer to Colour
Legend Legend for more information.
Table 25 - Tag Management Context Menu Options
Tag Status
The Tag Status (Figure 41) is found at the bottom of the Tag Workspace and displays the
following:
 Total number of tags
 Number of marked, deleted tags
 Number of modified tags
 Number of tags with invalid attributes
 Number of tags which are not committed after importing the tags using Import option.
Figure 41 - 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 42) 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.
Figure 42 - Data Collector State (showing Started and Stopped)
Note: When the Data Collector is stopped, the OPC client configuration node will go offline.
Filter and Sort

The tags can be filtered based on the text entered in the Filter field. To apply the filter, click on
the Apply button. In order to show all the available tags again, click on Clear. The filter is applied
across all the selected columns.

Figure 43 – Filter field
To sort a column in an ascending order, click on the column header. Another click on the header,
will sort the column in a descending order.
Importing tags from CSV files

Tags can be imported from CSV files using the Tag Management toolbar.
To import a tag:
1. Click on the Import tags button.

2. In the Open field, select the CSV file that you want to import.
3. Click Open.
4. Click on Commit to add the tags to the archiver or Cancel to abort the operation.
Notes:
 The tags should be added to the grid and can be
modified as required.
 While importing the tags, a window Import tags from
file appears which shows the progress of the operation.
Figure 44 – Importing CSV file
 Users can view the details and errors in the import

operation by clicking on the Details button.
Figure 45 – Import tags from file result

Exporting tags to CSV files
Tags can be exported to CSV files using the Tag Management toolbar (Figure 39).
To export a tag:
1. Click on the Export tags button.

Users can modify the default name by editing in the Save As field.
Adding a Tag
Tags can be added using the Tag Browser (Figure 35). 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 35 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 non-
adjacent 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 37) 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.

Removing a Tag
Notes:
 Removing a tag from Desktop Historian is an irreversible
event. When a tag is removed, all access to the tag’s
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 non-
adjacent 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 46).
 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.

Figure 46 - 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 tag’s data type can be 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 47) to acknowledge the request.

Figure 47 - Tag Workspace showing Changed Attribute
5. Click on the Commit button.

6. The attribute change is displayed.
Renaming a Tag
A tag’s 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 tag’s 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.

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 tag’s 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 tag’s 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 tag’s 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 48). 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.

Figure 48 - 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 49. 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.

Figure 49 - 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 50).

Figure 50 - 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
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 51).
Note: Timestamp Bias and Lifetime Read Interface are not visible by default. Refer to Visible
Attributes for more information.
Figure 51 - Lifetime and Timestamp Processing Attributes (with Lifetime Update Rate Field Options Displayed)
Table 26 describes the aforementioned attributes (displayed in Figure 51).
Attribute 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
Tag Lifetime Enabled 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
Lifetime Update Rate
value and timestamp.
Clicking on the down arrow displayed on the right side of this

Attribute Description
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
Lifetime Read Interface 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.
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
Use System Timestamp 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.
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 Historian’s database.
If the Tag Lifetime Enabled or Use System Timestamp
checkboxes are selected, the timestamp will be recorded as the
Timestamp Bias
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 26 - Timestamp and Lifetime Processing Attributes Descriptions
Notes:
 As per all other attributes, changes to those items listed in
Table 26 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.
Figure 52 - 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.
Managing Desktop Historian Instances

Depending on the type of license that has been purchased, the Multi Instance option is enabled.
Multi Instance allows users to run multiple instances of MatrikonOPC Desktop Historian on the
same PC allowing logical separation of archive tags and load balancing. Users can configure
additional instances by using the Desktop Historian Instances Manager.
In the Desktop Historian Instances Manager tool, users can add, remove, rename, and set up
security for an instance.

Figure 53 – Desktop Historian Instances Manager
Adding Instance
To add a new instance:
1. Enter the name of the new instance in the New Instance field.
2. Click on the Add button.
Note: Each Instance name must be unique.

Figure 54 – Adding New instance
Removing Instance
To remove an existing instance:
1. Select the instance in the Existing Instances list.
2. Click on the Remove button.
Figure 55 – Removing Existing Instance

Renaming Instance
To rename an existing instance:
1. Enter the new name of the instance in the New Instance field.
2. Select the instance that you want to rename in the Existing Instances list.
3. Click on the Rename button.
Figure 56 – Renaming Existing instance
Setting up security for an Instance

To setup security for an existing instance:
1. Select the instance from the Existing Instances list.
2. Click on the Security button.
Refer to the Security section for more details on how to setup security for an OPC server.

Figure 57 – Setting up Security for an Existing Instance
Notes:
 Each instance can be distinguished by a numerical identifier.
 Each instance has its own OPC server identified by a version dependent ProgId based on
its numerical identifier. For example, an instance named “Second Storage” that has 2 as
identifier will have the ProgId Matrikon.OPC.Desktop.Historian.2.
Figure 58 – Instance Version Dependent ProgId
 Each Instance has its own separate set of window services.
Figure 59 – Instance Windows Services

Scheduled Transfer
If the install as Hub or Spoke option is selected during installation, the MatrikonOPC Desktop
Historian can install the Scheduled Transfer component. This component allows users to
configure historical data transfers between OPC servers.
To view the Scheduled Transfer configuration settings:
1. From the Configuration window, in the tree-view pane (navigation pane on the left side of
the screen), select and expand the following node: Desktop -> Localhost -> OPC
Desktop Historian -> Scheduled Transfer-> Main Transfer
2. Click on the Configure item displayed under the Management node.
Figure 60 – Scheduled Transfer Component
History Transfer Configuration

The History Transfer Configuration toolbar provides commonly used commands to create a new
or modify existing history transfers.
Figure 61 – History Transfer Configuration
The table below describes the components of the History Transfer Configuration toolbar.

New History Transfer Creates a new history transfer.
Edit History Transfer Modifies an existing history transfer.
Start History Transfer Starts a history transfer that has been stopped.
Stop History Transfer Stops a running history transfer.
Clone History Transfer Clones selected history transfer.
Delete transfer Delete selected history transfer.
Table 27 - History Transfer Configuration Components
History Transfer Properties

Users can create a new or modify an existing history transfer in the History Transfer Properties
screen.

Figure 62 – History Transfer Properties
The table below describes the components of the History Transfer Properties dialog.
Description Enter a description for the history transfer.
History transfer data source. Click the browse button to use
Data Source
the Browse for HDA Servers screen.
Select a History transfer source type from the drop-down. The
Type
options available are OPC HDA Server and CSV file.

Default: OPC HDA Server
Select the History transfer data processing options from the
Data Processing drop-down. The options available are: Read raw data or
processed data (aggregates).
Select the type of aggregate from the drop-down. The options
Aggregate available are: INTERPOLATIVE, TIME AVERAGE, MINIMAL
ACTUAL TIME, MINIMUM, MAXIMUM ACTUAL TIME, MAXIMUM.
Sample Interval Enter the interval to be used when calculating aggregates
Enter the history transfer data destination. Users can also click
Data Destination the browse button to use the Browse for HDA Servers
window.
Select the History transfer destination type from the drop-down.
The options available are:
Type OPC HDA Server
CSV file
Default: OPC HDA Server
Select a history transfer insertion option.
Insert / Replace
Default: Insert
Timestamp Offset Destination data timestamp offset
Select a Scheduled Type from the drop-down. The options
available are:
 Sliding window: fixed window size which is the
difference between end time and start time.
Scheduled Type  One Time Transaction: executes only once
based on Start time and Start time offset.
 Expanding window: variable window size that
starts on the last time data was read.
Default: Sliding Window
When this option is selected, the transfer is retried on failure
Retry if failed
based on the retry delay set.
Start Time Determines the window start for the first transfer.
Start Time Offset Determines the transfer execution time relative to the start time.
Transaction Period Determines the window size and hence the transfer end time.
Select the action to be performed on transfer restart from the
drop-down. The options available are:
 Backfill: resumes transfer from the last valid start and
end time before stopping
On Restart
 No Backfill: resumes transfer on the start time just before
the next execution time
 Transfer from next: resumes transfer on the next future
start time.

Default: Backfill
When this option is selected, the buffer size and the inter buffer
Custom Transaction Properties
delay can be customized for this transfer.
Click on the Configure Tag Mappings button to configure Tag
Configure Tag Mappings
Mappings for this transfer.
Click on the Save button to Save the history transfer properties
Save
before closing the dialog.
Click on the Close button to close the dialog without saving the
Cancel
history transfer properties.
Table 28 - History Transfer Properties
Browse for HDA Servers

The Browse for HDA Servers screen allows users to select a local or remote HDA server.
Figure 63 – Browse for HDA Servers
History Transfer Tag Mapping

In the History Transfer Tag Mapping screen, users can create a new or modify an existing history
transfer tag.

Figure 64 – History Transfer Tag Mapping
1. Select a transfer to configure in the Scheduled Transfer list.

2. Click on the Browse button in the Source area. The Browse Filter window appears.
Figure 65 – Browse Filter
3. In the Browse Filter window, users can apply a filter to the tag browser and choose the
maximum number of items in the Max Items field. The source list will be populated with
the tags retrieved from the source OPC server. If the user chooses to proceed without
entering the number of items, then by default, 100 items are returned.
4. Click on the Browse button in the Destination area. The Browse Filter window appears.
5. Similarly, in the Browse Filter window, users can apply a filter to the tag browser and
choose the maximum number of items in the Max Items field. The destination list will be
populated with the tags retrieved from the source OPC server. If the user chooses to
proceed without entering the number of items, then by default, 100 items are returned.
6. From the populated source and destination list, select the source tag to be transferred and
the corresponding destination tag where the source data is to be sent.

7. If multiple items are to be mapped, ensure that both the source and destination browse list
are in the same order. Multiple selections may then be made and the tags will be mapped in
an order list.
8. Click on Map Selected. The tags are respectively added to the Mapped Source Items and
Mapped Destination Items columns.
9. To unmap items, select the tags in the Mapped Source Items or Mapped Destination
Items columns.
10. Right-click and select Remove Selected Mapping to remove only selected mappings or
Remove All Mappings to remove all mappings without selecting.
11. Click on the Save button to save the transfer mappings.
12. Once editing mappings for all the transfers is complete, click on the Close button.
Importing tag mappings

To import tag mappings from CSV files:
1. In the History Transfer Tag Mapping screen, click on the Import button.
2. Select the CSV file that you want to import.
3. Click Open.
Exporting tag mappings

To export tag mappings from CSV files:
1. In the History Transfer Tag Mapping screen, click on the Export button.
2. Enter the name of the CSV file in the Save As field.
3. Click Save.
Scheduled Transactions Options

Users can configure Data Transfer settings in the Scheduled Transaction Options page.
To access the Scheduled Transaction Options page:
1. From the Configuration window, in the tree-view pane, select and expand the following
nodes:
 Desktop -> Localhost -> OPC Desktop Historian -> Scheduled Transfer ->
Options
2. Click on the Configure item displayed under the Options node.

Figure 66 – Scheduled Transactions Options
The Table 29 describes the components in Scheduled Transaction Options page.
Transaction Buffer Size Limits the total amount of data that will be copied from the
source to destination per buffer. It is recommended to keep this
number smaller than the amount of memory available on your
computer. The available range is 0.01 through 128 MB.
Default = 0.11 MB
Reconnection Attempts If either the data source or data destination becomes
disconnected during a transaction, this is the number of
attempts that are made before the transaction is deemed a
failure.
Default = 1
Reconnection Delay The total time that is delayed (in seconds) in between
reconnection attempts. This gives the disconnected
source/destination time to ‘become available’.
Default = 5 seconds
Buffer Transfer Retries If a problem occurs during a transaction, this number will set
how many attempts will be made before the transaction is

deemed a failure.
Default = 1
Inter-Buffer Delay A delay can be placed in between the buffer transfers to ‘throttle’
the bandwidth being used during a transaction. Decreasing the
Transaction Buffer Size and increasing the Inter-Buffer
Delay will decrease the total sustained bandwidth required for a
transaction.
Default = 4 milliseconds
Maximum Concurrent Executing This is typically set to 1. This implies that all history transfers
Transactions are serialized. If users are worried about a transaction blocking
the rest of the transactions (e.g., communication failure),
increase this value.
WARNING: This value is a multiplier for the total buffer size!
Default = 1
Maximum Message Window Limits the number of message lines to be displayed in the
Lines Selected Transaction History screen section on the
Scheduled Transaction Management page. This number must
be between 1 and 500.
Default = 10
Transaction Scan Rate This is the interval to check for next execution transaction.
Log Level Enables/disables transaction logging at the specified detail level
(High, Medium, Low, or None).
Log File Name Filename of the log file to store logged activity.
Apply There are two Apply buttons on the Scheduled Transaction
Options page, one in the Process Properties section, and one
in the Logging section. Select the applicable Apply button to
commit any changes made in the corresponding screen section.
Cancel There are two Cancel buttons on the Scheduled Transaction
Options page, one in the Process Properties section, and one
in the Logging section. Select the applicable Cancel button to
cancel any changes made in the corresponding screen section.
Table 29 – Scheduled Transaction Options Components
Scheduled Transfer Redundancy

Users can configure Data Transfer settings in the Scheduled Transfer Redundancy page
To access the Scheduled Transfer Redundancy page:
nodes:
 Desktop -> Localhost -> OPC Desktop Historian -> Scheduled Transfer ->
Main Transfer -> Redundancy

2. Click on the Configure item displayed under the Redundancy node.
Figure 67 – Scheduled Transfer Redundancy
Redundancy Overview
History Transfer Redundancy is used for increasing data availability. In a redundancy setup, there
is a Primary History Transfer and a Backup History Transfer. A typical deployment with
History Transfer Redundancy is illustrated in Figure 68.

Destination Node
Historian
Primary Source Node Backup Source Node
Primary Backup
History History
Transfer Transfer
Historian Historian
Figure 68 - Typical Deployment for History Transfer Redundancy
The system is usually deployed with the Primary History Transfer residing on the primary source
node and the Backup History Transfer residing on the backup source node. The Historians on
both the Primary and Backup History Transfers collects the same data from the same data
sources. The data destinations for the Primary and Backup History Transfers are the same.
The Primary History Transfer will be responsible for data transfer as long as it is alive. The
Backup History Transfer will take over the data transfer when it detects that the Primary
History Transfer is not running any more. Increased availability of historical data is achieved.
The following points will explain how the Primary History Transfer and Backup History
Transfer will behave under different situations:
 If the Primary History Transfer starts up with the Backup History Transfer not running, the
Primary History Transfer will be responsible for data transfer.
 If the Backup History Transfer starts up with the Primary History Transfer running, the
Backup History Transfer will standby. The Primary History Transfer will update its
transaction execution status (transaction data window and next schedule time) to the
Backup History Transfer so that their transaction statuses are synchronized (transactions
are identified by the Transaction ID). This way, when the Backup History Transfer takes
over data transfer, it will continue from where the Primary leaves off.
 If the Backup History Transfer detects the Primary History Transfer is no longer running and
cannot connect to the Primary within a certain timeout, the Backup History Transfer will
take over the data transfer responsibility.
 If the Backup History Transfer starts up without detecting the Primary History Transfer
running within the timeout period, the Backup History Transfer will be responsible for data
transfer.

 If the Primary History Transfer starts up with the Backup History Transfer running, the
Primary History Transfer will wait for the Backup History Transfer’s signal as to when to take
over the data transfer.
 If the Backup History Transfer starts up but it is not in the state of transferring data, it will
signal the Primary History Transfer right away.
 If the Backup History Transfer is actually transferring data, it will keep transferring data
until all of the transaction start times have passed the time when the Primary History
Transfer starts up. This is for the purpose of increased data integrity. Before signaling the
Primary History Transfer, the Backup History Transfer will update its latest transaction
execution status to the Primary History Transfer so that the Primary History Transfer does
not duplicate the transactions.
Note: Redundancy is supported for One-Time Transactions and

Sliding Window Transactions only.
Configuration Settings
There are three redundancy settings: No Redundancy, Primary History Transfer, and Backup
History Transfer (Figure 69).

Figure 69 - Scheduled Transfer Redundancy Page
The appearance of the Scheduled Transfer Redundancy page depends on which Redundancy
Setup option is selected. If No Redundancy is selected, then the page displays only a
Redundancy Setup screen section. When either the Primary Node or Backup Node option is
selected, the Redundancy Configuration page displays three screen sections: Redundancy
Setup, Parameters, and Status. However, the parameters are different. For more information,
refer to Primary Node Configuration and Backup Node Configuration.
Clicking the information button displays the following note:
Figure 70 - Redundancy Configuration Note

As stated in the note (Figure 70), it is recommended that InsertReplace be used for OPC HDA
server data destination if redundancy is configured.
No Redundancy
If the History Transfer is configured to have no redundancy, it executes the configured transactions
without worrying about any peer History Transfers.
Primary Node Configuration

The configuration panel for the Primary Node is shown in Figure 71.
Figure 71 - Primary Node Configuration Settings
Table 30 describes the settings available for the Primary Node configuration.
The port to listen on for the Backup History Transfer’s
Port connection.
Default = 20006
The delay to wait for Backup History Transfer connection before
Startup Delay starting to transfer data.
Default = 120 seconds
Timeout for receiving message responses.
Message Response Timeout
The rate to send heartbeat message to the Backup History
Heartbeat Rate Transfer.
If the Primary History Transfer does not receive any message
from the Backup History Transfer for this timeout period, it will
Connection Timeout consider the Backup History Transfer to be in failure.
The rate to update the transaction execution status to the
Transaction Status Update Rate Backup History Transfer. Setting this value to 0 will trigger the
update whenever the status is changed.

Table 30 - Primary Node Configuration Components
Backup Node Configuration

The configuration panel for the Backup Node is shown in Figure 72.
Figure 72 - Backup Node Configuration Settings
Table 31 describes the settings available for the Backup Node configuration.
The Primary History Transfer node to which to connect. This is
Primary Node the network name of the machine that the Primary History
Transfer node is running on.
The port on the Primary History Transfer node to which to
Port connect.
Default = 20006
The delay to wait to connect before starting to transfer data.
Connection Delay
Default = 120 seconds
The delay to wait before retrying to connect to the Primary
Connection Retry Delay History Transfer.
Timeout for receiving message responses.
Message Response Timeout
The rate to send heartbeat message to the Primary History
Heartbeat Rate Transfer.
Connection Timeout If the Backup History Transfer does not receive any message

from the Primary History Transfer for this timeout period, it will
consider the Primary History Transfer to be in failure.
Select the Automatic option so that when the Backup History
Transfer is in failure, the Primary History Transfer
Redundancy Mode automatically takes over. When the Manual option is selected,
the Failover to Primary button must be selected before the
Primary History Transfer takes over.
When the Manual option is selected, this button must be
selected before the Primary History Transfer takes over. This
Failover to Primary
button is disabled (i.e., greyed out) when the Automatic
option is selected.
Table 31 - Backup Node Configuration Components
Note: Data Transfer validates the Primary History Transfer node. If it detects that it is an invalid
node name, a warning message is displayed.
Redundancy Status
The Redundancy Status screen section is shown in Figure 73.
Figure 73 - Redundancy Status
If redundancy is configured, the status will be displayed at the bottom of the Scheduled Transfer
Redundancy page in the Status screen section (Figure 69). There are two statuses available:
 Connectivity to the peer History Transfer – this is either Not connected or
Connected.
 Data Transfer State – this status reflects whether this History Transfer is actually
Transferring data or Standing-by.
The status is automatically updated periodically. The Refresh button is available for an on-demand
update, if required.
Configuring Redundancy Settings

To configure redundancy settings if redundancy is not required:
1. Go to Scheduled Transfer Redundancy page (for more information, refer to Accessing
Redundancy Configuration).
2. Select the No Redundancy option button.
3. Click on the Apply button.
To configure redundancy settings if redundancy is required:
1. Go to Scheduled Transfer Redundancy page.
2. Select either the Primary Node or Backup Node option.

3. In the Parameters screen section, change parameter values as required.
Note: Whenever an “on-demand” status update is required, click on the Refresh button.
Manually Synchronizing the Configuration

The Primary Node and the Backup Node only synchronize the transaction execution status,
including the data window and next schedule time. However, they do not synchronize the
transaction settings (e.g., item mapping).
Users should ensure that the transaction configuration for the Primary and Backup History
Transfers are identical.
To manually synchronize the transaction configurations:
1. Setup the configurations (transaction configuration, options) in the Primary History
Transfer.
2. Save the Primary History Transfer’s configuration into an XML configuration file (refer to
Loading and Saving Configurations).
3. Set the Configuration Loading Options in the Backup History Transfer (see
Configuration Loading Options) to make sure that the two checkboxes are cleared, so
that all existing transactions are removed and redundancy configuration is not loaded.
4. Load the XML configuration file saved in step 2, to the Backup History Transfer.
Saving and Loading Scheduled Transfer Configurations

To save Scheduled Transfer configuration:
1. Right-click on the Scheduled Transfer Instance node in the navigation pane. By default,
Main Instance is available.
2. Hover your mouse over the only menu option that is displayed (Persistence).
3. From the new menu that is now displayed, select the Save Configuration option. The
Save As window is displayed.
4. Enter the file name and the location in the Save As window.
Note: When saving the configuration, the Configuration Loading Options is not saved.
To load Scheduled Transfer configuration:

1. Right-click on the Scheduled Transfer Instance node in the navigation pane. By default,
Main Instance is available.
2. Hover your mouse over the only menu option that is displayed (Persistence).
3. From the new menu that is now displayed, select the Load Configuration option. The
Open window is displayed.
4. Browse and select the required file.
You can choose how the configuration is to be loaded by setting the options in the Configuration
Loading Options window which can be accessed from the Options page.
Note: After the configuration is loaded, you need to re-open the configuration panels to view the
updated configurations.

Managing Historian Transfer Instances
Depending on the type of license that has been purchased, the Multi Instance option is enabled.
Multi Instance allows users to run multiple instances of History Transfer on the same PC allowing
logical separation of archive tags and load balancing. Users can configure additional instances by
using the History Transfer Instances Manager.
In the History Transfer Instances Manager tool, users can add a new instance, remove, and
rename an existing instance.
Figure 74 – History Transfer Instances Manager
Adding Instance
To add a new instance:
1. Enter the name of the new instance in the New Instance field.
2. Click on the Add button.
Note: Each Instance name must be unique.
Figure 75 – Adding New instance
Removing Instance
To remove an existing instance:
1. Select the instance in the Existing Instances list.

Figure 76 – Removing Existing Instance
Renaming Instance
To rename an existing instance:
1. Enter the new name of the instance in the New Instance field.
2. Select the instance that you want to rename in the Existing Instances list.
3. Click on the Rename button.
Figure 77 – Renaming existing instance
Notes:
 Each Instance has its own separate set of window services.
Figure 78 – History Transfer Instance Windows Services

Event Transactions
The Event Transactions component allows for the configuration of the following:
 Event Transaction Configuration
 Options
Starting and Stopping Event Triggered Data Transfer

Event Triggered Data Transfer is installed as a Windows service, and may be started and stopped
using the Service Control Manager applet (under the Windows Control Panel). The service name
is MatrikonOPC Vigilant. 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 79 shows the Data Transfer (outlined in red) is started with a Status of Started.
Figure 79 - Windows Services Panel
Note: If you decide to restart the MatrikonOPC Vigilant service,

then you must ensure to restart the service twice.
Event Transaction Configuration

Event Transactions use a graphical user interface (GUI) that allows users to view and alter
configuration parameters.
To access the Event Transactions configuration:
1. Click on the Windows Start button and select Programs -> MatrikonOPC -> Desktop
Historian, and choose MatrikonOPC Desktop Historian.
2. The Configuration screen appears and the Start Page is displayed.
3. Select and expand the nodes in the navigation (left side) pane until the Event
Transactions node (Figure 80) is available.

Figure 80 - Start Page (Event Transactions Node)
Figure 80 shows the connected configurable parts of the solution. To access the application
functionality, you must navigate the tree-view (i.e., navigation) pane.
The Event Transactions node can be expanded allowing you to view other related screens (Figure
81
 Management configuration screen allows you to manage transactions.
 Options screen provides an interface to which you can customize the functionality of the
application.

Figure 81 - Event Transactions Node Expanded
The Event Transactions component is responsible for the migration of historical data from a
historical data source to a historical data destination using data event detection.
A transaction is the specification of a data transfer event, or series of data transfer events. Data is
moved from a data source to a data destination. A data window is the specific interval of stored
data that is to be moved from the data source, to the data destination. Each transaction can be
configured to trigger on a unique set of events.
An Event Source is a logical condition that can be tested against and if true, then a transaction
can be triggered. An example of an event source would be if an OPC value exceeds a user-defined
threshold or if communication with an OPC server is lost.
The Transactions screen section of the Event Transaction Management page (Figure 82) lists
the transaction users have created.

Figure 82 - Event Transaction Management Page
Table 32 describes the functionality of the buttons on the Transactions screen section.
Select this button to define new event sources using the Event
Event Sources
Source Configuration screen.
Select this button to create a new transaction using the Transaction
New Transaction
Configuration screen.
Select this button to modify the selected transaction using the
Transaction Configuration screen. You must first click on an item
Edit Selected
in the Transactions list. Double-clicking on an item in the
Transactions list will also perform this action.
Selecting this button permanently removes the currently selected
Remove Selected
transaction.
Table 32 - Transaction Buttons
The Selected Transaction History screen section shows results from transactions that have
already run. To display the results for a particular transaction, select the appropriate transaction
from the Transactions screen section. Table 33 describes the functionality of the buttons on the
Selected Transaction History screen section.

Clear History Select this button to remove all items from the transaction history.
Select this button to reload all history items for the selected
Refresh
transaction.
Table 33 - Transaction History Buttons
Note: Transaction IDs are unique identifiers used by the transaction

engine. When a saved configuration file is loaded, all existing
transactions are removed and the transactions in the file are added to
the transaction list. The transaction IDs of the newly loaded files will
start at the lowest unused ID value. This means that loading
configuration files repeatedly will cause the transaction ID numbers to
grow. This is expected and does not indicate a growth in the number
of transactions being processed by the transaction engine.
Accessing Event Transaction Management

To access the Event Transaction Management screen:
nodes:
 Desktop -> Localhost -> OPC Desktop Historian -> Event Transactions
2. Click on the Configure item displayed under the Management node. Figure 82 displays
the navigation pane and Event Transaction Management page.
Creating and Configuring an Event Source

To create/configure a new event source:
1. From the Event Transaction Management screen (Figure 82), select the Event Sources
button.
2. The Event Source Configuration screen (Figure 83) is displayed.

Figure 83 - Event Source Configuration Screen
3. Right-click your mouse anywhere in the panel on the left and select Add Event Source
from the displayed menu.
Or,
Select Add Event Source from the Edit menu. A new event source will be added in the left
panel (Figure 84).
Figure 84 - New Event Source

4. In the Name of Event Source field, enter an event source name that clearly identifies this
event. This name will be used to identify the event source when associating events with
transactions.
5. In the Number of Conditions Required for Event Source to Fire field, enter the
required value (or use the increase or decrease buttons to select the necessary value). This
field can be set between 1 and the number of conditions associated with this source (see
steps 9 through 13 for details on adding a condition). This field determines how many
conditions must be true before the event is triggered. For example, if there are five
conditions and this field is set to 3, then the event source will fire when any three or more
conditions are true.
6. In the Initialization Delay field, enter the required value (or use the increase or decrease
buttons to select the necessary value). This is the number of seconds the event detection
system waits (after start-up) before starting to evaluate whether an event source should
fire or not. This delay allows the user to delay detection for the system to reach a steady
state before detecting events.
7. In the Calculate Conditions Every field, enter the required value (or use the increase or
decrease buttons to select the necessary value). This field sets how often (in seconds) the
event conditions are checked to determine if an event should be triggered. Typically, this
time is greater than or equal to the largest scan rate of all the conditions configured for the
event source (see steps 9 through 13 for condition configuration information).
Note: Event triggers are only calculated on leading edge events. This
means that the conditions used to detect a trigger must go from a
false state to a true state for a trigger to be detected.
8. Click on the Add a Condition to this Event Source button (see the top-right corner of the
screen) to create a new condition for this event.
9. A new condition appears in the left panel and the panel on the right displays configuration
options for the new condition (Figure 85).

Figure 85 - New Event Condition
10. Name the condition by changing the Condition Name field.

11. In the Condition Type field, select a type from the drop-down list. There are two options:
 Condition Builder – used to build a logical statement based on an OPC value that is
monitored. The remainder of this example will focus on the Condition Builder since
it is the more complicated option of the two.
 Communication Status – allows you to create a condition based upon whether or
not communication with an OPC server is available.
12. Configure the Condition Builder (in the Condition Builder screen section) to monitor an
attribute of an OPC item. Table 34 describes the impact of the different fields within the field
builder.
13. Click on the OK button to close the Event Source Configuration window and return to the
Event Transaction Management page.
Field Values Description

The condition will be a comparison to the value of
If the… Value
an OPC item.
The condition will be a comparison to the quality of
Quality
an OPC item.
The condition will be a comparison to the amount
Value Change
of change of the value between condition checks.
The condition will be a comparison to the amount
Timestamp Change of change of the timestamp between condition
checks. Changes are compared in milliseconds.
Path to item in an OPC server. The item can be
of this OPC item: <Item Path> found by clicking on the ellipsis button and
browsing to the item in the OPC server.

Field Values Description
A logical comparison operation to be performed.
is… <Logical Statement> The options in this field will change depending on
the option selected for the “If the…” field.
Compare to the value of a second OPC item. The
this… OPC item value: item can be found by selecting the “…” button and
browsing to the item in the OPC server.
Quality Compare to a particular OPC quality.
Constant value: Compare to a constant user-selected value.
Constant string Compare to a constant user-defined string.
Defines how often the OPC item should be polled
Scan Rate:
from the server.
Table 34 - Condition Builder Fields
Example: Configuring an Unchanging Tag Event

This example will demonstrate how to configure an event to detect when an OPC tag has stopped
updating. For full instructions on how to complete each step please refer to Creating and
Configuring an Event Source.
The technique used in this example is based on timestamp comparisons and this example will
trigger an event if it has not changed in at least 30 seconds.
Figure 86 - Event Source Configuration
1. From the Event Source Configuration (see Figure 86) add a new Event source by clicking
Edit -> Add Event Source or by right clicking the left area of the window and selecting
Add Event Source.

2. Set the Event Source to calculate its event conditions every 30 seconds (see Figure 87).
This will allow the detection of a tag that has not changed in the past 30 seconds.
Figure 87 - Configured Event Source
3. Create a new Condition by clicking the button labelled Add a Condition to this Event
Source or by right clicking the new Event Source in the left tree and selecting Add
Condition.
4. Configure the condition to subscribe to the point of interest in your OPC server and to
evaluate to true when the timestamp does not change (see Figure 88).

Figure 88 - Configured Condition
This configuration will cause a DA subscription to be created with an update rate of one second.
The condition is configured to calculate to true if the timestamp has not changed since the last
calculation. The condition will be recalculated every 30 seconds as set in the Event Source.
Notes:
 Since conditions are calculated every 30 seconds and the
condition looks for a timestamp change of exactly 0, it can take
up to 60 seconds to detect that the monitored tag has not been
changing.
 Conditions use DA subscriptions to gather tag data. If a tag in
the OPC Server receives an updated timestamp, the Server will
not send the timestamp change to the subscriber unless either
the value or quality has changed. The condition will therefore
not be notified of the timestamp change and will trigger after
30 to 60 seconds.
Creating and Configuring an Event Transaction

Note: For detailed information about Event Transaction Configuration screen components and
functionality, refer to the Event Transaction Configuration Screen section in this manual.
To create/configure a new Batch Capture event transaction:
1. From the Event Transaction Management screen (Figure 82), select the New
Transaction button.
2. The Transaction Configuration screen (Figure 89) is displayed.

Figure 89 - Transaction Configuration Screen
3. In the Transaction Type field, select Batch Capture from the drop-down list.
4. In the Start Event Options screen section, select whether to use the first or last
occurrence of the start event as the start time for the historical data transfer.
5. In the Transaction Delay field, enter the applicable value, or use the increase or decrease
buttons to select the necessary value.
6. Select the required event sources from the drop-down lists in the Start and End Event
Source fields, for the transaction.
7. Enter or select the required Pre-Event and Post-Event Times for the transaction.
8. In the Retrigger Delay field, enter or select a value to define the minimum amount of time
that must pass after the end of a transaction before a new transaction can be triggered.

Note: Event triggers are only calculated on leading edge events. This
means that the conditions used to detect a trigger must go from a
false state to a true state for a trigger to be detected.
9. Map items as required. For detailed item mapping information, refer to the Mapping Tags
section in this manual.
10. On the Transaction Configuration screen, click on the Apply button.
11. The Transaction Configuration screen closes and you are returned to the Event
Transaction Management screen which now displays the newly created transaction in the
Transactions screen section (Figure 90).
Figure 90 - Event Transaction Management (Transactions)
Changing an Event Transaction

To edit a transaction:
1. From the Event Transaction Management screen, in the Transactions screen section
(Figure 90), select the transaction you wish to edit.
2. Click on the Edit Selected button.
3. The Transaction Configuration screen is displayed.
4. Change the transaction as required.
6. The Transaction Configuration screen closes and you are returned to the Event
Transaction Management screen which now displays the updated transaction in the
Transactions screen section.
Removing an Event Transaction

To remove a transaction:
(Figure 90), select the transaction you wish to remove.
2. Click on the Remove selected button.
3. A message is displayed asking you to confirm the action.

5. The Transaction Management screen is automatically refreshed and the selected
transaction no longer appears listed in the Transactions screen section.
Viewing Transaction History

To view transaction history:
(Figure 90), select the transaction for which you wish to review transaction history.
2. The history for the selected transaction is displayed in the Selected Transaction History
screen section (Figure 91).
Note: The Selected Transaction History screen section is empty (i.e., blank) if the
selected transaction has not yet run.
Clearing Transaction History

To clear transaction history:
1. From the Event Transaction Management screen, in the Transactions screen section,
select the transaction for which you wish to clear the transaction history.
Note: The Selected Transaction History screen section is empty (i.e., blank) if the
selected transaction has not yet run.
2. Any history information for the selected transaction is displayed in the Selected
Transaction History screen section (Figure 91).
Figure 91 - Event Transaction Management (Selected Transaction History)

3. Click on the Clear History button.
4. The Selected Transaction History screen section is refreshed and the history information
for the selected transaction is no longer displayed.
Refreshing Transaction History List

To refresh the transaction history list:
select the transaction for which you wish to refresh the history.
2. In the Selected Transaction History screen section, click on the Refresh button.
3. The Event Transaction Management screen is refreshed and all history items for the
selected transaction are reloaded and displayed in the Selected Transaction History
screen section.
Removing Item Mappings

To remove an item mapping:
select the transaction from which you wish to remove an item mapping.
2. Click on the Edit Selected button.
3. The Transaction Configuration screen is displayed.
4. In the Mapped Items screen section (i.e., Mapped Source Tags and Mapped
Destination Tags), right-click your mouse on the mapping you want to remove.
5. From the menu that appears, select the Remove Selected Mappings option (Figure 92).
Note: If only one mapping is available, then only the Remove All Mappings option is
enabled in the displayed menu.
Figure 92 - Mapped Items for Removal
6. The selected mapping no longer appears on the screen.

7. Click on the Apply button to close the Transaction Configuration screen and return to
the Event Transaction Management screen.
Event Transaction Configuration Screen

The Transaction Configuration screen is accessed by selecting either the New Transaction or
Edit Selected buttons on the Event Transaction Management screen. This screen consists of
the following sections which are described in detail:

 Transaction Options
 Tag Mapping
Transaction Options
You have the option of configuring a transaction to be a Batch Capture or a Trip Capture. For
detailed instructions on how to configure a Batch Capture event transaction, refer to Creating and
Configuring an Event Transaction.
Table 35 describes the components of the transaction types.
A Batch Capture transaction transfers historical data which occurs
Batch Capture
between two events.
A Trip Capture transaction transfers historical data which occurs within a
Trip Capture
time window around an event.
Table 35 - Event Transaction Types
Batch Capture Transactions

When the Batch Capture option is selected in the Transaction Type field, the Transaction
Options section (Figure 93) will display the configuration options for a Batch Capture transaction.
Figure 93 - Batch Capture Transaction Options
1. If the First Occurrence option button is selected in the Start Event Options section, then
the time stamp of the first occurrence of the Start Event will be used as the start time for
the historical data transfer. If Last Occurrence is selected, then the time stamp of the last
occurrence of the Start Event before the End Event will be used.
2. The Transaction Delay is the amount of time after the data transfer window has passed
before the data transfer should actually be started.
3. The Start Event Source is the Event Source which when triggered will be the source of the
start timestamp for the historical data transfer.
4. The End Event Source is the Event Source which when triggered will be the source of the
end timestamp for the historical data transfer.
5. The Pre-Event Time is an offset used to calculate the actual start time of the data transfer
using the timestamp of the Start Event Source. The start time of the transaction is
calculated as [Start Event Time minus Pre-Event Time].

6. The Post-Event Time is an offset used to calculate the actual end time of the data transfer
using the timestamp of the End Event Source. The end time of the transaction is
calculated as [End Event Time plus Post-Event Time].
7. The Retrigger Delay is the amount of time that must pass before another instance of this
transaction can be triggered.
Trip Capture Transactions

When the Trip Capture option is selected from the Transaction Type drop-down list, the
Transaction Options section (Figure 94) will display the configuration options for a Trip Capture
transaction.
Figure 94 - Trip Capture Transaction Options
1. The Transaction Delay is the amount of time after the data transfer window has passed
before the data transfer should actually be started.
2. The Event Source is the Event Source which when triggered will cause a historical data
transfer to occur.
3. The Pre-Event Time is an offset used to calculate the actual start time of the data transfer
using the timestamp of the Event Source. The start time of the transaction is calculated as
[Event Time minus Pre-Event Time].
4. The Post-Event Time is an offset used to calculate the actual end time of the data transfer
using the timestamp of the Event Source. The end time of the transaction is calculated as
[Event Time plus Post-Event Time].
5. The Retrigger Delay is the amount of time that must pass before another instance of this
transaction can be triggered.
Tag Mapping
The data source and data destination can be configured in the Tag Mapping section (Figure 95) of
the Transaction Configuration screen.

Figure 95 - Tag Mapping Editor
Data Source
The data source where a user’s data is to be retrieved from is an OPC HDA server or a Comma
Separated Value (CSV) file. Clicking on the ellipsis button next to the Name field allows you to
browse to the HDA server or the CSV file to use as the data source.
Figure 96 - Historical Data Source
1. OPC HDA Server Data Source – the HDA Read Properties window (Figure 97) is
accessible when OPC HDA Server is selected in the Type field. You can then click on the
HDA Read Properties ( ) button adjacent to the tag list below the Name field. This
properties window enables the user to configure whether or not the bounding data at the
start of the transaction window is included in the read results from the OPC HDA server.
Selecting this option will cause the HDA reads to include the nearest data value before the
start of the transaction window if such a value exists.

Figure 97 - HDA Read Properties
Data Destination
The Data Destination is the server or file that is to receive the transferred data values. These
controls are manipulated in the same fashion as the Data Source.
Figure 98 - Historical Data Destination
1. OPC HDA Server Data Destination – the HDA Write Properties window (Figure 99) is
accessible when OPC HDA Server is selected in the Type field. You can then click on the
HDA Write Properties ( ) button adjacent to the tag list below the Name field. This
properties window enables the user to configure the insert methods: either Insert or
InsertReplace.
Figure 99 - HDA Write Properties

Mapping Tags
Browsing for Tags
The transaction must be configured to indicate which tags to use from the data source and data
destination. When you first create a transaction, the Unmapped Source Tags and Unmapped
Destination Tags lists will appear empty. If you are pulling or inserting data from/to an OPC HDA
server, you can click on the ellipsis buttons immediately beside these lists to browse for OPC tags
on the associated OPC server.
Selecting the Browse button displays another window (Browse Filter) in which you may choose
to retrieve a list of tags from the OPC HDA Server. A tag filter may be entered to limit the results,
and users may specify a maximum number of tags that will be copied into the list.
Figure 100 - Browse Filter
If you are working with a CSV file, you will need to enter the tag names manually. Right-click on
the list in which you want to enter the tag to display a context menu. Select the Add Item menu
option. This will insert a new tag named New Item0. (Performing this process again will create
tags named New Item1, New Item2, New Item3, etc.)
To rename this tag to something more meaningful select the item by clicking on it. Then click the
tag again and wait approximately one second. A solid rectangle should now be drawn around the
item. This rectangle indicates you are now in edit mode. You may type the new name of the tag to
replace the old name.
Figure 101 - Renaming a Tag
If you wish to remove a tag from a list, select the tag you want to remove. Right-click your mouse
inside the tag list and select Remove Selected Items from the displayed menu. You may also
remove many tags at once by holding the SHIFT or CTRL keys on your keyboard while clicking on
multiple items. The Delete key on your keyboard will also remove selected tags from a list.
You can also copy all source tags to destination by selecting the Copy All Source Tags to
Destination option from the context menu, or copy all destination tags to source by selecting
Copy All Destination Tags to Source.
Mapping Tags Together
Because tags from the data source and data destination sometimes may not have the same name,
you must specify the source and destination for each applicable tag. This process is called
“mapping”.
Select a tag from the source list and then select a tag in the destination list. Click the Map
Selected button. Data Transfer will now copy values from the tag selected on the left to the tag
selected on the right when the transaction is executed.

Figure 102 - Map Two Tags Together
Figure 103 - Map Two Tags Together
Figure 104 - Mapped Tags
If you want to map several tags at once, you may select multiple tags in each Unmapped list
above and then hold the SHIFT or CTRL keys while clicking. You may also drag and drop tags
from one list to another to map them. Tags can also be dragged from Microsoft Excel into the tag
windows.

Note: The source tag must be unique for each transaction. If you wish to map the same source tag
to multiple destination tags, this must be done in separate transactions.
Saving a Transaction
Once you have entered all information correctly and mapped all necessary tags, you can click on
the Apply button. The transaction will then execute at the time specified in the Scheduled Start
field. If the scheduled start time is before the current time, the transaction will execute
immediately.
Note: Clicking on the Apply button when editing a One Time Transaction that has already
executed will cause the transaction to execute again.
If you wish to discard all current changes on the Transaction Edit screen, select the Cancel
button.
Loading and Saving Event Transaction Configurations

You can save the current Event Transfer Module configurations to an XML file by right-clicking your
mouse on the Event Transactions node in the navigation pane. Float your mouse over the only
menu option that is displayed (Configuration). From the new menu that is now displayed, select
the Save Configuration option. The Save As window is displayed allowing you to specify the file
name and location.
Note: This action will only save the configuration settings for Event Transactions. To save
Scheduled Transaction configurations refer to Loading and Saving Scheduled Transaction
Configurations.
You can also load the Event Transfer Module configuration from an XML file by right-clicking your
mouse on the Event Transactions node in the navigation pane. Float your mouse over the only
menu option that is displayed (Configuration). From the new menu that is now displayed, select
the Load Configuration option. The Open window is displayed allowing you to browse for the
required file. By setting the options in the Configuration Loading Options window (accessed
from the Options page), you can choose how to the configuration is to be loaded.
Note: After the configuration is loaded, you need to re-open the configuration panels to view the
updated configurations.
Options
To configure event transaction options, access the Event Transaction Options page (Figure 105)
through the navigation pane.

Figure 105 - Event Transaction Options Page
Options Settings
Table 36 describes the Event Transaction Options page components. For more information, refer
to Accessing Event Transaction Options.
Limits the total amount of data that will be copied from the source to
destination per buffer. You should keep this number smaller than the
Transaction Buffer Size amount of memory available on your computer. The available range
is 0.01 through 128 MB.
Default = 10 MB
If either the data source or data destination becomes disconnected
during a transaction, this is the number of attempts that are made
Reconnection Attempts before the transaction is deemed a failure.
Default = 5
The total time that is delayed (in milliseconds) in between
reconnection attempts. This gives the disconnected
Reconnection Delay source/destination time to ‘become available’.
Buffer Transfer Attempts If a problem occurs during a transaction, this number will set how
many attempts will be made before the transaction is deemed a

failure.
Default = 5
A delay can be placed in between the buffer transfers to ‘throttle’ the
bandwidth being used during a transaction. Decreasing the
Transaction Buffer Size and increasing the Inter-Buffer Delay
Inter-Buffer Delay will decrease the total sustained bandwidth required for a
transaction.
Limits the number of transaction history items to be displayed in the
Selected Transaction History window. This number must be
Maximum History Elements between 1 and 500.
Default = 20
This is typically set to 1. This implies that all history transfers are
serialized. If users are worried about a transaction blocking the rest
Maximum Concurrent of the transactions (e.g., communication failure), increase this value.
Executing Transactions
WARNING: This value is a multiplier for the total buffer size!
Default = 1
If this is checked then Event Transaction will remember if there was
Save Transaction State
an event triggered when the application was stopped. Upon restart
between Restarts
the transaction will be completed
Enables/disables transaction logging at the specified detail level
Log Level
(High, Medium, Low, or None).
Log File Name Filename of the log file to store logged activity.
Apply Select this button to commit any changes made on this panel.
Cancel Select this button to cancel any changes made on this panel.
Table 36 - Event Transaction Options Components
Accessing Event Transaction Options

To access the Data Transfer Options page:
nodes:
 Desktop -> Localhost -> OPC Desktop Historian -> Event Transactions ->
Options
2. Click on the Configure item displayed under the Options node. Figure 105 displays the
navigation pane and the Event Transaction Options page.
Configuring Event Transaction Options

To configure event transaction processing and logging options:
1. From the Event Transaction Options page (refer to Accessing Event Transaction
Options), accept the default values displayed in the Process Properties screen section, or
make changes as required.

2. If changes are made in the Process Properties section, click on the Apply button to
commit the changes.
3. In the Logging screen section, accept the default values or make changes as required.
4. If changes are made in the Logging section, click on the Apply button to commit the
changes.
Version Information
Figure 106 displays the tree-view pane outlining the access to the version information and the
Event Transaction Version page.
Figure 106 - Event Transaction Version Information Panel
Accessing Version Information

To access Event Transaction Version information:
nodes:
 Desktop -> Localhost -> OPC Desktop Historian -> Event Transactions ->
Options
2. Click on the Version item displayed under the Options node. Figure 106 displays the
navigation pane and the Version page.

Customizing the Display
Tag Browser Docking
You can auto-hide the Tag Browser window by clicking on the push pin icon found in the right-
hand corner of the Tag Browser title bar (as shown in Figure 107). 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 107 - Tag Browser Title Bar
Figure 108 - 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 109). To return the Tag
Browser to its locked-in position, double-click your mouse on the Tag Browser title bar.

Figure 109 - 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:
1. Right-click your mouse anywhere in the Tag Workspace.
2. From the displayed menu, select the Set Visible Attributes (Shortcut) menu option
(Figure 110).
3. A sub-menu is displayed listing the available attributes. The currently visible attributes
are checked.
4. Click on an attribute to make it visible (checked) or invisible (not checked).

Figure 110 - 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.
1. Right-click your mouse anywhere in the Tag Workspace.
2. From the displayed menu, select the Set Visible Attributes menu option.
3. The Preferences window (Figure 111) is displayed.
4. Click on an attribute to make it visible (checked) or invisible (not checked).
5. Click on the Apply button to accept the attribute selection, and to close the
Preferences window to return to the Tag Workspace.

Figure 111 - Set Visible Attributes (Second Approach)
Colour Legend
The Legend window illustrates the different colors used for different information, including deleted
tags, changed attributes, invalid attributes, etc.
To display the Legend window:
1. Right-click 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 112 - Colour Legend

OPC Server Configuration
Desktop Historian’s OPC server runs properly without any configuration, but you can customize the
server’s 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 -
>Main Storage -> General
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 113) appears.
Figure 113 - New Alias Group Window

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 114 - 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 button from the Toolbar.

Or,
 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 115) appears. The wizard provides the necessary
guidance to create your own Alias.

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

Figure 116 shows the Alias Identity configuration step when the Basic Alias configuration option
has been selected in Step 1 of the Alias Configuration Wizard (Figure 115).

Figure 116 - Alias Configuration Wizard - Step 2: Alias Identity
Table 38 describes the Alias Identity configuration components.
Displays the path where the new Alias item will reside once created.
Alias Group
This field is read-only.
Allows you to enter a name for the Alias you are creating. This name
Alias Name
must be unique within the Alias Group.
Allows you to enter or select a fully-qualified item ID for the OPC
item to which the Alias refers. Click on the Browse OPC Tag button
to display the Browse OPC Tag window which can be used to select
an existing OPC item on the server.
OPC Tag Alternatively, leave the item path blank to use the Alias as a general
in-memory variable. When doing so, either define the data type for
the Alias point as something other than Default, or have the Alias
set for reading and define the data type while writing values to the
Alias from an OPC client.
Table 38 - Alias Configuration Wizard - Step 2: Alias Identity Components
Figure 117 shows the Browse OPC Tag window which allows you to browse for tags on existing
OPC servers.

Figure 117 - Browse OPC Tag Window
Table 39 describes the Browse OPC Tag window components.
Browser Allows you to browse the OPC servers available on your system.
Available Tags Displays the tags available in the selected OPC server.
Refresh Click on this button to refresh your browser.
Allows you to filter available tags using a string pattern. For example,
*a will display all tags starting with the letter a. Enter a string pattern
Filter in the field to the left of the Filter button. Select the Filter button,
and all applicable tags are listed in the Available Tags screen
section.
Click on this button to confirm the tag you have selected, and to close
OK
the Browse OPC Tag window.
Click on this button to cancel your selection and return to the previous
Cancel
window.
Table 39 - Browse OPC Tag Window Components

Figure 118 shows the Alias Properties configuration step when the Basic Alias configuration
option has been selected.
Figure 118 - Alias Configuration Wizard - Step 3: Alias Properties
Table 40 describes the Alias Properties configuration components.
From the drop-down list, allows you to set the value of the OPC item
Data Type to the specified type unless Default is selected. Also serves as the
“canonical” data type for the Alias.
When this checkbox is selected, OPC clients are prevented from
Read-Only
writing values to the Alias.
Select whether to continue polling for data even if the connected
Poll when Inactive
client sets the alias to an inactive state.
The rate at which alias will update its value. Set to 0 for the fastest
Update Rate
client update rate.
Table 40 - Alias Configuration Wizard - Step 3: Alias Properties Components
Figure 119 shows the Scaling Algorithm configuration step when the Basic Alias configuration

Figure 119 - Alias Configuration Wizard - Step 4: Scaling Algorithms
Table 41 describes the Scaling Algorithms configuration component.
Allows you to select, from the drop-down list, the required scaling
Scaling
option for the Alias.
Table 41 - Alias Configuration Wizard - Step 4: Scaling Algorithms Component
Figure 120 shows the Linear Scaling configuration step when the Basic Alias configuration option
has been selected.

Figure 120 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Linear Scaling)
Table 42 describes the Linear Scaling configuration components.
Raw High Maximum expected raw value of the OPC item.
Raw Low Minimum expected raw value of the OPC item.
Maximum desired scaled value for the Alias (corresponds to Raw
Scaled High
High).
Minimum desired scaled value for the Alias (corresponds to Raw
Scaled Low
Low).
Clamp the scaled value at the high limit to prevent it from going out
Clamp High
of range.
Clamp the scaled value at the low limit to prevent it from going out
Clamp Low
of range.
Table 42 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Linear Scaling)
Figure 121 shows the Square Root Scaling configuration step when the Basic Alias configuration

Figure 121 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Square Root Scaling)
Table 43 describes the Square Root Scaling components.
Raw High Maximum expected raw value of the OPC item.
Raw Low Minimum expected raw value of the OPC item.
Maximum desired scaled value for the Alias (corresponds to Raw
Scaled High
High).
Minimum desired scaled value for the Alias (corresponds to Raw
Scaled Low
Low).
Clamp the scaled value at the high limit to prevent it from going out
Clamp High
of range.
Clamp the scaled value at the low limit to prevent it from going out
Clamp Low
of range.
Table 43 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Square Root Scaling) Components
Figure 122 shows the Gain/Offset configuration step when the Basic Alias configuration option
has been selected.

Figure 122 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Gain/Offset Scaling)
Table 44 describes the Gain/Offset Scaling configuration components.
Gain Scaling factor. (No limits are assumed.)
Offset Scaling offset.
Table 44 - Alias Configuration Wizard - Step 4: Scaling Algorithms (Gain/Offset Scaling) Components
Figure 123 shows the Expression Scaling configuration step when the Basic Alias configuration

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

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

Figure 125 - Select Function Window
Table 47 describes the components of Select Function window
Displays the available categories for selection. Allows you to select the
Category
required category.
Displays the available functions associated with the selected category.
Available Functions
Allows you to select the required function.
Select this button to accept the selections made and return to the
Continue
initial Expression Wizard window.
Select this button to disregard the selections made and return to the
Cancel
Table 47 - Select Function Window Components
Figure 126 shows the Select Variable window of the Expression Wizard.
Figure 126 - Select Variable Window

Table 48 describes the Select Variable window components.
Displays the available variables for selection. Allows you to select the
Select variable
required variable.
Select this button to accept the selection made and return to the
OK
Select this button to disregard the selection made and return to the
Cancel
Table 48 - Select Variable Window Components
Figure 127 shows the Alias Events configuration step when the Basic Alias configuration option
has been selected.
Figure 127 - Alias Configuration Wizard - Step 5: Configure Alias Events
Table 49 describes the Alias Events configuration components.
Enable events Select whether to generate an event each time when the value of this alias changes.
for this Alias
Source The name of the source for the event.
Severity Severity of the alarm ranging from 1 to 1000.
Category The event category this event is registered to.
Trigger The trigger condition configures how an alias event is triggered.

Condition
Message Message that is displayed when the event is triggered.
Timestamp
Source
Table 49 - Alias Configuration Wizard - Step 5: Configure Alias Events
Calculation Alias Configuration

Figure 128 shows the Alias Identity configuration step when the Calculation Alias configuration
option has been selected in Step 1 of the Alias Configuration Wizard (Figure 115).
Table 50 describes the components of Alias Identity step when the Calculation Alias
configuration option has been selected.
Displays the path where the new Alias item will reside once created. This field is
Alias Group
read-only.
Allows you to enter a name for the Alias you are creating. This name must be
Alias Name
unique within the Alias Group.
OPC Tag OPC tags name
Browse OPC Tag Opens a dialog used to browse server address space and select desired tag.

Figure 129 shows the Alias Properties configuration step when the Calculation Alias
Table 51 describes the Alias Properties configuration components.
Select whether to continue polling for data even if the connected
Poll When Inactive
client sets the alias to an inactive state.
The rate at which alias will update its value. Set to 0 for the fastest
Update Rate
client update rate.
Figure 130 shows the Alias Calculation configuration step when the Calculation Alias

Figure 130 - Alias Configuration Wizard - Step 4: Alias Calculation
Table 52 describes the Alias Calculation configuration components.
Alias Calculation Allows you to enter a calculation equation.
Select this button to display the Insert OPC Tag window (i.e., Tag
Insert OPC Tag Browser –Figure 117) allowing you to insert OPC tags as part of the
calculation formula.
This field lists a wide selection of mathematical functions that can be
used as part of your Alias calculation configuration. Double-click your
Insert Function
mouse on the required function and it appears in the calculation
equation displayed in the Alias Calculation screen section.
Table 52 - Alias Configuration Wizard - Step 4: Alias Calculation Components
Figure 131 shows the Alias Events configuration step when the Calculation Alias configuration
has been selected.

Figure 131 - Alias Configuration Wizard - Alias Events
Table 53 describes the Alias Events configuration components.
When this checkbox is selected, Alias events are enabled for this
Enable events for this Alias
Alias item.
Source Allows you to enter the name of the source of the event.
Allows you to enter or select a value defining the severity of the
Severity
alarm. The allowable range is 1 through 1000.
Allows you to select, from the drop-down list, the event category
Category
under which the event is to be registered.
The Manage Categories button launches the Manage Events
Manage Categories Categories window (Figure 132) where you can create new
categories, as well as edit or delete existing categories.
Allows you to select, from the drop-down list, how the Alias event is
Trigger Condition
to be triggered: Value Change, Positive Edge.
Allows you to select, from the drop-down list, whether the
Timestamp Source timestamp for the Alias event is retrieved from the Server or the
Device (if it is different).
Allows you to enter a message that is to appear in the posted event.
This message can contain references to data items in the server.
Message
These references are replaced with the values of those items at the
time the event was generated.

Select this button to display the Browse OPC Tag window (Figure
Insert OPC Tag
117) which is used to add item paths to this field.
Table 53 - Alias Configuration Wizard - Alias Events Components
Figure 132 displays the Manage Event Categories window.
Figure 132 - Manage Events Categories Window
Table 54 describes the Manage Event Categories window components.
Select this button to access the New Event Category window (Figure 133) and
New
create a new category.
Select this button to edit the currently selected category.
Edit Note: This button is available only if at least one event category has been created
and selected.
Select this button to delete the selected category.
Delete Note: This button is available only if at least one event category has been created
and selected.
Select this button to close the Manage Event Categories window and return to
Close
Step 5 of the Alias Configuration Wizard.
Table 54 - Manage Event Categories Window Components
Figure 133 displays the New Event Category window.

Figure 133 - New Event Category Window
Table 55 describes the New Event Category window components.
This is an automatically-assigned field that identifies the newly-
Category ID
created category.
Name The name of the newly-created category.
Description A description of the newly-created category.
Table 55 - New Event Category Window Components
Holding Alias Configuration

Figure 134 displays the Alias Identity configuration step when the Holding Alias configuration

Table 56 describes the components of Step 2: Alias Identity when the Holding Alias
Displays the path where the new Alias item will reside once created.
Alias Group
This field is read-only.
Allows you to enter a name for the Alias you are creating. This name
Alias Name
must be unique within the Alias Group.
OPC Tag OPC tags name
Opens a dialog used to browse server address space and select
Browse OPC Tag
desired tag.
Figure 135 shows the Alias Properties configuration when the Holding Alias configuration option
has been selected.

Table 57 describes the components of Step 3: Alias Properties.
When this checkbox is selected, OPC clients are prevented from
Read-only
writing values to the Alias.
Default Value The default value of the holding Alias item created.
Editing Aliases
To edit an Alias:
1. From the Alias Configuration panel, select the Alias item you wish to edit.
2. Click on the button.

Or,
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.

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.

Or,
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.

Or,
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.
7. The Alias Group is removed.

Cloning Aliases
To clone an Alias:
1. From the Alias Configuration panel, select the Alias that you wish to clone.

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.

Or,
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 button.

Or,

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 change from
OFF to ON.
String comparisons are case-sensitive.
IF(INPUT = ‘SAMPLE’,’ON’,’OFF’)
OUTPUT
Table 58 describes the Expression Wizard fields.
Displays the expression as it is created. This field is free-form which
allows you to manually enter or edit information. This field reads Input
Input/Output Expression
Expression when creating an input or “read” expression. It reads
Output Expression when creating an output or “write” expression.
Select this button to display the Select Function window which allows
Function
you to select the necessary function from those available.
Select this button to display the Select variable window which allows
Variable
you to select the necessary variable from those available.
Select the applicable button to add the corresponding operator or
Operators
operators to the expression.
Clear Select this button to clear the Input/Output Expression field.
OK Select this button to accept changes to (or the creation of) the

expression.
Select this button to discard changes to (or abandon the creation of) the
Cancel
expression.
Table 58 - 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 124) 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 125) window. After
selecting the required function, click on the Continue button to bring up the Function
Parameter (Figure 136) window.
Figure 136 - Function Parameter Window
3. Complete the parameters as required.

5. Click on the Variable button to go to the Select variable (Figure 126) window. After
selecting the required variable, click on the OK button to close the Select variable window
and return to the Expression Wizard.

6. The Operators buttons (Figure 137) allow you to enter an operation descriptor based on
the selected button.
Figure 137 - 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:
 Desktop -> Localhost -> OPC Desktop Historian -> Options -> OPC Server->
Main Storage -> General
2. Click on the Logging Options item displayed under the OPC Server node. Figure 138
displays the navigation pane and Logging Options page.
Figure 138 - Logging Options Page

Table 59 describes the components of the Logging Options page.
Command Description
Selecting this checkbox enables general activity logging. If this
Enable server activity checkbox is not selected (i.e., the checkbox is cleared), none of the
logging 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
Low – Errors (default setting)
Log Level Medium – Errors and Warnings
Default = None.
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\
Filename PSTCFGMatrikon.OPC.DesktopHistorian.1.log.
If enabled, selecting this checkbox ensures that the old log file is
overwritten each time the server starts up. Otherwise, the old log file
Overwrite old log is renamed with an underscore (_) prefix.
information If the Enable server activity logging checkbox is not selected
By default, this checkbox is cleared.
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:
Commit all log file writes
 Wrap log file if it exceeds checkbox is cleared, and
 Enable server activity logging checkbox is selected
By default, this checkbox is neither enabled nor 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
Wrap log file if it exceeds
checkbox is unavailable.

Command Description
Filtered Log Settings
If this field is enabled, allows you to enter a match string for filtered
log.
Filter String
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
displayed in the Filename field.
Use this button to commit any changes made on the Logging
Apply
Options page.
Cancel
Options page.
Table 59 – Logging Options Page Components
Version
This page is display only and shows OPC server version information.
To view OPC server version information:
nodes:
 Desktop -> Localhost -> OPC Desktop Historian -> Options -> OPC Server ->
Main Storage -> General
2. Click on the Version item displayed under the OPC Server node. Figure 139 displays the
Version page.

Figure 139 - 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 -> Main Storage -> Advanced
2. Click on the Configure item displayed under the Server Options node. Figure 140 displays
the navigation pane and Server Options page.

Figure 140 - Server Options Page
Table 60 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 server’s
limit. Setting this value to 0 means that no limit is enforced on the
number of items returned.
Default value = 0.
Notes:
Maximum Return Values
 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
Apply Maximum Return
ReadRaw request that gathers the data necessary to calculate the
Values to Processed Reads
aggregate. If this limit is reached, the aggregate data returned will
not cover the entire requested time range.

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
Aggregate Overread 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.
Note: The maximum ReadRaw timespan is three times the original
ReadProcessed timespan, regardless of the number of intervals
configured in this field.
Use this button to commit any changes made on the Server
Apply
Options page.
Use this button to discard any changes made on the Server Options
Cancel
page.
Table 60 - 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

OPC Client Configuration
You can customize Desktop Historian’s OPC Client behavior by changing the client’s 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 ->
Main Storage
2. Click on the Configure item displayed under the OPC Client node. Figure 141 displays the
navigation pane and OPC Client Configuration page with the Client Settings tab
selected.
Figure 141 - Client Settings Tab (OPC Client)
Client Settings tab variables (i.e., fields) and functions are described in Table 61.

Command Description
Allows you to enter a value (in milliseconds) indicating the time
Delay after connection to wait before adding any items after connecting to the OPC
server.
Allows you to enter a value (in milliseconds) indicating the time
Delay to retry adding items
to wait before retrying to add the failed items.
Allows you to enter a value defining the maximum number of
Maximum retries during startup
retries to add items during start up.
Table 61 - 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 62.
Command Description
Allows you to enter the directory where the data files will be created.
Data buffer directory By default, this directory is: C:\Program Files\Matrikon\OPC\Desktop
Historian\OPC Client\Data Buffer\.
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
Maximum number of data in
client will make an intelligent judgement as to when to start buffering
cache
data to files, based on the current number of data in cache and this
maximum value.
Allows you to enter the maximum number of files to be created. By
Maximum number of files
default, this value is 20.
Allows you to enter the maximum file size (in MB) for each file. By
Maximum file size
default, this value is 25 MB.
Use this button to commit any changes made on the Client Settings
Apply
tab.
Use this button to discard any changes made on the Client Settings
Cancel
tab.
Table 62 - 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 142) 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]

Figure 142 - Logging Settings (OPC Client)
The Logging Settings tab variables (i.e., fields) and functions are described in Table 63.
Command Description
Log file directory 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:
None
Log level Low – Errors (default setting)
Medium – Errors and Warnings
Default = Low.
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
Log file size
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
Commit all log file writes selected, statements must be written to the log file as soon as they
are reported. No caching may be used.
Use this button to commit any changes made on the Logging
Apply
Settings tab.
Cancel
Settings tab.
Table 63 - Logging Settings Tab Components

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 ->
Main Storage
2. Click on the Version item displayed under the OPC Client node. Figure 143 displays the
Version page.
Figure 143 - OPC Client Version Information Page

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
User’s Manual.

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 144). If not, you can manually configure the Tag
Manager add-in for use (refer to steps 3 through 7).
Figure 144 - 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].
6. Note: [ ] indicates the default installation path.
7. Click on the TagMgr.xll file.
8. 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.

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.

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 145).

Figure 145 - 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 145) 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,

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 146).
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.

Figure 146 - 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).

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”.
Connecting to another Desktop Historian Instance

To connect to another Desktop Historian Instance:
1. From the Desktop Historian menu, select the Other Instances menu option. The
Desktop Historian Instance Selector window appears.
Figure 147 – Desktop Historian Instance Selector
2. In the Connect to Instance field, select an instance from the drop-down list.
3. Click OK.

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.

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 File Collector - currently not supported on Windows 7.
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. Insert/Replace is not supported in FF7R storage format. All data insertions must be
done using the Insert method call.
5. 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.
6. 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 User’s Manual for specific size requirement of
storage format FF7.
7. 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.
8. 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.
9. 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.
10. 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
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.
11. 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.
12. Communication failure - if communication failure occurs with a source OPC server,
Desktop Historian records a bad quality point in history. When communication is re-
established, 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.

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-AD78-
B3702370B733} \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
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 third-
party 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.
Data is not being updated
Problem: The OPC server does not report any new data for tags that should be updating.
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.
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.
History Transfer stops working after applying license
Problem: History Transfer stops working after applying license.

Solution: Open services panel from control panel OR type services.msc in the Run window to
launch service panel. Locate Matrikon Historical Data Transporter service. Restart the
service. If multiple instances of Matrikon Historical Data Transporter are created,
restart all the instances.

Main Storage not working after upgrade
Problem: Main storage not working after upgrade.

Solution: If ‘Main Storage’ was renamed before upgrade, the upgrade will revert the it back to
‘Main Storage’. After the upgrade if ‘Main Storage’ does not work as expected, rename
it back to the name given before upgrade.
Memory leak in History Transfer when ODH GUI is open.
Problem: Memory leak in History Transfer when ODH GUI is open.

Solution: Close the ODH GUI after doing configuration changes.
Component goes offline after modify
Problem: Component goes offline after modify

Solution: This issue can be resolved either by manual action or by running
ODHServiceUtility.exe
In the install path, locate ODHServiceUtility.exe under Util folder. For example if the
install path is C:\Program Files (x86)\Matrikon\OPC , ODHServiceUtility.exe can be
found under C:\Program Files (x86)\Matrikon\OPC\Desktop Historian\Util
Double click to run ODHServiceUtility.exe (needs Admin Privileges)
For manual action follow the steps given below.

Open Service Control Manager from Control Panel or type services.msc in Run
window to launch Service Control Manager. If service is in disable state, change the
state to Automatic. Start the service.
During Upgrade, user gets an error (Service could not be deleted)
Problem: During Upgrade, user gets an error (Service could not be deleted). This issue occurs
when Windows does not release lock on the service resulting in service not getting
deleted from registry and Service Control Manager. In such cases re-registration of
service fails. A reboot is required to release OS lock on the old service entry, before
service can be re-registered again.
Solution: This issue can be resolved either by manual action or by running
ODHServiceUtility.exe
In the install path, locate ODHServiceUtility.exe under Util folder. For example if the
install path is C:\Program Files (x86)\Matrikon\OPC , ODHServiceUtility.exe can be
found under C:\Program Files (x86)\Matrikon\OPC\Desktop Historian\Util
Double click to run ODHServiceUtility.exe (needs Admin Privileges)
For manual action follow the steps given below.

Open Service Control Manager from Control Panel or Type services.msc in Run

window to launch Service Control Manager. Locate the path and name of the
service’s .exe in the installed location.
If service is not showing in the control panel, open Command prompt. Use cd
command to move to .exe path and register the service from command line.
If service is showing in the Service Control Manager, but is not starting, reboot the
machine, to clear out the service entry from Service Control Manager. Then register
the service as mentioned above.
Exe Path and Name for ‘Main Storage’ instance of Desktop Historian
For ‘Main Storage’ service instance the .exe is located in Core folder in the installation
path. For eg if the installation path is C:\Program Files (x86)\Matrikon\OPC\Desktop
Historian the exe path is C:\Program Files (x86)\Matrikon\OPC\Desktop Historian\Core
EXE name is Archiver.exe
Command to register service for ‘Main Storage’

In the command prompt type cd C:\Program Files (x86)\Matrikon\OPC\Desktop
Historian\Core press enter key to move to exe location.
Type Archiver.exe –regserver, press enter key to register the service.
Verify that service is showing in Service Control Manager and is running. Verify that
Dependent services, MatrikonOPC Desktop Historian - OPC Client and MatrikonOPC
Server for Desktop Historian are also running. Start the services manually if required.
Exe Path and Name for other Desktop Historian Instances

For each instance a folder with instance name is formed under C:\Program Files
(x86)\Matrikon\OPC\Desktop Historian\Core. For example for instance 2 , folder is
C:\Program Files (x86)\Matrikon\OPC\Desktop Historian\Core\2
EXE name would be suffixed with _<instance number>. For example Archiver_2.exe
Command to register service for other Desktop Historian Instances (taking

example of instance 2)
In the command prompt type the following command and press enter key to register
the service.
sc create "name" start= auto binPath= "path" DisplayName= "name"
name = Name of the service
path = path of service exe\exe name
Example for instance 2
sc create "MatrikonOPC Desktop Historian (2)" start= auto binPath= "C:\Program Files
(x86)\Matrikon\OPC\Desktop Historian\Core\2\Archiver_2.exe" DisplayName= "MatrikonOPC
Desktop Historian (2)"
Verify that service is showing in Service Control Manager and is running. Verify that
Dependent services MatrikonOPC Desktop Historian - OPC Client(2) and MatrikonOPC
Server for Desktop Historian(2) are also running. Start the services manually if
required.
Exe Path and Name for ‘Main Transfer’ instance of History Transfer
For ‘Main Transfer’ service instance the .exe is located in Historical Data

Transporter folder in the installation path. For eg if the installation path is
C:\Program Files (x86)\Matrikon\OPC\ the exe path is C:\Program Files
(x86)\Matrikon\OPC \ Historical Data Transporter
EXE name is HistoricalDataTransporter.exe
Command to register service for ‘Main Transfer’

In the command prompt type cd C:\Program Files (x86)\Matrikon\OPC \ Historical Data
Transporter press enter key to move to exe location.
Type HistoricalDataTransporter.exe –service, press enter key to register the service.
Verify that service is showing in Service Control Manager and is running. Start the
services manually if required.
Exe Path and Name for other History Transfer Instances

For each instance a folder with instance name is formed under C:\Program Files
(x86)\Matrikon\OPC \ Historical Data Transporter. For example for instance 2, folder
is C:\Program Files (x86)\Matrikon\OPC \ Historical Data Transporter \2 is formed.
EXE name would be suffixed with _<instance number>. For example Historical Data
Transporter _2.exe
Command to register service for other History Transfer Instances (taking

example of instance 2)
In the command prompt Type the following command and press enter key to register
the service.
sc create "name" start= auto binPath= "path" DisplayName= "name"
name = Name of the service
path = path of service exe\exe name
Example for instance 2
sc create " Matrikon Historical Data Transporter (2)" start= auto binPath= "C:\Program Files
(x86)\Matrikon\OPC\Historical Data Transporter\2\ HistoricalDataTransporter_2.exe"
DisplayName= " Matrikon Historical Data Transporter (2)"
Verify that service is showing in Service Control Manager and is running. Start the
services manually if required.
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
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.
Matrikon Desktop Historian 5.0.x.x to 5.1.x.x version migration.
Problem: What is the safe mode of migrating from Matrikon Desktop Historian 5.0.x.x. to 5.1.x.x
version?

Solution: Do not uninstall 5.0.x.x. from the machine during migration. Uninstalling 5.0.x.x will
lead to configuration and data loss. Copy 5.1.x.x installer on the machine and run the
new installer to do safe upgrade.
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 server’s functionality.
The MatrikonOPC Desktop Historian supports both software and hardware licensing.
MatrikonOPC Desktop Historian Licensing

IMPORTANT TO NOTE:
The following licensing information is described in detail within the
Licensing Procedures document which accompanies the MatrikonOPC
Desktop Historian software and User’s 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.
Licensing MatrikonOPC Easy Trender

MatrikonOPC Easy 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 Matrikon Analytics Excel Reporter

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.
During the installation of MatrikonOPC Desktop Historian, you are given the option of installing a
demonstration version of Matrikon Analytics Excel Reporter, and/or MatrikonOPC Easy Trender. If a
permanent license is required, contact your Account Manager for more information.
Feature Licenses
Default License
Featured Component
State
AliasEvents 30-Day Demo
MatrikonOPC Desktop Historian 30-Day Demo
Desktop Historian Instances 30-Day Demo
Desktop Historian Tags 30-Day Demo

MatrikonOPC FileCollector 30-Day Demo
Security 30-Day Demo
Table 64 - Feature Licenses
Note: MatrikonOPC Desktop Historian, Security, Excel Reporter, and Easy 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 65.
Region Office Hours Contact Information

North America
8:00 am-5:00 pm +1-877-OPC-4-ALL
UTC/GMT -7 hours (MST)
South America
9:00 am-5:00 pm +55 (11) 3475-1846
UTC/GMT -3 hours (BRT)
Europe /Africa/Middle East +49-221-969-77-10
9:00 am-5:00 pm
UTC/GMT +1 hours (CET) (Request OPC Support)
Table 65 - 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 Contact Information

All* +1-780-231-9480
Table 66 - After-Hours Support
*Available only to priority and premium support customers.

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.

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

Figure 148 - 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 149) appears.

Figure 149 - 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 150) appears.

Figure 150 - Registry Value Permissions Window
9. To add users to the list click, Add.

10. The Add Users and Groups window (Figure 151) appears.
Figure 151 - 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.

12. When you are done adding users, click OK to close the Add Users and Groups window.
You can then choose to Allow Access or Deny Access for each user.
Notes:
 The procedure to set the launch permissions is similar to the above, but instead of
choosing Allow Access for a user you would choose Allow Launch.
 The Configuration Permissions contain an Access Control List of principals that are
allowed to modify the configuration information for a server. In other words, it
indicates who is allowed to alter the registry entries for installed servers as well as
who is able to access the registry for the purposes of installing new servers. It is
usually simpler to install and configure servers as a user with local administrative
rights.
13. To connect to an OPC server from outside of the domain, create a local user account on
both the server and the client machine with identical username and password. Then, add
the local user on the OPC server to the DCOM permissions. Use the local account on the
client machine to connect to the OPC server.
Server Identity
The Identity tab for a selected COM (or OPC) server specifies the user account that should be
used when COM starts up the process. The available settings are different for servers that run as
local executables as opposed to those that run as NT services.
Note: It is strongly recommended that OPC servers should be

installed to run as NT services if they are going to be accessed by
remote clients via DCOM. This ensures that the server can always be
accessed even if no one is presently logged on to the machine, and
only one server process ever starts up. It also adds a greater degree
of security in terms of who is able to shut down the server process.
Servers that run as local executables have the option of running as the launching user (the calling
client–this is the default), the interactive user (the one currently logged onto the machine), or a
specified user. It is usually best to use the interactive user or a specified user. Otherwise, remote
clients might start up multiple separate server processes that are not accessible to others.
Servers that run as NT services should generally run as the local System account. Alternatively,
the server can be set to run as a specified user, although this is usually done from the Service
Control Manager applet rather than DCOMCNFG. Access and Launch permissions are particularly
important when installing a server to run as an NT service.
Default Protocols
The Default Protocols tab specifies the communication protocols available to DCOM. The order
that protocols appear in the list indicates the priority in which they will be used (the topmost
having the highest priority).
The more protocols that appear in the list, the better the chances of connecting to an OPC server
on an unknown remote machine (such as at an OPC Interoperability Workshop). However, it may
also take longer for DCOM to time out if a server machine is not present since it has to try each
protocol in turn.
For most situations, it is best to remove all unused protocols from the list and only include those
that are necessary for your network. For example, on a TCP/IP network, one would include the
Connection-oriented TCP/IP protocol. Contact your IT personnel for more information about
your network.

Note: Evidence indicates that there are problems with the datagram-
oriented protocols (such as UDP/IP) that can cause memory leaks in
DCOM. Therefore, it is strongly recommended that these protocols be
removed from the list of default protocols. Datagram-oriented
protocols are not supported under Windows 2000 at all (although the
DCOM configuration utility still allows you to configure them).
Remote Program ID
Before the OPC Server Browser became available, OPC client applications had to search the
registry to generate a list of available OPC servers. Therefore, some older OPC clients need to have
a program ID in the local registry in order to connect to a particular OPC server.
The simplest solution is to install the OPC server software on the client machine even if it is not
used. Alternatively, use the following steps to copy a program ID to the client machine.
Note: This method may not work for every OPC client. Please check the client documentation for
more information.
WARNING: Any changes made to the registry must be made with

extreme caution!
1. Back up your registry.

2. On the server machine, run REGEDIT as a user that has access rights to the local registry.
3. Expand the HKEY_CLASSES_ROOT key.
4. Find the program ID(s) for the desired OPC server(s).
Note: In the case of 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.

Appendix B Aliases
Scaling Expressions
Alias scaling expressions may use any of the expression constructs listed in Table 67.
Construct Description Examples

Text value (single quotation marks). ‘hello’
‘text’
‘Joe’s Alias’
Addition (or Append), Subtraction, (3 * 7 + 1) / 8 – 2
+ - * /
Multiplication, and Division. ‘hi’ + ‘there’
Equal To, Less Than, Greater Than,
= < > <> <= >= Unequal To, Less or Equal To, 3<4
Greater or Equal To.
Logical Not, Logical And, Logical Or. (7 >= 3) And (1 <> 0)
Not And Or
May also be used for binary math. (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
Returns x if expression evaluates to
IF(expr, x, y) IF(6 <= 12, ‘OK’, ‘Bad’) = ‘OK’
TRUE, otherwise returns y.
TRUE FALSE Constant Boolean true and false. (5 > 6) = FALSE
Returns the data type of x as a text
TYPEOF(x) description (‘STRING’, ‘INTEGER’, TYPEOF(‘hello’) = ‘STRING’
‘FLOAT, ‘BOOLEAN’, ‘ERROR’).
Converts the numeric value x to
STR(x) STR(3.14) = ‘3.14’
text.
Converts the text value x to all UPPER(‘alarm’) = ‘ALARM’
UPPER(x)
upper case or lower case letters, or
LOWER(x) LOWER(‘ALARM’) = ‘alarm’
the first letter upper case and the
PRETTY(x) PRETTY(‘ALARM’) = ‘Alarm’
rest lower.
Returns a sub-string of the x,
COPY(x, start, length) copying length characters starting at COPY(‘FIDDLE’, 2, 4) = ‘IDDL’
start.
Converts the numeric value x to text FORMATNUMERIC('####.#',
FORMATNUMERIC(mask, x)
using the format mask. 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 value (single quotation marks). ‘hello’
‘text’
‘Joe’’s Alias’
Table 67 - Expressions Constructs for Alias Scaling
Advanced Calculations
Calculations may contain references to any OPC item in the server’s syntax. However, they may
not contain references to other alias items. There are no limits on how many items can be used in
a calculation. The only limiting factor may be performance related. To reference another OPC item
in the calculation, wrap the items full item path in square brackets. For example, to add the items
Com1.Rtu.Reg1 and Com1.Rtu.Reg2 together, the correct expression would be:
[Com1.Rtu.Reg1] + [Com1.Rtu.Reg2]
Advanced alias calculations may use any of the operators listed in Table 68.

- Minus operator. x-y
- Unary minus operator. -x
Not logical operator.
! !x
Returns 1 if x is 0, else returns 0.
Not equal logical operator.
!= x != y
Returns 1 if true, 0 if false.
Modulo; find remainder of the division
% x%y
of x by 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.
x <= y
== Equal logical operator.
x == y
> Greater than logical operator.
x>y
>= Greater than or equal logical operator. x >= y

Table 68 - Calculation Operators for Alias Scaling
Alias scaling calculations may use any of the functions listed in Table 69.
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 avg(v1,v2,v3,...)

values.
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*(x- fact(x)

1)*(x-2)*...(x-x+1).
floor Floor. floor(x)
hex Converts a hexadecimal number hex(hexNumber)

to a decimal number.
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 rand(min, max)

max.

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 69 - 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 70.
 Values containing commas are enclosed in double-quotation marks (“ ”).
 Double-quotation marks occurring inside quoted values are escaped with an extra double-
quotation mark.
 Lines beginning with a hash mark (#) are ignored (used for comments).
Field Description
Name of the alias group folder where the alias belongs. Periods in the name
Alias Group indicate subfolders below the root (e.g., North.FIC101 = alias group North
under the Alias Configuration root and alias group FIC101 under that).
Name of the alias. Full alias path name composed of the alias group path, a
Alias Name
period, and the alias name (e.g., North.FIC101.CV for an alias named CV).
Fully qualified item ID for the OPC item to which the alias refers. Leave this field
Item Path
blank to specify a holding register.
Data Type Decimal number indicating the data type for the alias.
Specifies whether the alias is read-only or read-write.
Read-only 0 = read-write
1 = read-only
Specifies whether the alias is polled continuously or not.
Poll Always 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 type for the alias.
0 = none
Scaling type 1 = linear
2 = square root
3 = gain/offset

Field Description
4 = expression
5 = 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 Initial value of a holding register.
Value
Event Enabled 0 if events are not to be generated, or 1 if events will be generated. If 0, all
other event fields can be left blank.
Event Source Text that appears as the data source in generated events.
Event Category 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.
Trigger type for the alias event.
TriggerType 0 = value change
1 = positive edge
Timestamp type for the alias event.
Timestamp Type 0 = server generated
1 = device generated
Table 70 - 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 71.
Field Description
High Raw Raw value range (double-precision real).
Low Raw
High Scaled Scaled value range (double-precision real).
Low Scaled
Clamp options.
0 = none
Clamp 1 = clamp low value
2 = clamp high value
3 = clamp both high and low values
Table 71 - Additional File Import/Export Field Descriptions - Linear/Square Root Scaling
When the scaling field specifies gain/offset (3) scaling, the first two scaling option fields are defined
as listed in Table 72. The other scaling option fields can be left blank.

Field Description
Gain Scaling factor (double-precision real).
Offset Scaling offset (double-precision real).
Table 72 - 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 73. The other scaling option fields can be left blank.
Field Description
Input Expression Simple formula applied to the value read from the OPC item.
Simple formula applied to values written to the OPC item. The
Output Expression
output formula should be the reciprocal of the input formula.
Table 73 - 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 74. The other scaling option fields can be left blank.
Field Description
Input Calculation Calculation applied to the value read from the OPC item.
Table 74 - Additional File Import/Export Field Descriptions - Calculation Scaling
Scaling Algorithms
For each type of scaling, a different algorithm (Table 75) is applied to values read from the OPC
item. A reverse algorithm is applied to any values written to the OPC item.
Scaling Algorithm/Example Reverse Algorithm/Example

 Scaled High  Scaled Low   Raw High  Raw Low 
Linear x  Raw Low    Scaled Low

x  Scaled Low    Raw Low
 Raw High  Raw Low   Scaled High  Scaled Low 
 Scaled High  Scaled Low   Raw High  Raw Low 

Square x  Raw Low    Scaled x  Scaled Low 2    Raw
 Scaled High  Scaled Low 
Root  Raw  Raw  Low 2  Low
 High Low  
Gain/ x  Offset
Gain  x  Offset
Offset Gain
Expression SQRT(INPUT) + 5 (OUTPUT – 5) * (OUTPUT – 5)
Table 75 - Scaling Algorithms

Appendix C Standard Data Types
The Standard data types and their descriptions are listed in Table 76.
Hex Dec Data Type Description

0000 0 VT_EMPTY Default/Empty (nothing)
0002 2 VT_I2 2-byte signed integer
0004 4 VT_R4 4-byte (single-precision) real
0005 5 VT_R8 8-byte (double-precision) real
0006 6 VT_CY Currency
0007 7 VT_DATE Date
0008 8 VT_BSTR Text (UNICODE)
000A 10 VT_ERROR Error code
000B 11 VT_BOOL Boolean (TRUE = -1, FALSE = 0)
0012 17 VT_UI1 1-byte unsigned integer
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
Table 76 - Standard Data Types

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 client’s 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.

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 browse able, 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

To run the MatrikonOPC Tag Security Configuration Utility for an Instance from Desktop
Historian Instance manager:
1. Select the instance from ‘Existing Instances’ in Desktop Historian Instance manager.
2. Click on Security.
Figure 152 – Desktop Historian Instance Manager
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 displayed asking for administrator access.
After Security button is clicked:

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 153) appears.
Figure 153 - 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 154) appears.
Layout
Figure 154 - 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 154 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 155). 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.
Figure 155 - 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.
2. The Add User window (Figure 156) appears. The NT User option button is selected by
default. This will allow the addition of a user from a Windows NT Domain.
Figure 156 - 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 157 for a sample list of defined users and
groups).
6. The Edit <Username> window (Figure 162) appears. Follow the instructions in the Edit
User section for adding permissions.

Figure 157 - 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 156) appears.
3. Select the Private User option button (Figure 158).

Figure 158 - Add User Window (Private)
4. In the Username field, enter a user name.

5. In the Password field, enter a password.
1. In the Password Confirmation field, re-enter the new password.
2. Click OK to create the Private user. It will be added to the list of users and/or groups
currently defined (refer to Figure 157 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.

2. The Add Group window (Figure 159) 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 159 - 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 157 for a sample list of defined users
and groups).
6. The Edit <Groupname> window (Figure 169) 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 159) appears.
3. Select the Private Group option button (Figure 160).

Figure 160 - 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 157 for a sample list of defined users and groups).
6. The Edit <Groupname> window (Figure 169) 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 161) appears.
Figure 161 - Enter New Name Window

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 server’s
address space hierarchy. A location can either be a tag (i.e., OPC Item ID) or a path leading up to
an item.
Edit User
To edit a user:
1. From the MatrikonOPC Tag Security Configuration Utility main screen, either:
 Double-click your mouse on the user you wish to edit, or
 Right-click your mouse on the required user and select Edit User from the displayed
menu, or
 Click your mouse on the required user, and then select the Edit button.
2. The Edit <Username> window (Figure 162) appears.

Notes:
 In this example, the user being edited is User1 so the window’s title reads Edit
User1.
 There are two tabs on this window: Permissions and General. The General tab
only appears for private users.

Figure 162 - 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 163 provides an example of a null branch and items below it, all of which are outlined in
black.

Figure 163 - 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 (Saw-
toothed Waves.Int1), and therefore the Saw-toothed Waves folder does not appear as a red
folder like the Simulation Items folder does.
Note: User permissions override group permissions. For example, if a defined group is denied
writing privileges to an OPC item, Random.Int4, while a defined user (a member of that group) is
allowed writing privilege to Random items (Random.<itemID>), then the user permissions would
take precedence for that OPC item (even though the permissions relating to the group are a better
match for the OPC item, Random.Int4).
To edit a user’s permissions:
1. Click on the Add button to begin configuring permissions for the current user.
2. The Add User Permission window (Figure 164) 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.

Figure 164 - Add User Permission Window
3. Expand on the server address space’s root node and continue to browse to the desired path
in the hierarchy, or the desired OPC item.
Note: Branches (i.e., folders) that are red in color (see Figure 165) are not part of an item’s
path, but rather are used for browsing organization. Configuring permissions for adding,
reading, and writing will not affect items below it. For more information, refer to
Permissions.

Figure 165 - 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 166.
Note: In this example, User1 is allowed to browse the Random path of the OPC server’s
address space. Adding privileges are denied, and Reading and Writing privileges are
unspecified.

Figure 166 - Edit <Username>: Example
On the General tab (Figure 167) of the Edit <Username> window, the name and password of
the user can be changed.
To edit a user’s name:
1. Enter a new name in the Name field.

Figure 167 - Edit <Username> Window (General Tab)
To change the user’s password:

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

3. Re-enter the password in the Password Confirmation field.

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 169) appears.
Notes:
 In this example, the group being edited is Group1 so the window’s 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 169 - 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
section regarding configuration on the Permissions tab. Group and user permissions are
configured in the same way.

On the General tab (Figure 170) of the Edit <Groupname> window, the name of the group can
be changed.
To edit a group’s name:
1. Enter a new name in the Name field.
Figure 170 - Edit <Groupname> Window (General Tab)
On the Members tab (Figure 171), the users that are part of the current group are defined. By
default, the Group Members screen section is empty. In Figure 171, User1 has been added to
Group1.

Figure 171 - 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 172) appears.

Figure 172 - 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 171).
To remove a user from the group:
1. Select that user in the Group Members screen section.
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
157), or
 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 154).
2. The Change Password window (Figure 173) appears.
Figure 173 - 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.

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. Run-
time 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 157), 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 157). 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.

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 166). 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 77:
User/Group Configured Paths Browse Add Read Write

Everyone \ Allow Allow Allow Allow
Table 77 - 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.

Example 1
Table 78 contains a possible tag security configuration enforces complete restricted access except
for the NT user DOMAIN\Admin:

Everyone \ Deny Deny Deny Deny
DOMAIN\Admin \ Allow Allow Allow Allow
Table 78 - 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 79 lists all defined users and groups and their
associated permissions. Table 80 indicates which users are members of the defined groups.
Unspec. permission indicates Unspecified. Groups in this example are Private Groups.

Everyone \ Allow Deny Deny Deny
Everyone Configured Aliases Deny Unspec. Unspec. Unspec.
DOMAIN\john.doe
DOMAIN\fred.stone
DOMAIN\sally.simpson
DOMAIN\the.admin
Supervisor \ Deny Allow Allow Deny
Restricted (group)
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
Table 79 - Example 2: Permissions
User/Group Configured Paths

Restricted DOMAIN\john.doe
Common DOMAIN\fred.stone, DOMAIN\sally.simpson
Admin DOMAIN\the.admin
Table 80 - 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

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.

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 174).
Figure 174 - InstallAware Wizard Verification Window
3. License Agreement (Figure 175) screen 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.

Figure 175 - License Agreement Screen
4. Read the End-User License Agreement, using the scroll bar to view the entire message.
5. Select the I accept the license agreement option button.
6. Click on the Next button. The Product Registration screen (Figure 176) appears.

Figure 176 - Product Registration Screen
7. 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.
8. Click on the Next button. The Setup Type screen (Figure 177) appears.

Figure 177 - Setup Type Screen
9. Select the type of setup to be performed.

Note: Matrikon recommends that you select the Complete Setup option.
10. Click on the Next button. The Destination Folder screen (Figure 178) appears.

Figure 178 - Destination Folder Screen
11. Select the folder in which to install MatrikonOPC Desktop Historian, or accept the default
location displayed in the Folder path field.
12. Click on the Next button. The Start Menu screen (Figure 179) appears.

Figure 179 - Start Menu Screen
13. 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.
14. Click on the Next button. The Enter Password screen (Figure 180) appears.

Figure 180 - Enter Password Screen
15. A default password is supplied for you in the Password and Confirm Password fields.
Notes:
 The default password provided for you is MatrikonOPC. Note
this password for future reference.
 If you need to change the password at a later date, access the
Tag Security shortcut from the Start menu. Click on the
Windows Start button. Select Programs -> MatrikonOPC ->
<OPC Product Name> -> Tag Security. For more
information, refer to Appendix D – Security.
16. Click on the Next button to accept the default password. The Licensing screen (Figure
181) appears.

Figure 181 - Licensing Screen
17. Select the applicable licensing option.
Notes:
 MatrikonOPC Easy Trender, Matrikon Analytics Excel Reporter
are optional components that are installed by the typical
installation type, or if selected for a custom installation. Please
consult the User’s Manuals installed with those programs
separately for more information on how to use those products.
When these components are installed, those User’s Manuals
are available through the Start menu in the following location:
Programs -> MatrikonOPC -> Desktop Historian -> Help -
> [Product Name] Manual

18. Click on the Next button. The Matrikon Analytics Excel Reporter screen (Figure 182)
appears.
Figure 182 - Matrikon Analytics Excel Reporter
19. 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.
20. Click on the Next button. The MatrikonOPC Easy Trender screen (Figure 183) appears.

Figure 183 - MatrikonOPC Easy Trender Screen
21. If you would like to install a demonstration version of MatrikonOPC Easy 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 Easy 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 Easy Trender license is not included with MatrikonOPC
Micro Historian and must be purchased separately. Contact your Account Manager for
assistance and more information.
22. Click on the Next button. The MatrikonOPC Desktop Historian - Installation Type
screen (Figure 184) appears.

Figure 184 - MatrikonOPC Desktop Historian – Installation Type Screen
23. If you would like to install the Desktop Historian only, choose the “Install as Standalone”
option. To install History Transfer along with Desktop Historian, choose “Install as Hub or
Spoke configuration”.
24. Click on the Next button. The MatrikonOPC Tunneller screen (Figure 185) appears.

Figure 185 - MatrikonOPC OPC Tunneller
 Check “Install MatrikonOPC Tunneller” button to install Tunneller. For Local or

workgroup user accounts, enter user account name in.\user name format. For
Domain user, enter user account name in Domain\username format.
25. Click on the Next button. The Ready to Install screen (Figure 186) appears.

Figure 186 - Ready to Install Screen
26. Click on the Next button Pre-Requisites screen (Figure 187) appears. If the Pre-
Requisites screen appears, then click on the Next button to install the listed pre-
requisites.

Figure 187 - MatrikonOPC Desktop Historian - Pre-Requisites
27. The Installing MatrikonOPC Desktop Historian Pre-Requisites screen (Figure 188)
appears installation of pre-requisites.

Figure 188 - MatrikonOPC Desktop Historian Pre-Requisites
28. Once pre-requisites are installed, the Installing MatrikonOPC Desktop Historian screen
(Figure 188) appears, installation begins, and the product files are copied to the computer.
29. Figure 188 - Installing MatrikonOPC Desktop Historian When the installation has
finished, the MatrikonOPC Desktop Historian Setup Complete screen (Figure 189)
appears stating that the MatrikonOPC server has been successfully installed.

Figure 189 - MatrikonOPC Desktop Historian 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
 User’s 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.

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 81 are installed by default, in the following location:
C:\Program Files\Matrikon\OPC\Desktop Historian
File Name Description

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 User’s Manual.
Table 81 - Files Installed in “Desktop Historian” Folder
C:\Program Files\Matrikon\OPC\Desktop Historian\Core

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.
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 82 - Files Installed in "Core" Folder
C:\Program Files\Matrikon\OPC\Desktop Historian\Database

Holds the information about the storage engine type, location, and
Archive_20030827052840.ECF
configuration.
Holds the list of configurable attributes for each item (i.e., not the
Attribute_20080327150700.ECF attribute values, just the meta information about the attribute
itself).
Holds the final version of the configured tags on clean ODH
Tag_20090507192209.ECF
shutdown for future use.
Tag_20120416215101.ELF Holds the tags and the attribute values for the tags
This is intended for user access control and holds defaults included
User_20030527183812.ECF
with the install.
Table 83 - Files Installed in "Database" Folder
C:\Program Files\Matrikon\OPC\Desktop Historian\OPC Client

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.
Table 84 - Files Installed in "OPC Client" Folder

C:\Program Files\Matrikon\OPC\Desktop Historian\OPC Server

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
Calculation Engine binary files.
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
ACL.sec Access control list containing users

and permissions configured for the
server.
Command-line security utility used to
ACLSecure.exe
encrypt/decrypt the ACL file.
MatrikonOPC Calculation Engine
AliasCalculationLib.dll
wrapper.
OPC server alias configuration panel
AliasControl.dll
DLL.
Security information file used by the
ProgID.txt
encryption utility.
Retains Alias configuration information
DefaultConfig.xml
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.
OPC server configuration control panel
ServerConfigControl.dll
DLL.
ServerOpts.ini OPC Server Option files.
Table 85 - Files Installed in "OPC Server" Folder
C:\Program Files\Matrikon\OPC\Desktop Historian\Task Scheduler

Log\ TaskScheduler.log TaskScheduler log information.
LogOptions.dll User Interface for Logging Options.
TaskScheduler.exe ODH Task Scheduler Service.
TaskScheduler.ic IC file for Task Scheduler.
TaskSchedulerControl.dll User Interface for the Backup Utility (Task Scheduler).
Table 86 - Files Installed in "Task Scheduler" Folder
The files listed in Table 87 are stored in the following directory:

C:\Program Files\Matrikon\OPC\Desktop Historian\Util

7z.dll Zip utility for backup functionality.

BackupTool.exe Command-line tool for backing up stored data.
TagMgr.xll Tag Manager Excel Add-in.
MatrikonOPC Desktop Historian Instances
InstancesManager.exe
Manager.
Table 87 - Files Installed in "Util" Folder

C:\Program Files\Matrikon\OPC\Desktop Historian\ Vigilant

lsapiw32.dll Licensing related library
ProductInfoChannelControl.dll Support dll for Vigilant service
SchedulerState.vig Configuration related content for Vigilant
security.cfg Configuration related file
StartupLicensing.txt Configuration related file
Vigilant.exe Exe for MatrikonOPC Vigilant service
Vigilant.txt Log related to Vigilant
VigilantConfigControl.dll Vigilant UI related dll
VigilantEE.txt Log related to event engine
Table 88 - Files Installed in "Vigilant" Folder

C:\Program Files\Matrikon\OPC\Desktop Historian\ Historical Data Transporter

HDMDefaultConfig.hdt Schedule Transaction configuration file
HDMSchedulerConfigControl.dll Schedule Transaction UI dll
HDMTasks.hdt Schedule Transaction configuration file
HDMTransactions.hdt Schedule Transaction configuration file
HistoricalDataTransporter.exe Exe for History Data Transporter service
HistoricalDataTransporter.txt Log for History Data Transporter
InstanceInfo.txt Contains Instance information
lsapiw32.dll Licensing related dll
ProductInfoChannelControl.dll Support dll for History Data Transporter
security.cfg Configuration related file
StartupLicensing.txt Configuration related file
Table 89 - Files Installed in " Historical Data Transporter" Folder

The files listed in Table 90 are installed in the system’s Global Assembly Cache
(C:\WINDOWS\assembly):

Syncfusion.Core.dll Syncfusion Library, Version 4.401.0.51
Syncfusion.Core.dll Syncfusion Library, Version 4.402.0.51
Syncfusion.Edit.Windows.dll Syncfusion Library, Version 4.401.0.51
Syncfusion.Edit.Windows.dll Syncfusion Library, Version 4.402.0.51
Syncfusion.Grid.Base.dll Syncfusion Library, Version 4.401.0.51
Syncfusion.Grid.Base.dll Syncfusion Library, Version 4.402.0.51
Syncfusion.Grid.Windows.dll Syncfusion Library, Version 4.401.0.51
Syncfusion.Grid.Windows.dll Syncfusion Library, Version 4.402.0.51
Syncfusion.Shared.Base.dll Syncfusion Library, Version 4.401.0.51
Syncfusion.Shared.Base.dll Syncfusion Library, Version 4.402.0.51
Syncfusion.Shared.Windows.dll Syncfusion Library, Version 4.401.0.51
Syncfusion.Shared.Windows.dll Syncfusion Library, Version 4.402.0.51
Syncfusion.Tools.Base Syncfusion Library, Version 4.401.0.51
Syncfusion.Tools.Base Syncfusion Library, Version 4.402.0.51
Syncfusion.Tools.Windows.dll Syncfusion Library, Version 4.401.0.51
Syncfusion.Tools.Windows.dll Syncfusion Library, Version 4.402.0.51
Table 90 - Files Installed in Global Assembly Cache
C:\Program Files\Common Files\MatrikonOPC\Common

MatrikonOPC Tag Security Configuration Utility
ACLConfig.exe that configures tag-level security in MatrikonOPC
servers.
ClientToolkit.dll ClientToolkit.dll
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 MatrikonOPC Product Configuration Utility.
Marshal.log MatrikonOPC Product Configuration Utility.
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.
MatrikonOPC Automation Component – enables
developers to access OPC data from client
OPCAuto.dll
applications developed using Automation tools
such as Visual Basic, VBA, and VB Script.
MatrikonOPC Automation Component Interface
opcda20_auto.doc
Standard
MatrikonOPC Automation Component – enables
developers to access OPC data from client
OPCDAAuto.dll
applications developed using Automation tools
Developer documentation for the HDA
opchda10_auto.doc
Automation Component.
The proxy-stub file to allow OPC Clients to make
opchda_ps.dll
remote connections to an OPC HDA server.
MatrikonOPC HDA Automation Component –
enables developers to access OPC HDA data from
OPCHDAAuto.dll
client applications developed using Automation
tools.
PSTCFG.exe MatrikonOPC Product Configuration Utility.
PSTCFGInterface.dll MatrikonOPC Product Configuration Library.
MatrikonOPC Product Configuration Marshalling
PSTcfgps.dll
Library.
PSTCFGMatrikon.OPC.DesktopHistorian.1.log ODH log information.
PSTCFGMatrikon.OPC.DesktopHistorian.1.log.bak ODH log information backup.
Table 91 - Files Installed in "Common" Folder
The files listed in Table 92 are installed in the WINDOWS\system32 folder:

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.
MatrikonOPC Automation Component – enables developers to access
OPCDAAuto.dll 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 92 - Files Installed in "system32" Folder

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 190) is displayed.
4. Scroll through the list of currently installed programs and updates to find and select
MatrikonOPC Desktop Historian.
Figure 190 – Add or Remove Programs
5. Click on the Remove button associated with the MatrikonOPC Desktop Historian program to
initiate the un-install process.

6. The MatrikonOPC Desktop Historian – InstallAware Wizard appears, and the Welcome
to MatrikonOPC Desktop Historian Maintenance screen (Figure 191) is displayed.
Figure 191 - 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 192) is displayed.

Figure 192 - Ready to Uninstall Screen
9. Click on the Next button.

10. The Uninstalling MatrikonOPC Desktop Historian screen (Figure 193) appears and the
un-install takes place.

Figure 193 - Uninstalling MatrikonOPC Desktop Historian Screen
11. When the un-install has finished, the MatrikonOPC Desktop Historian Setup Complete
screen (Figure 194) appears stating that MatrikonOPC Desktop Historian was successfully
un-installed.

Figure 194 - 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.

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 (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
millisecond. This would result in a historical data sample approximately 11 to 15 bytes in size (per
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.
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 Historian’s 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
millisecond. This would result in a historical data sample approximately 11 to 15 bytes in size (per
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.

Appendix I Attributes
Name Data Type Description

Description String Describes the tag.
Engineering Units String The tag’s units.
Determines whether historical data should be
Stepped Boolean
displayed as stepped or interpolated.
Determines whether the system is currently recording
Archiving Boolean
data for the tag.
Node Name String The source machine for this tag.
The source process for this tag. If the source is OPC,
Process Name String
this represents an OPC Server.
The source name of the tag. If the source is OPC, this
Source Name String
represents an Item ID.
What sort of source provides data for this tag? The
Source Type String
default source is OPC.
The upper limit for the tag’s normal value range.
Normal Maximum Floating Point Values collected that are above this value will be
replaced with the normal maximum
The lower limit for the tag’s normal value range.
Normal Minimum Floating Point Values collected that are below this value will be
replaced with the normal minimum.
The changed amount must be greater than the
exception deviation value for the new tag value to be
Exception Deviation Value Floating Point
recorded. This is ignored if the Deviation Type is
disabled.
Determines whether the Exception Deviation
Algorithm is:
 An absolute change.
 A percentage change of the High/Low span.
Exception Deviation Type Integer
 A percentage change from the previous value.
 Ignored/disabled.
By default, Exception Deviation is disabled.

Highest valid value for a tag – top of span. Values
High Limit Floating Point outside the range bound by the High and Low limit
will not be archived.
Lowest valid value for a tag – bottom of span. Values
Low Limit Floating Point 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-

Name Data Type Description
based index).
Provides additional item access details. Specific to
Access Path String
OPC.
The real-time update rate for the tag (in
Update Rate Integer
milliseconds).
Determines if the Desktop Historian computer system
Use System Timestamp Boolean clock time should be used instead of the OPC server-
provided time.
The number of milliseconds (positive or negative)
Timestamp Bias Integer that should be added to the timestamp to adjust for
differences between clocks.
Determines if the Tag Lifetime feature is enabled for a
Tag Lifetime Enabled Boolean
tag.
If the Tag Lifetime feature is enabled, and a tag has
not had an updated value sent to the Desktop
Lifetime Update Rate Integer Historian OPC client for this amount of time in
milliseconds, a read command will be used to obtain
an updated value.
Selects that the OPC client should use either
Lifetime Read Interface String Synchronous IO (SYNC) or Asynchronous (ASYNC)
IO to read a tag for a lifetime update.
Table 93 - Attributes

Appendix J Desktop Historian Data Types
Data Type Description

NONE Default – empty
BOOL 1-byte Boolean (FF7 & FF7R storage formats only)
INT1 1-byte signed integer
UINT1 1-byte unsigned signed integer
FLT4 4-byte real
FLT8 8-byte real (FF7 & FF7R storage formats only)
STR Text (UNICODE) (FF7 & FF7R storage formats only)
Table 94 - Desktop Historian Data Types

Appendix K Third-Party Licensing
Syncfusion Essential Studio 4.4.0.51
© 2001-2005 Copyright Syncfusion Inc.

Appendix L Sample Custom Script

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 95) 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.
The start of the current second. For example, if the time is now 08:54:20.999,
SECOND
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 95 - Keywords
Relative time offsets consist of a sign (e.g., + or -), an integer count, and an offset unit (Table 96).
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

S Second
M Minute
H Hour
D Day
W Week
MO Month
Y Year
Table 96 - Offset Units
Table 97 lists some sample relative times.
Relative Time If NOW is 2008-01-02

Description
Example 6:30:27.525 AM UTC, then…
NOW-1D Exactly one day ago from now. 2008-01-01 6:30:27.525 AM
DAY-1D Yesterday at 12:00 a.m. 2008-01-01 12:00:00.000 AM
DAY-1D+2H Yesterday at 2:00 a.m. 2008-01-01 2:00:00.000 AM

Relative Time If NOW is 2008-01-02
Description
Example 6:30:27.525 AM UTC, then…
DAY-1D+2h+30M Yesterday at 2:30 a.m. 2008-01-01 2:30:00.000 AM
Yesterday at 2:30 a.m. The second plus 2008-01-01 2:30:00.000 AM
DAY-1D+2H30M sign (+) can be omitted because it is
assumed.
Equivalent to NOW-1W which is one week 2007-12-26 6:30:27.525 AM
-1W
ago from the current time.
Note that 2008-01-02 fell on a 2007-12-30 12:00:00.000 AM
WEEK Wednesday, and assuming the locale
starts the week on Sunday.
Note that 2008-01-02 fell on a 2007-12-23 12:00:00.000 AM
WEEK-1W Wednesday, and assuming the locale
starts the week on Sunday.
One hour and 30 minutes ago from now. 2008-01-02 5:00:27.525 AM
Since no keyword was provided, NOW
was assumed. The sign on 30M is
-1H30M
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
Table 97 - Relative Time Examples

Appendix N HDA Aggregate Functions
The following HDA aggregate functions are available in the MatrikonOPC Desktop Historian:
Function Description
Performs a straight line interpolation between the known data
Interpolative
points within the selected interval.
Time weighted average data over the line produced by the
TimeAverage
interpolative aggregate.
The minimum raw GOOD value that occurs within the selected
interval. This value is returned with the time stamp at which it
MinimumActualTime
occurs. If there are multiple occurrences, then the oldest time
stamp is returned.
The same as the MinimumActualTime aggregate except that
Minimum the time stamp returned is the beginning of the selected
interval.
The maximum raw GOOD value that occurs within the selected
interval. This value is returned with the time stamp at which it
MaximumActualTime
occurs. If there are multiple occurrences, then the oldest time
stamp is returned.
The same as the MaximumActualTime aggregate except that
Maximum the time stamp returned is the beginning of the selected
interval.
Interpolates both end points, divides the time between timeold
and timenew into intervals and returns the lowest or highest
MatrikonAggregate_TrendFriendly value for each interval.
* timeold and timenew are the bounds of the selected interval.
Table 98 - HDA Aggregate Functions

Appendix O MatrikonOPC Desktop Historian
5.1.x.x. or Higher Version Compatibility Matrix
This section lists out the compatibility between MatrikonOPC Desktop Historian 5.1.x.x or higher
and different versions of MatrikonOPC Desktop Historian.
Installed Version 5.1.x.x. or Higher Installer behavior

5.1.x.x or higher version can be installed
MatrikonOPC Desktop Historian 4.7.0
either as stand-alone or Hub\Spoke
With History Link 4.0.7 installed, 5.1.x.x or
higher version can only be installed as
MatrikonOPC Desktop Historian 4.7.0 with stand-alone. Once History Link 4.0.7 is
History Link 4.0.7 uninstalled, 5.1.x.x or higher version can
be installed either as stand-alone or
Hub\Spoke
MatrikonOPC Desktop Historian 5.0.x.x. as 5.1.x.x or higher version can be installed
Stand-Alone either as stand-alone or Hub\Spoke
MatrikonOPC Desktop Historian 5.0.x.x. as 5.1.x.x or higher version can only be
Hub and Spoke installed as Hub\Spoke
Table 99 - MatrikonOPC Desktop Historian Compatibility

OPC Desktop Historian Manual PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

OPC Desktop Historian Manual PDF

Uploaded by

Copyright:

Available Formats

MatrikonOPC Desktop Historian

This manual is a product of Matrikon International

Document Revision History:

2006-03-30 2.0 Added section of “Refresh Tag List”. Added EW

Applied new template. Updated procedures, and

Added Tag Management toolbar functionality;

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 2

2009-03-17 8.2 Added additional password information for Backup CHB

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 3

Updated Contacting Support section. Added Quick

Updated software version to 4.4.0.0. Updated

Limitations section updated to include a limitation

2010-02-03 13.0 Updated software version to 4.4.1.0. CB, LB

Updated Software Requirements and Limitations

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 4

Updated Software Requirements section and Log

2013-04-29 17.2 Updated software release version to 4.6.1. SG

2013-07-29 17.3 Updated software release version to 4.6.2. MK

Updated software release version to 5.0.0. New

2017-01-16 19.0 Updated software release version to 5.1.0. MB

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 5

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 6

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 7

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 8

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 9

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 10

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 11

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 12

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 13

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 14

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 15

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 16

Who Should Use This Manual

This symbol denotes important information that must be

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

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 17

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 18

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 19

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 20

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

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

For Matrikon Analytics Excel Reporter:

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 21

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 22

Launching the MatrikonOPC Desktop Historian

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 23

Table 2 describes the components of the Configuration window.

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 24

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 25

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 26

When selected, allows you to quickly navigate to previously-accessed

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 27

Cascade Cascades the currently-opened windows within the configuration.

Horizontally arranges the currently-opened windows within the

Closes all currently-opened windows in the configuration. The product

Starting and Stopping MatrikonOPC Desktop Historian

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 28

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 29

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 30

Table 9 describes the fields on the Log Settings tab.

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 31

Figure 4 - Version Information Tab

MatrikonOPC Desktop Historian v5.1.0 User’s Manual 32