OPH070

Version 4
September 2020

Ovation™
Process Historian User Guide
About this manual
Welcome to the Emerson Ovation distributed control system. Ovation is a highly reliable and responsive
real-time plant monitoring and process control system that uses commercially available hardware platforms,
operating systems, and open network technology.

This manual provides an overview of the Ovation Process Historian. The Ovation Process Historian collects
process values and messages that are generated by your Ovation control system and stores these values and
messages in an optimized historical data store that runs on a Microsoft Windows platform. You can use the
historian to better understand the typical and abnormal behavior of your plant processes, to identify
common trends, to explore abnormalities, and to diagnose process flaws and failures.

The information in this manual represents the recommended standards and procedures. If your system
requires a different configuration, contact your Emerson service representative or sales office for help with
the review of your system. It is assumed that all installation and maintenance procedures described in this
document will be performed by qualified personnel and that the equipment used is only for the purposes
described. Using alternate methods of installation or configuration could yield undesirable results.

Summary of changes
This 3.7.1 version of the Ovation Process Historian User Guide includes the following new information:

• Historian terminology [19] updated to explain that when Auto Historian is specified as the Historian for
a trace item, it determines which historian from the list of configured historians is to be used as the data
source; updated to include Controller, DEC module, COMTRADE, and High Speed Data Recorder
definitions.
• Trend data view [355] updated to explain that the context ribbon tab for the Historical Trend provides
ways to customize and navigate the historical data display.
• To add a point to a Historical Trend [366] updated to describe specifying point information to include
number of data samples or trace sample interval type, multiplier, and alignment.
• Event Trends [393] section updated to include COMTRADE and High Speed Data Recorder in list of event
filter types.
• Event types [400] describes the Controller, DEC module, High Speed Data Recorder (HSDR), and
COMTRADE event types.
• Message History Tables [563] updated to include Operator Events.

Versions and software requirements

The Ovation Process Historian User Guide was prepared for the Ovation Process Historian (OPH) 3.7.1
release. This release is compatible with Ovation 3.5.1, 3.6 Feature Pack 4, and 3.7 Feature Pack 1 and later
releases.

Conventions used in this manual

For security purposes, actual IP addresses are not used in Ovation user manuals. The IP addresses used in this
manual are for example purposes only and should not be used in an actual system.
Copyright Notice
Since the equipment explained in this document has a variety of uses, the user and those responsible for applying
this equipment must satisfy themselves as to the acceptability of each application and use of the equipment.
Under no circumstances will Emerson Process Management Power and Water Solutions, Inc. (Emerson) be
responsible or liable for any damage, including indirect or consequential losses resulting from the use, misuse, or
application of this equipment.

The text, illustrations, charts, and examples included in this manual are intended solely to explain the use and
application of the Ovation™ Unit. Due to the many variables associated with specific uses or applications, Emerson
cannot assume responsibility or liability for actual use based upon the data provided in this manual.

No patent liability is assumed by Emerson with respect to the use of circuits, information, equipment, or software
described in this manual.

No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any
means, including electronic, mechanical, photocopying, recording or otherwise without the prior express written
permission of Emerson.

The document is the property of and contains Proprietary Information owned by Emerson and/or its
subcontractors and suppliers. It is transmitted in confidence and trust, and the user agrees to treat this document
in strict accordance with the terms and conditions of the agreement under which it was provided.

This manual is printed in the USA and is subject to change without notice.

Ovation is the mark of Emerson. Other marks are the property of their respective holders.

Copyright © Emerson Process Management Power & Water Solutions, Inc. All rights reserved.

Emerson Process Management Power & Water Solutions, Inc.

200 Beta Drive
Pittsburgh, PA 15238
USA

Email: [Link]@[Link]
Web site: [Link]
 Contents

Contents
Section 1 Introduction to the Ovation Process Historian ...................................................................... 17
1.1 Ovation Process Historian overview .................................................................................... 17
1.1.1 Functions performed by using the Ovation Process Historian ......................................... 17
1.1.2 Advantages of the Ovation Process Historian .............................................................. 18
1.2 Historian component overview ......................................................................................... 18
1.3 Historian terminology ..................................................................................................... 19
1.4 Historian server redundancy ............................................................................................. 22
1.5 How does the historian work? ........................................................................................... 23
1.6 Scanning data ............................................................................................................... 23
1.6.1 How the scanners handle missing data ..................................................................... 24
1.6.2 How the scanners handle time ................................................................................ 24
1.6.3 How the scanners pass data to storage ..................................................................... 25
1.6.4 How the scanners are configured ............................................................................ 25
1.6.5 Using redundant scanners ..................................................................................... 25
1.7 Storing data .................................................................................................................. 27
1.8 Archiving data ............................................................................................................... 28
1.8.1 How archive functions are configured? ..................................................................... 30
1.9 Retrieving data .............................................................................................................. 30
1.9.1 How to retrieve data by using the historical reports? .................................................... 31
1.9.2 How to retrieve data by using the Historical Reviews? ................................................... 32
1.9.3 How to retrieve data by using the Historical Trends? .................................................... 32
1.9.4 How to retrieve data by using the History Manager? .................................................... 32
1.10 Historian security ......................................................................................................... 33
1.11 Using wildcard characters for retrieving data ...................................................................... 34
1.11.1 Escape characters .............................................................................................. 34

Section 2 Requirements for the historian ........................................................................................... 35

2.1 Hardware requirements for the historian ............................................................................. 35
2.1.1 Historian disk partitioning ..................................................................................... 35
2.2 Software requirements for the historian .............................................................................. 36

Section 3 Planning the historian ....................................................................................................... 37

3.1 Historian planning overview ............................................................................................. 37
3.2 How many historians do you need? .................................................................................... 38
3.2.1 Reasons to use multiple historians ........................................................................... 38
3.2.2 Reasons to use a single historian for multiple units ...................................................... 38

OPH070 5
Contents

3.2.3 Reasons to use an embedded historian ..................................................................... 38

3.2.4 Do you need redundant historian servers? ................................................................. 39
3.3 How many scanners do you need? ...................................................................................... 39
3.4 How will you archive your data? ......................................................................................... 40
3.5 Who are your end users? .................................................................................................. 41
3.6 Do you need to migrate eDB or HSR data to your new historian? ................................................ 42
3.7 Will you need any third-party software? .............................................................................. 42
3.8 What are the Desktop Tools? ............................................................................................ 42
3.8.1 Do you want to use the Desktop Tools? ..................................................................... 42

Section 4 Installing the historian ....................................................................................................... 43

4.1 Installing the historian overview ........................................................................................ 43
4.2 To install the historian ..................................................................................................... 43
4.2.1 What are different OPH installation scenarios? ............................................................ 53
4.3 To uninstall historian components or change your installation .................................................. 53

Section 5 Configuring the historian ................................................................................................... 55

5.1 Configuration overview ................................................................................................... 55
5.2 To configure a historian for the first time on a Windows-based system ........................................ 56
5.3 To access the Historian Configuration Tool window for Windows-based systems ........................... 58
5.4 Components of the Historian Configuration Tool window ........................................................ 61
5.5 Historian Configuration Tool menu button ........................................................................... 62
5.6 Quick Access Toolbar ...................................................................................................... 62
5.6.1 To remove an existing option from the Quick Access Toolbar .......................................... 63
5.6.2 To add a new option in the Quick Access Toolbar ......................................................... 63
5.6.3 To show Quick Access Toolbar below the ribbon bar ..................................................... 63
5.6.4 To show Quick Access Toolbar above the ribbon bar ..................................................... 64
5.6.5 To hide or minimize the ribbon bar .......................................................................... 64
5.6.6 To view the hidden or minimized ribbon bar ............................................................... 64
5.7 Menu bar ..................................................................................................................... 64
5.8 Ribbon bars .................................................................................................................. 64
5.8.1 Home ribbon bar ................................................................................................. 65
5.8.2 Tools ribbon bar .................................................................................................. 65
5.8.3 Edit ribbon bar (under the Points menu) .................................................................... 68
5.9 Left pane of the Historian Configuration Tool window ............................................................. 70
5.9.1 Historian Details tab ............................................................................................. 70
5.9.2 Storage Media tab ............................................................................................... 71
5.10 Right pane of the Historian Configuration Tool window ......................................................... 72
5.10.1 Historian Properties tab ...................................................................................... 73
5.10.2 Scanners tab ..................................................................................................... 74
5.10.3 Main Storage tab ............................................................................................... 75

6 OPH070
 Contents

5.10.4 Archive Storage tab ............................................................................................ 76

5.10.5 Functionality of a grid view .................................................................................. 77
5.10.6 Functionality of a card view .................................................................................. 81
5.11 Status bar ................................................................................................................... 85
5.12 To export data to an XML file ........................................................................................... 86
5.13 To import data from an XML file ....................................................................................... 89
5.14 To configure a historian server ......................................................................................... 91
5.15 To configure a main storage ............................................................................................ 94
5.16 To configure an archive .................................................................................................. 96
5.16.1 To configure a fixed archive .................................................................................. 96
5.16.2 To configure a removable archive .......................................................................... 98
5.17 To configure a scanner ................................................................................................. 100
5.17.1 Scanning data ................................................................................................. 104
5.18 To configure a point scan group ..................................................................................... 105
5.19 To configure historian points ......................................................................................... 110
5.20 Configuring your Ovation system to enable the collection of historical messages or events .......... 115
5.20.1 To configure Ovation alarm event scanning ............................................................ 115
5.20.2 To configure Ovation operator event scanning ........................................................ 118
5.20.3 To configure Ovation Sequence of Events scanning .................................................. 119
5.20.4 To configure Triggered Events ............................................................................. 123
5.21 To load your configuration to the historian on a Windows-based system .................................. 125

Section 6 Licensing the historian ..................................................................................................... 127

6.1 Licensing overview ....................................................................................................... 127
6.2 To obtain your locking code ............................................................................................ 128
6.3 To obtain your license key .............................................................................................. 130
6.4 To enable your license ................................................................................................... 130
6.5 To verify your installed licenses ........................................................................................ 133

Section 7 Recovering from OPH Server failure .................................................................................. 135

7.1 OPH Server storage failure and recovery overview ................................................................ 135
7.1.1 Recovery of the OPH runtime environment .............................................................. 136
7.1.2 Recovery of historical data ................................................................................... 136
7.2 Possible OPH Server failure scenarios ................................................................................ 137
7.3 Recovering the OPH Server runtime environment ................................................................ 138
7.3.1 To restore the failed OPH Server runtime software using re-installation media ................. 139
7.3.2 To restore the failed OPH Server runtime software using SBR ....................................... 141
7.3.3 Post runtime software restore steps ....................................................................... 141
7.4 Recovering the main storage historical data ....................................................................... 146
7.4.1 To recover the main storage for a redundant OPH Server ............................................. 146
7.4.2 To recover the main storage for a standalone OPH Server ............................................ 148

OPH070 7
Contents

7.4.3 To recover the main storage in case of an external RAID failure ..................................... 148
7.5 Recovering the fixed archive storage ................................................................................. 149
7.5.1 To re-archive historical data from main storage ......................................................... 150

Section 8 Configuring the NAS ....................................................................................................... 153

8.1 Using the Network Attached Storage (NAS) unit .................................................................. 153
8.2 Configuring the OPH NAS .............................................................................................. 153
8.2.1 To install hard drives ........................................................................................... 154
8.2.2 To configure a PC and connect it to the NAS ............................................................. 155
8.2.3 To perform an initial OS load ................................................................................ 161
8.2.4 To log on for the first time and to set the IP address of the OPH NAS ............................... 169
8.2.5 To access the OPH NAS main window ..................................................................... 175
8.2.6 To apply the applicable DSM Build ......................................................................... 177
8.2.7 To verify or determine Synology NAS model and version ............................................. 181
8.2.8 To create an OPH share ....................................................................................... 183
8.2.9 To enable a guest account ................................................................................... 186
8.2.10 To configure file services .................................................................................... 189
8.2.11 To enable HTTPS service .................................................................................... 191
8.2.12 To configure the NTP server ................................................................................ 193
8.2.13 To customize login and administrator's account background ...................................... 195

Section 9 Using the Report Manager ............................................................................................... 201

9.1 Report Manager overview .............................................................................................. 201
9.1.1 What is the Ovation Process Historian Report Service? ................................................ 202
9.1.2 What are the Report Manager features that administrator users are authorized to use? ...... 203
9.1.3 What are the Report Manager features that non-administrator users are authorized to use? 203
9.2 To access the Report Manager ......................................................................................... 204
9.2.1 Report Manager toolbar options ........................................................................... 205
9.3 To configure the Report Manager ..................................................................................... 206
9.4 To configure printers that your Report Manager can use ........................................................ 214
9.5 To configure historians that your Report Manager can use ...................................................... 214
9.6 To configure work shifts in the Report Manager ................................................................... 216
9.7 To configure reports storage ........................................................................................... 216
9.8 To use report formatting ................................................................................................ 218
9.9 Report format templates supplied with OPH installation package ............................................ 218
9.9.1 Message report formats ...................................................................................... 219
9.9.2 Point report formats .......................................................................................... 220
9.10 To use report definitions .............................................................................................. 221
9.10.1 To define or edit properties for report definitions in the Report Manager ....................... 222
9.10.2 Message-based reports ..................................................................................... 227
9.10.3 ExpressCalc reports .......................................................................................... 231

8 OPH070
 Contents

9.11 Report generating tasks ............................................................................................... 234

9.11.1 To manually generate reports in the Report Manager ................................................ 234
9.11.2 To export report output to external applications ..................................................... 237
9.12 Timed, demand, and triggered events ............................................................................. 238
9.12.1 To add a timed event or configure existing timed events in the Report Manager .............. 238
9.12.2 To add to or edit the Report Manager reports list ..................................................... 240
9.12.3 To add a demand event or configure existing demand events in the Report Manager ........ 241
9.12.4 To add reports to a demand event ........................................................................ 242
9.12.5 To generate a report from a demand event in the Report Manager ............................... 242
9.12.6 To add a triggered event or configure existing triggered events in the Report Manager ..... 244
9.12.7 Using the Reports List option in the Trigger Event dialog box ...................................... 246
9.12.8 Using a network-shared folder as a report destination for timed and triggered reports ..... 247
9.13 How the report start time is computed based on various event trigger settings ......................... 249
9.13.1 Example 1: Typical event trigger execution ............................................................. 249
9.13.2 Example 2: Set start time to a previous change of state occurrence .............................. 249
9.13.3 Example 3: Set start time to a time of previous event trigger ...................................... 250
9.13.4 Example 4: Special case for “Change in State” event triggers ...................................... 250
9.14 Report Manager administrative tasks .............................................................................. 251
9.14.1 To view the most recent report generation error in the Report Manager ........................ 251
9.14.2 To back up your Report Manager data ................................................................... 252
9.14.3 To set administrative rights in the Report Manager .................................................. 253
9.14.4 Crystal Reports format files ................................................................................ 253
9.14.5 Report user function library (UFL) ........................................................................ 254
9.14.6 Formatting formulas ......................................................................................... 254
9.14.7 To export report settings to a file ......................................................................... 254
9.15 To create reports of edited historical data ......................................................................... 257
9.16 To exit the Report Manager ........................................................................................... 259

Section 10 Using File History .......................................................................................................... 261

10.1 File History overview ................................................................................................... 261
10.2 To use the File History tool ............................................................................................ 261

Section 11 Using the History Manager ............................................................................................. 265

11.1 History Manager overview ............................................................................................ 265
11.2 To access the History Manager window ............................................................................ 265
11.3 Components of the History Manager window ................................................................... 266
11.3.1 Menu bar ....................................................................................................... 267
11.3.2 Toolbar ......................................................................................................... 268
11.3.3 Tabs ............................................................................................................. 269
11.3.4 Tab view ........................................................................................................ 276
11.3.5 Storage Map ................................................................................................... 276

OPH070 9
Contents

11.3.6 Archive action buttons ...................................................................................... 277

11.3.7 Color legend ................................................................................................... 277
11.4 Managing the historical data with the History Manager ....................................................... 278
11.4.1 Unloading data by time ..................................................................................... 281
11.4.2 Unloading data by size ...................................................................................... 282
11.4.3 Reloading data ................................................................................................ 283
11.4.4 Locking data ................................................................................................... 284
11.4.5 Unlocking data ................................................................................................ 285
11.4.6 Archiving data ................................................................................................ 286

Section 12 Using Historical Reviews ................................................................................................ 287

12.1 Historical Review overview ........................................................................................... 287
12.1.1 To access the Historical Reviews window ............................................................... 288
12.2 Components of the Historical Reviews window .................................................................. 289
12.3 Historical Review Menu button ...................................................................................... 290
12.3.1 To use the Load Review Configuration option (from the Historical Review Menu button) ... 292
12.3.2 To use the Save Review Configuration option (from the Historical Review Menu button) ... 293
12.3.3 To use the Print option (from the Historical Review Menu button) ................................ 294
12.3.4 To use the Export option (from the Historical Review Menu button) ............................. 294
12.3.5 To use the Preferences option (from the Historical Review Menu button) ....................... 295
12.3.6 To use the Historian Preferences option (from the Historical Review Menu button) .......... 297
12.3.7 To use the Historical Reviews Options (from the Historical Review Menu button) ............. 298
12.3.8 To use the Exit Historical Review option (from the Historical Review Menu button) .......... 299
12.4 Quick Access Toolbar ................................................................................................... 300
12.5 Menu bar ................................................................................................................. 300
12.6 Ribbon bars .............................................................................................................. 300
12.6.1 Home ribbon bar ............................................................................................. 300
12.6.2 Filter ribbon bar ............................................................................................... 301
12.7 Settings bar .............................................................................................................. 303
12.8 Columns Grouping bar ................................................................................................ 304
12.9 Review Details panel ................................................................................................... 304
12.9.1 Customizing the view of the Review Details panel .................................................... 306
12.10 Dockable tabs .......................................................................................................... 306
12.10.1 Customizing the view of the Dockable tabs .......................................................... 307
12.11 Status bar ............................................................................................................... 307
12.12 Setting preferences ................................................................................................... 307
12.13 Performing a Historical Review .................................................................................... 308
12.13.1 To perform a Point review ................................................................................ 308
12.13.2 Understanding the Point Status column ............................................................... 311
12.13.3 To perform an Alarm review .............................................................................. 312
12.13.4 To perform an Operator Event review .................................................................. 314

10 OPH070
 Contents

12.13.5 Understanding Operator Event Messages ............................................................. 316

12.13.6 To perform an SOE review ................................................................................ 318
12.13.7 To perform an SIS review .................................................................................. 319
12.13.8 To perform an ASCII review ............................................................................... 321
12.13.9 To perform a Common review ........................................................................... 322
12.14 Using command line options to perform a historical review ................................................ 323
12.14.1 To run a Point review from the Command Prompt window ....................................... 324
12.14.2 To run an Alarm review from the Command Prompt window .................................... 325
12.14.3 To run an Operator Event review from the Command Prompt window ........................ 325
12.14.4 To run an ASCII review from the Command Prompt window ..................................... 325
12.14.5 To run an SOE review from the Command Prompt window ....................................... 326
12.14.6 To run an SIS review from the Command Prompt window ........................................ 326
12.14.7 To open the online help from the Command Prompt window .................................... 327
12.14.8 To verify configuration settings from the Command Prompt window .......................... 327
12.14.9 To load a configuration file from the Command Prompt window ................................ 328
12.14.10 To execute a review query directly from the Command Prompt window .................... 328
12.14.11 To specify a historian name from the Command Prompt window ............................. 329
12.14.12 To specify duration of review from the Command Prompt window ........................... 330
12.14.13 To specify point filter criteria from the Command Prompt window ........................... 332
12.14.14 To specify alarm filter criteria from the Command Prompt window ........................... 335
12.14.15 To specify operator event filter criteria from the Command Prompt window ............... 337
12.14.16 To specify ASCII filter criteria from the Command Prompt window ........................... 339
12.14.17 To specify SOE filter criteria from the Command Prompt window ............................. 340
12.14.18 To specify SIS filter criteria from the Command Prompt window .............................. 341
12.15 To view edited historical data from a Historical Review ...................................................... 342

Section 13 Using Historical Trends .................................................................................................. 345

13.1 Historical Trends overview ............................................................................................ 345
13.1.1 To access the Historical Trend window .................................................................. 348
13.2 Components of the Historical Trend window ..................................................................... 350
13.3 Trend Menu button ..................................................................................................... 351
13.4 Trend Quick Access Toolbar ........................................................................................... 352
13.5 Ribbon tabs .............................................................................................................. 353
13.5.1 Home ribbon tab ............................................................................................. 353
13.5.2 Format ribbon tab ............................................................................................ 353
13.5.3 Trend ribbon tab .............................................................................................. 355
13.6 Trend data view (Dockable) tabs .................................................................................... 355
13.6.1 Graph tab of a Historical Trend ............................................................................ 356
13.6.2 Table View tab of a Historical Trend ...................................................................... 358
13.6.3 Summary View tab of a Historical Trend ................................................................ 359
13.6.4 Radar View tab of a Historical Trend ..................................................................... 360

OPH070 11
Contents

13.6.5 Event List tab of a Historical Trend ........................................................................ 361

13.6.6 Interaction between Graph, Radar, and Table view tabs when Trace Explorer is active ....... 362
13.7 Properties Panel ......................................................................................................... 363
13.8 Details Panel ............................................................................................................. 363
13.9 Visibility Panel ........................................................................................................... 363
13.10 Status bar ............................................................................................................... 363
13.11 Historical Trend specific menu options on the Trend ribbon tab ............................................ 364
13.12 Historical Trend specific user preferences ....................................................................... 365
13.13 Working with Historical Trends .................................................................................... 366
13.13.1 To add a point to a Historical Trend ..................................................................... 366
13.13.2 Specifying Point Information ............................................................................. 368
13.13.3 To delete a point from a Historical Trend .............................................................. 371
13.13.4 To page through a Historical Trend ..................................................................... 371
13.13.5 To save a Historical Trend ................................................................................. 372
13.13.6 To specify a time span using the Choose Time Span dialog box .................................. 373
13.13.7 To specify a time span using the Set Time Span drop-down list .................................. 374
13.13.8 To memorize and recall a time span for a Historical Trend ......................................... 379
13.13.9 To specify trace properties in a Historical Trend ..................................................... 380
13.13.10 To activate the deferred execution mode for Historical Trends ................................. 382
13.13.11 To use Chart Options ..................................................................................... 383
13.13.12 To use XY plot and display options .................................................................... 384

Section 14 Using Event Trends ........................................................................................................ 389

14.1 Event Trends overview ................................................................................................. 389
14.2 To enable the event trending functionality ....................................................................... 389
14.3 To specify event filters in the Events Browser window .......................................................... 393
14.3.1 Specifying time span filter for Events search using the Time Span dialog box .................. 395
14.3.2 Specifying time span filter for Events search using the Time Span drop-down list ............. 398
14.4 To run an Event Trend from the Events Browser window ....................................................... 399
14.5 Event types ............................................................................................................... 400
14.6 Components of the Event Trend window .......................................................................... 401
14.6.1 Quick Access Toolbar of an Event Trend ................................................................. 402
14.6.2 Trend ribbon tab of an Event Trend ....................................................................... 403
14.6.3 Graph tab of an Event Trend ................................................................................ 403
14.6.4 Table View tab of an Event Trend .......................................................................... 405
14.6.5 Event Details tab of an Event Trend ....................................................................... 407
14.6.6 Interaction between Event Trend view tabs when Trace Explorer is active ....................... 408
14.7 Event Trend specific menu options on the Trend ribbon tab .................................................. 409
14.8 Event Trend specific user preferences .............................................................................. 410
14.8.1 Events tab in the Trend Options window ................................................................ 410
14.9 Working with Event Trends ........................................................................................... 411

12 OPH070
 Contents

14.9.1 To zoom an Event Trend ..................................................................................... 411

14.9.2 To page through an Event Trend .......................................................................... 412
14.9.3 To save an Event Trend ...................................................................................... 412
14.9.4 To memorize and recall a time span for an Event Trend .............................................. 413
14.9.5 To specify trace properties for an Event Trend ......................................................... 414
14.9.6 To add a trace to an Event Trend .......................................................................... 415
14.9.7 To remove a trace from an Event Trend .................................................................. 415
14.9.8 To use Chart Options in Event Trends .................................................................... 415
14.9.9 To add an SOE point to an Event Trend ................................................................... 416

Section 15 Using the Historian Desktop Tools ................................................................................... 417

15.1 Historian Desktop Tools overview ................................................................................... 417
15.2 Overview of the Microsoft Excel Add-in ............................................................................ 417
15.3 Using the Microsoft Excel add-in .................................................................................... 418
15.3.1 To use the Aggregate Data Query ........................................................................ 420
15.3.2 To use the Point Attribute Query .......................................................................... 429
15.3.3 To use the Message Query .................................................................................. 430
15.3.4 To use the Configuration Query ........................................................................... 433
15.3.5 To use the Raw Data Query ................................................................................. 434
15.3.6 To use the Refresh Query ................................................................................... 437
15.3.7 Error displaying a large amount of data ................................................................. 437
15.3.8 Reference details ............................................................................................. 437
15.4 To use Desktop Tools Trend ........................................................................................... 463
15.5 To use Desktop Tools Review ......................................................................................... 463

Section 16 Accessing historical data from client applications ............................................................. 465

16.1 Client applications overview ......................................................................................... 465
16.2 Using the History Console tool ...................................................................................... 465
16.2.1 To query your client interface .............................................................................. 465
16.2.2 To automatically generate the query results in a file ................................................. 467
16.3 Accessing historical data from Excel by using SQL Queries .................................................... 467
16.4 Accessing historical data from Crystal Reports ................................................................... 469

Section 17 Using the History Edit tool ............................................................................................. 471

17.1 History Edit tool overview ............................................................................................ 471
17.2 Setting user permissions for the History Edit tool ............................................................... 471
17.2.1 To set user permissions for the History Edit tool ....................................................... 472
17.3 Launching the History Edit tool ...................................................................................... 474
17.4 Understanding the History Edit tool interface .................................................................... 475
17.4.1 Functionality of the Annotation tab ...................................................................... 475
17.4.2 Functionality of the Edit Audit Log tab .................................................................. 477

OPH070 13
Contents

17.4.3 Functionality of the Detailed Edit tab .................................................................... 478

17.4.4 Functionality of the Replace Wizard tab ................................................................. 480
17.5 To view edited historical data from Trends ........................................................................ 483
17.6 To view edited historical data from a Historical Review ........................................................ 486
17.7 Creating reports of edited historical data ......................................................................... 489

Section 18 Crystal Reports tasks ..................................................................................................... 491

18.1 Using Crystal Reports (.rpt) files ..................................................................................... 491
18.1.1 To create a new Crystal Report (.rpt) file ................................................................ 493
18.1.2 To modify an existing Crystal Report (.rpt) file ........................................................ 495
18.1.3 To link Crystal Report (.rpt) files to the historian Report Manager ................................ 496
18.2 To sort records ........................................................................................................... 496
18.3 To group information .................................................................................................. 497
18.4 To create a custom group ............................................................................................. 498
18.5 To create a custom group header ................................................................................... 499
18.6 To delete a group ....................................................................................................... 499
18.7 To modify a group ...................................................................................................... 499
18.8 To insert summaries .................................................................................................... 500
18.9 To insert subtotals ...................................................................................................... 501
18.10 Functions and formulas for .rpt files .............................................................................. 502

Section 19 Troubleshooting the historian ........................................................................................ 509

19.1 Troubleshooting tools ................................................................................................. 509
19.2 To use the OVH log file ................................................................................................. 509
19.3 To use the Historian Diagnostics tool ............................................................................... 510
19.3.1 Processes tab of the Historian Diagnostics window .................................................. 514
19.3.2 Services tab of the Historian Diagnostics window .................................................... 518
19.3.3 Scanner Details tab of the Historian Diagnostics window ........................................... 519
19.3.4 Point Counts tab of the Historian Diagnostics window .............................................. 521
19.3.5 Fixed Archive tab of the Historian Diagnostics window .............................................. 522
19.3.6 Removable Archive tab of the Historian Diagnostics window ...................................... 525
19.3.7 Redundant OPH synchronization ......................................................................... 527
19.4 Analyzing your historian's data collection ([Link]) .................................................... 529
19.4.1 To use the Scanner Statistics tool ......................................................................... 530
19.5 Historian fault codes ................................................................................................... 535

Section 20 Using Lab Data .............................................................................................................. 537

20.1 Lab Data overview ...................................................................................................... 537
20.2 Storing Lab Data ........................................................................................................ 537
20.3 OPH Lab Data Interfaces ............................................................................................... 538
20.4 Lab Data Sender interface ............................................................................................. 538

14 OPH070
 Contents

20.5 To access the Lab Data Manager ..................................................................................... 539

20.5.1 To access the Lab Data Options window ................................................................ 540
20.5.2 To synchronize point attributes ........................................................................... 543
20.6 Lab Data Manager Groups and Permissions ....................................................................... 544
20.6.1 To add users to a predefined group ...................................................................... 544
20.7 To modify a group ...................................................................................................... 545
20.8 To delete a group ....................................................................................................... 546
20.9 To import all group settings .......................................................................................... 547
20.10 Managing a Lab Data user session ................................................................................. 547
20.10.1 To start a new session ..................................................................................... 548
20.10.2 To save a session ............................................................................................ 548
20.10.3 To open an existing session ............................................................................... 550
20.10.4 To delete a session/sessions .............................................................................. 550
20.11 Customizing columns in the Session Explorer .................................................................. 550
20.11.1 To add column filters in the Session Explorer ......................................................... 551
20.11.2 To edit column filters in the Session Explorer ......................................................... 551
20.11.3 To clear filter columns in the Session Explorer ........................................................ 552
20.11.4 To enable or disable filter column in the Session Explorer ......................................... 552
20.12 To retrieve Lab Data from the historian .......................................................................... 552
20.13 To validate a Lab Data session ...................................................................................... 553
20.14 To import an external file into Lab Data .......................................................................... 554
20.15 To send Lab Data to the historian .................................................................................. 555
20.16 Lab history data files .................................................................................................. 555
20.16.1 INSERT and UPDATE keywords ........................................................................... 559
20.17 Lab history data retrieval ............................................................................................ 559

Section 21 Table Definitions ........................................................................................................... 561

21.1 Configuration tables ................................................................................................... 561
21.2 Point history tables ..................................................................................................... 563
21.3 Message history tables ................................................................................................ 566
21.4 Archive volume tables ................................................................................................. 569
21.5 History Edit and Annotation tables ................................................................................. 570
21.6 System tables ............................................................................................................ 571
21.7 User Defined Function (UDF) tables ................................................................................ 572
21.7.1 ProcessedData tables ........................................................................................ 572
21.7.2 ProcDataColWise table ..................................................................................... 574
21.7.3 Summary tables .............................................................................................. 577
21.7.4 Scalar and Aggregate functions ........................................................................... 577
21.8 History Console tool syntax .......................................................................................... 581
21.8.1 Support commands .......................................................................................... 581
21.8.2 Server commands ............................................................................................ 582

OPH070 15
Contents

21.8.3 Retrieval commands ......................................................................................... 583

21.8.4 Archive commands .......................................................................................... 592
21.8.5 Lab command ................................................................................................. 592
21.8.6 File history commands ...................................................................................... 593
21.8.7 Syntax terms .................................................................................................. 595

Section 22 Sample Reports ............................................................................................................ 599

22.1 Direct reports ............................................................................................................ 599
22.1.1 Alarm messages .............................................................................................. 599
22.1.2 SOE messages ................................................................................................. 605
22.1.3 Text messages ................................................................................................ 610
22.1.4 Raw values ..................................................................................................... 618
22.2 ExpressCalc reports .................................................................................................... 622

16 OPH070
 Ovation Process Historian overview

1 Introduction to the Ovation Process

Historian
Topics covered in this section:
• Ovation Process Historian overview [17]
• Historian component overview [18]
• Historian terminology [19]
• Historian server redundancy [22]
• How does the historian work? [23]
• Scanning data [23]
• Storing data [27]
• Archiving data [28]
• Retrieving data [30]
• Historian security [33]
• Using wildcard characters for retrieving data [34]

1.1 Ovation Process Historian overview

The Ovation Process Historian (OPH) collects process values and messages that are
generated by your Ovation control system. The historian stores these values and messages
in an optimized historical data store that runs on a Microsoft Windows platform. You can
view and filter this information, or output it to your printers, files, e-mail, or Web pages. The
historian can archive this information to a removable media or to a nearby or remote fixed
disk storage unit.

You can use the historian to better understand the typical and abnormal behavior of your
plant processes, to identify common trends, to explore abnormalities, and to diagnose
process flaws and failures. The frequency and precision of historian monitoring are
beneficial when accuracy is of utmost importance.

1.1.1 Functions performed by using the Ovation Process

Historian
You can perform the following functions by using the Ovation Process Historian:

• Organize real-time process data.

• Support online storage and offline archival.
• Respond to retrieval requests.
• Collect, process, and archive:
◦ Process point values.
◦ Process point attributes.

OPH070 17
Historian component overview

◦ Alarm history data.

◦ Operator events.
◦ Sequence of events (SOE) data.
◦ ASCII system messages.
◦ User files.
• Store process point data that does not originate directly from your DCS (lab history
data).
• Edit and annotate collected historical data.

1.1.2 Advantages of the Ovation Process Historian

The Ovation Process Historian has the following advantages:

• You can archive data for the following purposes:

◦ Duplication of valuable historical records.
◦ Off-site storage to provide protection from data loss due to a catastrophic event.
◦ To make room in the main storage area for the newly collected data.
• You can handle larger point counts due to additional storage and retrieval
performance.
• You can improve upgrade flexibility for future historian modifications.
• You have a storage mechanism, scalable for high and low point counts, which enables
optimal retrieval.
• You can use redundant historian servers to ensure reliable historian performance.

Note
If you have previously used the eDB or the HSR to collect historical information, you can
utilize Emerson's migration service to shift your collected data to your new Ovation
Process Historian. Your migrated data is seamlessly merged with your collected data
and is available on trends, reviews, reports, and SQL queries, the same as your
collected data. Contact your Emerson representative for details.

1.2 Historian component overview

The Ovation Process Historian includes several user interfaces and other components to
help you get the most from your historical data monitoring, storage, retrieval, and
archiving.

Table 1. Components of the Ovation Process Historian

Component Use
Historian server Facilitates collection, storage, archiving, and retrieval, as well as the
historian license manager.
Scanner(s) Monitors points and collects data that includes attributes, alarms,
operator events, SOE, and SCADA.

18 OPH070
 Historian terminology

Component Use
Engineering tools Helps you configure your historian server, disks, archive, scanners, scan
(includes Historian groups, and points. In addition, this component helps you edit and
Configuration Tool and annotate historical data.
History Edit tool)
Report Manager Enables you to schedule and generate customized reports to display
your historical data.
Client interface Enables you to use OLE DB to write your own programs to retrieve data.
Client Desktop Tools Enables you to query and retrieve information by using SQL, trend,
review, and the Excel add-in.

1.3 Historian terminology

The following table describes terms that are generally used with the Ovation Process
Historian.

Table 2. Terms used with the Ovation Process Historian

Term Description
Absolute time Date and time that are specified in numeric month, day, year, and hour, minute,
second.
Alias An alternate name assigned to a process point in a database.
API Application Programming Interface specifies how software components should
interact with each other.
Auto Historian Based on user preference Auto Historian Criteria, when Auto Historian is specified
as the historian for the trace item, the data source used is either the first
accessible historian in the list of configured historians or the first accessible
historian that contains history data for the item.
Compound This is a trace item that is not directly a process point but derives its values from
trace other process point values by applying the specified calculation logic.
COMTRADE The Common format for Transient Data Exchange (COMTRADE) for power systems
is a file format for storing oscillography and status data related to transient power
system disturbances. OPH accepts and stores transient data from third-party
devices.

Select COMTRADE to browse transient power system disturbances and launch the
trend of event variables.

See Using the IEC 61850 MMS Client Protocol with Ovation for more details.
Controller The OPH stores configured Ovation Controller Triggered Events in data files. Data
collected before and after the selected variables are stored as well.

See the applicable Ovation Controller User Guide for more details.
DCS Distributed Control System (or plant control system); the Ovation system or
systems that provide the source of the process point data, and alarms and events
that are collected by the historian.
Deadband A configuration that specifies the amount of change that must occur before a
point is collected.

OPH070 19
Historian terminology

Term Description
DEC module The Digital Excitation Controller (DEC) module captures ultra-high frequency
oscillography data for internal DEC I/O module variables, which occurs when a
configured trigger condition is met and uses OPH to store data as events.

Select this option to browse ultra-high frequency oscillography data and launch
the trend of event variables.

See the Digital Excitation Controller User Guide for more details.
Display ratio When the time-period being shown contains too many samples, an Event Trend
reduces the data that is displayed by using an approximation technique.

The display ratio indicates the reduction in data that occurred for the purpose of
plotting a reasonable and representative number of samples.
Event Trend This type of trend allows you to identify triggered event occurrences and details
from Controllers, the DEC module, COMTRADE or the High Speed Data Recorder.
In this mode, you can also view corresponding pre- and post-event data in a
graphical or tabular form.
Fixed archive A duplication of historical data files stored on a non-removable storage device,
typically a networked-attached storage (NAS), direct-attached storage (DAS), or
storage area network (SAN) unit, where the archive is typically online and
available for access.
GUI Graphical user interface is a type of user interface that allows users to interact
with electronic devices by using images rather than text commands.
High Speed The High Speed Data Recorder (HSDR) records high frequency data from Ovation
Data Recorder controllers, based on Data Recorder session configuration. The recorded data is
presented as events in the Events browser.

Select this option to browse high frequency data from the Ovation controller and
launch the trend of event variables.

See the High Speed Data Recorder User Guide for more details.
Historical Trend This type of trend shows the historical view of process point values for a specified
time span. It interfaces with the OPH to obtain historical data of specified
granularity and data aggregation criteria, such as actual-value, minimum,
maximum, average, and so on.
Lab Data Historical point data that is entered into the system from an outside application
rather than the Ovation network. (You provide the timestamps for this
information.)
Live Trend This type of trend continuously updates the Trend display to show real-time
updates to process point values.
Migrated data Historical data that is transformed to the Ovation Process Historian historical file
format from a previous historical file format.
NAS disc CD/DVD that contains the NAS support files. The disc is labeled as NAS Support
Files for OPH 3.6.0 and SBR 2.0 – June 2016.
NAS PC Personal computer (PC) used to configure a Network Attached Storage (NAS)
unit.
NSECS Nanosecond is one billionth of a second.
NTFS NT File System: an advanced file system that is designed for use specifically with
the Windows operating system.

20 OPH070
 Historian terminology

Term Description
ODBC Open Database Connectivity is a standard C programming language API for
accessing database management systems (DBMS).
OLAP Online Analytical Processing is an approach to answer multi-dimensional
analytical (MDA) queries swiftly.
OLE Object Linking and Embedding is a distributed object system and protocol
developed by Microsoft.
OPC OLE for Process Control is a set of standard OLE/COM interface protocols that are
intended to foster greater interoperability between automation/control
applications, field systems/devices, and business/office applications in the process
control industry.
RAID Redundant Array of Independent Disks: a data storage method in which data is
distributed among two or more hard disk drives.
Relative time This is a method of specifying start and/or end time for a Historical Trend and is
relative to commonly understood time boundaries, such as current time, current
hour, today, yesterday, and so forth. This is represented as an expression
comprised of various mnemonics. One example is ‘ct -10hr - 10mi’ meaning
subtract 10 hours and 10 minutes from current time, to determine the time value.
Relative time is useful for Historical Trends because it makes it unnecessary to
specify absolute time values every time a trend needs to be generated.
Removable A duplication of historical data files stored across a library of individual DVD-RAM
archive discs. Access is limited to the data contained on the mounted volume at any one
time.
Scanner Mechanism that is used by the historian for process point data and message-
based data collection.
SCSI Small Computer System Interface: a SCSI bus that is used to connect
microcomputers to peripheral devices.
SOE Sequence of Events is the order in which a set of events happens.
SQL Structured Query Language is a special-purpose programming language designed
for managing data held in a relational database management system (RDBMS).
TCP/IP Transmission Control Protocol/Internet Protocol: the default standard for data
transmission over networks.
Time Zone This is a three- or four-letter abbreviation for the time zones that are available on a
Abbreviation Windows machine, and which users intend to use for specifying the absolute start
and/or end times for a Historical Trend. Using these abbreviations, times can be
specified from non-local time zones.
Trace Trace is a graph line representing the values for a process point. The whole Trend
is comprised of a maximum of 32 traces.
Trace values This feature allows you to examine trace values while simultaneously moving a
explorer vertical cursor line horizontally across the trend chart.
User preferences These are the settings for controlling the behavior of the application. You can save
these settings in order and apply them to any new application sessions.
UTC Coordinated Universal Time is the high-precision atomic time standard.

OPH070 21
Historian server redundancy

1.4 Historian server redundancy

Server redundancy protects against data loss due to types of failures including:

• Hardware failure in the primary server.

• Software failure in the primary server.
• Some connectivity failures (for example, if a scanner loses connectivity to the primary
server, server redundancy directs the scanner to send its data to the partner server).

Redundant servers protect against data loss by communicating to each other for two
reasons: to forward messages from the primary server to the partner server in real time, and
to backfill data that was missed when one of the servers went offline.

During normal operation, the scanner communicates to the primary server, which in turn
forwards that information to the partner server. The partner server acknowledges receipt of
information to the primary server, which in turn passes the acknowledgement to the
scanner.

During failover operation, when the primary server is offline, the scanner automatically
communicates with the partner server, and the partner server acknowledges receipt of
information back to the scanner.

During failback operation, when the primary server has come back online, the scanner
automatically switches its communications back to the primary server, which forwards that
information to the partner server. The partner server not only acknowledges receipt of that
information, it also forwards the missing data that the primary server was unable to collect
while it was offline.

Synchronous configuration is required for using redundant servers. Synchronous

configuration means that both partner servers are configured to collect data from the same
points, with the same IDs. All configuration choices for servers are handled through the
Historian Configuration Tool [55]. Having identical configuration allows historian server
pairs to exchange history data at all times.

When partner servers are running, they work together automatically to establish
synchronization. For example, if you add a point to drop 61, it communicates your settings
to partner drop 62, to ensure configuration synchronization.

If the partner servers are not in sync, you will be unable to download any new configuration
settings, such as adding points, though the servers will continue working. It is possible to
get out of sync in the following situation: if you add new configurations to the primary while
the partner is failed, and then shut down the primary and restart the partner. Because the
servers in this situation do not have a chance to send missed configuration settings and
other missed data, this situation will create a lack of synchronization. When both servers are
up and running, they reestablish their synchronized configuration.

After recovery, both servers will automatically share all available historical data (up to six
months' worth). If you shift from a non-redundant historian to using redundant servers, it
backfills up to six months of data. All backfills are implemented at a throttled rate in order
not to slow down your network.

22 OPH070
 How does the historian work?

1.5 How does the historian work?

The historian enables you to perform four main tasks on your control system:

• Scan [23].
• Store [27].
• Archive [28].
• Retrieve [30].

1.6 Scanning data

The historian collects data from your system by using scanners. The scanner is a software
program that runs on a workstation that obtains data read from your Ovation network or
receives samples directly from the appropriately configured Ovation Controllers. Although
the historian does not need to be located within your Ovation network, your scanners must
be. Because the historian scanners are distributed, you can collect historical information
from a wide-area network with diverse system architectures.

Point Data

Every point in your system has a value, a status, and some attributes (attributes provide
information about a point). Scanners manage the point values (packed, analog, and digital),
statuses, and attributes for the points that you choose to scan. The historical value and
status sampling function reads the point information, either from your Ovation network or
from within a Controller, and checks two items:

• If the point's status has changed.

• If the point's value has changed more than the amount that you choose to tolerate
(known as the deadband).

The sampling function performs these two checks every second, or as frequently as you
configure your scanner to perform these checks (from every 40 milliseconds to 60 minutes,
but typically once per second). Scanners collect a sample based on a deadband amount, or
amount computed by a percentage of operating range. If a point exceeds the deadband
that you set, or if a digital point's value changes state, the scanner gathers the sample for
that point (timestamp, status, and value) and sends it to the historian for persistent storage
to disk. If no change in value exceeds the deadband within one hour, a sample is taken and
stored anyway.

In addition to values and statuses, each process point in the Ovation system has descriptive
attributes. Though the point values in your system can change significantly, the attributes
of the points change more slowly. Changes in attributes are caused by actions, such as
manually editing the attributes. These slowly changing attributes are read less often. When
scanning for point attributes, the attribute values are read every two hours and reported to
the historian.

Attributes that the historian collects and stores include the following:

• Point name.
• English description.
• Engineering units.

OPH070 23
Scanning data

• Set and reset description.

• Top and bottom of scale.
• Alarm limits.

When you configure a point-for-point value scanning, that point's attributes are
automatically scanned. You can retrieve the point attributes from the historian at any time
and use them to display point value trends, review, or reports.

In addition to the capture of Ovation native point values, some values originate in external
systems and arrive with externally generated timestamps to Ovation via the ELC or SCADA
Server. ELC values are mapped to Ovation points, from which OPH point scanners capture
samples, including the external timestamps when Deluxe point records are used. For
SCADA Server points, there are three types of scenarios in which they can be collected by
the Historian:

• Type A: The points are broadcast over the Ovation network or Controller, and arrive
normally via a standard OPH point scanner. Any data that was buffered by the external
device and cannot be broadcast in real time will be captured through the SCADA
scanner.
• Type B: No broadcasting of points over the Ovation network or Controller. All data
samples will be scanned through the SCADA scanner.
• Type C: Points are broadcast over the Ovation network or Controller, but are only
scanned by using the SCADA scanner.

Message Data

In addition to Ovation point value and attribute collection, additional scanners capture
Ovation process message data (operator events, sequence of events, and alarms), which is
packaged and sent to the historian. Unlike point data, message data is captured whenever it
occurs and is not filtered by a deadband.

A unit qualification and originating workstation ID are sent along with the message to help
you pinpoint which unit and workstation originated the message data.

The alarm message scanner can also collect PlantWeb alerts. The historian treats PlantWeb
alerts like all other alarm messages.

1.6.1 How the scanners handle missing data

If a scanner is stopped, or its local buffer is full, your scanners mark gaps in your collected
data. These gaps identify when the scanner is not operational for a time period or is unable
to collect data. These gaps are identified and marked so that you know where the gaps
occurred.

1.6.2 How the scanners handle time

Collected data is stamped with your local time as it is currently set on the workstation that
runs your scanner software. The historian translates this time into UTC (coordinated
universal time). When the historian stores your collected data, it uses the UTC timestamp.
Daylight Savings Time does not result in duplicate data because timestamps in UTC are
unique. The historian also supports deluxe points that already have a timestamp.

24 OPH070
 Scanning data

The historian identifies and reports reverse time shifts (when the system time is set
backward from the current time) at the scanner level. New data that is scanned after the
reverse time shift is detected is marked as duplicate data and stored. The second set of
duplicated data is returned to retrieval applications, such as reporting.

1.6.3 How the scanners pass data to storage

The scanner buffers your collected data and temporarily stores it. The scanner then sends
the buffered information to the historian for permanent storage. The scanner does not
delete the buffered information until it is certain that the historian has safely received and
stored it, which ensures that your data is not lost.

The scanner uses a disk file for temporary storage. You can configure the size of this file to
best utilize your resources. A small time configuration maximizes the scanner's resources,
and a large time configuration allows for longer periods of communications failure without
data loss.

If the temporary scanner storage ever fills, your scanner issues a fault that indicates data
loss and marks the time period that is missing data.

1.6.4 How the scanners are configured

Use the Ovation Developer Studio To configure a scanner [100] and other historian
operations. You can specify which workstation you want to run the scanner software and
whether each scanner collects point and/or message data. All scanners start collecting
when you start your historian workstation.

1.6.5 Using redundant scanners

You can configure your scanners to be redundant. Redundant scanners exist on two
separate Ovation workstations. The scanners communicate with each other to determine
which one of the two scanners is considered active and which is considered backup. Two
scanners that are configured as redundant do not utilize the Ovation primary and backup
mechanism, and will not be affected by Ovation applications that initiate a failover.

The historian uses a scanner redundancy manager software process to manage redundant
scanner pairs. If you use only one scanner, you will not use the scanner redundancy
manager. If you use multiple scanners, it is helpful to understand how the historian
manages your redundant scanning.

The redundancy manager communicates with a set of local scanners, as well as a partner
redundancy manager. The partner redundancy manager also communicates with its own
set of local scanners.

When the redundancy manager starts, it performs three data-gathering tasks:

• Obtains your scanner configuration data.

The redundancy manager must be connected to each of your historian servers so that it
can obtain the scanner specifications that you set in the Historian Configuration Tool.
The redundancy manager collects the partner name (the name that you chose for your
backup scanner).
• Obtains your redundancy configuration information.

OPH070 25
Scanning data

The redundancy manager also retrieves a redundancy state (the default redundancy
state that you chose for your active scanner). The redundancy manager attempts to
retrieve this information periodically. Program control remains in a data collection
state until the redundancy manager validates the data.
• Validates your redundancy configuration information.

In addition to gathering data from your scanners, the redundancy manager also:

• Monitors its own program synchronization.

• Monitors your scanner's health using system cross-checks.
If the redundancy manager detects an error in the data from one of your scanners, the
redundancy manager assigns a failed state to that scanner and promotes its partner
scanner to active. There are two types of errors that the redundancy manager can
detect:
◦ Connection errors (the redundancy manager detects that one or more scanners
have not communicated with the redundancy manager for more than 60
seconds).
◦ Redundancy state errors (the redundancy manager detects that a scanner has
reported a redundancy state different than the assigned value; the redundancy
manager allows a scanner ten seconds following a state change before considering
this an error).
• Monitors the health of the communication link between the historian and the
redundancy manager.

In backup mode, the redundancy manager declares a failure as soon as a

communication link fails, which prevents the possibility of failover to a backup scanner
that cannot communicate with a historian. The failure state is cleared when the
communication link is restored.

In active mode, the redundancy manager declares a failure after a historian

communication link fails for 30 minutes. At the failure point, the active redundancy
manager encounters a failover if the partner is not already failed. The failure state is
cleared and the communication link is restored.

The redundancy manager monitors all input and error conditions for circumstances that
require a transition between redundancy states:

Note
The backup scanner stores at least one minute of data to ensure no data is lost during a
controller failover.

Table 3. Redundancy states

State Meaning
Unknown This is the initial state of the redundancy manager when it starts, and for the time that it
takes before the redundancy managers can initiate communication with each other.

26 OPH070
 Storing data

State Meaning
Active This state means that the redundancy manager is in control, during which time the
backup redundancy manager receives duplicate information to maintain
synchronization. The active state can mean that:

• The scanner redundancy managers are unable to communicate with each other
after a standard amount of initialization time.
• After the standard amount of initialization time, the partner redundancy manager is
unknown, even though your configuration specifies that redundancy manager as
the active redundancy manager.
• After the standard amount of initialization time, the partner redundancy manager is
backup or failed.
• When the condition that caused a failed state stops, either there is a communication
failure between the redundancy managers or the partner redundancy manager is
unknown, backup, or failed.
• The current redundancy state is backup, and the partner redundancy manager is
unknown or failed.
Backup This state means that control has been given to the redundancy manager's partner,
during which time the backup redundancy manager receives duplicate information to
maintain synchronization. The backup state can mean that:

• After the standard amount of initialization time, the partner redundancy manager is
unknown, even though your configuration specifies that redundancy manager as
the backup redundancy manager.
• After the standard amount of initialization time, the partner redundancy manager is
active.
• When the condition that caused a failed state stops, the partner redundancy
manager is active.
Failed This state means that a redundancy manager has a problem communicating with the
historian, or that one of your scanners has reported a redundancy state different from
your assigned value. A set of scanners in a failed state operates like a set of scanners in a
backup state -- data is scanned and communications are processed.

During a failed state, the partner redundancy manager does not attempt to failover.
When an active redundancy manager fails, it checks that its partner redundant manager
is healthy before failing over. If the partner is failed, then the active redundancy manager
remains active.

1.7 Storing data

After data is received from your scanners, the data is placed into a disk-based historical
storage system optimized to maximize insertion and retrieval speed. The historian manages
these data files by closing them at periodic intervals or when they reach a certain size. Most
historian hardware configurations supply a RAID 5 disk array to provide data loss protection
and continued operation should a single-disk failure occur.

The historian supports various storage areas and configurations. It manages up to three
storage types as described in the following table.

OPH070 27
Archiving data

Table 4. Storage types

Storage Description
type
Main The most recently collected data is kept online in disk storage and is used as the
primary destination for the historian’s historical data. The main storage maintains a
history of data for as long as the historian server's internal disk capacity will support.
Main As an option, the internal main storage can be extended to provide additional disk
Extended storage pools that can include many years of valuable online historical data. The
storage pools can be ranked in order of data I/O performance to allow the historian to
keep the most recent (and most often used) historical data on the highest performing
storage hardware. As space is needed on the highest ranked pool, data files are
automatically moved to other storage pools.

Typically, the main extended storage is implemented by using an external RAID storage
unit. Up to 16 external storage units can be supported.

Note
If storage pools are configured with unequal ranking in the OPH Server, data files go to
the highest ranked pool first. However, if storage pools are configured with equal
ranking in the OPH Server, data files will go to the first storage pool of that rank listed
in the configuration file.

Archive See Archiving data [28].

1.8 Archiving data

The archive system provides storage and retrieval of the data collected by the historian to
and from the fixed or the removable archive. It maintains a database of all data that is
stored on the archive.

Once the main or extended storage area(s) are full, its oldest historical data files will be
deleted to make room for newly collected data. The optional archive storage maintains a
copy of the historical data that can extend beyond what currently resides on the main or
extended storage.

There are two types of archive storage:

• Removable archive, such as DVD-RAM.

• Fixed archive, such as network-attached storage (NAS), direct-attached storage (DAS),
or storage area network (SAN).

The following table describes these archive storage types.

28 OPH070
 Archiving data

Table 5. Archive storage types

Archive Description
storage
type
Removable The historian’s removable archive solution consists of an unlimited series of DVD-
archive RAM optical storage discs. If old data is no longer available on main storage, it can be
reloaded from the DVD-RAM media, using the History Manager [265], or read directly
from a disc volume resident in the DVD-RAM reader.

DVD-RAM storage is a low cost media with the following advantages:

• The discs can be moved off-site to protect against data loss due to a catastrophic
event.
• The discs are impervious to magnetic fields.
• It is easy to make duplicate copies of the media.
• With proper handling, the discs are durable and can last a very long time.
Fixed archive A removable archive requires periodic manual interaction to remove full volumes and
insert blank media, or to insert older media when there is a need to access data that
precedes that on the main storage. A fixed archive provides an archive solution with
minimal human involvement.

A fixed archive typically consists of a disk storage system, such as:

• Networked attached storage (NAS)

• Storage area network (SAN)
The archive is located separate from the historian server. Emerson recommends
a dedicated connection between the historian and the fixed archive.
In addition to unmanned operation, a fixed archive has the following advantages:
• Volumes are always mounted and accessible for data retrieval, eliminating the
need for the main extended storage or reloading of files from the archive.
• Faster read and write times than a DVD-RAM.
• Catastrophic data loss protection can be provided by locating the storage system
remotely.
• The fixed archive itself can be backed up and restored.

You can use the archive functions to perform the following tasks:

• Retrieve data on the removable or fixed archive.

• Display information about the data stored on the archive.
• Display information about the archive storage database maintained by the archive
system.
• Display information about the status of the archive system.
• Direct the operations of the archive system.

The archive system maintains a volume database that contains information about all data
written to the removable or fixed archive. Each piece of removable media can contain one
or two sides. Each side of media can contain a volume created by the archive system. The
archive system assigns a unique volume name to each volume created for the removable or
fixed archive.

OPH070 29
Retrieving data

If you do not specify an archive, the storage processes manage the main storage disk space
so that data collection continues and is stored to disk. The oldest data that resides on main
or main extended storage is removed in order to accommodate the newly collected data.

The removable archive system can prompt you for attention at any time by generating any
of the following messages.

Table 6. Attention messages prompted by a removable archive

Message Description
Request for blank media Archive system is attempting to archive data files but a currently open
volume does not exist.
Request for a specific Archive system is attempting to archive data files and the currently open
volume volume is not in the drive, or a volume request is received from a retrieval
operation and the requested volume is not in the drive.
Confirmation for Response to a request for blank media has been received, but the media in
overwrite the drive is not blank.

The fixed archive system can prompt you for attention at any time by generating any of the
following messages.

Table 7. Attention messages prompted by a fixed archive

Message Description
Archive Device is full, space required When the fixed archive device reaches its full storage
capacity.
Configured space available The disk storage capacity exceeds the percentage specified in
percentage is exceeded the Disk Warning Threshold field

1.8.1 How archive functions are configured?

You can configure your archive [96] functions in Ovation Developer Studio, and access
historian archive functions from the History Manager [265].

Historian archive functionality is optional. If you choose not to use archive functionality, the
historian deletes the historical data when disk space is needed to store more current
historical data.

1.9 Retrieving data

The historian includes several methods to retrieve and display your historical information:

• Historical reports.
• Historical Review.
• Historical Trend.
• Excel add-in.
• SQL access.
• History Manager.

You can search for information in specific ways for each type of historical data.

30 OPH070
 Retrieving data

Table 8. Data types

Data type Categories that you can search on

Point • Timestamp.
• Name.
• Description.
• Status.
Alarm • Timestamp.
• Name.
• Type.
• Alarm details.
• Workstation origin ID.
• Scanner ID.
Operator event • Time range.
• Workstation origin.
• Type.
• Subtype.
SOE messages • Timestamp.
• Name.
• Workstation origin.

1.9.1 How to retrieve data by using the historical reports?

You can run various types of reports on your historical data. These reports include:

• Scheduled reports (reports run on a scheduled interval).

• Event-triggered reports (reports that are triggered by one or more process conditions).
• Trip reports (provides information prior to and following a trip event).
• Manually generated reports (reports that you run on-demand).
• SOE reports (reports that display a chronological history of SOE activity).
• Alarm reports (reports that summarize alarms on your system).
• Operator event reports (reports that summarize operator-initiated actions).
• Edited data (historical data that has been edited or annotated by using the History Edit
tool).

You can run reports to focus on specific categories of information and distribute them to
other users. When you want to run reports, you can use the Emerson-designed report
templates or create your own. You can configure where you want a report to be run, how
you want the report to look, and when you want it to be generated.

OPH070 31
Retrieving data

1.9.2 How to retrieve data by using the Historical Reviews?

A Historical Review displays non-graphical information. You can filter the information to
show you various types of data, but you typically use a Historical Review for:

• Alarms.
• Operator events.
• SOE.
• Points.
• ASCII.
• SIS.

You can access the Historical Review interface from your workstation Start menu or using
the Desktop client.

Start -> Ovation -> Ovation Applications -> Historical Review

For more details on Historical Reviews, see Using Historical Reviews [287].

1.9.3 How to retrieve data by using the Historical Trends?

Historical Trends display history data of process variables in the form of graphs for
examining and analyzing past process activity. To assist with data exploration, additional
views are available:

• Table view displays tabulated data values.

• Summary view displays summarized results.
• Radar view displays spider chart of values at a time instance.

You can apply desired aggregation criteria (for example, processing type, such as actual,
average, or integration) to the values stored by the historian to visualize computed results.

You can access the Historical Trend interface from your workstation Start menu or using the
Desktop Client.

Start -> Ovation -> Ovation Applications -> Trend

1.9.4 How to retrieve data by using the History Manager?

The History Manager enables you to review the types of historical data that you are storing,
and provides information about the storage consumption of your various data types. You
can also use the History Manager to view information about the status of various time
ranges (for instance, to check whether your data is online or not). You can use the History
Manager to load, unload, lock, and unlock your historical data. The History Manager
displays messages applicable to your removable storage devices.

To access the History Manager, navigate to the following path:

Start -> Ovation Process Historian -> History Manager

For more details on History Manager, see Using the History Manager [265].

32 OPH070
 Historian security

1.10 Historian security

Historian security is derived from the surrounding Ovation security architecture. You can
define users, roles, and policies to fit your own security needs. Each of these components
(users, roles, and policies) can be defined separately and used together.

For example, you could configure a certain set of privileges (group) and then apply these
privileges to functions inside Ovation or Windows. This allows you to enable desktop items,
choose the frequency at which passwords need to be reset, and limit access to desktop
features, removable media devices, and other items.

If you choose, you can refuse a single machine (or single user name) access to historian
functions. Alternatively, you could configure a single machine (or user name) to have
unlimited access to historian functions. Any configuration between these two extremes is
also possible.

To achieve this security, the historian must be part of an Ovation domain.

Refer to Managing Security in Ovation for further security information.

OPH070 33
Using wildcard characters for retrieving data

1.11 Using wildcard characters for retrieving data

You can use wildcard characters to filter the historian data. However, the usage varies
depending on the OPH retrieval approach.

• OPH supports either of the following characters for a match any set of characters:
◦ *: Typically, the * character is used for a match any search.
◦ %: The % character is used in the OPH SQL engine when processing LIKE clauses.

Note
The OPH SQL engine does not support * as match any.

• OPH, including the OPH SQL engine, supports the ? character for a match one character
search when processing LIKE clauses.
• Report Manager (or Crystal Reports) supports the * character for match any and the ?
character for match one. It does not support the % character for match any.

1.11.1 Escape characters

• OPH allows any character to be escaped with a backslash to force that character to be
interpreted literally. For example:
◦ To search for a text containing, *, use \*.
◦ To search for a text containing, \, use \\.
• Excel Addin and Report Manager (or Crystal Reports) support the backslash escape
character. However, they do not support escaping a double quote with a backslash. You
must use consecutive double quotes ("") to actually specify a single double quote.
• You do not need to escape quote characters, either single or double quotes, in your
search strings sent to the OPH through the OvhClientApi. However, if you do this, it will
also work.

34 OPH070
 Hardware requirements for the historian

2 Requirements for the historian

Topics covered in this section:
• Hardware requirements for the historian [35]
• Software requirements for the historian [36]

2.1 Hardware requirements for the historian

The hardware requirements for the Ovation Process Historian are as follows:

• Dell PowerEdge T310, T320, T330, T440, R710, R720, R730, or R740.
◦ Point quantity greater than 200K requires a minimum of T330/ R730 machine,
with a H730 or H730P PERC controller installed.
• Synology NAS 2418RP+ (Emerson Part Number 1X00783H07).

2.1.1 Historian disk partitioning

Typically, disk partitioning is performed before you receive your OPH from Emerson.
Emerson ensures that your machines are properly configured and have enough disk storage
to properly install and run the operating system and historian software. However, if, for any
reason, you have a need to revisit your disk configuration (such as during a reload of the
operating system, first-time setup of unconfigured hardware, or recovering from a
hardware failure), use the following rules:

• The OPH Server is typically deployed using internal storage, configured as a single RAID
5 array in the RAID BIOS, which is accessible during the boot process. This unit is
recommended to be partitioned into C: and D: virtual drives.
• Ensure that you have at least 80 GB of free disk space on the system partition (C:) for
the installation of Windows and Ovation applications.
• The D: partition contains the rest of the available disk space, which should be used for
OPH software and historical data storage.
• Modifying the RAID hardware configuration can jeopardize your RAID 5 protection and
is not recommended.
• All hard disks must use the NTFS file system.

Note
Due to the possibility of various disk partitioning scenarios, Emerson recommends that
you contact your Emerson representative if you have questions about partitioning your
disks.

OPH070 35
Software requirements for the historian

2.2 Software requirements for the historian

The software requirements for the Ovation Process Historian are as follows:

• Microsoft Windows 7 (32 bit and 64 bit).

• Microsoft Windows Server 2008 R2 Standard SP1 (64 bit).
• Microsoft Windows Server 2008 SP2 (32 bit).
• Microsoft Windows Server 2012 R2 Standard (64-bit).
• Windows 10 loT Enterprise 2016 LTSB.
• Microsoft Windows Server 2016 Standard.

Note
The OPH is compatible with Ovation 3.5.1, 3.6 Feature Pack 4, 3.7 Feature Pack 1, and
later releases.

Note
The Desktop Tools are available for the above listed Windows versions. See Using the
Historian Desktop Tools [417].

36 OPH070
 Historian planning overview

3 Planning the historian

Topics covered in this section:
• Historian planning overview [37]
• How many historians do you need? [38]
• How many scanners do you need? [39]
• How will you archive your data? [40]
• Who are your end users? [41]
• Do you need to migrate eDB or HSR data to your new historian? [42]
• Will you need any third-party software? [42]
• What are the Desktop Tools? [42]

3.1 Historian planning overview

There are many factors that determine the number of historians and scanners you need.
Your total point count, as well as the way that you divide those points across various
systems, determines the number of historians that you need for your Ovation system.

The number of historians that you use can help decide the number of scanners that you
need (you need at least one scanner per historian).

The number of scanners that you use determines the amount and detail of data that you can
archive and retrieve from your system.

Because these considerations are intertwined, Emerson recommends that you plan your
historian setup with a thorough understanding of the options available to you. The
following questions can help you create your historian plan:

1. How many historians do you need? [38]

2. Do you need redundant historian servers? [39]
3. How many scanners do you need? [39]
4. How will you archive your data? [40]
5. Who are your end users? [41]
6. Do you need to migrate eDB or HSR data to your new historian? [42]
7. Will you need any third-party software? [42]
8. Do you want to use the Desktop Tools? [42]

OPH070 37
How many historians do you need?

3.2 How many historians do you need?

To determine how many historians are required, you must know how many points you want
to collect historical information for. The maximum number of points that one historian can
collect is 400,000.

In addition to knowing the number of points you want to collect, you must know what type
of points you want to scan for, because different point types are treated differently by the
historian and some require more storage space than others. The number of points and the
types of points that you want to collect both affect your disk space. For example, you should
decide if you want to monitor any points at a 0.1 second scan rate and understand how that
will impact your storage and retrieval performance Emerson recommends that you aim for
an overall storage rate of less than 1-2% change rate per second, especially if you have a
larger point count.

After you have analyzed the various aspects of your historian plan, revisit the question of
how many historians you require. After the various elements of your historian plan are in
place, the number of historians that you need should become clearer.

3.2.1 Reasons to use multiple historians

The reasons to use multiple historians are as follows:

• If your system includes a remote area with a potentially unreliable network link to the
rest of your system, multiple historians can provide continued local operation at your
remote facility while offering central historical data storage for your entire system.
• If you anticipate running out of licenses; for example, you might want to collect more
than 400,000 points, or you might require more non-Ovation clients than one historian
allows.

3.2.2 Reasons to use a single historian for multiple units

The reasons to use a single historian for multiple units are as follows:

• If you do not expect your total point count to exceed 400,000.

• If your system is confined to one geographical area with reliable network connections.
• If you require a low-cost solution to gather historical process data.

Note
If you think that you may eventually use a single historian for multiple units, Emerson
advises that you install your historian on your core network switches.

3.2.3 Reasons to use an embedded historian

An embedded historian is a historian that you add to a pre-existing database server
workstation. The reasons to use an embedded historian are as follows:

• If you do not expect your total point count to exceed 10,000.

• If you require the lowest cost solution to gather historical process data.

38 OPH070
 How many scanners do you need?

3.2.4 Do you need redundant historian servers?

You can use redundant servers to protect against data loss due to the following reasons:

• Hardware failure in the primary server.

• Software failure in the primary server.
• Some connectivity failures (for example, if a scanner loses connectivity to the primary
server, server redundancy directs the scanner to send its data to the partner server).

If historical data collection is critical to your plant, consider utilizing redundant servers. If
you are currently using a non-redundant historian server, you can convert to redundant
servers. The redundant servers will backfill up to six months of data, at a throttled rate in
order not to slow down your network.

Redundant historian servers are only available to customers with Ovation 3.1.1 or higher, or
customers with Ovation 3.0.4.

3.3 How many scanners do you need?

Given the number and type of points that you know you want to scan, decide whether you
want to scan with:

• A single scanner: Using a single scanner simplifies configuration, maintenance, and

troubleshooting. Most users require only one scanner.
• Multiple scanners: Multiple scanners can be useful if you want to scan at remote
segments of your control network. Multiple scanners can continue to collect and buffer
remote data during an outage between the local and remote network segments.

When planning your scanners, consider the number of network vulnerabilities, such as
routers and switches, between your scanner and your historian. Use of multiple scanners on
a single system is a decision that you should make based not on your point count but rather
on the quality of your network connectivity. There are no specific recommendations, but
generally, 30,000 points per scanner ensures good performance quality. Under typical
collection rates (1-2% average sampling rate), OPH point scanners deployed on current
Ovation standard computer hardware (for example, T330 / R730 or newer) can support up
to 50,000 points per scanner.

After you have decided whether to use a single scanner or multiple scanners, decide if you
want scanner redundancy. Redundant scanners exist on two separate Ovation machines.
They communicate with one another to determine which one of the two scanners is active,
and which one is backup. Two scanners that are configured as redundant do not utilize the
Ovation primary and backup mechanism and are not affected by Ovation applications that
initiate a failover. The status of the redundant scanners is displayed as an item on the
Maintenance and Status screen.

If you do decide that you want redundancy, the scanner redundancy manager must connect
the scanners, and the historian that they report to, in order to obtain redundant
information.

Note
If you use multiple non-redundant historians, a single Ovation process point can be
collected by more than one scanner but it is only configured once for a given historian.

OPH070 39
How will you archive your data?

3.4 How will you archive your data?

The historian archive system provides an optional (though recommended) capability for
storage and retrieval of the collected data to and from a removable and/or fixed archive. It
maintains a database of all data that is stored on the archive. The removable archive storage
device is a DVD-RAM drive, and is attached to the machine on which the historian server
software is installed. However, a fixed archive typically consists of a disk storage system,
such as networked attached storage (NAS) or a storage area network (SAN), accessible to
the historian server (see Archiving data [28]).

Note
Emerson strongly recommends the use of an Emerson-standard network attached storage
(NAS) device for fixed archiving purposes.

Disk size estimates are based on the volume and type of information that you want to
collect. Since your disk space needs can change radically based on the volume and type of
points that you want to collect historical information for, use the following estimates as
general guidelines only.

The following table of disk space estimates is based on several assumptions:

• Your hardware is a Dell PowerEdge T440 or R720 with a standard configuration: three
300-gigabyte drives in RAID 5, approximately 540 gigabytes of usable disk space.
• You collect samples at, on average, a 1% rate.
• Your total disk space is approximately 510 gigabytes.
• Your DVDs can hold a maximum of approximately 8 gigabytes of data.

Table 9. Storage estimates based on point count

Number of points to Number of years before Number of additional years 1-TB

collect disk storage is full RAID adds for storage
10,000 11 21
25,000 4.5 8.5
50,000 2.2 4.2
75,000 1.5 2.9
100,000 1 2.1

Note
The use of larger disks for main storage is recommended when point counts exceed
100,000.

40 OPH070
 Who are your end users?

External RAIDs extend your main storage capability and let end users access data online,
without having to load a DVD or other removable media in order to view data. You can add
up to 16 external RAIDs to your historian. You can use removable media in conjunction with
external RAIDs. However, deploying an external RAID unit as a fixed archive device provides
the benefit of duplicating the primary storage data while also providing an online access to
the data that is no longer available in the main storage.

DVD-RAM storage is a low-cost media with the following advantages:

• The discs can be moved off-site to protect against data loss due to a catastrophic event.
• The discs are impervious to magnetic fields.
• It is easy to make duplicate copies of the media.
• With proper handling, the discs are durable and can last a very long time.

If you decide that you do want removable media, you can use an internal or external DVD-
RAM drive. Historian archiving supports making backup copies of DVD-RAM volumes to
DVD +/- RW media.

Removable media offers storage beyond standard online storage. However, the removable
archive requires periodic manual interaction to remove full volumes and insert blank media,
or to insert older media when there is a need to access data that precedes the data on the
main storage.

A fixed archive provides an archive solution with minimal human involvement. In addition
to unmanned operation, a fixed archive has the following advantages:

• Volumes are always mounted and accessible for data retrieval, eliminating the need for
the primary extended storage or reloading of files from the archive.
• Faster read and write times than a DVD-RAM.
• Catastrophic data loss protection can be provided by locating the storage system
remotely.
• The fixed archive itself can be backed up and restored.

3.5 Who are your end users?

The way that your end users want to view and use your historical data decides the
applications that you should use:

• If you want to view your historical data in graphs, use Historical Trend.
• If you want to perform ad hoc queries to explore raw historical data, use Historical
Review.
• If you want tabular data to analyze, print, or save to files, use historical reports.
• If you want to analyze your storage utilization, use History Manager.
• If you want to use data on a spreadsheet, use the Excel add-in or OLE DB database
queries.

Consider where your end user is geographically. Local end users present no difficulties (for
example, you can print reports to any network printer). End users that are geographically
removed require special network planning; you will need to address connectivity and
firewall difficulties between the historian system and your end user's system.

OPH070 41
Do you need to migrate eDB or HSR data to your new historian?

For example, if the user at workstation 200 wants to be able to demand historical reports,
workstation 200 must have the Report Manager software loaded and have connectivity to
the historian server workstation. In addition, non-local users who query the historian server
frequently, or for large volumes of data, could greatly impact your network performance.

3.6 Do you need to migrate eDB or HSR data to your

new historian?
A migration service is available to help you migrate your data from the eDB or HSR to the
historian. You will be required to:

• Choose which history types you want to convert.

• Choose your start and end times.

If you need to migrate data, you should budget for work time and services to plan your data
migration, migration cost, and downtime. The downtime is a significant consideration if
you plan to use the same hardware for the historian that you used previously.

It is possible to migrate your custom report templates to the historian, but there can be
difficulties. Therefore, Emerson recommends that you do not attempt to migrate any
custom report templates that meet the following criteria:

• The reports are direct, cross tab reports (instead of ExpressCalc reports, which are
easier to migrate).
• The reports contain large amounts of custom code.

In addition to migrating point data, it is possible to migrate your existing point

configuration into your new historian. See your Emerson representative for details.

3.7 Will you need any third-party software?

The historian uses the SAP Crystal Reports 2016 [491] to build report layout files. If you
want to build report layout files outside of your control system, you must purchase
additional copies of SAP Crystal Reports 2016.

3.8 What are the Desktop Tools?

The Desktop Tools are as follows:

• Trend ( Using Historical Trends [345] ).

• Historical Review ( Using Historical Reviews [287] ).
• Excel Add-in for Microsoft Excel spreadsheets ( Using the Microsoft Excel add-in [418] ).

3.8.1 Do you want to use the Desktop Tools?

The Desktop Tools enable you to access process data stored in your Historian from
computers that are non-Ovation DCS workstations. See the Historian Desktop Tools
overview [417] for more information.

42 OPH070
 Installing the historian overview

4 Installing the historian

Topics covered in this section:
• Installing the historian overview [43]
• To install the historian [43]
• To uninstall historian components or change your installation [53]

4.1 Installing the historian overview

The Ovation system allows you to perform the following actions regarding the Ovation
Process Historian (OPH) software:

• Load the OPH software [43].

• Uninstall the OPH software [53].
• Change the components of the OPH software [53].

4.2 To install the historian

Before you install the Ovation Process Historian software on a computer, Emerson
recommends that you understand the configuration of the various historian software
components discussed in Planning for the historian [37]. In addition, note the following
points:

• The installation process must be performed by a user with Domain Administrative

privileges.
• At the drop where you are installing the Ovation Process Historian, you must verify the
Language settings before you begin the installation. Perform the following steps to
ensure that Locale is set to English (United States) during the OPH installation:
◦ Select Start > Control Panel > Region and Language. The Region and Language
window appears as shown below.
◦ Select the Formats tab. Verify that English (United States) is selected in the Format
section. If it is not, select it from the drop-down list.
◦ Select the Administrative tab. Verify that English (United States) is selected in the
Language for non-Unicode programs section. If it is not, select it, and then restart
the computer.

OPH070 43
To install the historian

Figure 1. Region and Language window

• Be aware that several installation scenarios may apply:

◦ Initial, first-time installation
◦ Upgrade to a new software release
◦ Restoration of OPH applications following a disk storage unit failure

Note
See What are different OPH installation scenarios? [53] for more information.

Use the following steps to install the Ovation Process Historian software:

1. Insert the historian CD into the CD-ROM drive of the machine that you want the
historian to run on.
2. Navigate to the [Link] file in the root directory of your CD drive.

44 OPH070
 To install the historian

3. Double-click the [Link] file.

Figure 2. Running [Link]

4. The Ovation Process Historian InstallShield wizard appears with the Welcome page.
Click Next.

Figure 3. Ovation Process Historian InstallShield wizard -- Welcome page

OPH070 45
To install the historian

5. The License Agreement page appears. Click Yes.

Figure 4. License Agreement page

46 OPH070
 To install the historian

6. The Customer Information page appears.

a. In the User Name field, enter your user name.
b. In the Company Name field, enter your company name.

Note
Your user name and company name are automatically detected. You can edit
these fields as necessary.

c. Click Next to continue.

Figure 5. Customer Information page

OPH070 47
To install the historian

7. The Choose Destination Location page appears. Click Next to accept the default
location, or change it, if required.

Figure 6. Choose Destination Location page

48 OPH070
 To install the historian

8. The Select Features page appears.

a. Select the historian components that you want to include in your installation.
b. Click Next.

Figure 7. Select Features page

Table 10. Components of the historian

Historian Details
component
Server Installs the server on any machine connected to your network that you
want the historian server to run on.
Scanners Installs the scanner software on all machines that you want to function
as scanners; scanner machines must be connected to the server and
have Ovation loaded on them.
Engineering This is the main configuration tool for the historian installation. You
Tools must install the engineering tool on each workstation that you want to
have the ability to engineer the historian system in the Developer
Studio, as well as the Ovation database server. The Engineering tools
installation component includes the History Edit tool.
Reports The Report Manager enables you to design, generate, and schedule
reports. Install the Report Manager on any machine connected to the
server that you want to run reports from.
Client Interface The client interface enables you to write your own programs, and
access your historian data from other applications, such as Microsoft
Excel.

OPH070 49
To install the historian

Historian Details
component
Client Desktop Client tools (including the History Console and [Link]) let you
Tools manipulate the system by using SQL queries, Trend, Review, and the
Excel add-in.
Data Insertion Libraries used to facilitate insertion of Historian data.

Note
Currently, these libraries are used on a SCADA or COMTRADE server
drop that does not require Historian Scanner functionality.

9. The Select Installation Type dialog box appears.

a. Depending on the scenario, select the installation type from the following options:
• Initial Installation
• Re-Installation/Upgrade
• Recovery

Note
See What are different OPH installation scenarios? [53] for more
information.

b. Click Next.

Figure 8. Select Installation Type dialog box

50 OPH070
 To install the historian

10. After selecting the installation option, a confirmation dialog box appears. Click Yes
after confirming that you have selected the appropriate option.

Figure 9. Confirmation dialog box

11. Return to the Ready to Install the Program page. Click Install to begin the installation.

Figure 10. Ready to Install the Program page

OPH070 51
To install the historian

12. The installation begins.

Figure 11. OPH installation in progress

When the installation is complete, the Installation Completed page appears. Click
Finish.

Figure 12. Installation Completed page

13. Restart your machine.

14. When you restart, the historian starts automatically. You have successfully loaded the
historian software.

52 OPH070
 To uninstall historian components or change your installation

4.2.1 What are different OPH installation scenarios?

The following OPH installation scenarios may be possible:

• Initial Installation: Use this option when you are installing the OPH software on a
machine for the first time. In addition, this option can be used when you want to
discard all historical data.

CAUTION

Selecting this option will cause data loss.

• Re-Installation / Upgrade: Use this option in the following circumstances:

◦ When the OPH software must be reinstalled, but not because of a disk failure.
◦ When upgrading the OPH software from a previous OPH software release.
In these circumstances, the disk storage system where the OPH software resides is not
replaced.
• Recovery: Use this option when you are recovering from an OPH Server storage device
failure where the OPH software has been lost. Before recovery installation, you need to
replace the disk storage where the OPH software will reside. See Recovering from OPH
Server failure [135] for more information.

4.3 To uninstall historian components or change your

installation
If you want to change the components that you have installed, navigate to the following
path:

Start -> Control Panel -> Add/Remove Programs -> Ovation Process Historian

Two options are displayed with the historian program:

• Remove: This option removes all of the historian components completely (except for
report configuration, (which is written to export files for future applications to use),
license keys, history files, and point configurations). A prompt will check whether you
are sure that you want to remove all features. Select Yes or No.
• Change: This option accesses a maintenance mode that enables you to modify, repair,
or remove historian components through the Select Features installation screen. You
can use this option to add components that you did not initially install. By using this,
you do not need to uninstall and reinstall your historian. You can add to your
installation as often as you need.

Note
After removing programs or changing components, Emerson recommends that you
restart your machine.

OPH070 53
 Configuration overview

5 Configuring the historian

Topics covered in this section:
• Configuration overview [55]
• To configure a historian for the first time on a Windows-based system [56]
• To access the Historian Configuration Tool window for Windows-based systems [58]
• Components of the Historian Configuration Tool window [61]
• Historian Configuration Tool menu button [62]
• Quick Access Toolbar [62]
• Menu bar [64]
• Ribbon bars [64]
• Left pane of the Historian Configuration Tool window [70]
• Right pane of the Historian Configuration Tool window [72]
• Status bar [85]
• To export data to an XML file [86]
• To import data from an XML file [89]
• To configure a historian server [91]
• To configure a main storage [94]
• To configure an archive [96]
• To configure a scanner [100]
• To configure a point scan group [105]
• To configure historian points [110]
• Configuring your Ovation system to enable the collection of historical messages or events [115]
• To load your configuration to the historian on a Windows-based system [125]

5.1 Configuration overview

Before you can use the historian, you must complete the following configuration tasks:

• To configure a historian for the first time on a Windows-based system [56].

• To access the Historian Configuration Tool window for Windows-based systems [58].
• To configure a historian server [91].
• To configure a main storage [94].
• To configure a fixed archive [96].
• Configure a removable archive [98].
• To configure a scanner [100].
• To configure a point scan group [105].
• To configure historian points [110].

OPH070 55
To configure a historian for the first time on a Windows-based system

• Enable the collection of historical messages or events [115].

5.2 To configure a historian for the first time on a

Windows-based system
Use the following steps to configure a historian for the first time on a Windows-based
system:

1. Access the Ovation Developer Studio. Refer to the Ovation Developer Studio User Guide
for more information.
2. Use the system tree to navigate to the Ovation Process Historian Servers folder as
follows:
Systems -> Configuration -> Historians -> Ovation Process Historian Servers -> Ovation
Process Historian Servers
3. Right-click on the second Ovation Process Historian Servers folder and select Insert
New. The New Ovation Process Historian Servers window appears:

Figure 13. New Ovation Process Historian Servers window

4. Use the Value drop-down menus to select the Ovation Process Historian Number
ranking. The rank decides what order you want your historians to display in the pull-
down menus in Trend and Review.
5. Use the drop-down menus to select your primary and partner historians.

56 OPH070
 To configure a historian for the first time on a Windows-based system

6. Click OK. Your new historian appears in the bottom-left corner of the Ovation
Developer Studio window. In the following figure, the new historian is drop 210.

Figure 14. Ovation Developer Studio with historians

OPH070 57
To access the Historian Configuration Tool window for Windows-based systems

7. Right-click on your new historian and select Engineer. The Historian Configuration Tool
window appears:

Figure 15. Historian Configuration Tool window

8. You can now use the Historian Configuration Tool to define how you want to manage
your historians, scanners, scan groups, points, and storage options.

5.3 To access the Historian Configuration Tool window

for Windows-based systems
Use the following steps to access the Historian Configuration Tool window for Windows-
based systems:

1. Access the Ovation Developer Studio. Refer to the Ovation Developer Studio User Guide
for more information.
2. Use the system tree to navigate to the Ovation Process Historian Servers folder as
follows:
Systems -> Configuration -> Historians -> Ovation Process Historian Servers -> Ovation
Process Historian Servers

58 OPH070
 To access the Historian Configuration Tool window for Windows-based systems

3. Right-click on the historian workstation that you want to configure. The right-click
menu appears:

Figure 16. Right-click menu

The following table describes the right-click menu options of the historian workstation.

Table 11. Right-click menu options of the historian workstation

Menu item Description

Open Displays general information of the primary and partner historians.
Engineer Launches the Historian Configuration Tool.
Delete Deletes the selected item from the hierarchy.
Search Launches the Search Options Wizard to find specific objects under the current
branch of the tree hierarchy.
Find Finds objects in the database or on a workstation.
Load Runs the post-configuration load procedure.
Allow Docking Places the current window in one fixed position.
Hide Closes the current window.

OPH070 59
To access the Historian Configuration Tool window for Windows-based systems

4. Select Engineer. The Historian Configuration Tool is automatically launched and

appears:

Figure 17. Historian Configuration Tool window

60 OPH070
 Components of the Historian Configuration Tool window

5.4 Components of the Historian Configuration Tool

window
The following figure depicts the components of the Historian Configuration Tool window:

Figure 18. Components of the Historian Configuration Tool window

The Historian Configuration Tool (HCT) window contains the following components:

• HCT menu button [62].

• Quick Access Toolbar [62].
• Menu bar [64].
• Ribbon bar [64].
• Left pane of the HCT window [70].
• Right pane of the HCT window [72].
• Status bar [85].

Note
When you change any settings in the Historian Configuration Tool window and click
Apply, a red flag appears in the Ovation Developer Studio. The flag indicates that you
need to perform the load procedure [125]. This note is applicable only for Windows-
based systems.

OPH070 61
Historian Configuration Tool menu button

5.5 Historian Configuration Tool menu button

The Historian Configuration Tool menu button (the wrench icon at the top left of the
Historian Configuration Tool window [61] provides access to several configuration
functions. When you click the button, the following dialog box appears:

Figure 19. Options in the Historian Configuration Tool menu button

The following table describes the functions provided by the Historian Configuration Tool
menu button:

Table 12. Historian Configuration Tool menu button functions

Function Description
New Creates a new and blank database.
Open Opens an existing database.
Validate Validates the configuration.
Download Downloads the configuration to a historian.

Note
For configuration sessions opened from the Ovation Developer Studio, you must
download the configuration by using the Ovation Developer Studio. In such cases, this
option would be disabled and grayed out.

Recent Files Displays recently used files.

Exit Exits the Historian Configuration Tool window.

5.6 Quick Access Toolbar

The Quick Access Toolbar of the Historian Configuration Tool window [61] contains
frequently used icons. The toolbar allows an easy access to commonly used functions. The
Quick Access Toolbar is shown in the following figure.

Figure 20. Quick Access Toolbar of the Historian Configuration Tool window

62 OPH070
 Quick Access Toolbar

The following table describes the icons in the Quick Access Toolbar.

Table 13. Quick Access Toolbar icons

Function Icon Description

Apply Saves the changes to database.

Validate Validates the configuration.

You can make the following changes to the Quick Access Toolbar.

• Remove an existing option from the Quick Access Toolbar [63].

• Add a new option in the Quick Access Toolbar [63].
• Show Quick Access Toolbar below the ribbon bar [63].
• Show Quick Access Toolbar above the ribbon bar [63].
• Hide or minimize the ribbon bar [64].
• View the hidden or minimized ribbon bar [64].

5.6.1 To remove an existing option from the Quick Access

Toolbar
Use the following steps to remove an existing option from the Quick Access Toolbar [62]:

1. Access the Historian Configuration Tool window [58].

2. Right-click the option on the Quick Access Toolbar, which you want to remove, and
click Remove from Quick Access Toolbar.

5.6.2 To add a new option in the Quick Access Toolbar

Use the following steps to add a new option in the Quick Access Toolbar [62]:

1. Access the Historian Configuration Tool window [58].

2. Right-click the option in the ribbon bar [64], which you want to add to the Quick
Access Toolbar, and click Add to Quick Access Toolbar.

5.6.3 To show Quick Access Toolbar below the ribbon bar

The Quick Access Toolbar [62], by default, appears at the top of the Historian Configuration
Tool window. However, you can place the toolbar below the ribbon bar [64] by using the
following steps:

1. Access the Historian Configuration Tool window [58].

2. Right-click the Quick Access Toolbar, and click Show Quick Access Toolbar Below the
Ribbon.

OPH070 63
Menu bar

5.6.4 To show Quick Access Toolbar above the ribbon bar

If you want to place the Quick Access Toolbar [62] again at the top of the Historian
Configuration Tool window, use the following steps:

1. Access the Historian Configuration Tool window [58].

2. Right-click the Quick Access Toolbar, appearing below the ribbon bar [64], and click
Show Quick Access Toolbar Above the Ribbon.

5.6.5 To hide or minimize the ribbon bar

Use the following steps to hide or minimize the ribbon bar [64]:

1. Access the Historian Configuration Tool window [58].

2. Right-click the Quick Access Toolbar [62], and select Minimize the Ribbon.

5.6.6 To view the hidden or minimized ribbon bar

Use the following steps to view the hidden or minimized ribbon bar [64]:

1. Access the Historian Configuration Tool window [58].

2. Right-click the Quick Access Toolbar [62], and deselect Minimize the Ribbon.

5.7 Menu bar

The menu bar of the Historian Configuration Tool window [61] contains the following tabs.
The tab you select displays the associated ribbon bar.

• Home tab: Use this tab to access the basic configuration options in the Home ribbon
bar [65].
• Tools tab: Use this tab to access the point and data options in the Tools ribbon bar
[65].

In addition to these tabs, the Edit tab will appear under the Points menu when you
configure your historian points [110]. Use this tab to access the point configuration options
in the Edit ribbon bar [68].

5.8 Ribbon bars

The Historian Configuration Tool window [61] contains the following ribbon bars. The
ribbon bars consist of menus and commands, which are grouped based on their functions.

• Home ribbon bar [65].

• Tools ribbon bar [65].

In addition to these ribbon bars, the Edit ribbon bar [68] appears under the Points menu
when you configure your historian points [110].

64 OPH070
 Ribbon bars

5.8.1 Home ribbon bar

The Home ribbon bar of the Historian Configuration Tool window [61] contains various
commands used during configuration tasks. The following figure depicts the Home ribbon
bar.

Figure 21. Home ribbon bar of the Historian Configuration Tool window

The following table describes the functions available in the Home ribbon bar.

Table 14. Functions in the Home ribbon bar of the Historian Configuration Tool window

Group Function Description

File New Creates a new and blank database.
Open Opens an existing database.
Item Search Searches for items in the database.
XML Export Exports all data to an XML file [86].
Import Imports data from an XML file [89].
Actions Validate Validates the configuration.
Download Downloads the configuration to a historian.

Note
For configuration sessions opened from the Ovation Developer Studio, you
must download the configuration by using the Ovation Developer Studio. In
such cases, this option would be disabled and grayed out.

Data Undo Rolls back changes to the point of last Save.

Refresh Refreshes the Historian Configuration Tool window with data from the
database.
Apply Saves changes to the database.
Delete Item Deletes the item being shown in the right pane of the Historian Configuration
Tool window [72].

5.8.2 Tools ribbon bar

The Tools ribbon bar of the Historian Configuration Tool window [61] enables you to:

• View the available points for a selected scanner.

• Check details about the available points in the database for your scanners.
• Refresh the available points in the database for a selected scanner.
• Set the backup parameters, such as allowing a periodic backup.

OPH070 65
Ribbon bars

The following figure depicts the Tools ribbon bar.

Figure 22. Tools ribbon bar of the Historian Configuration Tool window

The following table describes various functions available in the Tools ribbon bar.

Table 15. Functions in the Tools ribbon bar of the Historian Configuration Tool window

Group Function Description

Point Browse View Points Shows available points for a selected scanner.
Databases
Details Shows details about available points in the database for all scanners.
When you click Details, the Point Browse Databases Details window
[67] appears. The window contains the following details:

• Scanner name
• Database name
• Last Update Time (GMT)
• Data Origin
Click Browse Points on the window to browse points.
Click Force Refresh on the window to refresh the database for a
selected scanner.
Refresh Refreshes available points in the database for a selected scanner.
Points
Data Backup Sets the backup parameters and allows an instant backup. When
you click Backup, the Backup window [68] appears. You can set the
backup interval and number of backup copies.

66 OPH070
 Ribbon bars

Point Browse Databases Details window

The following figure depicts the Point Browse Databases Details window.

Figure 23. Point Browse Databases Details window

When you click Browse Points in the Point Browse Databases Details window, the following
window appears:

Figure 24. Browse Points window

OPH070 67
Ribbon bars

Backup window
The following figure depicts the Backup window.

Figure 25. Backup window

5.8.3 Edit ribbon bar (under the Points menu)

When you configure your historian points [110], the Edit ribbon bar appears under the
Points menu, as shown in the following figure.

Figure 26. Edit ribbon bar appears under the Points menu

The following table describes various functions available in the Edit ribbon bar.

Table 16. Functions in the Edit ribbon bar of the Historian Configuration Tool window

Group Function Description

Find Find Finds a sub-string in the points view.
Export/Import Export Points Exports point records to an XML file.
Import Points Imports point records from an XML or an Ovation file.

68 OPH070
 Ribbon bars

Group Function Description

Point Records Add Allows addition of point records by using the following options:

• Browse Points
• Append
Modify Allows the modification of selected point records.
Delete Deletes the point records from a scan group.
Data Undo Rolls back changes to the point of last Save.
Refresh Refreshes the Historian Configuration Tool window with data from
the database.
Apply Saves changes to the database.

OPH070 69
Left pane of the Historian Configuration Tool window

5.9 Left pane of the Historian Configuration Tool

window
The left pane of the Historian Configuration Tool window [61] has a tree view. The following
figure depicts the left pane.

Figure 27. Left pane of the Historian Configuration Tool window

The left pane contains the following tabs:

• Historian Details [70] tab [70].

• Storage Media [71] tab [71].

5.9.1 Historian Details tab

The Historian Details tab in the left pane of the Historian Configuration Tool window [70]
displays the following details:

• Historian
• Scanners

70 OPH070
 Left pane of the Historian Configuration Tool window

• Scan Groups

Use this tab to perform the following operations:

• Configure a historian server [91].

• Configure a scanner [100].
• Configure a scan group [105].

5.9.2 Storage Media tab

The Storage Media tab in the left pane of the Historian Configuration Tool window [70]
displays the following details:

• Main Storage
• Archive Storage
• Main Storage [Partner]
• Archive Storage [Partner]

The following figure depicts the Storage Media tab.

Figure 28. Storage Media tab

OPH070 71
Right pane of the Historian Configuration Tool window

Use this tab to perform the following operations:

• Configure a disk [94].

• Configure a fixed or removable archive [96].

5.10 Right pane of the Historian Configuration Tool

window
The right pane of the Historian Configuration Tool window [61] is designed to work in
tandem with the left pane [70]. When you select a historian in the left pane, the right pane
displays the following tabs:

• Historian Properties [73] tab [73].

• Scanners [74] tab [74].
• Main Storage [75] tab [75].
• Archive Storage [76] tab [76].

Depending on the operations you perform, the right pane can display the data in the
following formats:

• Grid view [77].

• Card view [81].

72 OPH070
 Right pane of the Historian Configuration Tool window

5.10.1 Historian Properties tab

The following figure depicts the Historian Properties tab in the right pane when you select a
historian in the left pane [70].

Figure 29. Historian Properties tab in the right pane of the Historian Configuration Tool
window

OPH070 73
Right pane of the Historian Configuration Tool window

5.10.2 Scanners tab

The following figure depicts the Scanners tab in the right pane when you select a historian
in the left pane [70].

Figure 30. Scanners tab in the right pane of the Historian Configuration Tool window

74 OPH070
 Right pane of the Historian Configuration Tool window

5.10.3 Main Storage tab

The following figure depicts the Main Storage tab in the right pane when you select a
historian in the left pane [70].

Figure 31. Main Storage tab in the right pane of the Historian Configuration Tool window

OPH070 75
Right pane of the Historian Configuration Tool window

5.10.4 Archive Storage tab

The following figure depicts the Archive Storage tab in the right pane when you select a
historian in the left pane [70].

Figure 32. Archive Storage tab in the right pane of the Historian Configuration Tool window

76 OPH070
 Right pane of the Historian Configuration Tool window

5.10.5 Functionality of a grid view

A grid view presents the data in a tabular format. The Historian Configuration Tool window
displays the historian points [110] as a grid view or a tabular format, as shown in the
following figure.

Figure 33. Historian points displayed in a grid view or a tabular format

A typical grid view supports the following options:

• Adjust column width.

• Ordering [77].
• Filtering [79].
• Grouping [80].

Ordering data
Use the following steps to order or sort the data in a grid view [77]:

1. Access the Historian Configuration Tool window [58].

2. View the configured historian points [110]. The points appear in a grid view or a tabular
format.
3. Click a column heading to sort the data on the basis of the entries in the column. To
reverse the sort order, click the column heading again.

OPH070 77
Right pane of the Historian Configuration Tool window

4. In addition, you can right-click on a column heading. A right-click menu appears:

Figure 34. Right-click menu

5. From the right-click menu, you can perform the following operations:
• Sort the data in an ascending order.
• Sort the data in an descending order
• Clear sorting, if applicable.
• Group by the column.
• Hide or view the Group By box.
• Remove the column.
• Choose columns. When you click Column Chooser in the right-click menu, the
Column Chooser dialog box appears. You can drag a column, such as TYPE, to the
dialog box to temporarily remove it from the grid view.

Figure 35. Column Chooser dialog box - the TYPE column removed from the grid
view

• Choose the best column fit.

• Launch the Filter Editor to filter the data [79].

78 OPH070
 Right pane of the Historian Configuration Tool window

Filtering data
Use the following steps to filter the data in a grid view [77]:

1. Access the Historian Configuration Tool window [58].

2. View the configured historian points [110]. The points appear in a grid view or a tabular
format.
3. Right-click on a column heading and a right-click menu appears:

Figure 36. Right-click menu

4. Click Filter Editor. The Filter Editor dialog box appears. In the dialog box, you can
change the filter column, for example, from NAME to INFORMATION. In addition, you
can retrieve the data with values beginning with a desired text.

Figure 37. Filter Editor dialog box

OPH070 79
Right pane of the Historian Configuration Tool window

5. You can also filter the data by using the filter icon to the right of a column heading.
When you click the icon, a pop-up menu appears:

Figure 38. Filter icon to the right of a column heading

6. Click (Custom) in the pop-up menu. The Custom AutoFilter dialog box appears. The
dialog box allows you to further customize your search by using equations.

Figure 39. Custom AutoFilter dialog box

7. Specify the conditions in the Custom AutoFilter dialog box, and click OK.

Grouping data
Use the following steps to group the data in a grid view [77]:

1. Access the Historian Configuration Tool window [58].

2. View the configured historian points [110]. The points appear in a grid view or a tabular
format.

80 OPH070
 Right pane of the Historian Configuration Tool window

3. Drag the column headers one by one to the grouping area. The following figure depicts
a multiple group of TYPE, DEADBAND ALGORITHM, and DEADBAND VALUE columns.

Figure 40. Grouping of multiple columns

4. Right-click in the Grouping area to fully expand the tree, fully collapse the tree, entirely
clear the grouping, or hide the Group By box, as shown in the following figure.

Figure 41. Right-click menu in the Grouping area

5.10.6 Functionality of a card view

A card view presents the data in an index card format. The view is useful to quickly see the
differences between duplicate and partner drops.

The Historian Configuration Tool window displays the following information as a card view:

• Main storage [82].

• Archive storage [83].
• Scanners [84].
• Scan groups [85].

OPH070 81
Right pane of the Historian Configuration Tool window

Main storage
The following figure depicts a card view for a main storage.

Figure 42. Card view for a main storage

Note
See To configure a main storage [94] for information about configuring a main storage.

82 OPH070
 Right pane of the Historian Configuration Tool window

Archive storage
The following figure depicts a card view for archive storage devices.

Figure 43. Card view for archive storage devices

Note
See To configure an archive [96] for information about configuring an archive.

OPH070 83
Right pane of the Historian Configuration Tool window

Scanners
The following figure depicts a card view for scanners.

Figure 44. Card view for scanners

Note
See To configure a scanner [100] for information about configuring a scanner.

84 OPH070
 Status bar

Scan groups
The following figure depicts a card view for scan groups.

Figure 45. Card view for scan groups

Note
See To configure a scan group [105] for information about configuring a scan group.

5.11 Status bar

The Status bar of the Historian Configuration Tool window [61] displays the path of the
configuration file, as shown in the following figure.

Figure 46. Status bar of the Historian Configuration Tool window

OPH070 85
To export data to an XML file

5.12 To export data to an XML file

Use the following steps to export data to an XML file:

1. Access the Historian Configuration Tool window [58].

2. In the Home ribbon bar [65], click the dialog box launcher under the XML group, as
shown in the following figure.

Figure 47. Dialog box launcher in the XML group of the Home ribbon bar

3. The Export Settings window appears. You can choose to include a style sheet in your
exported XML file by selecting the check box Include XSL Stylesheet instruction, in the
exported XML file.

Figure 48. Export Settings window

4. In the Home ribbon bar, click Export.

86 OPH070
 To export data to an XML file

5. The Save As window appears. Enter the XML file name, such as example, in the File
name field and click Save. The file is saved.

Figure 49. Save As window

Note
Save the XML file to the same path where the XSL stylesheet is available. This enables
the exported XML file to appear in a tabular form when opened in an Internet browser.
Alternatively, you can copy XSL files to the location of the exported XML file.

6. Open the XML file from the path. By choosing to export the data to an XML file using a
style sheet, the data appears formatted in the exported file. The XML file opens with
Internet Explorer, as shown in the following figure.

OPH070 87
To export data to an XML file

Figure 50. Formatted XML file using a style sheet

88 OPH070
 To import data from an XML file

5.13 To import data from an XML file

Use the following steps to import data from an XML file:

1. Access the Historian Configuration Tool window [58].

2. In the Home ribbon bar [65], click Import. The Open window appears:

Figure 51. Open window

OPH070 89
To import data from an XML file

3. In the window, select the XML file, such as [Link], from which you want to
import the data, and click Open. The Select items for import window appears:

Figure 52. Select items for import window

4. The window provides you the following options.

• To select exactly which items to import.
• To overwrite or not to overwrite any existing configuration items.
• To import or not to import points and scan groups.
5. After selecting the options, click OK.

90 OPH070
 To configure a historian server

5.14 To configure a historian server

Use the following steps to configure a historian server:

1. Access the Historian Configuration Tool window [58].

2. In the Historian Details tab of the left pane of the Historian Configuration Tool window
[70], click My Historian under the Historian group.

Note
The term My Historian only appears until you rename your primary server, and your
partner server if you are using redundancy, as part of the configuration task. After
naming your primary server, the name you choose, instead of My Historian, will display
in this left pane.

3. Navigate to the Historian Properties tab in the right pane of the Historian
Configuration Tool window [72].

OPH070 91
To configure a historian server

4. In the Historian group, perform the following steps:

a. In the Name field, enter the historian name, such as TestDrop200.
b. In the Description field, enter a brief description that helps you identify the
historian in the future.
c. In the Configuration Type drop-down list, select Master or Scanner. If you are using
a historian for multiple units, one unit must provide your master configuration,
while the other units must provide scanner-only configurations. A master
configuration contains main storage or disks; archive storage, including
removable and fixed archives; scanners; and scan groups with points. A scanner
configuration contains only scanners and scan groups with points.

Figure 53. Historian Properties tab in the Historian Configuration Tool window

If you are changing a scanner-only configuration to a master configuration, the

following message appears.

Figure 54. Information message

92 OPH070
 To configure a historian server

5. In the Primary Server group, perform the following steps:

a. In the Name field, enter the primary server name, such as DROP200.
b. In the IP field, enter the IP address for the primary server.
6. If you are using a redundant historian server, perform the following steps in the Partner
Server group:
a. In the Name field, enter the redundant server name.
b. In the IP field, enter the IP address for the redundant server.
7. In the Main Storage Configuration group, perform the following steps:
a. In the Long Term Retain Period field, select the time period for which you want to
retain your long-term data in the main or extended storage. The period ranges
from 12 to 120 months. Long-term files are protected from being removed when
the storage space runs out. A special consideration is given to the long-term files
to maintain their data online longer than the rest of historical data files. Long-term
data management is activated by a configuration setting for point scan groups
[105].
b. In the Disk Warning Threshold field, enter the percentage of the disk storage
capacity that must be filled before a message is logged.
c. Select the Drop Attention Enabled check box to enable the attention message to
appear when the disk storage capacity exceeds the percentage specified in the
Disk Warning Threshold field.
d. In the Email field, enter the e-mail address for a notification when the disk storage
capacity exceeds the percentage specified in the Disk Warning Threshold field.

Note
E-mail notification and drop attention are not currently enabled.

8. In the All Archives subgroup of the Archive Storage Configuration group, perform the
following steps:
a. Select the Archiving Enabled check box to enable the archiving process for all
archives, including fixed and removable archives.
b. In the Archive Time drop-down list, select the time when you want the historian to
archive your data every day. The options are IMMEDIATE and any hour of the day. If
you select the IMMEDIATE option, the OPH data archival is scheduled immediately
after active data files are closed, which is every four hours.
c. In the Retry Period drop-down list, select the retry period between 1 and 12 hours.
If an archive operation fails, and fails again even when the historian attempts to
archive after the set retry period, there are no additional retries. When the archive
retry finally succeeds, it archives all data files available, not just the data files that
existed at the time of the initial failure.

OPH070 93
To configure a main storage

9. In the Fixed Archive subgroup of the Archive Storage Configuration group, perform the
following steps:
a. In the Warning Threshold field, enter the percentage of the fixed archive storage
capacity that must be filled before you receive a warning message.
b. Specify Volume Period in months or days. The historian archives your data or, in
other words, copies the data files to the storage device in separate volumes. Each
volume is a separate directory for a volume period.
10. In the Data Retrieval Options group, use the Percent Good Aggregate Computation
drop-down list to retrieve the percentage aggregate when the point value was GOOD
over the requested time period. Select from the following options:
• Use FAIR and GOOD samples: Both GOOD and FAIR samples are used for Percent
Good computation.
• Use GOOD samples only: Only GOOD samples are used for Percent Good
computation.
11. Click Apply in the Home ribbon bar [65] to save your changes.
12. Click Validate in the Home ribbon bar [65] or Quick Access Toolbar [62] to ensure that
your changes are consistent with the historian requirements. The following message
appears:

Figure 55. Data successfully validated

13. Click OK.

14. In the Ovation Developer Studio, right-click on the workstation that you want to load
and select Load. The configuration changes are sent to the historian and the new
settings take effect.
The Load operation may fail because of the following reasons:
• The historian configuration is not valid.
• The historian is not available.
• The redundant historians are not in sync.
If the Load operation fails, check the OVHct_log.txt file located in the directory OvHist
\hct on the database server. The text file location varies, depending on where the
historian is loaded.

5.15 To configure a main storage

Use the following steps to configure a main storage:

1. Access the Historian Configuration Tool window [58].

2. Navigate to the Storage Media tab in the left pane of the Historian Configuration Tool
window [70].

94 OPH070
 To configure a main storage

3. In the Main Storage group, click Add Disk. The right pane of the Historian Configuration
Window [72] displays the Disk Properties tab for the new primary historian disk or the
main storage, as shown in the following figure.

Figure 56. Disk Properties tab for the new primary historian disk

4. In the Disk group, perform the following steps:

a. In the Name field, enter the disk name.
b. In the Description field, enter a brief description for the disk.
5. In the Volume Properties group, perform the following steps:
a. In the Path field, enter the path that the historian can use to access the disk.
b. In the Disk Space Allocated field, specify the amount of disk space that you want to
allocate at this location.
c. In the Disk Ranking drop-down list, select HIGH, MEDIUM, or LOW as your disk
ranking. The ranking enables you to specify the priority for the currently
configured disk, compared to the other storage disks, when storing information.
For example, you may want to rank your highest performing drive as HIGH; in this
case, the most recent historical information gathered is kept in the highest ranked
disk and the older data is migrated to lower ranked disks. You can choose to set all
disks to the same rank.

Note
If storage pools are configured with unequal ranking in the OPH Server, data files
go to the highest ranked pool first. However, if storage pools are configured with
equal ranking in the OPH Server, data files will go to the first storage pool of that
rank listed in the configuration file.

OPH070 95
To configure an archive

6. Click Apply in the Home ribbon bar [65] to save your changes. The new disk appears in
the Main Storage group in the left pane of the Historian Configuration Tool window
[70].
7. Click Validate in the Home ribbon bar [65] or Quick Access Toolbar [62] to ensure that
your changes are consistent with the historian requirements. The following message
appears:

Figure 57. Data successfully validated

8. Click OK.
9. In the Ovation Developer Studio, right-click on the workstation that you want to load
and select Load. The configuration changes are sent to the historian and the new
settings take effect.

Note
You can also configure a redundant or partner storage by using the Add Disk option of
the Main Storage [Partner] group, which appears under the Storage Media tab in the
left pane of the Historian Configuration Tool window [70]. The configuration steps for
the redundant or partner storage would be exactly same as the configuration steps for
the main storage.

5.16 To configure an archive

You can configure the following types of archive:

• Fixed archive, such as network-attached storage (NAS), direct-attached storage (DAS),

or storage area network (SAN) [96].
• Removable archive, such as DVD-RAM [98].

5.16.1 To configure a fixed archive

Use the following steps to configure a fixed archive:

1. Access the Historian Configuration Tool window [58].

2. Navigate to the Storage Media tab in the left pane of the Historian Configuration Tool
window [70].

96 OPH070
 To configure an archive

3. In the Archive Storage group, click Add Archive Storage. The right pane of the Historian
Configuration Window [72] displays the Archive Storage Properties tab for the new
primary historian fixed archive, as shown in the following figure.

Figure 58. Archive Storage Properties tab for the new primary historian fixed archive

4. In the Archive Storage group, perform the following steps:

a. In the Name field, enter the name of the fixed archive.
b. In the Description field, enter a brief description for the fixed archive.
c. In the Type drop-down list, select the option Fixed Archive.
5. In the Path field of the Settings group, enter the path that the historian can use to
access the fixed archive. Please note the following points:
• The NAS and SAN disk archive devices are accessible by using an UNC name or a
local drive letter. Following are the few examples:
◦ \\[Link]\e$
◦ \\DROP29\OPHVolumes$
◦ \\[Link]\OPHshare
◦ J:
• A drive letter disk reference must be a local drive. It cannot be a network drive. For
example, you cannot use a drive that you map via the Windows File Explorer.
• Ensure that the historian has a read/write access to the drive.
• Once the device and the historian are configured, refer to the Fixed Archive [522]
tab of the Historian Diagnostics tool [522] and verify that the device properties
indicate Read/Write.
6. Click Apply in the Home ribbon bar [65] to save your changes. The new fixed archive
appears in the Archive Storage group in the left pane of the Historian Configuration
Tool window [70].

OPH070 97
To configure an archive

7. Click Validate in the Home ribbon bar [65] or Quick Access Toolbar [62] to ensure that
your changes are consistent with the historian requirements. The following message
appears:

Figure 59. Data successfully validated

8. Click OK.
9. In the Ovation Developer Studio, right-click on the workstation that you want to load
and select Load. The configuration changes are sent to the historian and the new
settings take effect.

Note
You can also configure a redundant or partner fixed archive by using the Add Archive
Storage option of the Archive Storage [Partner] group, which appears under the
Storage Media tab in the left pane of the Historian Configuration Tool window [70]. The
configuration steps for the redundant or partner fixed archive would be exactly the
same as the configuration steps for the primary fixed archive.

5.16.2 To configure a removable archive

Use the following steps to configure a removable archive, such as a DVD-RAM:

1. Access the Historian Configuration Tool window [58].

2. Navigate to the Storage Media tab in the left pane of the Historian Configuration Tool
window [70].

98 OPH070
 To configure an archive

3. In the Archive Storage group, click Removable storage. The right pane of the Historian
Configuration Window [72] displays the Archive Storage Properties tab for the new
primary historian removable archive, as shown in the following figure.

Figure 60. Archive Storage Properties tab for the new primary historian removable
archive

4. In the Archive Storage group, perform the following steps:

a. In the Name field, enter the name of the removable archive.
b. In the Description field, enter a brief description for the removable archive.
c. In the Type drop-down list, select the option Removable Media.
5. In the Settings group, perform the following step:
• In the Path field, enter the drive letter that the historian can use to access the
removable archive.
6. Click Apply in the Home ribbon bar [65] to save your changes. The new removable
archive appears in the Archive Storage group in the left pane of the Historian
Configuration Tool window [70].
7. Click Validate in the Home ribbon bar [65] or Quick Access Toolbar [62] to ensure that
your changes are consistent with the historian requirements. The following message
appears:

Figure 61. Data successfully validated

OPH070 99
To configure a scanner

8. Click OK.
9. In the Ovation Developer Studio, right-click on the workstation that you want to load
and select Load. The configuration changes are sent to the historian and the new
settings take effect.

Note
You can also configure a redundant or partner removable archive by using the Add
Archive Storage option of the Archive Storage [Partner] group, which appears under
the Storage Media tab in the left pane of the Historian Configuration Tool window [70].
The configuration steps for the redundant or partner removable archive would be
exactly the same as the configuration steps for the primary removable archive.

5.17 To configure a scanner

Use the following steps to configure a scanner:

1. Access the Historian Configuration Tool window.

2. Navigate to the Historian Details tab in the left pane of the Historian Configuration Tool
window [70].

100 OPH070
 To configure a scanner

3. In the Scanners group, click Add Scanner. The right pane of the Historian Configuration
Window [72] displays the Scanner Properties tab for the new scanner, as shown in the
following figure.

Figure 62. Scanner Properties tab for the new scanner

Note
You can configure a single machine to run all of the different types of Ovation scanners
or split each of the scanner functions to multiple machines. You can also divide point
scanning across multiple scanners.

4. In the Scanner group, perform the following steps:

a. In the Name field, enter the name of the new scanner.
b. In the Description field, enter a brief description of the scanner.
5. In the Primary Scanner group, perform the following steps:
a. In the Name field, enter the name of the primary scanner that is assigned to the
new scanner. The primary scanner collects and sends data to the historian.
b. In the IP field, enter the IP address of the primary scanner.

Note
The IP address is automatically generated for you if it is in the hosts file, which
contains the mappings of IP addresses to host names. If the IP address is not
automatically generated, enter the address manually.

OPH070 101
To configure a scanner

6. If you also want to assign a redundant or a partner scanner to the new scanner, perform
the following steps in the Partner Scanner group.
a. In the Name field, enter the name of the partner scanner that is assigned to the
new scanner. The partner scanner operates in the backup mode and goes into
active mode only if the primary scanner fails.
b. In the IP field, enter the IP address of the partner scanner.

Note
The IP address is automatically generated for you if it is in the hosts file, which
contains the mappings of IP addresses to host names. If the IP address is not
automatically generated, enter the address manually.

102 OPH070
 To configure a scanner

7. In the History types scanned group, perform the following steps:

a. Select which history types you want the scanner (or scanner pair) to scan by
selecting the corresponding history type's Enabled check box. The following
history types are available:
• Point
• Attributes
• Alarm
• Operator Event
• SOE
• SCADA
• Event

Note
Alarms, Operator Events, and SOE history types can only be assigned to one
scanner per network.

All other scanner types can be assigned to multiple scanners on the same
network.

b. Use the DAT file size drop-down menus to assign a DAT file buffer size to each
history type that you want the scanner to scan. The following table describes the
default buffer sizes for different history types.

Table 17. Default buffer sizes for different history types

History type Default buffer size

Point 32 MB
Attributes 8 MB
Alarm 16 MB
Operator Event 8 MB
SOE 8 MB
SCADA 8 MB
Event 32 MB

8. To fully identify the scanner to the historian in case of duplicate workstation names,
perform the following steps in the Qualifiers group:
a. In the Unit drop-down list, select the scanner's unit.
b. In the Network drop-down list, select the scanner's network.

OPH070 103
To configure a scanner

9. In the Additional Information group, perform the following steps:

a. Select the Enable Deluxe Point Timestamps check box if you want to use deluxe
point timestamps. If you select the check box, the historian attempts to use a
deluxe point's U8 and U9 fields as its collection timestamps. In addition to
collecting the value and status of an event, the timestamp (which the historian
collects) reflects the time that an event actually occurred, not only the time that
the event was noted by your system.

Note
In order to apply the changes to the deluxe point's U8 and U9 fields, after you
select or clear the Enable Deluxe Point Timestamps check box, ensure that you
load the OPH configuration and then restart the OPH services of the scanner drop.

b. In the Attributes Collection Criteria drop-down list, select Periodic or Changes

Only. In both modes, attribute scanning occurs after every 2 hours.
• The Periodic mode stores changes in all attributes.
• The Changes Only mode stores only the attributes that have changed since
the last scan.
10. Click Apply in the Home ribbon bar [65] to save your changes. The new scanner
appears in the Scanners group in the Left pane of the Historian Configuration Tool
window [70].
11. Click Validate in the Home ribbon bar [65] or Quick Access Toolbar [62] to ensure that
your changes are consistent with the historian requirements. The following message
appears:

Figure 63. Data successfully validated

12. Click OK.

13. In the Ovation Developer Studio, right-click on the workstation that you want to load
and select Load. The configuration changes are sent to the historian and the new
settings take effect.

5.17.1 Scanning data

The historian collects data from your system by using scanners. The scanner is a software
program that runs on a workstation that obtains data read from your Ovation network or
receives samples directly from appropriately configured Ovation Controllers.

Although the historian does not need to be located within your Ovation network, your
scanners must be. Because the historian scanners are distributed, you can collect historical
information from a wide-area network with any one of a large variety of diverse system
architectures.

104 OPH070
 To configure a point scan group

Point Data

Every point in your system has a value, a status, and some attributes, which all provide
information about a point. Scanners manage the point values (packed, analog, and digital),
statuses, and attributes for the points that you choose to scan. The historical value and
status sampling function read the point information, either from your Ovation network or
from within a Controller, and check two items:

• Has the point status changed?

• Has the point value changed more than the deadband (the amount of tolerance you
have chosen)?

The sampling function performs these two checks every second, or as frequently as you
configure your scanner to perform these checks (from every 40 milliseconds to every 60
minutes, but typically once per second).

Scanners collect a sample, based on a deadband amount or the amount computed by a

percentage of operating range. If a point exceeds the deadband that you set, or if a digital
point's value changes state, the scanner gathers the sample for that point (timestamp,
status, and value) and sends it to the historian for persistent storage to disk. If no change in
value exceeds the deadband within one hour, a sample is taken and stored anyway.

In addition to values and statuses, each process point in the Ovation system has descriptive
attributes. Though the point values in your system can change significantly, the attributes
of the points change much more slowly. Changes in attributes are caused by actions, such
as an engineer manually editing the attributes. These slowly changing attributes are read
less often, so when scanning for point attributes, the attribute values are read every two
hours and reported to the historian.

Attributes that the historian collects and stores include the following:

• Point name.
• English description.
• Engineering units.
• Set and reset description.
• Top and bottom of scale.

• Alarm limits.

When you configure a point for point value scanning, that point's attributes are
automatically scanned. You can retrieve the point attributes from the historian at any time
and use them to display point value trends, review, or reports.

5.18 To configure a point scan group

A scanner collects historian points from scan group(s) defined for that scanner. Use the
following steps to configure a scan group:

1. Access the Historian Configuration Tool window [58].

2. Navigate to the Historian Details tab in the Left pane of the Historian Configuration
Tool window [70].

OPH070 105
To configure a point scan group

3. From the left pane, click Add Scan Group in the Scanner [Name] group.
4. The Right pane of the Historian Configuration Tool window [72] displays the Scan
Group Properties tab for the new scan group. In the Scan Group, perform the following
steps:
a. Enter the scan group name in the Name field.
b. Enter a brief description of the scan group in the Description field.
c. Select Ovation Network or Controller from the Data Source drop-down menu to
determine where the point data samples are to be located. If Ovation Network is
selected, then the data sampling algorithm uses point values and statuses read
from Ovation broadcast data. If Controller is selected, the point values and status
are sampled within the Controller and streamed directly to the Point Scanner,
bypassing the point data broadcast. In this case, the Primary Controller and
Partner Controller fields are enabled. If you select Ovation Network, skip to Step 6.

Figure 64. Scan Group properties tab -- Controller selected

106 OPH070
 To configure a point scan group

5. Select Controller from the Data Source drop-down menu.

a. Enter the name and IP address of the Primary Controller.
b. Enter the name and IP address of the Partner Controller.

Note
You can specify a OCC100 Controller in these fields.

c. Select the Scanning Enabled check box if you want this scan group to be
monitored.
d. In the Scan Frequency field, set the scan frequency that determines how often a
historian scanner monitors information from this group of points. You can
configure the Scan Frequency field to Standard (scans in multiples of one second,
up to a limit of 3600 seconds (60 minutes) and Fast (scans at the fast broadcast
rate of the system (either 40 mS or 100 mS).
e. In the Long Term Enabled field, select the check box if you want this scan group to
be a long-term scan group. You can define a subset of points to be stored for long
term (the current default for a long-term storage is five years), and these points
will be deleted last if space is required. It is recommended to use the long-term
storage for a small subset of key points.
f. In the Digital Sampling Limiting Enable field, select the check box if you want to
activate chattering suppression for digital point sampling performed in the
Controller.
g. The Max Samples in 5 Min field becomes active when the chattering suppression
for digital points is activated. This value determines how long the scanner detects
and limits the sampling of digital points.

OPH070 107
To configure a point scan group

6. Select Ovation Network from the Data Source drop-down menu.

Figure 65. Scan Group properties tab -- Ovation Network selected

a. Select the Scanning Enabled check box if you want this scan group to be
monitored.
b. In the Scan Frequency field, set the scan frequency that determines how often a
historian scanner monitors information from this group of points. You can
configure the Scan Frequency field to Standard (scans in multiples of one second,
up to a limit of 3600 seconds (60 minutes) and Fast (scans at the fast broadcast
rate of the system (either 40 mS or 100 mS).
c. In the Long Term Enabled field, select the check box if you want this scan group to
be a long-term scan group. You can define a subset of points to be stored for long
term (the current default for a long-term storage is five years), and these points
will be deleted last if space is required. It is recommended to use the long-term
storage for a small subset of key points.

Note
When setting a point scan frequency, consider the time between significant events in
your process. For example, if your point is monitoring a large wastewater pond for
changes in depth, you can set a slower scan rate, because changes in depth will
generally be slow. However, if you are monitoring a generator whose wattage output
can fluctuate in a matter of seconds, consider a faster scan rate.

Note
The Scan Enabled, Scan Frequency, and Long Term Enabled parameters are defined for
the scan group and are applicable to all points in the scan group. It is recommended to

108 OPH070
 To configure a point scan group

add points of different parameters to different scan groups. You may choose any logical
classification to group points into various scan groups for organization and
configuration.

7. In the Default values for new point additions group, define the values for new point
additions that are assigned to all new points added to this scan group. The following
table describes the deadband options in this group.

Table 18. Description of deadband options

Deadband Description
option
Deadband Determines how changes in the analog point value are filtered by the
Algorithm historian. The following algorithms are available for the Ovation Network
data source:

• STANDARD
• PCT_RANGE
• RATIO
• LOG
• POWER
• FLOW
• RADIATION
• SLOPE

Note
For the Controller data source, only STANDARD and PCT_RANGE
deadband algorithms are supported.

Deadband Value Determines the value that is applied by the selected deadband algorithm.
Deadband K The K value is used for the following algorithms:
Value
• LOG
• POWER
• FLOW
• RADIATION
Deadband N The N value is used for the following algorithms:
Value
• LOG
• POWER
The default N value for FLOW algorithm is 0.5.
The default N value for RADIATION algorithm is 10.

Note
For more information about deadbands, refer to the analog point
deadband definitions in To configure historian points [110].

OPH070 109
To configure historian points

8. The Historian Configuration Tool window displays the following point count
information:
a. License: Reflects the total number of licensed points. The Historian is licensed
based on the number of points of historical data you want to collect. The Historian
can collect a maximum of 400,000 points.
b. HCT: Reflects the number of points that are configured on the local network.
c. Unused: Reflects the number of points that are still available for configuration.
Typically, you can calculate the number of unused points as follows:
Unused = License - OPH
9. For convenience and organizational purposes, you can create multiple scan groups for
each scanner. You can plan your scan groups in many different ways. For example, you
might want to create groups around a scan frequency, an originator, a plant area, or for
a long-term storage. When you are finished, click Apply in the Home ribbon bar [65] to
save your changes. The new scan group appears in the Scanner [Name] group in the
left pane of the Historian Configuration Tool window [70].
10. Click Validate in the Home ribbon bar [65] or Quick Access Toolbar [62] to ensure that
your changes are consistent with the historian requirements. The following message
appears:

Figure 66. Data successfully validated

11. Click OK.

12. In the Ovation Developer Studio, right-click on the workstation that you want to load
and select Load. The configuration changes are sent to the historian and the new
settings take effect.

5.19 To configure historian points

You must assign each point that you want to monitor for historical collection to a specific
scanner and scan group. Use the following steps to configure historian points:

1. Access the Historian Configuration Tool window [58].

2. Navigate to the Historian Details tab in the left pane of the Historian Configuration Tool
window [70].

110 OPH070
 To configure historian points

3. In the Scanner [Name] group, select a scan group, and click the Point List tab in the
right pane of the Historian Configuration Window [72], which causes the Edit ribbon
bar [68] under the context-sensitive Points menu to appear in the ribbon bar, as shown
in the following figure.

Figure 67. Point List tab for a scan group

4. If you are adding points for the first time to the scan group, click Add in the Edit ribbon
bar [68]. The Add Points to Scan Group window appears:

Figure 68. Add Points to Scan Group window

OPH070 111
To configure historian points

5. In the Add Points to Scan Group window:

• Select the Do not show OCB points check box to hide the OCB points.
• Select the Show only the points eligible for addition. Add button is disabled when
this checkbox is not checked. check box to only display the points allowed for
addition.
• Select the points that you want to add, and click Add. You can select multiple
points by holding down the Shift key to select large continuous sections of points,
or by using the Ctrl key to select multiple individual points.
• If you want to add all points, click Select All and then click Add.
• Click Refresh point list with latest data to refresh the point records.
• Click Cancel to close the window without adding points.
6. When you click Add in the Add Points to Scan Group window, the points are displayed
in the Point List tab in the right pane of the Historian Configuration Window [72], as
shown in the following figure. The points are added with the current default values for
the scan group.

Figure 69. Points added in the Point List tab

7. You can modify a point if you want. Click a point to highlight it, and click Modify in the
Edit ribbon bar [68]. The point's fields are now editable. You can type directly in some
fields, or use the drop-down menus that appear when you click the other fields. You
can also edit multiple lines at the same time by holding down the Shift key to select a
large continuous section of points, or by using the Ctrl key to select multiple individual
points, and clicking Modify.

Note
Press Ctrl+F to access the Find dialog box. The dialog box enables you to enter a search
string. For example, you might use the Find dialog box to search points in a point list
that share a common naming convention.

112 OPH070
 To configure historian points

8. You can use the Point List tab interface to organize your data as per your preferences.
The interface enables you to order [77], filter [79], and group [80] your data by various
criteria.
The following table describes the columns in the point data displayed in the Point List
tab.

Table 19. Columns in the point data displayed in the Point List tab

Column heading Description

NAME Click this field to edit the point name.
ENABLED Click this field to toggle the Enabled check box. The check mark enables
the point.
TYPE Click this field to get a drop-down menu that enables you to select
ANALOG, DIGITAL, or PACKED.
INFORMATION It is not recommended that you edit this field, which displays the Ovation
SID and record type. This field is updated when you click Validate.
DEADBAND Click this field to select the algorithm from the following options:
ALGORITHM
• STANDARD
• PCT_RANGE
• RATIO
• LOG
• POWER
• FLOW
• RADIATION
• SLOPE
DEADBAND VALUE Click this field to edit the deadband value. This field is mandatory for
analog points, and contains a default value that you can change, if
required. (See the following table for deadband options.)
DEADBAND K Click this field to edit the deadband K value, which is enabled or disabled
VALUE based on your deadband algorithm choice. (See the following table for
deadband options.)
DEADBAND N Click this field to edit the deadband N value, which is enabled or disabled
VALUE based on your deadband algorithm choice. (See the following table for
deadband options.)

If you are working with analog points, the deadband values that you can select are
described in the following table.

Table 20. Deadband values for analog points

Deadband Meaning
Standard Compares the previously collected values with the currently scanned value for
changes beyond your specified deadband value.
Percent range Compares the previously collected value with the percentage of the current
range of the top and bottom of range values of the point.
Flow Compares the current collection deadband and the results of the current and
previously stored process values raised to the power specified by 1/0.5.

OPH070 113
To configure historian points

Deadband Meaning
The collection deadband is calculated as follows:

Base deadband * (K Component **1/0.5).

Note
N Component is fixed at 0.5.

Power Compares the current collection deadband and the results of the current and
previously stored process values raised to the power specified by 1/
NComponent.

The collection deadband is calculated as follows:

Base deadband * (K component**1/NComponent).

Ratio Collection deadband is recalculated every time the process value differs from
the last stored value by the amount specified by the base deadband.

The new collection deadband is calculated to be a percentage of the new

collection value.
Logarithmic Compares the current collection deadband and the logarithms of the current
and previously stored process values.

The collection deadband is calculated as follows:

Base deadband * K Component * log (N Component)

Slope Monitors for changes in slope.
Radiation Compares the current collection deadband and the logarithms of the current
and previously stored process values to check for a difference that exceeds the
allowed deadband.

The collection deadband is calculated as follows:

Base deadband * K Component

Note
N Component is fixed at 10.0.

Note
In cases where K component is applicable, you can configure its value.

9. Click Apply in the Home ribbon bar [65] to save your changes.

114 OPH070
 Configuring your Ovation system to enable the collection of historical messages or events

10. Click Validate in the Home ribbon bar [65] or Quick Access Toolbar [62] to ensure that
your changes are consistent with the historian requirements. The following message
appears:

Figure 70. Data successfully validated

11. Click OK.

12. In the Ovation Developer Studio, right-click on the workstation that you want to load
and select Load. The configuration changes are sent to the historian and the new
settings take effect.

5.20 Configuring your Ovation system to enable the

collection of historical messages or events
To prepare your Ovation system to enable the collection of historical messages or events,
you must complete the following configuration tasks:

• To configure Ovation alarm event scanning [115].

• To configure Ovation operator event scanning [118].
• To configure Ovation sequence of events scanning [119].

Note
For complete user interface definitions and further information on these tasks, refer to
the Ovation Developer Studio User Guide.

5.20.1 To configure Ovation alarm event scanning

Alarms are generated when abnormal conditions, or conditions that require special
attention, occur in your system. The historian collects alarms in your system according to
your specifications. The alarms are then available for you to retrieve at any time.

Use the following steps to configure Ovation alarm event scanning:

1. Access the Ovation Developer Studio. Refer to the Ovation Developer Studio User Guide
for more information.
2. Use the system tree to navigate to the Alarm folder as follows:
Systems -> Configuration -> Alarm
If you do not see an Alarm folder in your system tree, right-click and select Insert New
to create one.
3. Right-click on the Alarm folder and click Open. The Alarm window appears.

OPH070 115
Configuring your Ovation system to enable the collection of historical messages or events

4. Scroll to select the Normal Mode Filtering, Priority Mode Filtering, or Unit Filtering tabs
by using the horizontal scroll bar. Specify your filtering options. Your specifications
indicate which alarms are sent to the historian for storage.
5. Scroll to select the Alarm Historical Storage tab.

Figure 71. Alarm Historical Storage tab

6. Specify your configuration settings, as described in the following table.

Table 21. Configuration settings

Option Description Setting options

Send Alarms To Identifies whether alarms will be The default value is False. Set this option to
The Historian sent to the historian. True to receive alarms.
Send First Pass Identifies whether alarms will be The default value is True.
Alarms To The sent to the historian on first
Historian pass. It is only applicable if
alarms will be sent to the
historian.
Historian Alarm Allows you to select the drop Select a workstation from the drop-down
Scanner Drop where the scanner software is list.
running.
If this field is left blank, messages are sent
to an alarm scanner on the same machine
as the alarm arbiter. It is recommended
that you use a blank entry to facilitate the
redundant alarm scanning.

116 OPH070
 Configuring your Ovation system to enable the collection of historical messages or events

7. You can save configuration changes after each tab is configured, or you can save all
changes after all the required tabs in the window have been configured. Click Apply to
save the changes and leave the window open. Alternatively, click Ok to save the
changes and close the window.
8. The configuration changes you made will not take effect until they are downloaded to
the Ovation workstation and the Ovation workstation is restarted.

For more information about Ovation alarm event configuration, refer to Configuring Your
Ovation Operator Station.

To check for alarm configurations by using the Search function of

the Ovation Developer Studio
It can be helpful to search all places in your system that have alarms defined in the Ovation
Developer Studio hierarchy.

Use the following steps to check for alarm configurations by using the Search function of
the Ovation Developer Studio:

1. Access the Ovation Developer Studio. Refer to the Ovation Developer Studio User Guide
for more information.
2. Right-click at the System level of the navigation tree, and click Search. The Search
Options Wizard appears.
3. Select Object: Alarms in the wizard, and click Next.
4. Select whether you want to search for all items of this type or narrow your search with
clauses. In this case, select the Find all items option, and click Finish.
5. The search results are displayed in the Search: Object: Alarms window, as shown in the
following figure. You can use these results to ensure that each alarm configuration in
your system is set appropriately.

Figure 72. Alarm search results

OPH070 117
Configuring your Ovation system to enable the collection of historical messages or events

5.20.2 To configure Ovation operator event scanning

When a plant operator performs certain functions, such as forcing the value of a point or
changing a control loop from automatic to manual, the system generates operator event
messages. After the historian collects these messages, you can retrieve them at any time.

Use the following steps to configure Ovation operator event scanning:

1. Access the Ovation Developer Studio. Refer to the Ovation Developer Studio User Guide
for more information.
2. Use the system tree to navigate to a network folder as follows:
Systems -> Networks (open a network)
3. Right-click the network folder and click Open. The Config tab appears:

Figure 73. Config tab

4. Click to edit the Operator Event Multicast Address field, if necessary.

5. Click Apply or Ok.

118 OPH070
 Configuring your Ovation system to enable the collection of historical messages or events

5.20.3 To configure Ovation Sequence of Events scanning

A Sequence of Events (SOE) system generates special records when any of a set of digital
points changes its state. These digital points are hardwired to digital I/O cards that can
perform high-resolution timestamping. When the points change their states, the cards
produce a record with the new state and an accurate timestamp that indicates the time of
the state change. In the Sequence of Events scanning, all states and timestamps from these
records are gathered and reported to the historian for a permanent storage. You can
retrieve the Sequence of Events records at any time.

Use the following steps to configure Ovation Sequence of Events scanning:

1. Access the Ovation Developer Studio. Refer to the Ovation Developer Studio User Guide
for more information.
2. Use the system tree to navigate to the Controller folder as follows:
Drop Folder (select a Controller drop) -> Configuration -> Controller
3. Right-click the Controller folder and click Open. The Controller Parameters tab appears:

Figure 74. Controller Parameters tab

OPH070 119
Configuring your Ovation system to enable the collection of historical messages or events

4. In the SOE Logger fields, from the drop-down list, select the workstations that you
want the Controller to send the SOE messages to.

Table 22. SOE Logger fields

Field Description
SOE Selects the first Scanner Workstation drop where SOE messages are sent. (Refer to
Logger 1 the applicable Ovation Process Historian User Guide.) This field is not applicable if
the system does not include a Sequence of Events I/O module.

Default = None
SOE Selects the second Scanner Workstation drop where SOE messages are sent.
Logger 2 (Refer to the applicable Ovation Process Historian User Guide.) This field is not
applicable if the system does not include a Sequence of Events I/O module.

Default = None
SOE Selects the third Scanner Workstation drop where SOE messages are sent. (Refer
Logger 3 to the applicable Ovation Process Historian User Guide.) This field is not applicable
if the system does not include a Sequence of Events I/O module.

Default = None
SOE Selects the Ovation OPC Alarm and Event Server (workstation drop) where SOE
Logger 4 messages are sent. (Refer to the applicable Ovation Process Historian User
Guide.) This field is not applicable if the system does not include a Sequence of
Events I/O module.

Note
The same workstation cannot be used as both the OPC Alarm and Event Server
(AED) and the OPH SOE scanner for SOE configuration. For more information on
OPC AES, refer to the OPC Tools User Guide.

5. Select the workstations where your Historian scanners reside. To allow for redundant
scanners, add both scanners.
6. Click Apply or Ok to accept changes.

Note
The configuration changes you made will not take effect until they are downloaded to
the Controller and the Controller is restarted.

To configure SOE points and hardware

You must configure a digital point to enable it to collect SOE information.

Use the following steps to configure SOE points and hardware:

1. Access the Ovation Developer Studio. Refer to the Ovation Developer Studio User Guide
for more information.
2. Use the system tree to navigate to the Digital Points folder as follows:
Systems -> Networks -> Network -> Units -> Unit -> Drops -> Drop -> Points -> Digital
Points

120 OPH070
 Configuring your Ovation system to enable the collection of historical messages or events

3. Double-click the point that you want to open. The Point tab appears. Scroll to the
Hardware tab.

Figure 75. Hardware tab

4. Select the Soe point check box. This step identifies the point as an SOE point to the
Controller.
5. Specify your I/O settings as described in the following table.

Table 23. I/O settings

Attribute Value
IO type • Q-Line
• Ovation
• Third Party
IO module Options in this field correspond to the value in the IO Type field. Select the
appropriate SOE module.
IO channel 1 - 16
IO task Index 1 - 5

OPH070 121
Configuring your Ovation system to enable the collection of historical messages or events

6. Click Apply or Ok to save your changes.

7. Expand the I/O Device tree in the specific Controller. Navigate to the Slot folder to
select the SOE module.
I/O Device -> Node -> Branch -> Slot
8. Scroll to the Module tab.

Figure 76. Module tab

9. Select Event Tagging Enable for the channels that the SOE will be reporting on, by
selecting the appropriate check box. For example, you might select all sixteen
channels. If a correct channel is not selected, SOE reporting is not performed for a point
configured on that channel.
10. Select Apply or Ok to accept the changes.
11. The configuration changes you made will not take effect until you load them to the
workstation.

Refer to the Ovation Developer Studio User Guide for an explanation of all of the tabs
available in the Ovation Module folder and a detailed procedure on configuring points and
configuring I/O.

122 OPH070
 Configuring your Ovation system to enable the collection of historical messages or events

5.20.4 To configure Triggered Events

A Triggered Event is a pre-defined event that you can configure via the Ovation Developer
Studio. The event of interest is the change of value of a point. For example, you may wish to
configure a "Turbine Trip Event." The event would contain descriptive data such as "Drop 2,
Turbine Trip Event," and the data would contain values over a period of time ( for example,
two minutes before and one minute after the event). The Triggered Event data is contained
on the Controller until the event occurs. At that time, the event information is sent to the
Event Scanner/OPH systems and analyzed using the Event Trend [389] application.

Use the following steps to configure Triggered Events:

1. Access the Ovation Developer Studio. Refer to the Ovation Developer Studio User Guide
for more information.
2. Use the system tree to navigate to the Controller folder as follows:
Drop Folder (select a Controller drop) -> Configuration -> Controller
3. Right-click the Controller folder and click Open. The Controller Parameters tab appears:

Figure 77. Controller Parameters tab

OPH070 123
Configuring your Ovation system to enable the collection of historical messages or events

4. In one of the Triggered Event Logger fields, select the workstation from the drop-down
list that is to receive the triggered event:

Figure 78. Triggered Event Logger drop-down list

Table 24. Triggered Event Loggers

Field Description
Triggered Event Selects the first scanner workstation drop where Triggered Events are
Logger 1 sent. This is applicable to OCR 1100 Controllers only. Default = None
Triggered Event Selects the second scanner workstation drop where Triggered Events are
Logger 2 sent. This is applicable to OCR 1100 Controllers only. Keep the default
value of none for Ovation Compact Controllers. Default = None

5. Select the workstations where your Historian scanners reside. To allow for redundant
scanners, add both scanners.
6. Click Apply or Ok to accept changes.

Note
Triggered Event Logger 1 and Triggered Event Logger 2 cannot have the same value,
that is, they must be different drops or Event Trend will fail to display the data.

Note
The configuration changes you made will not take effect until they are downloaded to
the Controller and the Controller is restarted.

124 OPH070
 To load your configuration to the historian on a Windows-based system

Note
The Event scanner can also receive COMTRADE file sets from the SCADA server. When the
COMTRADE file set is received, an event is created. See Using the IEC 61850 MMS Client
Protocol with Ovation for details.

5.21 To load your configuration to the historian on a

Windows-based system
After you have configured your historian, disks, archives, points, and scanners, you must
run a brief load operation, which validates all of your configurations and sends them to the
historian. If you have not run the load procedure during the configuration tasks, you can run
it separately.

Note
Any configuration changes made through the Historian Configuration Tool (HCT) window
must be saved and loaded to the OPH.

Use the following steps to load your configuration to the historian on a Windows-based
system:

1. Access the Ovation Developer Studio. Refer to the Ovation Developer Studio User Guide
for more information.
2. Use the system tree to navigate to the historian object that represents your historian
workstation:
System -> Configuration -> Historians -> Ovation Process Historian Servers
3. Right-click the historian and click Load. The load procedure validates your settings and
sends them to your historian server. As the server only checks for changes every 30
seconds, it could take up to 30 seconds before your settings take effect.

OPH070 125
 Licensing overview

6 Licensing the historian

Topics covered in this section:
• Licensing overview [127]
• To obtain your locking code [128]
• To obtain your license key [130]
• To enable your license [130]
• To verify your installed licenses [133]

6.1 Licensing overview

You must have licenses for the following components in order to use the historian:

• Point count: The historian is licensed on the basis of how many points you want to
collect the historical data for. The maximum number of points that one historian can
collect is 400,000. You can license points in 1,000-point increments between 5,000
and 400,000 points.
• Non-Ovation client: Though Ovation clients do not need to be licensed, applications
that are not Ovation-dependent must be licensed. You can only have a pre-determined
number of non-Ovation client applications running concurrently. Each time that one of
your non-Ovation applications attempts to connect to the historian, the historian
checks that you have not exceeded your maximum number of allowed applications.
Simultaneous applications on the same machine consume only one license.
• Historian subsystem: During startup, the historian checks that the correct subsystems
(point data, alarm, sequence of events and operator events collection and storage) are
licensed.
• Desktop Tools: This license is required for the non-Ovation client.

You are allowed a 10-day trial license to use the historian. After 10 days have expired, you
must fully license the historian to continue using it.

Note
During the trial license period, you may receive the drop fault (Operator Attention)
message. If this happens, obtain the full license immediately.

Before you can enable your license [130], you must:

1. Obtain your locking code [128].

2. Obtain your license keys [130].

OPH070 127
To obtain your locking code

In addition to obtaining the locking code and license keys, note the following points:

• You must reboot the system or restart the OPH service when you update a license.
• If there is a mismatch between the historian configuration and license settings, no
historian processes will start. For example, if a SCADA scanner is enabled in
configuration and you do not have a SCADA scanner licensed, no historian processes
will start. The following configuration or licensed items are checked:
◦ Scanner type (Point data, Alarms, SOEs, Operator Events, and SCADA).
◦ Historian point count.
• If you are using redundant servers, you must obtain a separate license for both the
primary and partner servers. Emerson recommends that redundant server pairs have
the same features licensed on each server.

6.2 To obtain your locking code

Before you can enable your license, you must share your individual locking code with your
Emerson representative. Use the following steps to find your locking code:

1. Run the historian license manager program ([Link]).

Start -> Programs (or Apps) -> Ovation Process Historian -> License Manager

Note
The directory that stores the [Link] file is normally D:\OVHist\bin or E:\OVHist
\bin. The OVH_HOME environment variable is set up during the installation of the
historian software. You can determine its value by opening the System icon on the
Control Panel and finding the OVH_HOME setting in the Environment tab.

128 OPH070
 To obtain your locking code

2. The Historian License Manager window appears. Note the Locking Code displayed on
this window.

Figure 79. Historian License Manager window -- Locking code

You can also obtain the locking code by selecting Add License from the menu bar. The
Add License window appears. Note the Locking Code displayed on this window.

Figure 80. Add License window -- Locking code

3. Give the locking code to your Emerson representative when you apply for your license
key.

OPH070 129
To obtain your license key

6.3 To obtain your license key

Contact your Emerson representative. Be prepared to supply the number of points that you
want to collect data, the number of clients that you want to use, and the number of licensed
features that you want to run (alarms, operator events, SOE, SQL queries, Lab Data, edits,
annotations). You should also be prepared to supply your locking code [128]. Two license
codes, Point Count/Client Count and Features Enable, are issued.

6.4 To enable your license

Use the following steps to enable your license:

1. Run the historian license manager program ([Link]).

Start -> Programs (or Apps) -> Ovation Process Historian -> License Manager

Note
The directory that stores the [Link] file is normally D:\OVHist\bin or E:\OVHist
\bin. The OVH_HOME environment variable is set up during the installation of the
historian software. You can determine its value by opening the System icon on the
Control Panel and finding the OVH_HOME setting in the Environment tab.

2. The Historian License Manager window appears. Click Add License.

Figure 81. Historian License Manager window

130 OPH070
 To enable your license

3. The Add License window appears. You can add license keys in two ways:
• Enter License Code (see Step 4)
• Extract License(s) From File (see Step 5)

Figure 82. Add License window -- two options to add licenses

4. To use the Enter License Code option:

a. In the Enter License Code field, enter the license key(s) [130] provided by your
Emerson representative.
b. Click Add License.

Figure 83. Add License window -- Enter License Code option

OPH070 131
To enable your license

5. If the license key(s) [130] are provided in a file, you can use the Extract License(s) From
File option. To use this option:
a. Click Browse.
b. Navigate to the file containing the license key(s).
c. The path of the text file appears in the field adjacent to the Browse button.
d. Click Extract License(s).

Figure 84. Add License window -- Extract License(s) From File option

e. The Add License(s) window displays the licenses available from the text file.
f. Select the check box(es) for the license key(s) that you want to extract.
g. Click Extract.

Figure 85. Add License(s) window -- displaying available licenses

132 OPH070
 To verify your installed licenses

6. The KeyDetails window appears. Verify the license details and click Add to install the
license.

Figure 86. KeyDetails window

6.5 To verify your installed licenses

Use the following steps to verify your license:

1. Run the historian license manager program ([Link]):

Start -> Programs (or Apps) -> Ovation Process Historian ->License Manager

Note
The directory that stores the [Link] file is normally D:\OVHist\bin or E:\OVHist
\bin. The OVH_HOME environment variable is set up during the installation of the
historian software. You can determine its value by opening the System icon on the
Control Panel and finding the OVH_HOME setting in the Environment tab.

OPH070 133
To verify your installed licenses

2. The Historian License Manager window appears. In the left pane, select the license
feature. The right pane displays the license details.

Figure 87. Historian License Manager window

Note
If the license is not present, is expired, or the number of points configured in your
historian exceeds the number allowed in the license, the historian collection process
does not start. A license error message is logged in the historian error log
(%OVH_HOME%\bin\Ovh_Log_File.0).

134 OPH070
 OPH Server storage failure and recovery overview

7 Recovering from OPH Server failure

Topics covered in this section:
• OPH Server storage failure and recovery overview [135]
• Possible OPH Server failure scenarios [137]
• Recovering the OPH Server runtime environment [138]
• Recovering the main storage historical data [146]
• Recovering the fixed archive storage [149]

7.1 OPH Server storage failure and recovery overview

Typically, the OPH Server employs RAID storage to provide protection against the loss of the
OPH runtime environment and historical data due to a single drive failure. However, if the
RAID subsystem experiences a catastrophic failure, the OPH applications, configuration,
and/or historical data (main or archived) can be lost. Separate features and procedures exist
to recover the operational [136] and historical data [136] in the event of a failure.

Note
Recovery of historical data in the event of catastrophic failures depends on configuring and
maintaining at least one of two optional OPH capabilities -- data archiving and/or OPH
Server redundancy.

Figure 88. OPH runtime environment and historical data of an OPH Server

OPH070 135
OPH Server storage failure and recovery overview

7.1.1 Recovery of the OPH runtime environment

If the OPH runtime environment is lost, it can be restored by using one of the following
procedures, followed by a reload of the configuration using the Ovation Developer Studio:

• Re-installation of the Windows operating system and OPH software from installation
media [139].
• Recovery from a backup image using Emerson’s optional System Backup & Recovery
2.0 (or newer) product (SBR) [141].

Note
Refer to the appropriate System Backup and Recovery User Guide for SBR backup and
recovery procedures.

7.1.2 Recovery of historical data

When a main storage area is lost, the OPH can utilize the following native capabilities to
manage the backup and restoration of historical data:

• Historian Server redundancy: Historian Server redundancy provides continuous data

synchronization and automated data restoration to minimize opportunity for any loss
of historical data.
• Archive reload: Archival occurs more frequently than SBR backup. Typically, SBR
backups are scheduled daily whereas OPH data archival can be scheduled after active
data files are closed, which is every 4 hours.

These native features provide enhanced protection against historical data loss over the SBR
tool.

Note
Emerson requires the use of OPH native features, rather than SBR capabilities, to restore any
OPH historical data storage.

The following table summarizes the historical data protection provided by the available
OPH Server deployment configurations.

Table 25. OPH Server deployment configurations

OPH Server Historical data protection Historical data loss

deployment type
Standalone with no None. All historical data is lost.
archive.
Standalone with Data is backed up in the archive. Data collected after last archival.
archive.
Data missed during Server downtime.

136 OPH070
 Possible OPH Server failure scenarios

OPH Server Historical data protection Historical data loss

deployment type
Redundant Servers. Redundant partner maintains None (if the partner Server is
duplicate history of process data. functional throughout the failure and
restoration process).
Redundant partner captures data
during failed Server downtime.

Another storage system that can be affected by failure is an OPH fixed archive. While SBR is
not supported for this device, the OPH can be used to re-archive its current main storage
content. Alternatively, replication or backup capabilities supported by the storage device
manufacturer can be used. However, the Ovation network should not be used as the data
transport mechanism.

7.2 Possible OPH Server failure scenarios

A typical OPH deployment may contain the OPH runtime environment, main storage, and
archive storage, as shown in the following figure:

Figure 89. Typical OPH Server storage architecture

The internal RAID disk storage (depicted as drives C: and D: in the figure) contains the
Microsoft Windows operating system, OPH applications, configuration, and main storage
historical data. Main storage is often extended by one or more external RAID disk storage
units (depicted as the K: drive in the figure). In addition, an archive storage, such as an NAS,
may be included.

The following table describes software and data loss expectations along with recovery
options for various OPH Server failure scenarios.

OPH070 137
Recovering the OPH Server runtime environment

Table 26. OPH Server failure scenarios

Failed Potential data loss Recovery options Reference

storage
device
Internal OPH runtime OPH operating environment can • To restore the failed OPH
RAID environment. be restored in two ways: Server runtime software
using re-installation
• Re-installation from media [139].
installation media.
• To restore the failed OPH
• Recovery from SBR backup Server runtime software
image. using SBR [141] .
• Post runtime software
restore steps [141].
• System Backup &
Recovery User Guide.
Main Storage Use the OPH native features to • To recover the main
historical data. restore the main storage: storage for a redundant
OPH Server [146]
• Recovery from redundant
• To recover the main
OPH Server.
storage for a standalone
• Reload from archives. OPH Server [148] .
External Loss of main storage Use the OPH native features to • To recover the main
RAID historical data, but restore the main storage: storage in case of an
no loss of operating external RAID failure
system and OPH • Recovery from redundant [148] .
runtime OPH Server.
environment. • Reload from archives.
Archive Loss of archived • Perform re-archival of • To re-archive historical
historical data, but existing historical data from data from main storage
no loss of operating main storage. [150] .
system, OPH
• Restore fixed archive device
environment, or the
per manufacturer’s
historical data in
supported methods.
main storage.

7.3 Recovering the OPH Server runtime environment

A failure of the internal RAID results in the loss of the OPH runtime environment. Therefore,
the OPH runtime environment must be reestablished before historical data can be restored.
After this, when the archive exists as a historian component, you must also reestablish the
internal archive volume information for proper archival operation.

138 OPH070
 Recovering the OPH Server runtime environment

Figure 90. Internal RAID failure

Restore the OPH runtime environment by using the following general sequence:

1. When a storage device fails, replace the hardware and restart the OPH Server.
2. Restore the operating system, Ovation (optional), and OPH software.
3. Restart the OPH Server.
4. From all connected Ovation systems, reload the OPH Server configuration by using the
Ovation Developer Studio (see Post runtime software restore steps [141]).
5. If an archive exists, reestablish the volume database (see Post runtime software restore
steps [141]).
6. Data collection, storage, and retrieval should begin to operate.
7. You can proceed with the historical data recovery (see Recovering the main storage
historical data [146]).

You can restore the failed OPH runtime environment by using the following two methods:

• Recovery by re-installation of Windows OS and OPH/Ovation software (see To restore

the failed OPH Server runtime software using re-installation media [139]).
• Recovery using the latest SBR backup image (see To restore the failed OPH Server
runtime software using SBR [141] and refer to the System Backup & Recovery User
Guide).

7.3.1 To restore the failed OPH Server runtime software using

re-installation media
The OPH runtime software includes:

• Windows operating system

• OPH application software

Use the following steps to restore the failed OPH operating environment by reinstalling
from the installation media (Windows OS and OPH/Ovation software):

1. Install the applicable operating system on the machine.

OPH070 139
Recovering the OPH Server runtime environment

2. Install Microsoft patches.

3. Install the OPH software with required features [43]. During the installation, select the
Recovery option.

Figure 91. OPH installation type -- Recovery

Note
You must select the Recovery installation to ensure that the runtime configuration
reestablishment sequence is properly initiated.

Note
See What are different OPH installation scenarios? [53] for a description of other
installation options.

140 OPH070
 Recovering the OPH Server runtime environment

4. If you are recovering from a storage failure, click Yes.

Figure 92. Question dialog box

5. After the OPH software is installed, load the licenses [127].

6. Reboot the machine.
7. Proceed to Post runtime software restore steps [141] to complete the restoration of
the runtime environment. This will restore the OPH Server configuration and
reestablish the internal archive records if an archive exists.

7.3.2 To restore the failed OPH Server runtime software using

SBR
After repair or replacement of the internal RAID storage, recover the OPH Server runtime
software by using the latest SBR backup image. Refer to the System Backup & Recovery User
Guide for backup and recovery instructions.

After the restored OPH drop is restarted, proceed to restore the OPH Server configuration
and reestablish the internal archive records to complete the restoration of the runtime
environment (see Post runtime software restore steps [141] ).

7.3.3 Post runtime software restore steps

After restoring the OPH Server runtime software through either re-installation [139] or
from an SBR backup image [141], use the following steps to prepare the OPH Server
runtime environment for operation:

OPH070 141
Recovering the OPH Server runtime environment

1. After the machine restarts, open the Historian Diagnostics tool [510]. The tool may
display a status of Waiting for new configuration or Waiting for configuration.

Figure 93. Historian Diagnostics tool -- Waiting for configuration

2. When the Historian Diagnostics tool indicates it is waiting for configuration, load the
OPH configuration from the Ovation Developer Studio for each Ovation system
serviced by this OPH Server.

142 OPH070
 Recovering the OPH Server runtime environment

3. Return to the Historian Diagnostics tool. If an archive exists, the tool displays a status of
Waiting for VOLDB restore. If no archive exists, skip to Step 5.

Figure 94. Historian Diagnostics tool -- Waiting for VOLDB restore

OPH070 143
Recovering the OPH Server runtime environment

4. Restore the Archive management records manually from the most recently archived
volume by using the OPH utility, OvhRecoUtilities.

Note
You must perform these steps using the OvhRecoUtilities program. Otherwise,
necessary archive management information will be missing.

a. From the Windows Start button, open ovhrecoutilities and click OK.

Figure 95. Opening the OvhRecoUtilities utility

b. The OvhRecoUtilities utility window appears. You will be prompted to enter a

function. Select 1 to recover archive volume database and resynchronize data.
Then, press Enter.
c. At the Enter volume database location prompt, press Enter to select the default
location (recommended).
d. If the default directory (for example, D:\OvHist\Data) does not exist, enter Y to
create this directory for volume database location. Then, press Enter.
e. To continue the restore from the last (most recently archived) volume, click Y and
press Enter.
f. At the Enter main storage log file name step, press Enter.
g. At the Enter function prompt, enter 0 and press Enter to exit the window.

144 OPH070
 Recovering the OPH Server runtime environment

Figure 96. OvhRecoUtilities utility window

Note
After the volume management records have been restored, the OPH Server
updates the storage log file to reflect the current storage pool content of the main
storage.

5. Return to the Historian Diagnostics tool. The tool now displays that the OPH Supervisor
and other processes status are Running.

Figure 97. Historian Diagnostics tool -- Running

OPH070 145
Recovering the main storage historical data

6. The OPH Server is now operational and will begin to collect and store new process data.
Archiving (if configured) will be functional.
7. The OPH Server is now ready for historical data recovery (see Recovering the main
storage historical data [146]).

Note
You need to download the remote scanner configuration from a remote network after
recovery of a standalone OPH Server from the loss of the OPH operating environment.

7.4 Recovering the main storage historical data

The OPH Server provides two features to back up historical data. The data recovery
approach for the main storage historical data depends on which features exist on your
system.

• Server redundancy [146].

• Historical data archival for a standalone OPH Server [148].

Note
Emerson does not support the use of SBR and other data backup technologies to
recover main storage historical data.

Note
If the failed or replaced storage device also caused the loss of the operating system
and/or OPH software (for example, internal RAID), the OPH runtime environment must
be restored before historical data can be recovered. See Recovering the OPH Server
runtime environment [138] for more information.

7.4.1 To recover the main storage for a redundant OPH Server

For redundant OPH Server configurations, historical data recovery is automatically initiated
after the following events:

• Replacement of the failed storage device

• Restoration of the runtime environment is completed (if lost from the failure)
• Restart of the historian.

The progress of the historical data recovery operation can be monitored through the
Historian Diagnostics window.

146 OPH070
 Recovering the main storage historical data

Figure 98. Historian Diagnostics tool – Recovery from partner status

During the historical data synchronization operation, the pair of OPH partners are able to
service data retrieval requests.

Note
A redundant OPH drop with an archive skips re-archival of recovered files for time ranges
that exist in the archive. This means that archiving of recovered files will occur only for those
files with an end time greater than the end time of the last archived file.

OPH070 147
Recovering the main storage historical data

7.4.2 To recover the main storage for a standalone OPH Server

For standalone OPH Servers with an archive, the main storage must be manually reloaded
from the historical data files in the archive by using the History Manager Reload function
(see Reloading data [283]). Standalone OPH Servers that do not have an archive do not have
the capability to backup and recover historical data.

During the reload from the archive, the OPH Server will handle requests for historical data
retrieval.

Note
If an archive exists, the archive volume database must be reestablished before historical
data can be recovered. See Post runtime software restore steps [141] for more information.

7.4.3 To recover the main storage in case of an external RAID

failure
Failure of the external RAID does not result in a loss of the OPH runtime environment.
Therefore, the OPH Server continues to operate and only historical data recovery is
required. Depending on the OPH Server configuration, backup data may be available from
the archive (removable DVD-RAM or fixed archive) or a redundant OPH partner.

Figure 99. External RAID failure

Use the following steps to recover an OPH Server (standalone) with an external RAID failure:

1. Access the Historian Diagnostics tool [510].

148 OPH070
 Recovering the fixed archive storage

2. When an external RAID fails, the OPH storage process reports a drop fault. The
Historian Diagnostics tool indicates the storage unit failure.

Figure 100. Historian Diagnostics tool -- storage unit failure

3. After you repair or replace the storage unit, reboot the machine. The OPH Server
returns to service.
4. Depending on OPH Server configuration, restore your historical data.
• See To recover the main storage in case of redundant OPH Server [146] for
redundant OPH Servers.
• See To recover the main storage in case of a standalone OPH Server [148] for
standalone OPH Servers with an archive.

7.5 Recovering the fixed archive storage

Failure of the archive (removable or fixed) results in a loss of backup (archived) historical
data. However, there is no loss of operating system, OPH environment, or the historical data
from the main storage.

OPH070 149
Recovering the fixed archive storage

Figure 101. Fixed archive failure

To protect historical data in a removable archive, you can replicate the DVD-RAM volumes
by using Windows Explorer. Each copy can be used interchangeably, and therefore, can be
considered a backup of the original. However, since a fixed archive is itself a storage device
that can fail, re-archival of existing historical data from the main storage can be used to
manage its data restoration (see To re-archive historical data from main storage [150]).

Note
You can protect and recover the fixed archive data by using features supported by the
storage device manufacturer. In this case, do not use the Ovation network as the backup
and restore data transport mechanism. When a fixed archive is restored in this manner, you
must reestablish the archive management records by using the OvhRecoUtilities option 1
(see Post runtime software restore steps [141]).

7.5.1 To re-archive historical data from main storage

In some cases, the main storage contains the same data as the archive. In other cases, the
main storage contains enough data to satisfy desired historical data coverage
requirements. Therefore, the following procedure will allow you to replenish the fixed
archive.

Use the following steps to recover a fixed archive storage by re-archival of main storage:

1. Repair or replace the storage unit (NAS).

150 OPH070
 Recovering the fixed archive storage

2. Remove or reset the archive volume database by using the OPH utility,
OvhRecoUtilities.
a. From the Windows Start button, open ovhrecoutilities and click OK.

Figure 102. Opening the OvhRecoUtilities utility

b. The OvhRecoUtilities utility window appears. You will be prompted to enter a

function. Select 2 to remove the archive volume database. Then, press Enter.
c. To confirm the removal of the volume database, enter Y and press Enter.
d. A confirmation message appears, stating that the volume database is removed
and all data is set to be unarchived.
e. At the Enter function prompt, enter 0 and press Enter to exit the window.

Figure 103. OvhRecoUtilities utility window

3. To start re-archival:
a. Open the History Manager window [265].
b. Run the Archive command.

OPH070 151
 Using the Network Attached Storage (NAS) unit

8 Configuring the NAS

Topics covered in this section:
• Using the Network Attached Storage (NAS) unit [153]
• Configuring the OPH NAS [153]

8.1 Using the Network Attached Storage (NAS) unit

Note
Emerson strongly recommends the use of an Emerson-standard network attached storage
(NAS) device for fixed archiving purposes.

If you have a NAS device that is dedicated to the OPH application, you must perform the
following tasks for proper operation:

1. Configure the NAS as per the manufacturer instructions. The NAS should be
reconfigured with an IP address and TCP/IP settings consistent with the configuration
of the Ovation network. This is typically accomplished by using a PC temporarily
configured with network settings to match the NAS’ default TCP/IP settings to
establish initial connectivity. Then, use a web browser to connect to the NAS’ default IP
address to configure the desired settings. These settings may vary slightly from model
to model but can typically include hostname, network settings (including TCP/IP
settings and NIC speed/duplex), NTP server address, access credentials, and share
configuration.
2. For configuring the NAS, see Configuring the OPH NAS [153].

8.2 Configuring the OPH NAS

The following steps provide an overview of configuring an OPH NAS. Refer to the specific
topics for detailed instructions.

1. Install hard drives [154]. If the hard drives have already been installed, skip this step.
2. Configure a PC and connect it to the NAS. [155].
3. Perform an initial OS load [161].
4. Log on for the first time and to set the IP address of the OPH NAS [169].
5. Access the OPH NAS main window [175].
6. Apply the applicable DSM Build [177].
7. Verify or determine Synology NAS model and version [181].
8. Create an OPH share [183].
9. Enable a guest account [186].

OPH070 153
Configuring the OPH NAS

10. Configure file services [189].

11. Enable HTTPS service [191].
12. Configure the NTP server [193].
13. Customize login and administrator's account background [195].

8.2.1 To install hard drives

Note
You may skip the procedure if the hard drives are already installed.

Use the following steps to install hard drives:

1. The NAS has four hard drives. The drive bays are numbered as follows, looking at the
front of the NAS. Start at bay 1.

1 2 3 4
5 6 7 8
9 10 11 12

2. Pull the handle on the hard drive in the direction as indicated below to remove the hard
drive tray.

Figure 104. Removing hard drive from NAS

3. Place the hard disk in the hard drive tray. Turn the tray upside down, and then tighten
the screws to secure the hard disk.

154 OPH070
 Configuring the OPH NAS

Figure 105. Loading the hard disk in the hard drive tray

1. Insert the loaded hard drive tray into the empty hard drive bay.

Figure 106. Inserting the loaded hard drive tray

2. Push the hard drive tray handle to secure the hard drive tray.
3. Repeat these steps to assemble all hard disks you have prepared.

8.2.2 To configure a PC and connect it to the NAS

Use the following steps to configure a PC and connect it to the NAS:

1. Log on to the PC using the appropriate credentials.

OPH070 155
Configuring the OPH NAS

2. From the Start menu, type or click Control Panel.

Figure 107. Control Panel option on the Start menu

3. The Control Panel window appears. Click Network and Sharing Center.
[empty]

Figure 108. Control Panel window

4. The Network and Sharing Center window appears. Click Change adapter settings.

Figure 109. Network and Sharing Center window

156 OPH070
 Configuring the OPH NAS

5. The Network Connections window appears. Right-click the network adapter and click
Properties.

Figure 110. Network Connections window

OPH070 157
Configuring the OPH NAS

6. The Local Area Connection Properties dialog box appears.

a. Select the Internet Protocol Version 4 (TCP/IPv4) check box.
b. Click Properties.

Figure 111. Local Area Connection Properties dialog box

7. The Internet Protocol Version 4 (TCP/IPv4) Properties dialog box appears. Note the
current settings.
8. Select the Obtain an IP address automatically and Obtain DNS server address
automatically options.

158 OPH070
 Configuring the OPH NAS

9. Click OK.

Figure 112. Internet Protocol Version 4 (TCP/IPv4) Properties dialog box

OPH070 159
Configuring the OPH NAS

10. Return to the Local Area Connection Properties dialog box. Click Close to save the
settings.

Figure 113. Local Area Connection Properties dialog box

11. Connect the PC to the NAS. Plug it into LAN 1 on the NAS. LAN 1 is the leftmost port of
item 13.
12. Connect power to the power ports (item 8).

Figure 114. NAS connections

13. Ensure that the NAS unit is powered on. If not, press the power button on the front of
the NAS.

160 OPH070
 Configuring the OPH NAS

8.2.3 To perform an initial OS load

Use the following steps to perform an initial OS load:

Note
The following procedures refers to the PC now connected to the NAS as the 'NAS PC.'

1. Insert the NAS disc into the NAS PC.

2. Run the program [Link] on the NAS disc. This file is located on the disc at the
following path:
\NAS\Synology\Assistant52\[Link]
3. The Web Assistant window appears. Click Set up.

Figure 115. Web Assistant Welcome window

OPH070 161
Configuring the OPH NAS

4. The Synology Assistant window appears and scans for any NAS it can see. If you have
configured your NAS PC properly, the NAS appears in the list of Synology servers. If it
does not appear, ensure that you have configured your NAS PC to have an auto-
configured IP address (see To configure NAS PC and connect to OPH NAS [155]). In
addition, wait for five to 10 minutes for NAS to appear. Note the IP address.

Figure 116. Synology Assistant window

5. Once you see a Rackstation in the list, right-click the Rackstation and click Install.

Figure 117. Right-click menu of the Rackstation

6. The Synology Assistant Setup wizard appears with the Welcome page. Click Browse.
7. Browse for the installation file. Use the following path: \NAS\Synology
\23824_2\synology_denverton_RS2418RP+.pat

162 OPH070
 Configuring the OPH NAS

8. Click Next to continue.

Figure 118. Specify the path of the installation file

OPH070 163
Configuring the OPH NAS

9. The Enter server information page appears. Perform the following steps:
a. Enter a password for the administrator's account, for example, Security.4u.
b. Confirm the password.
c. Enter a server name, for example, OPH_NAS.
d. Ensure that the Create a Synology Hybrid RAID (SHR) volume after installation
check box is selected.
e. Click Next.

Figure 119. Enter server information page

10. A Warning message appears. Click OK.

Figure 120. Warning message

164 OPH070
 Configuring the OPH NAS

11. The Setup Network page appears.

a. Ensure that the Use manual configuration (recommended) option is selected.
b. Set the IP address to what you noted in Step 4. Emerson uses this IP address for
loading the OS. Otherwise, the load will fail. Later, you will set the IP properly
[169].

Note
If an entry for the DNS Server is present, remove it.

c. Click Finish.

Figure 121. Setup Network page

OPH070 165
Configuring the OPH NAS

12. The Installation Progress page appears, showing installation in progress. The page
applies a check mark to every step that installs properly. If you fail at step 1 of the
installation process (Applying network settings), you may need to reboot the NAS by
holding the power button on the front of the NAS and starting again. Otherwise, the
system will automatically proceed to step 4 (Installing DSM). Wait for 10 minutes for
the hardware to restart.

Figure 122. Installation Progress page

166 OPH070
 Configuring the OPH NAS

Figure 123. Installation Progress page -- system is rebooting

OPH070 167
Configuring the OPH NAS

13. When the installation is complete, the following page appears. Click Close.

Figure 124. Installation complete

14. Return to the Synology Assistant window. Exit the window.

Figure 125. Synology Assistant window

168 OPH070
 Configuring the OPH NAS

8.2.4 To log on for the first time and to set the IP address of the
OPH NAS
Use the following steps to log on for the first time and to set the IP address of the OPH NAS:

1. On the NAS PC, open Internet Explorer.

2. Enter the temporary IP address of the NAS (see To perform an initial OS load [161]),
followed by :5000, in the address bar of the Internet Explorer. For example, enter the
following:
[Link]
3. The OPH NAS login window appears.
a. Enter admin as the user name and the password you configured during initial OS
load [161].
b. Click Sign in.

Figure 126. OPH NAS login window

OPH070 169
Configuring the OPH NAS

4. The DSM Update Settings window appears.

a. Select the Download DSM updates but let me choose whether to install them
option.
b. Set the time to Saturday at 2 AM. This is a non-issue since this system will not have
an Internet connection.
c. Click Finish to continue.

Figure 127. DSM Update Settings window

170 OPH070
 Configuring the OPH NAS

5. For the first login instance, the OPH NAS main window appears with pop-up tips. Click
anywhere in the browser to see the main options on the window.

Figure 128. Tip 1

Figure 129. Tip 2

Figure 130. Tip 3

6. The DSM Help window appears with a message dialog box.

a. Select the Do not automatically launch DSM Help at every logon check box.
b. Click OK.

Figure 131. DSM Help window

OPH070 171
Configuring the OPH NAS

7. Close the DSM Help window.

Figure 132. DSM Help window -- close

8. Click the Control Panel option on the OPH NAS main window.

Figure 133. Control Panel option

9. The Control Panel window appears. Click Network.

Figure 134. Control Panel window

172 OPH070
 Configuring the OPH NAS

10. The Control Panel window updates with the Network tab view.
a. Select the Network Interface tab.
b. Select LAN1.
c. Click Edit.

Figure 135. Network interface tab

OPH070 173
Configuring the OPH NAS

11. The Edit window appears. Select the IPv4 tab.

a. Select the Use manual configuration option.
b. Enter the IP address, subnet mask, and default gateway.
c. Select the Set as default gateway check box.

Figure 136. Edit window -- IPv4 tab

12. In the Edit window, select the IPv6 tab.

a. From the IPv6 setup drop-down list, change the setup field to Off.
b. Once the correct values are added, click OK.

Figure 137. Edit window -- IPv6 tab

174 OPH070
 Configuring the OPH NAS

13. A dialog box appears, stating that it is applying network settings.

Figure 138. Applying network settings dialog box

14. At this point, the IP address of the OPH NAS has changed. A failure to communicate
error appears.

Figure 139. Failure to communicate

15. Remove the connection between NAS PC and OPH NAS.

16. Connect the NAS PC back into the OPH switch.
17. Configure the NAS PC’s IP settings (see To configure NAS PC and connect to OPH NAS
[155]).
18. Connect the OPH NAS into the OPH switch.

8.2.5 To access the OPH NAS main window

Use the following steps to access the OPH NAS main window:

1. Once the NAS PC and NAS have been properly placed and the NAS PC has the correct IP
settings [169], open a web browser.
2. In the address bar, enter:
<PROTOCOL>://<IP ADDRESS>:<PORT NUMBER>
Where:
<PROTOCOL> is either http or https, depending on the current system configuration.
<IP ADDRESS> is the IP address of the OPH NAS.
<PORT NUMBER> is the port number that the NAS is configured to use.
Examples:
[Link]
OR
[Link]

OPH070 175
Configuring the OPH NAS

3. If you use the https protocol, a certificate warning message appears. Click Continue to
this website.

Figure 140. Certificate warning message

4. The login window appears. Enter the login credentials and click Sign in.

Figure 141. OPH NAS login window

176 OPH070
 Configuring the OPH NAS

5. The OPH NAS main window appears:

Figure 142. OPH NAS main window

8.2.6 To apply the applicable DSM Build

Use the following steps to apply the DSM build. See Using the Network Attached Storage
(NAS) unit [153] for build information.

1. Ensure that the NAS PC and OPH NAS are properly configured [155].
2. Ensure that the NAS PC has the correct IP settings [169].
3. Log on to the OPH NAS by using the IP address that you configured (see To log on for
the first time and to set the IP address of the OPH NAS [169]) using only the http
protocol (https has not been turned on yet).
4. If you are logging on for the first time after changing the IP address, the Control Panel
window appears. Click the Home button to go to the main Control Panel window.

Figure 143. Home button on the Control Panel window

OPH070 177
Configuring the OPH NAS

5. If the Control Panel window is not visible, click the Control Panel link from the OPH NAS
main window [175].

Figure 144. Control Panel link on the OPH NAS main window

6. The Control Panel window appears. Click Update & Restore.

Figure 145. Control Panel window -- Update & Restore

7. The Control Panel window updates with the Update & Restore tab view.
a. Select the DSM Update tab.
b. Click Manual DSM Update.

Figure 146. Update & Restore tab view

178 OPH070
 Configuring the OPH NAS

8. The Manual DSM Update dialog box appears.

a. Click Browse.
b. Locate the update \NAS\Synology\23824-
Update2\synology_denverton_rs2418rp+.pat.
c. Click Open to select the file.
d. Click OK.

Figure 147. Manual DSM Update dialog box

9. A confirmation message appears. Click Yes to begin the transfer of the update file and
the update process.

Figure 148. Confirmation message

OPH070 179
Configuring the OPH NAS

10. The update file is uploaded to the NAS. A progress indicator appears, showing the
update progress.

Figure 149. Update in progress

180 OPH070
 Configuring the OPH NAS

11. A rebooting screen appears. It will count down until the GUI attempts to access the
NAS, giving it time to update. The NAS reboots.

Figure 150. Rebooting screen

12. When the upgrade is complete, return to the login screen.

13. Log back on to the NAS.

8.2.7 To verify or determine Synology NAS model and version

Use the following steps to verify or determine Synology NAS model and version:

1. Access the OPH NAS main window [175].

2. Click Control Panel.

Figure 151. Control Panel link on the OPH NAS main window

OPH070 181
Configuring the OPH NAS

3. The Control Panel window appears. Click Info Center.

Figure 152. Control Panel link

4. The Control Panel window updates with the Info Center tab view.
a. Select the General tab.
b. Note the model name.
c. Note the DSM version for the software version.

Figure 153. Control Panel window -- Info Center tab view

5. Close the Control Panel window.

182 OPH070
 Configuring the OPH NAS

8.2.8 To create an OPH share

Use the following steps to create an OPH share on the OPH Synology NAS:

1. Access the OPH NAS main window [175].

2. Click Control Panel.

Figure 154. Control Panel link

3. The Control Panel window appears. Click Shared Folder.

Figure 155. Control Panel window - Shared Folder

OPH070 183
Configuring the OPH NAS

4. The Control Panel window updates with the Shared Folder tab view. From the Create
drop-down list, click Create.

Figure 156. Control Panel window -- Shared Folder tab view

184 OPH070
 Configuring the OPH NAS

5. The Create New Shared Folder window appears. Go to the General tab and perform the
following steps:
a. In the Name field, enter OPH.
b. In the Description field, enter a brief description, such as OPH archive.
c. Click OK.

Figure 157. Create New Shared Folder window

6. The Edit Shared Folder OPH window appears. Go to the Permissions tab and perform
the following steps:
a. In the Read/ Write column, place a check mark for both admin and guest.
b. Click OK.

Figure 158. Edit Shared Folder OPH window

OPH070 185
Configuring the OPH NAS

7. The OPH share appears on the Control Panel window (Shared Folder tab view).

Figure 159. Control Panel window (Shared Folder tab view) -- OPH share

8.2.9 To enable a guest account

A guest account allows Windows to log on to the OPH share [183] without a user name and
password. Use the following steps to enable a guest account:

1. Access the OPH NAS main window [175].

2. Click Control Panel.

Figure 160. Control Panel link

186 OPH070
 Configuring the OPH NAS

3. The Control Panel window appears. Click User.

Figure 161. Control Panel window

4. The Control Panel window updates with the User tab view.
a. Select guest.
b. Click Edit.

Figure 162. Control Panel window -- User tab view

OPH070 187
Configuring the OPH NAS

5. The guest window appears. Go to the Info tab and perform the following steps:
a. Clear the Disable this account check box.
b. Click OK.

Figure 163. Guest window

6. Return to the Control Panel window with the User tab view. The guest status now
appears as Normal.

Figure 164. User tab view - guest status updated to Normal

188 OPH070
 Configuring the OPH NAS

8.2.10 To configure file services

Use the following steps to configure file services:

1. Access the OPH NAS main window [175].

2. Click Control Panel.

Figure 165. Control Panel link

3. The Control Panel window appears. Click File Services.

Figure 166. Control Panel window

OPH070 189
Configuring the OPH NAS

4. The Control Panel window updates with the File Services tab view. Go to the
SMB/AFP/NFS tab and perform the following steps:
• In the SMB group of the window, ensure that the following options are selected::
• Enable SMB service
• Enable Transfer Log

Figure 167. SMB Service group

5. In the AFP group, ensure that the Enable AFP service check box is clear (not checked).

Figure 168. AFP Service group

6. In the NFS Service group, ensure that the Enable NFS option is selected.

190 OPH070
 Configuring the OPH NAS

7. Click Apply to save the settings.

Figure 169. NFS Service group

8. Close the Control Panel window.

8.2.11 To enable HTTPS service

Use the following steps to enable HTTPS service:

1. Access the OPH NAS main window [175].

2. Click Control Panel.

Figure 170. Control Panel link

3. The Control Panel window appears. Click Network.

Figure 171. Control Panel window

OPH070 191
Configuring the OPH NAS

4. The Control Panel window updates with the Network tab view. Go to the DSM Settings
tab.
a. Select the Automatically redirect HTTP connections to HTTPS, Enable HTTP/2, and
Enable HSTS check boxes.
b. Click Apply to save.

Figure 172. Network tab view

5. You will be redirected to the HTTPS page. Click Continue to this website (not
recommended).

Figure 173. HTTPS page

6. Return to the OPH NAS main window.

192 OPH070
 Configuring the OPH NAS

8.2.12 To configure the NTP server

Use the following steps to configure the NTP server:

1. Access the OPH NAS main window [175].

2. Click Control Panel.

Figure 174. Control Panel link

3. The Control Panel window appears. Click Advanced Mode.

Figure 175. Control Panel window

OPH070 193
Configuring the OPH NAS

4. The Control Panel window updates with the Advanced mode view. Click Regional
Options.

Figure 176. Control Panel window -- Advanced mode view

5. The Regional Options window appears. Go to the Time tab.

6. Ensure that the Synchronize with NTP server option is selected.
7. In the Time zone field, enter the time zone of the site, if known.
8. In the Server address field, enter the IP address of the NTP server.

194 OPH070
 Configuring the OPH NAS

9. Click Apply to save the settings.

Figure 177. Regional Options window

10. Close the window.

8.2.13 To customize login and administrator's account

background
Use the following steps to customize login and administrator's account background:

1. Access the OPH NAS main window [175].

2. Click Control Panel.

Figure 178. Control Panel link

OPH070 195
Configuring the OPH NAS

3. The Control Panel window appears. Click Theme.

Figure 179. Select Theme

196 OPH070
 Configuring the OPH NAS

4. The Control Panel displays the Login Style and Theme tabs. Perform the following
steps:s:
a. Enter a message, for example, OPH NAS, in the Login page title field.
b. Add a title appropriate for your company in the Welcome title field.
c. Add a message appropriate for your company in the Welcome message field.
d. Pick a style in the Template field. (For example purposes in this procedure, the
second one was chosen. See the following figure.)
e. Click Remove in the Background section. This step enables the color entry field.
Enter the Emerson color (#0F205F).
f. Click the + symbol in the Logo section.
The Select image window appears. Click the Upload link.

Figure 180. Select image window

g. Browse for the Ovation logo, which can be found on the NAS disc at the following
path: \NAS\Synology\Ovation_Logo.png
h. Click Upload and return to the Control Panel window Login Style tab.

OPH070 197
Configuring the OPH NAS

Figure 181. Login Style window

5. Click the Theme tab to select the theme, Light or Dark. Click Apply.

Figure 182. Select theme

6. Click OK and close the Control Panel window. The OPH NAS main window appears.

198 OPH070
 Configuring the OPH NAS

7. Click the human icon at the upper-right corner of the window, and then click Personal.

Figure 183. Human icon on the OPH NAS main window

8. The Personal window appears. Go to the Desktop tab and perform the following steps:
a. Ensure that the Customize color check box is selected.
b. Enter the following colors:
• Text color: #FFFFFF
• Background color: #0F205F
c. Ensure that the Customize wallpaper check box is clear.
d. Click OK.

Figure 184. Personal window

OPH070 199
 Report Manager overview

9 Using the Report Manager

Topics covered in this section:
• Report Manager overview [201]
• To access the Report Manager [204]
• To configure the Report Manager [206]
• To configure printers that your Report Manager can use [214]
• To configure historians that your Report Manager can use [214]
• To configure work shifts in the Report Manager [216]
• To configure reports storage [216]
• To use report formatting [218]
• Report format templates supplied with OPH installation package [218]
• To use report definitions [221]
• Report generating tasks [234]
• Timed, demand, and triggered events [238]
• How the report start time is computed based on various event trigger settings [249]
• Report Manager administrative tasks [251]
• To create reports of edited historical data [257]
• To exit the Report Manager [259]

9.1 Report Manager overview

You can use the Report Manager to schedule and generate customized reports that display
historical data from the historian database.

Before you can use the Report Manager, you must:

• Configure the Report Manager [206].

• Configure printers that your Report Manager can use [214].
• Configure historians that your Report Manager can use [214].
• Configure work shifts in the Report Manager [216].

You can use the Report Manager to perform the following tasks:

• Generate timed, triggered, or on-demand reports.

• Configure report formats and definitions.
• Schedule reports.
• Generate reports (either timed, triggered, or on-demand).
• Track the status of report generation.

In addition, you can track changes made to the OPH Report Manager configuration and
OPH report definitions.

OPH070 201
Report Manager overview

You can direct your report output to a system printer, an e-mail address, a file, or a Web
server.

Historian reports are built and executed using the Business Objects Crystal Reports
product. Refer to the Crystal Reports User Manual for complete information about Crystal
Reports. See Crystal Reports tasks [491] for a brief summary of the most frequently used
Crystal Reports functions.

A complete library of fully functional report layout files (.rpt) is provided with the Report
Manager for your convenience (see Sample Reports [599]). If you require a report layout
that is not included in the library, you can use one of the existing files as a template, and add
your own modifications.

The following table describes two different methods that you can use to run reports.

Table 27. Methods to run reports

Method Details
Direct Use this method to access data directly from the historian database in its original
Reports [599] storage form with no pre-processing. You must perform any modifications that you
need in the report layout file using formulas, functions, and report design
techniques. The standard report library contains (point data and message text)
reports that you can use as templates for new or modified reports. Report designs
using this method can take longer to complete and can be more complex.

The Report Manager includes a selection of standard direct reports layout files that
are designed to address most of your reporting needs.
ExpressCalc This method uses a report pre-processor to collect and process data from the
Reports [622] historian database based upon configurations that you define in the Report
Manager. The pre-processor output is stored in the report results database, which is
available to any report designer. This method minimizes the need for any data
processing inside the report layout file. Reports can be designed and completed
quickly by using drag and drop. The standard report library contains templates that
you can use to generate reports quickly and easily.

The historian includes ExpressCalc report file templates.

Unless otherwise specified, all information provided in the following sections applies to
both reporting methods.

9.1.1 What is the Ovation Process Historian Report Service?

The Ovation Process Historian Report Service enables the report generation component of
the Report Manager to run as a separate service. The service allows timed [238] and
triggered [244] report generation and automated SOE [206] report execution to continue
without requiring a user to be logged into the workstation. You can view this service under
the Services [518] tab of the Historian Diagnostics window [518].

202 OPH070
 Report Manager overview

Note
Report Definitions [221], Timed Events [238], and Trigger Events [244] created by any user
are available to all other users that have an access to a particular Report Manager
installation. In other words, although multiple users can configure and initiate reports,
there is no concept of separate reports and configuration per user. The administrator must
assign administrative rights to such users by using the Manage Admin Users option of the
Report Manager. For more information about setting the administrative rights, see To set
administrative rights in the Report Manager [253].

9.1.2 What are the Report Manager features that administrator

users are authorized to use?
An administrator (a user with administrator credentials) is authorized to use the following
features of the Report Manager:

• Import data.
• Backup data.
• Manage admin users.
• Configure the Report Manager, except the following parameter in the Advanced tab of
the Configuration dialog box [206]:
◦ Set TIME input mode to Standard Time (Default is Local Time)
• View report storage and historian configuration.
• Create, modify, or delete events, report definitions, and report formats.
• Export the entire database via the Export icon in the toolbar.

9.1.3 What are the Report Manager features that non-

administrator users are authorized to use?
A non-administrator user (a user other than an administrator) is authorized to use the
following features of the Report Manager:

• View the Report Manager configuration. Modify the following parameter in the
Advanced tab of the Configuration dialog box [206]:
◦ Set TIME input mode to Standard Time (Default is Local Time).
• View the shift time intervals.
• Save the contents of the main pane to a file.
• View report definitions and formats.
• View event definitions.
• Generate reports.

OPH070 203
To access the Report Manager

9.2 To access the Report Manager

The Report Service [202] starts automatically, but you must start the Report Manager as
follows:

Start -> Programs -> Ovation Process Historian -> Report Manager

The main display of the Report Manager is the Report Generation Queue display.

Figure 185. Report Generation Queue display

The Report Generation Queue is a table in the Report Manager configuration database. The
queue is updated constantly. Records are deleted from the queue after one week.

Each event in the Report Generation Queue is represented with an icon that displays the
event's status.

Table 28. Event status

Icon Event status

Active

Canceled

Complete

204 OPH070
 To access the Report Manager

Icon Event status

Error

Pending

Triggered

The Report Generation queue columns display the following information for each report:

• Event name.
• Report name.
• Execution status.
• Execution date.
• Report output destination.
• Destination information.
• Report file name.
• Report file path.
• Creation date.
• Start date.
• End date.
• Historian server.

9.2.1 Report Manager toolbar options

The Report Manager toolbar contains shortcuts to help you generate, manage, and organize
your reports (the options on the toolbar differ on different tasks in the Report Manager).

Figure 186. Report Manager toolbar

The icons in the Report Manager toolbar enable you to perform the following actions.

Table 29. Icons in the Report Manager toolbar

Icon Description
Shows or hides the left menu bar.

OPH070 205
To configure the Report Manager

Icon Description
Configures the Report Manager.

Adds a new format.

Opens a format definition.

Deletes the selected record.

Refreshes the current view from database.

Finds a string.

Stops scheduling reports.

Starts scheduling reports.

Stops generating reports.

Starts generating reports.

Exports data.

Imports data.

Opens the Help topics.

9.3 To configure the Report Manager

Use the following steps to configure the Report Manager:

1. Access the Report Manager [204].

206 OPH070
 To configure the Report Manager

2. Choose File -> Configure Report Manager. The Configuration dialog box appears. This
dialog box contains five tabs:
• General
• SOE
• Triggers
• Advanced
• SMTP

Figure 187. General tab in the Configuration dialog box

Figure 188. SOE tab in the Configuration dialog box

OPH070 207
To configure the Report Manager

Figure 189. Triggers tab in the Configuration dialog box

208 OPH070
 To configure the Report Manager

Figure 190. Advanced tab in the Configuration dialog box

OPH070 209
To configure the Report Manager

Figure 191. SMTP tab in the Configuration dialog box

3. Make your changes in each tab and click OK to accept the changes.

The following table describes the options available in these tabs.

Table 30. Options available in the tabs of the Configuration dialog box

Item Description Setting options

General tab
Scheduler Defines the time period between record processing by the Number of
Interval scheduler. minutes > 0
Generator Defines the time period between record processing by the Number of
Interval generator. minutes > 0
Default Time Selects the time zone in which the Report Manager operates. Local, Eastern,
Zone Central,
Mountain, Pacific,
or GMT
Point Browse Selects the historian to be used when browsing points. Pull-down menu
Server
Historian Server Selects the historian to be used for data reports. Pull-down menu

Note
The default selection automatically selects the historian that
has the best available data (for ExpressCalc).

Enable Scheduler Enables the Scheduler. Check box

Enable Generator Enables the Generator. Check box
SOE tab

210 OPH070
 To configure the Report Manager

Item Description Setting options

Last SOE Identifies the date and time of the last SOE message Date and time
Processed processed.
Max SOE Hold Defines the maximum time period to hold SOE messages Number of
Time before printing. seconds
Max SOE Hold Defines the maximum SOE message count to hold before Number of
Count printing. messages
Report Definition Identifies the report definition used to generate the SOE Pull-down menu
report.
Enable Enables or disables the automatic SOE report generation. Check box
Triggers tab
Default Trigger Selects the default trigger value for use when defining new 0,1, or CHANGE IN
Value triggers. STATE
Default Start Selects the default for the amount of time (prior to trigger) Number of hours,
Time offset from that will be included in the report. minutes, and
Trigger time seconds
(hh:mm:ss)
Default End Time Selects the default for the amount of time (after the trigger) Number of hours,
offset from that will be included in the report. minutes, and
Trigger time seconds
(hh:mm:ss)
Default Time to Selects the default time to wait between processing the Number of hours,
wait before occurrence of the same trigger. minutes, and
Trigger Event is seconds
processed again (hh:mm:ss)
Enable Scan for Enables or disables the scan for all triggers. Check box
all Triggers
Advanced tab
Mark Edited data Enables or disables the marking that shows which data on Check box
on report the report was edited.
Data Retrieval Selects which type of edited data you want to include on Radio buttons:
Mode for Edited your report: original values (unedited), latest values (most
data recently edited), or all values. • Get Original
Value

Note • Get Latest

Value
An ExpressCalc report interprets the “Get All Values”
• Get All Values
settings the same as “Get Latest Value.” The report uses
computations, such as averages, integrations, and so on,
derived from the stored sample values – which by its nature
requires only one set of values, original or last edited, for the
computation results.

Show Enables or disables annotations made to historical data to be Check box

Annotations on displayed on your report.
report

OPH070 211
To configure the Report Manager

Item Description Setting options

Enable Reports Enables or disables you to save report output files as Check box
storage to historical files on the historian, which can then be archived
Historian Server and managed like other historical data.
Set TIME input Enables or disables you to specify the default time format of Check box
mode to the generated report windows. For example, you can select
Standard Time standard time to avoid confusions involving local time
(Default is Local during daylight savings.
Time)
Use Locale Date Enables or disables you to specify the locale date format in Check box
Format In reports.
Reports
By default, the date format in reports is mm/dd/yyyy. If the
computer is configured for a different date format (e.g., dd-
mm-yyyy) and this option is selected, the UFL formulae
gmtConvertGetDTDisplay and gmtConvertGetDTDisplayEx
use the locale's short date format specifier for the date field.
Default Text Lines Enables you to specify default text lines per page. Number of lines
Per Page per page
This field identifies how many lines will be placed on a page
when the report output definition is a .TXT file. 0 means all
lines on one page.
Default Text Enables you to specify default text characters per inch. Number of text
Characters Per characters per
Inch This field identifies how many characters will be displayed in inch
one inch when the report output definition is a .TXT file.
CSV Header/ Enables you to specify the format of CSV header/footer. Drop-down list
Footer Format with the following
The field controls how often each report page and group options:
header/footer pair are output when the report output
definition is a CSV file. This field provides the following three • Each Record
choices:
• Once
• Never: Indicates that each report page and group • Never
header/footer pair are never output.
• Once: Indicates that the page header is output once
before the detail records, the group header is output
once before each group, the group footer is output once
after each group, and the page footer is output once
after all the detail records.
• Each Report: Indicates that the page and group headers
and footers surround each record in the details section.
CSV Separator Enables you to specify the character that will be output Single character
between each field when the report output definition is a field
CSV file.

212 OPH070
 To configure the Report Manager

Item Description Setting options

Audit Server Specifies the audit server historian for tracking changes Drop-down list of
made to the OPH Report Manager configuration and OPH historians.
report definitions. If you do not want to track changes,
select the blank row from the drop-down list.

Note
Set the Message Type parameter as RPTAUDIT in the Report
Properties window to report changes. See Message-based
reports [227] for more information.

Use this option to track the following changes made to the

OPH Report Manager configuration:

• Modification of Report Manager configuration in

General, SOE, Triggers, Advanced, and SMTP tabs
• Modification of the configured historians
• Modification of shift time interval definitions
• Modification of Report Storage configuration
parameters
• Modification to the administrative user list
• Import of a configuration
• Addition, deletion, and update to timed, trigger, and
demand event definitions
Use this option to track the following changes made to
the OPH report definitions:
• Addition, deletion, and renaming of report template
files
• Addition, deletion, and renaming of report template
files
• Changes to the report definition configuration
If there is a loss of communication between the Report
Manager drop and the specified audit server historian,
the audit messages are buffered in a file. When the
connection is re-established, the messages are sent at
the first time an audit message is generated following
the communication restoration, or at the start of the
Report Manager.

Note
Using this option, you cannot track changes to Report
Template files created by using the SAP Crystal Reports
Report Designer application.

SMTP tab
Server Indicates the SMTP e-mail server address. Text box
Port Indicates the required port number of the e-mail server. Text box

OPH070 213
To configure printers that your Report Manager can use

Item Description Setting options

Username Indicates the e-mail account that will send the report file. Text box
Password Indicates the password for the e-mail account. Text box
Enable SSL Activates Secure Socket Layer (SSL) if required by the e-mail Check box
system.

9.4 To configure printers that your Report Manager

can use
The service component of the Report Manager, by default, does not have access to
printer(s) installed on the system. To generate timed, triggered, or automated SOE reports
whose destination is a printer, the Windows registry must first be configured to give
the .DEFAULT user access to the printer(s). The Ovation Process Historian provides a utility
to perform this configuration:

%OVH_HOME%\bin\[Link]

The program, by default, takes no arguments but must be run by the administrator that has
initially added the printer(s). If additional printers are added in the future, the program
must be run again by the administrator that has added the printer(s) before they can be
used by the Report Manager service [202]. This program configures both local and network
printers.

9.5 To configure historians that your Report Manager

can use
Note
If you configure your historian information from the Ovation Developer Studio, you do not
need to perform this task. Use this task if you install the Report Manager on a non-Ovation
workstation.

Use the following steps to configure historians that your Report Manager can use:

1. Access the Report Manager [204].

214 OPH070
 To configure historians that your Report Manager can use

2. Select File -> Configure Historians. The Configure Historians window appears:

Figure 192. Configure Historians window

3. Enter the IP addresses and host names for each of the historians that you want the
Report Manager to use.
4. Click Edit if you want to change the IP address, host name, partner host name, or
partner IP address. The Host Name and IP Address window appears:

Figure 193. Host Name and IP Address window

5. Click OK to save your new host name and IP information.

6. Select OK to save your settings, or Cancel to exit.

OPH070 215
To configure work shifts in the Report Manager

9.6 To configure work shifts in the Report Manager

Note
By default, the Report Manager supports three shifts, each of which is eight hours in length.
You can change these shift times, or disable shift tracking completely. If a timed event is
generated by shift, you can calculate the next event due date time by using the Shift
Configuration Dialog.

Use the following steps to configure work shifts in the Report Manager:

1. Access the Report Manager [204].

2. Select File -> Configure Shift Time Intervals. The Shift Configuration Dialog window
appears:

Figure 194. Shift Configuration Dialog window

3. All fields are configurable. You can add, delete, or modify the shift properties. The
following table describes the setting options available in the Shift Configuration Dialog
window.

Table 31. Options available in the Shift Configuration Dialog window

Item Description
RefShiftID ID number that refers to the shift.
ShiftName Name of the shift.
ShiftEnd Time that the shift ends.
* You can add a new shift in this field.

4. Select Close to save your changes.

9.7 To configure reports storage

Use the following steps to configure reports storage:

1. Access the Report Manager [204].

216 OPH070
 To configure reports storage

2. Select File -> Configure Reports Storage. The Reports Storage Management window
appears:

Figure 195. Reports Storage Management window

This window enables you to generate multiple, individually named report output files.
In addition, the window manages the disk space consumed by those report output
files. You can use this window to perform the following tasks:
• Select a file location.
• Choose to uniquely name report output files with the date and time or by a
sequence number.
• Select space management settings.
• Limit the number of files you want to add to a directory.
If you execute a report whose output will be stored to a file in this directory, or any of
its child directories, it uses the settings that you choose in this window.
3. Select OK to save your changes.

OPH070 217
To use report formatting

9.8 To use report formatting

Use the following steps to format a report:

1. Access the Report Manager [204].

2. Select Report Formats from the left-hand window. The Report Formats window
appears. Select the standard report templates or custom report layout files that you
want to use for your reports.

Figure 196. Report Formats window

3. Use the plus sign icon in the Report Manager toolbar [205] to add a report format. To
remove an existing report format, right-click the format and click Delete.

9.9 Report format templates supplied with OPH

installation package
The Ovation Process Historian installation package provides a set of Report Format (Crystal
Report RPT) files that are used to specify the layout of report content when generated by
the Ovation Report Manager. These Report Formats may be used as is, or modified by using
the SAP Crystal Reports 2016 application to serve as a basis for custom reports. The report
formats can be categorized in the following groups:

• Message report formats [219].

• Point report formats [220].

Note
Emerson-supplied report format templates are examples of report format usage. These
templates may be modified in a future release. If you want to avoid future changes,
create a copy of the sample templates and use them later as your own version.

218 OPH070
 Report format templates supplied with OPH installation package

9.9.1 Message report formats

The Ovation Process Historian installation kit provides the following message report
formats, which appear under the OvHist\Reports\MsgReports folder at the database server.

Table 32. Message report formats

Message report Description

format
Alarm [Link] Each message is formatted separately in consecutive sections of the report.
The individual fields are prefixed with the field name in each message. The
SOE [Link]
orientation of the report is portrait.
Text [Link]
Alarm Messages- These formats are exactly the same as the preceding formats, except that the
[Link] orientation is landscape.
SOE Messages-
[Link]
Text Messages-
[Link]
Alarm Messages- These formats contain a header line with the field names, followed by
[Link] message content where the fields are aligned in columns as indicated by the
header line. They are more concise than the preceding formats.
SOE Messages-
[Link]
Text Messages-
[Link]
Alarm Messages- These formats are exactly the same as the preceding formats, except that the
[Link] orientation is landscape.
SOE Messages-Brief-
[Link]
Text Messages-Brief-
[Link]
Alarm Messages This format displays an Alarm review, exactly as the historical review window
[Link] with all columns, except Quality and Code.
Alarm Messages This format displays an Alarm review, exactly as the historical review window
Review [Link] with all columns, including Quality and Code.
SOE Messages This format displays an SOE review, exactly as the historical review window
Review [Link] with all columns.
Text Messages This format displays information about text messages, including timestamp,
[Link] user name, message types, and subtypes, along with a reason.
Text Messages This format displays information about text messages, including timestamp,
[Link] user name, message types, and subtypes, along with a message text.

OPH070 219
Report format templates supplied with OPH installation package

Message report Description

format
Report Manager This format displays information about the changes made to the OPH Report
[Link] Manager configuration and report definitions.

Note
The Reference ID field, which appears on the supplied Report Audit template,
can be used to visually group report audit entries together for entries related
to changes to report definitions, report formats, timed events, triggered
events, and demand events. When one of these entities is created, a non-zero
Reference ID is assigned and associated with the create audit message.
Subsequent updates to that same item result in audit messages containing
the same Reference ID. The Reference ID is not unique and represents the
internal Report Manager ID for the entity. This ID is reused if an entity is
deleted and is not unique across entity types.

Operator Event This format displays information from operator event messages, including
Messages- timestamp, message types and subtypes, and operator event-specific fields
[Link] message, point_name, description, new value, and previous value.

Note
This format is intended to display operator events only, so the report
definition using this format should define the Message Type as OPEVENT in
the Additional Msg Filters panel.

9.9.2 Point report formats

The Ovation Process Historian installation kit provides the following point report formats,
which appear under the OvHist\Reports\PtReports folder at the database server.

Table 33. Point report formats

Point report format Description

Raw Value [Link] This report formats raw point sample values and statuses. Values are
displayed in standard notation.
Raw Value Report This report formats raw point sample values and statuses where the
[Link] value is displayed in standard, exponential, or technical notation
according to the FM field content of the point.
Raw Value Report - This report formats raw point sample values and statuses, and includes
[Link] a set of point attributes values for each point. Values are displayed in
standard notation.
Raw Value Report - This report formats raw point sample values and statuses and includes a
Attributes [Link] set of point attributes values for each point. Values are displayed in
standard, exponential, or technical notation according to the FM field
content of the point.
ExpressCalc 12 point This report formats up to 12 processed point values and their
[Link] summaries in landscape orientation. Values and summaries are
displayed in standard notation.

220 OPH070
 To use report definitions

Point report format Description

ExpressCalc 12 point This format is similar to ExpressCalc 12 point Landscape, except that it is
[Link] larger in size and allows the description and units fields to grow, if
necessary.
ExpressCalc 12 point This report formats up to 12 processed point values and their
Landscape [Link] summaries in landscape orientation. Values and summaries are
displayed in standard, exponential, or technical notation according to
the FM field content of the point.
ExpressCalc 8 [Link] This report formats up to 8 processed point values and their summaries
in portrait orientation. Values and summaries are displayed in standard
notation.
ExpressCalc 8 point This report formats up to 8 processed point values and their summaries
[Link] in portrait orientation. Values and summaries are displayed in standard,
exponential, or technical notation according to the FM field content of
the point.
ExpressCalc 8 point This format is similar to Express Calc 8 point ExNot, except that it has
[Link] landscape orientation and allows the description and units fields to
grow, if necessary.
ExpressCalc 80 point - This report formats up to 80 processed point values in a layout suitable
[Link] for export to an Excel spreadsheet. The data is displayed according to
the UTC time zone.
ExpressCalc 80 point (local This report formats up to 80 processed point values in a layout suitable
time) - [Link] for export to an Excel spreadsheet. The data is displayed according to
the local time zone.
ExpressCalc Basic 12 point These reports format processed values in a basic layout for up to 8, 12,
[Link] and 80 points, respectively. The 8-point version is portrait orientation,
while the 12- and 80-point versions are landscape.
ExpressCalc Basic 8
[Link]

ExpressCalc Basic 80 point

[Link]
ExpressCalc CT 48 These reports format processed point values in a cross-tab layout.
[Link]

ExpressCalc CT 80
[Link]
ExpressCalc CT Multi-Point This cross-tab report supports more than 80 points and whose values
As [Link] are formatted as numbers.
ExpressCalc CT Multi-Point This cross-tab report supports more than 80 points and whose values
As [Link] are formatted as text fields.
ExpressCalc Sub Report This report format is an example of a report that contains sub-reports.
[Link] Sub-reports must be used when the number of points exceeds 80. Each
sub-report can contain up to and including 80 points.

9.10 To use report definitions

Before you can generate reports, you must define the properties for your report definition,
and define the reports that you want to generate.

OPH070 221
To use report definitions

9.10.1 To define or edit properties for report definitions in the

Report Manager
Use the following steps to define or edit properties for report definitions in the Report
Manager:

1. Access the Report Manager [204].

2. Select Report Definitions from the left-hand window. The Report Definitions
information appears:

Figure 197. Report Definitions information

222 OPH070
 To use report definitions

3. If you want to add a new report definition, access the Add Report Definition shortcut
icon on the Report Manager toolbar [205]. Choose Point-ExpressCalc, Point-Direct,
Alarm, SOE, or Text from the Filter Criteria section.
If you want to edit an existing report definition, double-click on a report definition. The
Report Properties window appears (the fields in this window vary depending on the
type of report that you have selected).

Figure 198. Report properties window

4. Specify the properties for your report definition. You can rename and modify most of
the properties.
5. Enter a unique name for your report in the Report Name field.
6. Choose one of the report format types from the Report Format drop-down menu.

OPH070 223
To use report definitions

7. Use the Report Destination drop-down list to select where you want the report to go.
The list contains the following report destination options:
• Window: The generated report displays in a window on your screen.

Note
The Window option is only valid for manually requested (demand) reports. The
option is not supported for event-driven reports, which include timed, periodic,
and auto-SOE reports. Execution of event-driven report definitions that are
configured with this option results in an error listed in the Report Generation Log
of the Report Manager.

• Printer: The generated report is sent to the printer that you specify by using the
adjacent Select Printer button.
• File: If you select File, click the adjacent Select File button to choose an output file
name and type. The available file types are as follows:
◦ Text file (.txt)
◦ Microsoft Word files (.doc)
◦ HTML files (.htm or .html)
◦ CSV files (.csv)
◦ Excel files (.xls or .xlsx)
◦ RTF files (.rtf)
◦ PDF files (.pdf)
• Email: The generated report is sent through an e-mail to the address that you
specify by using the adjacent Select Mail button.
• File at Historian: The generated report is saved and archived with the rest of your
historical data.
8. The Destination Info field is populated with your choice.
9. You can enter information in the Header 1 area of your report (for example, a report
title) and Header 2 area of your report (for example, a subtitle or other information).
The WhereClause field is automatically generated with the properties that you have
selected. You can edit this clause, but it is not recommended.
10. An Include Initial Value on Report check box is shown on the Report Properties window
for a Raw Value report. Checking this box guarantees a value at the start time of
interval.
11. Enter the format that you want to use for the report's time period in the Time Format
field (Hour:Min:Sec, Day, Month, or Shift).
12. Enter the time period for your report in the Time Period field.

224 OPH070
 To use report definitions

13. Set the points that you want to use to generate your report.
• You can specify up to 80 points to use in your report in the Point List field.
• The Seq field displays the position of each point within your report.
• Rearrange the point names in the point list by clicking the Up or Down buttons.
You might want to arrange your point names in a specific order for some reports.
• Use the Add button to add a single point. If you want to add multiple points, use
the Browse Points button.
• Use the Modify button to modify point names.
• Use the > button to remove a highlighted point name from your list.
• Use the >> button to remove multiple point names from your list.
14. Select OK, Delete, or Cancel to finish defining your report definition properties.

OPH070 225
To use report definitions

15. If you want to define additional report properties, use the Advanced button. The
Advanced Report Properties window appears:

Figure 199. Advanced Report Properties window

Table 34. Advanced Report Properties description

Field Description Setting options

Adjust the start Enables you to automatically select a start time None
time to when a report is demanded.
start of year

start of month

start of week

start of day

start of shift

start of hour
Additional Offset Enables you to add or subtract from the offset. Months, Days, Hours,
Minutes, Seconds
Do not allow the Enables you to set limits on report generation. Years, Months, Days,
report Hours, Minutes,
generation to Seconds
exceed following
time period.
Text Lines/Page Enables you to specify the number of lines per page Numeral values
in the generated text file output.

226 OPH070
 To use report definitions

Field Description Setting options

Text Characters/ Enables you to specify the number of characters per Numeral values
Inch inch in the generated text file output. The default
value of this field is set to 15.
CSV Header/ Enables you to specify the format of CSV header/ Drop-down list with
Footer Format footer. the following
options:
The field controls how often each report page and
group header/footer pair are output when the report • Each Record
output definition is a CSV file. This field provides the
• Once
following three choices:
• Never
• Never: Indicates that each report page and
group header/footer pair are never output.
• Once: Indicates that the page header is output
once before the detail records, the group
header is output once before each group, the
group footer is output once after each group,
and the page footer is output once after all the
detail records.
• Each Report: Indicates that the page and group
headers and footers surround each record in the
details section.
CSV Separator Enables you to specify the character that will be Single character field
output between each field when the report output
definition is a CSV file.

16. Click OK to save your settings, or Cancel to exit.

Note
If a report definition contains process values that are larger than the space configured
for that field in the generated report, it will not display the complete value (that is, the
report displays the values as truncated or merged with other fields). In cases where a
field is not large enough to output desired values, it is recommended that you adjust
the field width by using the SAP Crystal Reports Report Designer application.

Depending on the type of report format that you selected, you might need to specify
further properties. The format types that require you to make additional specifications are
message-based reports [227] and ExpressCalc reports [231].

9.10.2 Message-based reports

Use the following steps to generate message-based reports:

OPH070 227
To use report definitions

1. If you selected a message-based report format, such as Alarm, SOE, or Text, from the
Report Formats [218] window for your report definition, the Report Properties window
appears:

Figure 200. Report Properties window

2. If you do not know the scanner number you want to enter for the Message Source field,
you can click the arrow button to browse. The Scanner browsing window appears:

Figure 201. Scanner browse window

3. Select your scanner and click OK.

228 OPH070
 To use report definitions

The other options on the Report Properties window are same as the previous Report
Properties window, except for the Additional Message Filters options and the Primary Text
field Search String.

Table 35. Report Properties window options

Option Description Setting options

Message Type Use filtering messages to Alphanumeric entry
further define the amount of
Message Sub type return on your report. Numeric entry

Message Source Numeric entry, or Browse

Source System Numeric entry

Source Node Numeric entry

Note
to report changes made to the OPH Report
Manager configuration and OPH report
[Link] the Message Type
parameter to

Primary Text Field Additional filter that allows Alphanumeric entry

Search String you to further define the
amount of data on your
report. For example, Cosine.

There are also some additional filters for alarm messages if you select an alarm-based
report.

Table 36. Additional filters

Msg Message Type Message Subtype Message Source Source

Type Source System Node
Alarm Alarm Message 0 - No Entry Scanner ID Unit # Drop #
Types are
described in 1 - New Alarm
detail in the
2 - Return
Ovation
Operator 3 - Incremental Alarm
Station User
Guide. 4 - Status Change

5 - Timed Out Drop

6 - Spurious Alarm

7 - Suppressed Alarm

8 - Acknowledged Alarm

9 - Released Alarm
SOE Not applicable Not applicable Scanner ID Unit # Drop #

OPH070 229
To use report definitions

Msg Message Type Message Subtype Message Source Source

Type Source System Node
Text SYSTEM OPEVENT message subtypes are Scanner ID Unit # Drop #
defined in the following table.
OPEVENT

Operator events
The following message subtypes originate in the Ovation system, and describe operator
events.

Table 37. Operator events description

Subtype number Operator event category type

100 Mode Change
120 Setpoint Change
121 Output Change
164 Status Check State Change
180 LS Print Cancellation
200 Scan Off
201 Scan On
202 Alarm Check Removal
203 Alarm Check Restoration
204 Limit Check Removal
205 Limit Check Restoration
206 Value Enter
207 High Limit Change
208 Low Limit Change
209 Incremental Change
210 Alarm Deadband Change
211 All Force Bits Clear
212 All Force Bits Set
218 Automatic Cutout Disabled
219 Automatic Cutout Enabled
231 MMI Logon/Logoff
240 Point Field Change
241 All Trend Events
252 Group Pt Force Clear
253 Group Pt Force
254 Set Force Group Pt
144 Value Clamp On

230 OPH070
 To use report definitions

Subtype number Operator event category type

145 Value Clamp Off
146 Engineering Range Checking On
147 Engineering Range Checking Off
148 Reasonability Range Checking On
149 Reasonability Range Checking Off
152 Test Mode Good
153 Test Mode Fair
154 Test Mode Poor
155 Test Mode Bad
156 Test Mode Static
157 Test Mode Off
158 Removed From Service
159 Restored To Service

9.10.3 ExpressCalc reports

If you selected a Point-ExpressCalc report format from the Report Formats window [218],
the Report Properties - ExpressCalc window appears:

Figure 202. ExpressCalc window

The options for the Report Properties - ExpressCalc window are same as the options for the
previous Report Properties window, except for the following.

OPH070 231
To use report definitions

Table 38. Options in the Report Properties - ExpressCalc window

Field Description Setting options

Sample Interval Identifies the sample time format required by the pre- Hour:Min:Sec, or Day
Time Format processor to generate the requested number of samples
for the report. or

No. of intervals
Sample Interval Quantifies the sample time or interval count required by
Time Value the pre-processor to generate the requested number of
samples for the report. Corresponds to the selected
Sample Interval Time Format.

232 OPH070
 To use report definitions

Field Description Setting options

Processing Defines the processing type required by the pre- Actual
Type processor to generate the desired sampling results.
Required for each point in the point list. Raw

Actual Bit

Time Average

Maximum Value

Minimum Value

Time of Maximum

Time of Minimum

Integration

Toggle

Toggle Set

Toggle Reset

Time Set

Time Reset

Average

Total

Count

Start Value

End Value

Delta

Range

Percent Bad

Percent Good

Duration Bad

Duration Good

Standard Deviation

Variance

Average Rate of Change

Bit Number Defines the bit number in a packed digital point required 0 - 31
by the pre-processor to generate the desired sample
results. This is used with the Actual Bit processing type.

OPH070 233
Report generating tasks

Field Description Setting options

Integral Value required by the pre-processor to perform Floating point
Constant integration on the selected point in the point list. Active
only when Processing type is set to integration.

9.11 Report generating tasks

After you have defined the properties for your report definition, the next step is to define
the reports that you want to generate, and then generate them. You can generate reports
manually or set them to be generated from the occurrence of a timed, triggered, or
demand event.

9.11.1 To manually generate reports in the Report Manager

Use the following steps to manually generate reports in the Report Manager:

1. Access the Report Manager [204].

2. Select Report Definitions.
3. Select the report that you want to generate.
4. Use the generate icon from the toolbar [205].
You can also generate a report by right-clicking a report and click Generate Report. A
Generate <Report Definition Name> dialog box appears:

Figure 203. Generate dialog box

234 OPH070
 Report generating tasks

5. Use the Set option to specify a time span. Choose one of the options from the pop-up
menu. To specify other available time span options, skip to Step 6.
• Previous Hour
• Previous Shift
• Yesterday
• Last
◦ Monday
◦ Tuesday
◦ Wednesday
◦ Thursday
◦ Friday
◦ Saturday
◦ Sunday
◦ Week
◦ Month
◦ Shift
• Past
◦ 10 minutes
◦ 30 minutes
◦ 60 minutes
◦ 2 hours
◦ 1 day
◦ 2 days
◦ 7 days
◦ 14 days
◦ 1 month
• Current Hour
• Current Shift
• Today
• Current Week
• From Start Of
◦ Today
◦ Yesterday
◦ Last Monday
◦ Last Tuesday
◦ Last Wednesday
◦ Last Thursday
◦ Last Friday

OPH070 235
Report generating tasks

◦ Last Saturday
◦ Last Sunday

Figure 204. Generate dialog box -- Time Span

6. Select a Start Date Time, in Absolute or Relative (A or R) time format. The pull-down
menu displays a calendar. Select dates from the calendar or manually enter dates in the
field.
7. Select an End Date Time, in Absolute or Relative time format. The pull-down menu
displays a calendar. Select dates from the calendar or manually enter dates in the field.
8. Select a Historian Server from the drop-down menu.

236 OPH070
 Report generating tasks

9. Use the Report Destination drop-down list to select where you want the report to go.
The list contains the following report destination options:
• Window: The generated report displays in a window on your screen.

Note
The Window option is only valid for manually requested (demand) reports. The
option is not supported for event-driven reports, which include timed, periodic,
and auto-SOE reports. Execution of event-driven report definitions that are
configured with this option results in an error listed in the Report Generation Log
of the Report Manager.

• Printer: The generated report is sent to the printer that you specify by using the
adjacent Select Printer button.
• File: If you select File, click the adjacent Select File button to choose an output file
name and type. The available file types are as follows:
◦ Text file (.txt)
◦ Microsoft Word files (.doc)
◦ HTML files (.htm or .html)
◦ CSV files (.csv)
◦ Excel files (.xls or .xlsx)
◦ RTF files (.rtf)
◦ PDF files (.pdf)
• Email: The generated report is sent through an e-mail to the address that you
specify by using the adjacent Select Mail button.
• File at Historian: The generated report is saved and archived with the rest of your
historical data.
10. The Destination Info field is populated with your choice.
11. Select OK to save your changes, or Cancel to exit.

9.11.2 To export report output to external applications

After a report is run to a workstation window, you can export the report to a variety of file
types and applications:

• Crystal Reports (*.rpt)

• PDF (*.pdf)
• Character Separated Values (CSV) (*.csv)
• Microsoft Excel (97 - 2003) (*.xls)
• Microsoft Excel (97 - 2003) Data-Only (*.xls)
• Microsoft Excel Workbook Data-Only (*.xlsx)
• Microsoft Word (97 - 2003) (*.doc)
• Microsoft Word (97 - 2003) - Editable (*.rtf)
• Rich Text Format (RTF) (*.rtf)

OPH070 237
Timed, demand, and triggered events

• XML (*.xml)

Note
The file type, Microsoft Excel Workbook Data-Only (*.xlsx), is limited to data only. All
formatting information, for example, font size, bold, and so forth, that may have been
configured using the SAP Crystal Report Manager is not passed on to the xlsx output
file.

Use the following steps to export the output of a report:

1. Access the Report Manager [204].

2. Generate a report to a window.
3. Click Export Report on the top left of the toolbar. The Export window appears.
4. Select your file format and destination.
5. Click OK to save your changes or Cancel to exit.

9.12 Timed, demand, and triggered events

The Report Manager enables you to add timed, demand, and triggered events to generate
reports about the following:

• Timed events run based on a due date and time period that you specify.
• Demand events run when you manually request them.
• Triggered events run based on a value change in a digital, monitored process point.

9.12.1 To add a timed event or configure existing timed events

in the Report Manager
Use the following steps to add a timed event or configure existing timed events in the
Report Manager:

1. Access the Report Manager [204].

2. Click Timed Events.

238 OPH070
 Timed, demand, and triggered events

3. Select New Event from the Options menu (or, if you want to configure an existing
timed event, select Open Event Definition). The Add Timed Event window appears:

Figure 205. Add Timed Event window

This window enables you to add a new timed event, or edit a timed event that already
exists.
4. Enter an Event Name. This name is displayed in the Timed Events window.
5. Select an Event Due Date from the pull-down menu. The timed event will trigger as
long as the current date and time is greater than the event due date that you specify.
6. Choose the Time Format (Hour:Min:Sec, Day, Month, or Shift) for the next event due.
7. Select a Time Period for Next Event Due. This field automatically changes based on your
time format selection. When a shift time is selected, the next event due date is
calculated from a database table along with the event due date and time.
8. Choose an Offset Time (Hour:Min:Sec) for the event. This time is used to adjust the end
date to ensure that all report data is available to the report that is being generated. The
end date is the time at which the timed event occurs minus the offset time. Your data
stops at the due date minus the offset. For example, if you generate at 12:05 with an
offset of [Link], the data includes up until 12:00.
9. Place a check mark in the Enable Event box to enable the event. Deselect the box to
disable the event.
10. Click OK to add the timed event, or Cancel to exit.

OPH070 239
Timed, demand, and triggered events

9.12.2 To add to or edit the Report Manager reports list

Use the following steps to add to or edit the Report Manager reports list:

1. Access the Report Manager [204].

2. Select Timed, Trigger, or Demand Events.
3. The grid populates with all of the report definitions attached to this event (the bottom,
Report List for Event portion of the window displays details of the report definitions
attached to the selected event):

Figure 206. Populated grid

240 OPH070
 Timed, demand, and triggered events

4. Choose an Event, and right-click to select the Edit Reports List button, or choose
Options -> Edit Reports List. The Reports List window appears:

Figure 207. Reports List window

5. Choose an Available Report Name and add it to the Added Report Names.
6. Click OK to save the updated report list, or Cancel to exit.

9.12.3 To add a demand event or configure existing demand

events in the Report Manager
Use the following steps to add a demand event or configure existing demand events in the
Report Manager:

1. Access the Report Manager [204].

2. Click Demand Events.

OPH070 241
Timed, demand, and triggered events

3. Select Options -> New Event. The Add Demand Event window appears:

Figure 208. Add Demand Event window

You can use this window to add a new demand event, or edit a demand event that
already exists.
4. Enter an Event Name.
5. Place a check in the Enable Event check box to enable the event. Clear the check box if
you want to disable the event.
6. Click OK to add or edit the demand event, or Cancel to exit.

9.12.4 To add reports to a demand event

Use the following steps to add reports to a demand event:

1. Access the Report Manager [204].

2. Select Demand Events. The grid populates with all of your scheduled events.
3. Choose an event, and right-click to select Edit Reports List. The Reports List window
appears.
4. Choose any Available Report Names that you want to add and move them down to the
Added Report Names window.
5. Click OK to save your reports to this event.

9.12.5 To generate a report from a demand event in the Report

Manager
Use the following steps to generate a report from a demand event in the Report Manager:

1. Access the Report Manager [204].

2. Click Demand Events.

242 OPH070
 Timed, demand, and triggered events

3. For report generation, use any of the following methods:

• Select a demand event and click Generate in the Options menu.
• Right-click a demand event and click Generate Reports.
• Click the Generate Report icon in the toolbar.
The Select Start Time and End Time window appears:

Figure 209. Select Time window

4. Specify the start and/or end time for your demand event. The following table describes
setting options available in the Select Start Time and End Time dialog box.

Table 39. Options in the Select Start Time and End Time dialog box

Item Description
Use Default Start and End The default start time is based on the time period that you
Time specified in the report definition. The default end time is the
current time.
I want to specify Start time The report is generated based on specific start and end times.

I want to specify End time

I want to specify Start and

End time
Start Date Time Enables you to select a specific start date and time. You can
specify times in Absolute or Relative format (A/R buttons).
End Date Time Enables you to select a specific start date and time. You can
specify times in Absolute or Relative format (A/R buttons).

OPH070 243
Timed, demand, and triggered events

9.12.6 To add a triggered event or configure existing triggered

events in the Report Manager
When you want to generate reports based on an event that occurs in your plant, consider
scheduling a trigger event. Use the following steps to add a triggered event or configure
existing triggered events in the Report Manager:

1. Access the Report Manager [204].

2. Select Trigger Events.
3. Select Options -> New Event. The Trigger Event dialog box appears:

Figure 210. Trigger Event dialog box

You can use this window to add a new trigger event, or edit a trigger event that already
exists.
4. Enter an Event Name. This name is displayed in the Trigger Events grid.
5. Enter a Trigger Point name, or click Browse Points.
6. Select a Trigger Value from the pull-down menu. The trigger value determines whether
the event will be triggered when the digital point changes to a 1, to a 0, or on any
change in state.
7. Enter a start time and end time offset from trigger time. This is the amount of time
prior to, and following, the trigger that you want to include in the report (in hh:mm:ss).

244 OPH070
 Timed, demand, and triggered events

8. You can also specify the start time as one of the following options:
• "Last change of state time" of the trigger point: To perform this action, select the
Use Last Change of State as Start Time check box.
• "Last processed trigger time" of the trigger event: To perform this action, select the
Use Last Trigger as Start Time check box.

Figure 211. Trigger Event dialog box

See How the report start time is computed based on various event trigger settings
[249] for more information about report start time computation.
9. Enter a time to wait before this trigger event is processed again. This time value
determines if changes in the trigger should be ignored for a specific time period after
the trigger is detected and processed.
10. Enter the Last Processed Time. This is the time of the last processed trigger event.
Events with times greater than this time will be processed. Use the down arrow to
access a calendar that you can use to select the date. The default is the current time.
11. Use the Enable Event check box to enable or disable the event.
12. Click Reports List to perform the following actions:
• View the list of available reports for the event.
• Add report(s) to the event.
See Using the Reports List option in the Trigger Event dialog box [246] for more
information about the Reports List option.

OPH070 245
Timed, demand, and triggered events

13. Click OK to add the trigger event, or Cancel to exit.

9.12.7 Using the Reports List option in the Trigger Event dialog
box
When you click Reports List in the Trigger Event [244] dialog box, the following dialog box
appears:

Figure 212. Reports List dialog box

The Reports List dialog box contains the following options.

Table 40. Options in the Reports List dialog box

Option Description
Event Name Shows the name of the trigger event.
Available Report Shows the available reports
Names
Added Report Shows the reports that are added to the trigger event.
Names
Add Adds the selected report(s) from the Available Report Names box to the Added
Report Names box.

246 OPH070
 Timed, demand, and triggered events

Option Description
Add All Adds all reports from the Available Report Names box to the Added Report
Names box.
Filter Filters reports by specifying a criteria. When you click Filter, the Filter Criteria
dialog box appears:

You can specify a filter criteria by using any one or a combination of the following
options:

• Select the check box(es) against the report format(s) that you want to use as
the filter criteria.
• Enter a string in the Filter String box.
Click Apply after you specify the filter criteria.
Show All Shows all reports with no filter criteria.
Move Up Moves up the selected report(s) in the Added Report Names box.
Move Down Moves down the selected report(s) in the Added Report Names box.
Remove Removes the selected report(s) in the Added Report Names box.
Remove All Removes all reports in the Added Report Names box.
OK Applies changes and dismisses the window.
Cancel Cancels changes and dismisses the window.

9.12.8 Using a network-shared folder as a report destination for

timed and triggered reports
Network-shared folders are supported as a file destination for report generation. However,
while specifying a file destination, Emerson recommends that you use Universal Naming
Convention (UNC) pathnames instead of mapped drive names. UNC is a standard for
identifying network resources, such as servers, printers, and so forth. A UNC path contains
backslashes or double slashes before the computer name.

Mapped drive names are only applicable to the user that created the mapping and are only
valid while that user is logged on. The Report Service component of the Report Manager will
not have access to user mappings and will not be able to execute the reports if they are
timed or triggered.

OPH070 247
Timed, demand, and triggered events

To use a UNC pathname, enter the destination pathname directly into the File Name field of
the Save As dialog box that appears when you define the destination file in the Report
Manager [222]. Use the following format:

\\<servername>\<sharename>\<filename>

Do not include the extension in the filename as that is defined by the Save as type field of
the Save As dialog box.

Figure 213. Save As dialog box

The computer hosting the share (or, shared folder) must be a member of the same domain
as the computer hosting the Report Service. Additionally, on the computer hosting the
share, the shared folder must have its share permissions and security set to allow access by
the computer hosting the Report Service. To do so, use the following steps:

1. Right-click the shared folder and click Properties.

2. The Properties window appears. Click the Sharing tab.
3. The Properties window displays the Sharing tab view. Click Advanced Sharing.
a. Click Share this folder.
b. Click Permissions.
4. The Permissions dialog box appears.
a. Add the computer hosting the Report Service with full control.
b. Click Apply to apply the settings.
5. Close the Permissions dialog box.

248 OPH070
 How the report start time is computed based on various event trigger settings

6. Return to the Properties window. Select the Security tab.

7. The Properties window displays the Security tab view.
a. Add the computer hosting the Report Service with full control.
b. Click Apply to apply the settings.
8. Close the Properties window.

9.13 How the report start time is computed based on

various event trigger settings
The report start time is computed on the basis of various event trigger settings, as
illustrated in the following examples.

9.13.1 Example 1: Typical event trigger execution

The common configuration for an event triggered report is to have the report start time to
begin at the trigger time, or at an offset prior to that time when a specific pre-event period
is desired for logging. In this case, both special start time options are left unchecked.

Table 41. Typical event trigger execution

Trigger Value Use Last Change of State as Start Time Use Last Trigger as Start Time
1 (unchecked) (unchecked)

Figure 214. Computing report start time during a typical event trigger execution

9.13.2 Example 2: Set start time to a previous change of state

occurrence
On some occasions, it is desirable to report values beginning at the time when the previous
event transitioned from the triggered state. In this special case, the “Use Last Change of
State as Start Time” option should be selected. A start time offset cannot be entered for this
type of trigger.

OPH070 249
How the report start time is computed based on various event trigger settings

Table 42. Start time set to a previous change of state occurrence

Trigger Value Use Last Change of State as Start Time Use Last Trigger as Start Time
1 checked (unchecked)

Figure 215. Start time set to a previous change of state occurrence

9.13.3 Example 3: Set start time to a time of previous event

trigger
On some occasions, it is desirable to report values beginning when the previous trigger
occurred. In this special case, select the “Use Last Trigger as Start Time” option. A start time
offset is not available for this type of trigger.

Table 43. Start time set to a time of previous event trigger

Trigger Value Use Last Change of State as Start Time Use Last Trigger as Start Time
1 (unchecked) checked

Figure 216. Start time set to a time of previous event trigger

9.13.4 Example 4: Special case for “Change in State” event

triggers
In the case, when the Trigger Value setting is set to “CHANGE IN STATE”, selecting either
start time modification option results in the same start time calculation behavior. This is
shown in the example below.

250 OPH070
 Report Manager administrative tasks

Table 44. “Change in State” event triggers

Trigger Value Use Last Change of State as Start Time Use Last Trigger as Start Time
CHANGE IN STATE (unchecked) checked
CHANGE IN STATE checked (unchecked)

Figure 217. “Change in State” event triggers

9.14 Report Manager administrative tasks

Beyond the day-to-day use of the Report Manager, the following tasks can help you get the
most out of the Report Manager functionality.

9.14.1 To view the most recent report generation error in the

Report Manager
Use the following steps to view the most recent report generation error in the Report
Manager:

1. Access the Report Manager [204].

2. Right-click to open the Options menu.

Figure 218. Options menu

3. Select View Error to view the most recent report generation error.

OPH070 251
Report Manager administrative tasks

9.14.2 To back up your Report Manager data

Use the following steps to back up your Report Manager data:

1. Access the Report Manager [204].

2. Select Backup from the File menu. The Backup Data window appears:

Figure 219. Backup Data window

3. To enable the historian to automatically backup Report Manager data, check the
Automatic Backup Enabled check box.
4. Choose the Automatic Backup Interval. The system automatically performs data
backups based on this time interval.
5. If you choose to disable automatic backup, you can set the length of time that you
want to be reminded on, in order to perform your manual backup. If you enable
automatic backup, this option is not available.
6. Click Do Backup Now to perform an immediate backup of your data, or select OK to
save your settings or Cancel to exit.

252 OPH070
 Report Manager administrative tasks

9.14.3 To set administrative rights in the Report Manager

Use the following steps to set administrative rights in the Report Manager:

1. Access the Report Manager [204].

2. Select File -> Manage Admin Users. The Admin Users window appears:

Figure 220. Admin Users window

3. If you want to remove a user, highlight the name and click Remove.
4. If you want to add a user, click Add. The Add User window appears:

Figure 221. Add User window

5. Type a user name and click OK to save your settings, or Cancel to exit.

9.14.4 Crystal Reports format files

The report file dictates the position, placement, and other display characteristics of data on
the report. A report file contains the following:

• Source of your data, such as OLE DB data source name.

• Tables and columns.
• Data fields that you want to use to retrieve data.
• Grouping and placement of data on your report.
• Summary information for your data.
• Details, such as font type, font size, and font attributes.

Display elements including graphics, supplemental text, page numbers, and date/time
stamps.

OPH070 253
Report Manager administrative tasks

9.14.5 Report user function library (UFL)

The UFL is a support library that provides a series of convenient and easy to use functions
that enable you to convert UTC to local time, evaluate historical data values and statuses,
and obtain data from the Report Manager configuration database.

You can invoke the functions in this library with any of the report layout files in the standard
library or any custom designed report from the Crystal Reports engine. You can expand the
UFL depending on your requirement.

9.14.6 Formatting formulas

Formatting formulas are helpful if you want to modify any of the report templates that are
included with the historian. See Functions and formulas for rpt files [502] .

9.14.7 To export report settings to a file

Note
You can use this procedure to move or duplicate report settings between machines.

Use the following steps to export report settings to a file:

1. Access the Report Manager [204].

2. Highlight a single item or multiple items. In this example, a demand event is
highlighted. You can export settings from report definitions, report formats, timed
events, trigger events, and demand events.

Figure 222. Demand event - highlighted

254 OPH070
 Report Manager administrative tasks

3. Right-click the item name and choose Select for Export.

Figure 223. Right-click menu

A check mark is now displayed in front of your selected item (or items) and all other
items now have check boxes.

Figure 224. Selected items

4. Select the check boxes of any additional items that you want to export.

OPH070 255
Report Manager administrative tasks

5. Click the Export Data button. The Export Package Name window appears:

Figure 225. Export Package Name window

6. Enter a name and click OK. The Export window appears:

Figure 226. Export window

256 OPH070
 To create reports of edited historical data

7. Click Start Export if you approve of the selection, or click Cancel. The Report Manager
logically groups items together when creating an export package, so that any other
items related to the item that you selected to export are also exported. In this example,
a demand event was selected for export. The Report Manager also exported the report
definition associated with the demand event, as well as the report format and the
associated RPT file.
An export status window is displayed to let you know that your export was successful.

Figure 227. Export Status window

9.15 To create reports of edited historical data

You can use the Report Manager to create reports that use edited historical data. This can
be a convenient way to monitor the historical data editing activities of users in your system,
and to ensure that the capability of the History Edit tool is being used correctly.

OPH070 257
To create reports of edited historical data

Figure 228. Advanced tab

Use the following steps to create reports of edited historical data:

1. Specify a data retrieval mode for your report:

• Get Original Value: Retrieves the values prior to any edits.
• Get Latest Value: Retrieves the most current values.
• Get All Values: Retrieves all the values from original to most current.
2. If you check Mark Edited data on report, the samples that contain edited data are
marked on your report.
3. If you want to include annotations, check Show Annotations on report (only applies to
ExpressCalc reports).
4. Click OK.

258 OPH070
 To exit the Report Manager

9.16 To exit the Report Manager

Use the following steps to exit the Report Manager:

1. Select File -> Exit, or alternxatively, the “X” button at the top right corner of the Report
Manager window. The Quit Application dialog box appears:

Figure 229. Quit Application dialog box

2. Select No.

Note
If you exit the Report Manager, scheduled or triggered reports will not run. Emerson
recommends that you minimize the Report Manager when you are not using it.

OPH070 259
 File History overview

10 Using File History

Topics covered in this section:
• File History overview [261]
• To use the File History tool [261]

10.1 File History overview

The File History system accepts requests to store and retrieve files to/from a historical file
archive. These accumulated data files are available for data retrieval processing. Historical
data can be retrieved and sorted with the retrieval functions.

There are two main ways to use the File History:

• By accessing the File History tool.

• By sending report output files directly to the File History tool from the Report Manager.

The File History tool enables you to quickly move files between your workstation and your
historian, and acts as a running document history of your historical data. The files are saved
until the hard disk storage is full or indefinitely if an archive media is used.

The tool functions like an FTP transfer program, but unlike an FTP program, multiple
versions of the same file cannot overwrite themselves. To enable you to save multiple
versions of the same file without danger of overwriting, files are saved by timestamp. This
means that you can keep multiple versions of a file with the same name, because they will
have different timestamps. For example, you can keep a running record of a file generated
daily, entitled Boiler analog points, and the File History tool displays each day's version of
that file organized by timestamp.

The File History tool enables you to create directories on your local workstation and on your
historian server. However, any directories that you create on your historian server are virtual
only, and meant to aid your file organization; these directories will not exist on the historian
disk.

10.2 To use the File History tool

Use the File History tool as follows:

OPH070 261
To use the File History tool

1. From your workstation, select Start -> Programs -> Ovation Process Historian -> File
History. The File History tool appears. Your local workstation is displayed on the left
side of the tool. The historian workstation that you are connected to displays on the
right side of the tool.

Figure 230. File History Tool

2. Choose a historian from the drop-down menu.

3. Click Connect. The tool displays all files available on the historian. You can verify the
historian that you are connected to on the bottom right of the File History Tool.

Note
The user and domain names are read only.

4. Click to navigate through the folders on your historian.

5. You can create directories either on your local workstation or on your historian
workstation by clicking the buttons Create Local Dir or Create Historian Dir. Remember
that any directories you create on your historian are virtual only, and will not be created
on the historian disk.

262 OPH070
 To use the File History tool

6. You can click the arrow buttons to send files between the two workstations. File
transfers occur in real time and the tool display refreshes automatically. In this
example, the [Link] file on the local workstation has been sent to the
historian workstation.

Figure 231. Using the file send buttons

7. You can use the File History tool filter function to narrow down the selection of files on
your historian workstation. You can filter the historian files by timestamp, date,
domain, user, computer, and source (which is the application that created the file).

Figure 232. Using the filter function

OPH070 263
To use the File History tool

8. You can use the File History Tool hover function to hover over (or mouse over) a file
name and view its details without scrolling.

Figure 233. Using the hover function

264 OPH070
 History Manager overview

11 Using the History Manager

Topics covered in this section:
• History Manager overview [265]
• To access the History Manager window [265]
• Components of the History Manager window [266]
• Managing the historical data with the History Manager [278]

11.1 History Manager overview

The History Manager enables you to review and manage stored historical data and disk
space. You can use the History Manager to perform the following tasks:

• Load, unload, lock, and unlock the historical data.

• Review information about various time ranges, for example, whether they are available
online or not.
• Visualize the historical data availability by using the storage map to review the status
and storage consumption of the individual history types.
• View messages for the removable or fixed storage devices.

11.2 To access the History Manager window

Use the following steps to access the History Manager window:

1. From your desktop, navigate to the History Manager as follows:

Start -> Ovation Process Historian -> History Manager

OPH070 265
Components of the History Manager window

2. The History Manager window appears:

Figure 234. History Manager window

11.3 Components of the History Manager window

The following figure depicts the components of the History Manager window:

266 OPH070
 Components of the History Manager window

Figure 235. Components of the History Manager window

Generally, the History Manager window contains the following components:

• Menu bar [267].

• Toolbar [268].
• Tabs [269].
• Tab view [276].
• Storage Map [276].
• Archive action buttons [277].
• Color legend [277].

11.3.1 Menu bar

The following figure depicts the menu bar of the History Manager window [266].

Figure 236. Menu bar of the History Manager window

The following table describes the options available in the menu bar.

Table 45. Options available in the menu bar

Menu Option Description

File Refresh Refreshes the current view.
Exit Closes the History Manager window.

OPH070 267
Components of the History Manager window

Menu Option Description

Data Reload Reloads historical data to the main storage from an archive
device by time.
Unload Unloads historical data from the main storage by time or
size.
Lock Locks the specified historical data from being removed
from the main storage by the historian’s automated disk
space management software.
Unlock Unlocks the historical data for the specified time range and
historical data type, making it available for the historian’s
automated disk space management software.
Zoom In Zooms into the Storage Map view.
Zoom Out Zooms out of the Storage Map view.
Archive Writes any un-archived historical data file to the archive
device.
Removable Enable Enables the removable archive (DVD-RAM).
Archive
Disable Disables the removable archive (DVD-RAM).
Lock Locks the removable archive (DVD-RAM).
Unlock Unlocks the removable archive (DVD-RAM).
Eject Ejects the removable archive volume (DVD-RAM disc).
Format Formats the removable archive volume (DVD-RAM disc).
Fixed Archive Enable Enables archive activities for the fixed archive, such as NAS,
SAN, or DAS.
Disable Disables archive activities for the fixed archive, such as NAS,
SAN, or DAS.
Volumes Enables you to view the volumes information [274].
Message Acknowledge Acknowledges an archive attention message.
Dismiss Dismisses an archive attention message.
Volumes Remove Last Removes the last volume [274] from the History Manager’s
volume database. In other words, the History Manager
resets.
Help Help Opens the Help topics.
About History Opens the About History Manager dialog box, which
Manager contains the version of the History Manager.

11.3.2 Toolbar
The following figure depicts the toolbar of the History Manager window [266].

Figure 237. Toolbar of the History Manager window

The following table describes the icons available in the toolbar of the History Manager
window.

268 OPH070
 Components of the History Manager window

Table 46. Icons in the toolbar of the History Manager window

Icon Description
Refreshes the current view.

Reloads historical data to the main storage from an archive device by time.

Unloads historical data from the main storage by time.

Unloads historical data from the main storage by size.

Locks the specified historical data from being removed from the main storage by the
historian’s automated disk space management software.
Unlocks the historical data for the specified time range and historical data type,
making it available for the historian’s automated disk space management software.
Writes any un-archived historical data file to the archive device.

Zooms into the Storage Map view.

Zooms out of the Storage Map view.

Enables the removable archive (DVD-RAM), or enables archive activities for the fixed
archive, such as NAS, SAN, or DAS.
Disables the removable archive (DVD-RAM), or disables archive activities for the fixed
archive, such as NAS, SAN, or DAS.
Locks the removable archive (DVD-RAM).

Unlocks the removable archive (DVD-RAM).

Ejects the removable archive volume (DVD-RAM disc).

Formats the removable archive volume (DVD-RAM disc).

Acknowledges an archive attention message.

Dismisses an archive attention message.

11.3.3 Tabs
The following figure depicts the tabs of the History Manager window [266].

Figure 238. Tabs of the History Manager window

OPH070 269
Components of the History Manager window

The History Manager window contains the following tabs:

• Historical Data [270] tab [270].

• Removable Archive [271] tab [271].
• Fixed Archive [272] tab [272].

Historical Data tab

The Historical Data tab of the History Manager window is used to view the historical data
that is stored, as well as the states of various time ranges. For each historical data type, this
tab displays the time period covered by the historical data files in each historian storage
area. It is useful to determine at what period of time the historical data is available from the
main storage and at what point the archive must be accessed to obtain retrieval results. The
following figure depicts the Historical Data tab.

Figure 239. Historical Data tab of the History Manager window

The top half of the window displays the following information about the historical data:

• Data type: This field indicates the historical data type.

• Start: This field indicates the start date and time of the historical data.
• End: This field indicates the end date and time of the historical data.
• Size (KB): This field indicates the size, in kilobytes, of the historical data.

The bottom half of the window displays the following information about the historical data:

• Storage map [276].

• Archive action buttons [277].

270 OPH070
 Components of the History Manager window

• Color legend [277].

Removable Archive tab

The Removable Archive tab of the History Manager window is used to view the removable
archive devices (DVD-RAMs), their status, and any attention messages. The following figure
depicts the Removable Archive tab.

Figure 240. Removable Archive tab of the History Manager window

The top half of the window displays the following data about the removable archive devices:

• Device: This field indicates the device name.

• Type: This field indicates the device type, DVD-RAM.
• State: This field indicates the state of the device. The four possible states that a device
can have are as follows:
◦ Request: There is a request on the device, which means that a message is
displayed on the bottom-half of the window for the device.
◦ Idle: The device is idle.
◦ Format: A new volume in the device is actively being formatted, which can take up
to 20 minutes.
◦ Access: Access to the device is in use for reading or writing.
• Properties: This field indicates any properties the device may have associated with it.
• Volume: This field indicates the archive volume of the device.

For each removable archive device, you can use the following buttons.

OPH070 271
Components of the History Manager window

Table 47. Buttons for the removable archive device

Button Functionality
Enable Enables the removable archive device (DVD-RAM).
Disable Disables the removable archive device (DVD-RAM).
Lock Locks the removable archive device (DVD-RAM).
Unlock Unlocks the removable archive device (DVD-RAM).
Eject Ejects the removable archive volume (DVD-RAM disc).
Format Formats the removable archive volume (DVD-RAM disc).

The bottom half of the window contains attention messages. This area displays the
following data about the attention messages:

• Time: This field indicates the time when each attention message was issued.
• Description: This field indicates the description of the action that you should take.

You can choose to acknowledge or dismiss the message.

• To acknowledge the message, click Acknowledge. The system immediately acts on

your acceptance of the message.
• To dismiss the message, click Dismiss. The message is removed from the History
Manager interface and canceled from your system.

The archive manager automatically manages your volumes by:

• Prompting you, through an archive attention message, when a new volume needs to
be inserted and how it should be physically labeled.
• By logically labeling a volume.
• Tracking all created volumes in the volume database.

Emerson recommends that you physically label removable media volumes in accordance
with the logical label that the archive manager assigns.

The volume database facilitates the reload of files that are no longer located in the main
storage. The archive manager will prompt you for the volumes needed to satisfy a reload
request using the logical labels. The History Manager can show you which volumes are
currently in the drive, because it is able to read the logical label of the volume. Retrieval is
allowed directly from the volume currently in the drive, without performing a reload
operation.

Fixed Archive tab

The Fixed Archive tab of the History Manager window is used to view the fixed archive
devices (NAS, SAN, or DAS), their status, and any attention messages. The following figure
depicts the Fixed Archive tab.

272 OPH070
 Components of the History Manager window

Figure 241. Fixed Archive tab of the History Manager window

The top half of the window displays the following data about the fixed archive devices:

• Name: This field indicates the device name.

• State: This field indicates the state of the device.
• Properties: This field indicates any properties the device may have associated with it.
• Free Space: This field indicates the free space available in the device.

For each fixed archive device, you can use the following buttons.

Table 48. Buttons for the fixed device

Button Functionality
Enable Enables archive activities for the fixed archive device, such as NAS, SAN, or DAS.
Disable Disables archive activities for the fixed archive device, such as NAS, SAN, or DAS.
Volumes Enables you to view the volumes information [274].

The bottom half of the window contains attention messages. This area displays the
following data about the attention messages:

• Time: This field indicates the time when each attention message was issued.
• Description: This field indicates the description of the action that you should take.

You can acknowledge the message by clicking Acknowledge.

OPH070 273
Components of the History Manager window

Because a fixed archive device is typically online, they are accessible for historical data
retrievals if the requested data is no longer available on the main storage. You are not
required to perform a reload operation.

Archive volumes information in the History Manager window

Use the following steps to view the archive volumes information in the History Manager
window:

1. Access the History Manager window [265].

2. Navigate to the Fixed Archive [272] tab [272] of the window.
3. Select a fixed archive device, and click Volumes. The Volumes option is available in the
menu bar options [267] and buttons in the middle of the window, as shown in the
following figure.

Figure 242. Volumes option in the History Manager window

4. When you click Volumes, the Archive Volumes dialog box appears. The dialog box
displays the archive volumes created by the fixed archive until the current date.

Figure 243. Archive Volumes dialog box

274 OPH070
 Components of the History Manager window

5. When you right-click a volume, you have the following options:

• Information: Use this option to view the information of a volume. When you click
Information, the Volume Information dialog box appears. The dialog box displays
the following information:
◦ Space used on the volume.
◦ Types of data in the volume, such as SOE, alarm (ALM), and so forth.
◦ Start date and time.
◦ End date and time.

Figure 244. Volume Information dialog box

• Delete: Use this option to delete a volume. When you click Delete, the following
confirmation message appears. If you click Yes, the volume is deleted. Click No if
you do not want to delete the volume.

Figure 245. Confirmation message to delete a volume

OPH070 275
Components of the History Manager window

6. You can also directly remove the last volume from the History Manager’s volume
database by using the Volumes -> Remove Last option in the menu bar [267]. When
you click Remove Last, the following confirmation message appears. If you click Yes,
the last volume is deleted. Click No if you do not want to delete the volume.

Figure 246. Confirmation message to delete the last volume

11.3.4 Tab view

The Tab view of the History Manager window [266] displays the results for different tabs
[269], as described in the following table.

Table 49. Tab results view

Tab View
Historical Data Details of the Historical Data
Removable Archive Details of the removable devices (DVD-RAMs).
Fixed Archive Details of the fixed archive devices (NAS, SAN, or DAS).

11.3.5 Storage Map

The Storage Map area of the History Manager window [266], available under the Historical
Data [270] tab [270], provides a visual representation of the historical data in the main
storage. The Storage Map displays the historical data either by:

• Time range: Select the By Time Range option. The following figure depicts the Storage
Map area for this option.

Figure 247. Storage Map - By Time Range

• Size: Select the By Size In Bytes option. The following figure depicts the Storage Map
area for this option.

276 OPH070
 Components of the History Manager window

Figure 248. Storage Map - By Size in Bytes

See Color legend [277] for a description of colors in the Storage Map area.

11.3.6 Archive action buttons

The following figure depicts the archive action buttons, which are located below the
Storage Map area of the History Manager window [266].

Figure 249. Archive action buttons

The following table describes the functions of these buttons.

Table 50. Archive action buttons

Button Description
Reload [283] Reloads historical data to the main storage from an archive device by time.
Unload By Time Unloads historical data from the main storage by time.
[281]
Unload By Size Unloads historical data from the main storage by size.
[282]
Lock [284] Locks the specified historical data from being removed from the main storage
by the historian’s automated disk space management software.
Unlock [285] Unlocks the historical data for the specified time range and historical data
type, making it available for the historian’s automated disk space
management software.
Archive [286] Writes any un-archived historical data file to the archive device.

11.3.7 Color legend

The color legend in the History Manager window [266] identifies the meaning of each color
in the Storage Map area [276]. The following figure depicts the color legend.

Figure 250. Color legend

The following table describes the meaning of each color in the color legend.

OPH070 277
Managing the historical data with the History Manager

Table 51. Color description

Color Meaning Description

Online Indicates the time period of un-archived historical data that resides in Main
Storage
Archived Indicates the time period of the main storage historical data that also exists
in archive volumes.
Locked Indicates the main storage historical data that is protected from removal by
the historian’s disk space management software.
Offline Indicates the time period of archived historical data that is contained on
removable archive volumes not currently mounted on the historian. For
removable media, this color indicates all archived volumes except for any
inside an archive device.
Removable Indicates the time period of the historical data contained on removable
volume(s) resident in an archive device and online/available for use. This
color is not applicable for fixed archive devices.
Deleted Indicates the time periods where the historical data has been removed from
the main storage without being archived. This data cannot be restored.
No Data Indicates the time periods where no data is collected by the historian.

11.4 Managing the historical data with the History

Manager
To understand the History Manager application, begin by browsing the folder tree in the
Historical Data [270] tab [270].

278 OPH070
 Managing the historical data with the History Manager

Figure 251. History Manager tree

As you browse through the tree folders, you will notice the following main historical data
types:

• Points
• Alarms
• Sequence of Events
• Text
• Attributes
• Lab Data

As you click through the folders, the Storage Map [276] graphic changes to give you a visual
representation of the historical data time period available for a selected storage area.
Storage areas can include the following:

• Online: Represents the main storage data waiting to be archived.

• Online [Arc]: Represents the main storage data that has been archived.
• Mounted archive device name, such as ReadyNAS 2100: Represents the archived data.

The color legend [277] at the bottom of the screen identifies the meaning of each color. You
can display data in the Storage Map by:

• Time range, or
• Size in bytes

OPH070 279
Managing the historical data with the History Manager

To zoom in, click the Zoom In icon in the toolbar. The Zoom Into Historical Data dialog box
appears:

Figure 252. Zoom Into Historical Data dialog box

You can select a start date and time and an end date and time that you want to zoom in (or
out) on. After you click OK, the Storage Map is updated to display your new, narrower (or
wider), time range. Alternatively, a left-click drag of the mouse within the Storage Map
highlights an area to zoom. A subsequent click of the Zoom In icon zooms the map to the
selected time range.

Each button under the Storage Map [277] performs specific functions for the historical data.
The buttons are as follows:

• Unload By Time [281].

• Unload By Size [282].
• Reload [283].
• Lock [284].
• Unlock [285].
• Archive [286].

In addition to the Historical Data tab, the History Manager has the following tabs:

• Removable Archive [271] tab [271].

• Fixed Archive [272] tab [272].

280 OPH070
 Managing the historical data with the History Manager

11.4.1 Unloading data by time

You can unload data that you no longer need from the main storage to create free space for
reloading data. Use the following steps to unload the historical data by time:

1. Access the History Manager window [265].

2. Click Unload By Time in the Historical Data [270] tab [270]. The Unload Historical Data
dialog box appears:

Figure 253. Unload Historical Data dialog box

3. You can use the Unload Historical Data dialog box to select which type of historical
data you would like to unload, as well as the date and time period that you would like to
unload it from.
4. The Size Only option determines how much space will be freed by unloading the
history types and time ranges that you have specified. You can use this check box to
help you plan your available space, because the data is not actually removed.

OPH070 281
Managing the historical data with the History Manager

11.4.2 Unloading data by size

You can unload data that you no longer need from the main storage to create free space for
reloading data. Use the following steps to unload the historical data by size:

1. Access the History Manager window [265].

2. Click Unload By Size in the Historical Data [270] tab [270]. The Unload Data By Size
dialog box appears:

Figure 254. Unload Data By Size dialog box

3. You can use the Unload Data By Size dialog box to enter the number of megabytes of
data that you would like to unload, if you know that you only want a certain size of
data.
4. The Size Only option determines how much space, up to your requested amount, can
be freed by the unload operation. You can use this feature to help you plan, because
the data is not actually removed.

282 OPH070
 Managing the historical data with the History Manager

11.4.3 Reloading data

Use the following steps to reload historical data to the main storage from an archive device:

1. Access the History Manager window [265].

2. Click Reload in the Historical Data [270] tab [270]. The Load Historical Data dialog box
appears:

Figure 255. Load Historical Data dialog box

3. You can use the Load Historical Data dialog box to select which type of historical data
you would like to load, as well as the date and time period that you would like to load it
from.
4. The Size Only option enables you to determine how much space would be required to
reload the types and time ranges that you specify. The data will not actually be
restored if you select this check box. This option is useful to give you a preview of the
space you need for a reload so that you can plan accordingly.

OPH070 283
Managing the historical data with the History Manager

5. The Delete Oldest option instructs the historian to automatically remove the oldest
files to make space available for the files that you want to reload.

Note
The reloaded data files are automatically locked, thereby preventing their removal by
the disk space management functions while you are using them. To allow the reloaded
files to be deleted, you should unlock them when you no longer require them. The data
can then be removed from the hard disk but will continue to exist in the archive.

11.4.4 Locking data

Locking time ranges of data protects them from being deleted by the historian's disk space
management functions. For example, you might want two specific weeks of data to remain
on a disk while you perform an event analysis. After the analysis is complete, you can unlock
the files and allow them to be removed as needed by the historian storage management
functions.

Use the following steps to lock the historical data:

1. Access the History Manager window [265].

2. Click Lock in the Historical Data [270] tab [270]. The Lock Historical Data dialog box
appears:

Figure 256. Lock Historical Data dialog box

284 OPH070
 Managing the historical data with the History Manager

3. You can use the Lock Historical Data dialog box to select which type of historical data
you would like to lock, as well as the date and time period that you would like to lock it
from. Select the All check box to lock all data types for the time range that you specify.

11.4.5 Unlocking data

Use the following steps to unlock the historical data:

1. Access the History Manager window [265].

2. Click Unlock in the Historical Data [270] tab [270]. The Unlock Historical Data dialog
box appears:

Figure 257. Unlock Historical Data dialog box

3. You can use the Unlock Historical Data dialog box to select which type of historical data
you would like to unlock, as well as the date and time period that you would like to
unlock it from.

OPH070 285
Managing the historical data with the History Manager

11.4.6 Archiving data

Typically, data archival occurs periodically according to the settings in the Historian
Configuration Tool [55]. Use the following steps to initiate an immediate archival of any
unarchived historical data:

1. Access the History Manager window [265].

2. Click Archive in the Historical Data [270] tab [270], which initiates the archiving of any
pending files. The following message appears:

Figure 258. History Data archive

3. If you are sure that you want to archive the historical data that you have selected, click
Yes. If not, click No.

286 OPH070
 Historical Review overview

12 Using Historical Reviews

Topics covered in this section:
• Historical Review overview [287]
• Components of the Historical Reviews window [289]
• Historical Review Menu button [290]
• Quick Access Toolbar [300]
• Menu bar [300]
• Ribbon bars [300]
• Settings bar [303]
• Columns Grouping bar [304]
• Review Details panel [304]
• Dockable tabs [306]
• Status bar [307]
• Setting preferences [307]
• Performing a Historical Review [308]
• Using command line options to perform a historical review [323]
• To view edited historical data from a Historical Review [342]

12.1 Historical Review overview

The Historical Review application allows you to perform specific retrieval requests for point-
based and message-based (that is, alarm, SOE, operator event) historical data. Historical
retrieval results are displayed within an interactive grid that allows you to regroup, sort, and
filter the retrieval results. The user interface for this application contains a ribbon toolbar for
easy navigation to its filtering and configuration features.

By using this functionality, you can perform the following tasks:

• Select historical time ranges, data filters, and views to review your data.
• Save the review query settings (for example, "all set point change operator events for
the past 24 hours", "today's sequence of events messages", and so forth) to a Review
Definition file, according to user role, for later reuse.
• Compare specific points from multiple historians.
• Easily select common time spans (for example, yesterday, current day, past 60 min, and
so forth).
• Memorize a current time span for recall and use for other review types.
• Perform paging of a time span.
• Export the retrieval results to various file types, such as .txt, .csv, .pdf, .xls, and .xlsx.
• Investigate and diagnose detailed process records that correspond to the time period
of a plant condition or an event.

OPH070 287
Historical Review overview

You can access Historical Review from your Operator Station or a desktop PC.

Note
The Historical Review application can only be used for OPH retrieval. Interoperability with
eDB and HSR has not been retained in Ovation 3.6.0.

Use the Historical Review application to perform the following types of reviews:

• Point: Point reviews are based on a selected time range, specific points (filtered by
point name, point group, or point characteristic), and specific review types that you
select (which define the type of collected point data that is retrieved). For example, you
might be interested to view all changes in point value, or you might be interested to
view only the changes that occurred when the points entered a particular status.
• Alarm: Alarm reviews display all alarm messages that occurred on all drops or a single
drop, selected alarm types, point types, or individual points.
• Operator Event: Operator Event reviews display operator event messages based on
specific workstation, subtypes, specific grouped subtypes, selected subtypes, and
messages for a single point.
• SOE: SOE reviews are based on workstation number and point name.
• SIS (optional): SIS activity messages are transmitted from SIS data servers. This review
tab is hidden by default.
• ASCII: ASCII messages are text messages generated by the system. The ASCII review
can display, print, or save ASCII messages that occur on all workstations or a single
workstation.
• Common: Common reviews are combined reviews of one or more data types to be
displayed together.

12.1.1 To access the Historical Reviews window

Use the following steps to access the Historical Reviews window:

1. Select Start -> All Programs -> Ovation -> Ovation Applications -> Historical Review.
OR
Open the Ovation Applications folder at the Operator Station and double-click the
Historical Review icon.

288 OPH070
 Components of the Historical Reviews window

2. The Historical Reviews window appears:

Figure 259. Historical Review main window

Note
The SIS dockable tab is hidden by default.

3. To run a specific type of review, click the corresponding dockable tab located at the
bottom of the Historical Reviews window. For example, click the Alarm tab to run an
alarm review.
See Performing a Historical Review [308] for more information.

12.2 Components of the Historical Reviews window

The graphical user interface (GUI) for the Historical Review application is shown in the
following figure:

OPH070 289
Historical Review Menu button

Figure 260. Components of the Historical Reviews window

Note
The SIS dockable tab is hidden by default.

The Historical Review GUI contains the following main components:

• Historical Review Menu button [290].

• Quick Access Toolbar [300].
• Menu bar [300].
• Ribbon bars [300].
• Settings bar [303].
• Column grouping bar [304].
• Review details [304].
• Dockable tabs [306].
• Status bar [307].

12.3 Historical Review Menu button

The Historical Review Menu button at the top of the Historical Reviews window provides
access to several Historical Review functions. When you click the Historical Review Menu
button, the following dialog box appears:

290 OPH070
 Historical Review Menu button

Figure 261. Options in the Historical Review Menu button

The following table describes the functions provided by the Historical Review Menu button.

Table 52. Functions provided by the Historical Review Menu button

Function Icon Description

Load Review Selects a previously saved Ovation Historical Review filter or column
Configuration [292] template to load preconfigured filtered settings and selected
columns.
Save Review Saves the review's current filter settings and, optionally, the current
Configuration [293] column configuration for later re-use. A custom name is provided to
the saved settings for easy identification of the desired review at a
later time.
Print [294] Performs print, print preview, and page setup operations.

Export [294] Opens the Save As window. You can export the contents of the
Historical Reviews window to text, CSV, HTML, PDF, and XLS
formats.
Preferences [295] Opens the Preferences dialog box that can be used to save Historical
Review application settings. These settings are then applied to
subsequent Historical Review sessions.
Historian Preferences Opens the Preferences dialog box that can be used to save historical
[297] data source (Ovation Process Historian) hosts and user-specified
time zone abbreviation settings. These settings are then applied to
subsequent Historical Review (and trend) sessions for the specified
user or role.
Historical Reviews Modifies the configuration settings, review settings, and time
Options [298] zones. In addition, you can change the look and feel of the Historical
Reviews window.
Exit Historical Review Exits and closes the Historical Review application.
[299]

OPH070 291
Historical Review Menu button

12.3.1 To use the Load Review Configuration option (from the

Historical Review Menu button)
Use the Load Review Configuration option (from the Historical Review Menu button) as
follows:

1. Select Start -> Ovation -> Ovation Applications -> Historical Review.
2. The Historical Reviews window appears.
3. Click the Historical Review Menu button [290], and then click Load Review
Configuration. The Open dialog box appears:

Figure 262. Loading a review configuration

4. Select an existing review configuration file (.rvw), such as "All Alarms for Past 1
[Link]", corresponding to a role, and click Open. The configuration settings in the
selected file are loaded for a Historical Review.

292 OPH070
 Historical Review Menu button

5. Click Begin to start the Historical Review with the loaded settings. The Historical
Reviews window appears:

Figure 263. Historical Reviews window displaying results for the loaded review
configuration file, “All Alarms for Past 1 [Link]”

12.3.2 To use the Save Review Configuration option (from the

Historical Review Menu button)
The Save Review Configuration option is used to save the Historical Review configuration
settings in a review (.rvw) file. The file can be used later to load the saved configuration
settings.

Use this option as follows:

1. Select Start -> Ovation -> Ovation Applications -> Historical Review.
2. The Historical Reviews window appears. Perform the Historical Review [308] with the
desired configuration settings. The settings are displayed in the Settings bar [303].

OPH070 293
Historical Review Menu button

3. Click the Historical Review Menu button [290], and then click Save Review
Configuration to save the settings of your review in a file. The Save As dialog box
appears:

Figure 264. Saving a review configuration

4. Select a role from the left pane and enter a name of the review configuration file, such
as "SOE Review for Past 1 Day", in the File Name box.
5. Click Save As. The review configuration file, "SOE Review for Past 1 [Link]", is created.
Next time, you can use the Load Review Configuration [292] option to load the
configuration settings defined in the file and perform a Historical Review [308].

12.3.3 To use the Print option (from the Historical Review Menu
button)
Use the Print option (from the Historical Review Menu button) as follows:

1. Select Start -> Ovation -> Ovation Applications -> Historical Review.
2. The Historical Reviews window appears. Perform the Historical Review [308].
3. Click the Historical Review Menu button [290], and then click Print to perform print,
print preview, and page setup operations.

12.3.4 To use the Export option (from the Historical Review

Menu button)
Use the Export option (from the Historical Review Menu button) as follows:

1. Select Start -> Ovation -> Ovation Applications -> Historical Review.

294 OPH070
 Historical Review Menu button

2. The Historical Reviews window appears. Perform the Historical Review [308].
3. Click the Historical Review Menu button [290], and then click Export. The following
Save As dialog box appears:

Figure 265. Save As dialog box

4. Enter a file name, such as past1day, in the File name box; select the file type in the Save
as type box; and click Save. The file can be exported and saved in the following formats:
• Text Files (.txt)
• CSV Files (.csv)
• HTML Files (.htm)
• PDF Files (.pdf)
• Microsoft Excel Files (.xls, .xlsx)
5. The Historical Review records are saved in the file. Depending upon the format
compatibility, you can now import the file you exported in Step 4 to an external
software application, such as the Ovation Alarm Health Analyzer (AHA).

12.3.5 To use the Preferences option (from the Historical Review

Menu button)
Use the following steps to load, save, or clear the user preferences that apply to the
Historical Review application:

1. Access the Historical Reviews window [288].

OPH070 295
Historical Review Menu button

2. Click the Historical Review Menu button [290], and then click Historian Preferences.
The Historian Preferences dialog box appears:

Figure 266. Historian Preferences dialog box

3. Click Save to save the settings to your user profile and the settings will reappear when
you begin a new session.
4. Click Clear to remove the preference settings for your user profile, and your Role
settings will load when you begin a new session.
5. If you are an Administrator, you can perform the following:
• Save the preferences to a Role profile by highlighting the desired role before you
click Save.
• Use the preferences that have been defined for another role by selecting the
desired role from the list in the Preferences window, and then click Load. All the
settings that were saved for the selected role will now appear in your current
session.
• Clear role preferences that have been defined by highlighting the role in the list,
and then click Clear. All the settings that were saved for that role will be removed.

296 OPH070
 Historical Review Menu button

12.3.6 To use the Historian Preferences option (from the

Historical Review Menu button)
Use the following steps to load, save, or clear the historical data source and time zone
preferences used by the Historical Review application:

1. Access the Historical Reviews window [288].

2. Click the Historical Review Menu button [290], and then click Historian Preferences.
The Historian Preferences dialog box appears:

Figure 267. Historian Preferences dialog box

3. Click Save to save the settings to your user profile and the settings will reappear when
you begin a new session.
4. Click Clear to remove the preference settings for your user profile, and your Role
settings will load when you begin a new session.

OPH070 297
Historical Review Menu button

5. If you are an Administrator, you can perform the following:

• Save the preferences to a Role profile by highlighting the desired role before you
click Save.
• Use the preferences that have been defined for another role by selecting the
desired role from the list in the Preferences window, and then click Load. All the
settings that were saved for the selected role will now appear in your current
session.
• Clear role preferences that have been defined by highlighting the role in the list,
and then click Clear. All the settings that were saved for that role will be removed.

12.3.7 To use the Historical Reviews Options (from the Historical

Review Menu button)
You can use the Historical Review Options dialog box to define the appearance of the
Historical Reviews window, the appearance of the review content, the time format of the
review content, and identification of the OPHs in your Ovation system, configured to be
available to the Historical Review application.

Use the following steps to change the review settings:

1. Access the Historical Reviews window [288].

2. Click the Historical Review Menu button [290], and then click Historical Reviews
Options. The Historical Reviews Options dialog box appears:

Figure 268. Historical Reviews Options dialog box

298 OPH070
 Historical Review Menu button

3. The following table describes the options available in the Historical Reviews Options
dialog box. Select the desired options and click OK.

Table 53. Historical Reviews Options

Option Description
Configuration Use this option to control which application settings are saved with a review
Settings configuration file. The option contains the following selections:

• Font settings
• Layout
• Views
• Column settings
• Filters
View Use this option to hide or view the Ribbon bar, Settings bar, and Columns
Grouping bar. In addition, you can enable or disable auto-resize of the
review columns' width.
Colors Use this option to change the colors associated with the Historical Reviews
window. You can change the color scheme of the window to Black, Blue, or
Silver. In addition, you can specify the gradient color, background color,
foreground color, and empty area color.
Review Settings Use this option to specify the following settings:

• Default interval between start time and end time for each review type
• Default start and end time format
• Date and time format, including subsecond display
• Data retrieval mode for edited data
Start Up Options Use this option to specify a default configuration file, if desired.
Historian Use this option to view the information, including host name and IP address,
of Ovation Process Historians available to Historical Review and other
Ovation historical client applications. You can also add a new historian by
entering the host name and IP address of the new machine.
Time Zone Use this option to specify abbreviations for frequently used time zones
intended for your use. These abbreviations are made available in Historical
Review and trend time span dialog boxes for the specification of absolute
times.
About Use this option to view the version and copyright information of the
Historical Review application.

12.3.8 To use the Exit Historical Review option (from the

Historical Review Menu button)
Use the Exit Historical Review option (from the Historical Review Menu button) as follows:

1. Select Start -> Ovation -> Ovation Applications -> Historical Review. The Historical
Reviews window appears.
2. Click the Historical Review Menu button [290], and then click Exit Historical Review to
exit the Historical Reviews window.

OPH070 299
Quick Access Toolbar

12.4 Quick Access Toolbar

The Historical Reviews window has frequently used icons that appear at the top of the
window in a Quick Access Toolbar. This toolbar allows for easy access to commonly used
functions. The Quick Access Toolbar is shown below.

Figure 269. Quick Access Toolbar in the Historical Reviews window

The following table describes the icons in the Quick Access Toolbar.

Table 54. Icons in the Quick Access Toolbar

Function Icon Description

Start Historical Starts a Historical Review. Points matching the currently configured
Review filter settings are displayed in the review list. This button is enabled if a
review is not currently in progress.
Stop Historical Stops an active Historical Review. This button is enabled whenever a
Review review is in progress.
Find Point Searches through the review list for point names, drop names, or review
types containing a specific substring. This button is enabled if one or
more rows exist in the review list.

12.5 Menu bar

The Menu bar of the Historical Reviews window contains the following tabs:

• Home tab: Use this tab to access the basic options, grouped under the Home ribbon
bar [300], during a Historical Review.
• Filter tab: Use this tab to access the filter options, grouped under the Filter ribbon bar
[301], during a Historical Review.

12.6 Ribbon bars

The Historical Reviews window contains the following ribbon bars:

• Home [300] ribbon bar [300].

• Filter [301] ribbon bar [301].

The ribbon bars consist of menus and commands, which are grouped based on their
function.

12.6.1 Home ribbon bar

The Home ribbon bar contains groups, which further encapsulates different commands to
be used during a Historical Review. This bar has same groups for every review type. The
Home ribbon bar is shown in the following figure.

300 OPH070
 Ribbon bars

Figure 270. Home ribbon bar of the Historical Reviews window

The following table describes various functions available in the Home ribbon bar.

Table 55. Functions in the Home ribbon bar

Group Functions Description

Review Begin Starts a Historical Review. Points matching the currently configured
filter settings are displayed in the review list. This button is enabled
if a review is not currently in progress.
Stop Stops an active Historical Review. This button is enabled whenever a
review is in progress.
Time Span Set Specifies the time range for the review request. You can also toggle
between absolute time and relative time by using the toggle icon.
Memorize Saves start time, end time, and duration of a Historical trend. It does
not save the sample count.

Note
The sample count is the Data density (plot sample quantity) that is
tightly coupled with the trend trace - and is sometimes different per
trend trace.

Recall Recalls the time range.

Page Back Takes the time span used by the current review filter and then
executes the query for the preceding time range.
Next Takes the time span used by the current review filter and then
executes the query for the subsequent time range.
Search Find Searches through the review results list of the point names, drop
names, or review types containing a specified substring. This button
is enabled only if one or more reviews exist in the review list.
Historian Historian Selects the historian that you want to extract the historical
information from.
Font Style and Size Changes the font settings, including style and size.
Select Views/ Select Views Customizes the views under dockable tabs.
Columns
Select Customizes the column headings that you want to display in the
Columns Historical Reviews window for a particular type of review.

12.6.2 Filter ribbon bar

The Filter ribbon bar has different groups for each review type, as shown in the following
figures.

OPH070 301
Ribbon bars

Figure 271. Filter ribbon bar for the Point review

Figure 272. Filter ribbon bar for the Alarm review

Figure 273. Filter ribbon bar for the Operator Event review

Figure 274. Filter ribbon bar for the SOE review

Figure 275. Filter ribbon bar for the SIS review

302 OPH070
 Settings bar

Figure 276. Filter ribbon bar for the ASCII review

Figure 277. Filter ribbon bar for the Common review

The following table describes various functions available in the Filter ribbon bar for each
review type.

Table 56. Functions in the Filter ribbon bar for each review type

Review type Groups Reference

Point review System, Characteristics/Group/ See To perform a Point review [308] for
Description/Point, and Data Filter more information.
Alarm review System, Originating Drop, Priority, See To perform an Alarm review [312] for
and Filter Criteria more information.
Operator Event System, Originating Drop, User See To perform an Operator Event review
review Detail, Reason Detail, and Filter [314] for more information.
Criteria
SOE review System and Filter Criteria See To perform an SOE review [318] for
more information.
SIS review System and Originating Drop See To perform an SIS review [319] for
more information.
ASCII review System and Originating Drop See To perform an ASCII review [321] for
more information.
Common review Review, Point, Message Systems, See To perform a Common review [322]
Alarm, Operator Event, SOE, ASCII, for more information.
and SIS (when enabled)

12.7 Settings bar

The Settings bar displays the current filter settings for a Historical Review. The settings
include Start Time, End Time, Historian, Network/Unit, Point Filter, and so forth.

The following figure shows a Settings bar for a review.

Figure 278. Settings bar in the Historical Reviews window

OPH070 303
Columns Grouping bar

12.8 Columns Grouping bar

You drag a column header under this bar to group by that column.

The following figure shows the Columns Grouping bar:

Figure 279. Columns Grouping bar in the Historical Reviews window

12.9 Review Details panel

The Review Details panel displays the results of a Historical Review, as shown in the
following figure.

Figure 280. Review Details panel in the Historical Reviews window

The Review Details panel contains various columns for each review type, as listed in the
following table.

Table 57. Columns in the Review Details panel

Review type Columns

Point • Date/Time
• Point Name
• Alarm Type
• Point Description
• Value
• Quality
• Units (A) Alarm State (D)
• Point Status

304 OPH070
 Review Details panel

Review type Columns

Alarm • Date/Time
• Alarm Type
• Code
• Point Name
• Point Description
• AP
• Value
• Q
• Units(A) State
• Limits
• Incr
• Point Type
• PM
Operator Event • Date/Time
• Drop
• Domain
• User Name
• Message
• Reason
SOE • Date/Time
• Point Name
• Description
• State
ASCII • Date/Time
• Drop
• Message
SIS • Date/Time
• Drop
• Message
Common • Date/Time
• Type
• Point Name
• Drop
• Domain
• User Name
• Description
• Reason

OPH070 305
Dockable tabs

12.9.1 Customizing the view of the Review Details panel

You can customize the view of the Review Details panel as follows:

• To customize the column headings that you want to display in the Historical Reviews
window for a particular type of review, click Select Column(s) under the Select Views/
Columns group in the Home ribbon bar [300]. The following dialog box appears:

Figure 281. Select Column(s) dialog box

◦ Move the columns of a review type, which you want to display in the Historical
Reviews window, from Select Column(s) to Selected Column(s). In the above
figure, all columns for the Point view are moved to Selected Column(s), and
therefore, all the columns are displayed in the Historical Reviews window.
• Right-click a column heading to customize the data display in a column. You can
perform actions, such as sorting the data in ascending or descending order, best fit,
remove the column, filter editor, and so forth.

12.10 Dockable tabs

The Dockable tabs component contains dockable tabs for each review type, as shown in the
following figure:

Figure 282. Dockable tabs in the Historical Reviews window

Note
The SIS dockable tab is hidden by default.

306 OPH070
 Status bar

12.10.1 Customizing the view of the Dockable tabs

You can customize the view of the dockable tabs as follows:

• To customize the views to be visible as dockable tabs (including enabling the view of
the SIS dockable tab), click Select View(s) under the Select Views/Columns group in the
Home ribbon bar [300]. The following dialog box appears:

Figure 283. Select View(s) dialog box

◦ Move the views, which you want to display in the dockable tabs, from Choose
View(s) to Selected View(s). In the above figure, all views, except ASCII, are moved
to Selected View(s), and therefore, every view, except ASCII, has a corresponding
dockable tab.

12.11 Status bar

The Status bar displays the status of the Historical Review, as shown in the following figure.
The status is shown as a short text message.

Figure 284. Status bar of the Historical Reviews window

12.12 Setting preferences

The Preferences feature provides the opportunity for you to save various window settings
between sessions for various applications. After your application window settings are
complete, you may want to save those settings to your user profile instead of having to
perform the setting changes again at your next session.

OPH070 307
Performing a Historical Review

After preferences are saved, they will be automatically loaded whenever you access the
application window. The preferences are loaded for a session in the following order:

• User-defined preferences are requested first. You can save, load, and clear settings only
for your user profile.
• If user-defined preferences are not found, role-defined preferences are requested next.
An administrator can save, load, and clear settings for any role profiles, but he or she
cannot affect any user profile except his or her own.
• System preferences are requested next.
• If no preferences are defined, the system default settings are used.

See To use the Preferences option (from the Historical Review Menu button) and To use the
Historian Preferences option (from the Historical Review Menu button) [297] for
information about setting preferences in the Historical Reviews window.

12.13 Performing a Historical Review

You can use the Historical Reviews window to perform specific retrieval requests for point-
based and message-based historical data. These retrieval results or reviews are displayed on
a grid that allows you to regroup, sort, and filter the retrieval results. You can perform the
following reviews:

• Point review [308].

• Alarm review [312].
• Operator Event review [314].
• SOE review [318].
• SIS review [319].
• ASCII review [321].
• Common review [322].

12.13.1 To perform a Point review

The Point review is used to query and display historical process values and related status
information. The main review window displays a point's value at the time that it was
collected (when its deadband was exceeded or when its status changed). The display is
provided in a row and column format that lists the date, time, point name, alarm type, point
description, value, and status units for each change.

Use the following steps to perform a Point review:

1. Access the Historical Reviews window [288].

2. Click the Point dockable tab at the bottom of the window to access the Point review
window.
3. Use the Home [300] ribbon bar [300] to specify the general settings for the review.

308 OPH070
 Performing a Historical Review

4. Use the Filter [301] ribbon bar [301] to specify the filter criteria for the review. The
ribbon bar has the following groups:
• System: This group has the following option:
◦ Network/Unit: Use this option to select the network and unit filter for the
review.
• Characteristics/Group/Description/Point: This group has the following options:
◦ Characteristics: Use this option to specify characteristics for the review. Enter
characteristics individually or choose characteristics from the pre-defined
group. To enter characteristics individually, by position, select a position
number and a position value from the Character Position and Position Values
drop-down lists, respectively. To choose a pre-defined characteristics group,
select a group from the Characteristics drop-down list.
◦ Point Group: Use this option to specify a historian point group.
◦ Point/Description: Use this option to specify point name and description. You
can also specify wildcard character, *, as an input.
◦ Points: Use this option to specify or browse the points for the review.
◦ Data Filter: This group has options shown in following table.
• Table 58. Data Filter options

Option Fields Description

Value/Status Value/Status Change Retrieves all collected changes in value or status.
(VL)
Raw Values Retrieves the actual data as it was collected,
including duplicate data (heartbeat) where the
value or status has not changed.
Quality Good (GQ) Retrieves all collected changes when a point has
good quality.
Fair (FQ) Retrieves all collected changes when a point has fair
quality.
Bad (BQ) Retrieves all collected changes when a point has bad
quality.
Poor (PQ) Retrieves all collected changes when a point has
poor quality.
Timed Out (TQ) Retrieves occurrences when a point is timed-out.
Limit/Alarm Limit Alarms (LA) Retrieves occurrences when a point is removed from
limit or alarm checking.
Sensor Alarms (SA) Retrieves occurrences when a point reaches a sensor
alarm.
Sid Alarm (IA) Retrieves points in the Sid alarm.
Check/ Alarm Check Retrieves points for which an alarm checking has
Cutout Removed (AR) been disabled.
Cutout Condition Retrieves occurrences when a point was cut-out
Set (CO) from alarm checking.

OPH070 309
Performing a Historical Review

Option Fields Description

Limit Check Retrieves points for which limit checking has been
Removed (LR) disabled.
Alarm is Suppressed Retrieves points for which alarms are suppressed.
(XA)
Alarm Shelved (PS) Retrieves points for which alarms are shelved.
Reasons Entered Values (EV) Retrieves occurrences of operator-entered values.
External Calibration Retrieves points whose status indicates that
(EC) external calibration is set.
Scan Removed (SC) Retrieves occurrences when a point was removed
from scan.
Tagged Out (XO) Retrieves points whose status indicates that they are
tagged out.
Value Option Returned Values Retrieves values showing return from the selected
conditions, in addition to the samples that satisfy
other conditions.
Initial Values Retrieves the initial value from the start of the
chosen time range, in addition to the samples that
satisfy the other chosen conditions. This is the value
that was set for a point reaching the retrieval
specified time range. To select the Initial Values
check box, you must first select the Value/Status
Change check box.

5. After specifying the settings, start the Historical Review by using any of the following
steps:
• Using the Home [300] ribbon bar [300], click Begin in the Review group.
• Using the Quick Access Toolbar [300], click Begin.
6. The review results are displayed in the Historical Reviews window as follows:

310 OPH070
 Performing a Historical Review

Figure 285. Point review

Note
To stop an active Historical Review, click Stop, which is located in the Quick Access Toolbar
[300] and the Home [300] ribbon bar [300]. This button is enabled only when you start a
review. It may take a few seconds to terminate the review process.

12.13.2 Understanding the Point Status column

The following table describes the acronyms that appear in the Point Status column of
Historical Review application while performing a Point review

Table 59. Point Status Descriptions

Point Status Value Description

Engr. Range Limits (EL) Displays points that exceed the engineering range units.
Limit Alarms (LA) Displays points that went into alarm because a limit was exceeded.
Reasonability Limits (RL) Displays points that exceed the reasonability limits.
Value Clamp Limits (CL) Displays points that have the value clamped.
Sensor Alarms (SA) Displays points in sensor alarm.
SID Alarm (IA) Displays points in SID alarm.
Alarm Check Removed (AR) Displays points for which alarm checking has been disabled.

OPH070 311
Performing a Historical Review

Point Status Value Description

Cutout Disabled (CD) Displays points with the cut-out option manually disabled.
Cutout From Alarming (CO) Displays points that have been cut-out from alarm checking.
Engr. Range Check Off (EO) Displays points with the engineering range limit check disabled.
Limit Check Removed (LR) Displays points for which limit checking have been disabled.
Reasonability Check Off (RO) Displays points with reasonability limit check disabled.
Value Clamp Off (VO) Displays points that have value clamping disabled.
Entered Values (EV) Displays points that have an operator-entered value.
External Calibration (EC) Displays points that are externally calibrated.
Scan Removed (SC) Displays points that have been removed from scan.
Tagged Out (XO) Displays points that are tagged out.
Test Mode (TM) Displays points in the test mode (latched quality).
Uncommissioned (UC) Displays points that are uncommissioned.
Out of Service (OS) Displays points that are out of service.
Failed (FS) Displays points that have the Failed alert type suppressed.
Maintenance (MS) Displays points that have the Maintenance alert type suppressed.
Advisory (AS) Displays points that have the Advisory alert type suppressed.
Communication (CS) Displays points that have the Communication alert type suppressed.
Abnormal (NS) Displays points that have the Abnormal alert type Suppressed.
Unacknowledged (U) Displays points that are unacknowledged.
Unacknowledged Return (UR) Displays points that are unacknowledged and need reset.
Acknowledged Return (R) Displays points that are acknowledged and need reset.
Alarm Suppressed (XA) Displays points for which alarms are suppressed.
Point Shelve (PS) Displays points for which alarms are shelved.
Hardware Error (HE) Displays points with hardware errors.

12.13.3 To perform an Alarm review

The Alarm review is used to display, print, or save a filtered list of alarm messages that are
stored with the historian's alarm history. You can specify filters for alarms by using options,
such as alarm type, point type, and single point.

Use the following steps to perform an Alarm review:

1. Access the Historical Reviews window [288].

2. Click the Alarm dockable tab at the bottom of the window to access the Alarm review
window.
3. Use the Home [300] ribbon bar [300] to specify the general settings for the review.

312 OPH070
 Performing a Historical Review

4. Use the Filter [301] ribbon bar [301] to specify the filter criteria for the review. The
ribbon bar has the following groups:
• System: This group has the following option:
◦ Network/Unit: Use this option to select all networks or a single network or
unit as a filter option for the review.
• Originating Drop: This group has the following option:
◦ Drops: Use this option to select the drop ID for the review.
• Priority: This group has the following option:
◦ Priority: Use this option to select alarm priority. The range of alarm priority is
1-8.
• Filter Criteria: This group has the following options:
◦ Alarm Type: Use this option to select one or more alarm types for the review.
◦ Point Type: Use this option to select one or more point types for the review.
◦ Point: Use this option to enter or browse a point for the review.
5. After specifying the settings, start the Historical Review by using any of the following
steps:
• Using the Home [300] ribbon bar [300], click Begin in the Review group.
• Using the Quick Access Toolbar [300], click Begin.

OPH070 313
Performing a Historical Review

6. The review results are displayed in the Historical Reviews window as follows:

Figure 286. Alarm review

Note
To stop an active Historical Review, click Stop, which is located in the Quick Access
Toolbar [300] and the Home [300] ribbon bar [300]. This button is enabled only when
you start a review. It may take a few seconds to terminate the review process.

12.13.4 To perform an Operator Event review

The Operator Event review is used to filter a chronological list of operator event messages
by time period, originating workstation, or event type. In addition, this review allows you to
focus on actions taken during a specific time period and can help you decide whether
human interaction preceded a particular plant event.

Use the following steps to perform an Operator Event review:

1. Access the Historical Reviews window [288].

2. Click the Operator Event dockable tab at the bottom of the window to access the
Operator Event review window.
3. Use the Home [300] ribbon bar [300] to specify the general settings for the review.

314 OPH070
 Performing a Historical Review

4. Use the Filter [301] ribbon bar [301] to specify the filter criteria for the review. The
ribbon bar has the following groups:
• System: This group has the following option:
◦ Network/Unit: Use this option to select all networks or a single network or
unit as a filter option for the review.
• Originating Drop: This group has the following option:
◦ Drops: Use this option to select the drop ID for the review.
• User Detail: This group has the following option:
◦ Domain User Name: Use this option to specify the domain and user name of
the Ovation user that initiated the operator event action.
• Reason Detail: This group has the following option:
◦ Reasons: Use this option to specify the reason as a search criteria for the
review.
• Filter Criteria: This group has the following options:
◦ Groups: Use this option to select one or more groups for the review.
◦ SubTypes: Use this option to select one or more subtypes for the review.
◦ Point: Use this option to enter or browse a point for the review.
5. After specifying the settings, start the Historical Review by using any of the following
steps:
• Using the Home [300] ribbon bar [300], click Begin in the Review group.
• Using the Quick Access Toolbar [300], click Begin.

OPH070 315
Performing a Historical Review

6. The review results are displayed in the Historical Reviews window as follows:

Figure 287. Operator Event review

Note
To stop an active Historical Review, click Stop, which is located in the Quick Access
Toolbar [300] and the Home [300] ribbon bar [300]. This button is enabled only when
you start a review. It may take a few seconds to terminate the review process.

12.13.5 Understanding Operator Event Messages

Certain Operator Station applications report user-specified actions to other drops in the
Ovation system in the form of Operator Event Messages. For example, if an operator makes
a change to a point, such as setting it to Limit Check Off, that action generates an event
message so that other drops in the system are aware of the change.

Operator Event Messages are saved at an Ovation historian drop and can be viewed through
the historian's Operator Event Review application [314].

Only certain Operator Station applications and specific operator actions generate operator
event messages. The applications that can issue an Operator Event message are:

• Alarms
• Graphics
• Point Information
• Point Review

316 OPH070
 Performing a Historical Review

• Signal Viewer
• System Viewer
• Trends
• Historical Review

Operator Event Messages are also generated when a user logs on and logs out from a drop.

In addition, some actions can be issued from more than one Operator Station application.
For example, the Scan On action can be performed in the Alarm, Point Information,
Graphics, and System Viewer subsystems.

The following table displays the list of actions that generate Operator Event messages.

Table 60. Actions that generate Operator Event messages

Commands that generate Operator Event messages

Scan On
Scan Off
Alarm Check On
Alarm Check Off
Limit Check On
Limit Check Off
Auto Cutout Disabled
Auto Cutout Enabled
Alarm Acknowledge (the Send Alarm Event Message parameter must be selected in the MMI Config
window in the Ovation Developer Studio. (Refer to the Ovation Operator Station Configuration
Guide for more information.)
Alarm Reset (the Send Alarm Event Message parameter must be selected in the MMI Config window
in the Ovation Developer Studio. (Refer to the Ovation Operator Station Configuration Guide for
more information.)
Test Mode On
Test Mode Off
Latched Quality Good
Latched Quality Fair
Latched Quality Poor
Latched Quality Bad
Value Clamp On
Value Clamp Off
Engineering Check On
Engineering Check Off
Reasonability Check On
Reasonability Check Off
Entered Value

OPH070 317
Performing a Historical Review

Commands that generate Operator Event messages

When any of the limits of an analog or deluxe analog are changed
Set Force
Clear Force
Set all Force Bits
Clear All Force Bits
Confirm Commission Request
Confirm Uncommission Request
Mode Change TO FROM, where TO and FROM are AUTO, CASC, or MANUAL

Note
For more information about Operator Event Messages generated from graphics application
programs, refer to the Ovation Graphics Language Reference Manual.

12.13.6 To perform an SOE review

The SOE review is used to view the SOE messages that are generated throughout an Ovation
system and stored by the historian. You can identify high-speed digital state changes that
may have been initiated or resulted from an interesting process incident. You can refine
your search on the basis of filter criteria, including particular point name, originating unit, or
controller.

Use the following steps to perform an SOE review:

1. Access the Historical Reviews window [288].

2. Click the SOE dockable tab at the bottom of the window to access the SOE review
window.
3. Use the Home [300] ribbon bar [300] to specify the general settings for the review.
4. Use the Filter [301] ribbon bar [301] to specify the filter criteria for the review. The
ribbon bar has the following groups:
• System: This group has the following option:
◦ Network/Unit: Use this option to select all networks or a single network or
unit as a filter option for the review.
• Filter Criteria: This group has the following options:
◦ All: Use this option if you want to review all SOE messages.
◦ Drops: Use this option to select the drop ID for the review.
◦ Point: Use this option to enter or browse a point for the review.
5. After specifying the settings, start the Historical Review by using any of the following
steps:
• Using the Home [300] ribbon bar [300], click Begin in the Review group.
• Using the Quick Access Toolbar [300], click Begin.

318 OPH070
 Performing a Historical Review

6. The review results are displayed in the Historical Reviews window as follows:

Figure 288. SOE review

Note
To stop an active Historical Review, click Stop, which is located in the Quick Access
Toolbar [300] and the Home [300] ribbon bar [300]. This button is enabled only when
you start a review. It may take a few seconds to terminate the review process.

12.13.7 To perform an SIS review

The SIS review is used to view SIS messages that are transmitted from SIS data servers. By
default, the SIS review tab is hidden. To view the SIS dockable tab, click Select View(s) in the
Select Views/Columns group in the Home [300] ribbon bar [300], and then move the SIS
view from Choose View(s) to Selected View(s).

Use the following steps to perform an SIS review:

1. Access the Historical Reviews window [288].

2. Click the SIS dockable tab at the bottom of the window to access the SIS review
window.
3. Use the Home [300] ribbon bar [300] to specify the general settings for the review.

OPH070 319
Performing a Historical Review

4. Use the Filter [301] ribbon bar [301] to specify the filter criteria for the review. The
ribbon bar has the following groups:
• System: This group has the following option:
◦ Network/Unit: Use this option to select all networks or a single network or
unit as a filter option for the review.
• Originating Drop: This group has the following option:
◦ Drops: Use this option to select the drop ID for the review.
5. After specifying the settings, start the Historical Review by using any of the following
steps:
• Using the Home [300] ribbon bar [300], click Begin in the Review group.
• Using the Quick Access Toolbar [300], click Begin.
6. The review results are displayed in the Historical Reviews window as follows:

Figure 289. SIS review

Note
To stop an active Historical Review, click Stop, which is located in the Quick Access
Toolbar [300] and the Home [300] ribbon bar [300]. This button is enabled only when
you start a review. It may take a few seconds to terminate the review process.

320 OPH070
 Performing a Historical Review

12.13.8 To perform an ASCII review

The ASCII review is used to retrieve ASCII messages, which are generated by users, and
occur on all workstations or a single workstation.

Use the following steps to perform an ASCII review:

1. Access the Historical Reviews window [288].

2. Click the ASCII dockable tab at the bottom of the window to access the ASCII review
window.
3. Use the Home [300] ribbon bar [300] to specify the general settings for the review.
4. Use the Filter [301] ribbon bar [301] to specify the filter criteria for the review. The
ribbon bar has the following groups:
• System: This group has the following option:
◦ Network/Unit: Use this option to select all networks or a single network or
unit as a filter option for the review.
• Originating Drop: This group has the following option:
◦ Drops: Use this option to select the drop ID for the review.
5. After specifying the settings, start the Historical Review by using any of the following
steps:
• Using the Home [300] ribbon bar [300], click Begin in the Review group.
• Using the Quick Access Toolbar [300], click Begin.

OPH070 321
Performing a Historical Review

6. The review results are displayed in the Historical Reviews window as follows:

Figure 290. ASCII review

Note
To stop an active Historical Review, click Stop, which is located in the Quick Access
Toolbar [300] and the Home [300] ribbon bar [300]. This button is enabled only when
you start a review. It may take a few seconds to terminate the review process.

12.13.9 To perform a Common review

The Common review is used to display one or more types of review data in a single view.

Use the following steps to perform a Common review:

1. Access the Historical Reviews window [288].

2. Click the Common dockable tab at the bottom of the window to access the Common
review window.
3. Use the Home [300] ribbon bar [300] to specify the general settings for the review.

322 OPH070
 Using command line options to perform a historical review

4. Use the Filter [301] ribbon bar [301] to specify the filter criteria for the review, which
may include the following steps:
• Use the Review group to specify the review types you want to include or exclude
from the Common review.
• Use the Point, Alarm, Operator Event, SOE, ASCII, and SIS groups to specify the
filter settings for each review type.
• Use the Message Systems group to select all networks or a single network or unit
as a filter option for the review.
5. After specifying the settings, start the Historical Review by using any of the following
steps:
• Using the Home [300] ribbon bar [300], click Begin in the Review group.
• Using the Quick Access Toolbar [300], click Begin.
6. The review results are displayed in the Historical Reviews window as follows:

Figure 291. Common review

Note
To stop an active Historical Review, click Stop, from the Quick Access Toolbar [300] and
the Home [300] ribbon bar [300]. This button is enabled only when you start a review.
It may take a few seconds to terminate the review process.

12.14 Using command line options to perform a

historical review
You may use the command line options (from the Command Prompt window) to perform a
historical review.

Syntax
[Link] [/help] |

OPH070 323
Using command line options to perform a historical review

[/setting “configuration-file-name”] |

[/loadfile “configuration-file-name”] |

[/execute]

{ [/historian “default_or_historian_string”]

[/duration PreviousHour|CurrentHour|Today|CurrentWeek|

Past10Min|Past30Min|Past60Min|Past2Hour|

Past1Day|Past2Day|Past7Day|Past14Day]

{ /filter-point <point-filter-option> |

/filter-alarm <alarm-filter-option> |

/filter-ope <operator-event-filter-option> |

/filter-ascii <ascii-filter-option> |

/filter-soe <soe-filter-option> |

/filter-sis <sis-filter-option>

See the following sections for examples and descriptions of these options.

12.14.1 To run a Point review from the Command Prompt

window
Use the /filter-point parameter to run a Point review from the Command Prompt
window.

Syntax
/filter-point

Example
The following example illustrates a command to run a Point review from the Command
Prompt window:

[Link] /historian default /duration Past1Day /filter-

point /pointnames D12_MNET_DA01.unit0@OV350

Note
See To specify point filter criteria from the Command Prompt window [332] for more
information.

324 OPH070
 Using command line options to perform a historical review

12.14.2 To run an Alarm review from the Command Prompt

window
Use the /filter-alarm parameter to run an Alarm review from the Command Prompt
window.

Syntax
/filter-alarm

Example
The following example illustrates a command to run an Alarm review from the Command
Prompt window:

[Link] /historian default /duration PreviousHour /filter-

alarm /pointname "D12_MNET_LA01_S"

Note
See To specify alarm filter criteria from the Command Prompt window [335] for more
information.

12.14.3 To run an Operator Event review from the Command

Prompt window
Use the /filter-ope parameter to run an Operator Event review from the Command
Prompt window.

Syntax
/filter-ope

Example
The following example illustrates a command to run an Operator Event review from the
Command Prompt window:

[Link] /historian default /duration Past1Day /filter-ope /

pointname "D12_MNET_LA01_S"

Note
See To specify operator event filter criteria from the Command Prompt window [337] for
more information.

12.14.4 To run an ASCII review from the Command Prompt

window
Use the /filter-ascii parameter to run an ASCII review from the Command Prompt
window.

Syntax
/filter-ascii

OPH070 325
Using command line options to perform a historical review

Example
The following example illustrates a command to run an ASCII review from the Command
Prompt window:

[Link] /historian default /duration Past1Day /filter-

ascii /networkunit "OV350/UNIT0"

Note
See To specify ASCII filter criteria from the Command Prompt window [339] for more
information.

12.14.5 To run an SOE review from the Command Prompt

window
Use the /filter-soe parameter to run an SOE review from the Command Prompt
window.

Syntax
/filter-soe

Example
The following example illustrates a command to run an SOE review from the Command
Prompt window:

[Link] /historian default /duration Past1Day /filter-soe /

pointname "D23-SOFTSOE02"

Note
See To specify SOE filter criteria from the Command Prompt window [340] for more
information.

12.14.6 To run an SIS review from the Command Prompt window

Use the /filter-sis parameter to run an SIS review from the Command Prompt
window.

Syntax
/filter-sis

Example
The following example illustrates a command to run an SIS review from the Command
Prompt window:

[Link] /historian default /duration Past1Day /filter-sis /

networkunit "FE350C/UNIT0"

326 OPH070
 Using command line options to perform a historical review

Note
See To specify SIS filter criteria from the Command Prompt window [341] for more
information.

12.14.7 To open the online help from the Command Prompt

window
Use the /help parameter to open the online help from the Command Prompt window.

Syntax
/help

Example
The following example illustrates a command to open the online help from the Command
Prompt window:

[Link] /help

12.14.8 To verify configuration settings from the Command

Prompt window
Use the /setting parameter to verify configuration settings from the Command Prompt
window.

Syntax
/setting <configuration-file-name>

Where:

• <configuration-file-name>: Name of the configuration file for system, role, or

user based historical review application.

Examples
The following example illustrates a command to verify the Administrator role settings from
the Command Prompt window:

[Link] /setting Role:Admin:[Link]

The following example illustrates a command to verify the Engineer role settings from the
Command Prompt window:

[Link] /setting Role:engineer:[Link]

The following example illustrates a command to verify the Operator role settings from the
Command Prompt window:

[Link] /setting Role:operator:[Link]

The following example illustrates a command to verify the settings for other available users
from the Command Prompt window:

[Link] /setting “valid configuration file name”

OPH070 327
Using command line options to perform a historical review

12.14.9 To load a configuration file from the Command Prompt

window
Use the /loadfile parameter to load a configuration file from the Command Prompt
window.

Syntax
/loadfile <configuration-file-name>

Where:

• <configuration-file-name>: Name of the configuration file for system, role, or

user based historical review application.

Example
The following example illustrates a command to load the configuration file [Link] from
the Command Prompt window:

[Link] /loadfile C:\Ovation\AppDocs\U-Administrator

\F8880A38-5FA4-48cb-911A-845FBD48C028\ [Link]

12.14.10 To execute a review query directly from the Command

Prompt window
Use the /execute parameter to execute a review query directly from the Command
Prompt window.

Note
If you do not use the execute parameter, you must manually run the review once the
Historical Review window appears with the configuration settings. If you specify the
execute parameter, the filter criteria is loaded and executed in the Historical Review
window.

Syntax
/execute

Examples
The following examples illustrate commands to execute arguments directly from the
Command Prompt window:

[Link] /execute /setting Role:Admin:[Link]

[Link] /execute /loadfile C:\Ovation\AppDocs\U-

Administrator\F8880A38-5FA4-48cb-911A-845FBD48C028\ [Link]

[Link] /historian default /duration Past1Day /execute /

filter-point /pointdesc

[Link] /execute /historian default /duration Past1Day /

filter-alarm /priority "2,8"

328 OPH070
 Using command line options to perform a historical review

[Link] /execute /historian default /duration Past1Day /

execute /filter-ope /drops ""

[Link] /execute /historian default /duration Past1Day /

filter-ASCII /DROPS ""

[Link] /execute /historian default /duration Past1Day /

filter-soe /pointname "D23-SOFTSOE02"

[Link] /execute /historian default /duration Past1Day /

filter-sis /drops ""

12.14.11 To specify a historian name from the Command Prompt

window
Use the /historian parameter to specify a historian name from the Command Prompt
window. If you do not specify a historian, the default or auto-historian is used.

Syntax
/historian "default_or_historian_string"

Example
The following examples illustrate commands to specify an available historian drop X from
the Command Prompt window:

[Link] /historian dropX /duration Past1Day /filter-point /

pointnames D12_MNET_DA01.unit0@OV350

[Link] /historian dropX /duration PreviousHour /filter-

alarm /pointname "D12_MNET_LA01_S"

[Link] /historian dropX /duration Past1Day /filter-ope /

pointname "D12_MNET_LA01_S"

The following examples illustrate commands to specify available historian redundant drop
A/dropB from the Command Prompt window:

[Link] /historian dropA/dropB /duration Past1Day /filter-

point /pointnames D12_MNET_DA01.unit0@OV350

[Link] /historian dropA/dropB /duration PreviousHour /

filter-alarm /pointname "D12_MNET_LA01_S"

[Link] /historian dropA/dropB /duration Past1Day /filter-

ope /pointname "D12_MNET_LA01_S"

The following examples illustrate commands to specify the default historian drop from the
Command Prompt window:

[Link] /historian default /duration Past1Day /filter-

point /pointnames D12_MNET_DA01.unit0@OV350

[Link] /historian default /duration PreviousHour /filter-

alarm /pointname "D12_MNET_LA01_S"

OPH070 329
Using command line options to perform a historical review

[Link] /historian default /duration Past1Day /filter-ope /

pointname "D12_MNET_LA01_S"

12.14.12 To specify duration of review from the Command Prompt

window
Use the /duration parameter to specify duration of review from the Command Prompt
window.

Syntax
/duration PreviousHour|CurrentHour|Today|CurrentWeek|Past10Min|

Past30Min|Past2Hour|Past1Day|Past2Day|

Past7Day|Past14Day

Note
Default value is Past1Day, which is 24 hours.

Examples
The following examples illustrate commands to specify duration of default value of 24 hours
from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-

point /pointnames D12_MNET_DA01.unit0@OV350

[Link] /historian default /duration Past1Day /filter-

alarm /pointname "D12_MNET_LA01_S"

[Link] /historian default /duration Past1Day /filter-ope /

pointname "D12_MNET_LA01_S"

The following examples illustrate commands to specify duration of previous hour from the
Command Prompt window:

[Link] /historian default /duration PreviousHour /filter-

point /pointnames D12_MNET_DA01.unit0@OV350

[Link] /historian default /duration PreviousHour /filter-

alarm /pointname "D12_MNET_LA01_S"

[Link] /historian default /duration PreviousHour /filter-

ope /pointname "D12_MNET_LA01_S"

The following examples illustrate commands to specify duration of current hour from the
Command Prompt window:

[Link] /historian default /duration CurrentHour /filter-

point /pointnames D12_MNET_DA01.unit0@OV350

[Link] /historian default /duration CurrentHour /filter-

alarm /pointname "D12_MNET_LA01_S"

330 OPH070
 Using command line options to perform a historical review

[Link] /historian default /duration CurrentHour /filter-

ope /pointname "D12_MNET_LA01_S"

The following examples illustrate commands to specify duration of today from the
Command Prompt window:

[Link] /historian default /duration Today /filter-point /

pointnames D12_MNET_DA01.unit0@OV350

[Link] /historian default /duration Today /filter-alarm /

pointname "D12_MNET_LA01_S"

[Link] /historian default /duration Today /filter-ope /

pointname "D12_MNET_LA01_S"

The following examples illustrate commands to specify duration of current week from the
Command Prompt window:

[Link] /historian default /duration CurrentWeek /filter-

point /pointnames D12_MNET_DA01.unit0@OV350

[Link] /historian default /duration CurrentWeek /filter-

alarm /pointname "D12_MNET_LA01_S"

[Link] /historian default /duration CurrentWeek /filter-

ope /pointname "D12_MNET_LA01_S"

The following examples illustrate commands to specify duration of past 10 minutes from
the Command Prompt window:

[Link] /historian default /duration Past10Min /filter-

point /pointnames D12_MNET_DA01.unit0@OV350

[Link] /historian default /duration Past10Min /filter-

alarm /pointname "D12_MNET_LA01_S"

[Link] /historian default /duration Past10Min /filter-

ope /pointname "D12_MNET_LA01_S"

The following examples illustrate commands to specify duration of past 30 minutes from
the Command Prompt window:

[Link] /historian default /duration Past30Min /filter-

point /pointnames D12_MNET_DA01.unit0@OV350

[Link] /historian default /duration Past30Min /filter-

alarm /pointname "D12_MNET_LA01_S"

[Link] /historian default /duration Past30Min /filter-

ope /pointname "D12_MNET_LA01_S"

The following examples illustrate commands to specify duration of past 2 hours from the
Command Prompt window:

[Link] /historian default /duration Past2Hour /filter-

point /pointnames D12_MNET_DA01.unit0@OV350

OPH070 331
Using command line options to perform a historical review

[Link] /historian default /duration Past2Hour /filter-

alarm /pointname "D12_MNET_LA01_S"

[Link] /historian default /duration Past2Hour /filter-

ope /pointname "D12_MNET_LA01_S"

The following examples illustrate commands to specify duration of past 2 days from the
Command Prompt window:

[Link] /historian default /duration Past2Day /filter-

point /pointnames D12_MNET_DA01.unit0@OV350

[Link] /historian default /duration Past2Day /filter-

alarm /pointname "D12_MNET_LA01_S"

[Link] /historian default /duration Past2Day /filter-ope /

pointname "D12_MNET_LA01_S"

The following examples illustrate commands to specify duration of past 7 days from the
Command Prompt window:

[Link] /historian default /duration Past7Day /filter-

point /pointnames D12_MNET_DA01.unit0@OV350

[Link] /historian default /duration Past7Day /filter-

alarm /pointname "D12_MNET_LA01_S"

[Link] /historian default /duration Past7Day /filter-ope /

pointname "D12_MNET_LA01_S"

The following examples illustrate commands to specify duration of past 14 days from the
Command Prompt window:

[Link] /historian default /duration Past14Day /filter-

point /pointnames D12_MNET_DA01.unit0@OV350

[Link] /historian default /duration Past14Day /filter-

alarm /pointname "D12_MNET_LA01_S"

[Link] /historian default /duration Past14Day /filter-

ope /pointname "D12_MNET_LA01_S"

12.14.13 To specify point filter criteria from the Command Prompt

window
Use the /filter-point parameter with other arguments to specify point filter criteria
from the Command Prompt window.

Syntax
/filter-point [/networkunit “netunit”]

{ [/characteristics “xxxxxxxx”] |

[/pointgroup “pointgroupname”]|

[/pointdesc “pointdescription”] |

332 OPH070
 Using command line options to perform a historical review

[/pointnames “pointname-list”]

} [/data-filter “data-filter-string”]

Where:

• [/networkunit “netunit”]: Indicates a network unit string, for example,

"OVA350/UNIT0". If you do not specify network unit, the default network unit of the
Ovation network is used.
• [/characteristics “xxxxxxxx”]: Indicates an eight-character string, for
example, “--------”.
• [/pointgroup “pointgroupname”]: Indicates a historical review point group.
• [/pointdesc “pointdescription”]: Indicates a point name or point
description string, for example, “LA001*/*”.
• [/pointnames “pointname-list”]: Indicates a comma-separated point
name(s).
• {/data-filter “data-filter-string”}: Indicates a comma-separated data
filter, for example, “VL”, “Raw Values, Initial Values”,
“GQ,FQ,PQ,BQ,TQ,LA,SA,IA,AR,CO,LR,EV,EC,SC,XO,XA,PS, Returned Values, Initial
Values”.

Note
If you do not specify /characteristics, /pointgroup, /pointdesc, or /
pointnames, an error is returned upon execution.

Note
If you do not specify /data-filter, the default filter is VL.

Examples
The following example illustrates a command to specify the point filter criteria of Ovation
networks and units from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-

point /networkunit FE350C/UNIT0 /characteristics "SMOKETST"

The following example illustrates a command to specify the point filter criteria of
characteristics from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-

point /characteristics "S-------"

When /characteristics is not specified, the default point filter criteria is “ ”. The
following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-

point /characteristics ""

The following example illustrates a command to specify the point filter criteria of point
groups from the Command Prompt window:

OPH070 333
Using command line options to perform a historical review

[Link] /historian default /duration Past1Day /filter-

point /pointgroup "OPH-HR"

When /pointgroup is not specified, the default point filter criteria is “ ”. The following
example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-

point /pointgroup ""

The following example illustrates a command to specify the point filter criteria of point
description from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-

point /pointdesc "TEST"

When /pointdesc is not specified, the default point filter criteria is " ". The following
example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-

point /pointdesc ""

The following example illustrates a command to specify the point filter criteria of point
name from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-

point /pointnames "d32_mnet_la01_s, d32_mnet_ld01

_s,d32_mnet_lp01_s"

When /pointname is not specified, the default point filter criteria is " ". The following
example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-

point /pointnames "”

The following examples illustrate commands to specify the point filter criteria of data filter
from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-

point /characteristics "--------” /data-filter “VL”

[Link] /historian default /duration Past1Day /filter-

point /pointnames "” /data-filter “Raw Values, Initial Values”

[Link] /historian default /duration Past1Day /filter-

point /pointnames "” /data-filter “GQ, FQ, PQ, BQ, TQ, LA, SA, IA,
AR, CO, LR, EV, EC, SC, XO, XA, PS, Returned Values, Initial
Values”

When /data-filter is not specified, the default filter is "VL". The following example
illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-

point /pointnames "” /data-filter “”

334 OPH070
 Using command line options to perform a historical review

12.14.14 To specify alarm filter criteria from the Command Prompt

window
Use the /filter-alarm parameter with other arguments to specify alarm filter criteria
from the Command Prompt window.

Syntax
/filter-alarm [/networkunit “netunit”] [/drop “drops-list”] [/
priority “priority-list”]

{ [/alarmtype “alarm-type-list”]|[/pointtype “point-type-list”]|

[/pointname “pointname”]

Where:

• [/networkunit “netunit”]: Indicates a network unit string, for example,

"OVA350/UNIT0". Default value is "", which means "Select All Networks".
• [/drop “drops-list”]: Indicates comma-separated drops. Default value is "",
which means “All Drops”. For example, “Drop1, Drop2”, “”.
• [/priority “priority-list”]: Indicates comma-separated priority string. For
example, “2, 3, 5”. Default value is “Disable Priority”.
• [/alarmtype “alarm-type-list”]: Indicates comma-separated alarm type. For
example, “RETURN, SENSOR”.
• [/pointtype “point-type-list”]: Indicates comma-separated point type. For
example, “LA,LD,LP,DU,RM”.
• [/pointname “pointname”]: Indicates a point name string to search.

Note
If you do not specify /alarmtype, /pointtype, or /pointname, the filter criteria /
pointname “” is equivalent to point name wildcard character (*).

Examples
The following example illustrates a command to specify the alarm filter criteria of Ovation
networks and units from the Command Prompt window:

[Link] /historian default /duration /Past1Day /filter-

alarm /networkunit OV350/UNIT0

When /networkunit is not specified, the default alarm filter criteria is “ ”, that is, "Select
All Networks". The following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-

alarm /networkunit “"

The following example illustrates a command to specify the alarm filter criteria of drops list
from the Command Prompt window:

OPH070 335
Using command line options to perform a historical review

[Link] /historian default /duration Past1Day /filter-

alarm /drops "drop12, drop29"

When /drop is not specified, the default alarm filter criteria is “ ”, that is, "All Drops". The
following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-

alarm /drops "”

The following example illustrates a command to specify the alarm filter criteria of priority
list from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-

alarm /priority "2,8"

When /priority is not specified, the default alarm filter criteria is “ ”, that is, "Disable
Priority". The following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-

alarm /priority ""

The following example illustrates a command to specify the alarm filter criteria of alarm
type from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-

alarm /alarmtype "HIGH,RETURN, SENSOR ”

When /alarmtype is not specified, the default alarm filter criteria is “ ”, that is, equivalent
to point name wildcard character (*). The following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-

alarm /alarmtype ""

The following example illustrates a command to specify the alarm filter criteria of point type
from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-

alarm /pointtype "LP, DP"

When /pointtype is not specified, the default alarm filter criteria is “ ”, that is, equivalent
to point name wildcard character (*). The following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-

alarm /pointtype ""

The following example illustrates a command to specify the alarm filter criteria of point
name from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-

alarm /pointname "D12_MNET_DP01_F"

When /pointname is not specified, the default alarm filter criteria is “ ”, that is, equivalent
to point name wildcard character (*). The following example illustrates this scenario:

[Link] /historian default /duration PreviousHour /filter-

alarm /pointname ""

336 OPH070
 Using command line options to perform a historical review

The following example illustrates a command to specify the alarm filter criteria of point
name (wildcard *) from the Command Prompt window:

[Link] /historian default /duration PreviousHour /filter-

alarm /pointname "D12_MNET_L*"

The following example illustrates a command to specify the alarm filter criteria of point
name (wildcard %) from the Command Prompt window:

[Link] /historian default /duration Past30Min /filter-

alarm /pointname "D12_MNET_LA%"

The following example illustrates a command to specify the alarm filter criteria of point
name (wildcard single character match) from the Command Prompt window:

[Link] /historian default /duration Past30Min /filter-

alarm /pointname "D12_MNET_LA01_?"

12.14.15 To specify operator event filter criteria from the

Command Prompt window
Use the /filter-ope parameter with other arguments to specify operator event filter
criteria from the Command Prompt window.

Syntax
/filter-ope [/networkunit “netunit”] [/drop “drop-list”]

[/domain “domainname”] [/username “username”]

{ [/group “group-list”]|[/subtype “subtype-list”]|

[/pointname “pointname”]

Where:

• [/networkunit “netunit”]: Indicates a network unit string, for example,

"OVA350/UNIT0". Default value is "", which means "Select All Networks".
• [/drop “drop-list”]: Indicates comma-separated drops. Default value is "",
which means “All Drops”. For example, “Drop1, Drop2”, “”.
• [/domain “domainname”]: Indicates the domain name.
• [/username “username”]: Indicates the user name.
• [/group “group-list”]: Indicates comma-separated groups. For example,
“Alarm Limit, Controller Action”.
• [/subtype “subtype-list”]: Indicates comma-separated sub types. For
example, “Scan Off, Scan On”.
• [/pointname “pointname”]: Indicates a point name string to search.

Note
If /group, /subtype, or /pointname is not specified, an error is returned upon
execution.

OPH070 337
Using command line options to perform a historical review

Examples
The following example illustrates a command to specify the operator event filter criteria of
Ovation networks and units from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-ope /

networkunit "OV350/UNIT0"

When /networkunit is not specified, the default operator event filter criteria is “ ”, that is,
"Select All Networks". The following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-ope /

networkunit "”

The following example illustrates a command to specify the operator event filter criteria of
drops list from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-ope /

drops "drop160"

When /drop is not specified, the default operator event filter criteria is “ ”, that is, "All
Drops". The following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-ope /

drops ""

The following example illustrates a command to specify the operator event filter criteria of
group list from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-ope /

GROUP "Alarm Limit, Controller Action, Value Change"

When /group is not specified, the default operator event filter criteria is “ ”, that is,
equivalent to point name wildcard character (*). The following example illustrates this
scenario:

[Link] /historian default /duration Past1Day /filter-ope /

GROUP "”

The following example illustrates a command to specify the operator event filter criteria of
sub type from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-ope /

SUBTYPE "VALUE ENTER, SCAN OFF, SCAN ON"

When /subtype is not specified, the default operator event filter criteria is “ ”, that is,
equivalent to point name wildcard character (*). The following example illustrates this
scenario:

[Link] /historian default /duration Past1Day /filter-ope /

SUBTYPE ""

The following example illustrates a command to specify the operator event filter criteria of
point name from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-ope /

POINTNAME "D12_MNET_LA01_S"

338 OPH070
 Using command line options to perform a historical review

When /pointname is not specified, the default operator event filter criteria is “ ”, that is,
equivalent to point name wildcard character (*). The following example illustrates this
scenario:

[Link] /historian default /duration Past1Day /filter-ope /

POINTNAME ""

The following example illustrates a command to specify the operator event filter criteria of
point name (wildcard *) from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-ope /

POINTNAME "D12_*"

The following example illustrates a command to specify the operator event filter criteria of
point name (wildcard %) from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-ope /

POINTNAME "D12_%"

The following example illustrates a command to specify the operator event filter criteria of
point name (wildcard single character match) from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-ope /

POINTNAME "D12_?"

12.14.16 To specify ASCII filter criteria from the Command Prompt

window
Use the /filter-ascii parameter with other arguments to specify ASCII filter criteria
from the Command Prompt window.

Syntax
/filter-ascii [/networkunit “netunit”] [/drop “drop-list”]

Where:

• [/networkunit “netunit”]: Indicates a network unit string, for example,

"OVA350/UNIT0". Default value is "", which means "Select All Networks".
• [/drop “drop-list”]: Indicates comma-separated drops. Default value is "",
which means “All Drops”. For example, “Drop1, Drop2”, “”.

Examples
The following example illustrates a command to specify the ASCII filter criteria of Ovation
networks and units from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-

ascii /networkunit "OV350/UNIT0"

When /networkunit is not specified, the default ASCII filter criteria is “ ”, that is, "Select
All Networks". The following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-

ascii /networkunit ""

OPH070 339
Using command line options to perform a historical review

The following example illustrates a command to specify the ASCII filter criteria of drops list
from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-

ascii /DROPS "DROP160"

When /drop is not specified, the default ASCII filter criteria is “ ”, that is, "All Drops". The
following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-

ascii /DROPS ""

12.14.17 To specify SOE filter criteria from the Command Prompt

window
Use the /filter-soe parameter with other arguments to specify SOE filter criteria from
the Command Prompt window.

Syntax
/filter-soe [/networkunit “netunit”] [/drop “drop-list”] [/
pointname “pointname”]

Where:

• [/networkunit “netunit”]: Indicates a network unit string, for example,

"OVA350/UNIT0". Default value is "", which means "Select All Networks".
• [/drop “drop-list”]: Indicates comma-separated drops. Default value is "",
which means “All Drops”. For example, “Drop1, Drop2”, “”.
• [/pointname “pointname”]: Indicates a point name string to search.

Note
If either of /drop or /pointname is not specified, the All button option is used as the
selected filter criteria.

Examples
The following example illustrates a command to specify the SOE filter criteria of Ovation
networks and units from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-soe /

networkunit "OV350/UNIT0"

When /networkunit is not specified, the All button options are used as search criteria.
The following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-soe /

networkunit “"

The following example illustrates a command to specify the SOE filter criteria of drops list
from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-soe /

DROPS "DROP23"

340 OPH070
 Using command line options to perform a historical review

When /drop is not specified, the All button options are used as search criteria. The
following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-soe /

DROPS ""

The following example illustrates a command to specify the SOE filter criteria of point name
from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-soe /

pointname "D23-SOFTSOE02"

When /pointname is not specified, the All button options are used as search criteria. The
following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-soe /

pointname ""

The following example illustrates a command to specify the SOE filter criteria of point name
(wildcard *) from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-soe /

pointname "D23-*"

The following example illustrates a command to specify the SOE filter criteria of point name
(wildcard %) from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-soe /

pointname "D23-SOFT%"

The following example illustrates a command to specify the SOE filter criteria of point name
(wildcard single character match) from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-soe /

pointname "D23-SOFTSOE?"

12.14.18 To specify SIS filter criteria from the Command Prompt

window
Use the /filter-sis parameter with other arguments to specify SIS filter criteria from
the Command Prompt window.

Syntax
/filter-sis [/networkunit “netunit”] [/ d rop “drop-list”]

Where:

• [/networkunit “netunit”]: Indicates a network unit string, for example,

"OVA350/UNIT0". Default value is "", which means "Select All Networks".
• [/drop “drop-list”]: Indicates comma-separated drops. Default value is "",
which means “All Drops”. For example, “Drop1, Drop2”, “”.

Examples
The following example illustrates a command to specify the SIS filter criteria of Ovation
networks and units from the Command Prompt window:

OPH070 341
To view edited historical data from a Historical Review

[Link] /historian default /duration Past1Day /filter-sis /

networkunit "FE350C/UNIT0"

When /networkunit is not specified, the default SIS filter criteria is “ ”, that is, "Select All
Networks". The following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-sis /

networkunit ""

The following example illustrates a command to specify the SIS filter criteria of drops list
from the Command Prompt window:

[Link] /historian default /duration Past1Day /filter-sis /

drops "drop23,drop34"

When /drop is not specified, the default SIS filter criteria is “ ”, that is, "All Drops". The
following example illustrates this scenario:

[Link] /historian default /duration Past1Day /filter-sis /

drops ""

12.15 To view edited historical data from a Historical

Review
After you have performed a Point review, you can compare data between the original value
of a point and the latest value of that point. You can also display a pencil icon next to any
data that has been edited.

Use the following steps to view the edited historical data from the Historical Reviews
window:

1. Perform a Historical Review, for example, Point review [308]. The Historical Reviews
window appears:

Figure 292. Point review

342 OPH070
 To view edited historical data from a Historical Review

2. Click the Historical Review Menu button, and then click Historical Reviews Options
[298].
3. The Historical Reviews Options dialog box appears.
a. From the left pane, click Review Settings.
b. In the right pane, you can toggle between Get Original Value and Get Latest Value
to display either original or the most recent data. In addition, you can select the
Mark Edited Data check box if you want to see pencil icons next to the data that
has been edited.
c. Click OK.

Figure 293. Review Settings

4. Return to the Historical Reviews window. A selected check box appears at the left to
the edited data.

OPH070 343
To view edited historical data from a Historical Review

Figure 294. Point review with edit icons

344 OPH070
 Historical Trends overview

13 Using Historical Trends

Topics covered in this section:
• Historical Trends overview [345]
• Components of the Historical Trend window [350]
• Trend Menu button [351]
• Trend Quick Access Toolbar [352]
• Ribbon tabs [353]
• Trend data view (Dockable) tabs [355]
• Properties Panel [363]
• Details Panel [363]
• Visibility Panel [363]
• Status bar [363]
• Historical Trend specific menu options on the Trend ribbon tab [364]
• Historical Trend specific user preferences [365]
• Working with Historical Trends [366]

13.1 Historical Trends overview

The Ovation Trend application supports the following modes of operation:

• Live Trends: This mode provides dynamic updates of current values along with the
recent history of data just prior to them.
• Historical Trends: This mode allows exploration into past time periods of interest.
• Event Trends: This mode allows identification of event occurrences, request the
corresponding event data file, and to present the data in graphical and tabular form.
See Using Event Trends [389] for more information.

The ribbon style user interface, user interaction, and configuration concepts for Historical
Trends is similar to that of Live Trends – but includes additional features for time navigation
and historical data processing. For more information about configuring the trend’s layout
and appearance, as well as other common operations, refer to the Ovation Operator Station
User Guide. The Ovation Process Historian User Guide focuses mainly on Historical Trend
specific topics.

Historical Trends allow you to visualize historical data for process points in the form of
graphical plots and provide tools necessary to explore and analyze the data. In addition to
graphical plots, table view shows numeric values used for plotting, summary view shows
aggregated results for the whole time span, and radar view shows values on a radar plot at a
time instance.

Live Trends access the Operator Station's Ovation trend buffer, which contains a local,
recent history of values from the Ovation real-time data network. At times, the OPH is
accessed when recent history is needed to be backfilled into this local buffer.

OPH070 345
Historical Trends overview

Historical Trends access the Ovation Process Historian’s (OPH) historical database.

Live Trends and Historical Trends have many of the same features, but there are some other
features that are unique to each type of trend. The following table illustrates the features
that are available for Live Trends and for Historical Trends.

Table 61. Trending features

Feature category Feature Live Historical Event

trend trend trend
Formatting tools Display settings X X X
Styles X X X
Layouts X X X
Chart grids X X X
Chart options X X X
Visibility options X X X
Trend configuration and Duration presets X X X
interaction
Time span presets X X
Variable time span X
Memorize / recall time X X
span
Variable plot sample X
quantity
Browse points X X X
Add / delete point X X X
Graphical zoom X X
Data zoom X* X
Auto zoom X
Page back X X X
Page next X X
Trace value explorers X X X
Save / recall trend group X X X
definitions
Print results X X X
Export results X X X
Browse events X
Display ratio X
Trend views Graph X X X
Table X X X
Radar X X
Information X

346 OPH070
 Historical Trends overview

Feature category Feature Live Historical Event

trend trend trend
Summary X
Event Details X
Trace properties Point name X X X
Bit mask X X
Historian data source X X X
Data processing type / X
conversion constant
Variable plot sample X
quantity
Trace colors X X X
Scaling options X X X
Visibility settings X X X
Display settings X X X
* Click-drag zoom only

Refer to the Ovation Operator Station User Guide for detailed information on the following
topics.

• Trend terminology.
• Trend Quick Access Toolbar.
• Using the Trend application menu to perform the following functions:
◦ Create a new Historical Trend.
◦ Open a trend from a file.
◦ Save a trend to a file. Trends are saved in files with a TGD (trend group definition)
extension.
◦ Launch a duplicate trend.
◦ Explore information about user preferences, trend styles, and trend definitions.
◦ Print.
◦ Export.
◦ Save and load user preferences.
◦ Specifying user preferences by using the Trend Options window.
• Using Ribbon menus to perform the following functions:
◦ Change font.
◦ Customize display appearance settings.
◦ Use of Trend Styles to save and load trend display appearance settings. These are
saved in files with a TS extension.
◦ Assign titles to Trend charts.
◦ Choosing trend display layout (stacked panes layout or quadrants layout).

OPH070 347
Historical Trends overview

◦ Display vertical and/or horizontal grid.

◦ Black background mode and chart orientation.
◦ Show or hide the details panel, properties panel, panes.
◦ Adding process points to Trend and configuring associated trace properties.
◦ Adding compound trace.
◦ Deleting trace items.
◦ Using graphical zoom functions.
◦ Paging back and next.
◦ Trace values explorer and compare values explorer.
• Configuring traces’ properties.
• Trend data views: Graph view, Table view, Radar view.
• Details panel and properties panel.

13.1.1 To access the Historical Trend window

Use the following steps to access the Historical Trend window:

1. Select Start -> Ovation -> Ovation Applications -> Trend.

OR
If the Trend application is already running, click the Trend icon located on the system
tray.
OR
Access the Trend window by using the Trend option on the Point Menu (as described in
the Ovation Operator Station User Guide).
OR
Drag or drop points from other Ovation applications into the Trend window.

348 OPH070
 Historical Trends overview

2. By default, the Trend window opens in the Live Trend mode, as shown below:

Figure 295. Trend (or Live Trend) window

OPH070 349
Components of the Historical Trend window

3. To activate a Historical Trend, select Historical Trend in the Trend Type option, which is
present in the Quick Access Toolbar [352] and the Home [353] ribbon tab [353]. The
Historical Trend window appears:

Figure 296. Historical Trend window

13.2 Components of the Historical Trend window

The Historical Trend window consists of the following components that are described in
detail in the Ovation Operator Station User Guide.

• Trend Menu Button [351].

• Trend Quick Access Toolbar [352].
• Ribbon tabs [353].
• Dockable tabs [355] or Trend Data Display view panels (in the middle of the window).
• Properties Panel [363] (Dockable panel that docks to left or right side of the main
window).
• Details Panel [363] (Dockable panel that docks to top or bottom of the main window).
• Visibility Panel [363].
• Status bar [363].

350 OPH070
 Trend Menu button

Figure 297. Components of the Historical Trend window

13.3 Trend Menu button

The Trend Menu button at the top-left corner of the Trend window provides access to
several Trend functions. When in the Historical Trend mode, additional features are
available within various application components. Refer to the Ovation Operator Station User
Guide for more details about the Trend Menu button functions.

The following table describes various functions provided by the Trend Menu button.

Table 62. Trend Menu button functions

Function Description
New Allows you to create a new trend of a specific type:

• Live Trend
• Historical Trend
• Event Trend
Open Allows you to open an existing Live or Historical Trend from a previously saved
Trend Group Definition (.tgd) file.
Save Allows you to save changes in the current trend configuration.
Save As Allows you to save the current trend configuration as a Trend Group Definition
(.tgd) file.
Launch Allows you to open a duplicate instance of a currently displayed Trend in a new
Duplicate separate Trend window. The new instance can be modified independently.

OPH070 351
Trend Quick Access Toolbar

Function Description
Explore Displays different windows that provide information about user preferences,
trend styles (current or saved), and trend definitions (current or saved).
Print Displays the Print, Print Preview, and Page Setup options.
Export Opens the Export window. You can export the contents of the Trend data views
window to Text, Image, CSV, HTML, PDF, XML, MHT, RTF, XLS, and XLSX formats.
Preferences Opens the Preferences window that can be used to save application settings that
can then be applied to subsequent Trend sessions.
Historian Opens the Preferences window that can be used to save the historical data source
Preferences (Ovation Process Historian) host and user-specified time zone abbreviation
settings. These settings can then be applied to subsequent Trend sessions.
Trend Options Displays the Trend Options window that allows you to specify application defaults
and behavior settings for the current session. These settings can be saved as user
preferences that can then be applied to all new Trend application sessions.
Exit Trend Closes the Trend window.
Recent Lists the most recently opened Trend Definition files.
Documents

13.4 Trend Quick Access Toolbar

The Historical Trend window has frequently used icons that appear at the top of the window
in a Quick Access Toolbar. This toolbar allows for easy access to commonly used functions,
instead of navigating through the ribbon toolbars. These icons are shown below and are
described in the following table from left to right. Refer to the Ovation Operator Station
User Guide for more details about the Trend Quick Access Toolbar functions.

Figure 298. Trend Quick Access Toolbar

The following table describes the functions available in the Trend Quick Access Toolbar.

Table 63. Functions in the Trend Quick Access Toolbar

Function Description
Trend Type Allows you to activate the Live or Historical Trend.
Full Page Back and Full Displays trend for previous full page of data or next full page of data,
Page Next respectively.
Time Span Specifies time span for a Historical Trend.
Trace Properties Allows you to configure traces and their properties.
Browse Points Allows you to browse and add the points to trend.
Add point Allows you to add a single point to the trend. Clicking the down arrow on
the right allows the addition of a compound trace item.
Begin Initiates a request to get the trend data from the Historian and uses that
data to update the Trend window contents.

352 OPH070
 Ribbon tabs

13.5 Ribbon tabs

Ribbon tabs organize various Trend application functions and facilitate navigation to them.
The following ribbon tabs provide features applicable to the Historical Trend mode.

• Home [353] ribbon tab [353].

• Format [353] ribbon tab [353].
• Trend [355] ribbon tab [355].

Refer to the Ovation Operator Station User Guide for more details about the ribbon tabs.

13.5.1 Home ribbon tab

Use the Home ribbon tab to define the trend type and font style.

Table 64. Functions in the Home ribbon tab of a Historical Trend

Group Function Description

Trend Type Defines type of trend, Live or Historical, by using the Trend Type selection
function.

Note
For users who have enabled the Triggered Events functionality, the Trend Type
function also includes the Event Trend option.

Font Font Defines the font style.

Font size Defines the font size.
B Makes your text bold.
I Italicizes your text.

The following figure shows the Home ribbon tab of a Historical Trend.

Figure 299. Home ribbon tab of a Historical Trend

13.5.2 Format ribbon tab

Use the Format ribbon tab to configure the appearance of a trend.

OPH070 353
Ribbon tabs

Table 65. Functions in the Format ribbon tab of a Historical Trend

Group Function Description

Configure Display Settings Opens the Configure Settings window where you can customize
various trend display settings.
Styles Loads and saves trend styles. The drop-down arrow allows you to
select from the following options:

• Load from file

• Save to file
• Apply default style
Titles Opens the Chart Titles window where you can specify titles for
charts.
Layout Quadrants Layout Displays a trend graph in four quadrants (two rows, two columns
arrangement). These are named Quadrants A, B, C, and D.
Stacked Panes Displays a trend graph in vertically stacked areas (panes)
Layout appearing one below the other. Up to four panes are available
and are named Panes A, B, C, and D.
Chart Grid Vertical Displays primary and secondary vertical grid lines. Grids help you
to easily identify the reference value and time in the trend chart.
Horizontal Displays primary and secondary horizontal grid lines.
Chart Options Black Background Displays a black background for the current trend chart. This
overrides the settings that were previously defined, but it does
not delete them from the trend configuration. Therefore, if you
clear this check box, the trend chart’s previous background
appears.
Orient Vertically Displays the trend charts with a horizontal process range and a
vertical time axis. The most recent time appears at the top of the
chart.
Trace Numbering Displays numbering on traces.
Charts side by Displays the trend charts side by side when the quadrants layout
side is in effect.
Visibility Details Panel Shows or hides the Details panel [363].
Properties Panel Shows or hides the Properties panel [363] and Visibility panel
[363].
Event Markers Shows or hides the event markers in the Graph tab [356].

The following figure shows the Format ribbon tab of a Historical Trend.

354 OPH070
 Trend data view (Dockable) tabs

Figure 300. Format ribbon tab of a Historical Trend

13.5.3 Trend ribbon tab

Use the Trend ribbon tab to perform the following tasks:

• Specify trend trace content.

• Manage historical time periods.
• Specify historical data processing.
• Zoom into the data detail or expand the time period under exploration.

These tasks define the trend content and allow you to explore the trend request results.

Note
See Historical Trend specific menu options on the Trend ribbon tab [364] for the Trend
ribbon tab menu options specific to Historical Trends.

The following figure shows the Trend ribbon tab of a Historical Trend.

Figure 301. Trend ribbon tab of a Historical Trend

13.6 Trend data view (Dockable) tabs

Dockable tabs provide different views of Trends. These dockable tabs are as follows:

• Graph [356].
• Table View [358].
• Summary View tab (displayed for Historical Trends, but not available for Live Trends)
[359].
• Radar View tab [360].
• Event List tab (displayed only if a triggered event is present in the specified time range)
[361].

OPH070 355
Trend data view (Dockable) tabs

• Information view tab (displayed for Live Trends, but not available for Historical Trends).

You can interactively dock these views in an application window through the use of the
Guide Diamond tool. You can arrange the dockable tab view panels as a group of tabbed
windows or you can dock them with each other for simultaneous viewing. These view
panels can also float independently and can be placed on different monitors. For more
details, refer to the Ovation Operator Station User Guide for more details about the
dockable tabs.

You can access different aspects of Historical Trend data using the following view tabs:
Graph, Table View, Summary View, Radar View, and Event List. The context ribbon tab for
the Historical Trend provides ways to customize and navigate the historical data display. The
Details Panel provides a quick view of information about traces like Point Name,
Description, Historian, Units, Value, and Scales.

13.6.1 Graph tab of a Historical Trend

The Graph tab is the main tab for Historical Trends. It is frequently used to monitor the
process activity. The Graph tab displays the plots of process values over a time range. The
following figure depicts a Graph tab view for the Historical Trend application.

Figure 302. Graph tab

The following figure depicts a Graph tab view for the Historical Trend application, but with
two types of processing. The upper portion depicts actual data retrieval while the lower
portion depicts raw data retrieval. Actual processing shows the sample value at certain time
intervals, based on the trend duration and number of samples requested. Raw processing
shows the sample based on value changes during the trend duration. Therefore, it shows all
spikes in data, not just those that occur at certain intervals.

356 OPH070
 Trend data view (Dockable) tabs

Figure 303. Graph tab showing both actual and raw processing

When the Trend application has the Triggered Events option enabled [389] and if triggered
events (generated by Controller, DEC module, COMTRADE, or High Speed Data Recorder)
are present in the trend time span, an E icon appears in the Graph tab.

Figure 304. Graph tab -- triggered event (E icon)

OPH070 357
Trend data view (Dockable) tabs

If you click the E icon on a Historical Trend, the Event Trend window appears. The Event
Trend window displays a T icon for triggered events. See Using Event Trends [389] for more
information.

If you right-click the E icon on a Historical Trend, a context menu appears.

Figure 305. E icon -- right-click menu

The right-click menu of the E icon contains the following options.

Table 66. Options in the right-click menu of the E icon

Function Description
Launch Event Trend Opens the Event Trend in the same window.
Launch Event Trend (New Window) Opens the Event Trend in a new window.
Memorize Event Time Span Memorizes the current time span in effect.
Browse Events Opens the Events Browser window.

13.6.2 Table View tab of a Historical Trend

The Table View tab displays the Historical Trend results in a tabular format. The following
figure depicts a Table View for the Historical Trend application.

358 OPH070
 Trend data view (Dockable) tabs

Figure 306. Table View tab

13.6.3 Summary View tab of a Historical Trend

The Summary View tab displays historical data summary information (for example, average,
maximum, minimum, and so forth) for the entire time span. The following figure depicts a
Summary View for the Historical Trend application.

OPH070 359
Trend data view (Dockable) tabs

Figure 307. Summary View tab

13.6.4 Radar View tab of a Historical Trend

The Radar View tab plots all the configured points for one instant in time, each on an
individual spoke (axis) arranged in a radial pattern. The following figure depicts a radar view
for the Historical Trend application.

360 OPH070
 Trend data view (Dockable) tabs

Figure 308. Radar View tab

13.6.5 Event List tab of a Historical Trend

Note
A Historical Trend displays an Event List tab only if triggered events are detected in its time
range.

The Event Details tab displays details about an event. The following figure depicts an Event
List tab view for the Historical Trend application.

OPH070 361
Trend data view (Dockable) tabs

Figure 309. Event List tab

If you double-click an event record, the Event Trend window appears. See Using Event
Trends [389] for more information.

13.6.6 Interaction between Graph, Radar, and Table view tabs

when Trace Explorer is active
Since view tabs are dockable, you can position them so that the Graph and Radar and/or
Table views are shown together (see figure below). When you activate the Trace Explorer
and position the line cursor at a desired point in time, the values plotted in the Radar view
and the row highlighted in the Table view correspond to the time indicated by the line
cursor. Moving the line cursor adjusts the other Views accordingly.

Figure 310. Interaction between Graph, Radar, and Table view tabs when Trace Explorer is
active

362 OPH070
 Properties Panel

13.7 Properties Panel

The Properties Panel provides a quick view of trace item configuration details and allows
you to dynamically edit and update these details while a trend graph is in view. The panel
has same information that the Trace Properties window contains. Refer to the Ovation
Operator Station User Guide for more details about the Properties Panel.

You can show or hide the Properties Panel through the Format [353] ribbon tab [353].
Select or clear the Properties Panel check box to show or hide the panel.

13.8 Details Panel

The Details panel gives you the key information, such as point name, description, current
point value, and many more, for the points assigned to the trend traces. The colors and
content columns shown within the Details Panel are configurable by using the Display
Settings dialog box. Refer to the Ovation Operator Station User Guide for more details
about the Details Panel.

You can show or hide the Details Panel through the Format [353] ribbon tab [353]. Select or
clear the Details Panel check box to show or hide the panel.

13.9 Visibility Panel

The slide-out Visibility panel is located at the right side of the Trend window, below the
Properties panel [363].

The Visibility Panel is an alternative location for controlling trace and scale visibility. It is
useful because the Details panel [363] is sometimes hidden itself or is usually sized such
that all points cannot be viewed without scrolling through its rows.

13.10 Status bar

Located at the bottom of the Trend window, the Status bar displays the following
information for the currently shown trend:

• Current trend type: Applicable to Live, Historical, and Event Trends.

• Time specifications: Applicable to Live, Historical, and Event Trends.
• Point Count: Applicable to Live and Historical Trends.
• Display Ratio: Applicable to Event Trends.

The following table describes the trend time specification in the status bar for Live,
Historical, and Event Trends.

Table 67. Trend time specification in status bar

Trend type Trend time specification in status bar

Live Trend Duration time for the trend.
Historical Trend Start, end, and duration times for the trend.
Event Trend Start, end, and duration times for the trend.

OPH070 363
Historical Trend specific menu options on the Trend ribbon tab

13.11 Historical Trend specific menu options on the

Trend ribbon tab
The following table describes Historical Trend specific menu options on the Trend ribbon
tab in the Trend window.

Table 68. Historical Trend specific menu options on the Trend ribbon tab

Option Description
Begin Use this option to initiate data retrieval from the historian and to update the trend
display. If start time and/or end time are specified as relative time, they are
recalculated. This option uses cached data on a client machine, if available.
Refresh Use this option to refresh the trend display with newly acquired data from the historian
without altering the time span. This functionality can be useful when the trend contains
SCADA point data that may have been delayed in getting to the historian.
Set (Time Use these options to deal with time span settings:
Span)
• Click Set and the Choose Time Span dialog box [373] appears. In the dialog box,
you can specify start time, end time, and number of data samples for the whole
trend. The number of data samples can be overridden for individual trace items.
• The associated drop-down menu [374] with the Set menu option offers convenient
time span presets. For example, the Yesterday option sets the start time to 00:00
yesterday (yd) and end time to 00:00 today (td) in terms of relative time.
• Click Memorize to memorize the current time span in effect.
• Click Recall to recall the memorized time span and to update the trend display
accordingly.
Data Use this option to retrieve more granular data for a reduced time range. The associated
Zoom-In menu options allow 25%, 50%, and 75% zoom-in levels. Clicking on the top part of the
button performs a 25% zoom-in.
Data Use this option to retrieve less granular data for a wider time range. The associated
Zoom-Out menu options allow 25%, 50%, and 75% zoom-out levels. Clicking on the top part of
the button performs a 25% zoom-out.
Page Back Use this option to update trend display to show data in the preceding time span with
respect to the time span currently in effect. The associated menu options allow going
back by full page and half page.
Page Next Use this option to update trend display to show data in the succeeding time span with
respect to the time span currently in effect. The associated menu options allow going
forward by full page and half page.

Note
Right-click and dragging the pointer creates a zoom rectangle to perform data zoom-in.
Pressing the ESC key or a left-click cancels this operation.

364 OPH070
 Historical Trend specific user preferences

13.12 Historical Trend specific user preferences

The following table lists the Historical Trend specific user preferences, which are specified in
the Trend Options window. The Trend Options window can be accessed by using the Trend
Menu button [351].

Table 69. Historical Trend specific user preferences

User preference Description

Input Date-Time This option controls the format of a date-time string in the date-time box
format (under General for specifying the absolute start time and end time in the Time Span dialog
tab) box for the Historical Trend application.
Display of Edited data When appropriately licensed, the Ovation Process Historian (OPH) allows
(under Data Display the historical data record to be manually adjusted for circumstances where
tab) more accurate readings can be obtained by using other means. The OPH
retains both the original data it collected and the user edits. This option
determines which data, the originally collected data or the user-modified
data, is presented to the users in the trend.
Mark Edited values This option when checked marks the edited values with an asterisk
character prefix.
(under Data Display
tab)
Mark saved Historical When selected, all Trend Group Definition (.tgd) files saved for a Historical
Trend File for Trend execute the trend without additional user action upon opening of the
immediate execution file. With this feature, a Historical Trend representing a reference or
on subsequent open benchmark process activity, such as "Unit 2 Turbine Run-up 2012-02-18" or
"Plant Overview Past 24 Hours", can be easily recalled for viewing. Without
(under Data Display this setting, Trends open in the deferred execution mode and wait for user
tab) interaction before initializing the request for historical data.
XY Plot Display This option enables you to view an XY plot display.

(under Data Display

tab)
Historians tab This tab displays a list of Ovation Process Historians to be used as a source
of the historical data request.
Auto Historian criteria You can choose "Resolve Auto Historian to real Historian," which will
traverse the list of configured historians and select the historian that is
collecting the point being trended. Conversely, you can choose "Use First
Active Historian as Auto Historian," which will traverse the historian list and
use the first responsive historian, whether or not the point is collected by
that historian.
Default processing When a point is added for trending, the user-specified default processing
type type becomes the default selection for that point.
Time Zones tab This tab displays frequently used time-zone abbreviations for specifying
absolute start and end time for the Historical Trend time span.

Refer to the Ovation Operator Station User Guide for more information about user
preferences and the Trend Options window.

OPH070 365
Working with Historical Trends

13.13 Working with Historical Trends

Live Trends are used for process monitoring. On the other hand, Historical Trends are used
to explore time periods to search for process anomalies or to produce trend results to
capture and present to other plant personnel. You can perform various functions with
Historical Trends. Refer to the Ovation Operator Station User Guide for additional
information about configuring and using Trends.

13.13.1 To add a point to a Historical Trend

Use the following steps to add a point to a Historical Trend:

1. Access the Historical Trend window [348].

2. Select the Add icon from the Points group.

366 OPH070
 Working with Historical Trends

3. The Specify Point Information dialog box appears as specified by either number of data
samples or interval type (time unit and associated parameters):

Figure 311. Specify Point Information as number of data samples

OPH070 367
Working with Historical Trends

Figure 312. Specify Point Information as interval type

13.13.2 Specifying Point Information

Add the required information about the point in the Specify Point Information dialog box.
The fields in the dialog box are described in the following subsections. After you have filled
in the required information, click OK to add the point to the trend.

Specifying Point Name

Use the Point Name field to enter the name of the point to be added to the Historical Trend
or click the ellipses button to browse the point.

Specifying Historian Name

Use the Historian field to select the applicable historian name for history data. You can
trend points from multiple historians in the same graph.

Specifying Processing Type

Use the Processing Type field to define the mathematical processing for aggregating
samples for Historical Trends.

All aggregate results are returned with timestamps at the start of an interval except Raw,
Start, and End processing types. The aggregate query returns one result for each interval,
based on the total duration specified and number of intervals. The result is composed of
value, status, and other pertinent information.

Actual aggregates are processed regardless of quality. For all other processing types, only
good or fair quality samples are used in the calculation if there is at least one good or fair
quality sample. If there are no good or fair quality samples, the calculation is performed
with the bad or poor samples.

368 OPH070
 Working with Historical Trends

A timed-out sample is considered as a bad quality sample. The quality of an interval is good
if more than 75% of the interval is good. Similarly, the quality of an interval is bad if more
than 75% of the interval is bad.

Table 70. Description of various OPH processing types

Processing type Description

Actual Reflects the actual value of a process point at the beginning of an interval.
Extrapolates the value, if necessary.
Average Reflects the average value for a process point over the interval.
Delta Reflects the difference between end value and start value for the interval (end
value – start value). End value is the value just before the end of an interval.
Duration Bad Reflects the time duration in the interval when a process point has a bad quality.
Duration Good Reflects the time duration in the interval when a process point has a good
quality.
End Reflects the process point value at the end of an interval. End value is the value
just before the end of an interval. The timestamp returned is the actual
timestamp of the value.
Full Integration Performs integration of process point values over the interval and sets the result
to a cumulative addition of such values for prior interval and this interval. This
value is multiplied by a conversion constant.
Integration Performs integration of process point values over the interval multiplied by a
conversion constant.
Maximum Reflects the maximum value of a process point in the interval.
Minimum Reflects the minimum value of a process point in the interval.
Percent Bad Reflects the percent bad quality in the interval.
Percent Good Reflects the percent good quality in the interval. A configuration setting decides
whether fair samples are treated as good samples for this calculation.
Range Reflects the total range of values (Maximum - Minimum) over the interval.
Rate of change Rate of Change is the difference between the first and last samples in the interval
divided by the number of seconds in the interval and scaled by dividing by the
conversion constant. The first and last sample values are computed using a linear
interpolation.
Raw This aggregate is not interval based, but retrieves all samples for which the value
or status has changed.
Raw Count Reflects the total number of samples collected in the interval for the process
point.
Start Reflects the value at the start of an interval for the process point. The timestamp
returned is the actual timestamp of the value.
Std-dev Reflects the standard deviation of all values over the interval.
Time Average Reflects the time-weighted average value for the process point over the interval.
Time Of Reflects the time associated with a maximum value in the interval.
Maximum
Time Of Reflects the time associated with a minimum value in the interval.
Minimum

OPH070 369
Working with Historical Trends

Processing type Description

Time Reset Reflects the amount of time a digital process point was in the RESET state during
the interval. It is also applicable for any one bit of a packed point.
Time Set Reflects the amount of time a digital process point was in the SET state during
the interval. It is also applicable for any one bit of a packed point.
Toggle Reflects the number of times a digital process point state was toggled from SET
to RESET and vice versa during the interval. It is also applicable for any one bit of
a packed point.
Toggle Reset Reflects the number of times a digital process point changed state to RESET
during the interval. It is also applicable for any one bit of a packed point.
Toggle Set Reflects the number of times a digital process point changed state to SET during
the interval. It is also applicable for any one bit of a packed point.
Total Reflects the sum of all values collected in the interval.
Variance Reflects the variance of all samples over the interval.

Interval Type: Trace sample interval can be specified as Number of Samples or one of the
time unit intervals: hour, minute, second, day, month, or millisecond. A down arrow button
with drop-down menu allows you to specify preset times.

Samples: Use this field to define the number of samples (1 to 2,000) to retrieve for Historical
Trends. Live Trends are fixed at 600 samples. Each trace can have unique samples counts.

Interval Multiplier: When the interval type is Time unit, this field is used to specify the
multiplier to be applied to the selected time unit, for example, 10 minutes, 3 hours.

Interval Alignment: When the interval type is Time unit, this field is used to specify how the
start of the interval should be aligned with time. If the alignment is Start, the first interval
start time aligns with the start time of the trend; if the alignment is Clock, the start of the
intervals aligns with the top value of the selected time unit. For example, if the time unit is
Hour, the start of each interval aligns with the start of the hour.

Conversion Constant: Use this field to supply the units conversion constant to be used for
Integration, Full Integration, and Rate of Change processing types when trending this type
of data from the historian.

Bit Mask: This field applies only to packed point items and is grayed out if the selected point
is not a packed point.

You can also add points to an Historical Trend by the following methods:

• Drag and drop a point in the Trend window from other Ovation applications, such as
Point Review to view its trend trace. The point is added to the underlying pane or
quadrant.
• Use the Browse Points option on the Trend ribbon tab to browse for points and add
them.
• Use the Trace Properties option on the Trend ribbon tab.

370 OPH070
 Working with Historical Trends

Note
Compound trace items can be added by using the Trace Properties option on the Trend
ribbon tab or by clicking the down arrow on the right side of the Add menu option of the
Trend ribbon tab. Refer to the Ovation Operator Station User Guide for more information.

13.13.3 To delete a point from a Historical Trend

Use the following steps to delete a point from a Historical Trend:

1. Access the Historical Trend window [348].

2. Select the Trend [355] ribbon tab [355].
3. Select the Delete icon from the Points group. Use this icon to delete all or only the
selected points.

Note
You can also delete a point by using the right-click menu in the Details Panel.

13.13.4 To page through a Historical Trend

Use the Page group of the Trend ribbon tab to view previous and next time periods of trend
data, as described in the following steps:

1. Access the Historical Trend window [348].

2. Select the Trend [355] ribbon tab [355].
3. Select the Full Page Back icon to view the trend data for the previous time span. The
previous time span will be the same length as the current time span duration.
4. Select the Full Page Next icon to view the trend data for the later time span. The later
time span will be the same length as the current time span duration.

OPH070 371
Working with Historical Trends

13.13.5 To save a Historical Trend

You can save Historical Trends in the following two ways:

• A Historical Trend can be saved for a specific absolute period in time. This trend can
then be recalled later as a benchmark reference.
• A Historical Trend can be saved with a time range relative to the current time (time of
trend request) or the most recent time boundary (beginning of most recent hour, day,
or week). This trend can then be used to obtain a recent time period for analysis.

You can program trend definitions to execute their retrieval request automatically when
loaded, or to wait for user action.

Use the following steps to save a trend so that you can revisit it later:

1. Access the Historical Trend window [348].

2. Click the Trend [351] Menu button [351], and then click Save As. The Save As Trend file
(TGD) dialog box appears:

Figure 313. Saving a Historical Trend in a file

3. Select the target location.

4. Enter the file name in the File Name box.
5. Click Save As in the Save As Trend file (TGD) dialog box. The Historical Trend is saved.

372 OPH070
 Working with Historical Trends

13.13.6 To specify a time span using the Choose Time Span dialog
box
Use the following steps to specify a time span by using the Choose Time Span dialog box:

1. Access the Historical Trend window [348].

2. Click Set in the Time Span group of the Trend [355] ribbon tab [355].
3. The Choose Time Span dialog box appears:

Figure 314. Choose Time Span dialog box

4. You can specify the time span by using the following options:
• Start Time and End Time
• Start Time and Duration
• End Time and Duration
• Absolute time specification syntax
• Relative time specification
• Time zone selection
• Current time reset (the “C” button)
• Previous entered time reset (the “L” button)

Duration is one of preset durations that are the same as the presets for Live Trends. Start
time and/or end time can be specified as either absolute value or relative value. In the date-
time box for absolute date-time, the suffix LCL means local time zone. If time zones are
configured in the Trend Options window, they appear in a drop-down window activated by
a click on the down arrow in the date-time box. You can select a time zone for specifying
time in that time zone. This feature allows you to specify a time zone setting that is different
from your local time zone. It is useful when the historian has data collected from a large
geographic area and you want to present the data by using the same time zone as the
remote Ovation system.

OPH070 373
Working with Historical Trends

Note
Input date/time format user preference [365] controls the format of absolute date-time
string appearing in Start Time and End Time boxes. Clicking C option button shows current
time in date-time box and clicking L option button restores the time span to the one used
for the last request.

The pencil icon at the right end of the date-time box toggles absolute and relative mode.
Relative time can be specified by typing the string or by using the drop-down window
activated by a click on the down arrow in the date-time box. The following figure shows the
drop-down window that can be used to specify relative time interactively.

Figure 315. Specifying the relative time interactively

A few examples of relative time are as follows:

• ct – 15mi: current time minus 15 minutes

• yd – 3hr – 10mi: yesterday 00:00 minus (3 hours and 10 minutes)

Relative time makes it unnecessary to specify absolute time values every time a trend needs
to be generated.

13.13.7 To specify a time span using the Set Time Span drop-
down list
Use the following steps to specify a time span by using the Set Time Span drop-down list:

1. Access the Historical Trend window [348].

374 OPH070
 Working with Historical Trends

2. Click the drop-down arrow below Set in the Time Span group of the Trend [355] ribbon
tab [355] to view the available time span options. The options include easy-to-use time
period presets, as shown in the following figures:

Figure 316. Main options in the Set Time Span drop-down list

OPH070 375
Working with Historical Trends

Figure 317. Further options associated with the "Last" option

Figure 318. Further options associated with the "Past" option

376 OPH070
 Working with Historical Trends

Figure 319. Further options associated with the "From start of" option

OPH070 377
Working with Historical Trends

3. You can specify the time span by selecting any option from the list. If the current date is
February 26, 2013 (Tuesday) and current time is 11:45, the Trends application
interprets various options as described in the following table.

Table 71. Options in the Set Time Span drop-down list

Option Start time End time

Previous Hour February 26, 2013 February 26, 2013

10:00 11:00
Yesterday February 25, 2013 February 26, 2013

00:00 00:00
Last ® Monday February 25, 2013 February 26, 2013

00:00 00:00
Last ® Tuesday February 19, 2013 February 20, 2013

00:00 00:00
Last ® Wednesday February 20, 2013 February 21, 2013

00:00 00:00
Last ® Thursday February 21, 2013 February 22, 2013

00:00 00:00
Last ® Friday February 22, 2013 February 23, 2013

00:00 00:00
Last ® Saturday February 23, 2013 February 24, 2013

00:00 00:00
Last ® Sunday February 24, 2013 February 25, 2013

00:00 00:00
Past ® 10 minutes February 26, 2013 February 26, 2013

11:35 11:45
Past ® 30 minutes February 26, 2013 February 26, 2013

11:15 11:45
Past ® 60 minutes February 26, 2013 February 26, 2013

10:45 11:45
Past ® 2 hours February 26, 2013 February 26, 2013

09:45 11:45
Past ® 1 day February 25, 2013 February 26, 2013

11:45 11:45
Past ® 2 days February 24, 2013 February 26, 2013

11:45 11:45

378 OPH070
 Working with Historical Trends

Option Start time End time

Past ® 7 days February 19, 2013 February 26, 2013

11:45 11:45
Past ® 14 days February 12, 2013 February 26, 2013

11:45 11:45
Current Hour February 26, 2013 February 26, 2013

11:00 11:45
Today February 26, 2013 February 26, 2013

00:00 11:45
Current Week February 25, 2013 February 26, 2013

00:00 11:45
From start of ® Today February 26, 2013 February 26, 2013

00:00 11:45
From start of ® Yesterday February 25, 2013 February 26, 2013

00:00 11:45
From start of ® Last Monday February 25, 2013 February 26, 2013

00:00 11:45
From start of ® Last Tuesday February 19, 2013 February 26, 2013

00:00 11:45
From start of ® Last Wednesday February 20, 2013 February 26, 2013

00:00 11:45
From start of ® Last Thursday February 21, 2013 February 26, 2013

00:00 11:45
From start of ® Last Friday February 22, 2013 February 26, 2013

00:00 11:45
From start of ® Last Saturday February 23, 2013 February 26, 2013

00:00 11:45
From start of ® Last Sunday February 24, 2013 February 26, 2013

00:00 11:45

13.13.8 To memorize and recall a time span for a Historical Trend

There may be a situation where you are exploring historical data for a set of points, and
after paging and zooming in time, you observe an anomaly. You can observe the activity for
that time period with a different set of points by memorizing that resultant time period and
then recalling it after loading a different trend definition.

OPH070 379
Working with Historical Trends

Note
Memorize and Recall options are available for Historical and Event Trends, not for Live
Trends.

Use the following steps to memorize and recall a time span:

1. Access the Historical Trend window [348].

2. Select the Trend ribbon tab.
3. Select the Memorize icon to memorize the current time span to be recalled later.
4. If desired, select the Recall icon to recall the previously memorized time span.

13.13.9 To specify trace properties in a Historical Trend

You can specify the trace properties by using the Trace Properties option in the Points group
of the Trend [355] ribbon tab [355]. The trace properties used for retrieving historical data
are described in the following table. For other properties, and for information on using trace
properties, refer to the Ovation Operator Station User Guide.

Table 72. Trace properties in a Historical Trend

Trace Description
property
Historian Use this option to specify the Ovation Process Historian that supplies historical data.
It can be specified per trace item.

Note
Use the Trend Options dialog box to specify a list of historians to be used for
Historical Trend.

Processing Use this option to specify the mathematical calculation logic applied to the
Type historical process values.
Conversion Use this option to specify the floating-point number that applies to processing types
Constant of Integration, Full Integration [381] and Rate of Change [382].
Interval Type Trace sample interval can be specified as Number of Samples or one of the time unit
intervals: hour, minute, second, day, month, millisecond.
Samples Use this option to specify the number of data samples. This is a number in the range
of 1 to 2000. Using this property, you can request plots of trace items with different
number of data samples. Trace items with more data samples show more detailed
plot whereas trace items with less data samples may be used for a coarse view of
data.

Each trace can have its own sample quantity. For example, a daily trend consisting of
one or more traces of 24 hourly average samples along with one or more
superimposed plot trace of 2000 actual values.
Interval When the interval type is Time unit, this field specifies the multiplier to be applied to
Multiplier the selected time unit, for example, 10 minutes, 3 hours.

380 OPH070
 Working with Historical Trends

Trace Description
property
Interval When the interval type is Time unit, this field is used to specify how the start of the
Alignment interval should be aligned with time. If the alignment is Start, the first interval start
time aligns with the start time of the trend; if the alignment is Clock, the start of the
intervals aligns with the top value of the selected time unit. For example, if the time
unit is Hour, the start of each interval aligns with the start of the hour.
Bit Mask This property applies only for PACKED points. For Actual processing type, it is a set of
ON consecutive bits. For processing types other than Actual, only one bit can be
specified to retrieve results based on that bit position.

The following figure shows the Trace Properties window for the Historical Trend application:

Figure 320. Trace Properties window

Full Integration
Full Integration is a processing type (in the Trace Properties window [365]) that performs
the retrieval of integration samples from the Ovation Process Historian. However, instead of
plotting the samples individually, the plots have successively accumulated values over the
displayed time span.

OPH070 381
Working with Historical Trends

The following figure shows the difference between the Integration and Full Integration
processing types. In this example, a point with a constant flow rate of 14 gallons per hour is
trended for a one-hour time span. The same point is plotted in the second trend pane with
the Integration processing type applied with the trend divided into 10 six-minute
integration results, using the units conversion constant specified in the point’s trace
properties. The third trend pane shows the same point with the Full Integration processing
type specified, which shows the six-minute integrations successively accumulated over the
trend time span.

Figure 321. Integration versus Full Integration processing types

Rate of Change
Rate of Change is an OPH retrieval processing type (in the Trace Properties window [380])
that uses the inverse of the value entered in the Conversion Constant field.

13.13.10 To activate the deferred execution mode for Historical

Trends
Historical Trend offers a special deferred execution mode. This mode allows you to build the
trend definition in its entirety, specify time span, and when done, click the Begin option in
the Trend [355] ribbon tab [355] to start data retrieval for the trend and to update the plot.

Use the following steps to activate the deferred execution mode for Historical Trends:

1. Access the Historical Trend window [348].

2. Click Set in the Time Span group of the Trend [355] ribbon tab [355].

382 OPH070
 Working with Historical Trends

3. The Choose Time Span dialog box appears:

Figure 322. Choose Time Span dialog box while using a deferred execution mode in
Historical Trends

4. Click OK. As you can see, if the current time is 2/4/2013 [Link] LCL, the time range is
automatically set as follows:
• Start Time: Current Time (ct) - Duration = (2/4/2013 [Link] LCL) - (10 min) =
2/4/2013 [Link] LCL
• End Time: ct
• Duration: 10 minutes

Note
Clicking OK in the Trace Properties window retains this mode if the trend was
already in deferred mode. Otherwise, the trend is updated immediately.

13.13.11 To use Chart Options

Chart Options allow you to select a black background for a trend and to switch the axis
positions resulting in a horizontal process range and a vertical time axis.

Use the following steps to use the Chart Options:

1. Access the Historical Trend window [348].

2. Select the Format ribbon tab.

OPH070 383
Working with Historical Trends

3. Select the desired Chart Option(s) in the Format ribbon:

• Black Background: Select this option to display a black background for the current
trend chart. This overrides the settings that were previously defined, but it does
not delete them from the trend configuration. Therefore, if you clear this check
box, the trend chart’s previous background appears.
• Orient Vertically: Select this option to display the trend charts with a horizontal
process range and a vertical time axis. The most recent time appears at the top of
the chart.
• Trace Numbering: Select this option to display numbering on traces.
• Charts side by side: Select this option to display the trend charts side by side when
the quadrants layout is in effect.

Figure 323. Chart Options section

13.13.12 To use XY plot and display options

1. Use the following steps to activate an XY plot:
2. Add at least two points to a Historical Trend. Click Begin to update the Trend window so
that corresponding traces are displayed.
3. From the Properties panel, select the XY Plot - X Axis check box,
OR
From the right-click context menu in the Details panel, Set as X-Axis.
OR
Right-click on scale for the point. From the context menu, select Set as X-Axis.
The Show Time as X Axis context menu option deactivates XY Plot and the trend
updates to show time as X Axis.

Note
Digital points cannot be used as XY plot X Axis.

384 OPH070
 Working with Historical Trends

4. Click Trend Options from the Trend Menu button.

Figure 324. Trend Menu button -- Trend Options

OPH070 385
Working with Historical Trends

5. The Trend Options window appears. Select Data Display from the left pane of the
window. From the right pane, select either of the following XY Plot Display options:
• Scatter Point: Displays the XY plot as dots without any interconnecting lines.
• Scatter Line: Displays the XY plot as lines connecting consecutive samples.

Figure 325. Trend Options window

386 OPH070
 Working with Historical Trends

6. Return to the Historical Trend window. The following figure depicts a historical trend
with a scatter line XY plot if you select the following options:
• Scatter Line option for XY Plot Display in the Trend Options window (see Step 4).
• XY Plot - X Axis option from the Properties panel [363] or Trace Properties window
[380].

Figure 326. Trend window -- Scatter line

OPH070 387
Working with Historical Trends

7. The following figure depicts a historical trend with a scatter point XY plot if you select
the following options:
• Scatter Point option for XY Plot Display in the Trend Options window (see Step 4).
• XY Plot - X Axis option from the Properties panel [363] or Trace Properties window
[380].

Figure 327. Trend window -- Scatter points

8. You can also specify the following X-axis options by right-clicking a point in the Details
panel:
• Set as X-axis
• Set Time as X-axis

Figure 328. Historical Trend window -- Right-click menu of the Details panel

388 OPH070
 Event Trends overview

14 Using Event Trends

Topics covered in this section:
• Event Trends overview [389]
• To enable the event trending functionality [389]
• To specify event filters in the Events Browser window [393]
• To run an Event Trend from the Events Browser window [399]
• Event types [400]
• Components of the Event Trend window [401]
• Event Trend specific menu options on the Trend ribbon tab [409]
• Event Trend specific user preferences [410]
• Working with Event Trends [411]

14.1 Event Trends overview

Event Trends allow you to identify triggered event occurrences and details from Controllers
and the DEC module. In this mode, you can also view corresponding pre- and post-event
data in a graphical or tabular form. See To access the Historical Trend window [348] to learn
how to start a trend application.

You can initiate an Event trend by:

• Clicking on the event marker (E) icon in a Historical Trend [356].

• Using the right-click context menu for that event marker (E) icon [356].
• Using the Events Browser window [399].

Use the following steps to run an Event Trend from the Events Browser window:

1. Enable the event trending functionality [389].

2. Specify event filters in the Events Browser window [393].
3. Run an Event Trend from the Events Browser window [399].

14.2 To enable the event trending functionality

Use the following steps to activate the event trending functionality:

OPH070 389
To enable the event trending functionality

1. Click Trend Options from the Trend Menu button [351].

Figure 329. Trend Menu button -- Trend Options

390 OPH070
 To enable the event trending functionality

2. The Trend Options window appears. Select Events from the left pane of the window.
Perform the following steps in the right pane:
a. Select the Enable Triggered Events check box.
b. (Optional) Select the Enable Soe Trending check box if you want to allow trending
of SOE messages over a triggered event time span.
c. Click OK.

Figure 330. Trend Options window

OPH070 391
To enable the event trending functionality

3. Launch the Event Trend by using any of the following methods:

• Trend Menu button -> New -> Event Trend

Figure 331. Launching Event Trend from the Trend Menu button

• Quick Access Toolbar -> Trend Type -> Event Trend

Figure 332. Launching Event Trend from the Quick Access Toolbar

392 OPH070
 To specify event filters in the Events Browser window

4. The Events Browser window appears:

Figure 333. Events Browser window

14.3 To specify event filters in the Events Browser

window
Use the following steps to specify event filters in the Events Browser window:

1. Access the Events Browser window [389].

OPH070 393
To specify event filters in the Events Browser window

2. From the Events Browser window, click Set Filters. The Events Browser window updates
to show additional fields for specifying filters.

Figure 334. Events Browser window -- specifying filters

The following table describes various event filter options.

Table 73. Event filter options

Function Description
Time Span Specifies the time span by using any of the following options:

• Time Span dialog box [395].

• Time Span drop-down list [398].
Event Name Specifies an event name for the filter search.
Network/Unit Specifies the network and unit filter for the search.
Historians Specifies the Ovation Process Historian that supplies historical data.
Type Specifies the event type:

• DEC Module
• Controller
• COMTRADE
• High Speed Data Recorder
Source Drop Specifies the Source drop from where an event originates.

394 OPH070
 To specify event filters in the Events Browser window

3. After you specify the filter options, click Start from the taskbar. The Event Records
group displays the search results in the form of event records.

Figure 335. Events Browser window -- event records

14.3.1 Specifying time span filter for Events search using the
Time Span dialog box
Use the following steps to specify a time span filter by using the Time Span dialog box:

1. Access the Events Browser window [389].

2. From the Events Browser window, click Set Filters. The Events Browser window updates
to show additional fields for specifying filters.

OPH070 395
To specify event filters in the Events Browser window

3. Click Time Span. The Time Span dialog box appears.

Note
Click the Time Span button to open the dialog box. If you click the drop-down arrow
(adjacent to the button), the Time Span drop-down list appears [398].

Figure 336. Events Browser window -- Time Span dialog box

396 OPH070
 To specify event filters in the Events Browser window

4. In the Time Span dialog box, you can specify the time span by using the following
options:
• Start Time and End Time
• Start Time and Duration
• End Time and Duration
• Absolute time specification syntax
• Relative time specification
• Time zone selection
• Current time reset (the “C” button)
• Previous entered time reset (the “L” button)
Duration is one of the preset durations that are the same as the presets for Live Trends.
Start time and/or end time can be specified as either absolute value or relative value. In
the date-time box for absolute date-time, the suffix LCL means local time zone. If time
zones are configured in the Trend Options window, they appear in a drop-down
window activated by clicking the down arrow in the date-time box. You can select a
time zone for specifying time in that time zone. This feature allows you to specify a
time zone setting that is different from your local time zone. It is useful when the
historian has data collected from a large geographic area, and you want to present the
data by using the same time zone as the remote Ovation system.

Note
Input date/time format user preference [410] controls the format of the absolute date-
time string that appears in the Start Time and End Time boxes. Clicking the C option
button shows the current time in the date-time box. Clicking the L option button
restores the time span to the one used for the last request.

The pencil icon at the right end of the date-time box toggles absolute and relative
mode. Relative time can be specified by typing the string or by using the drop-down
window activated by clicking the down arrow in the date-time box. The following
figure shows the drop-down window that can be used to specify relative time
interactively.

Figure 337. Specifying the relative time interactively

OPH070 397
To specify event filters in the Events Browser window

A few examples of relative time are as follows:

• ct – 15mi: current time minus 15 minutes
• yd – 3hr – 10mi: yesterday 00:00 minus (3 hours and 10 minutes)
5. Click OK to apply settings.

14.3.2 Specifying time span filter for Events search using the
Time Span drop-down list
Use the following steps to specify a time span filter by using the Time Span drop-down list:

1. Access the Events Browser window [389].

2. From the Events Browser window, click Set Filters. The Events Browser window updates
to show additional fields for specifying filters. Click the drop-down arrow, adjacent to
the Time Span button. The Time Span drop-down list appears.

Note
Click the drop-down arrow, adjacent to the Time Span button, to open the Time Span
drop-down list. If you click the Time Span button, the Time Span dialog box appears
[395].

Figure 338. Events Browser window -- Time Span drop-down list

398 OPH070
 To run an Event Trend from the Events Browser window

3. You can specify the time span by selecting any option from the list. For example, if the
current date is April 26, 2017 (Wednesday) and the current time is 11:45, the Event
Trends application interprets various options as described in the following table.

Table 74. Options in the Time Span drop-down list

Option Start time End time

Today April 26, 2017 April 26, 2017

00:00 11:45
Yesterday April 25, 2017 April 26, 2017

00:00 00:00
Past 7 days April 19, 2017 April 26, 2017

11:45 11:45
Past 14 days April 12, 2017 April 26, 2017

11:45 11:45
Past 21 days April 5, 2017 April 26, 2017

11:45 11:45
Past 1 Month March 26, 2017 April 26, 2017

11:45 11:45
Past 2 Months February 26, 2017 April 26, 2017

11:45 11:45

14.4 To run an Event Trend from the Events Browser

window
Use the following steps to run an Event Trend from the Events Browser window:

1. Access the Events Browser window [389].

2. Specify event filters in the Events Browser window [393].
3. Select an event record (an event) from the Event Records group. The Events Browser
window updates to show the event details for the selected record.
An event pertains to one of the following event types:
• Controller
• DEC Module
• COMTRADE
• High Speed Data Recorder

OPH070 399
Event types

4. Click Launch Trend, located at the upper-right corner of the Events Browser window.
OR
Double-click the event record.
(For example purposes, the following figure depicts the selection of a Controller event.)

Figure 339. Events Browser window

5. The Event Trend window appears for the selected event record. You can view the trend
details in the following tabs:
• Graph [403].
• Table View [405].
• Event Details [407].

14.5 Event types

You may choose the Controller, DEC module, High Speed Data Recorder (HSDR), or
COMTRADE event type from the events browser. The following is an explanation of each
event type.

Controller:

The Ovation Process Historian (OPH) stores configured Ovation Controller Triggered Events
in data files. Data collected before and after the selected variables are stored as well.

See the applicable Ovation Controller User Guide for more details.

DEC module:

The Digital Excitation Controller (DEC) module captures ultra-high frequency oscillography
data for internal DEC I/O module variables, which occurs when a configured trigger
condition is met and uses OPH to store data as events.

Select this option to browse ultra-high frequency oscillography data and launch the trend of
event variables.

400 OPH070
 Components of the Event Trend window

See the Digital Excitation Controller User Guide for more details.

High Speed Data Recorder:

The High Speed Data Recorder (HSDR) records high frequency data from Ovation
controllers, based on data recorder session configuration. The recorded data is presented as
events in the Events Browser.

Select this option to browse high frequency data from the Ovation controller and launch the
trend of event variables.

See the High Speed Data Recorder User Guide for more details.

COMTRADE:

The OPH supports the collection, storage, retrieval, and display of Common Format for
Transient Data Exchange (COMTRADE) files. User-defined Intelligent Electronics Devices
(IEDs) occasionally create event reports and store these reports in files in the standard
COMTRADE format. These files contain detailed information concerning the event,
including timestamped process values and metadata describing the values, the event, and
the source device. These files are stored at the OPH so that they can be retrieved at a later
time and analyzed.

The Ovation Controller and SCADA server currently have the ability to do minor file
management through the IEC 61850 MMS protocol. This ability is enhanced so that the
SCADA server detects when COMTRADE files are created by IEDs and sends them to the
OPH.

Select COMTRADE to browse transient power system disturbances and launch the trend of
event variables.

See IEC 61850 MMS Client Protocol with Ovation for more details.

14.6 Components of the Event Trend window

The Event Trend window consists of the following components:

• Trend Menu Button: Same as Historical Trends. See Trend Menu button [351].
• Trend Quick Access Toolbar: Different from Historical Trends. See Quick Access Toolbar
of an Event Trend [402].
• Ribbon tabs: The following tabs are available:
◦ Home ribbon tab: Same as Historical Trends. See Home ribbon tab [353].
◦ Format ribbon tab: Same as Historical Trends. See Format ribbon tab [353].
◦ Trend ribbon tab: Different from Historical Trends. See Trend ribbon tab of an
Event Trend [403].
• Dockable tabs or Trend Data Display view panels: Different from Historical Trends. The
following tabs are available:
◦ Graph tab [403].
◦ Table View tab [405].
◦ Event Details tab [407].

OPH070 401
Components of the Event Trend window

• Properties Panel: Same as Historical Trends. See Properties Panel [363].

• Details Panel: Same as Historical Trends. See Details Panel [363].
• Visibility Panel: Same as Historical Trends. See Visibility Panel [363].
• Status bar: Same as Historical Trends with few changes. See Status bar [363].

Figure 340. Components of the Event Trend window

14.6.1 Quick Access Toolbar of an Event Trend

The Event Trend window uses the Quick Access Toolbar, located near the upper-left corner
of the window, to provide an easy access to commonly used functions. This toolbar contains
icons for quick access to functionalities that would otherwise require navigating the ribbon
bars. These icons are shown in the following figure and are described in the following table.
Refer to the Ovation Operator Station User Guide for more details about the Trend Quick
Access Toolbar functions.

Figure 341. Event Trend Quick Access Toolbar

The following table describes the functions available in the Event Trend Quick Access
Toolbar, from left to right.

Table 75. Functions in the Event Trend Quick Access Toolbar

Function Description
Trend Type Allows you to activate the Live, Historical, or Event Trend.

402 OPH070
 Components of the Event Trend window

Function Description
Full Page Back and Full Page Displays a trend for a previous full page of data or next full page of
Next data, respectively.
Trace Properties Allows you to configure traces and their properties [414].

14.6.2 Trend ribbon tab of an Event Trend

Use the Trend ribbon tab to perform the following tasks:

• Specify trend trace content.

• Manage event time periods.
• Specify event data processing.
• Browse events.

These tasks define the trend content and allow you to explore the trend request results.

Note
See Event Trend specific menu options on the Trend ribbon tab [409] for the Trend ribbon
tab menu options specific to Event Trends.

The following figure depicts the Trend ribbon tab of an Event Trend.

Figure 342. Trend ribbon tab of an Event Trend

14.6.3 Graph tab of an Event Trend

The Graph tab is the main tab that is frequently used to observe process activity. The Graph
tab displays the plots of process values over a time range. The T icon in an Event Trend
indicates the moment when a triggered event occurs.

Note
Generally, the graph of a Controller-type Event Trend spreads over 3 minutes (2 minutes
before and 1 minute after the T icon).

The following figure depicts a Graph tab view for an Event Trend generated from a
Controller event.

OPH070 403
Components of the Event Trend window

Figure 343. Event Trend window -- Graph tab (Controller event)

The following figure depicts a Graph tab view for an Event Trend generated from a DEC
Module event.

Figure 344. Event Trend window -- Graph tab (DEC Module event)

404 OPH070
 Components of the Event Trend window

Note
When the graph of an Event Trend contains a lot of trend activity, it is difficult to get the
drag box to appear when you are attempting to click-drag zoom, and a circle with a slash
appears as the cursor. To override this behavior, press and hold the Control key before the
click-drag operation.

Note
Click-drag with a Control key (Control+click-drag) is also used to force a zoom, instead of a
pan, whenever the pan hand cursor appears. This is the case whenever the Display Ratio
becomes 1:1, indicating that there is no additional detail available from the buffer. The
Control+click-drag operation magnifies the existing plot data.

14.6.4 Table View tab of an Event Trend

The Table View tab displays the Event Trend results in a tabular format.

Note
The Table View tab does not display approximated rows. It displays all rows from the event
data file.

The timestamp background is displayed in the following colors:

• Green: Displays event data that falls in the time range being displayed for the trend.
• Gray: Displays event data that falls outside the time range being displayed for the
trend.

The following figure depicts a Table View for an Event Trend generated from a Controller
event.

OPH070 405
Components of the Event Trend window

Figure 345. Event Trend window -- Table View tab (Controller event)

The following figure depicts a Table View for an Event Trend generated from a DEC Module
event.

Figure 346. Event Trend window -- Table View tab (DEC Module event)

406 OPH070
 Components of the Event Trend window

14.6.5 Event Details tab of an Event Trend

The Event Details tab displays the following details about the selected event:

• Event Name: Indicates the name of a Controller or DEC event.

• Event Source: Indicates the drop where the event originates.
• Trigger Time: Indicates the time at which the triggered event occurred during the trend
time span.
• Start Time: Indicates the start time of the event trend.
• End Time: Indicates the end time of the event trend.
• Historian: Indicates the historian designated to receive triggered events.
• Interval: Indicates the scan interval of the event trend. This field only appears for DEC
events.
• Event Variables: Displays various attributes of the points in the Triggered Event list,
such as point name, description, minimum, and maximum values.
• Trigger Variables: Displays the trigger variables and their associated values.
• Trigger Condition: Displays the Boolean expression consisting of variables, operators,
and constants. When the trigger condition occurs, the data is sent to the historian for
analysis.

The following figure depicts an Event Details tab view for an Event Trend generated from a
Controller event.

Figure 347. Event Trend window -- Event Details tab (Controller event)

The following figure depicts an Event Details tab view for an Event Trend generated from a
DEC Module event.

OPH070 407
Components of the Event Trend window

Figure 348. Event Trend window -- Event Details tab (DEC Module event)

14.6.6 Interaction between Event Trend view tabs when Trace

Explorer is active
Since view tabs are dockable, you can position them so that the Graph, Table View, and
Event Details tabs are shown together (see the following figure). Moving the line cursor
adjusts the views accordingly.

408 OPH070
 Event Trend specific menu options on the Trend ribbon tab

Figure 349. Interaction between Event Trend view tabs when Trace Explorer is active

14.7 Event Trend specific menu options on the Trend

ribbon tab
The following table describes Event Trend specific menu options on the Trend ribbon tab in
the Trend window.

Table 76. Event Trend specific menu options on the Trend ribbon tab

Option Description
Browse Use this option to open the Events Browser window [389]. Use this window to specify
Events event search filters and run an Event Trend.
Refresh Use this option to refresh the trend display with newly acquired event data without
altering the time span.
Add Use this option to perform the following actions:

• Add All Points: Adds all the available points to an Event Trend.
• Add Soe Points: Adds an SOE point to an Event Trend. You can select an SOE point
from the list of available SOE points.
Set (Time Use these options to configure time span settings:
Span)
• Associated drop-down menu with the Set menu option offers convenient time
span presets for the Event Trend: 2, 6, 10, 30, 60, 120, and 180 seconds.
• Click Memorize to memorize the time range of an event trend that can be recalled
later for historical trend and event trend.
• Click Recall to recall the memorized time span and to update the trend display
accordingly.
Browse Use this option to open the Add Event Points window. The window displays a list of
Points available event points. Select points to add to a trend.

OPH070 409
Event Trend specific user preferences

Option Description
Page Back Use this option to update the trend display to show data in the preceding time span
with respect to the time span currently in effect. The associated menu options allow
navigating backward by a full page and half page.
Page Next Use this option to update the trend display to show data in the successive time span
with respect to the time span currently in effect. The associated menu options allow
going forward by a full page and half page.

14.8 Event Trend specific user preferences

The following table lists the Event Trend specific user preferences, which are specified in the
Trend Options window. The Trend Options window can be accessed by using the Trend
Menu button [351].

Table 77. Event Trend specific user preferences

User preference Description

Input Date-Time format Controls the format of a date-time string in the date-time box for
(under General tab) specifying the absolute start time and end time in the Time Span dialog
box for the Event Trend application.
Historians tab Displays a list of Ovation Process Historians to be used as a source of the
event data request.
Time Zones tab Displays frequently used time-zone abbreviations for specifying absolute
start and end time for the Event Trend time span.
Events tab See Events tab in the Trend Options window [410].

Note
Refer to the Ovation Operator Station User Guide for more information about user
preferences and the Trend Options window.

14.8.1 Events tab in the Trend Options window

The Events tab in the Trend Options window contains the following options.

Table 78. Events tab options

Option Description
Events Default Style Allows you to select a Trend file as a default style file for an Event Trend.
Enable Triggered Events Enables the event trending functionality [389].
Default Lookup Period for Specifies the default search time period (in months) for browsing events
browsing Events when the Events Browser window is launched.
Enable Soe Trending Allows trending of digital data associated with SOE messages over a
triggered event time span.
Data Recorder SOE Allows you to select Historian to access SOE data for Data Recorder
Historian Trend.

410 OPH070
 Working with Event Trends

Figure 350. Trend Options window

14.9 Working with Event Trends

You can perform the following tasks with an Event Trend:

• Zoom an Event Trend [411].

• Page through an Event Trend [412].
• Save an Event Trend [412].
• Memorize and recall a time span for an Event Trend [413].
• Specify trace properties for an Event Trend [414].
• Add a trace to an Event Trend [415].
• Remove a trace from an Event Trend [415].
• Use Chart Options in Event Trends [415].
• Add an SOE point to an Event Trend [416].

14.9.1 To zoom an Event Trend

Event Trend has a different (auto-zoom) zooming behavior than Live and Historical Trends.

In Live and Historical Trends:

• A left-click-drag magnifies the current data set.

OPH070 411
Working with Event Trends

• A right-click-drag shows a higher resolution data set.

However, in case of Event Trends, both left-click and right-click zooms produce the same
action:

• To plot a higher resolution data set until the data to plot has a Display Ratio of 1:1. After
this, both left-click and right-click show a magnified view of the raw data values.

For example, consider a 30-second DEC event with 0.390625 millisecond sample interval.
This produces 76,800 samples to represent in the Event Trend, which is far more than the
pixels to show them. The trend application processes the samples to produce a reduced
number of plot values in such a way as to not lose transients and they are written to the
graph display canvas. Initially, that 30 sec has a Display Ratio of 38:1, meaning that
approximately 2000 plots are written to the graph. When a zoom is initiated, the original
data file is reprocessed using the zoomed time span to produce a new set of ~2000 plot
values. This zoom reprocessing occurs until the Display Ratio is 1:1. At this time, the zoom
action does not reduce the number of plot samples, but plots all applicable samples,
resulting in an exact graphical presentation. Further zooming provides a shorter time span
and a magnified view of the sample values.

To restore the original Time Span, you can double-click in the graph canvas or choose the
full range option in the Set Time Span pull-down list.

14.9.2 To page through an Event Trend

Note
This function becomes active only after you perform one or more zooms on a trend. You
cannot page through an Event Trend that is showing a full range time span.

Use the Page group of the Trend ribbon tab to view previous and next time periods of the
trend data, as described in the following steps:

1. Run an Event Trend from the Events Browser window [399].

2. Modify layout, trace content and settings, and trend formatting, as desired.
3. Zoom into a shorter time range.
4. From the Event Trend window, select the Trend [403] ribbon tab [403].
5. Select the Full Page Back icon to view the trend data for the previous time span. The
previous time span will be the same length as the current time span duration.
6. Select the Full Page Next icon to view the trend data for the later time span. The later
time span will be the same length as the current time span duration.

14.9.3 To save an Event Trend

Use the following steps to save an Event Trend so that you can revisit it later:

1. Run an Event Trend from the Events Browser window [399].

412 OPH070
 Working with Event Trends

2. From the Event Trend window, click the Trend [351] Menu button [351], and then click
Save As. The Save As Trend file (TGD) dialog box appears:

Figure 351. Saving a Trend in a file

3. Select the target location.

4. Enter the file name in the File Name box.
5. Click Save As in the Save As Trend file (TGD) dialog box. The Event Trend is saved.

14.9.4 To memorize and recall a time span for an Event Trend

If you observe an issue when exploring event data for a set of points, you can observe the
activity for that same time period with a different set of points by memorizing the resultant
time period and then recalling it after loading a different trend definition.

Note
Memorize and Recall options are available for Historical and Event Trends, not for Live
Trends.

Use the following steps to memorize and recall a time span:

1. Run an Event Trend from the Events Browser window [399]

2. From the Event Trend window, select the Trend [403] ribbon tab [403].
3. Select the Memorize icon to memorize the current time span to be recalled later.
4. If desired, select the Recall icon to recall the previously memorized time span.

OPH070 413
Working with Event Trends

14.9.5 To specify trace properties for an Event Trend

You can specify the trace properties by using the Trace Properties option in the Points group
of the Trend ribbon tab [403]. The trace properties used for retrieving event data are
described in the following table.

Table 79. Trace properties in an Event Trend

Trace property Description

Historian Specifies the Ovation Process Historian that supplies event data.

Note
Use the Trend Options dialog box to specify a list of historians to be used for Event
Trends.

The following figure shows the Trace Properties window for the Event Trend application.

Figure 352. Trace Properties window for an Event Trend

414 OPH070
 Working with Event Trends

14.9.6 To add a trace to an Event Trend

You may want to add a trace to an Event Trend in the following scenarios:

• Depending on the configuration of DEC or Controller events, few points or module

variables from the event data file may fail to appear in the Event Trend due to the user
configuration. You may want to re-add those points.
• You want to re-add a trace that were previously deleted from view.

To add a trace to an Event Trend, use the Add Points button in the Trace Properties window
[414]. You can also add a trace using the + Add and Browse Points functions in the Trend
ribbon tab of an Event Trend [403].

14.9.7 To remove a trace from an Event Trend

Use the Remove Trace button in the Trace Properties window [414] to remove a trace from
an Event Trend. This action removes the point or module variable trace from the trend
views, but the data retrieved from the OPH is still available to the Event Trend client.

14.9.8 To use Chart Options in Event Trends

Chart Options allow you to select a black background for a trend and to switch the axis
positions resulting in a horizontal process range and a vertical time axis.

Use the following steps to use the Chart Options:

1. Run an Event Trend from the Events Browser window [399].

2. From the Event Trend window, select the Format ribbon tab.
3. Select the desired Chart Option(s) in the Format ribbon:
• Black Background: Select this option to display a black background for the current
trend chart. This overrides the settings that were previously defined, but it does
not delete them from the trend configuration. Therefore, if you clear this check
box, the trend chart’s previous background appears.
• Orient Vertically: Select this option to display the trend charts with a horizontal
process range and a vertical time axis. The most recent time appears at the top of
the chart.
• Trace Numbering: Select this option to display numbering on traces.
• Charts side by side: Select this option to display the trend charts side by side when
the quadrants layout is in effect.

Figure 353. Chart Options section

OPH070 415
Working with Event Trends

14.9.9 To add an SOE point to an Event Trend

Use the following steps to add an SOE point to an Event Trend:

1. Run an Event Trend from the Events Browser window [399].

2. From the Event Trend window, select the Trend [403] ribbon tab [403].
3. From the Points group, use the Add option to perform the following actions:
• Add All Points: Adds all the available points to an Event Trend.
• Add Soe Points: Adds an SOE point to an Event Trend. You can select an SOE point
from the list of available SOE points.

Figure 354. Event Trend window -- selecting SOE points

4. The Event Trend window displays the trend for the selected points, including the SOE
points, over the triggered event time span.

Figure 355. Event Trend window -- displaying SOE points

416 OPH070
 Historian Desktop Tools overview

15 Using the Historian Desktop Tools

Topics covered in this section:
• Historian Desktop Tools overview [417]
• Overview of the Microsoft Excel Add-in [417]
• Using the Microsoft Excel add-in [418]
• To use Desktop Tools Trend [463]
• To use Desktop Tools Review [463]

15.1 Historian Desktop Tools overview

The Historian Desktop Tools enable you to access process data stored in your historian from
computers other than Ovation DCS workstations. You can access the historical retrieval
applications Trend and Review, as well as use a Microsoft Excel add-in that enables you to
work with historian data in spreadsheet form. You can also deploy the Desktop Tools to
install the Microsoft Excel add-in to Ovation operator consoles.

The Historian Desktop Tools contain:

• Microsoft Excel add-in [418]. Microsoft Excel 2007, 2010, 2013, and 2016 are
supported.

Note
Ensure Microsoft Excel is installed before you install Historian Desktop Tools on a
system.

• Trend [463].
• Review [463].

Trend, Review, and the Excel Add-in consume a license whenever the product is launched on
a Desktop Tools machine. One license is consumed per machine regardless of the number of
Desktop Tools applications running simultaneously on that machine.

These three areas of Desktop Tools functionality are described further in the following
sections.

15.2 Overview of the Microsoft Excel Add-in

The Excel Add-In provides integration of the Historian data with Excel spreadsheets. The
following is a list of the key features of the Add-in:

• Supports Excel 2007, 2010, 2013, and 2016.

• Supports time formats. Selection of UTC or Local.

OPH070 417
Using the Microsoft Excel add-in

• Query formulas are entered using dialog boxes or directly into the worksheet cell with
dialogs accessible from the menu bar or toolbar.
• Queries allow the specification of a returned data cell range and optionally limit results
on execution. If a range is not specified, all result rows are allowed. Warns you if non-
empty cells will be overwritten.
• Queries within cells may reference other cells as parameters for example, point name,
historian, and time range.
• Supports single or multiple point names in single query.
• Dialog or direct queries support usage of absolute content or cell references.
• Supports browse of the Historian for point selection in dialogs.
• Supports ability to save multiple queries in single worksheet.
• Same worksheet may contain queries accessing different historians.
• Same worksheet may contain queries utilizing different time ranges.
• Supports absolute time range specification.
• Queries are stored in a cell and may be edited in subsequent session with dialogs or
directly.
• Queries can be copied from one cell to another and follow MS Excel convention for
adjusting referenced cells (relative and absolute cell refs).
• Queries can contain references to other cells that are result of a different query.
• Provides the ability to refresh all formulas (cells) on demand or when worksheet
opened.
• Supports a retrieval of configuration for Point attributes, Point Raw values, Point
Processed values and messages.
• Attribute configuration for Timestamp, Value, Status, and Status evaluation. Column
selection is supported using column attributes.
• Sample flags support indication of missing data ranges including setting of value and
status columns.
• Supports filtering and sorting of message content by time, point name, type, subtype,
origin.
• Integrates Historian Add-in functions into the Excel Wizard using the Insert function.
• View Query Result Statistics button on dialogs to determine result size.

15.3 Using the Microsoft Excel add-in

Use the following steps to access a data query window by using the Microsoft Excel add-in:

1. Access the Excel add-in by opening Microsoft Excel. The Historian menu appears in the
menu bar.

418 OPH070
 Using the Microsoft Excel add-in

2. Choose the Historian pull-down menu.

Figure 356. Historian pull-down menu

3. Select the type of Query you wish to start. The options are Aggregate Data, Point
Attribute, Configuration, Raw Data, and Message. The Queries can also be accessed by
choosing the corresponding shortcut button on the toolbar.

Figure 357. Historian toolbar

If you are using Microsoft Office 2007, the Queries options appear in the Ribbon Bar.

Figure 358. Microsoft Office 2007 Ribbon Bar

OPH070 419
Using the Microsoft Excel add-in

4. The appropriate data query window appears. Each data query window is specific to the
type of data requested. Use the window to define your desired query:
• Aggregate Data Query [420].
• Point Attribute Query [429].
• Message Query [430].
• Configuration Query [433].
• Raw Data Query [434].
• Refresh Query [437].
• Options: When you click Options, the Options Dialog appears. The dialog box
allows you to choose the retrieval mode for the data. You can select from the
following modes:
◦ Get original value.
◦ Get latest value.
◦ Get all values.

Figure 359. Options Dialog

15.3.1 To use the Aggregate Data Query

The Aggregate Data Query retrieves periodic aggregates for points in the OPH. Aggregate
data is a calculation at periodic interval boundaries.

Use the following steps to run an Aggregate Data Query:

420 OPH070
 Using the Microsoft Excel add-in

1. Access the Aggregate Data Query window [418]. The window appears:

Figure 360. Aggregate Data Query window

2. Choose the Historian from which you would like to retrieve data.

OPH070 421
Using the Microsoft Excel add-in

3. Choose the Point names for which you would like data. There are three ways to choose
the points. You can choose from the following options:
• Browse from Server.
• Specify Point.
• Refer to Excel Cell.

Figure 361. Input types

422 OPH070
 Using the Microsoft Excel add-in

4. If you choose Browse from Server from the input types, the Browse and Select Point(s)
dialog box appears:

Figure 362. Browse and Select Point(s) dialog box

The following table describes the options in the Browse and Select Point(s) dialog box.

Table 80. Options in the Browse and Select Point(s) dialog box

Item Description Setting options

Point Name Allows you to select only point names that Point name filter.
match a specified name filter.
For example, BLK001%
Description Allows you to select points where Description filter
description matches a specified
description filter. For example, %Temperature
%
Type Allows you to filter data by type. R - real/analog points

P - packed points

D - digital points

OPH070 423
Using the Microsoft Excel add-in

Item Description Setting options

All - all points
Category Allows you to select a group of points.
Show Only Enabled When checked, only enabled points are Checked
Points searched.
Not checked
Exclude Lab Data When checked, Lab Data and Internal Checked
and Internal Points Points are excluded from the search.
Not checked
Find Perform search
Ok Accepts the operation. This action returns
you to the previous screen and the Points
you have selected now appear in the
Points field of the interface being used.
Cancel Cancels the operation.
Point Name The Point Name field is populated when a
point is selected. The English description
Description for the point populates in the Description
field.
The paging options may appear differently in different versions of the Browse dialog.

5. If you choose Specify Point from the input types, the Specify Point Names dialog box
appears. Enter the point names in the text box.

Figure 363. Specify Point Names dialog box

424 OPH070
 Using the Microsoft Excel add-in

6. If you choose Refer to Excel cell from the input types, the Point Names dialog box
appears:

Figure 364. Point Names dialog box

7. Click Param in the Aggregate Data Query window to launch the Point Parameters
dialog box. The dialog box allows you to define point parameters.

Figure 365. Point Parameters dialog box

8. Return to the Aggregate Data Query window and select the starting location.

OPH070 425
Using the Microsoft Excel add-in

9. Choose the Output type, Formula or Text.

Figure 366. Text option Excel example

10. Choose the Header type. The options are Minimum Header, Detailed Header, or No
Header.

426 OPH070
 Using the Microsoft Excel add-in

11. Choose the time interval for the query.

• To specify intervals of days, use either of the following formats:
◦ ID(n). ID is equivalent to ID(1).
◦ INTERVALDAY(n)
◦ INTERVAL_DAY(n)
Where, n is an integer for intervals in days.
• To specify intervals of months, use either of the following formats:
◦ IM(n). IM is equivalent to IM(1).
◦ INTERVALMONTH(n)
◦ INTERVAL_MONTH(n)
Where, n is an integer for intervals in months.
• To specify intervals of years, use either of the following formats:
◦ IY(n). IY is equivalent to IY(1).
◦ INTERVALYEAR(n)
◦ INTERVAL_YEAR(n)
Where, n is an integer for intervals in years.

Note
Emerson recommends that you use the abbreviated interval terms due to formula
space availability.

12. You can choose to limit the output to a specific number of rows by clicking the Limit
output to box and specifying a number of rows.
13. Enter your date and time information. You can choose UTC or local time in the Time
Zone field. You may also reference cells by choosing the spreadsheet button.
14. Choose the columns for which you would like data to be retrieved by choosing the
column name in the Available columns area and moving them to the Selected columns
area by clicking > or >>. If you select a column that allows Attributes, the Attributes
button is active. See Reference details [437] for available attributes.

Figure 367. Column Attribute

OPH070 427
Using the Microsoft Excel add-in

15. This step is optional. You may choose to View Query Result Statistics to preview the
details of the query. A Query Result Statistics window appears. Choose Ok to close this
window.

Figure 368. Query Result Statistics window

16. Choose Finish to start the data Query.

17. The result of the query appears in the Excel spreadsheet.

Figure 369. Result Query

428 OPH070
 Using the Microsoft Excel add-in

15.3.2 To use the Point Attribute Query

Attributes are stored for each point in the system and may be retrieved into Excel sheets.

Use the following steps to run a Point Attribute Query:

1. Access the Point Attribute Data Query window [418]. The window appears:

Figure 370. Point Attribute Query window

2. Choose the Historian from which you would like to retrieve data.
3. Choose the Point names for which you would like data. There are three ways to choose
the points. You can choose from the following options:
• Browse from Server.
• Specify Point.
• Refer to Excel Cell.
4. Enter your Output information. Choose the starting location, Output Type, and Header
Type. You can choose to limit your output to a number of rows.
5. Enter your date and time information or refer to a cell. Make sure that the time range
specified is large enough to find available attributes. You may also leave this blank
when querying attributes to retrieve the most recent attribute.
6. Choose the columns for which you would like data to be retrieved by choosing the
column name in the Available columns area and moving them to the Selected columns
area by clicking > or >>. If you select a column that allows Attributes, the Attributes
button is active.

OPH070 429
Using the Microsoft Excel add-in

7. This step is optional. Choose View Query Result Statistics to preview the details of the
query. A Query Result Statistics window appears. Choose Ok to close this window.

Figure 371. Query Result Statistics window

8. Choose Finish to start the data Query.

9. The result of the query appears in an Excel spreadsheet.

15.3.3 To use the Message Query

Use the following steps to run a Message Query:

430 OPH070
 Using the Microsoft Excel add-in

1. Access the Message Data Query window [418]. The window appears:

Figure 372. Message Query window

2. Select the historian from which you would like to retrieve data.
3. Select the type of message that you want to retrieve. The options are:
• Alarm
• Text
• SOE
• Operator Event
• SIS

OPH070 431
Using the Microsoft Excel add-in

4. Select the point names for which you would like to retrieve data. The options are:
• All points: Use this option to select all points from the historian.
• Single point: Use this option to select specific points from the historian. Select the
Exact match check box if you want to match the point name exactly. When you
select the Single point option, the Input type drop-down field is enabled, which
allows you to select the points using the following options:
◦ Browse from Server: Click the ellipses (...) button. Select the points from the
Browse and Select Point(s) window.
◦ Specify Point: Click the ellipses (...) button. Specify the points in the Specify
Point Names window. Use comma to separate point names.
◦ Refer to Excel Cell: Click the ellipses (...) button. Select the points from the
Excel spreadsheet by providing a cell reference.
5. Enter your Output information.
a. Select the Starting location, Output type, and Header type.
b. Select the Limit output to check box if you want to limit your output to a number
of rows. Specify the number of rows in the adjacent field.
6. Enter your date and time information or refer to a cell. From the Time zone drop-down
list, select Local or UTC.
7. Choose the columns for which you would like data to be retrieved by choosing the
column name in the Available columns area and moving them to the Selected columns
area by clicking > or >>. If you select a column that allows Attributes, the Attributes
button is active.
Alternatively, you can use the Refer to Excel cell option. Select the message columns
from the Excel spreadsheet by providing a cell reference.
8. Enter any required message filters.
9. (Optional) Click View Query Result Statistics to preview the details of the query. A
Query Result Statistics window appears. Click OK to close this window.

Figure 373. Query Result Statistics window

10. Click Finish to start the data query.

432 OPH070
 Using the Microsoft Excel add-in

11. The result of the query appears in an Excel spreadsheet.

15.3.4 To use the Configuration Query

Use the following steps to run a Configuration Query:

1. Access the Configuration Query window [418]. The window appears:

Figure 374. Configuration Query window

2. Choose the Historian from which you would like to retrieve data.
3. Choose the Point names for which you would like data. There are three ways to choose
the points. You can choose from the following options:
• Browse from Server.
• Specify Point.
• Refer to Excel Cell.
4. Enter your Output information. Choose the starting location, Output Type and Header
Type. You can choose to limit you output by number of rows.
5. Choose the columns for which you would like data to be retrieved by choosing the
column name in the Available columns area and moving them to the Selected columns
area by clicking > or >>. If you select a column that allows Attributes, the Attributes
button is active.

OPH070 433
Using the Microsoft Excel add-in

6. This step is optional. Choose View Query Result Statistics to preview the details of the
query. A Query Result Statistics window appears. Choose Ok to close this window.

Figure 375. Query Result Statistics window

7. Choose Finish to start the data Query.

8. The result of the query appears in an Excel spreadsheet.

15.3.5 To use the Raw Data Query

Use the following steps to run a Raw Data Query:

434 OPH070
 Using the Microsoft Excel add-in

1. Access the Raw Data Query window [418]. The window appears:

Figure 376. Raw Data Query window

2. Choose the Historian from which you would like to retrieve data.
3. Choose the Point names for which you would like data. There are three ways to choose
the points. You can choose from the following options:
• Browse from Server.
• Specify Point.
• Refer to Excel Cell.

OPH070 435
Using the Microsoft Excel add-in

4. Click Param in the Raw Data Query window to launch the Point Filter Parameters dialog
box. The dialog box allows you to set condition filters on selected points.

Figure 377. Point Filter Parameters dialog box

5. Return to the Raw Data Query window and enter your Output information. Choose the
starting location, Output Type and Header Type. You can choose to limit your output to
a number of rows.
6. Enter your date and time information or cell reference.
7. Choose the columns for which you would like data to be retrieved by choosing the
column name in the Available columns area and moving them to the Selected columns
area by clicking > or >>. If you select a column that allows Attributes, the Attributes
button is active.
8. This step is optional. Choose View Query Result Statistics to preview the details of the
query. A Query Result Statistics window appears. Choose Ok to close this window.

Figure 378. Query Result Statistics window

9. Choose Finish to start the data Query.

436 OPH070
 Using the Microsoft Excel add-in

10. The result of the query appears in an Excel spreadsheet.

15.3.6 To use the Refresh Query

The Refresh Query option in the Microsoft Excel Add-in [418] refreshes the current data on
the Excel sheet.

15.3.7 Error displaying a large amount of data

When Excel is displaying a large amount on data on its worksheet(s), the OPH Excel Add-in
may not be able to allocate a large enough buffer to perform a new query, or refresh an
existing query. In addition, a large amount of redo information retained by Excel may
exacerbate the issue. In such cases, the following error message may appear:

Figure 379. Error message

For the Excel 2013 version, which runs all instances of itself within a single process, consider
the following options to minimize such errors:

• The size of the buffer required by the Add-in is a function of the number of columns
requested in a query. It is recommended that you select only the columns required for
the query. Keep the results to a manageable number of rows (below 100,000).
• Redo information is a function of the number of cells currently in use and changes to
them accordingly. Using the Add-in dialog boxes to refresh a query does not consume
redo information. Forcing a recalculation of the formulas (Ctrl+Alt+F9 or Ctrl+Shift
+Enter on the formula) does consume redo information. Do not use these tools if a
query is refreshed.

For versions prior to Excel 2013, which use separate processes for each instance, consider
the following options to minimize such errors:

• Splitting large queries into two or more instances of Excel.

• Using separate instances of Excel to run unrelated large queries.

15.3.8 Reference details

There are three ways to define function outputs: using the dialogs, insert function, or copy/
paste.

• Choose the insert function button in Microsoft Excel. The Function Arguments dialog
box appears:

OPH070 437
Using the Microsoft Excel add-in

Figure 380. Function Arguments dialog box

You must press Ctrl + Shift + Enter for an array formula or choose Enter for text output.
• Choose to Copy and Paste into a cell by pressing Ctrl + C and Ctrl + V, and press <enter>
for a text formula.

You can use the following functions while working on the historian Excel add-in.

• OPHGetPointAttr( ) function [441].

• OPHGetPointConfig( ) function [443].
• OPHReadMsgData( ) function [449].
• OPHReadProcData( ) function [456].
• OPHReadRawData( ) function [461].

OPHGetPointAttr
Retrieves the point attributes from historian.

Syntax (OPHGetPointAttr)
OPHGetPointAttr(connection_string,

point_names,

column_names,

start_time,

end_time,

time_zone,

header_style,

438 OPH070
 Using the Microsoft Excel add-in

data_count)

Parameters (OPHGetPointAttr)

Table 81. Parameters for the OPHGetPointAttr( ) function

Parameter Description
connection_string [in] Specifies the historian drop to connect to. Use empty string ("") to specify
default historian.
point_names [in] Specifies the point names to retrieve. Use comma to separate point names.
column_names [in] Specifies the column names to display. Use the following format:

"columnname1(attribute1, attribute2, …), columnname2, …"

start_time [in] Specifies the start time of data to retrieve. Use the following format:

"mm/dd/yyyy hh:mm:ss {D|S}"

end_time [in] Specifies the end time of data to retrieve. Use the following format:

"mm/dd/yyyy hh:mm:ss {D|S}"

time_zone [in] Specifies the time zone format of start time and end time. Use the following
values:

0 = Local or 1 = UTC

Default value in the UI is Local.

Note
The D/S notation for start and end time entries is not supported in the cell
reference mode for locales whose date format is not mm/dd/yyyy. If used in
such a situation, the time string is interpreted as the mm/dd/yyyy format when
the formula is recalculated by Excel, which leads to unexpected results. To avoid
this issue, either do not use the D/S notation, place the time strings directly into
the formula, or specify the cell referenced time strings in the UTC format.

header_style [in] Specifies the header style to display. Use the following values:

0 = Minimum Header, 1 = Detailed Header, or -1 = No Header

Default value in the UI is Minimum Header.

data_count [in] Specifies the maximum records to display. Use the following values:

-1 = All rows or >0 = N rows

Return value (OPHGetPointAttr)

If output type specified in the UI is Formula, it returns the results as formula array;
otherwise, it returns the results in text format. If query is specified using Excel's Insert
Function, it returns the results as formula array.

Remarks (OPHGetPointAttr)
For connection_string, you may specify a host name or network IP address. You may specify
actual value or cell reference.

OPH070 439
Using the Microsoft Excel add-in

For point_names, when specifying cell reference, you may specify a list of point names in
one cell or you may put each point name in separate cell.

For a list of column names and attributes, see OPHGetPointAttr( ) function [441]. For
column_names, you may specify actual value or cell reference.

For start_time and end_time, you may specify empty string ("") to return the latest point
attributes. The D (for daylight) or S (for standard) postfix, to distinguish between the
otherwise ambiguous times that occur during the “repeated” hour for the daylight savings
time, is applicable only when time_zone is set to 0 (Local). You may specify actual value or
cell reference.

For time_zone, header_style, and data_count, you may specify actual values but not call
references.

When using cell reference, the required format for the parameter should be specified.

The following are applicable only if query is specified using Insert Function: When one of the
arguments is invalid, the function displays #VALUE! in the selected cells. When the number
of records returned is less than the selected number of rows, the function displays #N/A in
the remaining rows.

Examples (OPHGetPointAttr)
The following example retrieves the point attributes:

OPHGetPointAttr("", /* uses default historian */

"blk00101c1a.unit2@mannet2, blk00101c2a.unit2@mannet2",

"TS(T1), ED, LL", /* displays timestamp (in UTC format), description */

/* and low limits columns */

"11/01/2007 [Link]",

"11/01/2007 [Link]",

0, /* start time and end time is in local time */

0, /* displays minimum header */

100) /* displays 100 records */

The following example retrieves the point attributes using point names as cell reference:

OPHGetPointAttr("drop160",

Sheet1!$A$2, /* cell reference is in R1C1 absolute format */

"TS(T1), ED, LL", /* displays timestamp, description and */

/* low limits columns */

"11/01/2007 [Link]",

"11/01/2007 [Link]",

440 OPH070
 Using the Microsoft Excel add-in

1, /* start time and end time is in UTC */

1, /* displays detailed header */

10) /* displays 10 records */

The following example retrieves the latest point attributes:

OPHGetPointAttr("drop160",

Sheet1!$A$2, /* cell reference is in R1C1 absolute format */

"TS(T1), ED, LL", /* displays timestamp, description and /*

/* low limits columns */

"", /* uses empty string in start time and end time */

"", /* to get latest attribute */

1, /* returned timestamp will use UTC format */

1, /* displays detailed header */

10) /* displays 10 records */

OPHGetPointAttr( ) function
The following table describes the possible values of the column_names argument.

Table 82. Possible values of the column_names argument

OPH table Excel add-in Column Column attribute Comment

column name attribute format
column name
ID ID
TIMESTAMP TS Tn TS(Tn) Displays column
value using
Where, specified time zone.

n – corresponds to
time zone. Use the Note
following values: Uses time zone
specified in the
1 – Local time_zone
argument if
2 – UTC
attribute is not
specified.
3 – Local D/S

TIME_NSEC NS
SAMP_FLAGS SF
DESCRIPTION ED
AUX_DESCRIPTION AD
ENGINEERING_UNITS EU

OPH070 441
Using the Microsoft Excel add-in

OPH table Excel add-in Column Column attribute Comment

column name attribute format
column name
SET_DESCRIPTION ST
RESET_DESCRIPTION RS
SIGNIFICANT_DIGITS FM
BOTTOM_SCALE BV
TOP_SCALE TV
LOW_LIMIT LL
HIGH_LIMIT HL
CHARACTERISTICS PC
PN (Point Derived value based
Name) on ID column.

Note
LATITUDE (GX), LONGITUDE (GY), and ALTITUDE (GZ) can be returned, but are reserved for future
use.

OPHGetPointConfig
Retrieves the point configuration from historian.

Syntax (OPHGetPointConfig)
OPHGetPointConfig(connection_string,

point_names,

column_names,

header_style)

Parameters (OPHGetPointConfig)

Table 83. Parameters for the OPHGetPointConfig( ) function

Parameter Description
connection_string [in] Specifies the historian drop to connect to. Use empty string ("") to specify
default historian.
point_names [in] Specifies the point names to retrieve. Use comma to separate point names.
column_names [in] Specifies the column names to display. Use the following format:

"columnname1(attribute1, attribute2, …), columnname2, …"

header_style [in] Specifies the header style to display. Use the following values:

0 = Minimum Header, 1 = Detailed Header or -1 = No Header

Default value in the UI is Minimum Header.

442 OPH070
 Using the Microsoft Excel add-in

Return value (OPHGetPointConfig)

If output type specified in the UI is Formula, it returns the results as formula array;
otherwise, it returns the results in text format. If query is specified using Insert Function, it
returns the results as formula array.

Remarks (OPHGetPointConfig)
For connection_string, you may specify a host name or network IP address. You may specify
actual value or cell reference.

For point_names, when specifying cell reference, you may specify a list of point names in
one cell or you may put each point name in separate cell.

For a list of column names and attributes, see OPHGetPointConfig( ) function [443]. For
column_names, you may specify actual value or cell reference.

For header_style, you may only specify actual value but not cell reference.

When using cell reference, the required format for the parameter should be specified.

The following are applicable only if query is specified using Insert Function: When one of the
arguments is invalid, the function displays #VALUE! in the selected cells. When the number
of records returned is less than the selected number of rows, the function displays #N/A in
the remaining rows.

Example (OPHGetPointConfig)
The following example retrieves point configuration.

OPHGetPointConfig("drop160",

"blk00101c1a.unit2@mannet2, blk00101c2a.unit2@mannet2",

"SN, SRC", /* displays source name and source ID columns */

/* displays minimum header */

OPHGetPointConfig( ) function
The following table describes the possible values of the column_names argument.

Table 84. Possible values of the column_names argument

OPH table Excel add-in Column Column attribute Comment

column attribute format
column name name
ID ID
PT_FLAGS PF
SOURCE_ID SRC
SOURCE_NAME SN
CATEGORY CAT
IMPORTED IM
ENABLED EN

OPH070 443
Using the Microsoft Excel add-in

OPH table Excel add-in Column Column attribute Comment

column attribute format
column name name
DATA_TYPE DT
INVERTED INV
SCAN_MSECS SMS
DB_ALGCODE DBAC
DB_ALGNAME DBA
DB_VAL DBV
DB_K_VAL DBK
DB_N_VAL DBN
SCAN_GROUP_ID SGI
PT_INFO PI
CREATION_TIME CT Tn CT(Tn) Displays column value
using specified time
Where, zone.

n – corresponds to time
zone. Use the following Note
values:
Uses the time zone
1 – Local specified in the
time_zone argument if
2 – UTC attribute is not
specified.
3 – Local D/S
MODIFY_TIME MT Tn MT(Tn) Displays column value
using specified time
Where, zone.

n – corresponds to time
zone. Use the following Note
values:
Uses the time zone
1 – Local specified in the
time_zone argument if
2 – UTC attribute is not
specified.
3 – Local D/S
MAX_SAVE_TIME MST
SOURCE_TYPE ST
PN (Point Derived value based on
Name) ID column.

OPHReadMsgData
Retrieves the message data from historian.

Syntax (OPHReadMsgData)
OPHReadMsgData(connection_string,

444 OPH070
 Using the Microsoft Excel add-in

message_type,

point_name,

column_names,

message_filters,

start_time,

end_time,

time_zone,

header_style,

data_count)

Parameters (OPHReadMsgData)
Table 85. Parameters for the OPHReadMsgData( ) function

Parameter Description
connection_string [in] Specifies the historian drop to connect to. Use empty string ("") to specify
default historian.
message_type [in] Specifies the message type to retrieve. Use the following values:

0 = Alarm, 1 = Text, 2 = SOE, 3 = Operator Event, or 4 = SIS message

point_name [in] Specifies the point name filter. Use empty string ("") to specify all points.
column_names [in] Specifies the column names to display. Use the following format:

"columnname1(attribute1, attribute2, …), columnname2, …"

OPH070 445
Using the Microsoft Excel add-in

Parameter Description
message_filters [in] Specifies the message filters to apply. A numeric value should be specified
for each message filter. Use -1 to specify no filtering.

Use the following format:

• Alarm: "source_id, system_id, drop_id, type, filter, exact_match, value,

code, description, priority, plant_mode, units, limits, quality, point_type,
incr"
exact_match is either 0 or 1, with 1 indicates using an exact match. An
exact match means matching the point name exactly.
priority and plant_mode are both integers.
All other fields are text strings.
No value specified means do not filter on that field.
• SOE: "source_id, system_id, drop_id, exact_match, soe_format, state,
description, soe_flags, point_sid, dpu_error"
exact_match is either 0 or 1, with 1 indicates using an exact match. An
exact match means matching the point name exactly.
soe_flags and point_sid are unsigned long integers and can be specified in
decimal or hexadecimal values. To specify hexadecimal values, prefix the
value with 0x.
All other fields are text strings.
No value specified means do not filter on that field.
• Text: "source_id, system_id, drop_id, subtype, domain, username,
exact_match"
exact_match is either 0 or 1, with 1 indicates using an exact match. An
exact match means matching the point name exactly.
domain and username are both strings.
No value specified means do not filter on that field.
• Operator Event: "source_id, system_id, drop_id, subtype, domain,
username, exact_match, reason"
exact_match is either 0 or 1, with 1 indicates using an exact match. An
exact match means matching the point name exactly.
domain, username, and reason are all strings.
No value specified means do not filter on that field.
• SIS: "source_id, system_id, drop_id, subtype, domain, username,
exact_match"
exact_match is either 0 or 1, with 1 indicates using an exact match. An
exact match means matching the point name exactly.
domain and username are both strings.
No value specified means do not filter on that field.
start_time [in] Specifies the start time of data to retrieve. Use the following format:

"mm/dd/yyyy hh:mm:ss {D|S}"

end_time [in] Specifies the end time of data to retrieve. Use the following format:

"mm/dd/yyyy hh:mm:ss {D|S}"

time_zone [in] Specifies the time format of start time and end time. Use the following
values:

0 = Local or 1 = UTC. Default value in the UI is Local

446 OPH070
 Using the Microsoft Excel add-in

Parameter Description
header_style [in] Specifies the header style to display. Use the following values:

0 = Minimum Header, 1 = Detailed Header, or -1 = No Header

Default value in the UI is Minimum Header.

data_count [in] Specifies the maximum records to display. Use the following values:

-1 = All rows or >0 = N rows

Return value (OPHReadMsgData)

If output type specified in the UI is Formula, it returns the results as formula array;
otherwise, it returns the results in text format. If query is specified using Insert Function, it
returns the results as formula array.

Remarks (OPHReadMsgData)
For connection_string, you may specify a host name or network IP address. You may specify
actual value or cell reference.

For point_names, when specifying cell reference, you may specify a list of point names in
one cell or you may put each point name in separate cell.

For a list of column names and corresponding attributes, see OPHReadMsgData( ) function
[449]. For column_name, you may specify actual value or cell reference.

For start_time and end_time, the D or S postfix is applicable only when time_zone is set to 0
(Local). You may specify actual value or cell reference.

For time_zone, header_style, and data_count, you may only specify actual values but not
cell references.

When using cell reference, the required format for the parameter should be specified.

The following are applicable only if query is specified using Insert Function: When one of the
arguments is invalid, the function displays #VALUE! in the selected cells. When number of
records returned is less than the selected number of rows, the function displays #N/A in the
remaining rows.

Examples (OPHReadMsgData)
The following example retrieves alarm message:

OPHReadMsgData("drop160",

0, /* queries alarm message type */

"", /* displays all points */

"PN, PT", /* displays point name and primary text columns */

"-1, -1, -1, -1, -1", /* no filters */

"7/6/2006 [Link]",

"7/6/2006 [Link]",

OPH070 447
Using the Microsoft Excel add-in

1, /* start time and end time is in UTC */

1, /* displays detailed header */

10) /* displays 10 records */

The following example retrieves text message:

OPHReadMsgData("", /* uses default historian */

1, /* queries text message type */

"", /* displays all points */

"TS, MT, PT(F1)", /* displays timestamp, message type and */

/* primary text (message text attribute) columns */

"2, -1, -1, -1", /* filters on source id = 2 */

"4/2/2007 [Link]",

"4/2/2007 [Link]",

0, /* start time and end time is in local time */

0, /* displays minimum header */

-1) /* displays all records */

The following example retrieves SOE message:

OPHReadMsgData("", /* uses default historian */

2, /* queries SOE message type */

"", /* displays all points */

"TS(T2), SYS, PT(F1)", /* displays timestamp (in UTC format), system type */

/* and primary text (English description */

/* field attribute) columns */

"2, -1, -1", /* filters on source id = 2 */

"4/2/2007 [Link]",

"4/2/2007 [Link]",

0, /* start time and end time is in local time */

0, /* displays minimum header */

-1) /* displays all records */

The following example retrieves operator event message:

OPHReadMsgData("", /* uses default historian */

448 OPH070
 Using the Microsoft Excel add-in

3, /* queries operator event message type */

"", /* displays all points */

"TS(T3), PT(F1)", /* displays timestamp (in local D/S format), */

/* and primary text (message text */

/* field attribute) columns */

"-1, -1, -1, -1", /* no filters */

"4/2/2007 [Link]",

"4/2/2007 [Link]",

0, /* start time and end time is in local time */

0, /* displays minimum header */

-1) /* displays all records */

OPHReadMsgData() function
The following tables describe the possible values of the column_names argument for
different message types.

Table 86. Alarm message type

OPH table Excel add- Column Column attribute format Comment

in column attribute
column name name
TIMESTAMP TS Tn TS(Tn) Displays column value
using specified time zone.
Where,

n – corresponds to time Note

zone. Use the following
values: Uses time zone specified
in the time_zone
1 – Local argument if attribute is
not specified.
2 – UTC

3 – Local D/S
TIME_NSEC NS
MSG_FLAGS MF
SOURCE_ID SRC
SYSTEM SYS
NODE NOD

OPH070 449
Using the Microsoft Excel add-in

OPH table Excel add- Column Column attribute format Comment

in column attribute
column name name
PRIM_TEXT PT Ln PT(Ln) Displays column value
with specified maximum
Fn Where, number of characters.

n – number of characters to
display. Maximum value is Note
200.
Displays all characters in
the column if attribute is
PT(Fn)
not specified.
Where,

n – corresponds to the field Extracts value of specified

number. Use the following field.
values:
Note
1 – Description field
Displays value of column
2 – Alarm priority field if attribute is not
specified.
3 – Value field
MSG_TYPE MT
SUB_TYPE ST
ALM_NAME PN
ALARM_INFO1 ALI1

Table 87. SOE message type

OPH Table Excel Add- Column Column Attribute Comment

in Column Attribute
Column Name Format
Name
TIMESTAMP TS Tn TS(Tn) Displays column value
using specified time
Where, zone.

n – corresponds to time zone.

Use the following values: Note

1 – Local Uses time zone specified

in the time_zone
2 – UTC argument if attribute is
not specified.
3 – Local D/S
TIME_NSEC NS
MSG_FLAGS MF
SOURCE_ID SRC
SYSTEM SYS
NODE NOD

450 OPH070
 Using the Microsoft Excel add-in

OPH Table Excel Add- Column Column Attribute Comment

in Column Attribute
Column Name Format
Name
PRIM_TEXT PT Ln PT(Ln) Displays column value
with specified maximum
Fn Where, number of characters.

n – number of characters to
display. Maximum value is Note
200.
Displays all characters in
PT(Fn) the column if attribute is
not specified.
Where,

n – corresponds to the field Extracts value of

number. Use the following specified field.
values:

1 – English description field Note

2 – Set description field Displays value of column
if attribute is not
3 – Reset description field specified.

4 – Point name field

SOE_INFO1 SOEI1

Table 88. Text message type or Operator Event

OPH Table Excel Add- Column Column Attribute Format Comment

in Column Attribute
Column Name
Name
TIMESTAMP TS Tn TS(Tn) Displays column value
using specified time
Where, zone.

n – corresponds to time zone.

Use the following values: Note
Uses the time zone
1 – Local specified in the
time_zone argument if
2 – UTC
attribute is not
specified.
3 – Local D/S

TIME_NSEC NS
MSG_FLAGS MF
SOURCE_ID SRC
SYSTEM SYS
NODE NOD

OPH070 451
Using the Microsoft Excel add-in

OPH Table Excel Add- Column Column Attribute Format Comment

in Column Attribute
Column Name
Name
PRIM_TEXT PT Ln PT(Ln) Displays column value
with specified
Fn Where, maximum number of
characters.
n – number of characters to
display. Maximum value is
200. Note
PT(Fn) Displays all characters in
the column if attribute
Where, is not specified.

n – corresponds to the field

number. Use the following Extracts value of
values: specified field.

1 – Message text field

Note
2 - Point Name
Displays value of
3 - Qualified Point Name column if attribute is
not specified.
4 - Description

5 - New Value

6 - Previous Value
MSG_TYPE MT
SUB_TYPE ST
SUPP_TEXT STX
SUPP_INFO1 SI1
SUPP_INFO2 SI2

The following table describes the possible values of the message_filters argument for the
Alarm message type.

Table 89. Alarm message type

Filter Value Description

1 ALMTYPE_RETURN
2 ALMTYPE_SENSOR
4 ALMTYPE_HIGH
8 ALMTYPE_HI_WRS
16 ALMTYPE_HI_BET
32 ALMTYPE_HI_UDA
64 ALMTYPE_HI_WRS_UDA
128 ALMTYPE_HI_BET_UDA

452 OPH070
 Using the Microsoft Excel add-in

Filter Value Description

256 ALMTYPE_LOW
512 ALMTYPE_LOW_WRS
1024 ALMTYPE_LOW_BET
2048 ALMTYPE_LOW_UDA
4096 ALMTYPE_LOW_WRS_UDA
8192 ALMTYPE_LOW_BET_UDA
16384 ALMTYPE_SP_ALM
32768 ALMTYPE_TIME_OUT
65536 ALMTYPE_SID_ALM
131072 ALMTYPE_ALARM
262144 ALMTYPE_ST_CHG
524288 ALMTYPE_INCR_ALARM
1048576 ALMTYPE_HIGH_HIGH
2097152 ALMTYPE_LOW_LOW
4194304 ALMTYPE_DEVICE

OPHReadProcData
Retrieves the aggregate (processed) data from historian.

Syntax (OPHReadProcData)
OPHReadProcData(connection_string,

point_names,

point_filters,

point_options,

point_constants,

point_bitpositions,

column_names,

start_time,

end_time,

time_interval,

time_zone,

header_style,

data_count)

OPH070 453
Using the Microsoft Excel add-in

Parameters (OPHReadProcData)
Table 90. Parameters for the OPHReadProcData( ) function

Parameter Description
connection_string [in] Specifies the historian drop to connect to. Use empty string ("") to specify
default historian.
point_names [in] Specifies the point names to retrieve. Use comma to separate point names.
point_filters [in] Specifies the point filters to apply. A numeric value should be specified for
each point filter. Use the following format:

"pointname1_filter, pointname2_filter, …"

Default value in the UI is OPH_NOP (0).

point_options [in] Specifies the point options. A numeric value should be specified for each
point option. Use the following format:

"pointname1_option, pointname2_option, …"

Default value in the UI is OPH_GLITCH (1).

point_constants [in] Specifies the integration constants. A numeric value should be specified for
each point constant. Use the following format:

"pointname1_constant, pointname2_constant, …"

Default value in the UI is 1.0.

point_bitpositions [in] Specifies the point bit positions. A numeric value should be specified for
each point bit position. Use the following format:

"pointname1_bitposition, pointname2_bitposition, …"

Default value in the UI is 0.

column_names [in] Specifies the column names to display. Use the following format:

"columnname1(attribute1, attribute2, …), columnname2, …"

start_time [in] Specifies the start time of data to retrieve. Use the following format:

"mm/dd/yyyy hh:mm:ss {D|S}"

end_time [in] Specifies the end time of data to retrieve. Use the following format:

"mm/dd/yyyy hh:mm:ss {D|S}"

time_interval [in] Specifies the sample time interval. Use the following format:

"HH:MM:SS"
time_zone [in] Specifies the time format of start time and end time. Use the following
values:

0 = Local or 1 = UTC

Default value in the UI is Local.

454 OPH070
 Using the Microsoft Excel add-in

Parameter Description
header_style [in] Specifies the header style to display. Use the following values:

0 = Minimum Header, 1 = Detailed Header, or -1 = No Header

Default value in the UI is Minimum Header.

data_count [in] Specifies the maximum records to display. Use the following values:

-1 = All rows or >0 = N rows

Return value (OPHReadProcData)

If output type specified in the UI is Formula, it returns the results as formula array;
otherwise, it returns the results in text format. If query is specified using Insert Function, it
returns the results as formula array.

Remarks (OPHReadProcData)
For connection_string, you may specify a host name or network IP address. You may specify
actual value or cell reference.

For point_names, when specifying cell reference, you may specify a list of point names in
one cell or you may put each point name in separate cell.

For point_filters, point_options, point_constants, and point_bitpositions, you may specify

individual point parameters for each point or you may specify a single point parameter for
all points. You may only specify actual values but not cell references.

For a list of column names and column attributes, see OPHReadProcData( ) function [456].
For column_names, you may specify actual value or cell reference.

For start_time and end_time, the D or S postfix is applicable only when time_zone is set to 0
(Local). You may specify actual value or cell reference.

For time_interval, time_zone, header_style, and data_count, you may only specify actual
values but not cell references.

When using cell reference, the required format for the parameter should be specified.

The following are applicable only if query is specified using Insert Function: When one of the
arguments is invalid, the function displays #VALUE! in the selected cells. When the number
of records returned is less than the selected number of rows, the function displays #N/A in
the remaining rows.

Example (OPHReadProcData)
The following example retrieves processed data with point parameters specified separately:

OPHReadProcData("drop160",

"blk00101c1a.unit2@mannet2, blk00101c2a.unit2@mannet2",

"0, 1", /* applies OPH_NOP filter to first point and */

/* OPH_NOPBIT to second point */

"0, 1", /* applies OPH_NONE option to first point and */

OPH070 455
Using the Microsoft Excel add-in

/* OPH_GLITCH to second point */

"1.0, 1.0", /* uses point constant default value */

"0, 0", /* uses point bit position default value */

""TS, PN, STS, EU"", /* displays timestamp, point name, status and */

/* engineering unit columns */

"6/14/2006 [Link]",

"6/14/2006 [Link]",

"[Link]", /* displays samples with 2 seconds interval */

1, /* start time and end time is in UTC */

1, /* displays detailed header */

10) /* displays 10 records */

The following example retrieves processed data with same point parameters applied to all
points:

OPHReadProcData("drop160",

"blk00101c1a.unit2@mannet2, blk00101c2a.unit2@mannet2",

"0", /* uses OPH_NOP filter for all points */

"0", /* uses OPH_NONE option for all points */

"1.0", /* uses point constant default value */

"0", /* uses point bit position default value */

"TS, PN, STS", /* displays timestamp, point name and */

/* status columns */

"6/14/2006 [Link]",

"6/14/2006 [Link]",

"[Link]", /* displays samples with 2 seconds interval */

1, /* start time and end time is in UTC */

1, /* displays detailed header */

10) /* displays 10 records */

OPHReadProcData( ) function
The following table describes the possible values of the column_names argument.

456 OPH070
 Using the Microsoft Excel add-in

Table 91. Possible values of the column_names argument

OPH table Excel add-in Column Column attribute Comment

column name attribute format
column name
ID ID
TIMESTAMP TS Tn TS(Tn) Displays column value
using specified time
Where, zone.

n – corresponds to
time zone. Use the Note
following values:
Uses time zone
1 – Local specified in the
time_zone argument
2 – UTC if attribute is not
specified.
3 – Local D/S
TIME_NSEC NS
SAMP_FLAGS SF
F_VALUE FV
RAW_VALUE RV
TIMESECS_VALUE TSV
TIMENSECS_VALUE TNSV
STS STS
SAMP_CREATE_TIME SCT Tn SCT (Tn) Displays column value
using specified time
Where, zone.

n – corresponds to
time zone. Use the Note
following values:
Uses time zone
1 – Local specified in the
time_zone argument
2 – UTC if attribute is not
specified.
3 – Local D/S
SAMP_CREATE_SEQ SCS
PN (Point Name) Derived value based
on ID column.
ED (Description) Derived value based
on ID column.
EU (Engineering Derived value based
Units) on ID column.

OPH070 457
Using the Microsoft Excel add-in

Note
For OPHReadProcData, samp_create_time and samp_create_seq have no meaning as
multiple raw samples are often used to derive a single processed data sample. The Excel
add-in displays these column values as blank.

The following table describes the possible values of the point_filters argument.

Table 92. Possible values of the point_filters argument

Value Description
0 OPH_NOP
1 OPH_NOPBIT
2 OPH_TIMEAVERAGE
3 OPH_MAXIMUM
4 OPH_MINIMUM
5 OPH_MAXIMUMACTUALTIME
6 OPH_MINIMUMACTUALTIME
7 RC_LIMIT_ALARM
8 OPH_TOGGLE
9 OPH_TOGGLESET
10 OPH_TOGGLERESET
11 OPH_TIMESET
12 OPH_TIMERESET
14 OPH_TOTAL
15 OPH_AVERAGE
16 OPH_COUNT, RC_SID_ALARM
17 OPH_STDEV, RC_ALARM_CHECK_REMOVED
18 OPH_END, RC_TAGGED_OUT
22 OPH_VARIANCE
23 OPH_RANGE
24 OPH_DURATIONGOOD
25 OPH_DURATIONBAD
26 OPH_PERCENTGOOD
27 OPH_PERCENTBAD
28 OPH_ANNOTATIONS
29 OPH_DELTA
30 OPH_START

The following table describes the possible values of the point_options argument.

458 OPH070
 Using the Microsoft Excel add-in

Table 93. Possible values of the point_options argument

Value Description
0 OPH_NONE
1 OPH_GLITCH
2 OPH_SUMMARY

OPHReadRawData
Retrieves the raw data from historian.

Syntax (OPHReadRawData)
OPHReadRawData(connection_string,

point_names,

point_filters,

column_names,

start_time,

end_time,

time_zone,

header_style,

data_count)

Parameters (OPHReadRawData)
Table 94. Parameters for the OPHReadRawData( ) function

Parameter Description
connection_string [in] Specifies the historian drop to connect to. Use empty string ("") to specify
default historian.
point_names [in] Specifies the point names to retrieve. Use comma to separate point names.
point_filters [in] Specifies the point filters to apply for point names. A numeric value should
be specified for each point filter. Use the following format:

"pointname1_filter1 | pointname1_filter2 | …, pointname2_filter1, …"

Default value in the UI is Raw Value (12).

column_names [in] Specifies the column names to display. Use the following format:

"columnname1(attribute1, attribute2, …), columnname2, …"

start_time [in] Specifies the start time of data to retrieve. Use the following format:

"mm/dd/yyyy hh:mm:ss {D|S}"

end_time [in] Specifies the end time of data to retrieve. Use the following format:

"mm/dd/yyyy hh:mm:ss {D|S}"

OPH070 459
Using the Microsoft Excel add-in

Parameter Description
time_zone [in] Specifies the time format of start time and end time. Use the following
values:

0 = Local or 1 = UTC

Default value in the UI is Local.

header_style [in] Specifies the header style to display. Use the following values:

0 = Minimum Header, 1 = Detailed Header, or -1 = No Header

Default value in the UI is Minimum Header.

data_count [in] Specifies the maximum records to display. Use the following values:

-1 = All rows or >0 = N rows

Return value (OPHReadRawData)

If output type specified in the UI is Formula, it returns the results as formula array;
otherwise, it returns the results in text format. If query is specified using Insert Function, it
returns the results as formula array.

Remarks (OPHReadRawData)
For connection_string, you may specify a host name or network IP address. You may specify
actual value or cell reference.

For point_names, when specifying cell reference, you may specify a list of point names in
one cell or you may put each point name in separate cell.

For point_filters, you may specify individual point filters for each point or you may specify a
single point filter for all points. For a list of point filters, see OPHReadRawData( ) function
[461]. You may only specify actual value but not cell reference.

For a list of column names and column attributes, see OPHReadRawData( ) function [461].
You may specify actual value or cell reference.

For start_time and end_time, the D or S postfix is applicable only when time_zone is set to 0
(Local). You may specify actual value or cell reference.

For time_zone, header_style, and data_count, you may only specify actual values but not
cell references.

When using cell reference, the required format for the parameter should be specified.

The following are applicable only if query is specified using Insert Function: When one of the
arguments is invalid, the function displays #VALUE! in the selected cells. When the number
of records returned is less than the selected number of rows, the function displays #N/A in
the remaining rows.

Example (OPHReadRawData)
The following example retrieves raw data with point filters specified separately.

OPHReadRawData("drop160",

"blk00101c1a.unit2@mannet2, blk00101c2a.unit2@mannet2",

460 OPH070
 Using the Microsoft Excel add-in

"6|11, 12", /* applies RC_SENSOR_ALARM and RC_GOOD_QUALITY */

/* filters to first point and */

/* RC_RAW_DATA_VAL filter to second point */

"PN, TS, VAL", /* displays point name, timestamp and */

/* value columns */

"11/01/2007 [Link]",

"11/01/2007 [Link]",

1, /* start time and end time is in UTC */

1, /* displays detailed header */

10) /* displays 10 records */

The following example retrieves raw data with same point filters applied to all points.

OPHReadRawData("drop160",

"blk00101c1a.unit2@mannet2, blk00101c2a.unit2@mannet2",

"12", /* applies RC_RAW_DATA_VAL filter to all points */

"PN, TS, VAL", /* displays point name, timestamp and */

/* value columns */

"11/01/2007 [Link]",

"11/01/2007 [Link]",

1, /* start time and end time is in UTC */

1, /* displays detailed header */

10) /* displays 10 records */

OPHReadRawData( ) function
The following table describes the possible values of the column_names argument.

Table 95. Possible values of the column_names argument

OPH table column Excel add-in Column Column attribute Comment

name column name attribute format
ID ID

OPH070 461
Using the Microsoft Excel add-in

OPH table column Excel add-in Column Column attribute Comment

name column name attribute format
TIMESTAMP TS Tn TS(Tn) Displays column
value using
Where, specified time zone.

n – corresponds to
time zone: Note
1 – Local Uses the time zone
specified in the
2 - UTC time_zone
argument if
3 - Local D/S attribute is not
specified.

TIME_NSEC NS
SAMP_FLAGS SF
F_VALUE FV
RAW_VALUE RV
STS STS Qn STSQn) Displays status'
quality description
V Where, part using specified
format.
n - corresponds to
format of quality Displays status'
description. Use the value part.
following values:

1 - Full

2 - Abbreviated

STS(V)
SAMP_CREATE_TIME SCT Tn TS(Tn) Displays column
value using
Where, specified time zone.

n – corresponds to
time zone: Note
1 – Local Uses time zone
specified in
2 - UTC time_zone
argument if
3 - Local D/S attribute is not
specified.

SAMP_CREATE_SEQ SCS
PN (Point Derived
Name)
ED Derived
(Description)
EU (Engr Units) Derived

462 OPH070
 To use Desktop Tools Trend

Note
For OPHReadRawData, samp_create_time and samp_create_seq reflect the time a sample
is stored at a historian.

The following table describes the possible values of the point_filters argument.

Table 96. Possible values of the point_filters argument

Value Description
0 RC_VALUE_LIMITS
1 RC_ENTERED_VALUE
2 RC_SCAN_REMOVED
3 RC_TIMED_OUT
4 RC_EXTERNAL_CALIBRATION
5 RC_CHECK_REMOVED
6 RC_SENSOR_ALARM
7 RC_IN_ALARM
8 RC_BAD_QUALITY
9 RC_POOR_QUALITY
10 RC_FAIR_QUALITY
11 RC_GOOD_QUALITY
12 RC_RAW_DATA_VAL
13 RC_CUTOUT_ALM
14 RC_INITIAL_VAL
15 RC_RETURN_VAL

15.4 To use Desktop Tools Trend

The offline Trend package provides most of the features of the Ovation workstation Trend,
but does not support live DCS functions, such as live trending and drag and drop or
browsing of Ovation DCS SPD points. To access the Desktop Trend application, select Start -
> Ovation Process Historian -> Historical Trend.

See Using Historical Trends [345] and Using Event Trends [389] for more information about
Trends.

15.5 To use Desktop Tools Review

The offline Historical Review package provides all of the analysis capabilities of the Ovation
workstation Historical Review, but does not support live DCS functions, such as drag and
drop or browse of Ovation DCS SPD points, and characteristic-based reviews. To access the
Desktop Review application, select Start -> Ovation Process Historian -> Historical Review.

The following features of the Ovation Historical Review are available in the Desktop Tools
application:

OPH070 463
To use Desktop Tools Review

• Point review [308].

• Alarm review [312].
• Operator Event review [314].
• SOE review [318].
• SIS review [319].
• ASCII review [321].
• Common review [322].

464 OPH070
 Client applications overview

16 Accessing historical data from client

applications
Topics covered in this section:
• Client applications overview [465]
• Using the History Console tool [465]
• Accessing historical data from Excel by using SQL Queries [467]
• Accessing historical data from Crystal Reports [469]

16.1 Client applications overview

You can use access your historical data from a variety of client applications, including:

• History Console tool [465] (included with the historian).

• Microsoft Excel [467].
• Crystal Reports [491].

Note
Install the client interface [43]To access historical data from external applications, you
must

Accessing historical data from these applications requires SQL. This section includes
information on the SQL commands and syntax supported by the historian.

16.2 Using the History Console tool

The History Console tool enables you to interact with your historian. The tool allows SQL,
periodic, and review data retrieval. It also allows you to upload Lab Data and control your
archive devices. The console is one of the client tools that you can choose to install during
the load procedure.

16.2.1 To query your client interface

Use the following steps to query your client interface:

1. Access the Historian Console tool from your Windows desktop:

Start -> Programs -> Ovation Process Historian -> History Console
The console appears.
2. Enter single or multiple commands as per the syntax rules [581].

OPH070 465
Using the History Console tool

3. To execute commands, highlight the commands, and click the arrow button. Your
results are displayed.

Figure 381. Example of query and SQL command results

This example contains three queries that demonstrate periodic data retrieval, a basic SQL
command, and an advanced SQL command.

466 OPH070
 Accessing historical data from Excel by using SQL Queries

• The first query requested time-weighted averages for the specified point over an hour.
The results display the six samples requested from that specific hour, each with an ID,
timestamp, status, and other data.
• The second query, the basic SQL command, displays scanners configured for the
specified historian.
• The third query, the advanced SQL command, displays points with IDs less than the
number 25.

This example is meant to show the various types of information that you can query for. You
can save, print, or perform other functions on the file from the top toolbar.

16.2.2 To automatically generate the query results in a file

The History Console application supports loading, running, or exiting a script automatically.
Use the following command format in the Command Prompt window:

[Link] <inputscript> <outputfile>

Where:

• <inputscript>: Path of the Ovh script file containing the query.

• <outputfile>: Path of the output file where you want to save the query results. This
file is created automatically.

Consider the following example:

D:\OvHist\bin> [Link] D:\OvHist\Samples\[Link]

D:\MyFolder\[Link]

This command runs the input script, sends the output to the output file at the specified
location, and then exits.

Note
If you do not specify any output file, the Console window opens, displaying the query from
the script file, and stops without executing the query. You must manually run the query.

16.3 Accessing historical data from Excel by using SQL

Queries
Use the following steps to access the historical data from Excel by using SQL Queries:

1. Open Microsoft Excel.

2. Navigate to Data -> Import External Data -> Import Data. The Select Data Source
window appears.

OPH070 467
Accessing historical data from Excel by using SQL Queries

3. Click New Data Source. The Data Connection Wizard appears.

Note
You will only need to perform this procedure the first time that you set up the
connection between the historian and Excel. After you create the connection, it is
displayed and selectable in the Select Data Source window.

4. Highlight Other/advanced.
5. Click Next.
6. Highlight Ovation Process Historian OLE DB Provider on the list of OLE DB providers.
7. Click Next.
8. In the Connection tab, enter dropxxx in the Data Source field (this is the name of your
historian server).
9. Click OK. The Data Connection Wizard displays all the available tables.
10. Click Next.
11. Enter the name that you want to define as your data source in the File Name field (for
example, "[Link]").
12. Click Finish. Your data source is added to the Select Data Source window.
13. Double-click to open your new data source. The Import Data screen is displayed, which
specifies where the result data is added to your Excel spreadsheet.
14. If you want to edit the query, click Edit Query. The Edit OLE DB Query screen is
displayed.
15. Select a command type from the Command Type drop-down menu. Your choices are
Table, SQL, and Default. Choose SQL to execute SQL queries.
16. If you select Table, SELECT * FROM <TABLE NAME> is executed.
17. Enter your SQL command in the Command Text field. See Supported SQL functions
[578] for more information.
18. Click OK. Your data is added to your Excel spreadsheet.
The retrieval mode default is MODE_LATEST. If you would like to change the default,
you can edit the extended properties as shown in the following table.

Table 97. Editing the extended properties to change the retrieval mode

Mode Usage
Extended properties = "RetrievalMode = To retrieve the original data
MODE_ORIGINAL;"
Extended properties = "RetrievalMode = To retrieve the latest data (this is the default if
MODE_LATEST;" you do not specify another option)
Extended properties = "RetrievalMode = To return all data
MODE_ALL;"
Extended properties = "ApplicationName = To set the application name
'EXCEL';"
Extended properties = "ApplicationName To specify both application data and retrieval
='EXCEL'; RetrievalMode =MODE_LATEST;" mode at the same time

468 OPH070
 Accessing historical data from Crystal Reports

16.4 Accessing historical data from Crystal Reports

See Crystal Reports tasks [491] for information on how to use Crystal Reports to generate
reports from your historical data.

OPH070 469
 History Edit tool overview

17 Using the History Edit tool

Topics covered in this section:
• History Edit tool overview [471]
• Setting user permissions for the History Edit tool [471]
• Launching the History Edit tool [474]
• Understanding the History Edit tool interface [475]
• To view edited historical data from Trends [483]
• To view edited historical data from a Historical Review [486]
• Creating reports of edited historical data [489]

17.1 History Edit tool overview

The History Edit tool enables you to 'correct' data that scanners have gathered from your
system. For example, if you know that a sensor is malfunctioning, and has been reporting
inaccurate point values, you can use the History Edit tool to correct the point values in that
specific time period to your own accurate estimate, or similar to previously recorded values.

The ability to edit historical data should be used prudently; unnecessary changes to
historical data can reduce the benefits of historical data analysis by creating an inaccurate
record of your plant performance.

To use the tool, you must obtain a license from your Emerson representative. You also must
decide how much access each user requires, and set access rights using the Security
Manager.

17.2 Setting user permissions for the History Edit tool

Before you can use the History Edit tool, you must set security permissions for all users with
the Security Manager.

The two rules that pertain to History Edit tool functionality are as follows:

• Allow full access to Historian data annotation.

• Allow full access to Historian data editing.

By default, Full Engineers, Supervisors, and Administrators have the functionality enabled
that allows them to annotate and edit using the History Edit tool. You can add or remove
this functionality to any of the user roles as required for your situation. All users assigned to
a specific role will have the permissions of that role.

The two rules are intertwined: a role can be configured so that its user can annotate, but
not edit, historical data. However, the reverse is not true; it is not possible to create a role
that allows its user to edit, but not annotate, historical data.

OPH070 471
Setting user permissions for the History Edit tool

User permissions can also depend on where the History Edit tool is launched from, as well as
the rules that a user's role is assigned to. When the tool is launched from the Windows Start
menu, it is read-only; regardless of a user's permissions, the user is not able to annotate or
edit historical data. When the tool is launched from Trend or Review, users are able to
interact with historical data as fully as their role allows them to, meaning that they may be
able to read only, to annotate only, or to actively edit and annotate.

17.2.1 To set user permissions for the History Edit tool

Use the following steps to set user permissions for the History Edit tool:

1. Access the Ovation Developer Studio. Refer to the Ovation Developer Studio User Guide
for more information.
2. Use the system tree to navigate to the Ovation Security item.
3. Double-click to open the Ovation Security Manager in the bottom pane.
4. Click Manage Ovation Roles. The Global Roles appears in the Ovation Security Manager
window as follows:

Figure 382. Manage global roles

472 OPH070
 Setting user permissions for the History Edit tool

5. Double-click on a role to enable or disable rules for that role.

Figure 383. Admin options

6. Enable or disable the two rules that define how a role allows its users to use the History
Edit tool:
• Allow full access to Historian data annotation.
• Allow full access to Historian data editing.
7. Click OK or Apply to save your changes.

OPH070 473
Launching the History Edit tool

17.3 Launching the History Edit tool

There are two different ways to launch the History Edit tool.

Table 98. Ways to launch the History Edit tool

Launch method Type of launch

Start -> Programs -> Ovation Process Launching from the Windows Start menu opens a read-only
Historian -> History Edit and copy of the History Edit tool. You can use this launch type to
Annotate review data, but you cannot annotate or edit data, regardless
of your security role.
From Historical Trend or Historical Launching from Trend or Review opens a read/write version
Review on your Operator Station, of the tool that allows users to annotate and edit historical
right-click on a specific point to data for that specific point, as the permissions for that user's
select History Edit or Annotate role allow.

To launch the History Edit application from the Historical Review and Trend applications,
you must meet the following criteria:

• You must set the data editing and history annotation privileges.
• You must install the OPH Engineering Tools on the workstation.
• You must choose a specific historian for the data edit session. If you select Default
Historian, the History Edit/Annotate option in the Historical Review right-click context
menu is grayed out.

The following example displays the right-click menu where you select History Edit/Annotate
from Historical Review.

Figure 384. Historical Reviews right-click point menu

474 OPH070
 Understanding the History Edit tool interface

17.4 Understanding the History Edit tool interface

The History Edit tool contains four tabs:

• Annotation [475].
• Edit Audit Log [477].
• Detailed Edit [478].
• Replace Wizard [480].

Filter criteria at the top of each tab allows you to search for historical data samples based on
various criteria.

The status bar along the bottom of the window displays the following information:

• The status of the last operation.

• Which historian is selected.
• Which time zone is selected.
• The number of rows retrieved by the tool.

17.4.1 Functionality of the Annotation tab

You can use the Annotation tab to review annotations (comments) that already exist or to
document the conditions or causes that necessitated an edit to your historical data. The
annotations that you make using the History Edit tool become part of your historical data,
and are archived and managed like the rest of your historical data; they do not merely reside
in this tool.

OPH070 475
Understanding the History Edit tool interface

Figure 385. Annotation tab

You can use the Add Annotation button to create a new comment regarding a point.

To add an annotation
Use the following steps to add an annotation:

1. Access the History Edit tool [474].

2. Navigate to the Annotation tab.

476 OPH070
 Understanding the History Edit tool interface

3. Click Add Annotation. The Add Annotation window is displayed.

Figure 386. Add Annotation window

You can add annotations with or without point references. For example, if you are
adding an annotation that relates to 10 particular points, you simply add the point
names. Future annotation review will cross-reference the associated points.
4. Click OK to save your changes, or Cancel to exit. Annotations that you add are archived
and managed in the same way as the rest of your historical data.

17.4.2 Functionality of the Edit Audit Log tab

The Edit Audit Log tab allows you to review a log of all edits that have been made to your
historical data. You can find out whether data is original or edited (and if it is edited, who
edited it) for each set of edits applied. It displays the following information:

• What time range of data samples was changed.

• Which point was changed.
• Which user changed the data samples.
• Which computer the user changed the data samples from.
• What history type the changed samples are (HF-- high fidelity-- is the only history type
that can be edited).

The Filter Criteria portion of the window enables you to filter the edit sessions by start and
end times, history type, domain, user, or computer. For example, if you would like to review
all the edit sessions performed by one user, you could type a user name or use the User
drop-down to view all the edit sessions performed by that user. After changing the filter
criteria, hit Refresh to retrieve the new log of edits. The comments associated with each edit
are displayed in the Comments box as you move your cursor down the rows.

OPH070 477
Understanding the History Edit tool interface

Figure 387. Edit Audit Log tab

You can select one row and click View Detailed Edit. The History Edit window is switched to
the Detailed Edit [478] tab [478] to display the details and context related to that edit
session.

17.4.3 Functionality of the Detailed Edit tab

You can use the Detailed Edit tab to actively modify, delete, and insert data samples. You
can also use the tab to review the edit history in detail (from the original value to the latest
value, with all iterations in between) with the Show all History check box. Show all History
mode is read-only; you cannot edit data while in this mode.

478 OPH070
 Understanding the History Edit tool interface

Figure 388. Detailed Edit tab

You can right-click to hide rows to create a more usable workspace and reduce the chance
that you might accidentally edit a row you do not want to edit.

The Comment field only becomes active and usable after you make an edit. It is a good
practice to add a comment explaining why you made a data edit, to help with future
analysis.

You have the option to save the changes you have made by clicking Apply, or opting to
cancel all changes that you have made since the last saved version by clicking Undo All.

To modify an existing data sample

Use the following steps to modify an existing data sample:

1. Access the History Edit tool [474].

2. Navigate to the Detailed Edit tab.
3. Type directly into a field (as with Value) or click the button (to change the sample flag
or status without needing to know the actual bits).

OPH070 479
Understanding the History Edit tool interface

4. Select OK to save your changes. Each row that you edited is displayed in green and is
now marked 'Modified' in the Pending Action column.

Note
If you do not want to save your changes, click Undo All. If you want to save your
changes, click Apply. A History Edit warning summarizes the changes that you have
made and verifies that you do want to save them. Select Yes or No.

To delete an existing data sample

Use the following steps to delete an existing data sample:

1. Access the History Edit tool [474].

2. Navigate to the Detailed Edit tab.
3. Right-click on the row number of the sample that you want to delete.
4. Select Delete. The row displays in pink and is now marked 'Deleted' in the Pending
Action column.

Note
If you do not want to save your changes, click Undo All. If you want to save your
changes, click Apply. A History Edit warning summarizes the changes that you have
made and checks that you do want to save them. Select Yes or No.

To insert a new data sample

Use the following steps to insert a new data sample:

1. Access the History Edit tool [474].

2. Navigate to the Detailed Edit tab.
3. Right-click anywhere in the table to select Insert Row. A blank sample row is added to
the table.
4. Fill in the values as needed. Each row that you insert displays in yellow and is now
marked 'Inserted' in the Pending Action column.

Note
If you do not want to save your changes, click Undo All. If you want to save your
changes, click Apply. A History Edit warning summarizes the changes that you have
made and verifies that you do want to save them. Select Yes or No.

17.4.4 Functionality of the Replace Wizard tab

Use the Replace Wizard tab to quickly replace multiple data samples with the same value.
Instead of manually typing your edits to each sample in the Detailed Edit tab, use the
Replace Wizard to perform batch replacements. For example, if you know that a sensor was
out of calibration for a specific time period, and that the values it recorded are incorrect,
you can replace those values with your own logical estimate for that entire time period.

480 OPH070
 Understanding the History Edit tool interface

Figure 389. Replace Wizard tab

To quickly replace multiple data samples with a single value

Use the following steps to quickly replace multiple data samples with a single value:

1. Access the History Edit tool [474].

2. Navigate to the Replace Wizard tab.
3. Change the settings as needed.

OPH070 481
Understanding the History Edit tool interface

4. Click Replace. A Replace window appears, superimposed over the data samples on the
Detailed Edit tab.

Figure 390. Using the Replace wizard

5. As each sample row is highlighted, you can take any of these four actions:
• Next to skip (without editing) a sample.
• Replace to edit a sample with your new values.
• Replace All to replace all values between the sample you are currently on and the
last sample.
• Cancel to close the Replace window (rows that you have already changed remain
changed).
Samples that you have changed are displayed in green, and labeled 'Modified' in the
Pending Action column.

Note
If you do not want to save your changes, click Undo All. If you want to save your
changes, click Apply. A History Edit warning summarizes the changes that you have
made and verifies that you do want to save them. Select Yes or No.

482 OPH070
 To view edited historical data from Trends

17.5 To view edited historical data from Trends

If you want to edit the historical data that you are viewing in Trends, you can right-click to
select History Edit/Annotate from the point menu. The History Edit tool launches.

You can use the Replace tab to quickly change data samples. In the following example, the
green "Modified" rows have been replaced with the value -1.234.

Figure 391. Selecting rows to modify

When you click Apply, a dialog box ensures that you want to save your changes.

Figure 392. Continue prompt

When you click Yes, your edits become a part of the historical data record, and are archived
and managed in the same way as your other historical data. If you return to Trends, you can
see the changes you have made at a glance.

OPH070 483
To view edited historical data from Trends

Figure 393. Trend curve displaying edited data

It can be helpful to split the screen and view both the trend curve and a tabular display of
data.

484 OPH070
 To view edited historical data from Trends

Figure 394. Split screen with tabular display

To display the pencil icons that mark edited data, or to toggle between displaying the
original values and the latest values, select Trend -> Properties from the Trend window
toolbar. The Trend Point & Properties window appears. Navigate to the Trend Config tab.

OPH070 485
To view edited historical data from a Historical Review

Figure 395. Trend Config tab

Select the Get Original Value or Get Latest Value option. Select the Mark Edited data check
box if you want to see the pencil icon displayed next to the edited data.

17.6 To view edited historical data from a Historical

Review
After you have performed a Point review, you can compare data between the original value
of a point and the latest value of that point. You can also display a pencil icon next to any
data that has been edited.

Use the following steps to view the edited historical data from the Historical Reviews
window:

486 OPH070
 To view edited historical data from a Historical Review

1. Perform a Historical Review, for example, Point review [308]. The Historical Reviews
window appears:

Figure 396. Point review

2. Click the Historical Review Menu button, and then click Historical Reviews Options
[298].

OPH070 487
To view edited historical data from a Historical Review

3. The Historical Reviews Options dialog box appears.

a. From the left pane, click Review Settings.
b. In the right pane, you can toggle between Get Original Value and Get Latest Value
to display either original or the most recent data. In addition, you can select the
Mark Edited Data check box if you want to see pencil icons next to the data that
has been edited.
c. Click OK.

Figure 397. Review Settings

4. Return to the Historical Reviews window. A selected check box appears at the left to
the edited data.

Figure 398. Point review with edit icons

488 OPH070
 Creating reports of edited historical data

17.7 Creating reports of edited historical data

You can use the Report Manager to create reports that use edited historical data. This can
be a convenient way to monitor the historical data editing activities of users in your system
and to ensure that the capability of the History Edit tool is being used correctly.

For detailed information, see To create reports of edited historical data [257] .

OPH070 489
 Using Crystal Reports (.rpt) files

18 Crystal Reports tasks

Topics covered in this section:
• Using Crystal Reports (.rpt) files [491]
• To sort records [496]
• To group information [497]
• To create a custom group [498]
• To create a custom group header [499]
• To delete a group [499]
• To modify a group [499]
• To insert summaries [500]
• To insert subtotals [501]
• Functions and formulas for .rpt files [502]

18.1 Using Crystal Reports (.rpt) files

You can use Crystal Reports to build additional historian report templates.

Guidelines for saving your data in Crystal Reports

Crystal Reports only reads your database when it is necessary (when you preview, print, or
export a report to file). When working with your report, Crystal Reports only refreshes data
from your database when:

• You add new fields to your report after that report was run
• You add a formula that references a field that was not in the report when it was first run
• You select Refresh Data on each print option in the File -> Options menu
• You modify your record selection to include additional records beyond those included
in the initial run

For these events, you are prompted to either use saved data or to refresh data.

Note
Refer to the Business Objects Crystal Reports User Guide for current, thorough information
about using Crystal Reports. Emerson recommends that you choose a typical (not limited)
installation of Crystal Reports.

Report files define the table data that you want to present and the data format that you
want to use in the report. Format includes:

• Grouping and placement of data on the report.

• Summary of data.

OPH070 491
Using Crystal Reports (.rpt) files

• Display details like font type, font size, and font attributes.
• Details like graphics, supplemental text, and page counts.

Each report file is divided into sections that define where information is placed on the
report and when the information for that section was created. There are five mandatory
sections for all report files and two optional sections. The five mandatory sections are as
follows:

• Report header: This section appears at the top of the first page of a report. This section
is printed one time per report at the start of the report, and the contents of the section
are evaluated only one time at the start of the report.
• Report footer: This section appears at the bottom of the last page of the report. This
section is printed one time per report at the end of the report, and the contents of the
section are evaluated only one time at the end of the report.
• Page header: This section appears at the top of each page of a report. This section is
printed one time for each report page at the start of the page, and the contents of the
section are evaluated one time per page at the start of each report page.
• Page footer: This section appears at the bottom of the each page of a report. The
section is printed one time for each report page at the end of the page, and the
contents of the section are evaluated one time per page at the end of each report page.
• Details: This section is the body of the report. Data in this section is processed for each
record in the record set that is evaluated.

The two optional sections are as follows:

• Group header: This is the beginning section for each group set that is added. The
section is printed one time for each section at the start of the section, and the contents
of the section are evaluated on time per section at the start of each section.
• Group footer: This is the last section for each group set that is added. The section is
printed one time for each section at the end of the section, and the contents of the
section are evaluated one time per section at the end of each section.

The optional sections appear in sets of two. You can add a variable number of sets to your
report file. These sections let you group or sort record set data by criteria that you specify.
To view or alter these sections, load the report file into Crystal Reports IDE. Each set of two
contains a group header and a group footer.

Each section has a sizing handle that you can use to determine the amount of space the
section will use in the final report output. In addition, you can click with the right mouse
button to view a section submenu. This enables you to hide, suppress, or further format any
section.

Report file fields

Report files are populated with fields that contain information that you want to display on
the final report output. Fields are categorized according to type. Some of the more
common fields are as follows:

• Database: to display record data from tables and columns.

• Text: to display fixed text information.
• Formula: to achieve a greater degree of control over report data.

492 OPH070
 Using Crystal Reports (.rpt) files

• Parameter: to display dynamic data.

• Special: to display specific data, such as page number.

The Crystal Reports IDE manages fields as objects. Each field has a unique identity and set of
properties. You can manipulate field placement and size by using drag and drop and the
sizing handle. Right-click to edit, size, or further format any field.

Report file formulas

You can use formulas to gain a greater degree of control over report output in terms of data
processing, placement, display, grouping, and collection. Formulas are actually functions
written in programming language syntax that provide access to other support functions in
the libraries that are provided with the Crystal Reports Development package. Formulas are
also the only method of access to the user function library that contains functions to the
following:

• Obtain configuration data from the Report Manager.

• Convert UTC to local time.
• Obtain definitions to perform specific data groupings.
• Evaluate historical data values and statuses.

18.1.1 To create a new Crystal Report (.rpt) file

Use the following steps to create a new Crystal Report (.rpt) file:

1. Access Start -> Programs -> Crystal Reports 2016.

2. Within Crystal Reports, access File -> New.
3. Select Standard Report, Blank Report, Cross-Tab Report, Mailing Label Report, or OLAP
Cube Report.
4. Access File -> Save As to save the file under an original name.
5. New reports can be generated using two methods:

Table 99. Methods to generate reports

Method Details
Template- These reports use help from the Crystal Reports IDE wizard. Template-based
based report reports use Crystal Reports IDE format wizards and standard reporting objects
to generate report layout files. This method ensures excellent report output.
However, they limit your control over report output. You can add formulas to
these reports to gain greater control.
Blank report These reports do not use Crystal Reports IDE wizard help. Blank reports
provide a very high degree of report output. However, they require extensive
use of custom design procedures, formulas, and running totals.

OPH070 493
Using Crystal Reports (.rpt) files

6. To work with a blank report, click the Blank Report button in the New Reports area. The
Database Expert dialog box appears:

Figure 399. Database Expert dialog box

7. Open the Create New Connection folder.

8. Open the Database Files folder (if you are working with an ExpressCalc report), or OLE
DB (if you are working with a direct report, you must enter your host name in the Data
Source field).
9. Select the database tables that you want to connect to.
10. Click OK. The Crystal Reports design environment is launched.
11. To insert a field into your report, expand Database Fields in the Field Explorer window.
Highlight a name and drag it into a section of your report, placing it where you want it
to appear in the finished report.
12. To position, size, or move objects on your report, drag items with your mouse. You can
resize by dragging with your mouse, or use the Ctrl key and click the item heading to
resize. You can move items with your mouse or use the Ctrl-Arrow key to move.

494 OPH070
 Using Crystal Reports (.rpt) files

18.1.2 To modify an existing Crystal Report (.rpt) file

Use the following steps to modify an existing Crystal Report (.rpt) file:

1. Launch Crystal Reports:

Access Start -> Programs -> Crystal Reports 2016.
2. Within Crystal Reports, go to File -> Open. An Open dialog box, which contains two
folders, MsgReports and PtReports, appears:

Figure 400. Open dialog box

3. Choose a folder and click Open. The Emerson-provided sample .rpt files appear as
follows:

Figure 401. Sample files displayed

4. Choose a sample template and click Open. Refer to Report format templates supplied
with OPH installation package [218] for more information about the report format
templates.

OPH070 495
To sort records

5. Use File -> Save As to save the file under a new name.

Note
Emerson recommends that you do not edit the original template. You might want to
reuse it. In addition, custom changes made to Emerson templates will be lost if the
historian is uninstalled or upgraded.

6. Make the modifications that you want. Typically, these modifications consist of:
• Adding or modifying a text field.
• Adding or modifying a data field.
• Modifying field placement or size.
• Modifying the report file formula.

18.1.3 To link Crystal Report (.rpt) files to the historian Report

Manager
Use the following steps to link Crystal Report (.rpt) files to the historian Report Manager:

1. Create a Crystal Report file [493]. Build your report in Crystal Reports by hard-coding
point names, time frame, and any other additional criteria and test output.
2. When you are satisfied with your results, remove ALL criteria that you defined. (This is
necessary in order to make the report open-ended like a macro, which allows the
Report Manager to pass in the settings that you defined in your Report Manager report
definitions.)
3. Deselect the option: File -> Save Data with Report. (This is necessary in order to allow
the Report Manager to process and display new data each time that the report runs.)
4. Rename the Data table name to some variation of "HIST":
• PT_HF_HIST
• MSG_ALARM_HIST
• MSG_TEXT_HIST
• MSG_SOE_HIST
5. Save the report to your :\Historian\Reports folder.
6. Open the Report Manager.
7. Navigate to the Reports Format workspace.
8. Right-click to select New Report Format.
9. Navigate to the correct directory to select your new crystal .rpt file.
10. Build your new report definition in Report Manager by defining points, time frame, and
so forth.
11. Schedule to run the report as needed.

18.2 To sort records

Use the following steps to sort records:

496 OPH070
 To group information

1. Create a Crystal Report file [493].

2. Access the Report menu.
3. Click Record Sort Expert. The Record Sort Expert dialog box appears as shown in the
following figure. It lists all the fields that are currently included in your report in the
left-hand window.

Figure 402. Record Expert dialog box

4. Highlight the field on the left-hand side that you want to sort. Click the > button. The
field is added to the Sort Fields list.
5. Assign an ascending or descending sort direction.
6. Click OK.

18.3 To group information

You can use the grouping option to organize your data into meaningful groups. You can
group by information in report fields, information in database fields that is not included in
the report, and formula fields. For example, you might want to group all alarms in your
database by point name, date, or alarm type. You can also summarize the information in
each group.

Use the following steps to group information:

1. Create a Crystal Report file [493].

OPH070 497
To create a custom group

2. Click Insert -> Group. The Insert Group dialog box appears:

Figure 403. Insert Group dialog box

3. Select the field that you want to group on from the first drop-down menu.
4. Choose a sorting direction.
5. Click OK to save your settings.

18.4 To create a custom group

Use the following steps to create a custom group:

1. Create a Crystal Report file [493].

2. Access the Insert menu.
3. Click Group. The Insert Group window appears.
4. Select the field that you want the data to be grouped by.
5. Select a sort direction.
6. Use the Specified Order tab to enter your group name in the Named Group field.
7. Click New. The Define Named Group window appears.
8. Use the drop-down menu to select the data that you want to include in your group.
9. Click the New tab if you want to add more selection criteria to your group.
10. Click OK.
11. If you need to organize data that is not part of the groups that you defined, use the
Others tab and click OK.

498 OPH070
 To create a custom group header

18.5 To create a custom group header

Use the following steps to create a custom group header:

1. Create a Crystal Report file [493].

2. Access the View menu.
3. Click Field Explorer. The Field Explorer window appears.
4. Open the Group Name Fields folder.
5. Select a group name field for your custom group and drag it onto the Group Header
section for that group. Each of your group names is assigned to the appropriate group.

18.6 To delete a group

Use the following steps to delete a group:

1. Create a Crystal Report file [493].

2. Right-click in the gray area over the group Header or Group Footer of the group that
you want to delete.
3. Select Delete Group.

18.7 To modify a group

Use the following steps to modify a group:

1. Create a Crystal Report file [493].

2. Access the Report menu.
3. Click Group Expert. The Group Expert dialog box appears:

Figure 404. Group Expert dialog box

OPH070 499
To insert summaries

4. Select the group that you want to edit from the Group By list.
5. Click Options. The Change Group Options window appears.
6. Edit the group as needed.
7. Click OK.

18.8 To insert summaries

Summary information includes the author, title, or subject of the report, as well as
keywords or other comments.

Use the following steps to insert summaries:

1. Create a Crystal Report file [493].

2. From the File menu, click Summary Info. The Document Properties dialog box,
Summary tab appears:

Figure 405. Document Properties dialog box

3. Enter information about your report (author, keywords, comments, title, subject, and
template).
4. Click OK.

500 OPH070
 To insert subtotals

18.9 To insert subtotals

Subtotals summarize the numerical values in a group. Use the following steps to insert
subtotals:

1. Create a Crystal Report file [493].

2. Right-click on a field on your report that you want to subtotal and select Insert ->
Summary. The Insert Summary dialog box appears:

Figure 406. Insert Summary dialog box

OPH070 501
Functions and formulas for .rpt files

3. Click Insert Group. The Insert Group dialog box appears. Select the group that you
want to add to your report.

Figure 407. Insert Group dialog box

4. Select the field that you want the data grouped by, and a sort direction.
5. Click OK.
6. On the Insert Summary window, select your newly created group and click OK. The
subtotals are run.

18.10 Functions and formulas for .rpt files

You can use the following functions from the user-defined formulas in OPH .rpt files to
customize the display of certain fields on the report. Examine the standard .rpt files to gain
more understanding of how to use functions and formulas.

502 OPH070
 Functions and formulas for .rpt files

Table 100. Functions

Predefined function Details

gmtConvertGetDTDisplay( Converts string gmt_strtimestamp (Refer to
the Visual Basic documentation on CDate for
gmt_strtimestamp As String, valid date/time string formats; “11/29/2006
[Link]M” is one of valid values) to local
rtn_type As String) As String time and returns string in format mm/dd/
yyyy hh:mm:ss.

Leading 0s are used for 1 digit values.

If time is between:

1st 1-2 AM interval on last DST day, suffix D is

applied.

2nd 1-2 AM interval on last DST day, suffix S

is applied.

Otherwise, there is no suffix.

gmtConvertGetTimeString( Combines all parameters passed into a string
with format mm/dd/yyyy hh:mm:ss and
ByVal year_val As Integer, returns it.

ByVal mon_val As Integer, Leading 0s are used for 1 digit values.

ByVal day_val As Integer, The rtn_type can be “t”, “d” or “b”.

ByVal hour_val As Integer, • “t” returns just TIME portion.

ByVal min_val As Integer, • “d” returns just DATE portion.
• “b” returns both DATE and TIME.
ByVal sec_val As Integer,

ByVal rtn_type As String) As String

gmtConvertSectoString( Converts time_t seconds into a local date/
time string.
time_sec As Long,
Refer to gmtConvertGetTimeString for
rtn_type As String) As String format information of the returned string.
gmtConvertValueDefine( Returns a string representation for the
meaning of BITs of the value status word
value As Long) As String passed in.

The string representation contains various 1

or 2-letter abbreviations separated by space,
based on bits in the value status word.

OPH070 503
Functions and formulas for .rpt files

Predefined function Details

gmtConvertValueStatus( Returns a string representation of the quality
bits set in the value status word passed in.
value As Long,
Returned string is abbreviated if rtn_type
rtn_type As String) As String passed is “a”. The other rtn_type is “f” for
full.

Possible return values are:

• "--Timed Out--" "t"

• "--Bad--" "b"
• "--Poor--" "p"
• "--Fair--" "f"
• "--Good--" "g"
gmtConvertValueWord( Returns a string representation of the
numeric value of the value status word
value As Long, passed in.

rtn_type As String) As String If rtn_type is “d,” returned string is decimal.

If rtn_type is “h,” returned string is

hexadecimal.
gmtConvertFormattedAnalogValue( analog_value As Formats and returns the analog_value as a
Double, fm_field As Integer) As String string in standard, exponential, or technical
notation according to the FM field content of
the point. The FM field is stored as column
SIGNIFICANT_DIGITS in the Historian's
PT_ATTRIB table and in the Report Manager's
PtAttribGrp ExpressCalc tables. The fm_field
parameter is used to format the return string
as follows:

Returned string Bits Bits 3-0

example 7-4
10.1234 0 Specify the
(Standard) number of
places, up to
15.
10.34E2, 5.54E-1 1 Reserved.
(Exponential)
13.34E3, 12.56E-3 2 Reserved.
Technical
(Exponential with
all exponents as
multiples of
three.)
10.1234 3-15 Specify the
(Standard) number of
places, up to
15.

504 OPH070
 Functions and formulas for .rpt files

The following table provides additional information about abbreviations and their meanings
for gmtConvertValueDefine.

Table 101. Abbreviations and their meanings for gmtConvertValueDefine

Predefined function Details

gmtConvertGetDTDisplayEx(gmt_strtimestamp As Refer to description of
String, rtn_type As String, nsec_val As Long, gmtConvertGetDTDisplay first.
do_rounding As Integer, decimal_digits As Integer)
As String This function includes nanoseconds in date/
time display string.

The display format is

mm/dd/yyyy hh:mm:[Link]

Where, NNN is the nanoseconds (nsec_val).

decimal_digits parameter controls how many

digits are to be displayed after the ‘.’ (DOT)
character (Like N or NN or NNN and so on).

do_rounding parameter controls whether the

nanoseconds are rounded or truncated.

The suffix S or D is applied (if applicable) after

the nanoseconds (NNN above) at the end of
the string.

gmtConvertGetNsecsDisplayString function is
used internally to convert nanoseconds to
string.
gmtConvertSectoStringEx(ByVal time_sec As Long, Refer to description of gmtConvertSectoString
rtn_type As String, nsec_val As Long, do_rounding and gmtConvertGetDTDisplayEx.
As Integer, decimal_digits As Integer) As String
This function includes nanoseconds in the
date/time display string.
gmtConvertGetNsecsDisplayString(nsec_val As Gets the display string for nanoseconds.
Long, do_rounding As Integer, decimal_digits As
Integer, ByRef overflow As Integer) As String decimal_digits parameter controls how many
digits are to be displayed after the ‘.’ (DOT)
character (Like N or NN or NNN and so on).

do_rounding parameter controls whether the

nanoseconds are rounded or truncated.

After rounding, if the nanoseconds are greater

than 1 second, overflow parameter is set to 1.

The character E is returned for any error

condition.
gmtConvertMarkEditedData( ) As Integer Returns whether Edited Data should be marked
with an asterisk (*). This setting is generally set
by the main application as part of user settings.

OPH070 505
Functions and formulas for .rpt files

Predefined function Details

gmtConvertIsValueEdited(samp_flag As Long, Based on sample flag value and whether the
is_direct As Integer) As Integer report is direct or not, this function tells
whether the value contained in the sample has
been edited by the user.

The following table provides description for field numbers and abbreviations.

Table 102. Field numbers and abbreviations

Field number Abbreviation Description

1 TO Point time out
2 GQ Quality:

FQ Good

PQ Fair

Poor
BQ
Bad
GL
Latched good
FL
Latched fair
PL
Latched poor
BL
Latched bad
3 HE Hardware error
4 XO Point tagged out
5 CO Point cutout
6 PO Point oscillating-- for digital and packed points only
7 AR Alarm check remove
8 LR Limit checking removed
8 LR Limit check remove
9 SC Scan remove
10 EV Enter value
11 IA SID error

506 OPH070
 Functions and formulas for .rpt files

Field number Abbreviation Description

12 SA Limit:

LW Sensor alarm

LB Low worse

Low better
LL
Low limit (or Low 1)
L2
Low 2
L3
Low 3
L4
Low 4
HL
High limit (or High 1)
H2
High 2
H3
High 3
H4
High 4
HB High better

HW High worse

PA Digital or packed point alarms

13 LU UDA alarm:

HU Low UDA

High UDA
14 UR Point is unacknowledged and needs to be reset

U Point is unacknowledged and needs to be acknowledged and reset

R Point is acknowledged and needs to be reset

blank Point is acknowledged and reset

The following formulas should be used to display certain specific information on the
generated report. Create these formulas with the exact same name as below in your .rpt file
with an empty string (" ") as content. These formulas act as placeholders for the field that
you want to display (indicated by the formula name). These formulas should be inserted in
the .rpt file at appropriate places based on their individual requirements.

Table 103. Formulas to display specific information

Formula Is used to display...

TitleOne Header1 text from your report definition.
TitleTwo Header2 text from your report definition.
StartDT Start time of your report.

The start timestamp is displayed: mm/dd/yy hh:mm:ss

OPH070 507
Functions and formulas for .rpt files

Formula Is used to display...

EndDT End time of your report.

The end timestamp is displayed: mm/dd/yy hh:mm:ss

EventType Event type that is associated with the report queue entry.

When a report definition is added to the report generation queue, it has an

associated event type and name that indicate how the entry was added to the
queue. This formula displays the event type. Possible returned values are as
follows:

• Reserved (the report was executed by demand of the report definition)

• Timed (the report was executed by a timed event)
• Trigger (the report was executed by a trigger event)
• Demand (the report was executed by a demand event)
EventName Event name that is associated with the report queue entry.

When a report definition is added to the report generation queue, it has an

associated event name that indicates how the entry was added to the queue.
This formula displayed the event name. Possible returned values are:

• Reserved system event (the report was executed by demand of the report
definition)
• Timed event name (the report was executed by a timed event)
• Trigger event name (the report was executed by a trigger event)
• Demand (the report was executed by a demand event)
TriggerPointName Trigger point name that is associated with the report queue entry.

When a report is generated due to a trigger, this formula displays the point
name of the digital trigger point.
TriggerPointDesc Trigger point description of the trigger point that is associated with the report
queue entry.

When a report is generated due to a trigger, this formula displays the point
description of the digital trigger point.
TriggerPointValue Value of the trigger point that is associated with the report queue entry. This is
the new value that the trigger point had at the time of trigger.

When a report is generated due to a trigger, this formula displays the (new)
value of the digital trigger point at the time of trigger.

508 OPH070
 Troubleshooting tools

19 Troubleshooting the historian

Topics covered in this section:
• Troubleshooting tools [509]
• To use the OVH log file [509]
• To use the Historian Diagnostics tool [510]
• Analyzing your historian's data collection ([Link]) [529]
• Historian fault codes [535]

19.1 Troubleshooting tools

You can use the following tools to monitor and troubleshoot your historian:

• OVH log file [509].

• HCT log file [91].
• Historian Diagnostics tool [510].
• [Link] [529].
• Ovation fault information tool [535].

19.2 To use the OVH log file

The OVH_Log_File is a text file that you can use to view errors from your historian system.
You can access this file from your OvHist\bin file, or the directory where you loaded the
historian software.

There are four levels of error information displayed.

Table 104. Error levels

Error level Meaning

Debug This category of information is mainly used by Emerson to help you analyze system
problems.
Info Information records log any significant system event, such as stopping or starting your
historian server, or adding a volume.
Warning This category includes events that signal potential problems, such as lost connections
and subsequent retry attempts.
Critical This category notes serious problems that impede historian function, such as an
unreadable volume or an invalid license.

OPH070 509
To use the Historian Diagnostics tool

19.3 To use the Historian Diagnostics tool

The Historian Diagnostics tool (ovhdiag) shows you locally the processes, services,
scanners, removable archive devices, and fixed archive devices that are running on your
system. Use the following steps to access the Historian Diagnostics tool:

1. You can launch the tool from the binoculars icon on your system tray, or from the Start
menu as follows:
Start -> Programs -> Ovation Process Historian -> Historian Diagnostics

Note
The binoculars icon that displays in the system tray is generally green, which means
that the historian process is running properly. If the binoculars icon turns red, there is a
problem with the historian software.

510 OPH070
 To use the Historian Diagnostics tool

2. The Historian Diagnostics window appears. The following figure depicts the window
for a simple configuration of one server, one scanner, and no redundancy.

Figure 408. Historian Diagnostics window

The following figure depicts the Historian Diagnostics window for a redundant pair of
servers.

OPH070 511
To use the Historian Diagnostics tool

Figure 409. Redundant pair of servers

The Historian Diagnostics window contains the following tabs:

• Processes [514].
• Services [518].
• Scanner Details [519].
• Point Counts [521].
• Fixed Archive [522].
• Removable Archive [525].

The Historian Diagnostics window displays information depending on your historian

environment.

512 OPH070
 To use the Historian Diagnostics tool

The bottom portion of the Historian Diagnostics window indicates the status of the
following:

• Main scanner drop

• Partner scanner drop
• Historian server connections

Generally, if the text is highlighted in green, the system communication is healthy.

However, if any text is highlighted in red, there is a problem.

The following table describes the possible states and respective highlight colors for main
and redundant scanners.

Table 105. States and highlight colors for main and redundant scanners in the Historian
Diagnostics window

State of a scanner Description Highlight

color
Active, Connected to: The scanner is active and connected to Green
<historian_machine1> <historian_machine1>.
Active, Historian Connection The scanner is active, but the historian connection Orange
Down is down.
Active, Connected to: The scanner is active and connected to Orange
<historian_machine1>, <historian_machine1> and <historian_machine2>.
<historian_machine2>
Partially Active, Connected to: The scanner is partially active and connected to Orange
<historian_machine1> <historian_machine1>.
Partially Active, Historian The scanner is partially active, but the historian Orange
Connection Down connection is down.
Partially Active, Connected to: The scanner is partially active and connected to Orange
<historian_machine1>, <historian_machine1> and <historian_machine2>.
<historian_machine2>
Backup The scanner is in the Backup stage. If the primary Green
scanner is working properly, the redundant scanner
is in the Backup stage, and vice versa.
Partial Backup The scanner is in the Partial Backup stage. Orange
Stopped A process has stopped working. Red
No Response The main scanner cannot communicate with the Red
redundant scanner drop.
Failed The scanner is in the Failed stage. Red
Not Available The scanner is not available. For example, at No highlight
initialization after start-up, a state is not yet
available.
Multiple Individual scanner processes are in different states. Orange

The following table describes the possible states and respective highlight colors for the
main and redundant historians.

OPH070 513
To use the Historian Diagnostics tool

Table 106. States and highlight colors for main and redundant historians in the Historian
Diagnostics window

State of a historian Description Highlight color

Active The historian is active. Green
Initial The historian is in the Initial stage. Orange
Updating The historian is in the Updating stage. Orange
Active, Sync Pending, Sync pending between primary and partner historians Orange
User Action Required because the configuration is out-of-date.
No Response The historian cannot communicate with the redundant Red
historian.
Not Available The historian is not available. For example, at initialization No highlight
after start-up, a state is not yet available.

The communication link between the redundancy manager and the historian is tested once
every five minutes. When a backup scanner detects a failed link, the Historian Diagnostics
tool displays a red highlight. An active scanner waits for 30 consecutive minutes of a failed
link before signaling the tool to display a red highlight. This functionality can result in a 5–
30 minute lag time between the time that the link fails and the diagnostics tool displays the
failure.

Rather than exiting the Historian Diagnostics window, Emerson recommends that you
minimize the window to your system tray so that it can run continuously.

19.3.1 Processes tab of the Historian Diagnostics window

The Processes tab of the Historian Diagnostics window displays the processes that are
running on your system. The following figure depicts the Processes tab.

514 OPH070
 To use the Historian Diagnostics tool

Figure 410. Historian Diagnostics window -- Processes tab

The Historian Diagnostics window displays the Restarts column under the Processes tab.
Normally, the Restarts column is blank. If the column contains a number, this indicates that
an OPH process stopped unexpectedly, requiring a restart. If the process could not be
successfully restarted after three attempts, the process appears in the Stopped state.

OPH070 515
To use the Historian Diagnostics tool

Figure 411. Historian Diagnostics window -- Restarts column -- third instance

516 OPH070
 To use the Historian Diagnostics tool

Figure 412. Historian Diagnostics window -- Restarts column -- process stopped after three
instances

If a scanner drop is active but not completely synchronized with the Ovation network, the
Processes tab displays the status of scanner processes as Highway Offline.

OPH070 517
To use the Historian Diagnostics tool

Figure 413. Historian Diagnostics window -- Highway Offline status

Once the scanner drop is completely synchronized with the Ovation network, the status
changes to Running.

19.3.2 Services tab of the Historian Diagnostics window

The Services tab of the Historian Diagnostics window displays the services that are running
on your system. The following figure depicts the Services tab.

518 OPH070
 To use the Historian Diagnostics tool

Figure 414. Historian Diagnostics window -- Services tab

Note
For details on the Ovation Process Historian Report Service, see What is the Ovation Process
Historian Report Service? [202].

19.3.3 Scanner Details tab of the Historian Diagnostics window

The Scanner Details tab of the Historian Diagnostics window displays which scanner is
active and which scanner is in backup. In addition, this tab displays the historian server to
which the scanners are connected. The following figure depicts the Scanner Details tab.

OPH070 519
To use the Historian Diagnostics tool

Figure 415. Historian Diagnostics window -- Scanner Details tab

520 OPH070
 To use the Historian Diagnostics tool

The following figure depicts the Scanner Details tab when the CHS scanner is configured.

Figure 416. Redundant scanner running with CHS scanner configured

19.3.4 Point Counts tab of the Historian Diagnostics window

The Point Counts tab of the Historian Diagnostics window displays the following point
count information:

• Licensed: Reflects the total number of licensed points. The historian is licensed on the
basis of how many points you want to collect the historical data for. The maximum
number of points that one historian can collect is 400,000.
• Configured: Reflects the number of points that are configured and enabled for
collection by various scanners in your network.
• Unused: Reflects the number of points that are still available for configuration.
Typically, you can calculate the number of unused points as follows:
Unused = Licensed - Configured

Note
When points are removed from collection by using the Historian Configuration Tool,
these points still remain in the OPH database tables. Therefore, the Historian
Diagnostics window displays such points as Disabled. Deleted points are maintained in
the OPH tables as these points may be required for data retrieval from data files.

OPH070 521
To use the Historian Diagnostics tool

The following figure depicts the Point Counts tab.

Figure 417. Historian Diagnostics window -- Point Counts tab

19.3.5 Fixed Archive tab of the Historian Diagnostics window

The Fixed Archive tab of the Historian Diagnostics window displays the fixed archive
devices, such as NAS, SAN, or DAS, their status, and any attention messages. The following
figure depicts the Fixed Archive tab.

522 OPH070
 To use the Historian Diagnostics tool

Figure 418. Historian Diagnostics window -- Fixed Archive tab

The top half of the window displays the following data about the fixed archive devices:

• Name: This field indicates the device name.

• State: This field indicates the state of the device.
• Properties: This field indicates any properties the device may have associated with it.
• Free Space: This field indicates the free space available in the device.

OPH070 523
To use the Historian Diagnostics tool

When you right-click a fixed archive device, you can use the following options:

Table 107. Options for the fixed archive device

Option Description
Enable Enables archive activities for the fixed archive device, such as NAS, SAN, or DAS.
Disable Disables archive activities for the fixed archive device, such as NAS, SAN, or DAS.
Volumes Enables you to view the volumes information [524].

The bottom half of the Historian Diagnostics window contains attention messages. This
area displays the following data about the attention messages:

• Time: This field indicates the time when each attention message was issued.
• Description: This field indicates the description of the action that you should take.

You can acknowledge the message by clicking Acknowledge.

Click Refresh Screen to refresh the current view.

Archive volumes information in the Historian Diagnostics window

Use the following steps to view the archive volumes information in the Historian
Diagnostics window:

1. Access the Historian Diagnostics window [510].

2. Navigate to the Fixed Archive [522] tab [522] of the window.
3. Right-click a fixed archive device, and click Volumes. The Archive Volumes dialog box
appears. The dialog box displays the archive volumes created by the fixed archive until
the current date.

Figure 419. Archive Volumes dialog box

524 OPH070
 To use the Historian Diagnostics tool

4. When you right-click a volume, you have the following options:

• Information: Use this option to view the information of a volume. When you click
Information, the Volume Information dialog box appears. The dialog box displays
the following information:
◦ Space used on the volume.
◦ Types of data in the volume, such as SOE, alarm (ALM), and so forth.
◦ Start date and time.
◦ End date and time.

Figure 420. Volume Information dialog box

• Delete: Use this option to delete a volume. When you click Delete, the following
confirmation message appears. If you click Yes, the volume is deleted. Click No if
you do not want to delete the volume.

Figure 421. Confirmation message to delete a volume

19.3.6 Removable Archive tab of the Historian Diagnostics

window
The Removable Archive tab of the Historian Diagnostics window displays the removable
archive devices (DVD-RAMs), their status, and any attention messages. The following figure
depicts the Removable Archive tab.

OPH070 525
To use the Historian Diagnostics tool

Figure 422. Historian Diagnostics window -- Removable Archive tab

The top half of the window displays the following data about the removable archive devices:

• Drive: This field indicates the device name.

• Type: This field indicates the device type, DVD-RAM.
• State: This field indicates the state of the device. The four possible states that a device
can have are as follows:
◦ Request: There is a request on the device, which means that a message is
displayed on the bottom-half of the window for the device.
◦ Idle: The device is idle.

526 OPH070
 To use the Historian Diagnostics tool

◦ Format: A new volume in the device is actively being formatted, which can take up
to 20 minutes.
◦ Access: Access to the device is in use for reading or writing.
• Properties: This field indicates any properties the device may have associated with it.
• Volume in Drive: This field indicates the archive volume of the device.

When you right-click a removable archive device, you can use the following options:

Table 108. Options for the removable archive device

Option Description
Eject Ejects the removable archive volume (DVD-RAM disc).
Lock Locks the removable archive device (DVD-RAM).
Unlock Unlocks the removable archive device (DVD-RAM).
Enable Enables the removable archive device (DVD-RAM).
Disable Disables the removable archive device (DVD-RAM).

The bottom half of the Historian Diagnostics window contains attention messages. This
area displays the following data about the attention messages:

• Time: This field indicates the time when each attention message was issued.
• Description: This field indicates the description of the action that you should take.

You can choose to acknowledge or cancels the message.

• To acknowledge the message, click Acknowledge. The system immediately acts on

your acceptance of the message.
• To cancel the message, click Cancel Message. The message is removed from the
interface and canceled from your system.

Click Refresh Screen to refresh the current view.

19.3.7 Redundant OPH synchronization

When partner servers are running, they work together automatically to establish
synchronization. For example, if you add a point to drop 103, it communicates your settings
to partner drop 108, to ensure configuration synchronization.

If the partner servers are not in sync, you are unable to download any new configuration
settings, such as adding points, though the servers continue working. It is possible to
become out of sync in the following situation: if you add new configurations to the primary
while the partner is failed, and then shut down the primary and restart the partner. Because
the servers in this situation do not have a chance to send missed configuration settings and
other missed data, this situation creates a lack of synchronization. When both servers are up
and running, they reestablish their synchronized configuration.

For auto-historian or redundant pair (DropA/DropB) requests, the OPH Client API
interrogates each OPH to determine if there are "holes" being recovered for a specific data
type and time period. Based on this information, the data retrieval request is sent to the
historian that is most capable of satisfying the request:

OPH070 527
To use the Historian Diagnostics tool

• If DropB is synchronized for the requested time span and historical data type, DropB
services the retrieval request.
• If DropB is not synchronized and DropA is synchronized for the requested time span
and historical data type, DropA services the retrieval request.
• If neither OPH is synchronized for the requested time span and historical data type, the
request is directed to the most completely synchronized OPH.
• Requests directed to a single historian data source (e.g., DropA or DropB) issue a
request to the specified historian only.

The Historian Diagnostics window indicates the status of data recovery operations between
partner historians (updated once per minute) as shown in the following figures.

Figure 423. Historian Diagnostics window -- Primary Server

528 OPH070
 Analyzing your historian's data collection ([Link])

Figure 424. Historian Diagnostics window -- Partner Server

19.4 Analyzing your historian's data collection

([Link])
The historian includes a Scanner Statistics tool [530] that can help you analyze the
historian's collection performance. For example, you can use the Scanner Statistics tool to
help you determine if a point is collecting too much information and taxing your storage
unnecessarily.

The questions that the Scanner Statistics tool can help you answer are as follows:

• What scanners and scanner types are currently connected to your historian server, and
does this match your configuration choices?
• Are your scanners communicating and are they regularly sending fresh process
samples?

OPH070 529
Analyzing your historian's data collection ([Link])

• Are messages being generated by your scanner but not sent to your historian (which
causes the dat file percentage full to increase) because your server connection is down?
• Is your scanner generating more sample data that it can transmit to the server
(because your dat file is growing increasingly full even though messages are being sent
to the historian and acknowledged)?
• Is your scanner performing its operations properly, with no unexpected time shifts or
missed scan cycles (which could indicate that the scanner is too busy)?
• What is the total volume of samples that your scanner is generating, and is it filtering
the significant changes well enough?
• Which points are the most active, and might require deadband adjustment?
• If points are being collected more often for status bit changes than for value changes,
what is causing the status changes, such as a point continuously toggling in and out of
a state?

19.4.1 To use the Scanner Statistics tool

Use the following steps to open the Scanner Statistics tool on any scanner or server
workstation:

1. Navigate to your OvHist\bin folder, or to the folder where you have loaded the historian
software. This tool can also be accessed from the Start menu.

530 OPH070
 Analyzing your historian's data collection ([Link])

2. Double-click the [Link] file. The Scanner Statistics window appears:

Figure 425. Scanner Statistics window

3. Click Select File to browse your folders and select a file to open in the Scanner Statistics
window.
4. The data displayed in the Scanner Statistics window is not updated automatically. Click
Refresh at any time to view fresh data.

The following table describes the tabs in the Scanner Statistics window.

Table 109. Tabs in the Scanner Statistics window

Tab Displays...
DAT file stats [532] Health of scanner-historian communication and .dat file status.
Point scan stats (hdr) [532] Information collected by your point scanner(s).
Point scan stats (detail) Detailed information from your point scanner on a single-point basis.
[533]
Server stats [534] The scanners that are currently connected to the historian server and
the timestamps on information that they send.

OPH070 531
Analyzing your historian's data collection ([Link])

DAT file stats tab

Use the DAT file stats tab to check the communication between your scanner and the
historian, and the percentage that your dat file is filled. Generally, your dat file should be no
more than 20% full. If it is significantly more full, it may indicate that you are using a scan
rate higher than the historian can accommodate, or you have lost communication for some
amount of time.

Figure 426. DAT file stats tab

Point scan stats (hdr) tab

Use the Point scan stats (hdr) tab to check the information that your point scanner is
collecting. Select a scanner to view information specific to that scanner's collection. For
example, you can check how many total samples a point scanner has taken due to value or
status changes. A number of Missed Scan Cycles mean that a scanner might be too busy.

532 OPH070
 Analyzing your historian's data collection ([Link])

Figure 427. Point scan stats (hdr) tab

Point scan stats (detail) tab

Use the Point scan stats (detail) tab to view point scanner information on an individual point
basis. For example, you can sort by total samples in a descending order to see which points
are saving the most and why. The Sort By drop-down enables you to sort by point name,
status samples, time, value, and total.

OPH070 533
Analyzing your historian's data collection ([Link])

Figure 428. Point scan stats (detail) tab

Server stats tab

Use the Server stats tab to examine the timestamps on your collected data and gauge how
current the collected information is. This tab displays which scanners are currently
connected to the Server and what most recent data was sent. The Scanner/Partner column
includes the drop(s) that host the scanner (or redundant scanner pair) along with the
primary scanner ID field within the brackets, as shown in the following figure.

534 OPH070
 Historian fault codes

Figure 429. Server status tab

19.5 Historian fault codes

Complete fault code strings are displayed in your error log.

You can diagnose most fault codes that appear by accessing the Ovation Fault Information
Tool for Ovation releases 3.4 and earlier. To access the Ovation Fault Information tool, log on
to the Ovation/WDPF Users site, and click the Fault Information Tool in the left hand menu.
Alternatively, enter the following URL:

[Link]

For Ovation 3.5 and later releases, the fault codes are part of Ovation and are displayed in
the Ovation System Viewer application (described in the Ovation Operator Station User
Guide).

OPH070 535
 Lab Data overview

20 Using Lab Data

Topics covered in this section:
• Lab Data overview [537]
• Storing Lab Data [537]
• OPH Lab Data Interfaces [538]
• Lab Data Sender interface [538]
• To access the Lab Data Manager [539]
• Lab Data Manager Groups and Permissions [544]
• To modify a group [545]
• To delete a group [546]
• To import all group settings [547]
• Managing a Lab Data user session [547]
• Customizing columns in the Session Explorer [550]
• To retrieve Lab Data from the historian [552]
• To validate a Lab Data session [553]
• To import an external file into Lab Data [554]
• To send Lab Data to the historian [555]
• Lab history data files [555]
• Lab history data retrieval [559]

20.1 Lab Data overview

The historian allows you to store process point data (lab history data) that does not
originate directly from your DCS. This means that external non-DCS data, values, and
timestamps can be stored into history. Typically, this point data is entered in the system by
a user through an application that then packages the data and sends it to the historian. This
data is stored in the historian database and can be retrieved through the same mechanisms
that retrieve regularly scanned point data in the historian, such as reports, trends, reviews,
and the Excel add-in.

20.2 Storing Lab Data

Points that are configured as lab history points count as licensed points just as regularly
collected scanner points count. Lab history points that have been previously configured in
the historian can be disabled so that they will not count towards your license allowance.

Attribute data must be provided for all lab history points that are sent to the historian. An
attribute is a specification that defines a property of an object, element, or file. To provide
attribute data, send attribute samples to the historian before you send the corresponding
lab history point data samples. This is necessary because the attribute data is required to
perform retrievals for reports, trends, reviews, and to allow validation of lab history point
data samples.

OPH070 537
OPH Lab Data Interfaces

Lab history attribute data is stored in the existing attribute data table (PT_ATTRIB) and is
subject to standard rules regarding online storage and migration to archive media. Lab
history point data is stored like other historical data. The lab history point data is stored in
table (PT_LAB_HIST) and is subject to the same rules as the other process point data tables.
These rules include:

• Space must be shared with other historian data. This means that the oldest data can be
rolled off to make room for new data if the disks are approaching full capacity.
• Data files are migrated from internal database space to the archive media.
• Lab history data is subject to the settings configured in the installation process and
licensing.

Storage of future-timestamped lab history data is not supported. Lab history data must
have a timestamp equal to or less than the current time to be stored. You can store an
annotated text entry with the lab history point sample.

20.3 OPH Lab Data Interfaces

You can use the Lab Data user interfaces to send lab history point and attribute data to the
historian, where it can be stored. The interfaces connect to the historian and transfer the
point and attribute data that you want to store. Using these interfaces, you must first
configure the lab history points that you want to store in the historian. You will need to
provide attribute and data samples for these lab history points.

There are two ways to get data to the interface:

• ASCII .csv files - sending these files using the Lab Data Sender [538].
• Lab Data Manager - using the Lab Data Manager [539] interface to enter and validate
Lab Data samples and then sending the validated content to the OPH.

20.4 Lab Data Sender interface

The historian includes a Lab Data sender program to send .csv files containing Lab Data
configuration, attributes, and data samples to the historian for storage. You can access this
program from a command line or as a GUI from your Windows menu.

• To access the UI, choose Start -> Programs -> Ovation Process Historian -> Lab Data
Sender.
or
• Navigate to your \bin\ folder and double-click [Link]. The OPH Lab Data
Sender interface appears:

538 OPH070
 To access the Lab Data Manager

Figure 430. OPH Lab Data window

or
• Alternatively, to access the program from a command line, type:
Ovhist\bin\OvhLabData -f [Link] -s OphServer

The program requires you to specify the file that contains your lab history data and to select
the historian(s) that you want to send the data to. If you choose to access this program from
the command line, you can include its functionality in a batch file.

When Lab Data files are processed by the Lab Data API, the operation status is appended to
your input file. The operation status identifies any errors that occurred when processing the
Lab Data files.

20.5 To access the Lab Data Manager

Use the following steps to access the Lab Data Manger:

Choose Start -> Programs -> Ovation Process Historian -> Lab Data Manager. The Lab Data
Manager UI main screen appears:

OPH070 539
To access the Lab Data Manager

Figure 431. Lab Data Manager Main window

20.5.1 To access the Lab Data Options window

Use the following steps to access the Lab Data Options window:

540 OPH070
 To access the Lab Data Manager

1. Click on the application menu from the Lab Data Manager main screen, and then the
Lab Data Options button. The Lab Data Options window appears. The window has the
following options:
• General
• User Groups
• Point Attributes

Figure 432. Lab Data Options window - General Option

2. Select General Lab Data options. Define the server and default time zone in this dialog.

OPH070 541
To access the Lab Data Manager

3. Select the User Groups option. The Manage Groups dialog appears. This window allows
you to define and edit user groups. See To add users to a predefined group [544] for
more information.

Figure 433. Lab Data Options window - User Groups options

542 OPH070
 To access the Lab Data Manager

4. Select the Point Attributes option. The Point Attribute Synchronization window
appears. See To synchronize point attributes [543] for more information. This window
allows you to update the local database with the latest point attributes from the
selected historian. You choose the historian to synchronize with from this window.

Figure 434. Lab Data Options window - Point Attributes option

20.5.2 To synchronize point attributes

Use the following steps to synchronize point attributes:

1. Choose Point Attributes in the Lab Data Options window [540].

2. Choose the historian to synchronize with and select Synch.
3. The system synchronizes the point attributes with the historian server's point
attributes and updates the local attributes in the local/application database.
4. If Combine duplicate data from the different historians is checked, the system displays
the duplicate data in one row and shows "multiple" in the Historian server column.
Duplicate data means that one or more rows have the same value for point name, low/
high limit, and top/bottom value. You can filter the data by utilizing the grid sort and
filter capabilities.

OPH070 543
Lab Data Manager Groups and Permissions

20.6 Lab Data Manager Groups and Permissions

You can define groups and add members to groups to grant access and other permission
rights to certain users or groups defined in the Lab Data Manager.

Table 110. User permissions in the Lab Data Manager

User type User permissions

Member of Windows Administrator Overall read/write Lab Data interaction.
group
Manage sessions (add, edit, delete, and save sessions, set
session time range).

Manage users/groups (add, edit, and delete groups).

Import/export file.

Retrieve/send Lab Data to/from the Historian.

Member of group with Manage Sessions Manage sessions (add, edit, delete, and save sessions, set
permission session time range).
Member of group with Manage Users/ Edit and save existing session.
Groups permission
Manage users/groups (add, edit and delete groups).
Member of group with Import/Export Edit and save existing session.
file permissions
Import/export file.

Retrieve Lab Data from Historian.

Member of group with Send Lab Data to Edit and save existing session.
Historian permission
Send Lab Data to Historian.
User which does not belong in any The application will not load if you do not have access in
group the Lab Data user interface.
User which belongs to any group in the Edit and save existing session.
application but does not have any
permission set

20.6.1 To add users to a predefined group

Use the following steps to add users to a predefined group:

1. Click on the application menu from the Lab Data Manager main screen, and then the
Lab Data Options button. The Lab Data Options window appears.
2. Select User Groups from the Lab Data Options dialog. The Manage Group dialog box
[540] appears.
3. Select New.

544 OPH070
 To modify a group

4. The New Group dialog box appears:

Figure 435. New Group window

5. Enter the Group name and Description.

a. Assign required permissions. See Lab Data user permission [544] s [544] for more
information.
b. Assign members of the group. Multiple users can be added by typing the user
names separated by a semicolon. If you choose the Add... button, the Select Users
dialog appears.
6. The system validates the group information and creates the group account.
7. Choose OK to accept the changes.

20.7 To modify a group

Use the following steps to modify a group:

1. From the Lab Data Options window [540], select User Groups option from the Lab Data
Option. The Manage Groups window appears.
2. Select a group name and choose Edit.

OPH070 545
To delete a group

3. The Edit Group dialog box appears:

Figure 436. Edit Group dialog

4. Edit the group description, permissions, and members information and choose Ok. The
system validates the group information and updates the group user account.

20.8 To delete a group

Use the following steps to delete a group:

1. From the Lab Data Options window [540], select a group name and choose Delete.
2. You are prompted to be sure that you really want to delete the group.
3. Choose Yes to acknowledge the message and the group is deleted from the system.

546 OPH070
 To import all group settings

20.9 To import all group settings

Importing of all group settings allows the duplication of user and group settings from
another workstation.

Use the following steps to import all group settings:

1. From the Lab Data Options window [540], select a User Groups and choose Import.
2. The Import Group window appears:

Figure 437. Import Group window

3. Press the Browse button to browse the database for groups to import.
4. If Include users is checked, groups and users that belong to the group will be included;
if not, then just the selected groups will be imported.
5. A Select File window appears. Select the database to import and select Open.

20.10 Managing a Lab Data user session

Note
You must be a member of the Windows Administrators group or have Manage Sessions
permissions to manage Lab Data sessions.

Use the following steps to manage a Lab Data user session:

OPH070 547
Managing a Lab Data user session

1. From the Lab Data Options [540] Manager window, click the Home tab.
2. The Session group includes Save [548], New [548], Open [550], and Delete [550].

20.10.1 To start a new session

Use the following steps to start a new session:

1. From the Lab Data Manager UI [540], choose New on the Home tab or choose New
from the Application Menu.
2. The system creates a blank session in a new window. The default session name is
LabDataSession1. The session name is displayed next to the application name. An
asterisk next to the name indicates that this session has not been saved.

Figure 438. LabDataSesson1* - session has not been saved

3. The Point Config, Point Attributes, and Point Samples tabs are displayed.

20.10.2 To save a session

Use the following steps to save a session:

1. From the Lab Data UI [540], select Save from the Home tab or choose Save from the
Application Menu.
2. If saving a new session, you are prompted to enter a session name.

548 OPH070
 Managing a Lab Data user session

3. The Save As window appears. Enter a session name. The Start Time and End Time fields
are enabled if you are a member of the Windows Administrators group or have Manage
Sessions permissions.

Figure 439. Save As window

4. If the timestamps entered are out of range of the existing records, a notification
message appears. You can choose to edit the session time range or save all records.

Figure 440. Lab Data - notification message

OPH070 549
Customizing columns in the Session Explorer

5. You have the option to choose Yes, No, or Cancel.

• Yes: Allows you to save with errors. You will need to go back and fix the errors later.
• No: Allows you to correct the errors manually or use the C button. See the Save As
figure below.
• Cancel: Allows you to go back to the grid and make the correction.

Figure 441. Save As with C button

6. Click OK to save. The session is added to the Session Explorer.

20.10.3 To open an existing session

Use the following steps to open an existing session:

1. Select a session name from the Session Explorer and click Open in the session group of
the Home tab. Alternatively, you can double-click on the Session in the Session
Explorer.
2. You will be prompted to save the current session before loading the selected session, if
it has not been saved.

20.10.4 To delete a session/sessions

You can choose to delete a session/sessions from the Session Explorer. A session must be
closed before it can be deleted.

Use the following steps to delete a session/sessions:

1. Choose the session name from the Session Explorer and select Delete from the ribbon
bar. You may also choose Delete from the Application Menu.
2. Click Yes to delete the selected session.

20.11 Customizing columns in the Session Explorer

The columns in the Session Explorer [548] can be hidden, filtered, added, and sorted. See
Historian Configuration Tool [77] for information about customizing the grid view.

550 OPH070
 Customizing columns in the Session Explorer

20.11.1 To add column filters in the Session Explorer

Use the following steps to add column filters in the Session Explorer:

1. Right-click on the header for the selected column.

2. Choose Filter Editor.
3. A Filter Editor window appears:

Figure 442. Filter Editor

4. Choose OK to save the changes. The columns are filtered based on the condition.

20.11.2 To edit column filters in the Session Explorer

There are four ways to edit a filter:

• Right-click the column header of the selected column and select Filter Editor.
• Modify the filter by changing the condition located at the lower left corner of the
Session Explorer to enable or disable the existing filter.
• Click the Edit Filter link at the lower right corner of the Session Explorer.
• Click the small filter icon in the column header to customize the column filter. Clicking
the drop-down arrow displays a recent filter history.

Figure 443. Edit column filters

OPH070 551
To retrieve Lab Data from the historian

20.11.3 To clear filter columns in the Session Explorer

There are two ways to clear a filter:

• Click the X button on the left corner for the grid in the Session Explorer.
• Right-click on the column header and choose Clear Filter from the right-click menu.

Figure 444. Clear filter columns

20.11.4 To enable or disable filter column in the Session Explorer

Use the following steps to enable or disable the filter column in the Session Explorer:

• Select or clear the check box next to the filter in the Session Explorer.

Figure 445. Filter check box

20.12 To retrieve Lab Data from the historian

Use the following steps to retrieve Lab Data from the historian:

1. Open or create a session and choose the Data tab.

2. Choose Retrieve from the Historian group.

552 OPH070
 To validate a Lab Data session

3. The Retrieve window appears.

Figure 446. Retrieve window

4. Select the tables of Lab Data information you want to retrieve from. Select Historian or
accept the default. The default data for the Historian is retrieved from the global
settings. The default start time is 10 minutes prior to the current time. The default end
time is the current time. You may choose the Browse button to search for a point name
from the Point Names dialog. The Add button is active when a valid Point name is
entered in the Point name field.
5. Press OK to start the retrieval. Data is retrieved from the historian into your session.

20.13 To validate a Lab Data session

Use the following steps to validate a Lab Data session:

1. Choose Validate from the Records group in the Home tab.

2. Each row within the Lab Data session is validated.

OPH070 553
To import an external file into Lab Data

3. If a validation error occurs, a description of the error appears in the Error List window:

Figure 447. Error List

4. Double-click the error from the list to highlight the actual row and column in the
current session where the error occurred.

20.14 To import an external file into Lab Data

You must be a member of the Windows Administrators group or have Import/Export
permissions to perform this action.

Use the following steps to import an external file into Lab Data:

1. Choose Import from XML or Import from Text file on the Lab Data UI from the Data tab.
2. The Import from Text File window appears. Enter the file name to be imported. Text
and XML formats are supported.

Figure 448. Import from Text file window

3. Choose Open to open and import the file.

554 OPH070
 To send Lab Data to the historian

4. If existing records are in the current session, you are asked to append the data. Choose
Yes to append the data, No to create a new session, or Cancel to cancel the import.

20.15 To send Lab Data to the historian

Note
You must be a member of the Windows Administrators group or have Send Lab Data to
Historian permission.

Use the following steps to send Lab Data to the historian:

1. Open a Lab Data session.

2. Select Send from the Historian Group and the Data tab.

Figure 449. Lab Data session - send

3. A notification message appears. You are about to send the Lab Data to the Historian.
4. You are prompted if you want to validate the Lab Data session before sending it to the
Historian. Choose Yes to validate the session. You may also choose No and the Lab Data
session will not be validated before it is sent to the Historian.
5. The Lab Data session is sent to the session's defined Historian.

20.16 Lab history data files

The Lab Data interface obtains information on your lab history data's point configuration,
attributes, and the data itself in the form of ASCII files.

Each file contains keywords in square brackets, for example, [FIELDS]. The keywords
determine how the file is processed. For example, the keyword LAB_PT_CFG indicates that
this file is a configuration file. You can use the provided commands to update the
CFG_PT_NAME table for the specified Lab Data point names. The CSV file format is editable
by using a text editor, such as Notepad or Excel.

The following sample files demonstrate the appropriate syntax.

Lab Data Point Configuration (OvHist\bin\[Link]):

# CFG_PT_NAME

# Available fields:

OPH070 555
Lab history data files

# NAME, SOURCE_NAME, CATEGORY, DATA_TYPE, INVERTED, ENABLED

[LAB_PT_CFG]

[INSERT]

[FIELDS]

NAME, SOURCE_NAME, CATEGORY, DATA_TYPE, INVERTED

"DEMO_LAB_01.UNIT0@OVATION, "DEMO_LAB_01", "LAB", "R", "N"

DEMO_LAB_02.UNIT0@OVATION, "DEMO_LAB_02", "LAB", "D", "N"

DEMO_LAB_03.UNIT0@OVATION, "DEMO_LAB_03", "LAB", "R", "N"

DEMO_LAB_04.UNIT0@OVATION, "DEMO_LAB_04", "LAB", "R", "N"

DEMO_LAB_05.UNIT0@OVATION, "DEMO_LAB_05", "LAB", "R", "N"

DEMO_LAB_06.UNIT0@OVATION, "DEMO_LAB_06", "LAB", "R", "N"

DEMO_LAB_07.UNIT0@OVATION, "DEMO_LAB_07", "LAB", "R", "N"

DEMO_LAB_08.UNIT0@OVATION, "DEMO_LAB_08", "LAB", "R", "N"

Lab Data Attribute Samples (OvHist\bin\[Link]):

# PT_ATTRIB

# Available fields:

# NAME, DESCRIPTION, AUX_DESCRIPTION, ENGINEERING_UNITS,

SET_DESCRIPTION, RESET_DESCRIPTION, SIGNIFICANT_DIGITS,

BOTTOM_SCALE, TOP_SCALE, LOW_LIMIT, HIGH_LIMIT, CHARACTERISTICS

[LAB_PT_ATTRIB]

[INSERT]

556 OPH070
 Lab history data files

[FIELDS]

NAME, DESCRIPTION, AUX_DESCRIPTION, ENGINEERING_UNITS,

SET_DESCRIPTION, RESET_DESCRIPTION, SIGNIFICANT_DIGITS,

BOTTOM_SCALE, TOP_SCALE, LOW_LIMIT, HIGH_LIMIT, CHARACTERISTICS

DEMO_LAB_01.UNIT0@OVATION, "DEMO_LAB_01 DESC", "DEMO_LAB_01 AUX",

"Ohm", "ON", "OFF", 1, 11, 20, 12, 19

DEMO_LAB_02.UNIT0@OVATION, "DEMO_LAB_02 DIGITAL", "DEMO_LAB_02

AUX", "", "TRUE", "FALSE", 1, 0, 1, 0, 1

DEMO_LAB_03.UNIT0@OVATION, "DEMO_LAB_03 DESC", "DEMO_LAB_03 AUX",

"Amp", "1", "0", 3, 31, 40, 32, 39

DEMO_LAB_04.UNIT0@OVATION, "DEMO_LAB_04 DESC", "DEMO_LAB_04 AUX",

"MHz", "OFF","ON", 4, 41, 50, 42, 49

DEMO_LAB_05.UNIT0@OVATION, "DEMO_LAB_05 DESC", "DEMO_LAB_05 AUX",

"Watts", "ON", "OFF", 5, 51, 60, 52, 59

DEMO_LAB_06.UNIT0@OVATION, "DEMO_LAB_06 DESC", "DEMO_LAB_06 AUX",

"HP", "ON", "OFF", 6, 61, 70, 62, 69

DEMO_LAB_07.UNIT0@OVATION, "DEMO_LAB_07 DESC", "DEMO_LAB_07 AUX",

"Volts", "OFF","ON", 7, 71, 80, 72, 79

DEMO_LAB_08.UNIT0@OVATION, "DEMO_LAB_08 DESC", "DEMO_LAB_08 AUX",

"cm", "ON", "OFF", 8, 81, 90, 82, 89

Lab Data Point Samples (OvHist\bin\[Link])

# PT_LAB_HIST

# Available fields:

# NAME, TIMESTAMP_GMT|TIMESTAMP_LOCAL, TIME_NSEC, SAMP_FLAGS,

F_VALUE, STS, MEMO

[LAB_DATA]

OPH070 557
Lab history data files

[INSERT]

[FIELDS]

NAME, TIMESTAMP_GMT, F_VALUE, STS, MEMO

DEMO_LAB_01.UNIT0@OVATION, "03/10/2003 [Link]", 18.1, GQ, MEMO1

DEMO_LAB_02.UNIT0@OVATION, "03/10/2003 [Link]", 0, GQ, MEMO2

DEMO_LAB_03.UNIT0@OVATION, "03/10/2003 [Link]", 33.3, FQ, MEMO3

DEMO_LAB_04.UNIT0@OVATION, "03/10/2003 [Link]", 44.4, BQ, MEMO4

DEMO_LAB_05.UNIT0@OVATION, "03/10/2003 [Link]", 55.5, 1, MEMO5

DEMO_LAB_06.UNIT0@OVATION, "03/10/2003 [Link]", 66.6, 2, MEMO6

DEMO_LAB_07.UNIT0@OVATION, "03/10/2003 [Link]", 77.7, 3, MEMO7

DEMO_LAB_08.UNIT0@OVATION, "03/10/2003 [Link]", 88.8, 0x34, MEMO8

[FIELDS]

NAME, TIMESTAMP_GMT, F_VALUE, STS, MEMO

DEMO_LAB_01.UNIT0@OVATION, "03/12/2003 [Link]", 12.1, GQ, MEMO1

DEMO_LAB_02.UNIT0@OVATION, "03/12/2003 [Link]", 1, GQ, MEMO2

DEMO_LAB_03.UNIT0@OVATION, "03/12/2003 [Link]", 38, FQ, MEMO3

DEMO_LAB_04.UNIT0@OVATION, "03/12/2003 [Link]", 48, BQ, MEMO4

DEMO_LAB_05.UNIT0@OVATION, "03/12/2003 [Link]", 58, 1, MEMO5

DEMO_LAB_06.UNIT0@OVATION, "03/12/2003 [Link]", 68, 2, MEMO6

DEMO_LAB_07.UNIT0@OVATION, "03/12/2003 [Link]", 78, 3, MEMO7

DEMO_LAB_08.UNIT0@OVATION, "03/12/2003 [Link]", 82, 0x34, MEMO8

558 OPH070
 Lab history data retrieval

20.16.1 INSERT and UPDATE keywords

Two frequently used keywords that help you control how to manage your Lab Data are
INSERT and UPDATE, as well as the INSERT/UPDATE keyword combination.

Table 111. Keywords

Keyword Usage
[INSERT] Inserts a row that did not already exist.
[UPDATE] Updates a row that already exists.
[INSERT/UPDATE] Allows the historian to determine whether INSERT or UPDATE is appropriate for
each individual usage (this keyword requires additional server-side processing).

20.17 Lab history data retrieval

You can view your historical Lab Data through:

• Trends
• Historical Review
• Reports
• Excel add-in

You can view scanner-generated data and lab history data in the same Trend.

OPH070 559
 Configuration tables

21 Table Definitions
Topics covered in this section:
• Configuration tables [561]
• Point history tables [563]
• Message history tables [566]
• Archive volume tables [569]
• History Edit and Annotation tables [570]
• System tables [571]
• User Defined Function (UDF) tables [572]
• History Console tool syntax [581]

21.1 Configuration tables

A configuration table is maintained in which every group in the historian is stored along
with the source of its data. Each group is assigned a unique history ID. The history IDs are
not recycled, which ensures that you can always access historical data.

Table 112. CFG_GROUP

Column name Column description

TYPE Scan Group.
NAME ASCII config group name.
ID Unique integer ID.
SCANNERID ID of originating scanner for a point group.
SCAN_MSECS Frequency of scanning in milliseconds.
DB_VAL Compression deadband value.
DB_K_VAL Compression deadband additional information.
DB_N_VAL Compression deadband additional information.
CONDITIONID Unused field.
MAX_SAVE_TIME The amount of time that the scanner will let elapse between exception samples
before it forces a sample to be stored.
DESCRIPTION English description.
ENABLED Point group enables status: Y or N.
DB_ALGNAME Algorithm name.
QUALIFIER ID of originating scanner for a point group.

OPH070 561
Configuration tables

A configuration table is maintained in which every point name in the historian is stored
along with the source of its data. Each point is assigned a unique history ID. The history IDs
are not recycled, which ensures that you can always access historical data. Point names are
never deleted from this table, though you can modify the point information.

The same history ID is retained permanently for a specific point name, though you can
modify other point information because it does not compromise data retrieval. This history
ID provides the key to store and retrieve data to/from the current, historical, and modified
tables. Inactive points can be marked as disabled because they are never deleted from the
table. The type of data that is associated with each point is configured so that collection,
storage, and retrieval can handle the data in the historical data tables.

Table 113. CFG_PT_NAME

Column name Column description

NAME ASCII point name.
ID Unique integer ID.
PT_FLAGS Flags for processing options.
SOURCE_ID ID of originating data scanner/source.
SOURCE_NAME Name of point in originating system.
CATEGORY For example, Temp, Pressure, Boiler, and so forth.
IMPORTED Indicates if point is imported.
ENABLED Indicates if point is currently enabled.
DATA_TYPE Analog (‘R’), Digital (‘D’), Packed (‘P’).
INVERTED Indicates if point values are inverted. Not applicable.
SCAN_MSECS Frequency of scanning in milliseconds (40 msec, 100 msec, or multiple of 1000).
DB_ALGCODE Compression type, deadband information, and so forth.
DB_ALGNAME Compression type, deadband information, and so forth.
DB_VAL Compression deadband.
DB_K_VAL Compression deadband additional information.
DB_N_VAL Compression deadband additional information.
SCAN_GROUP_ID ID of assigned scan group.
PT_INFO Contains DCS specific point parameters.
CREATION_TIME Date and Time point was added.
MODIFY_TIME Date and Time point was last modified.
MAX_SAVE_TIME The amount of time that the scanner will let elapse between exception samples
before it forces a sample to be stored.
SOURCE_TYPE Identifies as a scanned point, lab point, or statistics point.
SCADA_TYPE SCADA type.

A configuration table is maintained in which every scanner in the historian is stored along
with the source of its data. Each scanner is assigned a unique history ID. The history IDs are
not recycled, which ensures that you can always access historical data.

562 OPH070
 Point history tables

Table 114. CFG_DB_SOURCE

Column name Column description

NAME Unique name for the data source.
ID Unique Source ID.
PARTNER_ID ID of configured partner scanner.
TYPE Type of data source, for example, Pt Scanner, Attribute Scan.
DOWNLOAD_TIME_A Time of last download for point scanner.
DOWNLOAD_TIME_B Time of last download for attribute scanner.
NET_ADDRESS Character string that contains the TCP/IP address for scanner workstation.
ENABLED Source drop status.
DOWNLOAD_TIME_C SCADA.

21.2 Point history tables

Each data sample that is generated is stored in the historical data tables. These tables
contain timestamped value and status information for the points that are being collected by
the historian server. Entries are stored in the history table at a fixed minimum frequency,
even when no changes occur. This enables you to determine the value of a point at the
beginning of your requested retrieval interval. The fixed minimum frequency is set at one
hour. The frequency may be longer for migrated data.

Status data is stored in a normalized format where common status information is recorded
for all points, regardless of their source. The DCS scanner process performs normalization
on status information, value formats, and time formats prior to sending data to the
historian server collection process.

This following table describes how the status information is normalized from an Ovation
system.

Table 115. Normalization of status information

Status definition Point type Mapped Emerson Ovation

status
Bit 0 Better Bit LA, DA Status 1 Bit 0
Bit 1 Worse Bit LA, DA Status 1 Bit 1
Bit 2 Low Limit Exceeded LA, DA Status 1 Bit 2
Bit 3 High Limit Exceeded LA, DA Status 1 Bit 3
Bit 4 Hardware Error LA, DA, LD, DD, LP, DP, RM, Status 3 Bit 3
RN
Bit 5 Alarm Unacknowledged LA, DA, LD, DD, LP, DP, RM, Status 1 Bit 5
RN
Bit 6 Cut out from Alarm Checking LA, DA, LD, DD, LP, DP Status 1 Bit 6
Bit 7 Point is in Alarm LA, DA, LD, DD, LP, DP, RM, Status 1 Bit 7
RN

OPH070 563
Point history tables

Status definition Point type Mapped Emerson Ovation

status
Bit 8 Quality LA, DA, LD, DD, LP, DP Status 1 Bit 8
Bit 9 Quality LA, DA, LD, DD, LP, DP Status 1 Bit 9
Bit 10 Current Value is operator LA, DA, LD, DD Status 1 Bit 10
entered
Bit 11 Point is removed from scan/ LA, DA, LD, DD, LP, DP, RM, Status 1 Bit 11
forced RN
Bit 12 Limit Checking off LA, DA, LD, DD, LP, DP, RM, Status 1 Bit 12
RN
Bit 13 Alarm Checking off LA, DA, LD, DD, LP, DP, RM, Status 1 Bit 13
RN
Bit 14 Alarm Toggle LA, DA, LD, DD, LP, DP, RM, Status 1 Bit 14
RN
Bit 15 Point is timed out LA, DA, LD, DD, LP, DP, RM, Status 1 Bit 15
RN
Bit 16 Analog Limit Number (Better Bit LA, DA Status 1 Bit 16
if bit 18 is set)
Bit 17 Analog Limit Number (Worse LA, DA Status 1 Bit 17
Bit if bit 18 is set)
Bit 18 Analog Limit Incremental Limit LA, DA Status 1 Bit 18
Bit 19 Alarm Needs Reset LA, DA, LD, DD, LP, DP, RM, Status 1 Bit 19
RN
Bit 20 SID Limit Error LA, DA, LD, DD, LP, DP Status 1 Bit 20
Bit 21 User Defined High Limit LA, DA Status 1 Bit 21
Bit 22 User Defined Low Limit LA, DA Status 1 Bit 22
Bit 23 Reasonability Check Off LA, DA Status 1 Bit 23
Bit 24 Engineering Range Check Off LA, DA Status 1 Bit 24
Bit 25 Quality Latched LA, DA Status 2 Bit 14

LD, DD Status 2 Bit 11

Bit 26 Tagged Out LA, DA, LD, DD, LP, DP, RM, Status 3 Bit 2
RN
Bit 27 Oscillating LD, DD, LP, DP, RM, RN Status 3 Bit 4
Bit 28 Shelve Bit LA, DA, LP, DP, RM, RN Status 1 Bit 26
Bit 29 Out of Service LA, DA, LD, DD, LP, DP, RM Status 1 Bit 29
Bit 30 Alarm Cut Out Suppressed LA, DA, LD, DD, LP, DP, RM, Status 1 Bit 27
RN

Note
If a point is analog and both bits 2 and 3 are set, the point is in Sensor alarm.

564 OPH070
 Point history tables

Note
If a point is analog and bit 21 is set, the point is in high UDA alarm. If bit 22 is set, the point is
in low UDA alarm. If bit 22 is reset, the point is in high UDA alarm.

Table 116. PT_HF_HIST

Column name Column description

ID Unique point ID.
TIMESTAMP Timestamp in UTC.
TIME_NSEC High resolution timestamp in nanoseconds.
SAMP_FLAGS Indicates duplicate data, missing data, and modified data.
F_VALUE Floating-point value of sample, as appropriate, for analog points.
RAW_VALUE Raw value of sample, as appropriate, for packed points.
STS Status and Quality indicators for value fields.
SAMP_CREATE_TIME Time at which the sample is inserted into the historian.
SAMP_CREATE_SEQ Sequence number on the time that the sample is inserted.

Table 117. PT_ATTRIB

Column name Column description

ID Unique point ID.
TIMESTAMP Timestamp in UTC.
TIME_NSEC High resolution timestamp in nanoseconds.
SAMP_FLAGS Flag information.
DESCRIPTION English Description.
AUX_DESCRIPTION Auxiliary Description.
ENGINEERING_UNITS Engineering Units description.
SET_DESCRIPTION Set state description for digital points.
RESET_DESCRIPTION Reset state description for digital points.
SIGNIFICANT_DIGITS Number of decimal places to display.
BOTTOM_SCALE Bottom of scale value for display.
TOP_SCALE Top of scale value for display.
LOW_LIMIT Low limit for alarming purposes.
HIGH_LIMIT High limit for alarming purpose.
SAMP_CREATE_TIME Time at which the sample is collected at the scanner.
SAMP_CREATE_SEQ Sequence number on the time that the sample is inserted.
LATITUDE GIS coordinate.
LONGITUDE GIS coordinate.
ALTITUDE GIS coordinate.

OPH070 565
Message history tables

Column name Column description

CHARACTERISTICS Point characteristics

Table 118. PT_HF_CURR

Column name Column description

ID Unique point ID.
TIMESTAMP Timestamp in UTC.
TIME_NSEC High resolution timestamp in nanoseconds.
SAMP_FLAGS Indicates duplicate data, missing data, and modified data.
F_VALUE Floating-point value of sample, as appropriate, for analog points.
RAW_VALUE Raw value of sample, as appropriate, for packed points.
STS Status and Quality indicators for value fields.
SAMP_CREATE_TIME Time at which the sample is inserted into the historian.
SAMP_CREATE_SEQ Sequence number on the time that the sample is inserted.

Table 119. PT_LAB_HIST

Column name Column description

ID Unique point ID.
TIMESTAMP Timestamp in UTC.
TIME_NSEC High resolution timestamp in nanoseconds.
SAMP_FLAGS Indicates duplicate data, missing data, and modified data.
STS Status and Quality indicators for value fields.
F_VALUE Floating-point value of sample, as appropriate, for analog points.
MEMO Optional annotation on Lab Data sample.
SAMP_CREATE_TIME Time at which the sample is inserted into the historian.
SAMP_CREATE_SEQ Sequence number on the time that the sample is inserted.

21.3 Message history tables

The historian can store messages that originate from the DCS scanners, as well as messages
that originate locally due to historian events. Multiple message types are supported,
including:

• DCS data messages, such as alarms, operator events, ASCII messages.

• DCS event messages, such as time shifts or missing data.
• Link messages, such as link establish and failure messages.
• Historian event messages, such as disk space errors.

566 OPH070
 Message history tables

Table 120. MSG_ALARM_HIST

Column name Column description

TIMESTAMP Timestamp in UTC.
TIME_NSEC High resolution timestamp in nanoseconds.
MSG_FLAGS Message flags.
MSG_TYPE Message type of alarm, for example: cutout, timeout, high, low, return. For
additional information, refer to the Ovation Operator Station User Guide.
SUB_TYPE Subtype for alarm filtering.
SOURCE_ID ID of the scanner that sent the message.
SYSTEM ID of the system that originated the message.
NODE Node or drop that originated the message.
ALM_NAME The name of the point for which an alarm occurred.
PRIM_TEXT 200 character alarm text message storage.
ALARM_INFO1 Additional message information.
CODE Alarm code.
DESCRIPTION Alarm description.
ALARM_PRIORITY Alarm priority.
VALUE Value string.
QUALITY Quality.
UNITS Units string.
LIMITS Limits string.
INCR Incremental limit.
POINT_TYPE Record type of the point.
PLANT_MODE Value of plant mode.
CHARACTERISTICS Point characteristics for the point in alarm.

Table 121. Alarm subtypes

Subtype number Definition

0 No entry.
1 New Alarm.
2 Return.
3 Incremental Alarm.
4 Status Change.
5 Timed Out Drop.
6 Spurious Alarm.
7 Suppressed Alarm.
8 Acknowledged Alarm.

OPH070 567
Message history tables

Subtype number Definition

9 Released Alarm.

Table 122. MSG_SOE_HIST

Column name Column description

TIMESTAMP Timestamp in UTC.
TIME_NSEC High resolution timestamp in nanoseconds.
MSG_FLAGS Bit flags.
SOURCE_ID ID of the scanner that sent the message.
SYSTEM ID of the system that originated the message.
NODE Node or drop that originated the message.
PRIM_TEXT 200 character SOE message storage.
SOE_INFO1 Additional message information.
SOE_FLAGS SOE flags field.
SOE_FORMAT Format string.
POINT_SID SID of a point.
DPU_ERROR DPU error string.
POINT_NAME Name of a point.
DESCRIPTION Description.
STATE State string.

Table 123. MSG_TEXT_HIST

Column name Column description

TIMESTAMP Timestamp in UTC.
TIME_NSEC High resolution timestamp in nanoseconds.
MSG_FLAGS Message flags.
MSG_TYPE Text message type, for example, Opevent, System, and so forth.
SUB_TYPE Sub type category for additional filtering.
SOURCE_ID ID of the scanner that sent the message.
SYSTEM ID of the system that originated the message.
NODE Node or drop that originated the message.
PRIM_TEXT 200 character text message storage.
SUPP_TEXT 100 character optional supplementary message text.
SUPP_INFO1 Additional message information.
SUPP_INFO2 Additional message information.
DOMAIN Domain of the user responsible for the message.
USERNAME User name of the user responsible for the message.

568 OPH070
 Archive volume tables

Column name Column description

REASON Reason for the message.
MESSAGE* Message component of the operator event.
POINT_NAME* Point name component of the operator event.
DESCRIPTION* Description component of the operator event.
NEW_VALUE* New value component of the operator event.
PREVIOUS_VALUE* Previous value component of the operator event.
QUALIFIED_POINT_NAME* Fully qualified point name associated with the operator event.

Note
* These fields are populated when the data row in the MSG_TEXT_HIST table is an operator
event. Otherwise, these fields are NULL. Not all fields are available for all operator events. If
not available, the value is NULL.

21.4 Archive volume tables

Each entry in the ARC_VOLUME_LIST table corresponds to one side of your removable
media. You are prompted to label each side of your removable media when it is created. The
label is comprised of three fields from this table (VOLDB:SET:NUM), so that a volume label
might look like this: [Link].

Table 124. ARC_DEVICE_LIST

Column name Column description

TYPE Drive type (for example, DVD-RAM).
NAME Drive name.
WIN_DRIVE Drive letter.
STATE Drive state (for example, IDLE or REQUEST).
FLAGS Flag information.
VOLDB Volume database name.
SET Volume set.
NUM Volume number.
OPEN_TIME Date and time that the volume was opened.
MEDIA_TYPE Media type that contains the volume.

Table 125. ARC_VOLUME_LIST

Column name Column description

DATABASE_NAME Name of the volume database, typically the hostname. 25 characters maximum.
SET Name of the volume set within the volume database.
NUM Name of the volume number within the volume set.

OPH070 569
History Edit and Annotation tables

Column name Column description

MEDIA_TYPE Type of media that contains the volume: DVD-RAM.
FREE_SPACE Number of bytes available on the volume.
OPEN_TIME Date and time that the volume was opened.
CLOSE_TIME Date and time that the volume was closed. If null, the volume is open. If Close
Time is completed, the volume is full.

Table 126. ARC_VOLUME_DATA

Column name Column description

SET Name of the volume set.
NUM Name of the volume number.
DATA_TYPE Type of data: HF, Alarm, SOE, Text, Pt Attr, or Lab.
START_TIME Earliest data timestamp on the volume for the data type.
END_TIME Most recent data timestamp on the volume for the data type.

21.5 History Edit and Annotation tables

The annotations that you make using the History Edit tool become part of your historical
data, and are archived and managed like the rest of your historical data.

These are the annotation types that can be queried through SQL.

Table 127. ANNOTATION

Column name Column description

S_TIME Start timestamp in UTC.
NSECS High-resolution start timestamp in nanoseconds.
HISTORYTYPE Type of historical data (HF, Attr, EAL, and so forth).
DATATYPE Annotation type (Main or XREF).
SEQUENCE Sequence number.
SAMP_FLAGS Flag information.
SAMP_CREATE_TIME Time at which the sample is inserted into the historian.
SAMP_CREATE_SEQ Sequence number on the time that the annotation is inserted.
E_TIME End timestamp.
E_NSECS High resolution end timestamp in nanoseconds.
DOMAIN Domain name of where the annotation originates.
COMPUTER Computer name.
USERID User name that inserted the annotation.
TEXTSIZE The length of the Text column's value.
TEXT Annotation text.

570 OPH070
 System tables

Column name Column description

MAINSEQUENCE Main sequence number to be cross-referenced.
ID Point ID of the cross-referenced annotation.

The edits that have been made to your historical data become part of your historical data,
and are archived and managed like the rest of your historical data.

These are the edit types that can be queried through SQL.

Table 128. EDITAUDITLOG

Column name Column description

S_TIME Timestamp in UTC.
NSECS High resolution timestamp in nanoseconds.
HISTORYTYPE Type of historical data (HF, ANN, and so forth).
SEQUENCE Sequence number.
EDITSTARTTIME Timestamp when editing started.
EDITENDTIME Timestamp when editing ended.
EDITQUALIFIER ID for HF/LAB history type (TYPE if ANN).
EDITSEQUENCE Edit sequence number.
DOMAIN Domain name.
COMPUTER Computer name.
SAMP_FLAGS Sample information.
USERID User name.

21.6 System tables

The queries in this table enable you to see which retrieval applications are currently
connected and using licenses.

Table 129. SYSLICENSE

Column name Column description

THREADID Thread ID of the connection that is using a license.
USERNAME User name.
PASSWORD Password.
APPNAME Application name.
TYPE Internal or external license.
LOGINNAME User name.
DOMAINNAME Domain name.
COMPUTERNAME Computer name.
STATUS Connection status (Active or Disconnected).

OPH070 571
User Defined Function (UDF) tables

Column name Column description

DISCONNECT_TIME Time of disconnection.

21.7 User Defined Function (UDF) tables

The Historian SQL aggregates provide access to interval style processed data through SQL
queries. The SQL aggregates pseudo tables utilize User Defined Functions (UDF) syntax to
ensure standard compatibility with Excel and Crystal Reports.

The UDF tables are as follows:

• ProcessedData [572].
• ProcDataColWise [574].
• Summary [577].

21.7.1 ProcessedData tables

Table 130. ProcData

Column name Column description

HANDLE Point Handle.
ID Points Unique ID.
PROCESSING_TYPE For example, OPH_TIMEAVERAGE, OPH_TOGGLESET.
TIMESTAMP Timestamp in UTC.
TIME_NSEC High resolution time stamp in nanoseconds.
SAMP_FLAGS Flag information.
F_VALUE Floating-point value of sample, as appropriate, for analog points.
RAW_VALUE Raw value of sample, as appropriate, for packed points.
TIMESECS Timestamp in UTC.
TIMENSECS High resolution time stamp in nanoseconds.
STS Status and Quality indicators for value fields.
TIMESECS_VALUE Time value for point as appropriate for example, time of maximum or time set.
TIMENSECS_VALUE High resolution for point as appropriate for example, time of maximum or time
set.
ERROR Error condition detected.

The ProcessedData table provides three syntax options:

• PointsNameOnly [573].
• NameAggrPair [573].
• Complete [574].

572 OPH070
 User Defined Function (UDF) tables

PointsNameOnly
Only point names are provided and all points are processed with the same processing type,
such as asking for 30-second intervals with TIMEAVERAGE processing over a 10-minute
period.

Samples (PointsNameOnly)
Request time weighted average of three analog points over a 10-minute period specifying
IntervalCount of 10 so that each interval is one minute.

select * from processeddata (

#06/04/2009 [Link]#, #06/04/2009 [Link]#, IntervalCount, 10,

PointNamesOnly, OPH_TIMEAVERAGE,

'BLK00101C1A.UNIT2@OV23', 'BLK00101C2A.UNIT2@OV23',
'BLK00101C3A.UNIT2@OV23');

Request time weighted average of three analog points over a 10-minute period specifying
IntervalSize of 60 seconds so that 10 one-minute intervals are retrieved.

select id, timestamp, f_value, sts from processeddata (

#06/04/2009 [Link]#, #06/04/2009 [Link]#, IntervalSize, 60,

PointNamesOnly, OPH_TIMEAVERAGE,

'BLK00101C1A.UNIT2@OV23', 'BLK00101C2A.UNIT2@OV23',
'BLK00101C3A.UNIT2@OV23');

NameAggrPair
Point names are provided with each having its own specified processing type, for example,
asking for 60 * 10 second intervals with each point having a different processing type over a
10-minute period.

Sample (NameAggrPair)
Request three analog points over a 10-minute period specifying IntervalCount of 10 so that
each interval is one minute. Request time weighted average for first point, integration for
the second and minimum for the third.

select * from processeddata (

#06/04/2009 [Link]#, #06/04/2009 [Link]#, IntervalCount, 10,

NameAggrPair,

'BLK00101C1A.UNIT2@OV23', OPH_TIMEAVERAGE,

'BLK00101C1A.UNIT2@OV23', OPH_INTEGRATION,

'BLK00101C1A.UNIT2@OV23', OPH_MINIMUM);

OPH070 573
User Defined Function (UDF) tables

Complete
Complete processing options are provided for each named point including processing
types, bit number and integration constants, for example, asking for 10 * 1 minute intervals
with each point having a different processing type and parameters over a 10-minute period.

Samples (Complete)
Request four processing types for a packed point over a 10-minute period, specifying
IntervalCount of 2 so that each interval is five minutes. Specify that Bit 3 of the packed point
is to be used for the processing.

select * from processeddata (

#06/04/2009 [Link]#, #06/04/2009 [Link]#, IntervalCount, 2,

Complete,

'BLK00101P1P.UNIT2@OV23', OPH_NOPBIT, OPH_GENERATESUMMARY, 1, 3,

'BLK00101P1P.UNIT2@OV23', OPH_TIMEAVERAGE, OPH_GENERATESUMMARY, 1,

3,

'BLK00101P1P.UNIT2@OV23', OPH_TIMESET, OPH_GENERATESUMMARY, 1, 3,

'BLK00101P1P.UNIT2@OV23', OPH_TIMERESET, OPH_GENERATESUMMARY, 1,

3);

Request four processing types for an analog point over a 10-minute period, specifying
IntervalCount of 2 so that each interval is five minutes. Specify integration constants of 1.0
and 3.5 to be used for the processing of the OPH_INTEGRATION processing.

select * from processeddata (

#06/04/2009 [Link]#, #06/04/2009 [Link]#, IntervalCount, 2,

Complete,

'BLK00101C1A.UNIT2@OV23', OPH_TIMEAVERAGE, OPH_GENERATESUMMARY, 1,

1,

'BLK00101C1A.UNIT2@OV23', OPH_MINIMUM, OPH_GENERATESUMMARY, 1, 1,

'BLK00101R1A.UNIT2@OV23', OPH_INTEGRATION, OPH_GENERATESUMMARY,

1.0, 1,

'BLK00101R1A.UNIT2@OV23', OPH_INTEGRATION, OPH_GENERATESUMMARY,

3.5, 1);

21.7.2 ProcDataColWise table

ProcDataColWise UDF table provides functionality similar to the ProcessedData UDF table
but columns are returned in a column-wise orientation to facilitate use of data in report
style ordering inside Reports or Excel.

574 OPH070
 User Defined Function (UDF) tables

Table 131. ProcDataColWise

Column name Column description

HANDLE Point Handle.
ID Points Unique ID.
TIMESTAMP Timestamp in UTC.
TIME_NSEC High resolution timestamp in nanoseconds.
NOP Actual value of process point.
TIMEAVERAGE Timed average over interval.
MAXIMUM Maximum in interval.
MINIMUM Minimum in interval.
MAXIMUMACTUALTIME_SECS Time in seconds of maximum value in interval.
MAXIMUMACTUALTIME_NSECS Time in nanoseconds of maximum value in interval.
MIMIMUMTIMEACTUAL_SECS Time in seconds of minimum value of interval.
MINIMUMTIMEACTUALTIME_NSECS Time in nanoseconds of minimum value of interval.
INTEGRATION Integration over the interval.
TOGGLE Count of digital transitions over interval.
TOGGLESET Count of digital transitions to set state over interval.
TOGGLERESET Count of digital transitions to reset state over interval.
TIMESET_SECS Amount of time in seconds digital was set during interval.
TIMESET_NSECS Amount of time in nsecs digital was set during interval.
TIMERESET_SECS Amount of time in seconds digital was reset during interval.
TIMERESET_NSECS Amount of time in nsecs digital was reset during interval.
TOTAL Total of all samples during interval.
AVERAGE Average of all samples during interval.
COUNT Count all samples during interval.
STDEV Std dev of all samples during interval.
END Value at the end of the interval.
VARIANCE Variance of all the samples during the interval.
RANGE Total range of all values during the interval.
DURATIONGOOD_SECS Amount of time secs in good quality during interval.
DURATIONGOOD_NSECS Amount of time nsecs in good quality during interval.
DURATIONBAD_SECS Amount of time secs in non-good quality during interval.
DURATIONBAD_NSECS Amount of time nsecs in non-good quality during interval.
PERCENTGOOD Percentage good quality during interval.
PERCENTBAD Percentage non-good quality during interval.
DELTA Difference between value at start and end of interval.
START Value at the start of the interval.

OPH070 575
User Defined Function (UDF) tables

Column name Column description

AVGROC Average rate of change over the interval.
STS Status and Quality indicators for value fields.

Samples (ProcDataColWise)
PointNames Only: Request all columns for three analog points over a one-hour period
specifying IntervalCount of 10 so that each interval is six minutes.

select * from ProcDataColWise (

#06/04/2009 [Link]#, #06/04/2009 [Link]#, IntervalCount, 10,

PointNamesOnly,

'BLK00101C1A.UNIT2@OV23', 'BLK00101C2A.UNIT2@OV23',
'BLK00101C3A.UNIT2@OV23');

Request selected columns for three analog points over a one-hour period specifying
IntervalCount of 10 so that each interval is six minutes.

select ID, START, END, DELTA, AVERAGE, TIMEAVERAGE

from ProcDataColWise (

#06/04/2009 [Link]#, #06/04/2009 [Link]#, IntervalCount, 10,

PointNamesOnly,

'BLK00101C1A.UNIT2@OV23', 'BLK00101C2A.UNIT2@OV23',
'BLK00101C3A.UNIT2@OV23');

Request selected columns for three digital points over a one-hour period specifying
IntervalCount of 10 so that each interval is six minutes.

select ID, START, END, TOGGLE, TOGGLESET, TOGGLERESET

from ProcDataColWise (

#06/04/2009 [Link]#, #06/04/2009 [Link]#, IntervalCount, 10,

PointNamesOnly,

'BLK00101M1D.UNIT2@OV23', 'BLK00101M2D.UNIT2@OV23',
'BLK00101M3D.UNIT2@OV23');

Complete: Request all columns for three analog points over a one-hour period specifying
IntervalCount of 10 so that each interval is six minutes and specifying integration constants
to be used.

select * from ProcDataColWise (

#06/04/2009 [Link]#, #06/04/2009 [Link]#, IntervalCount, 10,

Complete,

576 OPH070
 User Defined Function (UDF) tables

'BLK00101C1A.UNIT2@OV23', OPH_GENERATESUMMARY, 1, 1,

'BLK00101R1A.UNIT2@OV23', OPH_GENERATESUMMARY, 1.0, 1,

'BLK00101R1A.UNIT2@OV23', OPH_GENERATESUMMARY, 3.5, 1);

21.7.3 Summary tables

Whenever a request is made from the ProcessedData UDF table, or the ProcDataColWise
UDF table the Summary UDF table is also populated and provides one set of summary data
over the entire requested period of raw data. This table can be accessed via SQL requests
but care must be taken to execute a ProcessedData or ProcDataColWise query to ensure the
Summary table is properly populated.

Table 132. ProcessedDataSummary

Column name Column description

HANDLE Point Handle.
ID Points Unique ID.
COUNT Number of intervals processed.
NUMSAMPLES Number of raw samples processed.
STATUS The accumulation of the status fields of the samples in the interval.
ERROR Error condition detected.
AVERAGE Average of all samples during entire requested time range.
MINIMUM Minimum in entire requested time range.
MINTIME_SECS Time in nanoseconds of minimum value in requested time range.
MINTIME_NSECS Time in seconds of minimum value in requested time range.
MAXIMUM Maximum in entire requested time range.
MAXTIME_SECS Time in seconds of maximum value in requested time range.
MAXTIME_NSECS Time in nanoseconds of maximum value in requested time range.
INTEGRATION The aggregated integration applied over the entire time range.
SUM Sum of requested time range.
TOGGLE Count of digital transitions over requested time range.
TOGGLESET Count of digital transitions to set state over requested time range.
TOGGLERESET Count of digital transitions to reset state over requested time range.
TIMESET_SECS Amount of time in seconds digital was set over requested time range.
TIMESET_NSECS Amount of time in nsecs digital was set over requested time range.
TIMERESET_SECS Amount of time in seconds digital was reset over requested time range.
TIMERESET_NSECS Amount of time in nsecs digital was reset over requested time range.

21.7.4 Scalar and Aggregate functions

The following section describes scalar and aggregate functions.

OPH070 577
User Defined Function (UDF) tables

Supported SQL functions

The following supported SQL functions can help you query your historical data:

• Count [578].
• Min [578].
• Max [579].
• Upper [579].
• Lower [579].
• Bitmask [579].
• Bitextract [579].
• Substring [579].
• Len [579].
• Concat [579].
• Trim [579].
• Ltrim [580].
• Rtrim [580].
• Abs [580].
• Round [580].
• Floor [580].
• Ceiling [580].
• Quality [580].
• ISNULL [580].
• NEW_TIME [580].
• GETDATE [580].

Note
For more information about using the SQL functions to query your data, see the
SQL_Funcs_Sample.ohs file that provides working examples of the various Scalar and
Aggregate SQL functions supported by the OPH.

Count
You can use the count function to return the exact number of database rows that match
your name criteria.

select count (*) from cfg_pt_name where name like 'BLK101%';

Min
You can use the min function to return the minimum values for a point during a time period
that you set.

select min(f_value) from pt_hf_hist where id=25 and timestamp>

#07/01/2009 [Link]# and timestamp< #07/01/2009 [Link]#;

578 OPH070
 User Defined Function (UDF) tables

Max
You can use the max function to return the maximum value for a point during a time period
that you set.

select max(f_value) from pt_hf_hist where id=25 and timestamp>

#07/01/2009 [Link]# and timestamp< #07/01/2009 [Link]#;

Upper
You can use the upper function to convert the capitalization of a string to all-upper-case.

select name, id from cfg_pt_name where name=upper

('bLk00101c1a.UNIT2@OV23');

Lower
You can use the lower function to convert the capitalization of a string to all-lower-case.

select lower (name), id from cfg_pt_name where

name='BLK00101C1A.UNIT2@OV23';

Bitmask
You can use the bit mask function to select bits that match your criteria, and optionally shift
the result to the right (in this case, the quality bits 8 and 9 are shifted to a single-digit
number by using '8').

select id, timestamp, f_value, sts, BITMASK (sts, 0x0300, 8) from

pt_hf_hist where id=25 and timestamp>#07/01/2009 [Link]# and
timestamp< #07/01/2009 [Link]#;

Bitextract
You can use the bit extract function to extract the value of a specific bit (which, in this
example, means samples where limit checking is off).

select id, timestamp, f_value, sts from pt_hf_hist where id=25 and
timestamp> #07/01/2009 [Link]# and timestamp< #07/01/2009
[Link]# and BITEXTRACT (sts, 12) =1;

Substring
Substring clips out a piece of a string beginning at a start byte and going for count bytes.

select name, id, data_type from cfg_pt_name where

substring(name,0,9) = 'BLK00101C';

Len
String length.

select name, id, len(name) as len from cfg_pt_name where len(name)

> 25;

Concat
Return concatenation of two strings.

Trim
Remove leading and trailing spaces.

OPH070 579
User Defined Function (UDF) tables

LTrim
Left Trim trims all the occurrences of any one of a set of characters of the left side of a string.

RTrim
Right Trim trims all the occurrences of any one of a set of characters of the right side of a
string.

Abs
Absolute value of a floating-point column.

Round
Round of a floating-point column.

Floor
Floor is the largest integer smaller than or equal to value.

Ceiling
Ceil is the smallest integer higher than or equal to value.

Quality
Indicates point condition Good, Fair, Poor, Bad, or Timed Out.

ISNULL
ISNULL tests column (or an expression) for the absence of any data.

NEW_TIME
Convert the time and date from one time zone to another time zone.

GETDATE
Gets the current date and time.

SQL Options Hint Syntax Example

The following example illustrates the data retrieval from PT_HF_HIST with no Initial Value
included.

sql command=SELECT TIMESTAMP, STS, F_VALUE FROM PT_HF_HIST

WHERE ID=870 AND TIMESTAMP>=#01/26/2011 [Link]# AND

TIMESTAMP<=#01/26/2011 [Link]#;

The following example illustrates the data retrieval from PT_HF_HIST with Initial Value
included by using /*+ */ hint.

sql command=SELECT TIMESTAMP, STS, F_VALUE FROM PT_HF_HIST /*+

Opt(InitVal) */

WHERE ID=870 AND TIMESTAMP>=#01/26/2011 [Link]# AND

TIMESTAMP<=#01/26/2011 [Link]#;

580 OPH070
 History Console tool syntax

21.8 History Console tool syntax

Use the correct syntax in order to get the most information from the History Console tool.
The following sections include support, server, retrieval, archive, and lab commands that
might be helpful to you. There is also a section on additional syntax terms.

21.8.1 Support commands

The support commands are as follows:

• set [581].
• echo [581].
• run [582].

set
Use the set command to define a runtime macro.

Syntax:

set

$<Macro>=<Value>;

Table 133. Parameters for the set command

Parameter name Description

Macro Name of the macro (required).
Value Value to replace the macro instance (required).

Example:

set $SERVER=PHPWS-01; //macro definition

connect Server=$SERVER; //instance of $SERVER is replaced by

PHPWS-01 during runtime;

A macro is replaced by its defined value during runtime. A macro can only be used for
command parameter values. A macro is valid until another set command is encountered
with the same macro name. Macros are recursive in that they apply to calls inside a script
file as well. Macros should be included in the runtime selection to take effect for commands
that follow.

echo
Use the echo command to echo specified text to the output stream.

Syntax:

echo

Text=<text>;

OPH070 581
History Console tool syntax

Table 134. Parameters for the echo command

Parameter name Description

Text The text that you want to echo to the output stream (required).

Example:

echo Text=Hello World!;//displays Hello World! to the output

This command is useful for tagging the output stream with text messages. For example,
you might use it to describe the expected result of a subsequent query.

run
Use the run command to load a script file and runs its contents (and optionally dump the
results to another file).

Syntax:

run

Source=<source file>,

[Results=<results file>];

Table 135. Parameters for the run command

Parameter name Description

Source Complete path and filename to the source script file that you want to run
(required).
Results Complete path and filename of the file that you want the results written to
(optional).

Use this command to execute previously saved Console scripts. By default, the results of the
execution are shown in the result pane but you can specify an optional Results file to dump
the results to.

21.8.2 Server commands

The server commands are as follows:

• connect [582].
• config [583].
• disconnect [583].

connect
Use the connect command to open a connection to a Historian server.

Syntax:

connect

Server=<server name>,

582 OPH070
 History Console tool syntax

[User=<user name>],

[Password=<password>];

Table 136. Parameters for the connect command

Parameter name Description

Server The Historian server that you want to connect to (required).
User Login name, which defaults to an empty string (optional).
Password Password, which defaults to an empty string (optional).

After a connection has been established, the connection will remain available for all
commands until a disconnect command is called. Another call to connect while a previous
connection is established will disconnect the previous connection and create a new one
based on the new call.

config
The config command configures the server retrieval mode. Use this command to establish
the retrieval type. Once a mode has been established, the mode type will remain the same
for all commands until a second configuration command is encountered or the connect
object is deleted.

Syntax:

config

Mode = <mode type>;

Table 137. Parameters for the config command

Parameter Description
name
Mode (Optional) The requested mode type.

The default mode is MODE_LATEST. In addition, you can set the parameter to
the following values:

• MODE_ORIGINAL
• MODE_ALL
• MODE_MODIFIED

disconnect
Use the disconnect command to close a connection to a Historian server.

Syntax:

disconnect;

An error is raised if no previous connection is established and a call to disconnect is made.

21.8.3 Retrieval commands

The retrieval commands are as follows:

OPH070 583
History Console tool syntax

• sql [584].
• GetPointConfig [584].
• GetPointAttributes [584].
• SyncReadRaw [585].
• SyncReadProcessed [586].
• SyncReadRealTime [588].
• ReadAlarms [588].
• ReadTextMsgs [589].
• ReadSoe [591].

sql
Use the sql command to execute a SQL command.

Syntax:

sql

command=<Sql statement>;

Table 138. Parameters for the sql command

Parameter name Description

Sql statement The SQL statement that you want to execute (required).

Example:

sql command=Select * From CFG_PT_NAME;

GetPointConfig
Use the GetPointConfig command to retrieve point configuration data from the historian.

Syntax:

GetPointConfig

Points={<list of points>};

Table 139. Parameters for the GetPointConfig command

Parameter name Description

Points The list of point names, separated by commas. The default is all points if you do
not specify specific points (optional).

Use this command to retrieve the configuration information for each point specified in the
points parameter. If no points are specified, configuration data for ALL points in the selected
historian are returned.

GetPointAttributes
Use the GetPointAttributes command to retrieve point attribute data from the historian.

584 OPH070
 History Console tool syntax

Syntax:

GetPointAttributes

Points={<list of points>},

Range={<start time>, <end time>};

Table 140. Parameters for the GetPointAttributes command

Parameter Description
name
Points The list of point names, separated by commas (required).
Range Specifies the start time and end time in mm/dd/yyyy hh:mm:ss format
(optional). If you do not specify these times, end time is set to NULL, which
returns the current attributes for the specified points.

Example:

GetPointAttributes

Points={Point1.Unit1@Net1, Point2.Unit1@Net1},

Range={06/01/2006 [Link], 06/01/2006 [Link]};

This example will retrieve all attribute values for Point1 and Point2 within 10:00 to 11:00 of
June 1, 2006.

Use this command to retrieve point attribute information for each point specified in the
points parameter. If current attributes are desired, set end time to NULL or alternatively, do
not specify the range parameter. If latest attributes relative to a given time are desired, set
start time to NULL and end time to the reference time.

SyncReadRaw
Use the SyncReadRaw command to retrieve raw (unprocessed) data synchronously from
the historian.

Syntax:

SyncReadRaw

Range={<start time>, <end time>},

Points={<list of points>},

[Filters={<list of filters>}],

[Bound=<true/false>],

[Options={<list of options>}],

[Bits={<list of bit positions>}],

[Constants={<list of constants>}];

OPH070 585
History Console tool syntax

Table 141. Parameters for the SyncReadRaw command

Parameter Description
name
Range Specifies the start time and end time in mm/dd/yyyy hh:mm:ss format (required).
Points The list of point names, separated by commas (required).
Filters List of "or" filters per point specified in the Points parameter, separated by commas
(optional). Defaults to RC_RAW_DATA_VAL if not specified. Refer to the list of
filters [595] for details.
Bound Specifies whether bounding values are returned or not (optional). Defaults to false.
Options List of "or" options per point specified in the Points parameter, separated by
commas (optional). Defaults to “no options” if not specified, which in this case
means no summary and no glitch detection. Refer to the list of options [595] for
details.
Bits Comma-separated list of bit positions per point specified in the Points parameter
(optional). Defaults to zero.
Constants Comma-separated list of constants per point specified in the Points parameter
(optional). Defaults to one.

Example:

SyncReadRaw

Range={06/01/2006 [Link], 06/01/2006 [Link]},

Points={Point1.Unit1@Net1, Point2.Unit1@Net1};

This example will retrieve the raw values for Point1 and Point2 within 10:00 to 11:00 of June
1, 2006, with default options.

Use the SyncReadRaw command to synchronously retrieve raw values for a given set of
points within a given time domain. Note that the entries for Filters, Options, Bits, and
Constants must correspond to an entry in the list of Points. After you specify one of the
optional lists, it must contain an entry for every corresponding entry on the list of points (a
one-to-one relationship). To make an equivalent asynchronous call, call the AsyncReadRaw
command.

SyncReadProcessed
Use the SyncReadProcessed command to retrieve processed data synchronously from the
historian.

Syntax:

SyncReadProcessed

Range={<start time>, <end time>},

Interval=<interval>,

Points={<list of points>},

[Aggregates={<list of aggregates>}],

586 OPH070
 History Console tool syntax

[Options={<list of options>}],

[Bits={<list of bit positions>}],

[Constants={<list of constants>}];

Table 142. Parameters for the SyncReadProcessed command

Parameter Description
name
Range Specifies the start time and end time in mm/dd/yyyy hh:mm:ss format (required).
Interval Size or number of the intervals (required). You can specify the interval either as a
time value (hh:mm:[Link]), as a constant (refer to the list of interval constants
[595]), or as a whole number value.

If more than 75% of the interval is BAD QUALITY or TIMED_OUT, the interval is
marked BAD.

If more than 75% of the interval is GOOD QUALITY or FAIR_QUALITY, the interval is
marked GOOD.

Otherwise, interval quality is marked as FAIR.

Points The list of point names, separated by commas (required).
Aggregates List of aggregate operations to be applied for each entry in the Points parameter
(optional). Defaults to OPH_NOP if not specified. Refer to the list of aggregates
[595].
Options List of "or" options per point specified in the Points parameter, separated by commas
(optional). Defaults to “no options” if not specified, which in this case means no
summary and no glitch detection. Refer to the list of options [595].
Bits Comma-separated list of bit positions per point specified in the Points parameter
(optional). Defaults to zero.
Constants Comma-separated list of constants per point specified in the Points parameter
(optional). Defaults to one.

Example:

SyncReadProcessed

Range={06/01/2006 [Link], 06/01/2006 [Link]},

Interval=60,

Points={Point1.Unit1@Net1, Point2.Unit1@Net1},

Aggregates={OPH_TIMEAVERAGE, OPH_INTEGRATION};

This example will retrieve the average and integration for Point1 and Point2, respectively,
per minute within 10:00 to 11:00 of June 1, 2006, with default options.

Use this command to synchronously retrieve processed and periodic values for a given set of
points within a given time domain. Note that the entries for Aggregates, Options, Bits, and
Constants must correspond to an entry in the list of Points.

OPH070 587
History Console tool syntax

SyncReadRealTime
The SyncReadRealTime command retrieves near real-time data synchronously from the
Historian for a given set of points.

Syntax:

SyncReadRealTime

Points={<list points>};

Table 143. Parameters for the SyncReadRealTime command

Parameter name Description

Points (Required) Comma-separated list of point names.

Example:

SyncReadRealTime

Points={Point1.Unit1@Net1, Point2.Unit1@Net1};

This example will retrieve the raw values for Point1 and Point2 in the nearest real time
values.

ReadAlarms
Use the ReadAlarms command to retrieve alarms from the historian.

Syntax:

ReadAlarms

Range={<start time>, <end time>},

[Point=<point name substring>],

[Source=<source id>],

[System=<system id>],

[Drop=<drop id>],

[RecordType=<record type>],

[AlarmType=<alarm type>],

[Options={OPH_exactpointmatch}],

[Code=<alarm code>],

[Description=<description>],

[Priority=<alarm priority>],

[Value=<value>],

[Quality=<quality>],

588 OPH070
 History Console tool syntax

[Units=<units>],

[Limits=<limit>],

[Incr=<incremental limit>],

[Point_type=<point type>],

[Plant_mode=<plant mode>],

[Characteristics=<point characteristics>];

Table 144. Parameters for the ReadAlarms command

Parameter name Description

Range Specifies the start time and end time in mm/dd/yyyy hh:mm:ss format
(required).
Point Point name substring (optional). Accepts wild cards. Defaults to an empty string
or no point filter.
Source Source ID (optional). Defaults to no source ID filter.
System System ID (optional). Defaults to no system ID filter.
Drop Drop ID (optional). Defaults to no drop filter.
RecordType Type of record (optional). Refer to the list of record types [595]. Defaults to no
record type filter.
AlarmType Type of alarm (optional). Refer to the list of alarm types [595]. Defaults to no
alarm type filter.
Options (Optional) Enables the exact point match feature.
Code Alarm code.
Description Alarm description.
Priority Alarm priority.
Value Value string.
Quality Quality.
Units Units string.
Limits Limits string.
Incr Incremental limit.
Point_type Record type of the point.
Plant_mode Value of plant mode.
Characteristics Point characteristics

ReadTextMsgs
Use the ReadTextMsgs command to retrieve text messages from the historian.

Syntax:

ReadTextMsgs

Range={<start time>, <end time>},

OPH070 589
History Console tool syntax

[Point=<point name substring>],

[Source=<source id>],

[System=<system id>],

[Drop=<drop id>],

[MsgType=<message type>],

[User=<Username>],

[Domain=<Domain>],

[EventType={<list of event types>}],

[Options={OPH_exactpointmatch}],

[Reason=<reason>];

Table 145. Parameters for the ReadTextMsgs command

Parameter Description
name
Range Specifies the start time and end time in mm/dd/yyyy hh:mm:ss format
(required).
Point Point name substring (optional). Accepts wild cards. Defaults to an empty string
or no point filter.
Source Source ID (optional). Defaults to no source ID filter.
System System ID (optional). Defaults to no system ID filter.
Drop Drop ID (optional). Defaults to no drop filter.
MsgType The string value that specifies the type of message that you want to
retrieve--'SYSTEM' or 'OPEVENT (optional). Defaults to no message type filter.
User Specifies the user name of the logged-in user.
Domain Specifies the domain name of the user account.
EventType List of event types, separated by commas (optional). Refer to the syntax terms
[595] for details. Defaults to a no events type filter.
Options (Optional) Enables the exact point match feature.
Reason Reason for the message.

Example:

ReadTextMsgs

Range={06/01/2015 [Link], 06/01/2015 [Link]},

MsgType='OPEVENT';

User=user1

Domain=OV360

590 OPH070
 History Console tool syntax

This example retrieves operator event messages between 10:00 and 11:00 hrs of June 1,
2015, for the user user1 of the domain OV360.

Use the MsgType parameter to specify the type of message that you want to retrieve. For
example, to retrieve operator events, set MsgType to 'OPEVENT'. To retrieve system
messages, set MsgType to 'SYSTEM'. If the MsgType parameter is not supplied or is set to a
blank string, all text messages are returned.

ReadSoe
Use the ReadSoe command to retrieve sequence of events from the historian.

Syntax:

ReadSoe

Range={<start time>, <end time>},

[Point=<point name substring>],

[Source=<source id>],

[System=<system id>],

[Drop=<drop id>],

[Options={OPH_exactpointmatch}],

[SOE_flags=<SOE flags>],

[SOE_format=<SOE format>],

[Point_SID=<point SID>],

[DPU_error=<DPU error>],

[Description=<description>],

[State=<state>];

Table 146. Parameters for the ReadSoe command

Parameter name Description

Range Specifies the start time and end time in mm/dd/yyyy hh:mm:ss format
(required).
Point Point name substring (optional). Accepts wild cards. Defaults to an empty string
or no point filter.
Source Source ID (optional). Defaults to no source ID filter.
System System ID (optional). Defaults to no system ID filter.
Drop Drop ID (optional). Defaults to no drop filter.
Options (Optional) Enables the exact point match feature.
SOE_flags SOE flags field.
SOE_format Format string.

OPH070 591
History Console tool syntax

Parameter name Description

Point_SID SID of a point.
DPU_error DPU error string.
Description Description.
State State string.

21.8.4 Archive commands

The archive commands are as follows:

• GetDeviceInfo [592].
• CommandDevice [592].

GetDeviceInfo
Use the GetDeviceInfo command to retrieve the list of available archive devices from the
historian.

Syntax:

GetDeviceInfo;

CommandDevice
Use the CommandDevice command to initiate an archive device command.

Syntax:

CommandDevice

Device=<device id>,

Action=<action>;

Table 147. Parameters for the CommandDevice command

Parameter name Description

Device The ID of the device that you want to send the command to (required).
Action The action that you want to execute (required). Refer to the list of commands
[595].

21.8.5 Lab command

The lab command is as follows:

• SendLabFile [592].

SendLabFile
Use the SendLabFile command to send a lab file to the historian.

Syntax:

SendLabFile

592 OPH070
 History Console tool syntax

File=<source lab file>,

[Results=<results file>];

Table 148. Parameters for the SendLabFile command

Parameter name Description

File The complete path and file name of the lab file that you want to send (required).
Results The complete path and file name of the file that you want the results written to
(optional).

By default, the results of the processing per row are shown, but you can specify an optional
Results file to dump the results to.

21.8.6 File history commands

The file history commands are as follows:

• CreateDir [593].
• PutFile [593].
• GetFile [594].
• GetList [594].

CreateDir
Use the CreateDir command to create a directory in the historian server.

Syntax:

CreateDir

Pathname=<full directory name>,

Timestamp=<timestamp>;

Table 149. Parameters for the CreateDir command

Parameter name Description

Pathname (Required) Complete pathname of directory to be created.
Timestamp (Required) Specifies the time stamp in mm/dd/yyyy hh:mm:[Link]
format.

PutFile
Use the PutFile command to put a file in the historian server.

Syntax:

Putfile

Source=<source filename>,

Destination=<destination filename>,

OPH070 593
History Console tool syntax

Timestamp=<timestamp>;

Table 150. Parameters for the PutFile command

Parameter name Description

Source (Required) Complete pathname of the source file to be sent.
Destination (Required) Complete pathname of the destination file located in the server.
Timestamp (Required) Specifies the time stamp in mm/dd/yyyy hh:mm:[Link]
format.

GetFile
Use the GetFile command to retrieve files from the historian server.

Syntax:

Getfile

Source=<source filename or sequence number>,

Destination=<destination filename>,

Timestamp=<timestamp>;

Table 151. Parameters for the GetFile command

Parameter name Description

Source (Required) Complete pathname or sequence number of the source file to be
retrieved.
Destination (Required) Complete pathname of the destination file.
Timestamp (Required) Specifies the time stamp in mm/dd/yyyy hh:mm:[Link]
format.

GetList
Use the GetList command to retrieve directory information from the historian server.

Syntax:

Getlist

Range= {<start time>, <end time>},

Pathname=<full directory name>,

[Domain =<domain name>],

[Computer =<computer name>],

[Application =<application name>],

[User =<user name>];

594 OPH070
 History Console tool syntax

Table 152. Parameters for the GetList command

Parameter name Description

Range (Required) Specifies the time range (start and end time) in mm/dd/yyyy
hh:mm:[Link] format.
Pathname (Required) Complete pathname of the directory to be created.
Domain (Optional) Domain name.
Computer (Optional) Computer name.
Application (Optional) Application name.
User (Optional) User name.

21.8.7 Syntax terms

SyncReadRaw filters:

• RC_VALUE_LIMITS
• RC_SCAN_REMOVED
• RC_ENTERED_VALUE
• RC_TIMED_OUT
• RC_BAD_QUALITY
• RC_FAIR_QUALITY
• RC_RAW_DATA_VAL
• RC_INITIAL_VAL
• RC_EXTERNAL_CALIBRATION
• RC_CHECK_REMOVED
• RC_SENSOR_ALARM
• RC_IN_ALARM
• RC_POOR_QUALITY
• RC_GOOD_QUALITY
• RC_CUTOUT_ALM
• RC_RETURN_VAL

SyncReadProcessed aggregates:

• OPH_NOP
• OPH_NOPBIT
• OPH_TIMEAVERAGE
• OPH_MAXIMUM
• OPH_TOGGLE
• OPH_TIMESET
• OPH_TOGGLERESET
• OPH_MINIMUM

OPH070 595
History Console tool syntax

• OPH_MAXIMUMACTUALTIME
• OPH_MINIMUMACTUALTIME
• OPH_INTEGRATION
• OPH_TOGGLESET
• OPH_TIMERESET
• OPH_TOTAL
• OPH_AVERAGE
• OPH_COUNT
• OPH_START
• OPH_END
• OPH_DELTA
• OPH_RANGE
• OPH_PERCENTBAD
• OPH_PERCENTGOOD
• OPH_DURATIONBAD
• OPH_DURATIONGOOD
• OPH_STDEV
• OPH_VARIANCE
• OPH_REGDEV
• OPH_REGSLOPE
• OPH_REGCONST
• OPH_ANNOTATION

SyncReadRaw / SyncReadProcessed options:

• OPH_GENERATESUMMARY
• OPH_DETECTGLITCH

ReadAlarms alarm types:

• ALMTYPE_SENSOR
• ALMTYPE_HIGH
• ALMTYPE_HI_WRS
• ALMTYPE_LOW
• ALMTYPE_LOW_BET
• ALMTYPE_LOW_WRS_UDA
• ALMTYPE_SP_ALM
• ALMTYPE_SID_ALM
• ALMTYPE_ST_CHG
• ALMTYPE_HI_BET

596 OPH070
 History Console tool syntax

• ALMTYPE_HI_UDA
• ALMTYPE_HI_WRS_UDA
• ALMTYPE_HI_BET_UDA
• ALMTYPE_LOW_WRS
• ALMTYPE_LOW_UDA
• ALMTYPE_LOW_BET_UDA
• ALMTYPE_TIME_OUT
• ALMTYPE_ALARM
• ALMTYPE_INCR_ALARM

ReadTxtMsgs event types:

• OPEVENT
• SYSTEM

CommandDevice actions:

• OPH_DEVICEENABLE
• OPH_DEVICEDISABLE
• OPH_DEVICELOCK
• OPH_DEVICEUNLOCK
• OPH_DEVICEEJECT

OPH070 597
 Direct reports

22 Sample Reports
Topics covered in this section:
• Direct reports [599]
• ExpressCalc reports [622]

22.1 Direct reports

There are four different types of direct report templates provided with the historian:

• Alarm Messages [599].

• SOE Messages [605].
• Text Messages [610].
• Raw Values [618].

22.1.1 Alarm messages

The historian provides the following alarm message templates:

• Alarm [Link]
• Alarm [Link]
• Alarm [Link]
• Alarm [Link]
• Alarm Messages [Link]
• Alarm Messages Review [Link]

The following figures depict the examples of each template.

OPH070 599
Direct reports

Figure 450. Alarm Messages template

600 OPH070
 Direct reports

Figure 451. Alarm Messages-Brief template

OPH070 601
Direct reports

Figure 452. Alarm Messages-Landscape template

602 OPH070
 Direct reports

Figure 453. Alarm Messages-Brief-Landscape template

OPH070 603
Direct reports

Figure 454. Alarm Messages Review template

604 OPH070
 Direct reports

Figure 455. Alarm Messages Review Ext template

22.1.2 SOE messages

The historian provides the following SOE message templates:

• SOE [Link]
• SOE [Link]
• SOE [Link]
• SOE [Link]
• SOE Messages Review [Link]

The following figures depict the examples of each template.

OPH070 605
Direct reports

Figure 456. SOE Messages template

606 OPH070
 Direct reports

Figure 457. SOE Messages-Brief template

OPH070 607
Direct reports

Figure 458. SOE Messages-Landscape template

608 OPH070
 Direct reports

Figure 459. SOE Messages-Brief-Landscape template

OPH070 609
Direct reports

Figure 460. SOE Messages Review Ext template

22.1.3 Text messages

The historian provides the following text message templates:

• Text [Link]
• Text [Link]
• Text [Link]
• Text [Link]

610 OPH070
 Direct reports

• Text Messages [Link]

• Text Messages [Link]
• Report Manager [Link]
• Operator Event [Link]

The following figures depict the examples of each template.

Figure 461. Text Messages template

OPH070 611
Direct reports

Figure 462. Text Messages-Brief template

612 OPH070
 Direct reports

Figure 463. Text Messages-Landscape template

OPH070 613
Direct reports

Figure 464. Text Messages-Brief-Landscape template

614 OPH070
 Direct reports

Figure 465. Text Messages Reason template

OPH070 615
Direct reports

Figure 466. Text Messages Username template

616 OPH070
 Direct reports

Figure 467. Report Manager Audit template

OPH070 617
Direct reports

Figure 468. Operator Event Messages-Landscape template

22.1.4 Raw values

The historian provides the following raw value templates:

• Raw value report

• Raw value attributes report
• Raw Value Report [Link]
• Raw Value Report - Attributes [Link]

The following figures depict the examples of each template.

618 OPH070
 Direct reports

Figure 469. Raw Value Report template

OPH070 619
Direct reports

Figure 470. Raw Value Report - Attributes template

620 OPH070
 Direct reports

Figure 471. Raw Value Report ExNot template

OPH070 621
ExpressCalc reports

Figure 472. Raw Value Report - Attributes ExNot template

22.2 ExpressCalc reports

ExpressCalc reports provide more flexibility than direct reports, which have a pre-specified
layout and content (except for the points that you want to report). These reports allow you
to specify the sample interval time and total time. For each point in the report, you can
apply specific processing types, such as:

• Actual

622 OPH070
 ExpressCalc reports

• Raw
• Actual Bit
• Time Average
• Maximum Value
• Minimum Value
• Time of Maximum
• Time of Minimum
• Integration
• Toggle
• Toggle Set
• Toggle Reset
• Time Set
• Time Reset
• Average
• Total
• Count
• Start Value
• End Value
• Delta
• Range
• Percent Bad
• Percent Good
• Duration Bad
• Duration Good
• Standard Deviation
• Variance
• Average Rate of Change

The historian provides the following ExpressCalc report templates (or formats). The
templates have been designed to be easily edited so that you can rearrange the report into
smaller, customized reports.

Table 153. ExpressCalc report templates

ExpressCalc report Description

format
ExpressCalc 12 point This report formats up to 12 processed point values and their
[Link] summaries in landscape orientation. Values and summaries are
displayed in standard notation.
ExpressCalc 12 point This format is similar to ExpressCalc 12 point Landscape, except that it
[Link] is larger in size and allows the description and units fields to grow, if
necessary.

OPH070 623
ExpressCalc reports

ExpressCalc report Description

format
ExpressCalc 12 point This report formats up to 12 processed point values and their
Landscape [Link] summaries in landscape orientation. Values and summaries are
displayed in standard, exponential, or technical notation according to
the FM field content of the point.
ExpressCalc 8 [Link] This report formats up to 8 processed point values and their
summaries in portrait orientation. Values and summaries are displayed
in standard notation.
ExpressCalc 8 point This report formats up to 8 processed point values and their
[Link] summaries in portrait orientation. Values and summaries are displayed
in standard, exponential, or technical notation according to the FM
field content of the point.
ExpressCalc 8 point This format is similar to Express Calc 8 point ExNot, except that it has
[Link] landscape orientation and allows the description and units fields to
grow, if necessary.
ExpressCalc 80 point - This report formats up to 80 processed point values in a layout suitable
[Link] for export to an Excel spreadsheet. The data is displayed according to
the UTC time zone.
ExpressCalc 80 point (local This report formats up to 80 processed point values in a layout suitable
time) -[Link] for export to an Excel spreadsheet. The data is displayed according to
the local time zone.
ExpressCalc Basic 12 point These reports format processed values in a basic layout for up to 8, 12,
[Link] and 80 points, respectively. The 8-point version is portrait orientation,
while the 12- and 80-point versions are landscape.
ExpressCalc Basic 8
[Link]

ExpressCalc Basic 80 point

[Link]
ExpressCalc CT 48 [Link] These reports format processed point values in a cross-tab layout.

ExpressCalc CT 80 [Link]
ExpressCalc CT Multi-Point This cross-tab report supports more than 80 points and whose values
As [Link] are formatted as numbers.
Express Calc CT Multi-Point This cross-tab report supports more than 80 points and whose values
As [Link] are formatted as text fields.
ExpressCalc Sub Report This report format is an example of a report that contains sub-reports.
[Link] Sub-reports must be used when the number of points exceeds 80.
Each sub-report can contain up to and including 80 points.

Note
The ExpressCalc basic report templates contain minimal formatting, for use in export to
Excel format.

The following figures depict the examples of each template.

624 OPH070
 ExpressCalc reports

Figure 473. ExpressCalc 8 point template

OPH070 625
ExpressCalc reports

Figure 474. ExpressCalc Basic 8 point template

626 OPH070
 ExpressCalc reports

Figure 475. ExpressCalc 12 point Landscape template

OPH070 627
ExpressCalc reports

Figure 476. ExpressCalc Basic 12 point Landscape template

628 OPH070
 ExpressCalc reports

Figure 477. ExpressCalc 12 point Landscape ExNot template

OPH070 629
ExpressCalc reports

Figure 478. ExpressCalc 8 point ExNot template

630 OPH070
 ExpressCalc reports

Figure 479. ExpressCalc 8 point Landscape template

OPH070 631
ExpressCalc reports

Figure 480. ExpressCalc 80 point - Excel template

632 OPH070
 ExpressCalc reports

Figure 481. ExpressCalc 80 point (local time) - Excel template

OPH070 633
ExpressCalc reports

Figure 482. ExpressCalc Basic 80 point Sample template

Figure 483. ExpressCalc 12 point 11x17 template

634 OPH070
 ExpressCalc reports

Figure 484. ExpressCalc CT 48 Point template

Figure 485. ExpressCalc CT 80 Point template

OPH070 635
ExpressCalc reports

Figure 486. ExpressCalc CT Multi-Point As Num template

636 OPH070
 ExpressCalc reports

Figure 487. ExpressCalc CT Multi-Point As Text template

OPH070 637
ExpressCalc reports

Figure 488. ExpressCalc Sub Report Sample template

638 OPH070
 OPH070
Version 4
September 2020

Twitter: [Link]/ovationusers
LinkedIn: [Link]/groups?gid=4179755
Ovation Users’ Group: [Link]

Emerson
200 Beta Drive
Pittsburgh, PA15238