3BUF001094-600 B en

System 800xA
Information Management
Data Access and Reports System Version 6.0
System 800xA
Information Management
Data Access and Reports
System Version 6.0
Document Number: 3BUF001094-600

Document Revision: B
Release: November 2017
NOTICE
This document contains information about one or more ABB products and may include a description
of or a reference to one or more standards that may be generally relevant to the ABB products. The
presence of any such description of a standard or reference to a standard is not a representation that
all of the ABB products referenced in this document support all of the features of the described or
referenced standard. In order to determine the specific features supported by a particular ABB product,
the reader should consult the product specifications for the particular ABB product.
ABB may have one or more patents or pending patent applications protecting the intellectual property
in the ABB products described in this document.
The information in this document is subject to change without notice and should not be construed as
a commitment by ABB. ABB assumes no responsibility for any errors that may appear in this document.
Products described or referenced in this document are designed to be connected, and to communicate
information and data via a secure network. It is the sole responsibility of the system/product owner to
provide and continuously ensure a secure connection between the product and the system network
and/or any other networks that may be connected.
The system/product owners must establish and maintain appropriate measures, including, but not
limited to, the installation of firewalls, application of authentication measures, encryption of data, in-
stallation of antivirus programs, and so on, to protect the system, its products and networks, against
security breaches, unauthorized access, interference, intrusion, leakage, and/or theft of data or infor-
mation.
ABB verifies the function of released products and updates. However system/product owners are ulti-
mately responsible to ensure that any system update (including but not limited to code changes,
configuration file changes, third-party software updates or patches, hardware change out, and so on)
is compatible with the security measures implemented. The system/product owners must verify that
the system and associated products function as expected in the environment they are deployed.
In no event shall ABB be liable for direct, indirect, special, incidental or consequential damages of
any nature or kind arising from the use of this document, nor shall ABB be liable for incidental or
consequential damages arising from use of any software or hardware described in this document.
This document and parts thereof must not be reproduced or copied without written permission from
ABB, and the contents thereof must not be imparted to a third party nor used for any unauthorized
purpose.
The software or hardware described in this document is furnished under a license and may be used,
copied, or disclosed only in accordance with the terms of such license. This product meets the require-
ments specified in EMC Directive 2014/30/EU and in Low Voltage Directive 2014/35/EU.
TRADEMARKS
All rights to copyrights, registered trademarks, and trademarks reside with their respective owners.
Copyright © 2004-2017 by ABB.
All rights reserved.
Table of Contents
Table of Contents
1 About This User Manual

1.1 User Manual Conventions ........................................................................................ 21
1.2 Warning, Caution, Information, and Tip Icons ......................................................... 21
1.3 Terminology ............................................................................................................. 22
1.4 Released User Manuals and Release Notes .............................................................. 23
2 Data Access Tools

2.1 Desktop Applications ............................................................................................... 25
2.2 Excel Data Access - DataDirect ............................................................................... 26
2.3 DeskTop Trends ........................................................................................................ 27
2.4 Display Services ....................................................................................................... 28
2.5 Reports ..................................................................................................................... 29
2.6 Selecting Which Tool to Use .................................................................................... 29
2.6.1 Real-time Data ........................................................................................... 31
2.6.2 Historical Process Data .............................................................................. 32
2.6.3 Property Log Naming Conventions ........................................................... 32
2.6.4 Criteria for Selection for Seamless Retrieval ............................................ 34
2.6.5 Interpolation ............................................................................................... 36
2.6.6 Daylight Savings ........................................................................................ 37
2.6.7 Writing to History Logs ............................................................................. 42
2.7 Alarm/Event Messages ............................................................................................. 42
2.8 Production Data ........................................................................................................ 43
2.9 SQL Access .............................................................................................................. 44
2.10 Data Providers .......................................................................................................... 44
2.10.1 Guidelines for Referencing Data Providers ............................................... 45
2.11 Open Data Access .................................................................................................... 46
3BUF001094-600 B 5
Table of Contents
2.12 Set-up for SQL*Plus ................................................................................................ 47

2.12.1 ORACLE_SID ........................................................................................... 48
2.12.2 tnsname ...................................................................................................... 48
3 General Information for DataDirect

3.1 User Access to DataDirect Add-in Tools ................................................................. 49
3.2 User Interface - DataDirect Add-in Tools ................................................................ 50
3.2.1 Accessibility to Add-in Tools for Different Windows Users ..................... 50
3.2.2 Showing/Hiding DataDirect Add-in Tools ................................................ 50
3.3 Add-in Tool Capabilities .......................................................................................... 50
3.4 Application Set-up .................................................................................................... 51
3.4.1 Enabling Macros ........................................................................................ 52
3.4.2 Manually Adding the DataDirect Add-in .................................................. 53
3.4.3 Updating Function References in Worksheets ........................................... 55
3.4.4 Fixing DataDirect After Upgrading Microsoft Excel ................................ 57
3.4.5 Changing the Language Selection for Microsoft Office ............................ 57
3.5 Starting DataDirect ................................................................................................... 57
3.6 Quick Tips for Using DataDirect ............................................................................. 58
3.6.1 Logging In ................................................................................................. 58
3.6.2 Customizing Your Application .................................................................. 58
3.6.3 Getting Help .............................................................................................. 58
3.6.4 About DataDirect ....................................................................................... 58
3.6.5 Finding the Right Tool ............................................................................... 58
3.7 Using DataDirect Dialogs ........................................................................................ 59
3.7.1 Selecting the Starting Cell ......................................................................... 60
3.7.2 Opening the Dialog .................................................................................... 60
3.7.3 Changing the Start Cell .............................................................................. 61
3.7.4 Inserting or Overwriting Rows .................................................................. 61
3.7.5 Specifying One-time Data Access or Reusable Formulas ......................... 61
3.7.6 Date and Time ............................................................................................ 62
3.7.7 Formatting ................................................................................................. 67
3.7.8 Monitoring/Changing the Server Connection ............................................ 67
3.7.9 Apply, OK, & Cancel Buttons ................................................................... 68
6 3BUF001094-600 B
Table of Contents
3.8 Using DataDirect Functions ..................................................................................... 68

3.8.1 Inserting Functions in the Spreadsheet ...................................................... 69
3.8.2 Storing, Updating, and Scheduling Reports .............................................. 74
4 DataDirect System 800xA

4.1 Introduction .............................................................................................................. 77
4.2 Using the System 800xA Process Values Dialog ..................................................... 77
4.2.1 Reading Process Values ............................................................................. 79
4.2.2 Writing Process Values .............................................................................. 84
4.3 Using the System 800xA History Values Dialog ..................................................... 90
4.3.1 Reading History Data ................................................................................ 92
4.3.2 Retrieval Type ............................................................................................ 92
4.3.3 Log Calculation Algorithm ........................................................................ 93
4.3.4 Number of Values ...................................................................................... 95
4.3.5 Time Span for Retrieval ............................................................................. 95
4.3.6 Selecting Logs ........................................................................................... 95
4.3.7 Changing the Output Options .................................................................... 98
4.3.8 Writing History Data ................................................................................ 98
4.4 Using the System 800xA Alarm/Events Dialog ....................................................... 104
4.4.1 Using the Alarms and Events Dialog ........................................................ 107
4.5 System 800xA Configuring Options ........................................................................ 109
4.5.1 Data Format ............................................................................................... 110
4.5.2 View .......................................................................................................... 114
4.5.3 Setup .......................................................................................................... 115
4.6 Functions for Reading/Writing Process Values ........................................................ 117
4.6.1 ABBGetOPCDASimple ............................................................................ 118
4.6.2 ABBGetOPCDA ........................................................................................ 118
4.6.3 ABBWriteOPCDA .................................................................................... 119
4.7 Functions for Reading/Writing History Values ........................................................ 120
4.7.1 ABBGetOPCHDA ..................................................................................... 121
4.7.2 ABBGetOPCHDAAggregates ................................................................... 124
4.7.3 ABBWriteNOPCHDA ............................................................................... 124
4.7.4 ABBWriteOPCHDA .................................................................................. 126
3BUF001094-600 B 7
Table of Contents
4.7.5 ABBGetOPCHDAAttributes ..................................................................... 128

4.7.6 ABBGetOPCHDAAttributeValue ............................................................. 129
4.8 Functions for Reading Messages .............................................................................. 132
4.8.1 ABBAERetrieval ....................................................................................... 132
5 DataDirect Inform IT
5.1 User Access to DataDirect Inform IT Add-in Tools ................................................ 135
5.2 Populating Pick Lists for Data Retrieval/Entry Dialogs .......................................... 135
5.3 Data Access Methods ............................................................................................... 135
5.4 Licensing .................................................................................................................. 138
5.5 Login ........................................................................................................................ 139
5.5.1 Perpetual Login .......................................................................................... 139
5.5.2 Login As Needed for Ad-hoc Data Requests ............................................ 139
5.5.3 Using the Login Dialog ............................................................................. 140
5.5.4 User ............................................................................................................ 140
5.5.5 Password .................................................................................................... 141
5.5.6 Host ............................................................................................................ 141
5.5.7 Save Settings .............................................................................................. 141
5.6 Reading and Writing Process Values For Inform IT ................................................ 141
5.7 Using the Inform IT Process Values Dialog ............................................................. 142
5.7.1 Reading Process Values ............................................................................. 144
5.7.2 Selecting Objects to Query ........................................................................ 145
5.7.3 Selecting OPC Tags ................................................................................... 145
5.7.4 Selecting ABB OCS Tags ......................................................................... 146
5.7.5 Writing Process Values .............................................................................. 149
5.8 Reading/Writing History Data .................................................................................. 164
5.9 Using the Inform IT History Values Dialog ............................................................. 165
5.9.1 Retrieving History Data ............................................................................. 167
5.9.2 Selecting the Data Provider ....................................................................... 168
5.9.3 Retrieval Type ............................................................................................ 169
5.9.4 Selecting History Objects .......................................................................... 170
5.9.5 Log Calculation Algorithm ........................................................................ 172
5.9.6 Number of Values ...................................................................................... 176
8 3BUF001094-600 B
Table of Contents
5.9.7 Time Span for Retrieval ............................................................................. 176

5.9.8 Changing the Output Options .................................................................... 176
5.9.9 Adding/Modifying Entries for a Lab Data Log ......................................... 177
5.10 Retrieving Message Logs ......................................................................................... 189
5.10.1 Selecting Which Tab to Use ...................................................................... 190
5.10.2 Using the Vendor/Categories List .............................................................. 191
5.10.3 OPC/Audit Trail ......................................................................................... 191
5.10.4 Alarm and Event ........................................................................................ 198
5.10.5 Alarm/Event Format Output ...................................................................... 201
5.11 Retrieving Production Data ...................................................................................... 202
5.11.1 Using the Batch Data Dialog ..................................................................... 202
5.11.2 Using the Production Data Log Dialog ..................................................... 216
5.12 Retrieving Data by SQL Query ................................................................................ 231
5.12.1 Saving and Re-using SQL Queries ............................................................ 233
5.13 Retrieving Values for TCL Unit Arrays ................................................................... 235
5.14 Using the Information Management Browser .......................................................... 237
5.15 Configuring Options ................................................................................................. 238
5.15.1 Data Format ............................................................................................... 239
5.15.2 View .......................................................................................................... 243
5.15.3 PDL/Batch ................................................................................................. 244
5.15.4 Setup .......................................................................................................... 249
5.15.5 File Setup ................................................................................................... 254
5.15.6 Messages .................................................................................................... 257
5.16 Configuring Pick Lists for Advant OCS Objects ..................................................... 258
5.17 Populating Pick Lists ................................................................................................ 259
5.17.1 Guidelines for Creating New Text Files .................................................... 261
5.18 Functions for Reading/Writing Inform IT Process Values ....................................... 264
5.18.1 ABBGetObj ............................................................................................... 265
5.18.2 ABBUpdateObj ......................................................................................... 266
5.19 Functions for Reading/Writing Inform IT History Values ....................................... 267
5.19.1 ABBGetHistory ......................................................................................... 268
5.19.2 ABBEditLog .............................................................................................. 271
5.19.3 ABBEditNLogs ......................................................................................... 272
3BUF001094-600 B 9
Table of Contents
5.19.4 ABBGetAttributes ..................................................................................... 274

5.19.5 ABBGetAttributeValue .............................................................................. 275
5.20 Miscellaneous Functions .......................................................................................... 276
5.20.1 ABBSql ...................................................................................................... 276
5.20.2 ABBArray .................................................................................................. 278
5.20.3 ABBConnect .............................................................................................. 279
5.20.4 ABBDisconnect ......................................................................................... 279
5.20.5 Using VBA Macros ................................................................................... 280
5.20.6 Adding Charts to DataDirect Reports ........................................................ 280
6 Using Desktop Trends

6.1 Product Overview ..................................................................................................... 285
6.2 Connection and Setup ............................................................................................... 286
6.2.1 Connecting to the Data Server ................................................................... 286
6.2.2 Setting Up Pick Lists ................................................................................. 287
6.2.3 Guidelines for Creating New Text Files .................................................... 289
6.2.4 Applying New Default Files ...................................................................... 290
6.2.5 Setting Up the Limits File ......................................................................... 290
6.2.6 Applying New Default Files ...................................................................... 291
6.3 Changing Regional Settings Causes User Errors ..................................................... 291
6.4 Settings to open the Desktop Trend Tools ................................................................ 292
6.5 Trend Display .......................................................................................................... 293
6.5.1 Launching the Trend Display .................................................................... 293
6.5.2 Description ................................................................................................. 294
6.5.3 Setting Up the Trend Display .................................................................... 298
6.5.4 Setup Dialog .............................................................................................. 298
6.5.5 Data ............................................................................................................ 299
6.5.6 Visibility .................................................................................................... 302
6.5.7 Column Widths .......................................................................................... 303
6.5.8 Miscellaneous Settings .............................................................................. 304
6.5.9 Print Colors ................................................................................................ 306
6.5.10 Status ........................................................................................................ 308
6.5.11 Versions ..................................................................................................... 309
10 3BUF001094-600 B
Table of Contents
6.5.12 Property Page ............................................................................................. 310

6.5.13 Trace Properties ......................................................................................... 310
6.5.14 Scope Properties ........................................................................................ 315
6.5.15 Using the Trend Display ............................................................................ 319
6.5.16 Adding and Removing Traces ................................................................... 320
6.5.17 Browsing an OPC Server ........................................................................... 320
6.5.18 Reading Trend Data ................................................................................... 322
6.5.19 Using the Scope/Zoom Tool Bar ............................................................... 326
6.5.20 Using the Table (Info) Area ....................................................................... 328
6.5.21 Showing/Hiding and Docking/Undocking Trend Display Components .... 331
6.5.22 Viewing Trend Statistics ............................................................................ 331
6.5.23 Copying and Pasting Trend Data to Other Applications ........................... 332
6.5.24 Copying and Pasting a Bitmap Image of the Trend Display ..................... 333
6.5.25 Selecting the Time Scale for a Trace ......................................................... 334
6.5.26 Applying Time Offsets .............................................................................. 334
6.5.27 Saving the Current Display ........................................................................ 335
6.5.28 Opening a Saved Display .......................................................................... 336
6.5.29 Printing the Current Display ...................................................................... 336
6.5.30 Toggling between Print and Display Colors .............................................. 336
6.5.31 Launching Other Desktop Trend Tools from the Trend Display ............... 336
6.5.32 Ticker ......................................................................................................... 336
6.5.33 Launching the Ticker ................................................................................. 337
6.5.34 Configuring Ticker Files ............................................................................ 337
6.5.35 Configuring Tags ....................................................................................... 339
6.5.36 Adding Tags ............................................................................................... 341
6.5.37 Browsing for OPC Objects ........................................................................ 341
6.5.38 Adding an Advant OCS Tag ...................................................................... 347
6.5.39 Adding Tags ............................................................................................... 352
6.5.40 Copying an Existing Tag ........................................................................... 353
6.5.41 Removing Tags from the File .................................................................... 353
6.5.42 Reverting to the Saved Configuration for a Tag ........................................ 354
6.5.43 Configuring the Appearance of the Ticker File ......................................... 354
6.5.44 Changing Ticker Defaults .......................................................................... 359
3BUF001094-600 B 11
Table of Contents
6.5.45 Configuring the Data Delimiter ................................................................. 360

6.5.46 Configuring Error Condition Indicators .................................................... 362
6.5.47 File Specifications ..................................................................................... 363
6.5.48 Aspect Object Browser Defaults ............................................................... 365
6.5.49 Operating the Ticker .................................................................................. 366
6.5.50 Dragging and Dropping Tags Between Desktop Trend Controls .............. 369
6.5.51 Refreshing Tag Limits ............................................................................... 372
6.5.52 Displaying Version Information for the Ticker Controls ........................... 373
6.5.53 Launching the Trend Display from the Ticker .......................................... 373
6.5.54 Refreshing the Ticker in Internet Explorer ................................................ 374
6.6 Tag Explorer ............................................................................................................. 375
6.6.1 Launching the Tag Explorer ...................................................................... 375
6.6.2 Configuring the Tag Explorer .................................................................... 376
6.6.3 Creating Tag Groups .................................................................................. 376
6.6.4 Specifying the Contents Tag Groups ......................................................... 377
6.6.5 Clearing the Current Tag Explorer Configuration ..................................... 378
6.6.6 Configuring the Tag Explorer Appearance and Operational Characteris-
tics .............................................................................................................. 379
6.6.7 File Specifications ..................................................................................... 382
6.6.8 Aspect Object Browser Defaults ............................................................... 383
6.6.9 Aspect Object Browser .............................................................................. 383
6.6.10 Using the Tag Explorer .............................................................................. 383
6.6.11 All Tags ...................................................................................................... 384
6.6.12 Dragging and Dropping Tags in Tag Explorer .......................................... 384
6.6.13 Exporting Files .......................................................................................... 385
6.6.14 Displaying Version Information for the Tag Explorer Controls ................ 386
6.6.15 Launching the Trend Display from the Tag Explorer ................................ 386
6.7 PDL Browser ............................................................................................................ 386
6.7.1 Opening the PDL Browser ........................................................................ 387
6.7.2 Setting Up the PDL Browser Interface ...................................................... 387
6.7.3 Using the PDL Browser ............................................................................. 394
6.7.4 Search Criteria ........................................................................................... 395
6.7.5 Search Results ............................................................................................ 397
12 3BUF001094-600 B
Table of Contents
6.8 Batch Batch Display ................................................................................................. 403

6.8.1 Opening the Batch to Batch Display ......................................................... 403
6.8.2 Using the Batch to Batch Display .............................................................. 404
6.8.3 Setting Up the Batch to Batch Display ...................................................... 404
6.9 Event Browser .......................................................................................................... 404
6.9.1 Opening the Event Browser ....................................................................... 405
6.9.2 Setting Up the Event Browser Interface .................................................... 406
6.9.3 Retrieving Events ...................................................................................... 407
6.9.4 Viewing Trend Data Related to Events ...................................................... 408
6.10 SQL Browser ............................................................................................................ 408
6.10.1 Opening the SQL Browser ........................................................................ 409
6.10.2 Setting Up the SQL Browser Interface ...................................................... 410
6.10.3 Using the SQL Browser ............................................................................. 411
6.10.4 Specifying and Executing Ad-hoc SQL Queries ....................................... 411
6.10.5 Managing Queries ...................................................................................... 412
6.10.6 Dragging Tag Names and Time Stamps to the Desktop Trend Display ..... 414
6.11 OPC Browser ............................................................................................................ 416
7 Creating Reports
7.1 Report Building Applications ................................................................................... 417
7.2 Implementing Reports .............................................................................................. 418
7.2.1 Example Reports ........................................................................................ 419
7.3 Setting Up the Report Action and Scheduling Definition ........................................ 428
7.3.1 Creating Objects and Aspects in the Scheduling Structure ....................... 428
7.3.2 Defining the Report Action ....................................................................... 429
7.3.3 Selecting the Report Action ....................................................................... 430
7.3.4 Selecting the Report Template ................................................................... 430
7.3.5 Output Options .......................................................................................... 431
7.3.6 Report Parameters ...................................................................................... 433
7.3.7 Export File ................................................................................................. 445
7.3.8 Printer ........................................................................................................ 451
7.3.9 Email .......................................................................................................... 452
7.3.10 Save to History .......................................................................................... 455
3BUF001094-600 B 13
Table of Contents
7.3.11 Saving HTML or XML reports to History ................................................ 457

7.3.12 Execute File ............................................................................................... 457
7.3.13 Defining the Schedule ............................................................................... 458
7.3.14 Define Schedule Type - Periodic Scheduling ............................................ 460
7.4 Before Running a Report .......................................................................................... 460
7.5 Viewing Reports Over the Web ................................................................................ 461
7.5.1 Creating A Virtual Web Directory ............................................................. 461
7.5.2 Creating Report Output And Viewing It Over The Web ........................... 461
7.6 Attaching a Report Template to a File Viewer Aspect ............................................. 462
7.7 Report Preferences Aspect ....................................................................................... 465
7.8 Report Printing Aspect ............................................................................................. 465
7.9 View Report Logs Aspect ......................................................................................... 466
7.9.1 Viewing Reports Stored in a Report Log ................................................... 468
7.10 Troubleshooting Reports .......................................................................................... 468
7.11 Creating a Report with Crystal Reports - Example .................................................. 469
7.11.1 Connecting the Report to the ODA Table for Historical Data ................... 470
7.11.2 Selecting Fields from the Batch_Trends View .......................................... 472
7.11.3 Adding Parameters .................................................................................... 473
7.11.4 Configuring the Query to Get Historical Process Data ............................. 474
7.11.5 Integrating the Report into the 800xA System .......................................... 475
7.11.6 Using DataDirect ....................................................................................... 476
7.11.7 Using Excel Without DataDirect Add-ins ................................................. 479
8 Scheduling
8.1 Using Scheduling ..................................................................................................... 481
8.2 Adding a Job Description Object ............................................................................. 482
8.2.1 Scheduling Definition View ...................................................................... 483
8.2.2 Defining the Schedule ............................................................................... 484
8.2.3 Cyclic Scheduling ...................................................................................... 485
8.2.4 Periodic Scheduling ................................................................................... 486
8.2.5 Weekly Scheduling .................................................................................... 486
8.2.6 Monthly Scheduling .................................................................................. 488
8.2.7 Creating a Scheduling List ........................................................................ 490
14 3BUF001094-600 B
Table of Contents
8.2.8 Expression-based Scheduling .................................................................... 490

8.3 Specifying Start Conditions ..................................................................................... 492
8.3.1 Configuring a Start Condition ................................................................... 493
8.3.2 The Expression Start Condition ................................................................. 493
8.3.3 The Yes/No Start Condition ....................................................................... 494
8.4 Arguments ................................................................................................................ 495
8.5 Viewing a Job Log .................................................................................................... 497
8.6 Actions ..................................................................................................................... 498
8.6.1 Action Aspect View ................................................................................... 499
8.6.2 Understanding the Predefined Batch Reports Action Aspect in Sched-
uler ............................................................................................................. 501
8.7 Job Hierarchies ......................................................................................................... 503
8.8 The Running Job ...................................................................................................... 503
8.8.1 Monitoring a Running Job ......................................................................... 504
8.8.2 Viewing Alarm and Event List .................................................................. 505
8.8.3 Purging Running Job Objects .................................................................... 506
8.8.4 Using the Test Action to Test a Job ........................................................... 507
8.9 Security ..................................................................................................................... 508
8.9.1 Securing Windows Files on Shared Network Drives ................................ 511
9 Tag Management
9.1 User Tag Management (UTM) ................................................................................. 513
9.1.1 Starting UTM ............................................................................................. 513
9.1.2 Displaying User Tags, Hierarchical View ................................................. 515
9.1.3 Displaying User Tags, Search View .......................................................... 516
9.1.4 Displaying User Tags, HDA Browser ....................................................... 518
9.1.5 Managing User Groups .............................................................................. 518
9.1.6 Managing User Tags Using Tag Workspace .............................................. 520
9.2 Using UTM from Desktop Tools .............................................................................. 522
9.3 User Tag Management Status ................................................................................... 523
9.4 Information Management Browser .......................................................................... 524
9.4.1 Navigation Methods .................................................................................. 526
9.4.2 Filtering ..................................................................................................... 527
3BUF001094-600 B 15
Table of Contents
9.4.3 Copying Items ............................................................................................ 527

9.4.4 Considerations for History Access ............................................................ 527
10 Reading and Managing Archive Data

10.1 User Interface ........................................................................................................... 532
10.2 Archive Operations .................................................................................................. 532
10.3 User Interface for Managing Archive Data .............................................................. 533
10.3.1 Archive Device Aspect .............................................................................. 533
10.3.2 Archive Volume Aspect ............................................................................. 537
10.3.3 Archive Group Aspect ............................................................................... 542
10.3.4 View Logs Aspect ...................................................................................... 544
10.3.5 View Report Logs Aspect .......................................................................... 546
10.3.6 View Production Data Logs Aspect ........................................................... 548
10.3.7 Maintaining Archive Media ....................................................................... 550
10.3.8 Removing/Replacing Platters .................................................................... 551
10.3.9 Activating/Deactivating an Archive Device .............................................. 551
10.3.10 Remounting a Volume ............................................................................... 552
10.3.11 Initializing an Archive Volume .................................................................. 553
10.3.12 Copying Volumes ...................................................................................... 556
10.3.13 Overriding Volume Backup ....................................................................... 558
10.4 Archiving Logs Manually ........................................................................................ 558
10.4.1 Manual Archiving for Archive Groups ..................................................... 559
10.4.2 Manual Archiving Property and Message Logs on an Ad-hoc Basis ........ 560
10.4.3 Manually Archiving PDLs ......................................................................... 567
10.5 Verifying Archive Data ............................................................................................ 570
10.5.1 Verifying Signatures for a Volume ............................................................ 571
10.5.2 Showing Signature Information for a Volume ........................................... 572
10.6 Making Archived Data Available to Client Applications ......................................... 572
10.6.1 Publishing an Archive Volume .................................................................. 573
10.6.2 Accessing Published Logs ........................................................................ 576
10.6.3 Unpublishing a Volume ............................................................................. 576
10.6.4 Restoring Logs from Archive Media to Restored Database ...................... 577
10.6.5 Accessing Restored Logs .......................................................................... 583
16 3BUF001094-600 B
Table of Contents
10.6.6 Deleting Restored Logs ............................................................................. 583

10.7 Miscellaneous Archive Operations .......................................................................... 584
10.7.1 List Group Items ........................................................................................ 585
10.7.2 Resetting the Last Archive Time for an Archive Group ............................ 585
10.7.3 Showing Volume Information ................................................................... 586
10.7.4 Showing Platform Information for a Log .................................................. 586
10.8 Importing Archive Data ........................................................................................... 588
10.8.1 Overview ................................................................................................... 589
10.8.2 Step-by-Step Instructions .......................................................................... 594
10.8.3 Modifying a Workbook ............................................................................. 614
11 Reading Message Logs

11.1 Message Log Tables ................................................................................................. 615
11.2 Example Queries ...................................................................................................... 620
11.2.1 Query for MSGLOG Table Name for PDL Message Logs ....................... 621
11.2.2 Example Query for Data ............................................................................ 621
11.3 System 800xA ATTVAL Oracle Function for IM Message Log ............................. 622
Appendix A Using Open Data Access

A.1 ODA for Real-time Data .......................................................................................... 625
A.1.1 Guidelines for Using Custom Database Tables ......................................... 626
A.1.2 Sample Queries for Custom Database Tables ............................................ 627
A.1.3 Guidelines for Using the Generic_DA Table ............................................. 628
A.1.4 Sample Queries for Generic_DA ............................................................... 630
A.2 ODA for Historical Data Access .............................................................................. 632
A.2.1 SQL Query Structure ................................................................................. 633
A.2.2 Query Guidelines ....................................................................................... 635
A.2.3 Specifying the Log in a Query ................................................................... 635
A.2.4 Example Queries ........................................................................................ 637
A.2.5 Basic Query for Numeric Data .................................................................. 637
A.2.6 Query for Numeric Data from a Secondary Log ....................................... 637
A.2.7 Query for a Specific Time Range .............................................................. 638
A.2.8 Query for Interpolative Data ...................................................................... 638
3BUF001094-600 B 17
Table of Contents
A.2.9 UPDATE and INSERT Functions .............................................................. 639

A.2.10 IMHDA Access ........................................................................................ 640
A.3 ODA for Profile Data Access ................................................................................... 642
A.3.1 Profile Historian Example ......................................................................... 644
A.4 Connecting Client Applications to an ODA Database ............................................. 645
A.4.1 Using Crystal Reports ................................................................................ 645
A.5 Accessing ODA Programmatically using ADO ....................................................... 655
Appendix B PDL for Batch Management

B.1 PDL Extractor .......................................................................................................... 657
B.2 Installing the PDL Extractor ..................................................................................... 657
B.3 Launching the PDL Extractor ................................................................................... 658
B.4 Using PDL Extractor ................................................................................................ 659
B.4.1 Viewing the PFC ........................................................................................ 662
B.5 Setting up PDL Extractor ......................................................................................... 662
B.6 Configuration Requirements for Batch Management ............................................. 665
B.6.1 Batch Management Data Flow .................................................................. 666
B.6.2 Information Management Archive Sessions for Batch Management ........ 666
B.6.3 Establishing History Associations in Batch Management ......................... 667
B.6.4 Setting Up Storage of Batch Procedures in PDL ....................................... 670
B.7 Accessing PDL Data (Using PDL Task ID) ............................................................. 672
B.7.1 Querying for a Specific Task Type in the Task Hierarchy ......................... 673
B.7.2 How to Get taskid if it is Unknown ........................................................... 675
B.7.3 How To Query for the Entire Campaign Hierarchy ................................... 675
B.7.4 How to Exclude Parts of the Hierarchy ..................................................... 675
B.7.5 Joining Task Views .................................................................................... 676
B.7.6 Retrieve Variable Data for a Specific Batch Occurrence ........................... 677
B.7.7 Accessing Archived Data .......................................................................... 679
B.7.8 PDL Tables and Views .............................................................................. 679
Appendix C Using the IM OPC HDA Server

C.1 Accessing History Servers in Other Aspect Systems ............................................... 717
C.2 Enhanced Browsing Features for History Logs ....................................................... 717
18 3BUF001094-600 B
Table of Contents
C.3 Syntax for Log Name References ............................................................................ 717

C.4 Direct Access to Trend Logs .................................................................................... 718
Appendix D Revision History

D.1 Introduction .............................................................................................................. 719
D.2 Revision History ....................................................................................................... 719
D.3 Updates in Revision Index A ................................................................................... 720
D.4 Updates in Revision Index B .................................................................................... 720
INDEX
3BUF001094-600 B 19
20 3BUF001094-600 B
1 About This User Manual 1.1 User Manual Conventions
1 About This User Manual
Any security measures described in this User Manual, for example, for user access,
password security, network security, firewalls, virus protection, etc., represent
possible steps that a user of an 800xA System may want to consider based on a
risk assessment for a particular application and installation. This risk assessment,
as well as the proper implementation, configuration, installation, operation, admin-
istration, and maintenance of all relevant security related equipment, software,
and procedures, are the responsibility of the user of the 800xA System.
This User Manual provides instructions for using Information Management DataDirect
and Desktop Trends for data access in the 800xA System. It provides guidelines for
using DataDirect or third party applications to build, schedule, and manage reports
for 800xA System applications. The User Manual is intended for anyone that uses
the Display and Client Services and/or third-party applications to access data in the
800xA System. This User Manual is not the sole source of instruction for this func-
tionality. It is recommended that you attend the applicable training courses offered
by ABB.
1.1 User Manual Conventions

Microsoft Windows conventions are normally used for the standard presentation of
material when entering text, key sequences, prompts, messages, menu items, screen
elements, etc.
1.2 Warning, Caution, Information, and Tip Icons

This User Manual includes Warning, Caution, and Information where appropriate to
point out safety related or other important information. It also includes Tip to point
out useful hints to the reader. The corresponding symbols should be interpreted as
follows:
Electrical warning icon indicates the presence of a hazard that could result in
electrical shock.
3BUF001094-600 B 21
1 About This User Manual 1.3 Terminology
Warning icon indicates the presence of a hazard that could result in personal injury.
Caution icon indicates important information or warning related to the concept

discussed in the text. It might indicate the presence of a hazard that could result
in corruption of software or damage to equipment/property.
Information icon alerts the reader to pertinent facts and conditions.
Tip icon indicates advice on, for example, how to design your project or how to
use a certain function
Although Warning hazards are related to personal injury, and Caution hazards are
associated with equipment or property damage, it should be understood that operation
of damaged equipment could, under certain operational conditions, result in degraded
process performance leading to personal injury or death. Therefore, fully comply with
all Warning and Caution notices.
1.3 Terminology
The listing includes terms and definitions that apply to the 800xA System where the
usage is different from commonly accepted industry standard definitions and defini-
tions given in standard dictionaries such as Webster’s Dictionary of Computer Terms.
Terms that uniquely apply to this User Manual are listed in the following table.
Term/Acronym Description
AE Alarm and Event
Afw Aspect Framework
Afw OPC server An OPC server that unifies a client's
access to all data sources, by splitting a
request into separate requests for
separate data sources, and merging the
responses. Afw OPC servers are modeled
after the Afw Service concept. The
System 800xA platform provides OPC
servers for OPC/DA, HDA, and AE.
22 3BUF001094-600 B
1 About This User Manual 1.4 Released User Manuals and Release Notes
Term/Acronym Description
Afw Service A software component that provides a
certain set of functions in the system,
typically for use by various client
applications. An Afw Service is designed
to run around the clock. It can normally
be portioned into several service groups,
each group handling part of the scope of
the service (e.g. part of the object space).
For redundancy each group can contain
several service providers running on
different servers.
Afw Service handler A COM object that a client application
includes and runs as an in-process object
to access an Afw Service.
1.4 Released User Manuals and Release Notes

A complete list of all User Manuals and Release Notes applicable to System 800xA
is provided in System 800xA Released User Documents (3BUA000263*).
System 800xA Released User Documents (3BUA000263*) is updated each time a
document is updated or a new document is released. It is in pdf format and is provided
in the following ways:
• Included on the documentation media provided with the system and published
to myABB/My Control System portal when released as part of a major or minor
release, Service Pack or System Revision.
• Published to myABB/My Control System portal when a User Manual or Release
Note is updated in between any of the release cycles listed in the first bullet.
A product bulletin is published each time System 800xA Released User Documents
(3BUA000263*) is updated and published to myABB/My Control System portal.
3BUF001094-600 B 23
24 3BUF001094-600 B
2 Data Access Tools 2.1 Desktop Applications
2 Data Access Tools
This section provides a brief introduction to the data access tools provided by the
Information Management Desktop Applications.
2.1 Desktop Applications

The Information Management History and Real-time Database services provide a
repository of real-time and historical process data, alarm and event messages, and
production information. The History Server function supports collection, online and
offline storage, consolidation, and retrieval for process and lab data, alarms/events,
and reports.
Real-time Database Services support access to real-time process data from AC 800M
controllers, and other ABB and third-party control systems. Real-time database services
also support the configuration of softpoints to hold application-generated data not
directly connected to any process. Softpoints are accessible by all other functions in
the system. Calculation Services is used to apply calculations to both process and
softpoint objects.
Read and write access to historical and real-time data is supported by a set of desktop
applications installed with the Information Management Display and Client Services.
These applications are used to generate ad-hoc queries through interactive dialogs,
create reports, and in some cases, modify existing values or enter new values through
write transactions. The desktop applications provided with the Display and Client
Services are:
• Excel Data Access - DataDirect.
• DeskTop Trends.
• Display Services.
The Display and Client Services also support access by third-party applications such
as Crystal Reports, Microsoft Excel, and APIs developed in C++ or Visual Basic.
Third party applications use Open Data Access which must be configured as described
in System 800xA Information Management Configuration (3BUF001092*).
3BUF001094-600 B 25
2 Data Access Tools 2.2 Excel Data Access - DataDirect
All desktop applications access data via data providers. Some configuration and set-
up may be required, depending on the application. A brief overview of the data
providers is provided in Data Providers on page 44. Detailed instructions for config-
uring and managing data providers are provided in System 800xA Information Man-
agement Configuration (3BUF001092*).
Desktop Applications may be may be installed on nodes that are not loaded with
800xA. Use the following steps to load the software.
1. Mount the System 800xA media on the PC.
2. Navigate to <media>\Applications\Information Management\
3. Right-click the file Install_DesktopToolsForNon-800xA.bat and select Run
as administrator.
2.2 Excel Data Access - DataDirect

DataDirect is an add-in for Microsoft Excel and can run on Operating Systems sup-
ported by 800xA and Windows 7x64 workstations. DataDirect is installed with the
Information Management server software, and may be installed on remote computer
clients using the Information Management Desktop tools software bundle. DataDirect
may also be installed as a base system component on other 800xA System nodes
(Aspect Servers, Connectivity Servers, other Application servers, and Workplace
Clients).
DataDirect provides re-executable functions to integrate into the spreadsheet. Functions
are used to specify parameters to meet data access requirements. For example, when
retrieving historical data the log name, time range and so on are specified. These
functions are re-executed whenever the spreadsheet is opened or re-calculated. This
is used to create Excel reports for 800xA System applications.
Rather than enter functions manually, use Interactive dialogs for data access. Some
dialogs support ad-hoc (on-demand, one-time) queries only. Other dialogs specify
whether to generate an ad-hoc query, or enter a re-executable function which is
equivalent to the functions described above. There is one dialog for each of the differ-
ent storage types in the system.
DataDirect may run directly on 800xA System client and server nodes, or on remote
computer clients (independent of 800xA base system software). In some cases, the
function or dialog used depends on where DataDirect is being used (on an 800xA
System node or remote computer client).
26 3BUF001094-600 B
2 Data Access Tools 2.3 DeskTop Trends
There are three classes of functions/dialogs in DataDirect.

• The Industrial IT dialogs (and functions) facilitate data access in the 800xA
System.
• The Industrial IT Process Values and History Values dialogs have a browsing
tool that is similar to the Plant Explorer.
• The Alarm/event dialog is used to retrieve alarm and event messages by selecting
an alarm or event list which is configured via Operator Workplace.
The Industrial IT tools require DataDirect to be installed on a node with 800xA base
system software. These tools cannot be used on a remote computer client.
The Inform IT dialogs (and corresponding functions) do run on remote computer
clients (without 800xA base system software). Some of these dialogs and functions
also support access to data that does not reside in the aspect system, for example,
when accessing data from MOD 300 or Master process, history, or message log objects
on an Enterprise Historian platform.
The Batch Management Batch Data dialog supports access to production data via
pre-configured view. This dialog may run either on an 800xA System node or remote
computer client.
2.3 DeskTop Trends

Desktop Trends may run directly on server nodes, or on remote computer clients.
Desktop Trends is used to view real time, trend, production, and event data via ActiveX
controls. There are seven controls:
By default, Windows blocks ActiveX controls unless it is explicitly allowed access
to such controls. This includes Desktop Trends and the Profile Client display.
Change the default security in Internet Explorer (Tools > Internet Options..., Ad-
vanced tab, Security section) to include:
Allow active content from CDs to run on My Computer and
Allow active content to run in files on My Computer.
• The Trend Display shows graphical traces for up to eight tags. The Trend Display
supports common trend display tools including, zoom, ruler, filtering, and time
offset.
• The Ticker shows a repeating stream of real time data for selected tags, similar
to a stock market ticker.
3BUF001094-600 B 27
2 Data Access Tools 2.4 Display Services
• The Tag Explorer is used to structure data source objects in a format similar to
the browsing and access methods used in Microsoft Windows Explorer.
• The PDL Browser is used to access production data from Production Data Logs
for 800xA Batch Management applications, Batch 300, TCL Batches, and Profile
Historian.
• The Batch to Batch Display combines the functionality of the Trend Display
with the PDL Browser. It is used to easily navigate the PDL structure to find and
display historical trends for different batches.
• The Event Browser is used to retrieve messages from OPC message logs config-
ured with Information Management - History Server function.
• The SQL Browser is used to run ad-hoc SQL queries. Use it to save a query
once it is run, and then reopen the query for viewing at some time in the future.
Also, use it to delete saved queries.
2.4 Display Services

Display Services is used to create custom graphics and view them from the desktop.
These displays can be process mimic displays, status overview or other information
management displays. A wide range of display elements such as bar charts, pie charts,
edit boxes and gauges as well as traditional process elements like pumps, motors and
vessels are available for creating these displays. How to create custom graphic displays
is described in System 800xA Information Management Configuration for Display
Services (3BUF001093*).
Displays can be viewed in the container provided with Display Services. This container
supports navigation through the different displays that have been built. As an alterna-
tive, displays may be viewed in a web browser, or from Selecting Which Tool to Use.
A display can include data from OPC servers and ADO (ODBC) data sources. Displays
can read data from and write data to the system.
28 3BUF001094-600 B
2 Data Access Tools 2.5 Reports
2.5 Reports
Reporting functions in the 800xA System are supported by the Display and Client
Services, Application Scheduler with the Report Action plug-in, and the History
Server function.
The Display and Client Services provide tools and data access services that is used
to integrate data into a chosen report building application. The Application Scheduler
is used to set up schedules (periodic, conditional, etc...) for executing the reports. The
Report Action plug-in lets specifies report options such as output destination (Windows
file, Completed Report object, printer, e-mail, history, and so on). The History Server
function provides the means to store finished reports in history, archive the reports
to an offline storage media, and retrieve the reports either from online or offline
storage.
The report building applications supported are: DataDirect, Crystal Reports, Microsoft
Excel, and Generic Executable. Crystal reports and Microsoft Excel (without
DataDirect add-ins) require the Open Data Access option to access process and his-
torical data.
The report builder package must be installed on the node with the scheduling server.
Use remote report builder clients to build the report files; however, the files must be
stored locally, and the report builder must also reside locally to support scheduling
and execution via the Scheduler.
2.6 Selecting Which Tool to Use

Table 2.1 identifies the specific tool and corresponding instructions in this user
manual that most closely fit any data access application. For further guidelines and
special considerations, and their key topics covered in these sections:
• Real-time Data on page 31.
– Retrieving Last History Value on page 31.
• Historical Process Data on page 32.
– Property Log Naming Conventions on page 32.
– Daylight Savings on page 37.
– Writing to History Logs on page 42.
• Alarm/Event Messages on page 42.
3BUF001094-600 B 29
2 Data Access Tools 2.6 Selecting Which Tool to Use
• Production Data on page 43.

• SQL Access on page 44.
• Data Providers on page 44.
• Open Data Access on page 46.
• Set-up for SQL*Plus on page 47.
Table 2.1: Tools for Data Access
Application Tool
Reading and Writing DataDirect:
Process Values Dialogs for Apply, OK, & Cancel Buttons on page 68.
Using the System 800xA Process Values Dialog on page 77 and Using
the Inform IT Process Values Dialog on page 142.
Desktop Trends: Ticker on page 336.
Reading and Writing DataDirect:
History Values Dialogs for Apply, OK, & Cancel Buttons on page 68.
Using the System 800xA History Values Dialog on page 90 and Using
the Inform IT History Values Dialog on page 165
Desktop Trends: Trend Display on page 293.
Reading Messages DataDirect:
Dialogs for Retrieving Message Logs on page 189.
Functions for Reading Messages on page 132
Desktop Trends: Event Browser on page 404.
Querying Oracle tables via DataDirect:
SQL queries Dialogs for Retrieving Values for TCL Unit Arrays on page 235.
ABBSql on page 276.
Desktop Trends: SQL Browser on page 408
30 3BUF001094-600 B
Table 2.1: Tools for Data Access

(Continued)
Application Tool
Production Data (PDL) DataDirect: System 800xA PDL Dialog - Retrieving Production Data
on page 202.
Desktop Trends:
PDL Browser on page 386
Batch Batch Display on page 403
For further guidelines, refer to Appendix B.
Report Building with The third party packages require Open Data Access (ODA). For
DataDirect Crystal guidelines on how to access data via ODA, refer to Appendix A.
Reports, Microsoft Excel, For Report Building refer to Section 7 Creating Reports.
Third-party APIs For scheduling refer to Section 8 Scheduling.
2.6.1 Real-time Data

Real-time data includes process data from AC 800M controllers, and other ABB and
third-party control systems. Real-time also includes user-configured softpoints which
hold application-generated data not directly connected to any process. To find the
tool which best fits any real-time data access application, refer to Table 2.1 at the end
of this section.
Retrieving Last History Value

As an alternative to retrieving real-time process data, data can e retrieved from a
process object’s corresponding History log. This reduces the load on the control net-
work, and improves network performance. This functionality is supported for:
• The numeric display element in Display Services.
• The Process Values dialog and related function calls in DataDirect.
• The Ticker in Desktop Trends.
Set up this functionality on a global basis for all desktop applications by setting the
user preference: AID-DATARETRIEVAL-DCSDATA. This is described in System
800xA Information Management Configuration (3BUF001092*). For Desktop Trends
and Display Services, when this user preference is set up for real-time data retrieval,
the last history value can still be retrieved on an ad-hoc basis.
3BUF001094-600 B 31
2.6.2 Historical Process Data

Historical process data is stored on two levels. Standard 800xA System functionality
supports data collection, storage, and viewing for operator trend data with trend logs.
The optional Information Management History Server function supports extended
data storage and archiving via history logs.
Access to history data is supported by the 800xA OPC HDA server. This server sup-
ports seamless access to both trend and history logs. This server also supports access
to log attributes. This is the default and recommended OPC HDA server. The IM
OPC HDA server installed with the History Server option provides an alternative to
the 800xA OPC HDA server for access to historical process data. The IM OPC HDA
server supports access to history servers in other systems. Also, it provides alternative
methods for browsing history logs. For further details regarding the IM OPC HDA
server, refer to Appendix C.
If the system has numeric property logs which use the Oracle storage type, then it is
required to have an ADO data provider configured via the ADSS utility. This procedure
is described in System 800xA Information Management Configuration
(3BUF001092*).
To find the tool which best fits the historical data access application, refer to Table
2.1. Other topics related to historical data access which are covered in this section
are:
• Property Log Naming Conventions on page 32.
• Criteria for Selection for Seamless Retrieval on page 34.
• Interpolation on page 36.
• Daylight Savings on page 37.
• Writing to History Logs on page 42.
2.6.3 Property Log Naming Conventions

This section describes the syntax for referencing a property (numeric) log. The syntax
varies slightly depending on which OPC HDA server being used. There is also a
special syntax when accessing logs on earlier Enterprise Historian platforms.
32 3BUF001094-600 B
When using a tool other than the Industrial IT tools in DataDirect, it is recommend-
ed that the Information Management Browser be used to select logs for data access
applications. This is a sure way to always use the correct syntax for the connected
data provider. Instructions for using the Information Management Browser are
provided in Information Management Browser on page 524.
• Syntax for 800xA OPC HDA Server on page 33.
• Syntax for History Server (IM) OPC HDA Server on page 33.
• Syntax for Enterprise Historian - DCSLOG (LOGMAN) on page 33.
Syntax for 800xA OPC HDA Server

When accessing property logs via the 800xA OPC HDA server, the logs are referenced
by objectname:property,logname, Figure 2.1.
TC100:MEASURE,Log1
[OPTIONAL FULL OR PARTIAL PATH/]
Object Name
Property Name
Log Name
(as defined when adding the log to a log template)
Figure 2.1: Log Reference for 800xA OPC HDA Server
Syntax for History Server (IM) OPC HDA Server

When accessing history logs through the History Server OPC HDA server, any Process
Portal A OPC/HDA valid syntax for an IM log is accepted by the IM OPC/HDA
server.
[optional full or partial
path/]<objectName>:<propertyName>,<logName>
Syntax for Enterprise Historian - DCSLOG (LOGMAN)

When configuring a property log, the access name defaults to the name of the data
source assigned to the log. For instance, TC100,MEASURE or TC100,VALUE.
Change the access name as required. By virtue of the hierarchical structure of History
3BUF001094-600 B 33
logs, there can be more than one log using the same data source. To distinguish mul-
tiple logs with the same data source, History automatically assigns a unique default
log name to each log. The log name is derived from the access name, and has a prefix
and suffix appended as shown in Figure 2.2. Change the default log name when the
log is configured.
$HSTC100,MEASURE-1-o
Prefix - $HS indicates History Log

Access Name
Integer to uniquely identify different logs in a
composite log (for example 0 = PHL, 1 = primary,2 = first secondary,
3 = next secondary, and so on). The number is assigned
according to the order the log was added to the
composite log.
o = original, p = PHL, r = restored (from archive media)
Figure 2.2: Log Name
Use the access name to reference a log when the data source is known but the log
name is not known. When using the access name, History uses the seamless retrieval
criteria (described later in this section) to select the most appropriate log in the data
source’s log hierarchy. Generally, unless other criteria are specified, seamless retrieval
selects the log that has INSTANTANEOUS or AVERAGE as the calculation algo-
rithm, and has a log period that provides the best coverage of the requested time period.
Use the log name when the seamless retrieval criteria to select the log is unreliable
and the log name of the log that stores the required data is known. For instance, use
the log name to get the log that uses the STANDARD DEVIATION algorithm, and
it is known that this data is stored in $HSTC100,MEASURE-3-o (or
$HSTC100,VALUE-3-o).
2.6.4 Criteria for Selection for Seamless Retrieval

Seamless retrieval uses the following criteria to search the History database and select
a log when a request for history data is issued:
Seamless retrieval is only applicable for history logs. This does not apply to trend
logs.
34 3BUF001094-600 B
1. Sort logs by percentage of the time period of the request that the log covers, and
choose the set of logs that are closest in coverage.
For instance, for a request for 24 hours, logs may be sorted as follows in descend-
ing order of preference: 24-hour logs and 168_hour logs, 8-hour logs, and 1-hour
logs. Since the 24-hour logs and 168-hour logs cover 100% of the requested time
period, they are chosen.
2. Search the set chosen in step 1, and find all logs that use the specified calculation
algorithm. Logs that do not use the specified algorithm are dropped from consid-
eration.
If the algorithm is WILDCARD (no algorithm specified), then the algorithms
have the following order of preference:
a. AVERAGE or INSTANTANEOUS
These algorithms have equal preference. The first one found in the search
is selected, and logs with any other calculation are dropped from considera-
tion.
b. MAX
c. MIN
d. SUM
e. SUM OF SQUARES
f. STANDARD DEVIATION
g. NUM_OF_VALUES
At this point the set of logs still under consideration have the same log period
(closest to percent of coverage of requested time period), and calculation
algorithm.
3. This set is now sorted, depending on the specified retrieval type. One log is se-
lected according to retrieval type as follows:
a. If the retrieval type is RAW, one log is selected in the following order of
preference:
1) Pick the log whose storage interval is equal to the time between points in
request.
2) Pick the log whose storage interval is greater than and closest to the time
between points (so request can be completed in one response).
3BUF001094-600 B 35
3) Pick the log whose storage interval is less than and closest to the time
between points (more points exist than buffer can hold, MORE_DATA status
is returned).
b. If the retrieval type is INTERPOLATE, one log is selected in the following
order of preference:
between points (so interpolation is more accurate).
request.
between points.
c. If retrieval type is DISPLAY, one log is selected according to retrieval type
as follows:
request. The request is changed to RAW unless the log uses Deadband
compaction, in which case the request is changed to INTERPOLATE/AVE.
between points. The request is changed to INTERPOLATE/AVE.
between points. The request is changed to INTERPOLATE/AVE.
In addition to the seamless algorithm applied for retrieval requests, the following
criteria have been added to better handle selection of a log for a request by access
name, when logs are in a dual configuration:
• Uptime of node where log exists.
• local is chosen over remote (local should always be faster than remote).
• sequence number of log. (with all other conditions equal, the lowest sequence
numbered log is used. Sequence number is the ‘-1-o’ or ‘-2-o’ attached to the
generated log name.
2.6.5 Interpolation
History usually samples the property values at set intervals. When data is requested
at the interval it was stored, the software returns raw data. If data is requested at a
36 3BUF001094-600 B
different interval, the software returns an interpolated value. Figure 2.3 shows an
example where data is saved every 10 seconds.
y = 29
2
oy=?
y = 22
1
60 t1 = 70 76 t 2 = 80 90
Figure 2.3: Numerical Data Retrieval by Interpolation
If the value is requested at second 70, the stored value 22 is returned. If the value is
requested at second 80, the stored value 29 is returned. If the value is requested at
second 76 (in between intervals where the value is stored), the stored values for sec-
onds 70 and 80 are used to perform a mathematical interpolation. In this case, the
value 26.2 is returned.
2.6.6 Daylight Savings

History applies Universal Time Coordinate (UTC) time stamps to all property log
entries. UTC time is not affected by time zones and local time changes. History client
applications such as DataDirect and Display Services map the UTC time stamps to
local time for presentation according to the time zone configuration on the nodes
where the client applications run.
For time zones that use Daylight Saving Time, client applications alter this mapping
to compensate for the hour gained during the transition from Daylight Saving to
Standard Time, and the hour lost during the transition from Standard to Daylight
Saving Time. The client applications use different mapping methods. It is very impor-
tant to understand how the client application handles this mapping to effectively access
property log data stored during these transition periods.
3BUF001094-600 B 37
Transition from Daylight Saving to Standard Time

When the change is made from Daylight Saving to Standard Time (local time set
back one hour), local time cycles twice through the hour from 1:00 AM and 2:00
AM:
• once on Daylight Saving Time.
• and then again on Standard Time after local time is set back to 1:00 AM.
History continues to operate as usual, storing UTC time stamped entries for both cy-
cles. The client applications apply two sets of local time stamps for this hour from
1:00 AM to 2:00 AM. One set is for Daylight Saving Time - the first cycle. The second
is for Standard Time - representing the hour which has been gained.
Since different client applications use different mapping techniques, it may be difficult
accessing data for the exact time range needed. It may also be difficult recognizing
what time range is being used. Use the following guidelines to get the correct data
and interpret the time stamps based on the client application being used.
Retrieving Standard Time Stamps Only

When retrieving Standard Time stamps for the period between 1:00 AM and 2:00
AM, the start time for the data request time range must be later than 1:00 AM - for
example: 1:01 AM to 2:30 AM. In this case, only one set of time stamps will be pre-
sented for the time from 1:00 AM to 1:59 AM, and these time stamps will correspond
to Standard Time.
Retrieving Both Daylight Saving and Standard Time Stamps

To retrieve both Daylight Saving and Standard Time stamps for the period between
1:00 AM and 2:00 AM, the start time for the data request time range must be 1:00
AM or earlier - for example: 12:58 AM (00:58) to 2:30 AM. In this case, all time
stamps from 1:00 AM to 1:59 AM will be duplicated. The first time stamp is for
Daylight Saving Time. The second time stamp is for Standard Time (second cycle
through the hour after the time has been set back). Prior to 1:00 AM, all time stamps
are for Daylight Saving Time. From 2:00 AM forward, all time stamps are for Standard
Time. This is illustrated in Figure 2.4 for DataDirect and Figure 2.5 for Desktop
Trends.
38 3BUF001094-600 B
Daylight
Saving
Time
Standard
Time
Standard Time
only from this
Point On
Figure 2.4: DataDirect Query Result with Duplicated Time Stamps between 1:00 AM & 1:59
AM
3BUF001094-600 B 39
Ruler Points to Entry for 1:30 Daylight Saving Time
Ruler Points to Entry

for 1:30 Standard Time
Figure 2.5: Example, Reading Entry for Time on Desktop Trend
40 3BUF001094-600 B
Transition from Standard to Daylight Saving Time

When the change is made from Standard Time to Daylight Saving Time (clocks set
ahead one hour), the hour from 2:00AM to 3:00AM is essentially skipped. This is
the hour which is lost to compensate for the one gained in October. Therefore, there
will be no History data with time stamps between 2:00AM and 3:00AM. All time
stamps up to 2:00AM are for Standard Time. All time stamps from 3:00AM forward
are for Daylight Saving Time. Examples for DataDirect and Desktop Trends are
provided in Figure 2.6 and Figure 2.7.
Standard
Time
Daylight
Saving
Time
Daylight Saving
Time from this
Point On
Figure 2.6: Example, Transition to Daylight Saving Time using DataDirect
Figure 2.7: Example, Transition to Daylight Saving Time using Desktop Trends
3BUF001094-600 B 41
2 Data Access Tools 2.7 Alarm/Event Messages
2.6.7 Writing to History Logs

Both DataDirect and Display Services support writing to numeric history (property)
logs. Existing values can be replaced (modify) or new values inserted. There are
certain limitations and considerations depending on the log’s configured collection
mode (synchronous or asynchronous) and collection type
(API or OPC HDA or USER_SUPPLIED).
Inserting New Values

The ability to insert new values is limited to lab data (asynchronous) logs and syn-
chronous logs whose collection type is configured as USER_SUPPLIED.
Storage for lab data logs is Oracle-based and the maximum number of values per log
is 50,000. When the log reaches its capacity, the oldest values are deleted. The data
may be entered out of order (older entries may be entered after more current entries.
USER_SUPPLIED logs are file-based and provide a greater storage capacity than
lab data logs. For synchronous logs, the data must be entered in time forward order.
This means that once an entry is stored at a particular time, the log will not allow
entries with a date before that time. Also, entries are received and stored at the con-
figured storage rate. For example, for a user supplied, synchronous log, adding an
entry every second for a log with a 1-minute storage interval, only one entry over a
one-minute period will be stored. If only one entry is received every day for a one
minute log, history will insert at least one "NO DATA" entry between each value
received.
Modifying Existing Values

This functionality is supported for all numeric log types including asynchronous (lab
data), and all synchronous collection types: API, OPC HDA, and USER_SUPPLIED.
When modifying an existing value, the time stamp must be specified with millisecond
precision.
2.7 Alarm/Event Messages

The messages can be organized into filtered lists for viewing. This functionality is
described in System 800xA Operations Operator Workplace Configuration
(3BSE030322*). The Audit Trail function records operator changes including log
42 3BUF001094-600 B
2 Data Access Tools 2.8 Production Data
configuration changes, add/delete and activate/deactivate operations, and updates to

lab data logs.
If the system has the History Server function installed, the messages stored by 800xA
System message server may be forwarded to the OPC message log (IMMSGLOG)
for extended online storage. This message log can store up to twelve million messages.
In addition, with the History Server function messages can be saved on an archive
media for permanent offline storage. The IMMSGLOG message log must be config-
ured as described in the Alarm/Event Message Logging section in System 800xA In-
formation Management Configuration (3BUF001092*).
DataDirect provides tools for querying alarm/event messages by filtered lists which
are configured via Operator Workplace. This requires DataDirect to be installed on
a node with 800xA base system software. For all other desktop tools, or to access
messages that extend beyond the storage limit of the 800xA System software message
server, query the OPC message log. Refer to Table 2.1 for details.
For further guidelines on reading alarm/event messages from the message log, refer
to Section 11 Reading Message Logs.
2.8 Production Data

Production data for Batch Management applications may be stored in production data
logs (PDLs). PDL is an option for the History Server function.
Alarm and event messages for batch applications are collected and stored by the
800xA System message services and the OPC message log as described in
Alarm/Event Messages on page 42.
The Batch Data dialog is used to retrieve production data for a selected batch. The
data is organized in eleven pre-configured views which are described under Functions
in respective sections of DataDirect System 800xA and DataDirect Inform IT. These
views simplify data retrieval from batch applications for viewing on the Excel
spreadsheet, and for integrating into reports built either with DataDirect, or third
party report building applications such as Crystal Reports. The output of this dialog
can be one of the following:
• DataDirect Formula - enters a DataDirect formula that may be re-executed (for
reports).
• SQL Query - creates an SQL query that may be copied and pasted into an SQL-
based application such as Crystal Reports. It also places the query in an ABBSQL
function call on the spreadsheet.
3BUF001094-600 B 43
2 Data Access Tools 2.9 SQL Access
• Data Only - executes a one-time (ad-hoc) request for data.

Other options for retrieving production data are the DataDirect Inform IT PDL dialog,
and the Desktop Trends PDL Browser. To find the data access tool which best fits
the PDL application, refer to Table 2.1.
2.9 SQL Access

SQL queries may be used for access to Oracle data. The DataDirect and Desktop
Trends packages provide interactive dialogs for generating ad-hoc SQL queries.
DataDirect provides an equivalent function for reporting applications. SQL queries
can also be submitted via third-party report building applications such as Crystal
Reports. These applications require Open Data Access.
To find the data access tool which best fits the SQL query application, refer to Table
2.1.
2.10 Data Providers

Data providers are installed with the Display Services software. These data providers
support data access for desktop tools provided by the Display and Client Services,
including Desktop Trends, some DataDirect tools, Display Services, and PDL
Browser for Batch Management. A description of data provider applications, func-
tionality and configuration via the ADSS Configuration tool is included in System
800xA Information Management Configuration (3BUF001092*).
Different data providers are used to access different types of data. For example, the
AIPOPC data provider is for real-time process and softpoint data from the 800xA
OPC DA server, while the AIPHDA data provider is used to access historical process
data via the 800xA OPC HDA server. Data providers can be activated and deactivated
so as not to exceed the limit allowed by the license.
Client applications that use data providers connect via a specified service provider
which resides on a data server. The client application must log on to the data server
to establish the connection with the service provider. The client applications may
connect to service providers on an 800xA System server, or earlier Information
Manager and Enterprise Historian platforms, including the HP-UX-based Enterprise
Historian version 2.2.
The client can use all data providers connected to the service provider. This includes
data providers installed on the local data server, as well as data providers installed
44 3BUF001094-600 B
2 Data Access Tools 2.10 Data Providers
on remote servers. Generally, the data providers operate transparently so queries for
data can be made without regard for the data providers. In some cases a specific data
provider must be referenced.
2.10.1 Guidelines for Referencing Data Providers

Data providers are uniquely identified by type, channel number, and name. These
attributes are indicated on the Display Server Status window for the data server where
the data providers are configured. To open this window choose: ABB Start Menu >
ABB System 800xA > Information Mgmt>Display Services >IM Display Server
Status.
If not using more than one data provider of a given type, the data access applications
are not required to reference a specific data provider. Data requests will be routed via
the correct data provider based on the type of data being requested. When multiple
data providers of the same type are connected, if a specific data provider is not refer-
enced, the data request will default to the data provider with channel 0. If a different
data provider needs to be used, it must be explicitly referenced. Each of the client
applications use a different method for referencing data providers.
DataDirect
In DataDirect use the Setup tab on the Options dialog to specify the default data
providers for all dialogs and functions (refer to Data Provider Connections on page
251). Optionally, choose whether to use channel number or -name. The default setup
is to use -name. When using -name, the default data provider for each data provider
type must also be selected.
DataDirect functions can specify data providers by -name argument when referencing
a data provider other than the default specified in the Options dialog.
Desktop Trends
In Desktop Trends, the Trend and Ticker tools specify the data provider for each trace
on a Trend display (refer to Data Provider Connections on page 251) and tag on a
Ticker (refer to Data Provider on page 352). Data providers are always referenced by
-name.
3BUF001094-600 B 45
2 Data Access Tools 2.11 Open Data Access
Display Services
In Display Services, data provider references are made in user-configured scripts that
specify the operation of the display elements. All scripting functions EXCEPT data
statements use channel number. The default channel is zero (0). When using the data
statement in a script, and a data provider reference is required, reference the data
provider using its -name argument. For further information regarding display scripts,
display elements, and display building in general, refer to System 800xA Information
Management Configuration for Display Services (3BUF001093*).
Batch Management PDL Browser

The Batch Management PDL Browser is hardcoded to use an ADO data provider
with the name DBA. This is the default name for the ADO data provider. Ensure the
ADO data provider supporting those applications is named DBA and that no other
active data providers use the -name DBA.
2.11 Open Data Access

Open Data Access (ODA) supports client applications that use an ODBC data source,
for example: Crystal Reports and Microsoft Excel (Excel requires Microsoft Query).
In addition to the custom tables, one predefined table named generic_da is provided
for real-time data access. This is a read-only table that exposes all properties for all
real-time objects.
Client applications which access data via ODA may run locally on the server where
the ODA Server is installed, or on a remote computer client. Remote clients require
ODA client software. This component may be installed with the Display and Client
Services bundle during installation.
For an overview and information on configuring ODA refer to the section on Open
Data Access in System 800xA Information Management Configuration
(3BUF001092*). For guidelines on accessing data via ODA and connecting client
applications to an ODA database, refer to Appendix A.
ODA database named DATABASE1 is provided as standard. By default this ODA
database uses the 800xA OPC HDA server, and connects to a real-time database
named Database1. Database1 is initially empty, meaning it has no assigned ODA
Table Definition aspects. This set up supports access via the predefined numericlog
and generic_da tables. The default set up can be changed to use the IM OPC HDA
server, and/or specify a different real-time database table. The IM OPC HDA server
46 3BUF001094-600 B
2 Data Access Tools 2.12 Set-up for SQL*Plus
is provided primarily to support earlier data access applications configured to use this
server. refer to Appendix C for further information.
Further, additional ODA databases can be created where each one specifies a different
real-time database. This allows the client application to be connected to a different
ODA database, depending on the particular data access requirements.
The Open Data Access (ODA) functionality for the System 800xA supports ODBC
as a client connection mechanism that provides access to both, real time and his-
torical process data. The client connections using Oracle support both, the ODBC
and the OLE/DB client connection mechanism.
For more information on database client connections, refer to the following user
manuals:
• System 800xA Reference Guide (3BSE062442*)
• System 800xA System Capabilities (3BSE039129*)
• System 800xA System Guide Technical Data and Configuration (3BSE041434*)
• System 800xA System Guide Functional Description (3BSE038018*)
2.12 Set-up for SQL*Plus

SQL*Plus can be used to access Oracle-based data. The basic syntax is as follows:
sqlplus [<username>]/[<password>][@<tnsname>]
This is described in Table 2.2.
Table 2.2: SQL*Plus Syntax
Syntax Description
sqlplus / This requires being logged in as a historyadmin user, and
requires the ORACLE_SID environment variable to be set.
Note: For IM servers on x64 OS, the default sqlplus.exe is
the x86 version. The "@<tnsname>" must be used to access
the local database. IM servers always define the local
tnsname for the IM database as "localhost". The updated
command line becomes sqlplus /@localhost.
sqlplus /@<tnsname> This requires being logged in as a historyadmin user, and
requires the tnsname to be configured.
3BUF001094-600 B 47
2 Data Access Tools 2.12 Set-up for SQL*Plus
Table 2.2: SQL*Plus Syntax

(Continued)
Syntax Description
sqlplus history/<password> This logs you in as the read-only history user, and requires
the ORACLE_SID environment variable to be set.
the local database. IM servers always define the local
tnsname for the IM database as "localhost". The updated
command line is as follows:
sqlplus history@localhost <Enter>
password: <enter the password> <Enter>
sqlplus This logs you in as the read-only history user, and requires
history/<password>@<tnsname> the tnsname to be configured.
the remote database.The updated command line is as
follows:
sqlplus history@<tnsname> <Enter>
password: <enter the password> <Enter>
2.12.1 ORACLE_SID
Setting this environment variable gives access to a specified Oracle database on the
local server (where SQL*Plus is run). For Information Management applications, set
ORACLE_SID = ADVA. This is the Oracle database installed with Information
Management.
2.12.2 tnsname
Use the Net Configuration Assistant to configure additional net service names to
support SQL*Plus access to remote Information Management servers.
48 3BUF001094-600 B
3 General Information for Data 3.1 User Access to DataDirect Add-in Tools
3 General Information for DataDirect
DataDirect (Excel Data Access) is a desktop tool for integrating information from
various data sources into a Microsoft® Excel spreadsheet. It is implemented as an
add-in for Microsoft Excel that is used to work with industry-standard tools, using
familiar techniques common to other Microsoft Office products. Interactive dialogs
and functions are supported.
Two add-ins are available for DataDirect.
• ABB 800xA DataDirect.msi and
• ABB InformIT DataDirect.msi
This section describes the general information pertaining to both ABB 800xA
DataDirect and ABB InformIT DataDirect.
3.1 User Access to DataDirect Add-in Tools

The DataDirect add-in is integrated into Microsoft Excel on a user-basis. Install ABB
800xA DataDirect.msi on all the PPA nodes to add excel add-ins at location
C:\ProgramData\ABB\800xA\DataDirect\bin\
Install ABB InformIT DataDirect.msi on IM server, IM clients and non 800xA
nodes to add excel add-ins at location C:\ProgramData\ABB\IM\DataDirect\Bin
The add-in must be explicitly added for any other users that will be using DataDirect.
For example, the add-ins must be installed for the 800xAService user in order for the
Application Scheduler to schedule Excel reports. This is described in Manually Adding
the DataDirect Add-in on page 53.
If Excel is not installed, the user can install the Excel later and then manually add
DataDirect Add-in using the steps described in Manually Adding the DataDirect Add-
in on page 53.
3BUF001094-600 B 49
3 General Information for Data 3.2 User Interface - DataDirect Add-in Tools
3.2 User Interface - DataDirect Add-in Tools

The DataDirect user interface is embedded in Excel. Installing DataDirect, adds the
DataDirect add-in tools to the tool bar.
3.2.1 Accessibility to Add-in Tools for Different Windows Users

Add-in tools are embedded in Excel on a user basis. Logging onto the computer as a
different user requires the add-in tools for that user to be manually added.
3.2.2 Showing/Hiding DataDirect Add-in Tools

Each DataDirect add-in tool on the Excel menu and tool bars can be shown or hidden
on an individual basis. This is done through the View tab on the Options dialog.
3.3 Add-in Tool Capabilities

DataDirect is available with two kinds of Add-Ins, System 800xA Add-ins and Inform
IT Add-ins. System 800xA DataDirect add-in tools facilitate access to information
from aspect objects in the 800xA System aspect directory. Some tools of Inform IT
support access to earlier ABB control systems, as well as Oracle and OPC data sources.
For example, Figure 3.1 shows the System 800xA DataDirect add-in tool for accessing
historical data from property logs. With the proper authority process values can be
updated, and add/modify entries in numeric (lab data) logs.
50 3BUF001094-600 B
3 General Information for Data 3.4 Application Set-up
Figure 3.1: Example - Using DataDirect Add-in Tool for Historical Data Access
3.4 Application Set-up

This subsection describes the following set-up procedures:
• Enabling Macros
• Manually Adding the DataDirect Add-in
• Updating Function References in Worksheets
3BUF001094-600 B 51
Upgrading Microsoft Excel software AFTER installing DataDirect may cause

problems when starting DataDirect. This is because the Excel files may be installed
in a different location. Refer to Fixing DataDirect After Upgrading Microsoft
Excel on page 57.
• Changing the Language Selection for Microsoft Office.
3.4.1 Enabling Macros

The Disable All macros except digitally signed macros option should be selected
in the Macro Settings tab of the Trust Center dialog during 800xA System installa-
tion (Figure 3.2). This is necessary to use the DataDirect add-in tools. If the setting
has not been made, when an Excel Worksheet is opened with the DataDirect add-in
tools, error messages may appear. Perform the following steps to disable all macros
except digitally signed macros, if this setting has not been made already per the in-
structions in Section 2 of System 800xA Manual Installation (3BSE034678*), or by
using the System Installer.
1. Click the Office button of an Excel 2010 or 2013 worksheet.
2. Select FILE > Option > Trust Centre
3. Click Trust Centre Settings....
4. Click Macro Settings in the Trust Center dialog.
5. Select Disable All macros except digitally signed macros option in the Trust
Center dialog.
6. Click OK in the Trust Center dialog.
7. Click OK in the Excel Options dialog.
52 3BUF001094-600 B
Figure 3.2: Macro Security Dialog
3.4.2 Manually Adding the DataDirect Add-in

Add-in tools are embedded in Excel on a user basis. Initially, the DataDirect add-in
tools are only available for the user that installed the DataDirect software. Logging
onto the computer as a different user requires the add-in tools for that user to be
manually added. Follow these steps to manually add the add-in tools.
1. Launch Microsoft Excel.
2. Select Excel Options from the bottom of the menu.
3. Select Add-ins from the pane on the left.
4. Select FILE > Option > Add-Ins
5. Click the Go button in the right pane.
3BUF001094-600 B 53
6. Click the Browse button, and use the Windows file chooser dialog to find and
select the respective file for DataDirect System 800xA and DataDirect Inform
IT as given below.
• For DataDirect System 800xA: Go to C:\ProgramData\ABB\800xA\DataDi-
rect\Bin and select the file ABBDataDirectSystem800xA.xlam
• For DataDirect Inform IT: Go to C:\ProgramData\ABB\IM\DataDirect\Bin
and select the file ABBDataDirectInformIT.xlam
This makes the DataDirect Add-in available in the Add-ins dialog, Figure
3.3. Any add-ins listed in this dialog may be added or removed from Excel
by checking or unchecking the corresponding check box.
Figure 3.3: DataDirect Add-in Available in Add-ins Dialog
7. Make sure the DataDirect check box is checked, then click OK.
54 3BUF001094-600 B
3.4.3 Updating Function References in Worksheets

This procedure is required under the following circumstances:
• for worksheets with functions from an earlier DataDirect version.
• for worksheets that are exchanged between two DataDirect installations where
the home directories are different.
In either of the above cases the home directories are different, so the ABBSql, AB-
BGetObj, ABBArray, and ABBGetHistory functions will not operate with the new
add-in. Therefore, it is required that all references in the worksheet be updated.
To do this:
1. Open a workbook in Excel. If the workbook contains DataDirect functions that
reference a relocated add-in, a prompt appears.
2. Answer No to this prompt, and then run the utility as described in Step 3..
To record changes made to the worksheet when the Update Function References
utility runs, go to the Setup tab of the DataDirect Options dialog and select the
Write Debug File option. This records changes to the debug.txt file in the
\DataDirect\tmp directory.
3. Enable the Update Functions menu item through the View tab in the Options
dialog of System 800xA or Inform IT and click OK. (Inform IT is chosen for
reference and refer Figure 3.4 for the view tab of Inform IT).
3BUF001094-600 B 55
Figure 3.4: Enable Update Functions of Inform IT
4. Choose DataDirectInformIT>Update Function References.

5. After the confirmation message, click Continue. This updates all worksheets in
the selected workbook.
6. After getting the update function references completed message, click OK.
7. After updating the function references, execute each function once, before using
the F9 key to calculate the entire workbook.
Any time functions are disabled and then re-enabled, all functions in the spreadsheet
must be executed individually before the F9 key can be used to calculate the entire
workbook.
• For each function that returns multiple values (for example, ABBGetHistory):
a. Select the cell where the function is defined.
56 3BUF001094-600 B
3 General Information for Data 3.5 Starting DataDirect
b. Starting with that cell, select a range of cells where the data will be en-
tered.
c. Put the cursor in the formula bar, and then Press CTRL+SHIFT+ENTER.
• For each function that returns one value (for example, ABBGetObj):
b. Put the cursor in the formula bar.
c. Press ENTER.
3.4.4 Fixing DataDirect After Upgrading Microsoft Excel

Upgrading Microsoft Excel software AFTER installing DataDirect will cause problems
when DataDirect is started. This is because the Excel files are installed in a different
location. An error message indicating that the applicable folder was moved or removed
is displayed in this case. Also, the DataDirect add-in tools will no longer be embedded
in Microsoft Excel.
Use the following procedure to fix these problems:
1. Launch DataDirect from Excel.
When the message that the folder was moved or removed is displayed, select the
option to let the system find and fix. This will restore the connection that lets this
command launch Excel.
2. Re-embed the DataDirect add-in tools in Microsoft Excel. To do this follow the
procedure in Manually Adding the DataDirect Add-in on page 53.
After completing these two steps, DataDirect will start-up normally.
3.4.5 Changing the Language Selection for Microsoft Office

If the language selection for Microsoft Office is changed after DataDirect has been
installed, then uninstall and reinstall DataDirect.
3.5 Starting DataDirect

DataDirect is started from the Add-Ins tab of Excel.
Open Excel. Click Add-Ins tab. Macros MUST be enabled in order to use the
DataDirect add-in tools.
3BUF001094-600 B 57
3 General Information for Data 3.6 Quick Tips for Using DataDirect
3.6 Quick Tips for Using DataDirect

The following sections provide some quick tips for using DataDirect:
• Logging In on page 58.
• Customizing Your Application on page 58.
• Getting Help on page 58.
• About DataDirect on page 58.
• Finding the Right Tool on page 58.
3.6.1 Logging In
DataDirect requires being logged in to a data server. There are two log-in modes.
Perpetual log-in lasts until a log off occurs. Ad-hoc log-in lasts until the current dialog
is closed. Refer to Using DataDirect Dialogs on page 59 for details.
3.6.2 Customizing Your Application

The DataDirect user interface has default settings so DataDirect can be used without
having to do any preliminary set up. To make adjustments in System800xA DataDirect,
refer to System 800xA Configuring Options on page 109and for Inform IT DataDirect
refer to Configuring Options on page 238.
3.6.3 Getting Help

To access general online help files, choose DataDirect > Help, or click the Help (?)
button in the DataDirect tool bar. Get context-sensitive help for a specific dialog by
clicking the dialog’s Help button. This button displays the online help topic for the
current dialog.
3.6.4 About DataDirect

The DataDirect>About menu item displays the About message box. Clicking More
displays the About message for AdvaInform Active Data Provider.
3.6.5 Finding the Right Tool

The DataDirect dialogs are used to generate ad-hoc data queries and data objects and
display the results in an Excel spreadsheet. With the proper authority, the process and
58 3BUF001094-600 B
3 General Information for Data 3.7 Using DataDirect Dialogs
history values dialogs can be used to insert and/or update values. These dialogs have
equivalent functions used to create reusable Excel reports.
Most dialogs provide the option of inserting a reusable formula in the spreadsheet.
This is used to perform the ad-hoc query, and insert the formula in the spreadsheet
so that it may be reused for reporting.
Use Table 3.1 to determine which DataDirect tool to use for data retrieval.
Table 3.1: Which Tool to Use
Application Add-in Tool

Reading and Writing Process Values To use a dialog, refer to Apply, OK, & Cancel
Buttons on page 68.
For equivalent functions, refer to Using the
System 800xA Process Values Dialog on page
77 and Using the Inform IT Process Values
Dialog on page 142.
Reading and Writing History values To use a dialog, refer to Using the System 800xA
History Values Dialog on page 90 and Using the
Inform IT History Values Dialog on page 165
Read Alarm/Event Messages To use a dialog, refer to Using the System 800xA
Alarm/Events Dialog on page 104.
Read Production data from PDL tasks for PDL dialog - Refer to Retrieving Production Data
800xA Batch Management, Batch 300, or TCL on page 202.
SQL queries SQL dialog - Refer to Retrieving Values for TCL
Unit Arrays on page 235.
OR ABBSql on page 276.
3.7 Using DataDirect Dialogs

Basic operating procedures for all DataDirect dialogs are similar. This section describes
these basic procedures to help with using the DataDirect dialogs more effectively.
Details for these basic procedures are provided in the sections referenced below, as
are the specific instructions for each dialog. Basic steps:
1. Before opening the dialog, select the starting cell to insert data.
2. Open the dialog. After opening the dialog, the starting cell may be changed.
3BUF001094-600 B 59
3. Use the Insert check box to specify whether to overwrite existing information in
the spreadsheet, or to insert the new data without overwriting.
4. Specify whether to execute a one-time data query, or insert a reusable formula.
5. If the dialog requires a date and time range, enter the start and end times.
6. Apply data formatting options if desired.
7. The connection icon in the lower right corner shows the server connection status.
8. Click Apply or OK to execute the query.
For further details regarding each basic step, refer to:
Selecting the Starting Cell on page 60
Opening the Dialog on page 60
Changing the Start Cell on page 61
Specifying One-time Data Access or Reusable Formulas on page 61
Date and Time on page 62
Formatting on page 67
Monitoring/Changing the Server Connection on page 67
Apply, OK, & Cancel Buttons on page 68
3.7.1 Selecting the Starting Cell

For any query, specify the starting cell where the query result will be inserted. To do
this, click the applicable cell in the Excel Spreadsheet, Figure 3.5. The Start Cell
specification can be changed from the dialog if necessary.
Selected Cell - B2
Figure 3.5: Selecting the Starting Cell
3.7.2 Opening the Dialog

Use either the DataDirect menu, or equivalent tool bar to open any dialog. Figure 3.6
demonstrates how to open the System 800xA Process Values dialog.
60 3BUF001094-600 B
Figure 3.6: Opening the Dialog
If required options are not available in the menu and tool bars, use the View tab
on the Options dialog to make these options available.
If not logged in, the prompt to log in now is displayed. Refer to Login on page 139
for details. After log in, the chosen dialog is displayed.
3.7.3 Changing the Start Cell

The Start Cell field indicates the starting cell where data returned by the query will
be presented. The initial Start Cell value is based on the spreadsheet cell which is
selected when the dialog is opened. The Start Cell value can be changed by entering
a new value directly in this field. The syntax is ColumnLetterRowNumber. For example
G5 is the fifth row in the seventh column.
3.7.4 Inserting or Overwriting Rows

The Insert check box is used to insert a new row or rows of data in the spreadsheet
without overwriting any existing data. When Insert is selected, existing rows are
moved down as required to make room for the new data. By not selecting this check
box, any cells already containing data may be overwritten by new data.
3.7.5 Specifying One-time Data Access or Reusable Formulas

The Output option buttons on the top right part of the dialog are used to specify
whether to execute a one-time data request, or enter a reusable formula which will
be executed each time the spreadsheet is updated. This is equivalent to using the
function call for the chosen dialog (Configuring Options on page 238).
For one-time data requests, select Data Only. For reusable formulas, select Formula.
This requires functions to be enabled on the Setup tab of the Options dialog (functions
are enabled by default). Refer to Disable Functions on page 254.
3BUF001094-600 B 61
Figure 3.7: Output Options
When using Formula output, selecting any cell that has output in the spreadsheet will
display the formula in the formula bar, Figure 3.8.
Figure 3.8: Showing the Formula
To use the Formula output option, refer to Storing, Updating, and Scheduling Reports
on page 74 for further guidelines for creating a report with DataDirect.
3.7.6 Date and Time

Dialogs that retrieve historical data require a time range. These dialogs provide three
methods for specifying the time range. Select the method for specifying start and end
times from the respective pick lists as shown in Figure 3.9.
Figure 3.9: Selecting the Method for Specifying Start and End Times
Then refer to the sections referenced below for details on how to use the selected
method:
• Date and Time on page 63.
62 3BUF001094-600 B
• Cell Reference on page 63.

• Dynamic Time on page 64.
Date and Time

This option is used to modify any part of the date and time by clicking directly on
the unit to be changed and entering the new value. For time, the up/down arrows can
also be used to change the selected unit. For date, click the down arrow to display
the Microsoft DT Picker dialog, Figure 3.10.
Up down arrows for adjusting time units
Figure 3.10: Example, Microsoft DT Picker Dialog
Entering an end time that precedes or equals the start time causes an error message
to be displayed when the query is executed. Click OK to clear the message, then
enter a valid start (or end) time.
Do not use either of the following options for short date style in the Regional
Settings dialog (Windows Control Panel function): yy-dd-mm or yyyy-dd-mm.
This causes the month and date values to be reversed in the DT Picker.
Cell Reference
This option is used to reference a cell in the spreadsheet where the start or end time
is specified, Figure 3.11.
3BUF001094-600 B 63
Is used to return focus to the spreadsheet to clic

rather than enter the cell by typing
Figure 3.11: Specifying Start and End Times by Cell Reference
Dynamic Time
This option is used to specify the start and end time as Now (current date and time)
plus or minus a time interval specified in number of seconds, minutes, hours, days,
weeks, months, or years. For example in Figure 3.12, the start time is specified as
now minus one day, and the end time is specified as now.
Figure 3.12: Dynamic Time Example
Dynamic time can be used in combination with date and time. For example, in Figure
3.13, the start time is specified as end time minus four days, and the end time is
specified as 9/18/2004 11:30:00.
Now refers to the current date and time, Figure 3.13. Each time a report is gener-
ated, every instance of Now is re-evaluated. To record the current date and time
for future references, use the now() function in any of the cell.
64 3BUF001094-600 B
Figure 3.13: Dynamic Time in Combination with Date and Time
The Now() Function

The Now() function provides the current date and time in the Excel cell with an
=Now() entry. If this function is used multiple times in the same Excel workbook,
the time recorded for each function is different as it gets its time at the instant the
function is called and there is a time delay between each function call. This can be
used for an ad-hoc query for a single set of data for a single tag. However, to generate
a report with multiple data calls that are to be synchronized, there are two methods
as follows:
Method 1:
Use the Now() function in a cell in the Excel file and then reference that cell in other
places in the report where the time entry is required.
For example, in cell A1 enter =Now(), that results in the current time entry into cell
A1. In the rest of the report when a function that requires a time entry is called, provide
A1 as the parameter.
Method 2 :
The other method is to pass in the start time and the date as parameters to the Excel
report. This is done by defining name cells in Excel that are named the same as the
parameter that is being passed. Then, define the parameter on the Action Aspect for
the report. For example, Figure 3.14 and Figure 3.15 shows an Action Aspect that is
configured to pass in the three parameters: DateParam, TimeParam, and Date-
TimeParam.
3BUF001094-600 B 65
Figure 3.14: Action Aspect
Figure 3.15: Report Parameters
66 3BUF001094-600 B
The content in the Name field in Figure 3.15 are the names to be given to the cells in
Excel, and the Value field indicates the value to be put into the cell.
3.7.7 Formatting
The presentation format is set through the Data Format tab in the Options dialog.
When Horizontal List is selected, attributes are listed horizontally and objects are
listed vertically, Figure 3.16. When Vertical List is selected, attributes are listed ver-
tically and objects are listed horizontally.
To change any of the data format or orientation options, click the Options button to
display the Options dialog. Refer to Configuring Options on page 238 for details.
Figure 3.16: Process Value Query Result - Example Horizontal List Format
3.7.8 Monitoring/Changing the Server Connection

Monitoring/Changing the server connection is applicable only for Inform IT. The
plug icon near the bottom of the dialog indicates the current connection status to a
data server, Figure 3.17. Use this icon to establish a connection, or connect to a dif-
ferent server. To do this double-click the Plug icon. This displays the Login dialog.
Connected
Disconnected
Figure 3.17: Plug Icon
3BUF001094-600 B 67
3 General Information for Data 3.8 Using DataDirect Functions
3.7.9 Apply, OK, & Cancel Buttons

Use OK or Apply to execute the query. Use Apply to have the dialog remain open
after a query executed. Use OK to have the dialog close after making entries. The
OK button always executes the query that is currently specified in the dialog. To not
re-execute the query, use the Cancel button to close the dialog.
3.8 Using DataDirect Functions

The DataDirect functions listed in Table 3.2 can be used to build a report. Many of
these functions can be entered manually in the spreadsheet, or the Formula option
can be used in the equivalent dialog.
• If DataDirect is installed in two different locations and worksheets need to
be exchanged between the two installations, use the Update Function Refer-
ences utility to make the worksheets compatible. Refer to Updating Function
References in Worksheets on page 55.
• DataDirect stops updating functions when focus is shifted from the spread-
sheet. The Excel spreadsheet must maintain focus while the report is running
(retrieving data).
There are two methods for applying these functions.
• Inserting Functions Directly in the Spreadsheet - To insert the functions di-
rectly in an Excel spreadsheet, refer to Inserting Functions in the Spreadsheet on
page 69.
Guidelines for re-executing a spreadsheet are provided in Updating the Excel
Spreadsheet on page 75.
• VBA Macros - write macros that reference these functions using VBA program-
ming. By embedding the functions in the macros, they are not automatically ex-
ecuted when the spreadsheet is opened. This is used when archiving reports. In
addition, these reports can be distributed to Excel users that do not have
DataDirect. An example is provided in Using VBA Macros on page 280.
Excel files created for reports may be saved as Excel files (.xls) in the Windows file
system, or these files may be attached to File Viewer aspects in the 800xA System
aspect directory. This is used to browse for report files through the Plant Explorer,
and is also used to apply version control and electronic signatures to report files.
When finished building a report, refer to Storing, Updating, and Scheduling Reports
on page 74 for further guidelines.
68 3BUF001094-600 B
Table 3.2: List of Functions
Application Function
Reading and Writing Process Values ABBGetOPCDASimple on page 118
ABBGetOPCDA on page 118
ABBWriteOPCDA on page 119
ABBGetObj on page 265
ABBUpdateObj on page 266
Reading and Writing History Values ABBGetOPCDA on page 118
ABBGetOPCHDAAggregates on page 124
ABBWriteNOPCHDA on page 124
ABBWriteOPCHDA on page 126
ABBGetOPCHDAAttributes on page 128
ABBGetOPCHDAAttributeValue on page 129
ABBGetHistory on page 268
ABBEditLog on page 271
ABBEditNLogs on page 272
ABBGetAttributes on page 274
ABBGetAttributeValue on page 275
Reading Messages ABBAERetrieval on page 132
Miscellaneous Functions ABBSql on page 276
ABBArray on page 278
ABBConnect on page 279
ABBDisconnect on page 279
Using VBA Macros on page 280
Adding Charts to DataDirect Reports on page 280
3.8.1 Inserting Functions in the Spreadsheet

Execute each function at least once as it is inserted in the spreadsheet.
While the cursor is in the formula bar, pressing F9 after inserting or changing a
function will cause Excel to hang.
To insert a function call, the workbook must be in manual mode. DataDirect sets the
workbook to manual mode by default. Confirm this setting as described in Putting
the Workbook in Manual Mode on page 70. Use either the Excel Function wizard
or insert function calls manually.
3BUF001094-600 B 69
• To use the Excel Function Wizard, refer to Inserting DataDirect Functions with
the Function Wizard on page 70.
• To insert functions manually, refer to Inserting DataDirect Functions Manually
on page 73.
The Excel Chart Wizard can be used to add charts in a DataDirect report. Refer
to Adding Charts to DataDirect Reports on page 280.
Putting the Workbook in Manual Mode

Make sure that the workbook calculation mode is set to Manual when one of these
functions is used in an Excel spreadsheet. To do this:
1. Click the Formulae tab.
2. Click Calculation Options. This displays the Options dialog.
3. Select the Manual calculation option. Figure 3.18.
Figure 3.18: Excel Options Dialog, Calculation Tab
Inserting DataDirect Functions with the Function Wizard

To use the Excel function wizard to set up functions:
1. Make sure the workbook is in Manual calculation mode as described in Putting
the Workbook in Manual Mode on page 70.
2. Make sure Disable Functions is checked on the DataDirect Options dialog. Refer
to Setup on page 249.
3. Select a cell in the spreadsheet.
4. Choose Insert > Function from the Excel menu bar (or click the Function button
on the Excel toolbar). This displays the Paste Function dialog.
70 3BUF001094-600 B
5. Select User Defined from the Function category list on the left. This displays
the DataDirect functions in the Function name list on the right, Figure 3.19.
Figure 3.19: Paste Function Dialog
6. Select the function to be inserted. This displays a dialog for specifying the selected
function’s parameters. For example, if ABBGetOPCHDA is selected, the dialog
shown in Figure 3.20 is displayed.
3BUF001094-600 B 71
Figure 3.20: Function Specification Dialog
7. Enter a specification for each parameter. Be sure to embed text strings (for exam-
ple, object names) in double quotes. Refer to the applicable function description
for details. Refer to Table 3.2.
8. Click OK when finished with the Parameters dialog.
9. Repeat steps 3-8 for as many functions as needed.
10. Go back to the DataDirect Options dialog, and un-select Disable Functions. Refer
to Setup on page 249.
11. Each function must be executed once before the F9 key can be used to calculate
the entire workbook.
Any time functions are disabled and then re-enabled, all functions in the spreadsheet
must be executed individually before the F9 key can be used to calculate the entire
workbook.
The Excel spreadsheet must maintain focus while the report is running (retrieving
data).
72 3BUF001094-600 B
• For each function that returns multiple values (for example, ABBGetOPCH-
DA):
b. Starting with that cell, select a range of cells to hold the data.
c. Put the cursor in the formula bar, and then Press CTRL+SHIFT+ENTER.
• For each function that returns one value (for example, ABBGetOPCDA):
b. Put the cursor in the formula bar.
c. Press ENTER.
Inserting DataDirect Functions Manually

For functions that return multiple values (for example, ABBGetOPCHDA):
2. Select a range of cells. For example, select an area on the worksheet that is 3
columns wide and 500 rows long.
3. Enter the function according to the function syntax. Refer to Table 3.2. Each
parameter must be separated by a comma. Strings must be in double-quotes (").
4. To run the function, put the cursor in the formula bar, and press
CTRL+SHIFT+ENTER. This treats the selected area as one function.
For functions that return a single value (for example, ABBGetOPCDA):
2. Select a cell.
3. Enter the function according to the function syntax. Refer to Table 3.2. Each
parameter must be separated by a comma. Strings must be in double-quotes (").
4. Press ENTER to run the function.
3BUF001094-600 B 73
Expanding an Array Formula

To expand an array formula (they can not shrunk) do the following.
1. In the workbook, clear any text and single-cell formulas located below the main
table.
2. Select the range of cells that contains the current array formula, plus the empty
cells next to the new data.
3. Press F2 to start edit mode.
4. In the formula bar, change number of rows to be returned from the formula, and
then press CTRL+SHIFT+ENTER. Excel places an instance of the formula in
the new cells.
3.8.2 Storing, Updating, and Scheduling Reports

Reports may be scheduled through the 800xA System scheduler. For details refer to
Section 7 Creating Reports.
Saving a Report Template

Excel files may be saved as Excel files (.xls) in the Windows file system, or these
files may be attached to File Viewer aspects in the 800xA System aspect directory.
This is used to browse for report files through the Plant Explorer, and is also used to
apply version control and electronic signatures to report files.
A report file MUST be saved in Manual calculation mode if it will be scheduled
and executed using the Application Scheduler. Otherwise, the report will run twice
when run through the Scheduler. The Excel calculation mode is set to the mode
of the first file opened (or calculated, if no previously saved file has been opened).
All workbooks that are opened in that Excel session will be set to that same calcu-
lation mode, despite any previous settings. DataDirect sets the calculation mode
to Manual by default. To check the mode and change it if necessary, refer to Putting
Use the File>Save As command from the Excel menu bar the first time a report is
saved. This is used to enter a unique name for the report and specify the path where
it will be saved. If multiple instances are to be saved, use File>Save As to enter a
unique name for each instance. If each instance does not need to be saved, use
File>Save instead.
74 3BUF001094-600 B
Updating the Excel Spreadsheet

The purpose of using functions (or dialog in the formula mode) is to create a spread-
sheet that will be updated each time it is opened or executed through the Application
Scheduler. The spreadsheet can also be updated on demand.
The Inform IT functions are set up to update using the F9 function in Microsoft Excel.
The Industrial IT functions will not be updated when the F9 function is invoked. For
these functions, use the Calculate Full function in Microsoft Excel. Calculate Full
will update all functions on the spreadsheet, including Inform IT functions. Refer to
the online help for Microsoft Excel for instructions on using Calculate Full.
3BUF001094-600 B 75
76 3BUF001094-600 B
4 DataDirect System 800xA 4.1 Introduction
4 DataDirect System 800xA
4.1 Introduction
System 800xA dialogs and functions can only be used on nodes where the base 800xA
System software is installed.
4.2 Using the System 800xA Process Values Dialog

DataDirect System 800xA process values provides dialogs for reading and writing
real-time process values. The System 800xA version is used to query aspect objects
in the 800xA System. With the proper authority process values can also be updated.
This dialog is only available on 800xA System nodes that have base 800xA software
installed (Aspect Servers, Connectivity Servers, Application Servers, and Workplace
Clients). This dialog is not available on remote computer clients running Information
Management Desktop tools without 800xA software.
The Process Value toolbar icons for the System 800xA is red in color. Figure 4.1. If
the icon is not available on the tool bar, use the View tab on the Options dialog to
make it available. Refer to View on page 114.
Figure 4.1: Industrial IT Process Value icons
The System 800xA Process Values dialog, Figure 4.2, is used to query aspect objects
in the 800xA System for real-time process data (including softpoints).
3BUF001094-600 B 77
4 DataDirect System 800xA 4.2 Using the System 800xA Process Values Di
Figure 4.2: Process Values Dialog
With the proper authority process values can also be updated. The Update Process
Values tab is not enabled unless the Allow Process Updates option is selected through
the Setup tab on the Options dialog (refer to Setup on page 249). Also, user authority
must be configured in the aspect system to allow updates of certain object properties.
• This dialog requires 800xA base system software to be installed on the com-
puter running DataDirect.
• This dialog does not support querying objects on servers outside the 800xA
System. For this, use the Inform IT version of this dialog. Refer to Using the
Inform IT Process Values Dialog on page 142.
Follow these steps to display the process values dialog for data retrieval or updates:
78 3BUF001094-600 B
1. Select the cell in the spreadsheet which will be the starting point for inserting
data.
2. Use the menu or tool bar to open the System 800xA Industrial IT Process Values
dialog.
Either click the Process Value button in the tool bar, or choose
DataDirect System 800xA> Industrial IT Process Values from the menu bar,
Figure 4.3.
3. For data retrieval, refer to Reading Process Values on page 79.

For data updates, refer to Writing Process Values on page 84.
4.2.1 Reading Process Values

The Process Values tab is used to query aspect objects for real-time process data
(including softpoints) and display the results in an Excel Spreadsheet. Follow these
steps to retrieve process values with this dialog. Further details for each step, and
other optional procedures are provided in the sections referenced below. Basic steps:
1. Use the Output option buttons to specify whether to execute a one-time (ad-hoc)
data query, or insert a reusable formula.
2. Select the objects whose process values will be retrieved.
3. Click Apply or OK to retrieve the data.
3BUF001094-600 B 79
Only press Apply or OK once. Wait for the process values to be returned before
attempting to retrieve additional values. Pressing the button multiple times can
result in software failure.
For further details on these steps and other optional procedures refer to:
• Specifying One-time Data Access or Reusable Formulas on page 61.
• Selecting Objects to Query on page 80.
• Changing the Start Cell on page 61.
• Inserting or Overwriting Rows on page 61.
• Formatting on page 67.
• Some information columns in the properties list (right pane) are hidden by default.
these columns can be expanded to show the information as described in Expanding
the Items Columns on page 83.
Selecting Objects to Query

The object browser (left pane) in the Process Values dialog is similar to the Plant
Explorer. It is used to browse the aspect directory for the objects whose property data
are being retrieved and displayed on the spreadsheet. Selecting an object in the left
pane will cause the properties of that object to be listed in the property list in the right
pane. To put process data onto the spreadsheet, select one or more items in the prop-
erties list, then click OK. Alternately, copy the selected properties to the clipboard
to use (paste) in another application.
The scope of this retrieval process can be limited to just the selected object, or expand
the scope to include child objects of the selected object (Specifying Whether or Not
to Include Child Objects on page 81).
A filter may also be applied to include or exclude certain objects, aspects, and prop-
erties (Applying a Filter to the List of Returned Object Properties on page 82).
The retrieval process may be aborted if there are too many properties for the selected
object(s). While the dialog is building the property list, the Apply Filter button
changes to Abort, Figure 4.4. This button indicates the number of objects whose
properties have been returned at the current time, and the total number of selected
objects. Clicking this button will abort the retrieval process when the current object
is finished, so that no additional objects will be searched for properties.
80 3BUF001094-600 B
Figure 4.4: Abort Button Showing 35/101 Items Searched
Specifying Whether or Not to Include Child Objects

This check box, Figure 4.5, is used to specify whether or not to return properties for
all child objects of the selected object. If this check box is not checked, then only
properties of the selected object will be returned.
3BUF001094-600 B 81
Figure 4.5: Specifying Whether or Not to Include Child Objects
Applying a Filter to the List of Returned Object Properties

The default condition of the object browser is to retrieve all object properties with
no filtering. To apply a filter, click the Edit Filter button. This displays the Process
Values Filter dialog, Figure 4.6. Up to five filtering criterion can be used to limit the
list of returned object properties. The two type filters (object and data type) and three
pattern filters (object, aspect, and property name) can be specified in.any combination
according to the following guidelines.
Figure 4.6: Process Values Filter
82 3BUF001094-600 B
The type filters are used to select one or more object or data types from the respective
lists. Use one, both, or neither of the type filters. Making no selection is equivalent
to selecting all types.
If object types have been added to or deleted from the Object Type structure, the
Object Type list will be updated the next time the Process values dialog is opened.
This causes any current selections to be cleared from the list.
The pattern filters are used to specify one or more patterns for each criteria. When
specifying multiple patterns, separate them with the pipe (|) delimiter character. Use
the following wildcard characters:
* - any character string
? - any single alphabetic character
# - any single numeric character
Example pattern filters can be displayed by hovering the cursor over the corresponding
field. Matching is not case sensitive. Not specifying a pattern is equivalent to (and is
replaced by) the wildcard asterisk (*) character.
For each type or pattern filter, any objects that match any one (or more) of the specified
types or patterns will satisfy the component filter. However, only objects that satisfy
all component filters will pass the filter and be included in the list of returned proper-
ties.
Clicking OK saves the current filter settings. These settings will then be used for all
future process value queries until the current settings are changed again. Clicking
Cancel will discard any changes made in this dialog and revert back to the last saved
filter. The Reset button returns all settings to their default state.
The filter is applied any time a new selection is made in the browser (left pane). To
apply the filter to the currently selected object in the left pane, click Apply Filter.
Expanding the Items Columns

By default the columns for Object Name, Property, and Current Value are shown in
the right pane, while the Object Type, Aspect, Property, and Data Type columns are
hidden. Expand these hidden columns to show the contents by clicking and dragging
the column header as shown in Figure 4.7. The fully expanded columns are shown
in Figure 4.8. The columns remain expanded for the current object selection. When
a new object is selected, the columns will be hidden again.
3BUF001094-600 B 83
Click and drag here to expand these columns
Figure 4.7: Default View of Items Columns
Figure 4.8: Fully Expanded Columns
4.2.2 Writing Process Values

The Update Process Values tab on the Process Values dialog is shown in Figure 4.9.
This tab is used to update property values for aspect objects (including softpoints).
84 3BUF001094-600 B
Figure 4.9: Update Process Value Tab
User Authority
The Update Process Values tab is not enabled unless the Allow Process Updates
option is selected through the Setup tab on the Options dialog (refer to Setup on page
249). Also, user authority must be configured in the aspect system to allow updates
to certain object properties.
The method of operation for this tab is similar to reading process values as described
in Apply, OK, & Cancel Buttons on page 68. Either of two methods can be used:
3BUF001094-600 B 85
• The basic method is to use the object browser (left pane) in combination with an
edit filter. Refer to Using the Object Browser below.
• As an alternative, make a list of object properties and values in the spreadsheet,
and then import this data from the spreadsheet. Refer to Use Spreadsheet for Input
on page 88.
Using the Object Browser

This is similar to retrieving items for data retrieval (reference Figure 4.10):
1. Use the object browser (left pane) and edit filter to retrieve an object property
list as described in Selecting Objects to Query on page 80. This list is displayed
in the right pane.
Do not select the Use Spreadsheet for Input check box. This disables the object
browser.
2. Select one or more items from the properties list in the right pane, then click Add
to List. This places the selected items in the update list (lower pane).
Remove selected items from the list if necessary. To do this, select the item in
the list, and then click Remove From List. Clear the entire list by clicking Clear
List.
3. Click in the Value column and edit the value for a selected property. The Updated
column will indicate Changed when the value has been changed. Other columns
may be updated as required.
To update only selected items in the Update list, check Update Selected Items
only; otherwise all items in this list will be updated.
Checking the Automatically apply filter check box will reapply the existing
filter to the properties list (upper right pane) when the changes are applied.
4. Click Apply when finished. The Updated column in the Update list (lower pane)
will indicate whether or not the update was successful, Figure 4.11.
86 3BUF001094-600 B
Figure 4.10: Selecting Items to Update
Figure 4.11: Update Success Indication
3BUF001094-600 B 87
Use Spreadsheet for Input

This procedure describes how to import an existing list of object property names and
values from the spreadsheet (object names are mandatory, values are optional). To
do this:
1. Click the Use Spreadsheet for Input check box, Figure 4.12.
Click
Here
Click here to collapse the dialog
Figure 4.12: Use Spreadsheet for Input
2. Enter the range of cells that contain the object names in the Objects Range field.
Enter the range directly, or click the button to collapse the dialog and then select
the range of cells in the spreadsheet.
Select the range of cells, then click the red button on the bottom right corner of
the collapsed dialog to restore it. An example is shown in Figure 4.13.
Objects
Range
Selected
Click Here
to Restore
Figure 4.13: Selecting a Range of Cells
All cells must contain data, and the range CANNOT contain spaces. This will
generate an error message and the cell range must be reselected.
3. As an option, repeat step 2 to import values from the spreadsheet (using the
Values Range field). When this is done, the number of rows selected for the
values must match the number of rows selected for the object names.
88 3BUF001094-600 B
4. After finishing with the object and value ranges, click Add to List. This creates
the update list, Figure 4.14.
Figure 4.14: Preview Selected Updates for Formatted Range
Remove selected items from the list if necessary. To do this, select the item in
the list, and then click Remove From List. Clear the entire list by clicking Clear
List.
column will indicate Changed when the value has been changed.
6. To update only selected items in the Update list, check Update Selected Items
only; otherwise all items in this list will be updated.
7. Checking the Automatically apply filter check box will reapply the existing
filter to the properties list (upper right pane) when the changes are applied.
3BUF001094-600 B 89
4 DataDirect System 800xA 4.3 Using the System 800xA History Values Di
Figure 4.15: Update OK Indication
4.3 Using the System 800xA History Values Dialog

System 800xA DataDirect provides dialogs for reading and writing numeric history
data. The System 800xA version is used to query aspect objects (property logs) in
the 800xA System. With the proper authority, log entries can be inserted and/or re-
placed. This dialog is only available on 800xA System nodes that have base 800xA
software installed (Aspect Servers, Connectivity Servers, Application Servers, and
Workplace Clients). This dialog is not available on remote computer clients running
Information Management Desktop tools without 800xA software.
For querying 800xA System objects, if the System 800xA version is available, it is
generally recommended that it be used rather than the Inform IT version. The System
800xAversion provides browsing tools that more closely resemble the Plant Explorer
and make it easier to find the applicable objects for querying.
The toolbar icons for the System 800xA History value is given in Figure 4.16. If an
icon is not available on the tool bar, use the View tab on the Options dialog to make
it available. Refer to View on page 114.
90 3BUF001094-600 B
Figure 4.16: System 800xA History Value Icon
Refer to the section below for instructions on using the appropriate dialog:
The System 800xA History Values dialog, Figure 4.17, is used to query aspect objects
in the 800xA System for historical process data. The results are displayed according
to the selections made on the Data Format tab on the Options dialog. Modify these
selections through the Output Options tab on the History Values dialog.
With the proper authority, new log entries can be inserted, or existing entries replaced.
The Insert/Replace tab is not enabled unless the Allow History Updates option is
selected through the Setup tab on the Options dialog (refer to Setup on page 249).
Also, user authority must be configured in the aspect system to allow certain object
properties to be updated.
Figure 4.17: History Values Dialog
Follow these basic steps to retrieve or update history values with this dialog:
data.
2. Use the menu or tool bar to open the System 800xAHistory Values dialog.
3BUF001094-600 B 91
Either click the History Values button, or choose DataDirect System 800xA>
Industrial IT History Values from the menu bar.
3. To read history values, refer to Reading History Data on page 92.
To update history values, refer to Writing History Data on page 98.
4.3.1 Reading History Data

Follow these basic steps to retrieve history values with this dialog. Further details for
each step, and other optional procedures are provided in the section referenced below.
Basic steps:
2. Specify whether to retrieve raw or interpolated data.
3. A calculation algorithm (aggregate) can be selected to apply to the data when it
is retrieved. The default is to apply no calculation.
4. Specify the maximum number of value to return. The default is 100.
5. The time range may adjusted. The default time span is one hour from the current
time. Also, to add a millisecond column, check Include Milliseconds.
6. Select the property logs whose values are to be seen.
4.3.2 Retrieval Type

The Retrieval Type pull-down list is used to select: Interpolated Data or Raw Data,
Figure 4.18.
Figure 4.18: Retrieval Type
Interpolated Data
This returns values at regular intervals. Always specify the time range and number
of values to return. This divides the time range into discrete intervals for which data
92 3BUF001094-600 B
values are returned. For example, if the time range is 24 hours and the number of
values to return is 1440, a value will be provided for each one-minute interval. The
values are not actual samples, but rather values interpolated from the actual samples.
Raw Data
This returns values for actual samples collected and stored by History. Always spec-
ify a time range. Values are only returned for times when samples were collected and
stored. The query will return all values up to the quantity specified in the Number of
Values field (3200 maximum). For example, if the time range is 24 hours and the
number of values to return is 300 or greater, for a log with a five-minute storage rate,
288 values will be returned.
4.3.3 Log Calculation Algorithm

When the Retrieval Type is Interpolated, use this pull-down list to select a calculation
to apply to the history data being retrieved. This list is not available when the Retrieval
Type is Raw.
The pull-down list for Log Calculation Algorithms is based on the connected OPC
HDA server. The implementation of these calculations is server dependent. The system
OPC HDA server is the default. Figure 4.19 shows the list of calculation types for
this server. These calculation types are described in Table 4.1.
The selected calculation is performed on the data stored in the log with data being
retrieved. The requested time range for which data will be retrieved is divided into
resample intervals. For example, if the requested time range is 24 hours and the re-
quested number of values to return is 1440, the resample interval is one minute (24
hours = 1440 minutes, 1440 minutes/1440 values = 1 value per minute). In this case,
the calculation will be performed on the values stored in the log for each one-minute
interval. All time stamps returned are those of the beginning of the resample interval
except for those calculations which explicitly state otherwise.
Figure 4.19: Log Calculation Algorithm List for AIPHDA
3BUF001094-600 B 93
Table 4.1: Calculation Options for 800xA OPC HDA Server
Calculation Retrieves
Interpolated Linear interpolation (no calculation).
Total Totalized value (time integral) of data over the resample interval.
Average Average value for data over the resample interval.
Timeaverage Time weighted average for data over the resample interval.
Count Number of raw values over the resample interval.
Standard Deviation Standard deviation over the resample interval.
Minimum Actual Time Minimum value in the resample interval and the timestamp of the minimum
value.
Minimum Minimum value in the resample interval.
Maximum Maximum value in the resample interval.
Start Raw value at the beginning of the resample interval. The time stamp is
the time stamp of the beginning of the interval.
End Raw value at the end of the resample interval. The time stamp is the time
stamp of the end of the interval.
Delta Difference between the first and last value in the resample interval.
Regression Slope Slope of the regression line over the resample interval.
Regression Const Intercept of the regression line over the resample interval. This is the
value of the regression line at the start of the interval.
Regression Deviation Standard deviation of the regression line over the resample interval.
Variance Variance over the resample interval.
Range Difference between the minimum and maximum value over the resample
interval.
Duration Good Duration (in seconds) in the resample interval during which the data is
good.
Duration Bad Duration (in seconds) in the resample interval during which the data is
bad.
Percentage Good Percentage of data in the resample interval which has good quality
(1 equals 100 percent).
94 3BUF001094-600 B

(Continued)
Percentage Bad Percentage of data in the resample interval which has bad quality
Worst Quality Worst quality of data in the resample interval.
4.3.4 Number of Values

The Number of Values pull-down list is used to specify the number of values to return.
The default is 100 and the maximum is 3200. When the Retrieval Type is Interpolat-
ed, this in combination with the Time Span for Retrieval divides the time range into
discrete intervals for which data values are returned. For the Raw Data Retrieval
Type, all data up to 3200 values can be retrieved.
4.3.5 Time Span for Retrieval

Refer to Date and Time on page 62.
4.3.6 Selecting Logs

The object browser in the left pane of the History Values dialog is similar to the Plant
Explorer. It is used to browse the aspect directory for the logs whose data is being
retrieved and displayed on the spreadsheet. Selecting an object in the left pane will
cause the logs for that object to be listed in the log list in the right pane.
Limit the scope of this retrieval process to just the selected object, or expand the scope
to include child objects of the selected object (Specifying Whether or Not to Include
Child Objects on page 96).
erties (Applying a Filter to the List of Returned Logs on page 96).
Also, the retrieval process may be aborted if there are too many logs for the selected
object(s). While the dialog is building the log list, the Apply Filter button changes
to Abort, Figure 4.4. This button indicates the number of objects whose logs have
been returned at the current time, and the total number of selected objects. Clicking
this button will abort the retrieval process when the current object is finished, so that
no additional objects will be searched for logs.
3BUF001094-600 B 95
Figure 4.20: Abort Button Showing 81 or 250 Items Retrieved
To put history data onto the spreadsheet, select one or more items in the log list, then
click OK. The selected logs can also be copied to the clipboard to use (paste) in an-
other application.
Specifying Whether or Not to Include Child Objects

This check box is used to specify whether or not to return logs for all child objects
of the selected object. If this check box is not checked, then only logs for the selected
object will be returned.
Applying a Filter to the List of Returned Logs

The list of returned logs in the right pane can be limited to a specific set based on any
combination of up to seven filtering criterion. There are three type filters: object type,
property log template, and data type; and four pattern filters object, aspect, property,
and log name.
The default condition is to retrieve all logs with no filtering. To apply a filter, click
the Edit Filter button to display the History Values Filter dialog, Figure 4.21. Then
specify any combination of type and pattern filters according to these guidelines.
96 3BUF001094-600 B
Figure 4.21: History Values Filter
The type filters are used to select one or more object types, property log templates,
or data types from the respective lists. Any combination of the type filters may be
used. Making no selection is equivalent to selecting all types.
If object types or log templates have been added to or deleted from the Object
Type structure or Library structure respectively, the corresponding list will be
updated the next time the History Values dialog is opened. This will cause any
current selections to be cleared from the lists.
The pattern filters are used to specify one or more patterns for each criteria. When
specify multiple patterns, separate them with the pipe (|) delimiter character. The
following wildcard characters may be used:
Display example pattern filters by hovering the cursor over the corresponding field.
Matching is not case sensitive. Not specifying a pattern is equivalent to (and is replaced
by) the wildcard asterisk (*) character.
3BUF001094-600 B 97
For each type and pattern filter, any objects that match any one (or more) of the
specified types or patterns will satisfy the component filter. However, only objects
that satisfy all component filters will be included in the list of returned logs.
Clicking OK will save the current filter settings. These settings will then be used for
all future History Value queries until the current settings are changed again. Clicking
4.3.7 Changing the Output Options

Use this to specify whether or not to display the following information as a result of
a historical data query: Headers, Tag Names, Calculation, Timestamp, or Data Qual-
ity.
The output format defaults to the settings made on the Data Format tab on the Options
dialog (Data Format on page 239). Change these default selections through the Output
Options tab on this dialog, Figure 4.22. Clicking the Restore Options Dialog Settings
will reset the output options to the settings on the Data Format tab.
Figure 4.22: Modifying Output Options
4.3.8 Writing History Data

The Insert/Replace tab on the History Values dialog is shown in Figure 4.23. This
tab is used to modify existing entries and insert new entries in property logs. There
are certain restrictions and important considerations that should be read prior to
writing history data. Refer to Writing to History Logs on page 42.
98 3BUF001094-600 B
Figure 4.23: Insert/Replace Tab
User Authority
The Insert/Replace tab is not enabled unless the Allow History Updates option is
selected through the Setup tab on the Options dialog (refer to Setup on page 249).
Also, user authority must be configured in the aspect system to allow updates to log
objects.
The method of operation for this tab is similar to reading history values as described
in Apply, OK, & Cancel Buttons on page 68. Use either of two methods:
• The basic method is to use the object browser (left pane) in combination with an
edit filter. Refer to Using the Object Browser below.
• As an alternative, make a list of data retrieval parameters in the spreadsheet, and
then import this data from the spreadsheet. Refer to Use Spreadsheet for Input
on page 102.
3BUF001094-600 B 99
Using the Object Browser

This is similar to retrieving items for data retrieval (reference Figure 4.24):
1. Use the object browser (left pane) and edit filter to retrieve an object property
list as described in Selecting Logs on page 95. This list is displayed in the right
pane.
DO NOT check the Use Spreadsheet for Input check box. This disables the object
browser.
2. Select one or more items from the log list in the right pane, then click Add to
List. This places the selected items in the update list (lower pane).
Selected items from the list can be removed if necessary. To do this, select the
item in the list, and then click Remove From List. The entire list may be cleared
by clicking Clear List.
3. Click in the Value column and edit the value for a selected log. The Updated
column will indicate Changed when the value has been changed. Other columns
may be updated as required.
ONLY; otherwise all items in this list will be updated.
Checking the Automatically Apply Filter check box will reapply the existing
filter to the log list (upper right pane) when the changes are applied.
4. Click in the Insert/Replace column and select Insert or Replace.
100 3BUF001094-600 B
Figure 4.24: Selecting Items to Update
Figure 4.25: Updated Values in refreshed Log List
3BUF001094-600 B 101
Use Spreadsheet for Input

This procedure describes how to import an existing list of data retrieval parameters
from the spreadsheet. Object names are mandatory. Timestamps, milliseconds, values,
and object status are optional. Parameters not selected will use the last value saved
for that object. To do this:
Click
Here
2. Enter the range of cells that contain the object names in the Objects Range field.
Enter the range directly, or click the button to collapse the dialog and then select
the range of cells in the spreadsheet, then click the red button on the bottom right
corner of the collapsed dialog to restore it. An example is shown in Figure 4.27.
Click Here
to Restore
Objects
Range
Selected
Figure 4.27: Selecting a Range of Cells
generate an error message, in which case the cell range must be reselected.
3. As an option, repeat step 2 to import timestamps, milliseconds, values and/or
object status data from the spreadsheet. The number of rows selected for each
102 3BUF001094-600 B
additional parameter must match the number of rows selected for the object
names.
4. When finished, Figure 4.28, click Add to List. This creates the update list, Figure
4.29.
Figure 4.28: Selected Range
To remove selected items from the list, select the item in the list and then click
Remove From List. The entire list may be cleared by clicking Clear.
column will indicate Changed when the value has been changed.
Only; otherwise all items in this list will be updated.
Checking the Automatically Apply Filter check box will reapply the existing
filter to the log list (upper right pane) when the changes are applied.
6. Click in the Insert/Replace column and select Insert or Replace.
7. Click Apply when finished.The Updated column in the Update list (lower pane)
indicates whether or not the update was successful, Figure 4.30.
3BUF001094-600 B 103
4 DataDirect System 800xA 4.4 Using the System 800xA Alarm/Events Dial
Figure 4.30: Update Completed
4.4 Using the System 800xA Alarm/Events Dialog

System 800xADataDirect provides dialogs for reading alarm/event message. The
System 800xA Alarm and Events dialog is used to retrieve alarm and event messages
for a selected alarm/event list. This dialog requires 800xA base system software to
be installed on the computer where DataDirect is running.
The System 800xA version is generally recommended for viewing recent alarm/event
data on the 800xA alarm/event server. Since messages on this server are eventually
overwritten, the Inform IT version may be needed to read the IMMSGLOG. This log
can hold up to 12 million entries. Further, these entries may be archived for permanent
storage, and then restored for viewing.
The System 800xA Alarm and Event icon is given in Figure 4.31. If an icon is not
available on the tool bar, use the View tab on the Options dialog to make it available.
Refer to View on page 114.
104 3BUF001094-600 B
Figure 4.31: Industrial IT Alarm/Event Dialog Icons
The Industrial IT Alarms and Events dialog, Figure 4.32, is used to retrieve alarm
and event messages for a selected alarm/event list. These lists are user-configurable
as part of the operator workplace configuration. This dialog requires 800xA base
system software to be installed on the computer where DataDirect is running.
3BUF001094-600 B 105
Figure 4.32: Industrial IT Alarms and Events Dialog
To retrieve messages that are beyond the scope of the 800xA System message services
(50,000 messages maximum), use the Inform IT Message Log dialog.
To begin:
1. Select the cell which will be the starting point for inserting data.
2. Open the Industrial IT Alarms and Events dialog. Either click the Alarm/Events
button in the tool bar, or choose DataDirect System 800xA> Industrial IT
Alarm and Events from the menu bar, Figure 4.33.
3. Use the Alarm and Events dialog to select the alarm or event list and specify a
time range. Refer to Using the Alarms and Events Dialog on page 107.
106 3BUF001094-600 B
4.4.1 Using the Alarms and Events Dialog

To use the Industrial IT Alarms and Events dialog:
data query, or insert a reusable formula. Refer to Specifying One-time Data Access
or Reusable Formulas on page 61.
2. Select the alarm and event list whose messages will be retrieved and displayed
in the spreadsheet. Refer to Selecting Alarm and Event Lists on page 108.
3. The default time span is 24 hours from the current time. Change the default time
span through the Messages tab of the Options dialog. Refer to Messages on page
257. The start and end time can also be changed using the controls on this dialog
as described in Date and Time on page 62.
4. Use the Maximum Rows pull-down list to specify the number of values to return.
The default is 100.
As an option, specify the following alarm/event retrieval parameters:
Inserting or Overwriting Rows on page 61
3BUF001094-600 B 107
Selecting Alarm and Event Lists

The object browser (left pane) in the Alarm and Events dialog is similar to the Plant
Explorer. It is used to browse the aspect directory for the objects whose alarm and
event lists will be queried. Selecting an object in the left pane will cause the alarm
and event lists of that object to be listed in the right pane. To put alarm/event messages
onto the spreadsheet, select one or more items from the list in the right pane, then
click OK.
Use the Include child objects check box to limit the scope of this retrieval process
to just the selected object, or include child objects of the selected object
erties.
The retrieval process may be aborted if there are too many properties for the selected
object(s). While the dialog is building the property list, the Apply Filter button
changes to Abort. This button indicates the number of objects whose properties have
been returned at the current time, and the total number of selected objects. Clicking
this button will abort the retrieval process when the current object is finished, so that
no additional objects will be searched for properties.
Applying a Filter to the List of Returned Alarm and Event Lists

The list of returned alarm and event lists in the right pane can be limited to a specific
set based on any combination of up to three filtering criterion. There is an object type
filter, and two pattern filters: object and aspect.
The default condition is to retrieve all alarm and event lists with no filtering. To apply
a filter, click the Edit Filter button to display the Edit Alarm and Event Filter dialog,
Figure 4.34. Then specify any combination of type and pattern filters according to
these guidelines.
The type filter is used to select one or more object types. Making no selection is
equivalent to selecting all types.
If object types have been added to or deleted from the Object Type structure, the
Object Type list will be updated the next time the Alarm and Events dialog is
opened. This causes any current selections to be cleared from the list.
The pattern filters are used to specify one or more patterns for each criteria. If multiple
patterns are specified, separate them with the pipe (|) delimiter character. The following
wildcard characters may be used:
108 3BUF001094-600 B
4 DataDirect System 800xA 4.5 System 800xA Configuring Options

Example pattern filters can be displayed by hovering the cursor over the corresponding
field. Matching is not case sensitive. Not specifying a pattern is equivalent to (and is
replaced by) the wildcard asterisk (*) character.
For each type or pattern filter, any objects that match any one (or more) of the specified
types or patterns will satisfy the component filter. However, only objects that satisfy
all component filters will pass the filter and be included in the list of returned proper-
ties.
Clicking OK saves the current filter settings. These settings will then be used for all
future alarm/event queries until the current settings are changed again. Clicking
The filter is applied any time a new selection is made in the browser (left pane). To
apply the filter to the currently selected object in the left pane, click Apply Filter.
Figure 4.34: Edit Alarm and Event Filters
4.5 System 800xA Configuring Options

Data format, file setup and View can be configured under System 800xA configuring
options. To change any of these options, use the Options dialog. This dialog is dis-
3BUF001094-600 B 109
played by clicking the Options button, Figure 4.35, or choose System 800xA> Op-
tions Form from the Microsoft Excel menu bar.
Figure 4.35: Options Button
The configurable options are grouped on three tabs:

• Use the Data Format tab to configure orientation and data options. For instance,
this tab is used to specify whether or not to include attribute names as headers,
and whether to orient the results horizontally or vertically.
• Use the Setup tab to establish defaults for communications settings. This includes
setting up data access through data providers and enabling/disabling write access
to process and history values,.
• Use the View tab to select which add-in tools to show or hide in the Excel tool
and menu bars.
4.5.1 Data Format

The Data Format tab, Figure 4.36 is used to specify the items described in Table 4.2.
110 3BUF001094-600 B
Figure 4.36: Options Dialog, Data Format Tab
Table 4.2: Data Format Items
Data Format Option Description

Horizontal List Use Horizontal List to list attributes horizontally and objects
vertically. An example is shown in Figure 4.37.
Vertical List Use Vertical List to list attributes vertically and objects
horizontally. An example is shown in Figure 4.37.
Attributes as Headers Use this option to have the names of the selected
attributes used as column headers (for Horizontal List) or
row headers (for Vertical List). An example is shown in
Figure 4.37.
Long Format When this orientation option is selected, object attributes
are presented in the long format with Attribute and Data
Value headings. A Long format example is shown in
Figure 4.38.
3BUF001094-600 B 111

(Continued)

Headers When this option is selected, headers are included in the
list.
Object Names When this option is selected, object names are shown;
otherwise, they are excluded.
History Log Calculation When this option is selected, calculation (aggregate) for
the History log is shown; otherwise, it is excluded.
Attribute Names When this option is selected, the names of the selected
attributes are shown.
History Data Quality When this option is selected, a data quality indication is
provided for History object values according to the
selected format (Symbolic, Numeric or Red-coded).
Symbolic When History Data Quality is enabled and Symbolic is
selected, the indication for good data is OK. The
indications for no data, bad data, and unknown status
respectively are: No Data, Bad Data, and ?_.
Numeric When History Data Quality is enabled and Numeric is
selected, data quality is indicated as a numeric error code.
Red-coded When History Data Quality is enabled and Red-coded is
selected, data quality is indicated in red.
Autofit All Columns If this option is checked, then all output to the worksheet
will have the columns autofitted (resized to accommodate
the longest value in the Excel column). If not selected, the
columns retain their original size.
Time Stamp When this option is selected, a time stamp is provided for
values that have an associated time stamp, for instance
History objects.
Note: If the time stamp field shows pound symbols
(#######), make sure the column width is sufficient to
show the complete date and time. If not, stretch the column
until it fits.
112 3BUF001094-600 B

(Continued)

Date and Time These fields are used to specify the date and time formats.
Formatting These formats apply to date and time presentation in the
Excel spreadsheets. The available formats are shown in
Figure 66.
Note: This option is available only for the standard times
of Active Time, Event Time and Acknowledge Time in
Alarm and Events functions.
Millisecond Select this checkbox for Alarm and Events function of
DataDirect that supports the retrieval of data.
of Active Time, Event Time and Acknowledge Time.
Horizontal Orientation
Vertical Orientation
Figure 4.37: Example, Using Attributes as Headers
3BUF001094-600 B 113
Figure 4.38: Example, Long Format
Figure 4.39: Date and Time Formatting
4.5.2 View
The View tab, Figure 4.40, is used to select which add-in tools to show or hide on
the DataDirect tool bar and menu bar. Add-in tools are grouped under Industrial IT
for use in the 800xA System.
114 3BUF001094-600 B
Figure 4.40: View Tab
Each add-in tool has a separate check box for showing/hiding the add-in tool in the
DataDirect menu and/or the corresponding tool bar. Restore the default settings at
any time by clicking Restore Defaults. Figure 4.40 shows the default settings when
DataDirect is initially installed on an 800xA System node.
4.5.3 Setup
This tab, Figure 4.41, is used to configure the following settings:
• Enable/Disable Write Access to History and Process Values
• Timeout
• Write Debug File
• Disable Functions
3BUF001094-600 B 115
Figure 4.41: Options Dialog, Setup Tab
Enable/Disable Write Access to History and Process Values

The Allow History Updates and Allow Process Updates check boxes are used to
enable/disable write access to history logs and process objects respectively.
For the System 800xA History and Process values dialogs, the user authority must
be configured in the aspect system to allow updating log objects.
116 3BUF001094-600 B
4 DataDirect System 800xA 4.6 Functions for Reading/Writing Process Va
Timeout
This is the maximum time that DataDirect will wait for the selected object to respond
to the query before timing out. Increase the timeout interval if the application uses
complex SQL queries.
Write Debug File

When this option is selected, DataDirect writes status information to a text file that
can be read when troubleshooting. The file name is debug.txt. This file is located in
“C:\Users\<current user>\AppData\Roaming\ABB Industrial IT\Inform IT\DataDi-
rect\tmp. This way each user has their own debug file.”1.
Disable Functions
When this check box is selected, all DataDirect functions in the Excel spreadsheet
are disabled. Functions must be disabled when inserting functions as described in
System 800xA Configuring Options on page 109. The functions must be enabled to
execute a specific function, or calculate the entire workbook.
Any time functions are disabled and then re-enabled, then all functions in the
spreadsheet must be executed individually before the F9 key can be used to calcu-
late the entire workbook.
4.6 Functions for Reading/Writing Process Values

DataDirect System 800xA provides functions for reading and writing real-time process
values. The System 800xA functions are used to query aspect objects in the 800xA
System. With the proper authority, process values can also be updated. These functions
will only run on 800xA System nodes that have base 800xA software installed (Aspect
Servers, Connectivity Servers, Application Servers, and Workplace Clients). Further,
these functions will not work with Excel versions before Office 2000.
The functions for Reading/Writing Process Values for 800xA Systems are explained
below.
The Industrial IT Functions for Process Values are:
• ABBGetOPCDASimple on page 118 (Read value for one object).
• ABBGetOPCDA on page 118 (Read value for multiple objects).
1. The default path for %ABB_ROOT% is: C:\Program Files\Abb Industrial IT\
3BUF001094-600 B 117
• ABBWriteOPCDA on page 119 (Write to an object).
4.6.1 ABBGetOPCDASimple
The ABBGetOPCDASimple function will return real-time object data for one OPCDA
item.
This function requires 800xA base system software to be installed on the computer
where DataDirect is running. To query objects on a server that is not part of the
800xA System, use ABBGetObj on page 265.
The syntax for this function is described below:
=ABBGetOPCDASimple(ObjectName [,Server])
where:
ObjectName is the object name. Use the Information Management Browser to find
objects in the aspect directory. The browser is used to copy and paste
the object names to ensure the name is specified correctly. Refer to
Information Management Browser on page 524.
[Server] specifies the OPCDA server ProgID. This defaults to the 800xA
OPCDA server when the parameter is left undefined.
Enter all parameters as text strings with double quotes.
Example:
=ABBGetOPCDASimple(“H0000X000K-000000:MEASURE”, "ABB.AfwOPCDA-
Surrogate")
This function returns an array of data (two columns, one row). To manually execute
the function, select a 2 x 1 range of cells, then place the cursor in the formula bar
and press Ctrl-Shift-Enter.
For instructions on inserting functions, refer to Inserting Functions in the Spreadsheet
on page 69.
4.6.2 ABBGetOPCDA
This function returns real-time object data for specified OPCDA items. It will search
for all cells containing this function and formulate one OPC call to retrieve the spec-
ified data for all and cause all cells to be populated with the correct data. The Indus-
trial IT Process Values dialog may also be used in the Formula mode to insert this
function (Using the Inform IT Process Values Dialog on page 142).
118 3BUF001094-600 B
800xA System, use ABBGetObj on page 265.
=ABBGetOPCDA(ObjectName[,bTS] [,Server])
where:
ObjectName is object name. Use the Information Management Browser to find
objects in the aspect directory. This is used to copy and paste to ensure
the name is specified correctly. Refer to Information Management
Browser on page 524.
If the property desired is not unique to one aspect, the aspect name can be appended
to the object path. For example:
Object:Property[:AspectName]
[bTS] specifies whether or not to return the time stamp with each value.
Enter bTS as a boolean value:
TRUE = return time stamps
FALSE = do not return time stamps
OPCDA server when the parameter is left undefined. If this parameter
is used, all cells using this function must specify the same progID.
Enter all parameters (except bTS) as text strings with double quotes. bTS is a boolean.
Example:
=ABBGetOPCDA(“H0000X000K-000000:MEASURE”, TRUE "ABB.AfwOPCDA-
Surrogate")
on page 69.
4.6.3 ABBWriteOPCDA
The ABBWriteOPCDA function is used to update process values.
800xA System, use ABBUpdateObj on page 266.
3BUF001094-600 B 119
4 DataDirect System 800xA 4.7 Functions for Reading/Writing History Va
The syntax is as follows:

=ABBWriteOPCDA (objname, value, [,Server])
where:
ObjName is the object name. Use the Information Management Browser to find
objects in the aspect directory. The browser is used to copy and paste
the object names to ensure the name is specified correctly. Refer to
Information Management Browser on page 524.
Value is the new value to be applied to the specified attribute.
Enter all parameters as text strings with double-quotes, with the exception of the
value which may be entered as another data type as applicable, for example: integer.
Example:
=ABBWriteOPCDA(“H0000X000K-000000:MEASURE”, 100 "ABB.AfwOPCDA-
Surrogate")
on page 69.
4.7 Functions for Reading/Writing History Values

DataDirect System 800xA provides functions for reading and writing history data.
The System 800xA functions are used to query aspect objects in the 800xA System.
With the proper authority, log entries can also be inserted and/or replaced. These
functions will only run on 800xA System nodes that have base 800xA software in-
stalled (Aspect Servers, Connectivity Servers, Application Servers, and Workplace
Clients). Further, these functions will not work with Excel versions before Office
2000.
The functions for Reading/Writing History Values for 800xA Systems are explained
below.
The System 800xA Functions for History Values are:
• ABBGetOPCHDA on page 121 (Read values).
• ABBGetOPCHDAAggregates on page 124 (Get Aggregate List for OPC HDA
Server, an aggregate must be entered in the ABBGetOPCHDA function).
120 3BUF001094-600 B
• ABBWriteNOPCHDA on page 124 (Write to multiple entries).

• ABBWriteOPCHDA on page 126 (Write to single entry).
• ABBGetOPCHDAAttributes on page 128 (Get a list of log attributes).
• ABBGetOPCHDAAttributeValue on page 129 (Get Log attribute values).
4.7.1 ABBGetOPCHDA
The ABBGetOPCHDA function returns a specified number of values for the specified
history log object. By default this function retrieves the columns of data selected on
the Data Format tab on the Options dialog. Refer to Data Format on page 239. The
default is to display Time Stamp, History Data Quality Indication, and Value. Change
the settings on the Data Format tab, or use the output parameter in this function to
change the output specification.
Generate a query for this function using the Industrial IT History Values dialog in
the Formula mode as described in Reading/Writing History Data on page 164, or
enter the function manually.
800xA System, use ABBGetHistory on page 268.
The syntax is:
=ABBGetOPCHDA(Logname, Interpolation, Start Time, End Time, MaxCount
[,Format Date] [,Server][,output],[mSec])
where:
Logname is the name of the log whose data is to be retrieved. Use the
Information Management Browser to find logs in the aspect directory.
This is used to copy and paste log names to ensure the name is
specified correctly. Refer to Information Management Browser on
page 524.
Interpolation is the type of calculation. The available options depend on the OPC
server. The ABBGetOPCHDAAggregates function may be used to
get the list of available aggregates.
Start/End specify the time range for which data will be retrieved.
Time
3BUF001094-600 B 121
MaxCount specifies the number of values to return. This in combination with the
Time Span for Retrieval divides the time range into discrete intervals
for which data values are returned.
[Format is an optional parameter that is used to specify whether to use standard
Date] Excel formatting (n) or DataDirect formatting (y). Refer to Formatting
the Date on page 123.
[Server] specifies the OPCHDA server ProgID. This defaults to the 800xA
[output] specifies the information to display as a result of the historical data
query. If this option is not specified, the information selected in the
Data Format tab of the Options dialog will be displayed (Data Format
on page 239). This option may be used to specify any combination of
the following columns be displayed:
header = 1
object name = 2
calculation = 4
time stamp = 8
attribute name = 16
data quality = 32
To use this option, enter the parameter as an integer which is equal
to the sum of the integer values for the columns to be displayed. For
example, to specify the time stamp and object name, enter 10 (8 for
timestamp plus 2 for object name).
The history value is always displayed. Specify that only the history
value be displayed by entering 0.
[mSec] specifies whether or not to show the time stamp with millisecond
resolution (true = show milliseconds, false = do not show
milliseconds).
Enter all parameters (except MaxCount and output) as text strings with double quotes.
For start time and end time, separate the date and time with a space. MaxCount and
output are entered as integer values.
Example:
122 3BUF001094-600 B
=ABBGetOPCHDA(“H0000X000K-000000:MEASURE”, “max”, "11/3/00 14:30",

“11/3/00 19:30”, 5, “n”, "ABB.AdvHtHistoryHdlr.1",10)
This function returns an array of data. The width (columns) is based on the log
attributes being displayed. The number of rows depends on the time range and
MaxCount parameter. To manually execute the function, select a range of cells,
then place the cursor in the formula bar and press Ctrl-Shift-Enter.
on page 69.
Matching Number of Values Returned with Rows Selected

The number of values returned by the ABBGetOPCHDA function is determined by
the MaxCount parameter, and by the number of rows selected in the spreadsheet.
If MaxCount > selected rows, the excess values are truncated.
If MaxCount < selected rows, excess rows are left blank.
Use MaxCount to make the number of values returned match the number of rows
selected. To do this specify the MaxCount parameter as -1. For example:
=ABBGetOPCHDA(“H0000X000K-000000:MEASURE”, “max”, "11/3/00 14:30",
“11/3/00 19:30”, -1)
Again, if there are fewer values in the log than there are rows specified, the excess
rows are left blank.
Formatting the Date

Normally, date and time are formatted as specified in the Data Format tab of the
Options dialog. To edit date and time information in the spreadsheet, or use this infor-
mation in Excel charts, use the standard Excel formatting instead. To specify standard
Excel formatting rather than DataDirect formatting, use the Format Date parameter
in the ABBGetOPCHDA function to specify that DataDirect formatting NOT be used
(n).
Specify the Format Date parameter as follows:
“n” or “N”DataDirect date and time formats, as specified in the Data Format tab of
the Options dialog, are not applied to the timestamp returned by the ABBGetOPCHDA
function. Additionally, the returned timestamp is a date data type.
3BUF001094-600 B 123
“y” or “Y”DataDirect date and time formats, as specified in the Data Format tab of
the Options dialog, are applied to the timestamp returned by the ABBGetOPCHDA
function.
If a Format Date parameter is not provided, then the DataDirect date and time formats,
as specified in the Data Format tab of the Options dialog, are applied to the timestamp
returned by the ABBGetOPCHDA function. This is the same as specifying formatDate
as y or Y.
4.7.2 ABBGetOPCHDAAggregates
The ABBGetOPCHDAAggregates function returns a list of aggregates supported by
the connected OPCHDA server. This may be used when manually entering the AB-
BGetOPCHDA function rather than using the Industrial IT History Values dialog.
where DataDirect is running.
=ABBGetOPCHDAAggregates([Server])
where:
Enter the server parameter as a text strings with double quotes.
Example:
=ABBGetOPCHDAAggregates( "ABB.AfwOPCDASurrogate")
This function returns an array of data (two columns by n number of rows). To
manually execute the function, select a range of cells two columns wide and a
reasonable number of rows (about 25), then place the cursor in the formula bar
on page 69.
4.7.3 ABBWriteNOPCHDA
The ABBWriteNOPCHDA function is used to add multiple entries to a history log,
or modify existing log entries. This is the same functionality provided by the Insert/Re-
124 3BUF001094-600 B
place tab on the History Values dialog as described in Writing History Data on page
98. To add a single entry, use ABBWriteOPCHDA on page 126.
where DataDirect is running. To write to an object on a server that is not part of
the 800xA System, use ABBEditNLogs on page 272.
Guidelines for Writing History Data
User authority must be configured in the aspect system to allow log objects to be
updated.
There are certain restrictions and important considerations that need to be understood
prior to writing history data. Refer to Writing to History Logs on page 42.
Log Entry Specification
The log entry specification contains the values, time stamps and object statuses for
each log entry being added or modified. Enter this specification in the proper format
in the spreadsheet. The function references the row/column range where this informa-
tion is entered. An example is shown in Figure 4.42. Syntax for value, time stamp,
and object status are described in ABBWriteOPCHDA on page 126.
Values Time Stamps Object Statuses
Figure 4.42: Example, Log Entry Specification
Syntax
Enter all parameters (except the optional fractional seconds) as text strings with
double-quotes. The syntax is as follows:
=ABBWriteNOPCHDA (cmd, logName, theRange [,varType] [,server])
where:
3BUF001094-600 B 125
cmd indicates whether to insert a new value or replace an existing value.

Enter “I” or “A” to insert a new value. Enter “R” or “M” to replace
an existing value. The complete word may also be used (Insert, Add,
Replace, or Modify)
logName is the name of the log whose data is to be written. Use the Information
Management Browser to find logs in the aspect directory. The browser
is used to copy and paste the log names to ensure the name is specified
correctly. Refer to Information Management Browser on page 524.
theRangeis the range of rows and columns in the spreadsheet where the pre-formatted
log entry specification is located.
the Value string
timestamp string
Optional numeric OPC Quality
Optional fractional seconds as a floating point number
[varType] variant type to which the value is converted. This parameter is NOT
used in this version of DataDirect, and is present for compatibility
with earlier versions of DataDirect.
Examples:
To add a log:
=ABBWriteNOPCHDA ("INSERT", "H000X000K-000000,MEASURE", A1:C5)
To modify a log:
=ABBWriteNOPCHDA ("REPLACE", "H000X000K-000000,MEASURE", A1:C5)
4.7.4 ABBWriteOPCHDA
The ABBWriteOPCHDA function is used to add a single entry to a lab data history
log, or modify an existing log entry. This is the same functionality provided by the
Insert/Replace tab on the History Values dialog as described in Writing History Data
on page 98. To add multiple entries in one function call, use ABBWriteNOPCHDA
on page 124.
126 3BUF001094-600 B
the 800xA System, use ABBEditLog on page 271.
Guidelines for Writing History Data
User authority must be configured in the aspect system to allow log objects to be
updated.
There are certain restrictions and important considerations that should be understood
prior to writing history data. Refer to Writing to History Logs on page 42.
Syntax
Enter all parameters (except the optional fractional seconds) as text strings with
double-quotes. The syntax is as follows:
=ABBWriteOPCHDA (cmd, logName, logValue, timeStamp, objectStatus [,fractSec]
[,opcQuality] [,varType] [,server])
where:
cmd indicates whether to insert a new value or replace an existing value.
Enter “I” or “A” to insert a new value. Enter “R” or “M” to replace
an existing value. The complete word may also be used (Insert, Add,
Replace, or Modify)
logName is the name of the log whose data is to be written. Use the Information
Management Browser to find logs in the aspect directory. The browser
is used to copy and paste the log names to ensure the name is specified
correctly. Refer to Information Management Browser on page 524.
logValue is the new value for the log entry.
timeStamp is the time stamp for the entry. When modifying an existing entry the
time stamp must be accurate within one second. To get the precise
time stamp, retrieve the raw data for the log entry as described in
Reading History Data on page 92.
[fractSec] Optional fractional seconds specification (floating point).
objectStatus is an option used to enter an integer value to associate with this log
entry. For example, ObjectStatus may be used to identify the user that
added/modified the entry. This value defaults to 0 (zero). The value
does not have to be changed if the functionality is not used.
3BUF001094-600 B 127
[varType] variant type to which the value is converted. This parameter is NOT
used in this version of DataDirect, and is present for compatibility
with earlier versions of DataDirect.
Examples:
=ABBWriteOPCHDA ("INSERT", "H000X000K-000000,MEASURE", "150.25",
"9/16/2003 13:22:00", "0")
=ABBWriteOPCHDA ("REPLACE", "H000X000K-000000:MEASURE,Log1",
"150.25", "9/16/2003 13:22:00", "0")
4.7.5 ABBGetOPCHDAAttributes
The ABBGetOPCHDAAttributes function returns a list of available attributes for the
connected OPCHDA server.
the 800xA System, use ABBGetAttributes on page 274.
=ABBGetOPCHDAAttributes([Server])
where:
Enter the server parameter as a text strings with double quotes.
Example:
=ABBGetOPCHDAAttributes("ABB.AfwOPCDASurrogate")
This function returns an array of data (two columns by n number of rows). To
manually execute the function, select a range of cells two columns wide and a
reasonable number of rows (about 25), then place the cursor in the formula bar
128 3BUF001094-600 B
4.7.6 ABBGetOPCHDAAttributeValue
This function returns values for a specified attribute of a specified history log object.
By default this function retrieves the columns of data selected on the Data Format
tab on the Options dialog. Refer to Data Format on page 239. The default setting on
this tab is to display Time Stamp, History Data Quality Indication, and Value. Change
the settings on the Data Format tab, or use the output parameter in this function to
change the output specification.
Generate a query for this function using the Industrial IT History Values dialog in
the Formula mode as described in Reading History Data on page 92, or enter the
function manually.
the 800xA System, use ABBGetAttributeValue on page 275.
The syntax is:
=ABBGetOPCHDAttributeValue(Logname, AttributeID, Start Time, End Time,
MaxCount [,Format Date] [,Server][,output])
where:
Logname is the name of the log whose attribute value is to be retrieved. Use the
Information Management Browser to find logs in the aspect directory.
The browser is used to copy and paste the log names to ensure the
name is specified correctly.
AttributeID is the name of the attribute whose value is to be retrieved. The
available attributes depend on the connected OPC server. The
ABBWriteNOPCHDA function may be used to get the list of available
attributes.
Start/End specify the time range for which data will be retrieved. Specify that
Time only the current value be returned by entering the Start Time as
“NOW”.
Time Span for Retrieval divides the time range into discrete intervals
for which data values are returned.
3BUF001094-600 B 129
on page 239). Use this option to specify that any combination of the
following columns be displayed:
header = 1
object name = 2
calculation = 4
time stamp = 8
attribute name = 16
data quality = 32
to the sum of the integer values for the columns being displayed. For
Enter all parameters (except MaxCount and output) as text strings with double quotes.
For start time and end time, separate the date and time with a space. MaxCount and
output are entered as integer values. For example:
=ABBGetOPCHDAAttributeValue(“H0000X000K-000000:MEASURE”, “attribute-
Name”, "11/3/00 14:30", “11/3/00 19:30”, 5, “n”, "ABB.AdvHtHistoryHdlr.1",10)
This function returns an array of data. The width (columns) is based on the log
attributes to be displayed. The number of rows depends on the time range and
MaxCount parameter. To manually execute the function, select a range of cells,
then place the cursor in the formula bar and press Ctrl-Shift-Enter.
130 3BUF001094-600 B

The number of values returned by this function is determined by the MaxCount pa-
rameter, and the number of rows selected in the spreadsheet.
If MaxCount > selected rows, the excess values are truncated.
If MaxCount < selected rows, excess rows are left blank.
Use MaxCount to make the number of values returned match the number of rows
selected. To do this specify the MaxCount parameter as -1. For example:
=ABBGetOPCHDAAttributeValue(“H0000X000K-000000:MEASURE”, “attribute-
name”, "11/3/00 14:30", “11/3/00 19:30”, -1)
Again, if there are fewer values in the log than there are rows specified, the excess
rows are left blank.
Formatting the Date

in the ABBGetOPCHDAAttributevalue function to specify that DataDirect formatting
NOT be used (n).
the Options dialog, are not applied to the timestamp returned by the ABBGetOPCH-
DAAttributeValue function. Additionally, the returned timestamp is a date data type.
the Options dialog, are applied to the timestamp returned by the ABBGetOPCHDAAt-
tributeValue function.
returned by the ABBGetOPCHDAAttributeValue function. This is the same as
specifying formatDate as y or Y.
3BUF001094-600 B 131
4 DataDirect System 800xA 4.8 Functions for Reading Messages
4.8 Functions for Reading Messages

The ABBAERetrieval function retrieves runtime or archived event data for a specified
800xA System alarm and event list. This function will only run on 800xA System
nodes that have base 800xA software installed (Aspect Servers, Connectivity Servers,
Application Servers, and Workplace Clients).
To use this function, refer to ABBAERetrieval on page 132.
4.8.1 ABBAERetrieval
The ABBAERetrieval function retrieves runtime or archived event data for a specified
800xA System alarm and event list.
where DataDirect is running.
The Message Type combo box on the Filter tab of the Alarm and Event List Config-
uration aspect determines whether messages come from archive or from local (runtime)
storage. If this field starts with ArchiveService.OPCEventServer the messages are
retrieved from the archive. The A/E Linked Server Configuration aspect, which must
be attached to the same object as the Alarm and Event List Configuration aspect,
specifies the parameters for the archive retrieval.
The Alarm and Event List Configuration aspect specified by the Alarm and Event
List Aspect is used to determine the following:
• List of categories.
• List of attributes.
• Order of attribute columns.
• Number of messages retrieved.
• Whether or not Column Headers are displayed.
• Process Sections filtering.
• Class filtering.
The timeout for this function (maximum seconds to wait for response) defaults to the
timeout specified by the setting on the DataDirect Options dialog. Refer to Timeout
on page 253.
132 3BUF001094-600 B
4 DataDirect System 800xA 4.8 Functions for Reading Messages
The format of the timestamp (if the time is a selected attribute to be output) is deter-
mined by the time format setting on the DataDirect Options dialog. Refer to Date and
Time Formatting.
This function is an array function meaning that rows and columns must be allocated
to it in which the retrieved results are to be stored. Each message retrieved requires
one row. Each attribute retrieved requires one column.
Generate a query for this function using the Alarm and Event Retrieval dialog in the
Formula mode as described in Using the Inform IT Message Log Dialog, or enter
the function manually. The syntax is:
=ABBAERetrieval(startTime, endTime, AEListAspect[,MaxRows] [,Timeout])
where:
start and end time range for messages to be retrieved. Note: if endTime comes
times before startTime, the messages are ordered oldest first.
AEListAspect name of object containing an Alarm and Event List Aspect. The first
one is used to specify filter and attribute selections.
MaxRows Optional maximum number of rows to populate - overrides what is
specified on Alarm and Event List Configuration aspect.
Timeout Optional parameter is used to specify maximum seconds to wait for
response. This defaults to the Timeout specified on the Setup tab of
the Data Direct Options dialog. Refer to Setup on page 249.
on page 69.
3BUF001094-600 B 133
134 3BUF001094-600 B
5 DataDirect Inform IT 5.1 User Access to DataDirect Inform IT Add-
5 DataDirect Inform IT
The Inform IT dialogs and functions are used on remote computer clients that do not
have the base software installed.
5.1 User Access to DataDirect Inform IT Add-in Tools

Add-in tools must be explicitly added for users who will be using DataDirect without
installing 800xA software.
5.2 Populating Pick Lists for Data Retrieval/Entry Di-

alogs
For data points that exist outside the 800xA System, text files must be configured to
populate object type, object, and attribute pick lists in these dialogs. This procedure
is described in Configuring Pick Lists for Advant OCS Objects on page 258.
5.3 Data Access Methods

DataDirect supports access to:
• Process, historical, and softpoint data from aspect objects in the 800xA System.
• Production Data Logs (PDLs) for Batch Management, Profile Historian, TCL,
and Batch 300 applications.
• Ad-hoc SQL queries without the use of SQL*NET or ODBC drivers.
• Process and historical data from ABB OCS databases.
• Messages from DCS message logs on earlier Enterprise historian platforms.
• TCL arrays.
InformIT Datadirect provides both interactive dialogs and programmable functions
for integrating data into an Excel spreadsheet. Some dialogs and functions also support
3BUF001094-600 B 135
5 DataDirect Inform IT 5.3 Data Access Methods
writing to process and history objects. User authority must be properly configured to
support write transactions.
The interactive dialogs, such as the one shown in Figure 5.1, help when generating
and executing data queries. They are generally intended for on-demand (one-time)
data access functions, although some dialogs are used to generate re-usable function
calls.
DataDirect functions may be used to create re-executable reports with Microsoft Excel,
Figure 5.2. The functions provide the same data retrieval capabilities as the dialogs,
except that the functions can be re-executed by running the spreadsheet. The results
can be saved, archived, printed and then rerun. For further information refer to (give
the new link).
The DataDirect functions can be embedded in VBA macros, as an alternative to in-
serting them directly in an Excel spreadsheet. By embedding the functions in the
macros, they are not automatically executed when the spreadsheet is opened. This
allows reports to be archived. In addition, these reports can be distributed to Excel
users that do not have DataDirect.
136 3BUF001094-600 B
5 DataDirect Inform IT 5.3 Data Access Methods
Figure 5.1: Example DataDirect Dialog (PPA Process Values)
3BUF001094-600 B 137
5 DataDirect Inform IT 5.4 Licensing
Figure 5.2: Example, DataDirect Function in an Excel Spreadsheet
5.4 Licensing
InformIT Datadirect is licensed on a concurrent-user basis. InformIT Datadirect can
be installed on many computers and the server will control the number of clients that
may connect to the server based on the number of client licenses purchased. For ex-
ample, if InformIT Datadirect is installed on ten computers, but only two licenses are
purchased, then only two client computers will be permitted to connect to the server
at any one time.
For DataDirect, each open dialog occupies a client license, even if the dialogs are
open on the same computer. Thus one computer may occupy two or more client li-
censes concurrently. Installing and managing licenses is a system installation activity.
138 3BUF001094-600 B
5 DataDirect Inform IT 5.5 Login
5.5 Login
To obtain a runtime license, log on to a data server. The login procedure connects the
Excel spreadsheet to a specified host data server for all dialogs.
One runtime license is taken up for each user that logs in to the data server. DataDirect
provides two methods for logging in to support license use.
• log in on an ad-hoc basis. Automatically disconnects when the current dialog is
closed to help minimize the time that a runtime license is occupied.
• log in on a perpetual basis. Stays logged in until you choose to log off regardless
of how many dialogs are opened and closed.
Add-in tools are embedded in Excel on a user basis. By default, the DataDirect
add-in tools are available for the user that installed DataDirect software. A different
user will be required to add the add-in tools for that user. Refer to Manually Adding
the DataDirect Add-in on page 53.
5.5.1 Perpetual Login

Perpetual login lasts until an active choice is made to disconnect from the host server.
This is used to invoke any number of ad-hoc data requests or function calls without
having to repeat the log in procedure after each request. However, this occupies the
runtime license while logged in. Use a perpetual log in when working with DataDirect
functions. To log in perpetually, click the ABB button, Figure 5.3, or choose
DataDirect InformIT> Login from the menu bar. Log in as described under Using
the Login Dialog on page 140. To disconnect from the data server, press the Disconnect
button in the Login dialog, or exit Excel.
Figure 5.3: Login Button
5.5.2 Login As Needed for Ad-hoc Data Requests

Not logging in prior to using a data retrieval/entry dialog, causes the login dialog to
display each time one of the dialogs is used. Log in, as described under Using the
Login Dialog on page 140. Automatic log off happens when the current data retrieval/en-
3BUF001094-600 B 139
5 DataDirect Inform IT 5.5 Login
try dialog is closed. This method minimizes the time that the runtime license is occu-
pied.
The ad-hoc log-in method cannot be used for executing DataDirect function calls.
Attempting to run a DataDirect function call without login will display the login dialog.
Be sure to log in perpetually in this case.
5.5.3 Using the Login Dialog

To display the login dialog, Figure 5.4, click the ABB button, or choose DataDirect
InformIT > Login from the menu bar. This results in a Perpetual Login. The dialog
is also displayed when opening a data retrieval/entry dialog without being logged in.
This is used to Login As Needed for Ad-hoc Data Requests.
After Connection
Before Connection
Figure 5.4: Login Dialog
All data retrieval/entry dialogs have a plug icon located in the bottom right corner.
This icon is used to display the Login dialog without having to close the current data
retrieval dialog. Simply double-click the icon to display the Login dialog.
To log in, enter your User name, Password, and Host name. Check the Save Settings
option to save these login parameters and automatically have them entered on the
next log in. Click Connect when finished.
5.5.4 User
Enter the user name for the host data server as defined during the IM configurations.
User names are case-sensitive.
140 3BUF001094-600 B
5 DataDirect Inform IT 5.6 Reading and Writing Process Values For I
5.5.5 Password
Enter the password for the specified user as defined during the IM configurations.
5.5.6 Host
The Host specification is used in two different ways, depending on whether the Indus-
trial IT version of the Process and History Values dialogs (and equivalent functions),
or any other dialog (or their equivalent functions) are being used.
For the Industrial IT version of the Process and History Values dialogs (and equivalent
functions), the Host specification is used to obtain a runtime license from a specified
data server.
For all other dialogs (and their equivalent functions), in addition to obtaining the li-
cense, the Host specification also connects the spreadsheet to the specified data
server allowing data access from that server and only that server.
To specify the host, enter the computer name for the computer where the display
server software is installed. Look up the computer name using the Network Identifi-
cation information on the System Properties dialog in the Control Panel. The host
server IP address can be used instead of the computer name.
5.5.7 Save Settings

When this option is selected, your user name, password, and host specification are
saved and do not have to be re-entered on the next log in. The data server name and
user ID are indicated in the status bar. Also, when Save Settings is selected, log in
remains until the Disconnect button is clicked in the Login dialog, or Excel is exited.
5.6 Reading and Writing Process Values For Inform

IT
DataDirect Inform IT provides dialogs for reading and writing real-time process values.
If DataDirect is run on a computer that does not have 800xA base system software
(a remote Desktop Tools client), then use the Inform IT version of the Process Values
dialog to query aspect objects in the 800xA System. The Inform IT dialog may be
used on 800xA System nodes when connecting the dialog to a server that is outside
the 800xA System, for example an earlier Enterprise Historian server. This is used
3BUF001094-600 B 141
5 DataDirect Inform IT 5.7 Using the Inform IT Process Values Dialo
to query objects on that server that are not a part of the 800xA System. This function-
ality is not supported by the Industrial IT version.
generally recommended to use it rather than the Inform IT version. The System 800xA
version provides browsing tools that more closely resemble the Plant Explorer and
make it easier to find the applicable objects for querying.
The toolbar icons for the Inform IT icon is blue, Figure 5.5. If an icon is not available
on the tool bar, use the View tab on the Options dialog to make it available. Refer to
View on page 243.
Figure 5.5: Inform IT Process Value Icons
5.7 Using the Inform IT Process Values Dialog

The Inform IT Process Values dialog, Figure 5.6, is required when DataDirect is
running on a computer client that does not have 800xA base software installed, or
when objects need to be queried outside the 800xA System.
142 3BUF001094-600 B
Figure 5.6: Process Values Dialog
With proper authority, process values can be updated. The Update Process Values
tab is not shown unless the Allow Process Updates option is selected through the
Setup tab on the Options dialog (refer to Setup on page 249), and a user log in to
DataDirect is made with authority to update process values. Refer to User Authority
on page 149. Also, the tab may be visible, but not active unless the Use Channel
Numbers option is deactivated through the Setup tab on the Options dialog (refer to
Setup on page 249).
When using this dialog, the F9 function can not be used to re-calculate the work-
book and retrieve new data. To create a workbook that can be re-calculated on-
demand for reporting purposes, use DataDirect functions as described in Config-
uring Options on page 238.
3BUF001094-600 B 143
Follow these basic steps to access process values with this dialog:
1. Select the spreadsheet cell which will be the starting point for inserting data.
2. Use the menu or tool bar to open the Inform IT Process Values dialog. Either
click the Process Value button in the tool bar, or choose
DataDirect Inform IT > Process Values from the menu bar, Figure 5.7.
If the menu option and/or tool bar icon for this dialog are not visible, use the
View tab on the Options dialog to make them visible. Refer to View on page
243.
3. To query process tags for data retrieval, refer to Reading Process Values on page
144 or refer to User Tag Management (UTM) on page 513. To update the process
values for tags, refer to Writing Process Values on page 149.
5.7.1 Reading Process Values

Follow these steps to retrieve process values. Further details for each step, and other
optional procedures are provided in the sections referenced below. Basic steps:
2. Select the objects whose process values will be retrieved.
Only press Apply or OK once. Wait for the process values to be returned before
attempting to retrieve additional values. Pressing the button multiple times can
result in software failure.
144 3BUF001094-600 B
For further details regarding these basic steps and other optional procedures refer to:
• Selecting Objects to Query on page 145.
5.7.2 Selecting Objects to Query

The method for selecting which objects to query differs depending on the selected
object type. When selecting the OPC object type, an OPC browser dialog is provided.
Refer to Selecting OPC Tags on page 145. For all other object types, use the applicable
pick lists as described in Selecting ABB OCS Tags on page 146. This requires the
corresponding text files to be configured as described in Configuring Pick Lists for
Advant OCS Objects on page 258. Also, refer to User Tag Management (UTM) on
page 513 for selecting system as well as public and private groupings of tags.
5.7.3 Selecting OPC Tags

When the selected object type is OPC, the Process Values dialog, Figure 5.6, provides
a dialog for browsing OPC objects on the connected OPC server. By selecting OPC
in the Object Type pull-down list, the Select Objects area of the display becomes an
OPC Browser. Use the browser to find and select the OPC tag.
By default DataDirect is connected to the 800xA OPC DA server which provides
access to real-time process and softpoint objects in the 800xA aspect system. If
this connection needs to be changed, click the Options button and refer to Data
Provider Connections on page 251.
Use the left pane to browse the server directory structure to find the folder(s) where
the objects reside. Supported methods for browsing the directory structure are:
• Basic point and click to show the contents of a specific folder.
• Select a folder then choose Get Entire List from the context menu. This shows
all applicable objects in the selected folder as well as objects from all sub-folders
within the selected folder.
• Apply a filter to either show or exclude all objects whose name has a specified
text string.
3BUF001094-600 B 145
Select one or more objects from the right pane. Click OK when finished. This executes
the query and puts the requested data in the spreadsheet. The selected object list can
also be copied to the clipboard to use (paste) in another application.
For further guidelines on using this tool, refer to Using the Information Management
5.7.4 Selecting ABB OCS Tags

To access real-time data for ABB OCS (Enterprise Historian) process tags, specify
the object and attribute names using the corresponding pick lists. It may also be re-
quired to select the object type. These pick lists are populated by text files specified
through the Options dialog File Setup tab (refer to File Setup on page 254). The con-
tents of the Select Object pick list is determined by the Select Object File specifica-
tion, and the Object Type specification (if necessary), Figure 5.8.
Figure 5.8: Selecting ABB OCS Objects
To change the contents of the Select Objects pick list, click the Browse button to
change the file specified in the Select Object File field. The object text file provides
the object names for the Select Object pick list.
Several object files are provided with DataDirect as standard. Additional object files
can be created to customize object selection for the application. For details, refer to
Configuring Pick Lists for Advant OCS Objects on page 258. This text file may be
configured with or without object type specifications for the object names. If object
types are not specified in the text file, then the entire contents of the text file will be
available in the Select Object pick list. If object types are included in the specification,
146 3BUF001094-600 B
then select the Object Type to make objects of that type available in the Select Object
pick list. The following instructions are only applicable for selecting ABB OCS tags.
Ignore these sections when selecting OPC tags:
Selecting the Object Type
Selecting Object Attributes
Adding New Items to the Object and Attribute Pick Lists
Selecting the Object Type

This section describes how to select the object type for ABB OCS (MOD 300 or
Master) tags. For OPC tags, select the OPC object type, and then refer to Selecting
OPC Tags on page 145.
Objects (tags) are organized in the ABB OCS database by object type. The object
type represents a class of objects that have a common set of object attributes, for ex-
ample, CCF_PID_LOOP for systems with MOD 300 software, or PIDCON for systems
with Master software.
Whether or not object type is specified, depends on how the object text file is config-
ured. If object types are associated with objects, then use the Object Type pick list,
Figure 5.9, to specify the object type. If object types are not specified, then all objects
will be available in the list, regardless of the object type.
Figure 5.9: Selecting the Object Type
This populates the Object and Attribute pick lists with the object and attribute names
corresponding to the selected object type. For example, Figure 5.10 shows the Select
Objects and Select Attributes pick lists populated according to the CCF_PID_LOOP
object type.
3BUF001094-600 B 147
Selecting Object Attributes

ABB OCS objects require specifying the attribute(s) to query. Select any number of
objects and attributes from their respective pick lists:
• To select one item at a time, click on the corresponding line.
• To select multiple contiguous items, click on the first item, hold down the SHIFT
key, and then click on the last item.
• To select multiple items that are not contiguous, hold down the CTRL key and
click on the items.
Use the up and down arrows next to the pick lists to adjust the object and attribute
presentation order, Figure 5.10.
Figure 5.10: Selecting Objects and Attributes
Adding New Items to the Object and Attribute Pick Lists

The text files for the object and attribute pick lists may occasionally require additions.
For instance, when a new object is added to the ABB OCS database it may not be
added to the object text file. Similarly, the attribute text file may not include seldom-
used attributes.
Use the New Process Object and New Object Attribute fields to add new items to
their respective pick lists, Figure 5.11 and remove items from the pick lists. To add
a new item to one of these pick lists, enter the tag name for the new item, and then
click the < (Add) button. This adds the new item to the top of the list and automati-
148 3BUF001094-600 B
cally selects it. Previously selected items will remain selected. To remove an item,
select the item and click the > (Remove) button.
These additions and deletions are only applicable as long as the dialog remains
open. Tags are neither added to, nor removed from the actual object text file.
Figure 5.11: Adding a New Item
5.7.5 Writing Process Values
User Authority
The proper user authority is required to update process values. This is controlled at
three levels - data server, DataDirect client, and user:
• At the DataDirect client level, the Allow Process Updates option must be checked
on the Setup tab of the Options dialog. Also, log on to the computer as an Admin-
istrator-level user to change these settings. Refer to Enable/Disable Write Access
to History and Process Values on page 253.
• At the data server level, the applicable data provider must be configured to allow
write transactions. This is the default set-up. To verify this set-up, refer to con-
figuring data access for display and client services in Information Management
configuration.
• On the user level, the user who logs onto the data server (DataDirect Log-in dia-
log) must be authorized to write to process objects. This is configured in the user
preference file. By default, users are NOT granted this authority. Adjust this
preference for a user when managing Information Management users during
configuration.
This function does not recognize data providers by channel number, but rather by
the -name argument. Therefore the Use Channel Numbers option in the Options
dialog Setup tab must be DEACTIVATED (not selected). Refer to Setup on page
249.
3BUF001094-600 B 149
Update Process Values Tab

To update the value for a process tag:
1. Either click the Process value button, or choose
DataDirect Inform IT >Process Values from the menu bar, Figure 5.7.
2. Click the Update Process Values tab. This displays the controls for updating
process values for one or more process tags, Figure 5.12.
Figure 5.12: Update Process Value Tab
Basically, this procedure requires building process value update specifications for
one or more tags, add these specifications to a list, and then apply the list. Also, it is
recommended that results of the update operation be output to a spreadsheet. This
gives a permanent record of the update operation.
150 3BUF001094-600 B
This display supports four methods for building the tag update list - one for OPC tags
and three for ABB OCS tags (Enterprise Historian platform). Refer to the applicable
instructions below:
• Updating OPC Tags.
• Updating ABB OCS tags on an Enterprise Historian platform:
– Building an Ad-hoc List.
– Importing a Formatted Range of Cells from a Spreadsheet. This requires
having a properly formatted range of tag update specifications within the
Excel spreadsheet.
– Importing Non-formatted Ranges of Cells from a Spreadsheet.
For ABB OCS tags, it is recommended to start with Building an Ad-hoc List. This
describes the procedure in depth. Some of the steps from this procedure are used
in the other methods, but are not covered in the same detail.
Updating OPC Tags

Use the Information Management Browser to select one OPC tag at a time. To do
this:
1. Select OPC in the Object Type pull-down list, Figure 5.13.
Figure 5.13: Selecting the OPC Object Type
3BUF001094-600 B 151
This displays a Browse button and two corresponding fields as shown in Figure
5.14.
Figure 5.14: OPC Tag Update Controls
2. Click Browse to launch the Information Management Browser, then use the
browser to find and select the OPC tag, Figure 5.15.
a. Use the left pane to browse the server directory structure to find the folder(s)
where the objects reside. The following methods are supported for browsing
the directory structure:
• Point and click to show the contents of a specific folder.
• Select a folder then choose Get Entire List from the context menu.
This shows all applicable objects in the selected folder as well as objects
from all sub-folders within the selected folder.
• Apply a filter to either show or exclude all objects whose name has a
specified text string.
i. Select an object from the right pane. Click OK when finished. The
full path to the selected tag is displayed in the Selected Tag field.
Refer to Using the Information Management Browser on page 237
for additional information.
152 3BUF001094-600 B
Figure 5.15: Browsing for the OPC Tag
3. Enter the tag value in the Value field.

4. When satisfied with the tag specification, click the Add to List button. This adds
the specification to the Preview Selected Updates list, Figure 5.16.
Figure 5.16: Preview Selected Updates List
Continue adding OPC tags to the list as required. To do this, repeat steps 2-4.
5. Make adjustments to the list if necessary. To edit a specification, select it from
the list, then click Edit. This removes the specification from the Selected Updates
list and puts it back in the Selected Tag and Value fields above. Edit the informa-
tion as required, and then click Add to List. The edited specification is placed
at the bottom of the list.
To remove a specification, select the specification in the list, and then click Re-
move From List. If only one row is selected, the row will be deleted immediately.
3BUF001094-600 B 153
If more than one row is selected, confirm whether or not to remove ALL selected
rows. Click Yes to confirm, or No to cancel the remove operation.
6. When ready to apply the updates to their respective tags, click Apply. This adds
two columns to the preview list: Updated and Error Message. These columns
indicate the status of each update, Figure 5.17.
Figure 5.17: Send Updates Result
7. It is recommended that a permanent record of this update operation be made by

recording the results in a spreadsheet. Refer to Recording the Output Results on
page 162.
Building an Ad-hoc List

This procedure is similar to building a data retrieval query as described in Reading
Process Values on page 144.
1. Use the Select Object File field, if necessary, to change the text file for the Object
pick list.
2. Select the applicable object type from the pull-down list, Figure 5.18.
154 3BUF001094-600 B
Figure 5.18: Selecting the Object Type
3. Select the object name and attribute name from their respective lists, Figure 5.19.
Figure 5.19: Selecting the Object and Attribute
4. Enter the value as shown in Figure 5.20.
Figure 5.20: Specifying the Tag Value
DO NOT check the Use Spreadsheet for Input check box.
3BUF001094-600 B 155
5. When satisfied with the tag specification, click the Add to List button. This adds
6. Continue adding tag specifications as required. To do this repeat steps 1-5.

7. Make adjustments to the list if necessary. To edit a specification, select it from
the list, then click Edit. This removes the specification from the list and puts it
back in the ad-hoc pick lists above. Edit the information as required, and then
click Add to List. The edited specification is placed at the bottom of the list.
If more than one row is selected, confirm whether or not to remove ALL selected
rows. Click Yes to confirm, or No to cancel the remove operation.
8. When ready to apply the updates to their respective tags, click Apply. This adds
two columns to the preview list: Updated and Error Message. These columns
indicate the status of each update, Figure 5.22.
156 3BUF001094-600 B
9. It is recommended that a permanent record of this update operation be made by

recording the results in a spreadsheet. Refer to Recording the Output Results on
page 162.
Importing a Formatted Range of Cells from a Spreadsheet

This procedure is used to import a formatted range of tag update specifications from
a spreadsheet. Each specification in the range must be formatted as a row with the
following columns in this exact order: Object, Attribute, Value, Object Type.
To import tag update specifications from a formatted range spreadsheet:
This disables the fields for specifying ad-hoc tag updates. The Select Formatted
Range option is selected, and the Formatted Range field is enabled.
2. Enter the range of cells to import in the Formatted Range field. Enter the range
directly, or click the button to collapse the Update Process Values dialog, Figure
5.24, and then select the range directly in the spreadsheet.
Figure 5.24: Collapsing the Process Values Dialog
3BUF001094-600 B 157
Do not select multiple single cells in the spreadsheet using the Ctrl key as it will
cause an error message to appear when the Add to List button is clicked in the
Inform IT Process Values dialog box.
An example is shown in Figure 5.25.
Formatted Range Selected
Click Here to Restore
Figure 5.25: Selecting a Formatted Range of Cells
3. With the selected range indicated in the Formatted Range field, Figure 5.26, click
the Add to List button.
Figure 5.26: Selecting the Starting Cell for a Formatted Range
This adds the update specifications to the Selected Updates list, Figure 5.27.
158 3BUF001094-600 B
4. Continue adding specifications as required by repeating steps 2 and 3.

5. Remove specifications from the list if necessary. To do this, select the specifica-
tion in the list, and then click Remove From List. The specifications cannot be
edited.
6. When ready to apply the updates to History, click Apply. This adds two columns
to the preview list: Updated and Error Message. These columns indicate the status
of each update, Figure 5.28.
Figure 5.28: Updates Sent for Formatted Range
7. Make a permanent record of this update operation. To do this, click the Output
Results button and specify the starting cell where the tag updates will be inserted.
For details refer to Recording the Output Results on page 162.
3BUF001094-600 B 159
Importing a Non-formatted Range of Cells from a Spreadsheet

Use this method when the required information is available from a spreadsheet;
however, the range is not properly formatted. An example is shown in Figure 5.29.
Figure 5.29: Unformatted, Non-contiguous Ranges
To import tag update specifications from non-formatted ranges in a spreadsheet:

1. Click the Use Spreadsheet for Input check box. This disables the fields for
specifying individual tag updates. The Select Formatted Range option is selected
by default, and the Formatted Range field is enabled.
2. Click the Select Individual Ranges from Spreadsheet check box. This unselects
the Select Formatted Range option and the heading for the Formatted Range
changes to Object Types Range. Also, the fields for Objects Range, Attributes
Range, and Values Range are enabled, Figure 5.30.
Figure 5.30: Select Individual Ranges From Spreadsheet
3. Enter the range of cells for one or more of the four categories in their respective
fields. The operation of these fields is similar to the procedure for Importing a
160 3BUF001094-600 B
Formatted Range of Cells from a Spreadsheet. The only difference is that each
range must be selected individually. An example is shown in Figure 5.31.
Do not select multiple single cells in the spreadsheet using the Ctrl key as it will
cause an error message to appear when the Add to List button is clicked in the
Inform IT Process Values dialog box.
Figure 5.31: Selecting Unformatted Ranges
4. With the selected range indicated in the Formatted Range field, click the Add
to List button. This adds the update specifications to the Selected Updates list,
Figure 5.32.
Figure 5.32: Adding Unformatted Ranges to the List
5. Continue adding unformatted ranges to the list. To add another specification,

repeat steps 3 and 4.
3BUF001094-600 B 161
6. Remove specifications from the list if necessary. To remove a specification, select

the specification in the list, and then click Remove From List. These specifica-
tions cannot be edited.
7. When ready to apply the updates, click Apply. This adds to columns to the pre-
view list: Updated and Error Message. These columns indicate the status of each
update, Figure 5.33.
Figure 5.33: Updates Sent for Unformatted Range
8. Make a permanent record of this update operation. To do this, click the Output
Results button and specify the starting cell where the tag updates will be inserted.
For details refer to Recording the Output Results on page 162.
Recording the Output Results

Make a permanent record of the update operation by inserting the output results in
the spreadsheet.
To do this:
1. Click the Output Results button. This displays a dialog for specifying the starting
cell where the tag update records will be inserted.
2. To specify the starting cell, either enter the column/row specification directly in
the dialog, or use the corresponding button to collapse the Select Start Cell dialog.
This returns focus to the spreadsheet in order to select a cell, Figure 5.34.
162 3BUF001094-600 B
Click Here to Collapse this

Dialog and Return Focus to
the Spreadsheet
Selected Cell
Figure 5.34: Collapsing Select Start Cell Dialog
After selecting the start cell, click the restore button (red dot) to restore the dialog,
Figure 5.35.
Click Here to Restore
Figure 5.35: Indication of Selected Starting Cell
3. If the cell specification is entered directly, the syntax is ColumnLetterRowNumber.

For example A1 is the first row in the first column, Figure 5.36.
3BUF001094-600 B 163
5 DataDirect Inform IT 5.8 Reading/Writing History Data
Figure 5.36: Select Start Cell Dialog
The orientation of the data is set through the Data Format tab in the Options dia-
log. Display the options dialog by clicking the Options button in the Starting
Cell dialog. For details on using the Options dialog, refer to Configuring Options
on page 238.
The Insert check box is used to insert a new row or rows of data in the spreadsheet
without overwriting any existing data. When Insert is selected, existing rows are
moved down as required to make room for the new data. If this check box is not
selected, any existing cells may be overwritten by new data.
4. Click OK when finished. This inserts the tag update records in the spreadsheet,
Figure 5.37.
Figure 5.37: Output Results Inserted
5.8 Reading/Writing History Data

DataDirect Inform IT provides dialogs for reading and writing numeric history data.
When running DataDirect on a computer that does not have 800xA base system
software (a remote Desktop Tools client), use the Inform IT version of the History
Values dialog to query aspect objects in the 800xA System. The Inform IT dialog
may be used on 800xA System nodes when connecting the dialog to a server that is
outside the 800xA System, for example an earlier Enterprise Historian server. This
164 3BUF001094-600 B
5 DataDirect Inform IT 5.9 Using the Inform IT History Values Dialo
is used to query objects on that server that are not a part of the 800xA System. This
functionality is not supported by the Industrial IT version.
generally recommended that it be used rather than the Inform IT version. The System
800xA version provides browsing tools that more closely resemble the Plant Explorer
and make it easier to find the applicable objects for querying.
The toolbar icons for the Inform IT icon is blue, Figure 5.38. If an icon is not available
View on page 243.
Figure 5.38: Inform IT History Value Icons
Refer the section below for instructions on using the appropriate dialog:
5.9 Using the Inform IT History Values Dialog

The Inform IT History Values dialog, Figure 5.39, is required when running
DataDirect on a computer client that does not have 800xA base software installed,
or when objects need to be queried outside the 800xA System.
3BUF001094-600 B 165
Figure 5.39: History Values Dialog
The Add/Modify tab is not shown unless:

• The Allow History Updates option is selected through the Setup tab on the Options
dialog. Refer to Enable/Disable Write Access to History and Process Values on
page 253.
• A user with update history authority logs in to DataDirect.
Also, the tab will be visible, but not active unless the Use Channel Numbers option
is deactivated through the Setup tab on the Options dialog (Setup on page 249).
When this dialog is used, the F9 function can not be used to re-calculate the
workbook and retrieve new data. To create a workbook that can be re-calculated
on-demand for reporting purposes, use DataDirect functions as described in Con-
figuring Options on page 238.
Follow these basic steps to access history values with this dialog:
166 3BUF001094-600 B
1. Select the range of cells in the spreadsheet which will be the starting point for
inserting data.
2. Use the menu or tool bar to open the Inform IT History Values dialog.
Either click the Process Value button in the tool bar, or choose
DataDirect Inform IT > History Values from the menu bar, Figure 5.40.
243.
3. To retrieve historical data, refer to Retrieving History Data on page 167. Also,
refer to User Tag Management (UTM) on page 513 for selecting system as well
as public and private groupings of tags.
To add/modify lab data log entries, refer to Adding/Modifying Entries for a Lab
Data Log on page 177.
5.9.1 Retrieving History Data

Follow these basic steps to retrieve history values with this dialog. Further details for
each step, and other optional procedures are provided in the section referenced below.
Basic steps:
1. Select the appropriate data provider.
2. Specify whether to retrieve raw or interpolated data.
3BUF001094-600 B 167
4. Select the property logs whose values are to be seen.
5. A calculation algorithm (aggregate) may be selected to apply to the data when
it is retrieved. The default is to apply no calculation.
6. Specify the maximum number of value to return. The default is 500.
7. The time range may be adjusted. The default time span is 24 hours from the
current time. Also, to add a millisecond column, check Include Milliseconds.
For further details regarding these basic steps and other optional procedures refer to:
• Selecting the Data Provider on page 168.
• Retrieval Type on page 169.
• Selecting History Objects on page 170.
• Log Calculation Algorithm on page 172.
• Number of Values on page 176.
• Date and Time on page 62.
• Changing the Output Options on page 176.
5.9.2 Selecting the Data Provider

The data provider must be specified to use for historical data access. The choices are:
• AIPHDA (Default) - for access through the 800xA OPC HDA server. This sup-
ports seamless access to both trend logs and history logs. This also supports access
to log attributes.
• IMHDA - an alternative OPC HDA server that is typically not used. Refer to
Appendix C.
168 3BUF001094-600 B
• LOG - for ABB OCS logs (Enterprise Historian version 3.2/1 or earlier).
This specification is made through the LOG/HDA data provider setting on the Setup
tab on the Options dialog. Click Options to display the Options dialog. Then click
the Setup tab and check the LOG/HDA data provider setting, Figure 5.41.
Figure 5.41: Selecting the AIPHDA Data Provider
5.9.3 Retrieval Type

The History Values dialog is used to select one of these retrieval types: Trend Display,
Interpolated Data, Modified Data, or Raw Data. Select the retrieval type by clicking
the corresponding option button.
Trend Display
This displays the requested data on the Desktop Trend display. The Desktop Trends
option must be installed. Refer to Desktop Trends Operation for instructions on using
the Desktop Trend Display.
Interpolated Data
This returns values at regular intervals. Always specify the time range and number
of values to return. This divides the time range into discrete intervals for which data
values are returned. For example, if the time range is 24 hours and the number of
values to return is 1440, a value will be provided for each one-minute interval. The
values are not actual samples, but rather values interpolated from the actual samples.
3BUF001094-600 B 169
Modified Data
Modified data can be selected when the history log type retains the original data when
modified data is written and when the IMHDA data provider is used.
Raw Data
This returns values for actual samples collected and stored by History. Always spec-
ify a time range. Values are only returned for times when samples were collected and
stored. The query will return all values up to the quantity specified in the Number of
Values field (3200 maximum). For example, if the time range is 24 hours and the
number of values to return is 300 or greater, for a log with a five-minute storage rate,
288 values will be returned.
5.9.4 Selecting History Objects

Use the Select History Objects section to select the logs that have data being retrieved.
The operation of this section differs, depending on the connected LOG/HDA data
provider (Selecting the Data Provider on page 168). For operating instructions based
on the selected data provider, refer to:
• Accessing Property Logs through OPC HDA below.
• ABB OCS (Enterprise Historian Platform) History Access on page 172.
Also, refer to User Tag Management (UTM) on page 513 for selecting system as well
as public and private groupings of tags.
Accessing Property Logs through OPC HDA

When connected to an OPC HDA server, for example through the AIPHDA data
provider or IMHDA data provider, the Select History Objects section provides a dialog
for browsing property logs on the connected OPC server, Figure 5.42. Use the left
pane to browse the server directory structure to find the folder(s) where property log
objects reside, then select one or more objects from the right pane.
The contents of the left pane varies, depending on the type of OPC HDA server. For
AIPHDA, the browser provides a directory structure similar to the Plant Explorer.
All locations where log aspects reside are available to search. For IMHDA, the left
pane is used to choose one of three methods the search can be conducted: EH for local
access, EH_PUBL for published archived log data, and EH_NET for network-wide
access (LOGMAN is not applicable).
170 3BUF001094-600 B
or AIPHDA
View for IMHDA
Figure 5.42: Browsing for Property Logs
These same browsing methods are supported whether the AIPHDA or IMHDA data
provider is used:
• Basic point and click to show the logs within a specific folder.
• Select a folder then choose Get Entire List from the context menu. This shows
all logs in the selected folder as well as logs from all sub-folders within the se-
lected folder.
• Apply a filter to either show or exclude all logs whose name has a specified text
string.
• With AIPHDA, the Seamless retrieval option can be used when it is uncertain
which component log within the property log will provide best coverage of the
requested time range.
Select one or more logs from the right pane. Click OK when finished. This executes
the query and puts the requested data in the spreadsheet. The selected object list can
also be copied to the clipboard to use (paste) in another application.
For further guidelines on using this tool, refer to Using the Information Management
3BUF001094-600 B 171
ABB OCS (Enterprise Historian Platform) History Access

When accessing history data from an Enterprise Historian platform through the LOG
data provider, the object list in the Select History Objects section is populated accord-
ing to the text file specified in the Select History Object File field, Figure 5.43. To
select a different text file, click the button to display a standard Windows file chooser
dialog.
Figure 5.43: Select History Objects List
Any number of objects can be selected from the list of available objects:
• To select one item at a time, click on the corresponding line.
• To select multiple contiguous items, click on the first item, hold down the SHIFT
key, and then click on the last item.
• To select multiple items that are not contiguous, hold down the CTRL key and
click on the items.
The New History Object field is used to add new History objects to the object list.
Objects can also be removed. To add a new object, enter the name of the new history
object and then click the < (Add) button. This adds the new object to the top of the
list and automatically selects it. Previously selected objects will remain selected. To
remove an object, select the object and click the > (Remove) button.
Add/remove operations neither add to, nor remove from the current History object
text file. However, the changes can be saved to a new text file by clicking the Save
File button.
5.9.5 Log Calculation Algorithm

When the Retrieval Type is Interpolated, this pull-down list can be used to select a
calculation to apply to the history data being retrieved. This list is not available when
172 3BUF001094-600 B
the Retrieval Type is Raw. This list has two modes of operation depending on whether
history data is being retrieved from an OPC HDA Server, or from an Enterprise His-
torian server version 3.2/1 or earlier.
Log Calculation for OPC HDA Server

When DataDirect is connected to an OPC HDA server, the pull-down list for Log
Calculation Algorithms is based on the specific connected OPC HDA server. The
implementation of these calculations is server dependent.
The default OPC HDA server is the 800xA OPC HDA server which is connected
through the AIPHDA data provider. Figure 5.44 shows the list of calculation types
for this server. These calculation types are described in Table 5.1.
The calculation options for the IMHDA server are listed in Table 5.2.
The selected calculation is performed on the data stored in the log with data retrieved.
The requested time range for which data will be retrieved is divided into resample
intervals. For example, if the requested time range is 24 hours and the requested
number of values to return is 1440, the resample interval is one minute (24 hours =
1440 minutes, 1440 minutes/1440 values = 1 value per minute). In this case, the cal-
culation will be performed on the values stored in the log for each one-minute interval.
All time stamps returned are those of the beginning of the resample interval except
for those calculations which explicitly state otherwise.
Figure 5.44: Log Calculation Algorithm List for AIPHDA
Interpolated Linear interpolation (no calculation).
Total Totalized value (time integral) of data over the resample interval.
3BUF001094-600 B 173

(Continued)
Average Average value for data over the resample interval.
Timeaverage Time weighted average for data over the resample interval.
Count Number of raw values over the resample interval.
Standard Deviation Standard deviation over the resample interval.
Minimum Actual Time Minimum value in the resample interval and the timestamp of the minimum
value.
Minimum Minimum value in the resample interval.
Maximum Maximum value in the resample interval.
Start Raw value at the beginning of the resample interval. The time stamp is
the time stamp of the beginning of the interval.
End Raw value at the end of the resample interval. The time stamp is the time
stamp of the end of the interval.
Delta Difference between the first and last value in the resample interval.
Regression Slope Slope of the regression line over the resample interval.
Regression Const Intercept of the regression line over the resample interval. This is the
value of the regression line at the start of the interval.
Regression Deviation Standard deviation of the regression line over the resample interval.
Variance Variance over the resample interval.
Range Difference between the minimum and maximum value over the resample
interval.
Duration Good Duration (in seconds) in the resample interval during which the data is
good.
Duration Bad Duration (in seconds) in the resample interval during which the data is
bad.
Percentage Good Percentage of data in the resample interval which has good quality
174 3BUF001094-600 B

(Continued)
Percentage Bad Percentage of data in the resample interval which has bad quality
Worst Quality Worst quality of data in the resample interval.
Table 5.2: Calculation Options for Information Management OPC HDA Server
INTERPOLATIVE Linear interpolation (no calculation).
OPCHDA_TIMEAVERAGE Time weighted average for data over the resample interval.
OPCHDA_MINIMUM Minimum value in the resample interval.
OPCHDA_MAXIMUM Maximum value in the resample interval.
Log Calculation for Enterprise Historian 3.2/1 or Earlier (LOG)

When DataDirect is connected to an Enterprise Historian server version 3.2/1 or ear-
lier through the LOG data provider, log calculation options are as described below
and shown in Figure 5.45. In this case, the choice made in this list will cause the data
to be retrieved from the actual log in the log hierarchy that performs the selected
calculation.
Any retrieves data from log according to seamless retrieval algorithm.
When the exact log in a composite log hierarchy is not specified, this
algorithm selects the most appropriate log.
Mean retrieves data from log that calculates the mean value.
Max retrieves data from log that calculates the maximum value.
Min retrieves data from log that calculates the minimum value.
Inst retrieves data from log that stores the instantaneous value (no
calculation).
Sum retrieves data from log that calculates the sum of sampled values.
SqSum retrieves data from log that calculates the square of the sum of values.
3BUF001094-600 B 175
stclDev retrieves data from log that calculates the standard deviation.
numval retrieves data from log that calculates the number of values collected
over the storage interval.
Figure 5.45: Log Calculation Algorithm for LOG Data Provider
5.9.6 Number of Values

This pull-down list is used to specify the number of values to return. The default is
500 and the maximum is 3200. When the Retrieval Type is Interpolated, this in
combination with the Time Span for Retrieval divides the time range into discrete
intervals for which data values are returned. For the Raw Data Retrieval Type, all
data up to 3200 values can be retrieved.
5.9.7 Time Span for Retrieval

Refer to Date and Time on page 62.
5.9.8 Changing the Output Options

The following information can be specified for display as a result of a historical data
query: Headers, Tag Names, Calculation, Timestamp, or Data Quality.
The output format defaults to the settings made on the Data Format tab on the Options
dialog (Data Format on page 239). These default selections can be changed through
the Output Options tab on this dialog. Clicking the Restore Options Dialog Settings
will reset the output options to the settings on the Data Format tab.
176 3BUF001094-600 B
5.9.9 Adding/Modifying Entries for a Lab Data Log
User Authority
The proper user authority is required to add and/or modify numeric logs. This is
controlled at three levels - data server, DataDirect client, and user:
• At the DataDirect client level, the Allow History Updates option must be checked
on the Setup tab of the Options dialog. Also, log in as an Administrator-level
user to change these settings. Refer to Enable/Disable Write Access to History
and Process Values on page 253.
write transactions. This is the default set-up. Verify this set-up when configuring
data access for data providers.
• On the user level, the user logged onto the data server (DataDirect Log-in dialog)
must be authorized to write to log objects. This is configured in the user preference
file. By default, users are NOT granted this authority. Adjust this preference for
a user when managing users during Information Management configuration.
Other Considerations
• For add/modify operations, if a specific data provider needs to be referenced,
use the -name argument. Therefore the Use Channel Numbers option in the
Options dialog Setup tab must be DEACTIVATED (not selected).
• If the IMHDA OPC HDA server is being used and new log entries need to be
added, use the EH_NET option in the Information Management Browser (Using
the Information Management Browser on page 237). This option is used to mod-
ify existing log entries, and add new entries. EH supports the ability to modify
existing log entries, but not to add new entries.
Accessing the Add/Modify Tab

To Add a History value to a lab data log:
1. Click the History Values button, or choose DataDirect InformIT> History
Values from the menu bar.
2. Click the Add/Modify tab. This displays the controls for adding or modifying a
log entry, Figure 5.46.
3BUF001094-600 B 177
Figure 5.46: Add/Modify Tab
3. Click the applicable option button to specify either Add a new entry to the log,
or Modify an existing entry.
The remainder of this procedure requires building log entry update specifications,
adding these specifications to a list, and then sending the list. Also, it is recommended
that the results of the update operation be output to the spreadsheet. This provides a
permanent record of the update operation.
The dialog supports four methods for doing this - one for OPC tags and three for
ABB OCS tags as described in the applicable instructions below:
• Updating an OPC HDA Property Log.
• Updating ABB OCS (Enterprise Historian platform) logs:
– Building an Ad-hoc List.
178 3BUF001094-600 B
– Importing a Formatted Range of Cells from a Spreadsheet.

– Importing Non-formatted Ranges of Cells from a Spreadsheet.
When updating ABB OCS logs on an Enterprise Historian platform, it is recom-
mended to start with Building an Ad-hoc List. This describes the procedure in
depth. Some of the steps from this procedure are also used in the other methods,
but are not covered in the same detail.
Updating an OPC HDA Property Log

This requires an HDA type data provider to be selected on the Setup tab on the Options
dialog (for example AIPHDA). Refer to Selecting the Data Provider on page 168.
When using an HDA data provider, the History Object section of this dialog provides
controls for browsing the OPC server for property logs, Figure 5.47.
Figure 5.47: Update OPC HDA History Object
Select one property log at a time. To do this:

1. Click Browse to launch the Information Management Browser.
2. Use the browser to find and select the Property Log, Figure 5.48. Use the left
pane to browse the server directory structure to find the folder(s) where property
log objects reside, then select the object from the right pane.
The contents of the left pane varies depending on the connected data provider:
AIPHDA and IMHDA. These same browsing methods are supported whether
the AIPHDA or IMHDA data provider is being used:
• Select a folder then choose Get Entire List from the context menu. This
shows all logs in the selected folder as well as logs from all sub-folders
3BUF001094-600 B 179
• Apply a filter to either show or exclude all logs whose name has a specified
text string.
• With AIPHDA, the Seamless retrieval option is used when it is uncertain
which component log within the property log will provide best coverage of
the requested time range.
• For IMHDA, if new log entries need to be added, use the EH_NET option
in the Information Management Browser. This option is used to modify ex-
isting log entries, and add new entries. EH supports the ability to modify
existing log entries, but not to add new entries.
Information Management-based logs in the property log hierarchy that are created
after the IMHDA data provider has been started will not be available through
network-wide (EH_NET) access. In order to see these logs, either restart the
IMHDA data provider, or use local (EH) access.
For further details regarding the Information Management Browser, refer
to Using the Information Management Browser on page 237.
Figure 5.48: Browsing for the OPC Tag
3. Click OK when finished. This puts the full path to the property log in the History
Object field, Figure 5.49.
180 3BUF001094-600 B
Figure 5.49: Selected Log
4. Enter a value in the Value field.

5. Specify the date and time for the entry. When modifying an existing entry, match
the time stamp to one-second resolution. The recommended way to retrieve the
raw data for the log entry is described in Retrieving History Data on page 167 to
get the precise time stamp.
6. As an option, use the Object Status field to enter an integer value to be associated
with this log entry. For example integer values may be used to identify the user
that added/modified the entry. This value defaults to 0 (zero). It is not necessary
to change this value if this functionality is not being used. A completed specifi-
cation is shown in Figure 5.50.
Figure 5.50: Completed Property Log Update Specification
7. When satisfied with the log entry specification, click the Add to List button to
add it to the Preview Selected Updates list, Figure 5.51.
3BUF001094-600 B 181
8. Continue adding specifications to the list as required by repeating steps 1-7.

9. Make adjustments to the list if necessary. To edit a specification, select it in the
list, and then click Edit. This removes the specification from the Preview Selected
Updates list and puts it in the History Object edit fields above. Edit the information
as required, then click Add to List. The edited specification is placed at the
bottom of the list.
If more than one row is selected, a prompt to confirm whether or not to remove
ALL selected rows is made. Click Yes to confirm, or No to cancel the remove
operation.
10. When ready to apply the updates, click Apply. This adds two columns to the
preview list: Updated and Error Message. These columns indicate the status of
each update, Figure 5.56.
11. It is recommended that the update results be recorded in a spreadsheet. Refer to

Recording Output Results on page 188.
Building an Ad-hoc List

To build the log entry update list, one-specification-at-a-time:
1. Use the Select History Object File field, if necessary, to change the text file for
the History Object pick list.
2. Use the History Object pick list to select a log, Figure 5.53. Logs are listed by
their full log name as required for log editing functions.
182 3BUF001094-600 B
Figure 5.53: Select a History Object
3. Specify the date and time for the entry. When modifying an existing entry, match
the time stamp to one-second resolution. It is recommended that the raw data be
retrieved for the log entry as described in Retrieving History Data on page 167
to get the precise time stamp.
4. Enter the value as shown in Figure 5.54.
Figure 5.54: Specifying the Log Entry Value
5. As an option, use the Object Status field to enter an integer value that is to be
associated with this log entry. For example integer values may be used to identify
the user that added/modified the entry. This value defaults to 0 (zero). It is not
required to change this value if this functionality is not used.
DO NOT check either the Use Spreadsheet for Input or
Use Current Time Stamp check boxes.
6. When satisfied with the log specification, click the Add to List button. This adds
3BUF001094-600 B 183
7. Continue adding specifications to the list as required by repeating steps 1-6.

8. Make adjustments to the list if necessary. To edit a specification, select it in the
list, and then click Edit. This removes the specification from the list and puts it
in the History Object, Time Stamp, Value, and Object Status fields above. Edit
the information as required, then click Add to List. The edited specification is
placed at the bottom of the list.
If more than one row is selected, a prompt to confirm whether or not to remove
ALL selected rows is made. Click Yes to confirm, or No to cancel the remove
operation.
9. When ready to apply the updates, click Apply. This adds two columns to the
preview list: Updated and Error Message. These columns indicate the status of
each update, Figure 5.56.
184 3BUF001094-600 B
10. It is recommended that the update results be recorded in a spreadsheet. Refer to

Recording Output Results on page 188.
Importing a Formatted Range of Cells from a Spreadsheet

This procedure is used to import a formatted range of log entry update specifications
from a spreadsheet. Each specification in the range must be formatted as a row with
columns in this exact order: Object Name, Time Stamp, Value, Object Status.
To import log entry update specifications from a formatted range spreadsheet:
This disables fields for specifying ad-hoc log entry updates. The Select Formatted
Range option is selected by default, and the Formatted Range field is enabled.
2. Enter the range of cells to import in the Formatted Range field. Enter the range
directly, or click the button to collapse the Add/Modify History Values dialog,
and then select the range directly in the spreadsheet.
Do not select multiple single cells in the spreadsheet using the Ctrl key as a mes-
sage may appear indicating the need to select four columns when the Add To List
command button is clicked in the Inform IT History Values dialog box, even if
four columns are already selected.
3. With the selected range indicated in the Formatted Range field, Figure 5.58, click
the Add to List button, Figure 5.59. This adds the log entry update specifications
to the Preview Selected Updates list.
3BUF001094-600 B 185
Figure 5.58: Selecting the Starting Cell for a Formatted Range
4. Continue adding specifications to the list as required. To do this, repeat steps 2

and 3. A specification can also be removed from the list by selecting it and
clicking Remove from List. These specifications cannot be edited.
5. When ready to send the updates to History, click Apply. This adds to columns
to the preview list: Updated and Error Message. These columns indicate the status
of each update, Figure 5.60.
Figure 5.60: Updates Sent for Formatted Range
6. To make a permanent record of this update operation, refer to Recording Output

Results on page 188.
186 3BUF001094-600 B
Importing Non-formatted Ranges of Cells from a Spreadsheet

This method is used to select non-contiguous ranges of cells. There is no formatting
requirements for the ranges selected.
To import log entry update specifications from non-formatted ranges in a spreadsheet:
1. Click the Use Spreadsheet for Input check box. This disables fields for speci-
fying individual log entry updates. The Select Formatted Range option is select-
ed by default, and the Formatted Range field is enabled.
2. Click the Select Individual Ranges from Spreadsheet check box. This unselects
the Select Formatted Range option and the heading for the Formatted Range
changes to History Objects Range. Also, the fields for History Objects Range,
Time Stamps Range, Values Range, and Object Status Range are enabled, Figure
5.61.
Do not select multiple single cells in the spreadsheet using the Ctrl key as a mes-
sage may appear indicating the need to select four columns when the Add To List
command button is clicked in the Inform IT History Values dialog box, even if
four columns are already selected.
Figure 5.61: Select Individual Ranges From Spreadsheet
3. Enter the range of cells for one or more of the four categories in their respective
fields. The operation of these fields is similar to the procedure for Importing a
Formatted Range of Cells from a Spreadsheet. The only difference is that each
range must be selected individually. Click the button to minimize the dialog, and
then select the full range of cells.
Other rules are:
• Use Current Time Stamp option may also be used.
• All range input fields must have values in them.
• Blank cells at the END of a range selection are removed.
3BUF001094-600 B 187
• Blank cells WITHIN a range selection will give an error message, then al-
lowing the user to correct the selection.
• Select only ONE cell from the range input field, which will return a confir-
mation message asking the user if he chooses to use the value contained
within the single cell with the rest of the data he has selected. However, at
least one range must contain more than one cell address.
• The number of cells in each of the range selections MUST be the same as
the other range selections UNLESS only one cell was selected for one of
the range input fields, in which case the previous message will be displayed.
• Selection of more than 1 column and row at one time will give an error
message, the range selection be corrected.
• When entries are added to the Preview Selected Updates list, all date values
are formatted according to options from date/time values.
• The timestamp value must be converted to UTC time in seconds since Jan
1, 1970 (unix compatible). The microseconds value will always be set to 0.
4. To make a permanent record of this update operation, refer to Recording Output
Results on page 188.
Recording Output Results

Make a permanent record of the update operation by inserting the output results in
the spreadsheet. To do this:
1. Click the Output Results button. This displays a dialog for specifying the starting
cell where the tag update records will be inserted.
2. Specify the starting cell. Either enter the column/row specification directly in
the dialog or use the corresponding button to collapse the Select Start Cell dialog
and return focus to the spreadsheet to select a cell, Figure 5.34.
After selecting the start cell, click the restore button (red dot) to restore the dialog,
Figure 5.35.
3. Use ColumnLetterRowNumber as the syntax for entering the cell specification
directly. For example A1 is the first row in the first column, Figure 5.36.
The orientation of the data is set through the Data Format tab in the Options dia-
log. Display the options dialog by clicking the Options button in the Starting
Cell dialog. For details on using the Options dialog, refer to Configuring Options
188 3BUF001094-600 B
5 DataDirect Inform IT 5.10 Retrieving Message Logs
on page 238. The Insert check box is used to insert a new row or rows of data in
the spreadsheet without overwriting any existing data. When Insert is selected,
existing rows are moved down as required to make room for the new data. If this
check box is not selected, any existing cells may be overwritten by new data.
4. Click OK when finished. This inserts the log entry updates in the spreadsheet,
Figure 5.62.
Figure 5.62: Output Results Inserted
5.10 Retrieving Message Logs

DataDirect Inform IT provides dialogs for retrieving message data. The Inform IT
Messages dialog is used to retrieve data from message logs configured through the
Information Management History Server function. This includes the IMMSGLOG
which collects from the 800xA alarm/event server, the PDLMSGLOG which collects
from the Batch Management server, and DCS_MESSAGE logs which consolidate
message data from earlier ABB historian platforms.
The Inform IT message log icon is given in Figure 5.63. If an icon is not available
View on page 243.
Figure 5.63: Inform IT Message Icon
3BUF001094-600 B 189
The Message Log dialog is used to retrieve data from message logs configured through
the Information Management History Server function.
workbook and retrieve new data. DataDirect does not provide an equivalent
function for this dialog at this time.
1. Select the starting cell in the spreadsheet which will be the starting point for in-
serting data.
Either click the Message Log button in the tool bar, or choose
DataDirect Inform IT > Message Log from the menu bar, Figure 5.64.
243.
5.10.1 Selecting Which Tab to Use

This dialog has two tabs, depending on the type of message log being accessed:
• Use the OPC/Audit Trail tab for:
– OPC_MESSAGE logs for Batch Management, the 800xA System
Alarm/Event Server, and other OPC data sources.
190 3BUF001094-600 B
– The AUDIT_MESSAGE log for History event messages stored in the Audit
Trail message log.
Refer to OPC/Audit Trail on page 191.
• Use the Alarm and Event tab for the DCS_MESSAGE log for the Advant OCS
with MOD 300 software or Master software. MOD 300 message logs store CCF
and TCL messages, as well as operator diagnostic messages. Master message
logs store event messages. Refer to Alarm and Event on page 198.
Other optional procedures are:
5.10.2 Using the Vendor/Categories List

The vendor/categories list provides a means to filter which messages will be presented
when the query is executed. By using the filter you can reduce the number of Vendor
Categories, and attributes.
It is important to note, that the filter is not active unless when you return to the main
page, columns that you wish to include in the output as well as use in the filter must
be selected. If the user does not select the columns the filters are not applied.
As an application note, after using the filter tools to generate the query, if you dump
the query using the SQL option, the query can be further refined to provide a more
specific query.
5.10.3 OPC/Audit Trail

The OPC/Audit Trail tab, Figure 5.65, is used to retrieve data from OPC_MESSAGE
and AUDIT_MESSAGE logs based on user-specified criteria.
3BUF001094-600 B 191
Figure 5.65: Message Log - OPC/Audit Trail Tab
Follow these guidelines to retrieve alarm/event message using this tab. Refer to the
referenced sections for details.
1. Use the Output option buttons to specify whether to execute a one-time data
query, or insert a reusable formula.
When Data Only is selected, choose whether or not to generate the SQL query.
Refer to Generate SQL on page 196. When Formula is selected, change the default
name for the saved query if needed. Refer to Saving a Query on page 196.
2. Select a log name from the pull-down list. This list contains every OPC message
log configured in the system.
3. The start and end times are optional. Refer to Date and Time on page 62 for de-
tails.
4. Select which OPC attributes and/or Vendor Attributes to be retrieved from their
respective lists.
The OPC attributes are described in Table 5.3. Rather than use the list, the OPC
attribute query function may be used. Refer to OPC Attribute Query on page 195.
192 3BUF001094-600 B
The Vendor/Category list is unfiltered by default. A filter may be applied to

limit the scope of vendor attributes to retrieve. Refer to Using the Vendor/Cate-
gories List on page 194 or use the vendor attribute query function as described
in Vendor Attribute Query on page 196
5. The Additional Output Options section is used to select additional information
to include in the output. Either show the SQL query with a data only output, or
save the query when the Formula option is used. Refer to:
• Generate SQL on page 196.
• Saving a Query on page 196.
• Additional Output Options on page 197.
OPC Attributes
Use this list to select one or more OPC attributes whose values are to be retrieved.
These attributes are described in Table 5.3.
Table 5.3: OPC/Audit Trail Message Log Attributes
Field Name Type Description

IDX Number Auto-generated number uniquely identifies each message.
LOCALTIME Date Local Time and date of the message.
TIME Date UTC Time and date of the message.
UTC Number UTC Time and date of message in seconds since 1/1/70.
TIME_NANO NUMBER Number of Hundreds of Nanoseconds of fractional portion
of seconds of the TIME field.
MONTH Number Used internally to partition Oracle tables for better
performance.
CHANGE_MASK Number Indicates which properties changed to cause the event.
NEW_STATE Number Specifies the new state of the condition
TASK_ID Number Task ID for PDL Messages.
SOURCE Varchar2(255) Source of the event (i.e. tag name)
MESSAGE Varchar2(4000) Textual description of the event
EVENT_TYPE Number Simple, Condition Related, or Tracking event.
3BUF001094-600 B 193
Table 5.3: OPC/Audit Trail Message Log Attributes

(Continued)

CATEGORY Number Standard OPC and Vendor Specific event category codes.
SEVERITY Number Vendor Defined Event severity (0…1000)
CONDITION Varchar2(255) Name of condition related to event
SUB_COND Varchar2(255) Name of sub-condition for multi-state conditions, or condition
name for single-state
QUALITY Number Quality associated with condition state (refer to OPC/DA
spec.)
ACK_REQ Number Acknowledgement required for event
ACTIVE_TIME Date UTC Time that the condition became active or time of
sub-condition transition
ACT_TIME_UTC Number Active_time (UTC) in seconds since 1/1/70
ACT_TIME_NANO NUMBER Number of Hundreds of Nanoseconds of fractional portion
of seconds of the ACTIVE_TIME field
COOKIE Number Server defined cookie associated with the event
ACTOR_ID Varchar2(64) User ID for tracking type events, Acknowledged ID for
condition related events.
NUM_ATTRS Number Number of vendor specific attributes associated with the
message.
Using the Vendor/Categories List

This pick list is populated with all attributes for all vendors and categories that exist
in the MSGVENDORS table (Refer to Section 11 Reading Message Logs). Use this
list to select one or more vendor-specific attributes whose values are to be retrieved.
This list is unfiltered by default. A filter may be applied to limit the scope of vendor
attributes to retrieve. To do this, click the Filter button. This displays the Filter dialog
shown in Figure 5.66.
Create a filter by selecting the vendors, categories, and attributes to include.
194 3BUF001094-600 B
The Filter Here check box for each list is used to apply a filter to the other lists. Filters
are applied from left to right by default. For example, if Filter Here for Vendors is
checked, the Categories list will show categories only for the selected vendors.
To reverse the filter order, use the Filter Order pull-down list. For example, when
Filter Here is checked for both Vendors and Categories, it is possible to specify
whether selected vendors will filter the categories list, or whether selected categories
will filter the vendors list.
The Select All buttons for each list is used to select all items in a list. The Reset
button restores the defaults.
Click OK when done.
Figure 5.66: Vendor and Category Filter
OPC Attribute Query

This check box and edit field is used to specify a query for an OPC attribute, for ex-
ample: EVENT_TYPE = 1. This would return all selected OPC or vendor-specific
attributes for messages whose EVENT_TYPE is set to 1 (simple).
3BUF001094-600 B 195
Vendor Attribute Query

This check box and edit field is used to specify a query for a vendor attribute. The
attribute must be specified by ID rather than name. For example in Figure 5.65 for
vendor ABB AIP, and category AE Condition Event, the Condition attribute ID is
27. Note that attribute IDs may vary from system to system. To query for condition
= setpoint, enter the query: 27 = ‘Setpoint’.
All vendor attributes are returned to DataDirect as character strings. Therefore,
use SQL conversion functions as required to convert the character strings to the
applicable data types for comparison in the MSGVENDORS table. Refer to Section
11 Reading Message Logs to determine the actual data types.
Generate SQL
Selecting this option is used to show the SQL statement used to run the query. The
SQL statement is inserted into the cell immediately following the query results. The
Data Only option must be selected to get the Generate SQL option.
Figure 5.67: Generate SQL
Saving a Query
When the Formula option is used, the resulting SQL query is saved and may be used
either in the SQL Query dialog (Using the Production Data Log Dialog on page 216),
or the ABBSQL function (ABBSql on page 276).
196 3BUF001094-600 B
Figure 5.68: Saving the SQL Query
The query name defaults to MsgLog1. The next query will be MsgLog2, and so on.
Rename the queries as required. The saved queries will be available through the Open
Query function on the SQL Query dialog, Figure 5.69.
Figure 5.69: MsgLog Queries Saved
Additional Output Options

The check boxes in this section are used to specify whether or not to include the fol-
lowing information in the query output: Vendor, Category, Category Number, Attribute
ID.
3BUF001094-600 B 197
5.10.4 Alarm and Event

The Alarm and Event tab, Figure 5.70, is used to specify filtering criteria to retrieve
data from DCS_MESSAGE logs. Always specify Log Name and Message Type.
Search Text and Date and Time are optional. The middle section is used to specify
database fields as additional search criteria. First, make sure the applicable message
type is selected through the filter on the Messages tab in the Options dialog. Click
Options, then refer to Messages on page 257.
Figure 5.70: Message Log - Alarm and Event Tab
Results are formatted according to the settings described in Alarm/Event Format

Output on page 201.
Log Name
This pull down list contains all message logs configured in the system.
Search Text
This field is used to search for a value within the actual message. This field is optional.
The wildcard characters * or % can be used. Since it is highly unlikely that an exact
198 3BUF001094-600 B
message entry can be entered, DataDirect adds the wildcard to the beginning and end
of every value entered when generating the query.
Message Type
This pick list is used to specify the types of alarm/events to retrieve. This field is en-
abled only when the Filter option in the Options/Messages dialog is set to
MOD 300 or Other.
The default selection is ALL. Multiple message types can be specified by checking
on the associated checkboxes. If ALL is selected, all other types are automatically
unchecked.
Database Fields
The database fields in the middle section of the dialog are used to specify message
attribute values as additional search criteria. The wildcard characters % or * can be
used. Enter either a new value, or select one from the corresponding list.
These lists are automatically populated with the contents of a file specified in the File
Setup tab of the Options dialog. Refer to File Setup on page 254. The Browse and
Auto-Create functions can be used to change the contents of a list.
The Tag name list is always enabled. The Batch, Unit, and Sequence Name lists are
enabled only when the Filter option in the Messages tab of the Options dialog is set
to MOD 300 or Other.
The Property Text, Event Text, Sections, Networks and Nodes lists are enabled only
when the Filter option in the Messages tab of the Options dialog is set to Master or
Other and the message log table that has been selected contains the applicable column.
The Property Text and Event Text fields are disabled when the version of History
software is earlier than History Services 2.4.
For Section, Network, and Node entries, if multiple entries are required, separate each
entry with a comma, for example: 2,6,7.
Browse
The Browse button is used to temporarily select a new file to change the list contents.
The button is activated for the list that currently has focus. Clicking Browse launches
the standard Windows dialog for directory navigation and file selection. Selecting a
new file does not change the file specification in the File Setup tab. The list contents
3BUF001094-600 B 199
will revert back to the file specified in the File Setup tab the next time the Message
Log dialog is used.
Auto-Create
The Auto Create function is used to alter the contents of the database field in the
Message Log dialog that currently has focus. This is done by creating a new text file.
The text file is created by a query built and run through the Auto Create dialog, Figure
5.71. To open this dialog click Auto Create.
Figure 5.71: Auto Create Dialog
The Log Name and Database Field settings specify the log and database field for
which the file will be created. Log Name defaults to the log name specified in the
Message Log dialog, and Database Field defaults to the field that currently has focus
in the Message Log dialog. Change these settings if necessary.
The Filter edit box is used to limit the number of entries in the file by returning only
those database items that satisfy the filter. For example, if the Database Field is
Tag_Name, and the filter is TC* or TC%, the file will only be populated with tag
names that have the TC prefix.
The query result is written to a text file with a default name and location as indicated
in the Output File edit box. Change the file name and/or location as required. Auto
Create returns one instance of each unique entry in the specified Database field. For
instance, if the Database field is Tag_Name, and there are multiple instances of the
tag TC101, only one entry for that tag is returned.
200 3BUF001094-600 B
The Browse button launches the standard Windows dialog for directory navigation
and file selection. The Edit button is used to open the specified file in a text editor
such as notepad.
5.10.5 Alarm/Event Format Output

The results are formatted according to these formatting options: Start Cell, Number
of Values, Insert, Generate SQL, Output Selection, Sort Order, Output Fields.
Generate SQL
Selecting this option is used to show the SQL statement used to run the query. The
SQL statement is inserted into the cell immediately following the query results.
Output Selection
The Output Selection combobox contains a list of all the fields available for output
from the message log table. An SQL query automatically populates this combobox
with the column names from the selected table.
Sort Order
The Sort Order field indicates the sorting sequence for each selected output field. The
choices are: Ascending, Descending, Unordered.
Output Fields
The Output Fields listbox dictates the message log fields that will be output to the
worksheet as well as the sequence and sort order of the selected fields. Automatically
display Localtime and Message.
Buttons
Add concatenates the current values from the Output Selection and Sort Order fields
and place the combined value into the Output Fields listbox. Remove deletes the se-
lected row(s) from the Output Fields listbox. If only one row is selected, it is removed
when this button is pressed. If more than one row is selected, then confirm the remove
operation.
Change Order cycles through the different sort order options (Ascending, Descending,
Unordered) for the selected items. The Up/Down arrow buttons move the selected
3BUF001094-600 B 201
5 DataDirect Inform IT 5.11 Retrieving Production Data
row in the Output Fields listbox up or down one row. Only one row can be selected
and moved at a time.
5.11 Retrieving Production Data

DataDirect Inform IT provides two dialogs for retrieving production data generated
by batch process applications. The Batch Data dialog provides twelve pre-configured
views, Table 5.4. The Production Data Log dialog is used to drill the task hierarchy.
Both dialogs may be used either on a node where the 800xA base software is installed,
or on a remote computer client without 800xA software.
The toolbar icons for the Production Data Log and Batch Data versions are shown in
Figure 5.72. If an icon is not available on the tool bar, use the View tab on the Options
dialog to make it available. Refer to View on page 243.
Figure 5.72: Production Data Log and Batch Data Icons
• Functions on page 203.
• Using the Production Data Log Dialog on page 216.
5.11.1 Using the Batch Data Dialog

The Batch Data dialog is used to retrieve production data for a selected batch. The
data is organized in twelve pre-configured views which are described in Functions
on page 203. These views simplify data retrieval from batch applications for viewing
on the Excel spreadsheet, and for integrating into reports built either with DataDirect,
or third party report building applications such as Crystal Reports. The output of this
dialog can be one of the following:
• DataDirect Formula - enters a DataDirect formula that may be re-executed (for
reports).
202 3BUF001094-600 B
• SQL Query - creates an SQL query that may be copied and pasted into an SQL-
based application such as Crystal Reports. It also places the query in an ABBSQL
function call on the spreadsheet.
• Data Only - executes a one-time (ad-hoc) request for data.
Follow these basic steps to retrieve production data with this dialog:
data.
2. Use the menu or tool bar to open the Batch data dialog, Figure 5.74.
Either click the Batch Data button, or choose DataDirect InformIT> Batch
Data from the menu bar.
Functions
The Function list, Figure 5.73, contains the names of the functions that retrieve data
from pre-configured views which are described in Table 5.4.
These names are configurable through the PDL/Batch tab on the Options dialog
(Refer to Options for the Batch Data Dialog on page 248). Selecting a function creates
the DataDirect function or SQL query as a starting point for the data retrieval appli-
cation. This function (or SQL query) is further specified as the other fields in this
dialog are used.
When either DataDirect Formula or SQL Query is selected as the Output Type, then
click the Edit button to view and edit the function. Refer to Editing the Function or
SQL Query on page 214.
Figure 5.73: Selecting the Function
3BUF001094-600 B 203
Table 5.4: Views
View Name Function Name Returns

Batch_AuditEvents ABBGetBatchAuditEvents All batch audit events for a batch (events
generated by operator actions associated
with a batch). Refer to Table B.10.
Batch_BatchMgrEvents ABBGetBatchBatchMgrEvents All batch manager events for a batch
(events generated by batch manager).
Refer to Table B.13.
Batch_CommentEvents ABBGetBatchCommentEvents Batch audit comment events (entered using
block status dialog) for a batch. Refer to
Table B.11.
Batch_Equipment ABBGetBatchEquipment Equipment transactions for a batch. Refer
to Table B.5.
Batch_Events ABBGetBatchEvents All batch audit, batch manager and batch
process events for a batch. Refer to Table
B.12.
Batch_Header ABBGetBatchHeader Batch header (basic batch information).
Refer to Table B.4.
Batch_Procedures ABBGetBatchProcedures List of procedures executed by a batch.
Refer to Table B.8.
Batch_ProcessEvents ABBGetBatchProcessEvents All events generated by sources external
to the batch server and associated with a
batch (does not include batch audit
events). Refer to Table B.9.
Batch_SystemEvents ABBGetBatchSystemEvents All system events (events not associated
with a batch) for the time frame that a batch
executed. Refer to Table B.14.
204 3BUF001094-600 B
Table 5.4: Views

(Continued)
View Name Function Name Returns

Batch_Trends ABBGetBatchTrends Continuous data recorded for a batch.
Refer to Table B.15.
Note: Usage of the Batch_Trends views
requires an ODBC Client and ODBC
Historical Data Server license.
Note: When using the Batch_Trends view,
always use the LogicalName column with
a filter. This filter is case-sensitive.
The Search Criteria is Case Sensitive
check box must be checked on the
PDL/Batch tab of the Options dialog (check
box is checked by default). Refer to Search
Criteria is Case Sensitive on page 248.
Improving Performance: Refer to the
guidelines in Improving the Performance
of the Batch_Trend View on page 215.
Batch_Variables ABBGetBatchVariables Variables recorded for a batch. Refer to
Table B.7.
Batch_Vars_MatchedPair ABBGetMatchedPair Matched pairs of variables recorded for a
batch. Refer to Table B.6.
3BUF001094-600 B 205
1. Use the Batch Data dialog, Figure 5.75, to specify the following:
a. The function that will retrieve data from the view that contains the batch
information required. This creates a basic query to access the view.
b. Data retrieval parameters such as the batch ID, and which batch attributes
(columns in the view) to include. Filters can also be specified for one or
more selected columns, and the sorting order of the selected columns can
be adjusted.
c. Select output type for the data request. The options are: DataDirect formula,
SQL query, or one-time data request. As an option, specify the following:
Inserting or Overwriting Rows on page 61
Maximum Rows on page 214
Figure 5.75: Batch Data Dialog
206 3BUF001094-600 B
Batch ID
This list contains the ID of the batches which have been executed during the time
span specified through the Time Span Start Time and End Time controls, and whose
data is stored in a PDL.
The default span is specified through the Search Time Span field on the PDL/Batch
tab of the Options dialog (refer to Search Time Span on page 248). Adjust the time
span as required, Figure 5.76. This control operates like a standard Microsoft date/time
picker. After adjusting the time span, click Get Batch IDs to update the list.
Figure 5.76: Adjusting the Time Span for Batch IDs
Once the time span is correct, use the pull-down list to select the batch whose data is
to be retrieved, Figure 5.77, or enter the batch ID directly.
Figure 5.77: Selecting a Batch
3BUF001094-600 B 207
Other Methods for Specifying Batch ID

There are two additional methods to specify the batch ID:
• Use Cell Reference - Checking this check box hides the list of batches and dis-
plays a cell reference text box in its place, Figure 5.78. This text box operates
much like the Start Cell text box. It is used to reference a specific cell in the
spreadsheet which contains the batch ID. To specify the starting cell, either enter
the column/row specification directly in the Batch ID field, or use the correspond-
ing button to return focus to the spreadsheet so a cell can be selected. This cell
may be filled in during report generation.
1) Check Use Cell Reference
2) Enter Cell Reference

Directly
OR
3a) Click button to return 3c) Click
focus to spreadsheet here to
close
3b) select a cell
Figure 5.78: Using a Cell Reference
• PDL Browser - Launch the PDL dialog by clicking the PDL Browser button.
This dialog is used to drill up and down in the task hierarchy to find the batch
whose data is to be retrieved. The PDL dialog may be used to simply find the
applicable batch ID for entry in this dialog, or for continuing with a data query
in the PDL dialog. To select a batch from the PDL Browser for use in the Batch
Data dialog, navigate to a batch, then click Select Batch. For further information
regarding the PDL dialog, refer to Using the Production Data Log Dialog on
page 216.
Selecting Columns
The data retrieval function (or SQL query) is further specified by selecting columns,
filters, and sorting options for the selected view in the lower part of the dialog. The
208 3BUF001094-600 B
Columns list contains a list of all columns for the selected view, Figure 5.79. Select
one or more columns to specify the batch information to retrieve. The single right
arrow button (>) puts the selected columns in the selected columns list (right pane).
The double right arrow button (>>) puts all columns in the selected columns list. Use
the left arrow buttons to remove selected columns from this list.
For detailed descriptions of the various columns refer to the tables in PDL Tables
and Views on page 679.
Figure 5.79: Selecting Columns
When finished selecting columns, a filter may be specified for one or more selected
columns, and the sorting order may be adjusted.
Filtering
By default, no filter will be applied to any column (indicated by None). To specify
a filter for an item in the selected column list, double-click on the Filter column for
the item. This displays a Filter dialog that is used to specify values or patterns by
which to compare column values. Values that do not satisfy the filter will be excluded
from the query. After a filter is applied it can be reset to None by clicking the Clear
Filter button on the filter dialog.
There are three filter dialog versions, depending on the selected column’s data type:
• Text - This dialog provides two ways to apply a textual filter.
The List tab on the Text Filter dialog lists of all possible values for the selected column
and selected batch ID, Figure 5.80. If the batch ID is by reference, then all possible
matches for that column will be listed. Simply select one or more values from the list
3BUF001094-600 B 209
then click Ok. Values that do not match the selected value will be filtered out. Check
the NOT box to negate the filter. This filters out values that do match the selected
value(s).
Figure 5.80: Text Filter Dialog - List Tab
The Pattern tab is used to specify a textual pattern by which to compare column
values, Figure 5.81. Use the pull-down list to specify whether the value must be
an exact match (EQUALS), or simply contain the specified text string (LIKE).
Then specify the pattern. The % character may be used as a wildcard to substitute
for any character string when using the LIKE operator. For example, assuming
LIKE is selected, the pattern - %001 will cause the query to retrieve information
for batches whose Batch IDs end with the text string 001. Click the NOT check
box to apply a NOT operator and filter out values that match the pattern.
210 3BUF001094-600 B
Figure 5.81: Text Filter Dialog - Pattern Tab
Extend the filter with AND or OR clauses by clicking the Add Filter button.
This is illustrated in Figure 5.82. By clicking Add Filter, another line is added
to the filter. Select whether to add the line as an AND clause, or an OR clause,
then specify the pattern as described above.
Figure 5.82: Adding an OR Clause
3BUF001094-600 B 211
Text filters are case sensitive by default. Make them not case sensitive by
unchecking the Search Criteria is Case Sensitive check box on the PDL/Batch
tab of the Options dialog. Refer to Search Criteria is Case Sensitive on page 248.
One exception is when filtering on LogicalName for the Batch_Trend view. This
filter is case sensitive and requires the Search Criteria is Case Sensitive check box
to be checked.
• Number Filtering - Choose a comparative operator from the pull-down list, then
adjust the minimum and maximum numbers as required, Figure 5.83.
Figure 5.83: Number Filter Dialog
• Date - For this dialog, choose a comparative operator from the pull-down list,
then adjust the start and end dates and times as required, Figure 5.84.
Figure 5.84: Date Filter
Sorting
The order in which the columns are listed here determines the order in which the
columns will be displayed on the spreadsheet, and the order in which they will be
212 3BUF001094-600 B
added to the ORDER BY clause of the query. They may be dragged (one at a time)
up and down the list to change this order.
To sort the returned values in ascending or descending order, click the Sort Order
column for an item. This will display a pick list with the following choices: None,
Ascending, and Descending, Figure 5.85. When the query is executed, the columns
that have either Ascending or Descending specified will be added to the ORDER
BY clause according to the order in which they are listed. Items specified as none
will not be used in the ORDER BY clause.
Figure 5.85: Specifying Ascending or Descending Order for Columns
Output Type
The option buttons on the top right part of the dialog are used to specify whether to
enter a reusable formula which will be executed each time the spreadsheet is updated,
create an SQL query, or execute a one-time data request Figure 5.86.
Figure 5.86: Output Types
• DataDirect Formula - creates a re-executable DataDirect formula based on dialog

specifications including filters and sorting information. This requires functions
to be enabled on the Setup tab of the Options dialog (functions are enabled by
default). Refer to Disable Functions on page 254.
• SQL Query - creates an SQL query based dialog specifications including filters
and sorting information. The query is executed once, and may also be copied-
and-pasted into another SQL-based application such as Crystal Reports.
3BUF001094-600 B 213
• Data Only: executes the query on a one-time basis.

The Edit button is enabled when either DataDirect Formula or SQL Query is
selected. This is used to view and edit the function (or query) before it is executed.
For further information, refer to Editing the Function or SQL Query on page 214.
Maximum Rows
When this box is checked, the maximum number of rows on the spreadsheet can be
specified for which data will be returned. When this box is not checked (default
condition), the number of rows for which data is available will be returned.
If there are fewer values available than there are rows specified, the excess rows
are left blank.
Editing the Function or SQL Query

This dialog is used to edit the current function or SQL query, Figure 5.87.
Figure 5.87: Editing the Function or Query
For further guidelines, refer to:

• SQL Queries below.
• DataDirect Functions on page 215.
214 3BUF001094-600 B
SQL Queries
The SQL queries will be used in a call to ABBSQL. This query may then be used in
other applications. The following are the equivalent SQL query for the functions de-
scribed above:
ABBSQL("SELECT CampaignID, RecipeName, StartTime, EndTime FROM
BatchHeaderInfo WHERE BatchID='BATCH_001' ORDER BY StartTime ASC)
DataDirect Functions
The DataDirect-specific functions will all follow this generic form:
ABBGetSomeView(ByVal BatchID as String, _
Optional ByVal ColumnsToShow as String = "", _
Optional ByVal Filter as String = "", _
Optional ByVal SortOrder As String = "") As Variant
The BatchID parameter (either a cell reference or an actual BatchID name) must always
be included. All other parameters are optional.
The ColumnsToShow parameter is equivalent to a SELECT statement. This optional
string consists of a comma-separated list of columns from the view. If this parameter
is blank, all columns will be selected.
The Filter parameter is equivalent to a WHERE clause. If this parameter is not passed,
no filtering will be done (except on the mandatory BatchID).
The SortOrder parameter is equivalent to a ORDER BY clause. If this parameter is
not passed, there will be no sorting performed.
Examples:
ABBGetBatchHeader("BATCH_001", "CampaignID, RecipeName, StartTime,
EndTime", "", "StartTime ASC")
ABBGetBatchHeader("BATCH_001", ColumnsToShow := "CampaignID,
RecipeName, StartTime, EndTime", SortOrder := "StartTime ASC")
Improving the Performance of the Batch_Trend View

Improve the performance of queries on the Batch_Trends view by configuring a
dedicated ADO data provider which uses the ODBC data source for ODA. Refer to
System 800xA Information Management Configuration (3BUF001092*), to configure
3BUF001094-600 B 215
data providers. Next, enter the Batch_Views function manually, and modify the query
to specify the new ADO data provider, Figure 5.88.
Data provider Specification Added
Figure 5.88: Editing the batch_Trend Query
5.11.2 Using the Production Data Log Dialog

The PDL dialog, Figure 5.89, is used to query PDL tasks for production data.
Figure 5.89: PDL Dialog
workbook and retrieve new data. DataDirect does not provide an equivalent
function for this dialog at this time.
216 3BUF001094-600 B
Setting Up the PDL Interface

PDLs may be created by any one of four batch processing applications: 800xA Batch
Management (default), Batch 300, Taylor Control Language (TCL), or Profile Histo-
rian. Specify the PDL application through the PDL tab on the Options dialog. This
tab also is used to specify other PDL querying parameters such as default time span,
maximum number of values to return, and language for messages. Access to this tab
is through the Options button. To configure these PDL parameters, refer to PDL/Batch
on page 244. Also, specify the batch application for which messages will be logged.
This is done through the Message tab (refer to Messages on page 257).
Opening the Dialog

1. Select the starting cell in the spreadsheet which will be the starting point for in-
serting data.
Either click the Message Log button in the tool bar, or choose
DataDirect Inform IT > PDL from the menu bar, Figure 5.90.
Using the Dialog

Use the Search Criteria controls to retrieve the PDL tasks whose data will be accessed.
Any tasks meeting the specified criteria are displayed in the Search Results section.
3BUF001094-600 B 217
Use the controls in this section to drill up or down in the hierarchy for a selected task.
Next, insert the selected task data into the spreadsheet through the Output Results
button. Data for the selected task are also displayed in the Associated Data Listing
below the Search Results.
Search Criteria
Use this part of the PDL dialog to specify the Task Type, Task Value, and Time Span
for the search. Click Search when finished, Figure 5.91.
Figure 5.91: Search Criteria Section
Task Type
This specifies the level of the PDL hierarchy to be searched. The choices in the Task
Type list are based on the Type of PDL selected in the Messages tab of the Options
dialog.
When the Task Type specification is changed, any previous results in the PDL dialog
are cleared.
For this release of the software, Batch 300 and TCL-specific criteria are automat-
ically applied to the search to prevent the retrieval of Batch records which do not
belong to the selected PDL type. If Batch 300 is the current PDL type, then TCL
Batch records will not be retrieved when a search for Batch records is executed.
If TCL is the current PDL type, then Batch 300 batch records will not be retrieved
during a Batch search.
Task Value
This specifies the name of the task to query. If a name is not specified, all tasks are
returned. Enter the complete name, or just a partial name. The wildcard character%
218 3BUF001094-600 B
can be used to search for a particular pattern or format. Leading and trailing blanks
are removed before the search is executed.
The Search Criteria is Case Sensitive option in the Messages tab of the Options dialog
determines whether or not to convert the task name to uppercase characters. This is
a convenience option for those systems in which all names are stored as uppercase.
Time Span
The Time Span fields is used to specify a time range for the query. These fields can
be enabled or disabled through their respective check boxes.
To restrict the query to a time range, check both boxes, and enter both the Start and
End date/times.
To make a query for all tasks starting before a specific date/time, check just the End
check box, and enter the End date/time.
To make a query for all tasks starting after a specific date/time, check just the Start
check box, and enter the Start date/time.
By default, the End date/time are set to the current date and time when the PDL
dialog is opened. The Start date/time are set based on the Search Time Span option
on the Messages tab in the Options dialog (Start date/time = End date/time minus
Search Time Span).
The method of operation for the date and time fields is the same as for the History
dialog. For further information refer to Time Span for Retrieval in Retrieving History
Data on page 167.
Limiting the Amount of Data Returned By Your Query

As a safeguard against retrieving an excessive amount of data, configure a limit for
the number of rows to be returned for each query. This is done through the Messages
tab in the Options dialog. The default is set at 500 rows. The range is 1 to 32,767.
The dialog shown in Figure 5.92 is displayed when the total number of rows satisfying
the search criteria exceeds the specified limit.
3BUF001094-600 B 219
Figure 5.92: Maximum Number of Retrieved Rows Exceeded Dialog
If this occurs, use this dialog to do one of the following:

• To retrieve all rows, click Options. This displays the PDL tab in the Options
dialog. Adjust the number of rows to be returned. Refer to Messages on page
257.
• To accept the results as is and return to the PDL dialog, simply click OK.
To keep from seeing this message each time the maximum number of rows is exceeded,
click the check box. This remains in effect for the current Excel session.
Search Results
This part displays a listing of tasks that meet the search criteria, Figure 5.93. The
search results include: Task Name, Start Time and End Time. The rows are sorted
by Start Time. The header for the first displayed column changes according to the
Task Type that was searched.
The Drill buttons are used to move up and down the PDL hierarchy for a selected
task in order to view the data at all levels of the hierarchy for a task. Refer to Drilling
on page 221 for details.
To enter the PDL data into the Excel worksheet, click the Output Results button.
Refer to Output Results on page 223 for details.
If the search is performed for a level lower than the topmost (job or campaign) level
of the PDL hierarchy, the results will also include the task names at each level of the
hierarchy, up to the topmost level, for each row in the listing. For the example, the
results shown in Figure 5.93 are for a search done at the Unit level in a Batch 300
application. Each unit’s Batch and Job names are retrieved in addition to the unit
level data.
220 3BUF001094-600 B
Figure 5.93: Example, Search Results
The first row in the Search Results listing is automatically selected (highlighted), and
the associated data for the selected item are available for viewing in the Associated
Data Listing section of the dialog. When a different row is selected, the contents of
the Associated Data Listing changes accordingly.
Column width and the sort order of the rows are fixed. Some column values may be
truncated in the display due to the fixed widths of the columns; however, when the
values are output to the worksheet, the complete value will be output. Horizontal and
vertical scroll bars are provided when the number of rows or columns exceeds the
limits of the Search Results window.
The main search result count is displayed above the result listing. The associated data
search count is displayed below the listing. If a query does not return any results, a
row with the text No Data is displayed underneath the header row. Additionally, the
search count displays No rows returned.
Drilling
The Drill buttons, Figure 5.94, are used to move up and down the PDL hierarchy for
a selected task in order to view the data at all levels of the task hierarchy.
Figure 5.94: Drill Buttons
3BUF001094-600 B 221
Drilling down displays data for the selected task at the next level down in the hierarchy.
Drilling up displays data for the selected task at the next level up in the hierarchy.
For example, clicking the drill down button for unit R-101 in Figure 5.94, displays
the phase-level search results for R-101, Figure 5.95.
Figure 5.95: Drill Down Example
The Task Type value indicates the next level defined in the hierarchy. The Task
Value is reset to a blank value, and the time values retain their previous values.
Throughout the drilling process, the task record that was selected before the drill
function was performed will be highlighted when the opposite drill function is later
performed. For example, if an initial search is performed for a particular batch, the
drill down function will display data at the unit level for the selected batch. If drill
down is executed again, data at the phase level for the selected unit will be displayed.
When Drill Up is selected, data at the unit level will be displayed. The unit that was
originally selected for the drill down function will be highlighted when drilling back
from the phase level to the unit level.
The drill buttons are automatically enabled and disabled as follows:
• If the Search Results listing indicates ‘No Data’, the Drill Down and Drill Up
buttons are disabled.
• If the current Task Type value is at the bottom of the hierarchy for a PDL type,
the Drill Down button is disabled.
• If the current Task Type value is at the top of the hierarchy for a PDL type, the
Drill Up button is disabled.
• After each new search is completed, the Drill Up button is disabled. Only drill
Down is allowed after a new search is performed.
222 3BUF001094-600 B
Output Results
The PDL Output dialog, Figure 5.96, is used to enter PDL data into the Excel work-
sheet. To display this form, click Output Results in the Search Results section of
the PDL dialog.
Use the Output Items and Output Choices sections to specify which data to output.
The Output Formatting Options section is used to format the output results.
Figure 5.96: PDL Output Dialog
Output Items
The Output Items grouping is used to specify whether to output the results for all
tasks currently in the Search Results list, or limit the output to just the task that is
currently selected in the list. The default is to use just the selected task.
Output Choices
The output choices lists the data categories that can be output for the selected item(s),
Figure 5.97. The choices correspond with the data tabs provided on the PDL dialog
in the Associated Data Listing and are described in Table 5.5.
To select a data category for output to the Excel spreadsheet, select the category in
the Output Choices list and then click the > button. This moves the selected item to
the Chosen Outputs list. To select all categories at once, click >>.
3BUF001094-600 B 223
To un-select a currently selected data category, select the entry from the Chosen
Outputs list and then click <. This moves the selected item back to the Output
Choices list. To un-select all items, click <<.
The order in which the data will be output is dictated by the sequence in the Chosen
Outputs list. To change the sequence, select an entry from the Chosen Outputs list
and then click the up or down arrow as required to move the item up or down
Figure 5.97: Output Choices
If no entry is placed in the Chosen Outputs list and either Apply or OK are clicked,
the output will consist of the data as it appears in the Search Results listing on the
PDL dialog.
Table 5.5: Output Choices
Output Choices Description

Variables Outputs contents of Variables tab in the Associated Data Listing.
Resources Outputs contents of Resources tab in the Associated Data Listing.
History Logs Outputs contents of History tab in the Associated Data Listing.
History Values Outputs the actual history data for logs listed in the History tab in the
Associated Data Listing (same as the History Logs output block).
Formatting is based on the History options selected in the Output
Formatting Options section, as well as the Data Format options defined
in the Options dialog.
Messages Outputs contents of Messages tab in the Associated Data Listing.
224 3BUF001094-600 B
Table 5.5: Output Choices

(Continued)
Output Choices Description

Next-level List Outputs contents of Next-Level Listing in the Associated Data Listing.
Variable Report Merges various types of data together into a particular format. It provides
variables for each level starting at the selected level, and continuing for
all lower levels.
Output Formatting Options

Use these controls to specify basic formatting instructions for the output.
From the Worksheet tab, specify the Start Cell for the output results, and whether
to Insert or overwrite rows.
The History tab is only applicable when the choice is made to output History Values
(actual History data). It is used to specify the number of values to be output, and the
Log Calculation Algorithm.
The Excel format of the cells containing the data will be set to ‘General’ for non-
date/time data. Date/Time values will be set to a custom format as defined in the Date
and Time fields in the Data Format section of the Options form. Although the Excel
‘General’ format is used, Excel may choose to reformat numeric values on its own.
When an output request is submitted, the number of queries to be executed is estimated.
If the estimate is above 20, a prompt to confirm whether or not to continue with the
request is made.
Even when continuing, the whole request can still be cancelled. As each search is
executing, the Cancel Query dialog is displayed. Clicking the Cancel button, the
currently executing queries) are allowed to complete; however, all remaining queries
are canceled. An example output result is shown in Figure 5.98.
3BUF001094-600 B 225
Figure 5.98: Example, PDL Output
Associated Data Listing

This part of the PDL dialog displays the data for selected task in the Search Results
listing. These data are organized under the following tabs: Variables, Resources,
Messages, History, and Next-Level Listing.
Variables
This tab displays: variable name, value, time, occurrence number, result value and
result time. Rows are sorted by Time, Variable Name, then Occurrence, Figure 5.99.
226 3BUF001094-600 B
Figure 5.99: Example, Variables Tab
Resources
This tab displays: Resource Type, Name, Value, Time and Occurrence. The rows are
sorted by Type, then by Name, then by Occurrence, Figure 5.100.
Figure 5.100: Example, Resources Tab
Messages
This tab displays the following message data for the selected task: Message Type,
Message and Local Time. The rows are sorted by Local Time, Figure 5.101.
When the PDL type is specified as Produce IT Batch or 800xA Batch Management,
the time is displayed in UTC time rather than local time.
3BUF001094-600 B 227
Figure 5.101: Example, Messages Tab
Some PDL tasks may not have start or end time values. Running queries without time
boundaries could result in a huge number of returned records. When one of the times
is not available, DataDirect tries to get a start or end time from the parent record of
a task. If both the start and end times are still not available after this attempt, then a
restriction is put on the query to limit the Maximum Rows to be Returned. This is
specified through the PDL tab on the Options dialog.
History
This tab displays Log Name, Start Time, End Time, Phase and Occurrence. The rows
are sorted by Log Name then by Start Time, Figure 5.102.
Figure 5.102: Example, History Tab
The History association tables track the start and end times for which history values
were collected for a particular object. The PDL tables do NOT store the actual history
values, just the initial and final times of the collection period.
History Log associations can be retrieved at two levels — owner and individual task
level. Each history association record has a taskid for the level at which the history
228 3BUF001094-600 B
log was started. Because the history log may span multiple tasks within a level of the
hierarchy, each history association record also has an “owner” task.
For example, consider a Batch application where history collection began during
Batch 123. Batch 123 had four Phases through which the history collection spanned.
Batch 123 is the owner for each of the four phases. When a search is executed for
Batch 123, a record is displayed in the History listing. Additionally, when a search
is done for each of the four phases, a record is also displayed for each of the phases,
even though the history collection spanned across all four. The Phase value will be
displayed if the owner task is the currently displayed item.
Clicking the Trend Display button launches the Trend Display view of the selected
log.
Clicking View displays the PDL History Data dialog, Figure 5.103. This dialog pro-
vides a listing of history timestamps, values and data quality values for the selected
log. The log name, start and end times are taken from the selected row in the History
listing. The Log Calculation Algorithm is set to “ANY” and the number of values to
be returned is set to 500.
The contents and formatting options for the display are taken from the Data Format
tab in the Options dialog.
3BUF001094-600 B 229
Figure 5.103: Viewing PDL History Data
Clicking Copy to Clipboard copies the entire contents of the listing into the comput-
er’s clipboard. Each line is separated by a carriage control character. Each column
value is separated with a tab within the line.
Next-Level Listing
Usually, the last tab in the Associated Data listings contains data from the history.task
table for the next level down in the hierarchy. The actual name of the tab is based on
the level in the hierarchy for the data. For example, if the current Task Type is a Unit
in a Batch 300 system, then the tab name will be Phase List. The header for the first
column of data changes to reflect the ‘child’ level name.
If the current Task Type is the last level in the hierarchy, this tab will not be displayed.
The following data are displayed: Task Name, Start Time and End Time. The rows
are sorted by Start Time, Figure 5.104.
230 3BUF001094-600 B
5 DataDirect Inform IT 5.12 Retrieving Data by SQL Query
Figure 5.104: Example, Next Level Tab
Printing a Screen Dump of the PDL Dialog

If the computer is connected to a printer, the printer button is displayed below the
Cancel button, Figure 5.105. Clicking this button sends a screen dump of what ever
is currently visible on the form to the default printer attached to the computer.
Figure 5.105: Printer Icon
5.12 Retrieving Data by SQL Query

The SQL Query dialog, Figure 5.106, is used to build ad-hoc SQL queries and display
the results in the Excel Spreadsheet. It also is used to save and re-use queries. The
saved queries may be used in this dialog, or in the ABBSQL function (ABBSql on
page 276). This dialog may be used either on a node where the 800xA base software
is installed, or on a remote computer client without 800xA software.
These queries are generally used for access to Oracle data. This dialog is not intended
for querying historical and process objects on Windows-based data servers. These
applications are better supported by the History Values and Process Values dialogs.
To use this dialog to query historical and process objects on a Windows-based data
3BUF001094-600 B 231
server, install the Open Data Access (ODA) option on the data server, and configure
an ADO data provider to support ODA.
Figure 5.106: SQL Query Dialog
To enter an SQL query:

1. Click on the starting cell where the query results will be displayed.
2. Open the SQL Query dialog. To do this, click the SQL button, or choose
DataDirect > SQL Query from the menu bar. If not logged in, a prompt to log
in now is made. Refer to Login on page 139.
3. The selected starting cell is indicated in the Start Cell field. Use this field to
change the Start Cell if necessary.
5. Select the number of values to be returned in the Number of Values field. This
is used to set the maximum number of responses to a manageable quantity.
Enter an integer value directly in this field, or use the corresponding pick list.
The pick list choices are: MAX, 1, 50, 100, 200, 300, 400, 500. The largest
possible number is 65,534 for direct entry.
6. Click the Insert check box to ensure that existing data are not overwritten by new
data.
7. Enter the query in the SQL Statement window.
232 3BUF001094-600 B
As an option, choose to save the query, or open an existing query that has already
been saved. This is described in Saving and Re-using SQL Queries on page 233.
To be prompted to save a new query before running the query or when closing
the dialog, check the Confirm Save check box.
8. Click OK or Apply to send the query.
The data orientation and formatting options described in Data Format on page 239
DO NOT apply to SQL queries. An example query result is shown in Figure 5.107.
Figure 5.107: Example Query Result
For complex queries, the Timeout interval may need to be increased. Click the
Options button to display the Options dialog. For details refer to Timeout in Setup
on page 249.
5.12.1 Saving and Re-using SQL Queries

To save the query currently being entered for re-use later, click the Save icon in the
upper right corner of the dialog, Figure 5.108.
Save SQL Query
Save Icon
Figure 5.108: Save Icon
This displays the Save dialog, Figure 5.109. Enter a name for the query, then click
OK.
3BUF001094-600 B 233
Figure 5.109: Saving a Query
Open SQL Query

To open an existing query, click the Open icon in the upper right corner of the dialog,
Figure 5.110.
Open Icon
Figure 5.110: Open Icon
This dialog, Figure 5.111, is used to select an existing query to re-use in the SQL
Query dialog. A selected query may also be deleted, and toggled between the detailed
and list views. To open an existing query, select the query, then click OK.
This enables the Use Named Query check box on the SQL Query dialog. Check this
box to use the query by name rather than the actual query. By using the named query,
any modifications will be implemented whenever a spreadsheet is used with the named
query. By using the actual query (Use Named Query not checked), the changes will
need to be made in all spreadsheets that use the query.
To delete an existing query, select the query then click the Delete icon, Figure 5.111.
Use the List and Detail icons to list queries by name only, or show the full detailed
view. The detailed view indicates the query name, the user that saved the query, the
234 3BUF001094-600 B
5 DataDirect Inform IT 5.13 Retrieving Values for TCL Unit Arrays
date and time when the query was last saved, and the full query text. Figure 5.111
shows the detailed view.
Click to list queries by Click to list queries by

name without details name with details
Click here to
delete the selected
query
Figure 5.111: Open Query Dialog
5.13 Retrieving Values for TCL Unit Arrays

The TCL Unit Array command can only be used when connected to an Enterprise
Historian node that is connected to the DCN (has an RTA board). TCL unit array
variables are loaded and removed from TCL units by Load and Remove statements
in TCL programs.
This dialog does not support using the F9 function to re-calculate the workbook
and retrieve new data.
Follow these basic steps to access TCL unit array data with this dialog:
1. Select the starting cell in the spreadsheet.
2. Use the menu or tool bar to open the Inform IT TCL Unit Array dialog. Either
click the TCL Unit Array button in the tool bar, or choose
DataDirect Inform IT > TCL Unit Array from the menu bar, Figure 5.112.
3BUF001094-600 B 235
5 DataDirect Inform IT 5.13 Retrieving Values for TCL Unit Arrays
To get TCL Unit Array data:

1. Use the Values field to set the maximum number of responses to a manageable
quantity. Enter an integer value directly in this field, or use the corresponding
pick list. The pick list choices are: 1, 50, 100, 200, 300, 400, 500. The largest
possible number is 65,534 for direct entry. If the array has fewer elements than
the specified Number of values, only the actual number of elements will be re-
turned.
2. Use the Select Object File field, if necessary, to change the text file for the TCL
Object pick list.
Figure 5.113: TCL Unit Array Dialog
236 3BUF001094-600 B
5 DataDirect Inform IT 5.14 Using the Information Management Browse
3. Select the TCL object type from the pick list. The selected TCL Object Type
filters the contents of the TCL Object pick list. It also determines the contents
of the TCL Attribute and Data Type fields. These fields are read-only.
Refer to the Object Types Reference Manual for details regarding TCL Unit Array
object types, and their respective attributes.
4. Select the TCL Object from the pick list. This is the name of the TCL Unit Array
variable as defined in the TCL Load statement. Refer to the TCL User’s Guide
for details regarding the Load statement.
5. Click OK or Apply to send the query.
Other optional procedures are:
5.14 Using the Information Management Browser

The Information Management Browser is used to browse OPC objects on the connected
OPC DA or OPC HDA server when performing data retrieval or update operations
for real-time or historical data on the OPC servers. The layout of the browser and
method of operation vary to some extent, depending on where the browser is used.
For example Figure 5.114 shows the browser associated with the History Values dia-
log. Refer to Information Management Browser on page 524 for general usage.
3BUF001094-600 B 237
5 DataDirect Inform IT 5.15 Configuring Options
Figure 5.114: Example, Information Management Browser in History Values Dialog
5.15 Configuring Options

Data formatting, communications, and file setup options have default settings so
DataDirect can begin being used without having to do any preliminary set up. To
change any of these options, use the Options dialog. This dialog is displayed by
clicking the Options button, Figure 5.115, or choose DataDirect > Options from
the Microsoft Excel menu bar.
238 3BUF001094-600 B
Figure 5.115: Options Button
The configurable options are grouped on six tabs:

• Use the Data Format tab to configure orientation and data options. For instance,
this tab is used to specify whether or not to include attribute names as headers,
and whether to orient the results horizontally or vertically.
• Use the View tab to select which add-in tools to show or hide in the Excel tool
and menu bars.
• Use the PDL/Batch tab to specify the PDL application set a default time span
for data retrieval, whether to query active or restored logs, and other set-up.
• Use the Setup tab to establish defaults for communications settings. This includes
setting up data access through data providers and enabling/disabling write access
to process and history values,.
• Use the File Setup tab to select the default text files for the pick lists in all data
retrieval/data entry dialogs. Also use this tab to specify whether to show object
names, aliases, or both in DataDirect dialogs and Excel spreadsheets. This tab
is not applicable for Industrial IT dialogs.
• Use the Messages tab to specify whether to retrieve MOD 300 messages, Master
messages, or all messages when using the Message Log dialog. This tab is also
used to configure the default time span for queries.
The Restore Defaults button in the Options dialog restores the defaults for the
currently selected tab.
5.15.1 Data Format

The Data Format tab, Figure 5.116 is used to specify the items described in Table
5.6.
3BUF001094-600 B 239
Figure 5.116: Options Dialog, Data Format Tab

Horizontal List Use Horizontal List to list attributes horizontally and objects
vertically. An example is shown in Figure 5.117.
Vertical List Use Vertical List to list attributes vertically and objects
horizontally. An example is shown in Figure 5.117.
Attributes as Headers Use this option to have the names of the selected
attributes used as column headers (for Horizontal List) or
row headers (for Vertical List). An example is shown in
Figure 5.117.
Long Format When this orientation option is selected, object attributes
are presented in the long format with Attribute and Data
Value headings. A Long format example is shown in
Figure 5.118.
240 3BUF001094-600 B

(Continued)

Headers When this option is selected, headers are included in the
list.
Object Names When this option is selected, object names are shown;
otherwise, they are excluded.
History Log Calculation When this option is selected, calculation (aggregate) for
the History log is shown; otherwise, it is excluded.
Attribute Names When this option is selected, the names of the selected
attributes are shown.
History Data Quality When this option is selected, a data quality indication is
provided for History object values according to the
selected format (Symbolic, Numeric or Red-coded).
Symbolic When History Data Quality is enabled and Symbolic is
selected, the indication for good data is OK. The
indications for no data, bad data, and unknown status
respectively are: No Data, Bad Data, and ?_.
Numeric When History Data Quality is enabled and Numeric is
selected, data quality is indicated as a numeric error code.
Red-coded When History Data Quality is enabled and Red-coded is
selected, data quality is indicated in red.
Autofit All Columns If this option is checked, then all output to the worksheet
will have the columns autofitted (resized to accommodate
the longest value in the Excel column). If not selected, the
columns retain their original size.
Time Stamp When this option is selected, a time stamp is provided for
values that have an associated time stamp, for instance
History objects.
Note: If the time stamp field shows pound symbols
(#######), make sure the column width is sufficient to
show the complete date and time. If not, stretch the column
until it fits.
3BUF001094-600 B 241

(Continued)

Date and Time These fields are used to specify the date and time formats.
Formatting These formats apply to date and time presentation in the
Excel spreadsheets. The available formats are shown in
Figure 5.119.
of Active Time, Event Time and Acknowledge Time in
Alarm and Events functions.
Millisecond Select this checkbox for Alarm and Events function of
DataDirect that supports the retrieval of data.
of Active Time, Event Time and Acknowledge Time.
Horizontal Orientation
Vertical Orientation
Figure 5.117: Example, Using Attributes as Headers
242 3BUF001094-600 B
Figure 5.118: Example, Long Format
Figure 5.119: Date and Time Formatting
5.15.2 View
The View tab, Figure 5.120, is used to select which add-in tools to show or hide on
the DataDirect tool bar and menu bar. Add-in tools are grouped under two categories:
• Inform IT for use with earlier platforms, and when using DataDirect on a remote
computer client.
• Batch Management/PDL- for retrieving production data.
Each add-in tool has a separate check box for showing/hiding the add-in tool in the
DataDirect menu and/or the corresponding tool bar. Restore the default settings at
any time by clicking Restore Defaults. Figure 5.120 shows the default settings when
DataDirect is initially installed on an 800xA System node.
3BUF001094-600 B 243
Figure 5.120: View Tab
5.15.3 PDL/Batch
This tab, Figure 5.121, is used to specify:
• Type of PDL (800xA Batch Management, Batch 300, TCL, Profile Historian).
• Search Time Span.
• Whether or not to Search Criteria is Case Sensitive.
• Whether to Use Active Database or Use Restored Archive.
• Options for the Batch Data Dialog.
• Maximum Rows to be Returned.
• Language for Message Type.
244 3BUF001094-600 B
Figure 5.121: PDL/Batch Tab
Type of PDL
Use this pick list to specify the PDL application: 800xA Batch Management (default),
Batch 300, Taylor Control Language (TCL), Produce IT Batch, or Profile Historian.
This determines types of tasks available in the Task Type list in the PDL dialog
3BUF001094-600 B 245
(Configuring Options on page 238). Task types for the various PDL applications are
indicated in Table 5.7.
Table 5.7: Resulting Task Type Options Based on Type of PDL Selected
Type of PDL Task Type Options

800xA Batch Management (Default) Up to 15 user-configurable task types. Refer to
Configuring Flexible Task Types on page 246 for
details.
Produce IT Batch version 1.1 (and 1.2/0) Campaign - Level 0
Batch - Level 1
Procedures Level 1 - Level 2,3
Phase - Level 12
Batch 300 Job, Batch, Unit, Phase
TCL TCL Batch
Profiles Profile Events (Reel, Grade, Dayshift) - Level 1
Roll Set Information - Level 2
Generic Not applicable for this release.
The Produce IT Batch option is only applicable for Produce IT Batch versions 1.1
and 1.2/0. When using Produce IT batch version 1.2/1 or later, or 800xA Batch
Management select the 800xA Batch Management PDL Type.
Configuring Flexible Task Types

The 800xA Batch Management option in the Type of PDL pick list is used to con-
figure up to 15 user-defined task types. Selecting this option enables the Customize
button, Figure 5.122.
246 3BUF001094-600 B
Figure 5.122: Selecting Flexible Type of PDL
This button displays the Customize PDL Hierarchy dialog, Figure 5.123. Each level
has a default name. These names can be changed. To choose which levels to include
in the Task Type list in the PDL dialog, check the corresponding checkbox. Any
level whose checkbox is checked is included in the list.
Figure 5.123: Customize PDL Hierarchy Dialog
3BUF001094-600 B 247
Search Time Span

The Search Time Span fields are used to specify a default time span for the queries
executed in the PDL and Batch Data dialogs. The End Time in those dialogs defaults
to the current time. The time span specified here is subtracted from the End Time to
determine the Start Time for the query. After setting the default time span here, if the
same time span is always used, the start or end times in the PDL or Batch Data dialog
will not have to be adjusted. First select an interval: Hour, Day, Week, or Month.
Then select the number of intervals: 1 to 31. The default is 1 Week.
Search Criteria is Case Sensitive

Queries for Task names in the Oracle PDL database are case-sensitive. This option
can be used to specify whether or not an input Task Value entry will be automatically
converted to uppercase characters before a search request is executed. When all task
names are stored in uppercase characters, this option will not hinder a user when en-
tering lowercase values. The default is Unchecked (do not convert to uppercase).
Use Restored Archive

This is used to access PDL data that has been restored from an archive. When this
option is checked, all queries are performed against a set of PDL tables that contain
restored PDL data only. A message is generated on the PDL or Batch Data dialog to
indicate that a restored archive is being used. No message is displayed when an active
database is being used. The default is Unchecked (use active database).
Options for the Batch Data Dialog

There are two options related to the Batch Data dialog: Batch Data Function Options
and Search Criterion is Case Sensitive.
The Batch Data Function Options button displays a dialog that is used to edit the
names of the functions that are displayed in the Functions list on the Batch Data dialog,
Figure 5.124. The actual function names (as indicated in the Function Name column)
are fixed and cannot be changed. The name can be changed in the Readable Name
column. This is the text which is used in the Functions list on the dialog. The minimum
and maximum values for numeric filters may also be changed for each function.
The View name is provided for reference. This is the name to use if a function call
is entered manually.
248 3BUF001094-600 B
When an editable field is clicked on this dialog, the background turns grey, and the
field becomes an edit box as shown in Figure 5.124.
Figure 5.124: Batch Data Functions Options
The Search Criteria is Case Sensitive check box is used to specify whether or not
to make the text strings in the text filter dialogs case sensitive. The default is to make
the text strings not case sensitive. The text strings will be case sensitive when this
box is checked.
Maximum Rows to be Returned

This option is used to specify the maximum number of rows to be returned to the
client for each query that is executed. This helps prevent hanging the client computer
by generating queries that return an excessive number of rows. The range is 1 to
65,534. The default is 500.
Language for Message Type

This option specifies the language used for displaying message-type PDL data. The
choices are: English, German, Swedish. The default is English.
5.15.4 Setup
This tab, Figure 5.125, is used to configure the following communications settings:
• Data Provider Connections.
3BUF001094-600 B 249
• Enable/Disable Write Access to History and Process Values.

• Port Number.
• Timeout.
• Write Debug File.
• Disable Functions.
• Auto Apply Filters.
•
Figure 5.125: Options Dialog, Setup Tab
250 3BUF001094-600 B
Data Provider Connections

The Inform IT and Batch Data tools access data through data providers which are
managed through the ADSS tool in the Windows Control Panel. Data providers are
not applicable for the Industrial IT History, Process Values or Alarm/Event dialogs.
The Named Data Provider pick lists are used to select which data providers to use
for ad-hoc requests through the data retrieval dialogs. The corresponding functions
also use these data providers by default. Data providers may be specified directly in
the functions if necessary.
The default set-up supports most data access applications. It can be changed for special
requirements, such as writing access to historical data. To do this select the data
provider through the Named Data Provider pull-down lists, Table 5.8.
Table 5.8: Data Providers
Type Description
DCS Real-time data from Enterprise Historian-based process tags.
DBA Oracle-based data from historical message logs and Production Data Logs (PDLs).
LOG/HDA Historical process data:
• AIPHDA (Default) - for access through the 800xA OPC HDA server. This
supports seamless access to both trend logs and history logs. This also supports
access to log attributes.
• IMHDA - alternative OPC HDA server, not typically used. Refer to Appendix C.
• LOG - Historical data from Enterprise Historian-based logs.
AOS Supports the optional web-based Report Scheduling for earlier platforms.
OPC OPC real-time data access through specified OPC server. The default is AIPOPC.
This connects to the 800xA OPC DA server which provides access to all real-time
(process and softpoint) objects in the Aspect System.
Configuring Data Providers for display and client services is an Information

Management configuration activity.
3BUF001094-600 B 251
Data from a DCS data provider will be unavailable and its type set to UNK (un-
known) if DCS data provider connects to server after remote OPC data provider
has been connected. Do the following:
• Use different channel number for DCS data provider than one used by OPC
data provider. (This also requires changes in displays to reference new channel
number or new DCS data provider name).
• Make sure that DCS data provider connects to server before OPC data provider
does.
Name or Channel Number

DataDirect can reference data providers using either the Channel Number or -name
argument. The default setup is to use -name. Always reference data providers by
-name when accessing data from the 800xA System, or any platform later than Enter-
prise Historian 3.2/1.
Channel number may be used when connecting to an earlier version of Information
Manager (Enterprise Historian). Also, the -name argument is always required for
• process value update.
• history update.
• history retrieval of raw data.
To use -name, make sure the Use Channel Numbers check box is NOT selected.
To use channel numbers, select the Use Channel Numbers check box, and then select
the channel number from the Current Channel pick list. Use the default channel (0)
unless the server has more than the default set of data providers. If channel number
is used, the same channel number applies to all data providers. Channel number does
not support process value update, history update, and history retrieval of raw data.
If an invalid channel is specified, the request defaults to channel 0. To not use
channel 0 as the default for an invalid channel specifications, insure that no data
providers are assigned channel 0.
252 3BUF001094-600 B
Enable/Disable Write Access to History and Process Values

The Allow History Updates and Allow Process Updates check boxes are used to
enable/disable write access to history logs and process objects respectively. Figure
5.125
For the Inform IT History and Process values dialogs, the user authority is controlled
by data server and user:
data providers.
• On the user level, individual users must be authorized to add or modify. This is
configured in the user preference file.
This function does not recognize data providers by channel number, but rather by
the -name argument. Therefore the Use Channel Numbers option in the Options
dialog Setup tab must be DEACTIVATED (not selected).
Port Number
This is the current communications port on the computer from which data are being
retrieved. Use the default port (19014) unless there is a conflict between DataDirect
and some other application that requires that port number.
Timeout
This is the maximum time that DataDirect will wait for the selected object to respond
to the query before timing out. Increase the timeout interval if the application uses
complex SQL queries.
Write Debug File

When this option is selected, DataDirect writes status information to a text file that
can be read when troubleshooting. The file name is debug.txt. This file is located in
“C:\Users\<current user>\AppData\Roaming\ABB Industrial IT\Inform IT\DataDi-
rect\tmp. This way each user has their own debug file.”2.
3BUF001094-600 B 253
Disable Functions
When this check box is selected, all DataDirect functions in the Excel spreadsheet
are disabled. Functions must be disabled when inserting functions as described in
Configuring Options on page 238. The functions must be enabled to execute a specific
function, or calculate the entire workbook.
Any time functions are disabled and then re-enabled, then all functions in the
spreadsheet must be executed individually before the F9 key can be used to calcu-
late the entire workbook.
5.15.5 File Setup

The File Setup tab for Inform IT is given in Figure 5.126.
Figure 5.126: File Setup Tab
This tab is NOT applicable for Industrial IT tools. Use the File Setup tab to manage
text files for object and attribute pick lists in the ad-hoc data retrieval/entry dialogs,
254 3BUF001094-600 B
as well as the data provider pick lists on the Setup tab in the Options dialog. The op-
erations supported by this tab are:
• Changing the Text File Specification for a Pick List.
• Editing a Text File.
• Setting Object Name and Alias Options.
• Auto-Creating a Text File.
Changing the Text File Specification for a Pick List

Select the text file type from the Type pull down list. The current text file specification
for the selected file type is displayed in the Name field. To use a different text file,
enter a new path specification directly in the Name field, or use the Browse button
to navigate to and select a different file.
When the selected Type is Object, Object Type, Attributes, or History Object, a
file MUST be specified in the Name field. This specification is not mandatory
when the selected Type is Message Log.
Editing a Text File

To edit a text file, click the Edit button. This launches a text editor for the text file
currently listed in the name field. For guidelines on editing text files, refer to Config-
uring Pick Lists for Advant OCS Objects on page 258.
Setting Object Name and Alias Options

These three option buttons are used to choose whether to show just object names, just
aliases, or both aliases and object names in all applicable object pick lists. The options
are:
• Show object names.
• Show aliases.
• Show aliases and name.
If one of the alias options is used (Show aliases or Show alias and name), and an
alias was not entered in the object text file, the object name will be displayed in
place of the alias.
3BUF001094-600 B 255
Auto-Creating a Text File

The Auto Create function is used to create new text files for database fields associated
with the Message Log Type.
The Auto Create function is only applicable for Message Log Types (for example
Message Log Tag Names). The button is dimmed for all other Types.
1. To auto create a text file select one of the Message Log types, and then click the
Auto Create button, Figure 5.127. This displays the Auto Create dialog, Figure
5.128.
Figure 5.127: Launching the Auto Create Function
2. Use the Log Name and Database Field settings in this dialog to specify the
message log and message log attribute for which the file will be created.
Auto Create returns one instance of each unique entry in the specified Database
field. For instance, if the Database field is Tag_Name, and there are multiple in-
stances of the tag TC101, only one entry for that tag is returned.
3. Use the Filter edit box to limit the number of entries in the file by returning only
those database items that satisfy the filter. For example, if the Database Field is
Tag_Name, and the filter is TC* (or TC%), the file will only be populated with
tag names that have the TC prefix.
256 3BUF001094-600 B
Figure 5.128: Auto Create Dialog
The query result is written to a text file with a default name and location as indicated
in the Output File edit box. Change the file name and/or location as required. The
Browse button launches the standard Windows dialog for directory navigation and
file selection. The Edit button is used to open the specified file in the notepad text
editor.
5.15.6 Messages
This tab is used to configure message viewing options, Figure 5.129.
• Filter - when using the Alarm and Event tab on Inform IT Message Log dialog,
this specifies whether to query MOD 300 or Master message logs. Other spec-
ifies both MOD 300 and Master.
• Query Time Span - specifies the default time span for message queries. This
time span can be changed when the message query is actually generated as de-
scribed in Retrieving Message Logs on page 189.
• Batch Messages - specifies the batch application being used:
– ProduceIT 1.1 PDL Messages - Produce IT Batch v1.1 - 1.2.
– Batch Management Messages Log - 800xA System batches.
3BUF001094-600 B 257
5 DataDirect Inform IT 5.16 Configuring Pick Lists for Advant OCS O
Figure 5.129: Messages Tab
5.16 Configuring Pick Lists for Advant OCS Objects

When using DataDirect with earlier Information Manager and Enterprise Historian
platforms, the DataDirect Process and History Values dialogs provide an OPC
browser for browsing the connected OPC server to select data points to query. This
supports access to real-time process, softpoint, and historical property log data.
For Advant OCS objects that do not reside on an OPC server, configure text files to
populate object type, object, and attribute pick lists in these dialogs. This is required
for access to real-time and historical process data on Enterprise Historian platforms.
Pre-defined text files are provided as a starting point. Customize these pick lists to
better fit the object/attribute selection requirements. This is done by creating new text
files and then associating those text files with the corresponding pick lists. This pro-
cedure is described inPopulating Pick Lists below.
258 3BUF001094-600 B
5 DataDirect Inform IT 5.17 Populating Pick Lists
5.17 Populating Pick Lists

Text files define the contents of the pick lists for object and attribute selection in the
ad-hoc data retrieval/entry dialogs, and for data providers on the Setup tab in the
Options dialog. These text files are located in “%ABB_DATA%IM\DataDirect\etc”.3
A set of standard text files are provided with DataDirect as described in Table 5.9.
These standard files are not complete, and are only intended as a starting point. Create
additional files to customize object selection for the application. For instance, create
a file structure such as the one shown in Figure 5.130 to follow the specific plant
structure. The default text file for each type of pick list is specified through the Options
dialog File Setup tab.
Table 5.9: Standard Text Files
Category Description Standard Files

Object Type Populates object type pick lists for all dialogs • ModObjectTypes.txt.
File that require an object type specification. For an
• MasterObjectTypes.txt.
example, refer to Selecting the Object Type in
Reading Process Values on page 144.
Object File Populates object pick lists for all dialogs that • ModObjects.txt.
require an object specification. This along with
• MasterObjects.txt.
the selected object type determine the contents
of the object pick list. The Object File pick list
can be used to select a different text file.
Attribute File Populates the attributes pick lists for all dialogs • ModAttributes.txt.
that require an attribute specification.
• MasterAttributes.txt.
History Object Populates the object pick list for the History • ModHistoryObjects.txt.
File Value dialog. The Object File pick list can be
• MasterHistoryObjects.txt.
used to select a different text file. For an
example, refer to Log Calculation Algorithm in
Retrieving History Data on page 167.
3BUF001094-600 B 259

(Continued)

Message Log These files populate the following drop down • TagNames.txt.
Files menus in the Message Log dialog.
• BatchNames.txt.
• UnitNames.txt.
• SequenceNames.txt.
• PropertyText.txt.
• EventText.txt.
• Sections.txt.
• Networks.txt.
• Nodes.txt.
Aliases Aliases can replace, or be used in combination • ModObjects with Aliases.txt.
with object names where ever object names are
• MasterObjects with
used.
Aliases.txt.
Data Providers This file populates the data provider pick lists • DataProviders.txt.
on the Setup tab.
Figure 5.130: Organizing Text Files According to The Plant Structure
260 3BUF001094-600 B
5.17.1 Guidelines for Creating New Text Files

Follow these guidelines to create a new file. Use the standard text files for reference.
• File Naming and Directory Structure - There are no special requirements for file
names. Follow standard Windows conventions for file naming. It is not required
to put the text files in any specific directory.
• General File Syntax and Format - Enter one item (object, object type, attribute,
or history object) per line.
• Associating Object Types with Objects - A specific object type can be associ-
ated with each object When an object text file is created. To do this, use the fol-
lowing format: object name, object type, Figure 5.131.
Example MOD 300 Object Text File Example Master Object Text File
Figure 5.131: Example Text Files
When a specific object type is associated with an object, the object will only be in-
cluded in the Object pick list when the corresponding object type is selected. If an
object type is not associated with an object, the object will always be included in the
Object pick list, no matter which object type is chosen.
DO NOT enter a comma (,) after the object name unless an object type is also
being specified.
• Naming History Objects - For History Object text files, use the full log name
as specified in the History database. Include commas (,) if there are any. Refer
to Property Log Naming Conventions on page 32 for details regarding log name
syntax.
• Data Providers - Enter the data provider name followed by the data provider
type, separated by a comma. Each instance of a data provider type requires a
3BUF001094-600 B 261
separate line. For example in Figure 5.132, there are two DCS (real-time data)
data providers. One is named DCS (the default). The second is named DCS2.
Data Provider Type

Data Provider Name
Figure 5.132: Example, Data Provider Text File
Applying New Default Files

The default text files for all pick lists are specified through the File Setup tab on the
Options dialog. These defaults can changed as required. For details, refer to File
Setup.
Aliases
Aliases are alternate names for objects. Aliases can replace, or be used in combination
with object names where ever object names are used. This includes all object pick
lists in DataDirect dialogs, and in Excel spreadsheets where query results are displayed.
Aliases are optional, and apply only to Object and History object text files. If the
object text file is created with aliases, then use the Options File Setup tab to specify
whether to show just aliases, just object names, or both aliases and object names.
262 3BUF001094-600 B
Object Names
Aliases
Excel Output with

Both Alias & Object Name
Figure 5.133: Example - Using Both Aliases and Object Names
To include aliases in the object text file, use the following format:
@Alias, ObjectName, ObjectType
To include aliases in the History object text file, use the following format:
@Alias, ObjectName,Attribute
The alias is the first value in each line, and must be prefixed with a @ symbol. An
example is shown in Figure 5.134.
3BUF001094-600 B 263
5 DataDirect Inform IT 5.18 Functions for Reading/Writing Inform IT
These Lines Have

Aliases Configured
Figure 5.134: Example, Including Aliases in Object Text File
• The @ symbol MUST be the first character on the line. Leading spaces are
not allowed.
• Spaces are allowed in alias names, for instance Flow 1.
5.18 Functions for Reading/Writing Inform IT Process

Values
DataDirect Inform IT provides functions for reading and writing real-time process
values. When running DataDirect on a computer that does not have 800xA base system
software (a remote Desktop Tools client), use the Inform IT functions to query aspect
objects in the 800xA System. The Inform IT functions may be used on 800xA System
nodes when connecting to a server that is outside the 800xA System, for example an
earlier Enterprise Historian server. This is used to query objects on that server that
are not a part of the 800xA System. This functionality is not supported by the System
800xA functions.
The functions for Reading/Writing Process Values for Inform IT are explained in
below.
The Inform IT Functions for Process Values are:
• ABBGetObj on page 265 (Read value for one object).
• ABBUpdateObj on page 266 (Write to an object).
264 3BUF001094-600 B
5.18.1 ABBGetObj
The ABBGetObj function retrieves the specified attribute value for the specified object.
The Inform IT Process Values dialog may also be used in the Formula mode to insert
this function (Using the Inform IT Process Values Dialog on page 142). The syntax
for ABBGetObj is:
=ABBGetObj(Object Type, ObjectName [,Attribute] [,data provider])
where:
Object Type when getting data from an OPC server, enter OPC for object type.
For MOD 300 or Master OCS applications, this is the table name
where objects having a specific set of object attributes reside. For
example, CCF_PID_LOOP for systems with MOD 300 software, or
PIDCON for systems with Master software.
ObjectName is the tag name for the object. Use the object browsing tools in the
Process Values dialog to find object names for the specified object
type. Refer to Selecting OPC Tags on page 145.
[Attribute] is the name of the attribute whose value is to be retrieved. The attribute
specification is NOT required for queries on OPC objects. The Value
attribute is always returned.
[data specifies the name of the data provider through which this query will
provider] be routed. This parameter is optional. If a data provider is not specified,
the default data provider is used. To use a different data provider,
specify the -name argument that uniquely identifies the data provider.
For further details regarding data providers refer to Data Provider
Connections on page 251.
For OPC object values, the data provider must be referenced using the -name ar-
gument and not the channel number. The Use Channel Numbers option must NOT
be selected in the Setup tab of the Options dialog.
Enter all parameters as text strings with double quotes. Examples:
=ABBGetObj(“CCF_PID_LOOP”, “TC101”, “MEASURE”)
=ABBGetObj(“PIDCON”, “FIC101”, “VALUE”)
=ABBGetObj (“OPC”, “CalculationServer_ENG189ExecPerMin:Value”)
3BUF001094-600 B 265
5.18.2 ABBUpdateObj
The ABBUpdateObj function is used to update process values. This is the same
functionality provided by the Update Process Values dialog as described in Writing
User Authority
The proper user authority is required to update process values. This is controlled at
on the Setup tab of the Options dialog. Log in as an Administrator-level user to
change these settings. Refer to Enable/Disable Write Access to History and
data providers.
• On the user level, individual users must be authorized to write to process objects.
This is configured in the user preference file. By default, users are NOT granted
this authority. Adjust this preference for a user when managing Information
Management users.
Data Provider Specification
This function does not recognize data providers by channel number, but rather by the
-name argument. Therefore the Use Channel Numbers option in the Options dialog
Setup tab must be DEACTIVATED (not selected). Refer to Setup on page 249.
Syntax
=ABBUpdateObj (objtype, objname, value, [objatt], [,data provider])
where:
ObjType when updating data on an OPC server, enter OPC for object type. For
MOD 300 or Master OCS applications, this is the table name where
objects having a specific set of object attributes reside. For example,
CCF_PID_LOOP for systems with MOD 300 software, or PIDCON
for systems with Master software.
266 3BUF001094-600 B
ObjName is the tag name for the object. Use the object browsing tools in the
Process Values dialog to find object names for the specified object
type. Refer to Selecting OPC Tags on page 145.
Value is the new value to be applied to the specified attribute.
ObjAtt is the name of the attribute whose value is to be retrieved. The attribute
specification is NOT required for queries on OPC objects. The Value
attribute is always returned.
[data specifies the data provider through which this update operation will
provider] be routed. This parameter is optional. If data provider is not specified,
Enter all parameters as text strings with double-quotes.
Example:
=ABBUpdateObj("CCF_PID_LOOP", "FC3015", "SETPOINT", "8", "DCS")
=ABBUpdateObj(“PIDCON”, “FIC101”, “VALUE”, “19”, “DCS”)
=ABBGetObj (“OPC”, “CalculationServer_ENG189ExecPerMin:Value”, “100”,
“AIPOPC”)
5.19 Functions for Reading/Writing Inform IT History

Values
DataDirect Inform IT provides functions for reading and writing history data. If
DataDirect is being run on a computer that does not have 800xA base system software
(a remote Desktop Tools client), use the Inform IT functions to query aspect objects
in the 800xA System. The Inform IT functions may be used on 800xA System nodes
that need to be connected to a server that is outside the 800xA System, for example
an earlier Enterprise Historian server. This is used to query objects on that server that
are not a part of the 800xA System. This functionality is not supported by the System
800xA functions.
The functions for Reading/Writing History Values for Inform IT are explained below.
The Inform IT Functions for History Values are:
3BUF001094-600 B 267
• ABBGetHistory on page 268 (Read values).

• ABBEditLog on page 271 (Write to single entry).
• ABBEditNLogs on page 272 (Write to multiple entries).
• ABBGetAttributes on page 274 (Get a list of log attributes).
• ABBGetAttributeValue on page 275 (Get attribute values).
5.19.1 ABBGetHistory
The ABBGetHistory function retrieves a specified number of values for the specified
history log object. By default this function retrieves the columns of data selected on
the Data Format tab on the Options dialog. Refer to Data Format on page 239. The
default setting on this tab is to display Time Stamp, History Data Quality Indication,
and Value. Change the settings on the Data Format tab, or use the output parameter
in this function to change the output specification.
The syntax for ABBGetHistory is:
=ABBGetHistory(Logname, Interpolation, Start Time, End Time, MaxCount [,Format
Date] [,data provider][,output][,mSec])
where:
Logname is the access name for the log whose data is to be retrieved. Use the
object browsing tools in the History Values dialog to find log names.
Refer to Accessing Property Logs through OPC HDA on page 170.
Interpolation is the type of calculation performed by the log. The available options
depend on the connected data provider for history access. For further
information refer to Log Calculation Algorithm on page 93.
Start/End these specify the time range for which data will be retrieved.
Time
time span divides the time range into discrete intervals for which data
values are returned.
268 3BUF001094-600 B
[data specifies the data provider through which this operation will be routed.
provider] This is optional. If data provider is not specified, the default data
provider is used. To use a different data provider, specify the
-name argument that uniquely identifies the data provider. For further details regarding
data providers refer to Data Provider Connections on page 251.
on page 239). Use this option to specify that any combination of the
following columns be displayed:
header = 1
object name = 2
calculation = 4
time stamp = 8
attribute name = 16
data quality = 32
to the sum of the integer values for the columns being displayed. For
[mSec] specifies whether or not to show the time stamp with millisecond
resolution (true = show milliseconds, false = do not show
milliseconds).
Enter all parameters (except MaxCount, output, and displayMilliseconds) as text
strings with double quotes. For start time and end time, the date and time must be
separated by a space. MaxCount and output are specified as integer values.
Example:
=ABBGetHistory(“FC3051,MEASURE”, “max”, "11/3/00 14:30", “11/3/00 19:30”,
5, “n”,“IMHDA”)
3BUF001094-600 B 269
=ABBGetHistory(“H0000X000K-000000:MEASURE,log1”, “max”, "11/3/00 14:30",

“11/3/00 19:30”, 5, “n”,“AIPHDA”)

The number of values returned by the ABBgetHistory function is determined by the
MaxCount parameter, and by the number of rows selected in the Excel spreadsheet
(step 2 in Inserting DataDirect Functions Manually on page 73).
• If MaxCount > selected rows, the excess values are truncated.
• If MaxCount < selected rows, the excess rows are left blank.
Use the MaxCount parameter to make the number of values returned match the
number of rows selected. To do this specify the MaxCount parameter as -1. For ex-
ample:
=ABBGetHistory(“FC3051,MEASURE”, “max”, "11/3/00 14:30", “11/3/00 19:30”,
-1,“IMHDA”)
Again, if there are less values in the log than there are rows specified, the excess rows
are left blank.
Formatting the Date

in the ABBGetHistory function.
the Options dialog, are not applied to the timestamp returned by the ABBGetHistory
function. Additionally, the returned timestamp is a date data type.
the Options dialog, are applied to the timestamp returned by the ABBGetHistory
function.
270 3BUF001094-600 B
returned by the ABBGetHistory function. This is the same as specifying formatDate

as y or Y.
5.19.2 ABBEditLog
The ABBEditLog function is used to add a single entry to a lab data history log, or
modify an existing log entry. This is the same functionality provided by the
Add/Modify Values dialog as described in Adding/Modifying Entries for a Lab Data
Log on page 177. To add multiple entries in one function call, use ABBEditNLogs on
page 272.
User Authority
The proper user authority is required to add and/or modify logs. This is controlled at
on the Setup tab of the Options dialog. Log in as an Administrator-level user to
change these settings. Refer to Enable/Disable Write Access to History and
data access for display and client services.
• On the user level, individual users must be authorized to write to log objects.
This is configured in the user preference file. By default, users are NOT granted
this authority. Adjust this preference for a user when managing Information
Management users.
Data Provider Specification
This function does not recognize data providers by channel number, but rather by the
-name argument. Therefore the Use Channel Numbers option in the Options dialog
Setup tab must be DEACTIVATED (not selected). Refer to Data Provider Connections
on page 251.
Syntax
Enter all parameters as text strings with double-quotes. The syntax is as follows:
=ABBEditLog ("ADD" or "MODIFY”, ObjName, ObjValue, timeStamp, objectSta-
tus [,data provider])
where:
3BUF001094-600 B 271
ObjName is the log name. Use the access name to add an entry. Always use the
full log name to modify. Use the object browsing tools in the History
Values dialog to find log names. Refer to Accessing Property Logs
through OPC HDA on page 170.
ObjValue is the new value for the log entry.
timeStamp is the time stamp for the entry. When modifying an existing entry the
time stamp must be accurate within one second. To get the precise
time stamp, retrieve the raw data for the log entry as described in
Reading/Writing History Data on page 164.
objectStatus is an option used to enter an integer value to associate with this log
entry. For example, ObjectStatus may be used to identify the user that
added/modified the entry. This value defaults to 0 (zero). It is not
necessary to change this value if this functionality is not used.
[data specifies the name of the data provider through which this update
provider] operation will be routed. This parameter is optional. If data provider
is not specified, the default data provider is used. To use a different
data provider, specify the -name argument that uniquely identifies the
data provider. For further details regarding data providers refer to
Data Provider Connections on page 251.
Examples:
=ABBEditLog("ADD", "H000X000K-000000,MEASURE", "15", "3/16/2001
13:22:00", "0", "IMHDA")
=ABBEditLog("MODIFY", "H000X000K-000000:MEASURE,Log1", "15",
"3/16/2001 13:22:00", "0", "AIPHDA")
5.19.3 ABBEditNLogs
The ABBEditNLogs function is used to add multiple entries to a lab data history log,
or modify existing log entries. This is the same functionality provided by the
Add/Modify Values dialog as described in Adding/Modifying Entries for a Lab Data
Log on page 177. To change one entry at a time, use ABBConnect on page 279.
User Authority and Data Provider Specification
The requirements for user authority and data provider specification are the same as
for ABBConnect on page 279.
Log Entry Specification
272 3BUF001094-600 B
The log entry specification contains the values, time stamps and object statuses for
each log entry being added or modified. This specification must be entered in the
proper format in the spreadsheet. The function references the row/column range where
this information is entered. An example specification is shown in Figure 5.135.
Refer to ABBConnect on page 279 for details regarding values, time stamps, and object
statuses.
Values Time Stamps Object Statuses
Figure 5.135: Example, Log Entry Specification
Syntax
=ABBNEditNLogs ("ADD" or "MODIFY”, ObjName, range, [,data provider])
where:
ObjName is the log name. Use the access name to add an entry. Always use the
full log name to modify. Use the object browsing tools in the History
Values dialog to find log names. Refer to Accessing Property Logs
through OPC HDA on page 170.
rangeis the range of rows and columns in the spreadsheet where the pre-formatted
log entry specification is located.
[data specifies the data provider through which this update operation will
provider] be routed. This parameter is optional. If data provider is not specified,
3BUF001094-600 B 273
Enter all parameters as text strings with double-quotes.

Examples:
To add a log:
=ABBNEditLogs("ADD", "FC3015,MEASURE", A1:C5, "LOG")
=ABBNEditLogs("ADD", "H000X000K-000000,MEASURE", A1:C5, "IMHDA")
To modify a log:
=ABBNEditLogs("MODIFY", "$HSFC3015,MEASURE-1-o", A1:C5, "LOG")
=ABBNEditLogs("MODIFY", "$H000X000K-000000:MEASURE,Log1", A1:C5,
"AIPHDA")
5.19.4 ABBGetAttributes
The ABBGetAttributes function retrieves the attribute list for history objects that reside
on an OPC HDA server (for example, the 800xA OPC HDA server). Use the result
from this function call to query for attribute values in the ABBGetAttributeValue
function.
To specify the server whose attribute list is being retrieved, indicate the corresponding
data provider -name in the function call. The syntax for ABBGetAttributes is:
=ABBGetAttributes(dataProvider)
where:
data indicates the -name argument of data provider that supports the OPC
provider HDA server whose attribute list is to be retrieve. For example, the
-name argument for the data provider that supports the 800xA OPC
HDA server is AIPHDA.
Enter the data provider text string with double quotes. Example:
=ABBGetAttributes(“AIPHDA”)
274 3BUF001094-600 B
5.19.5 ABBGetAttributeValue
The ABBGetAttributeValue function retrieves values for a specified OPC HDA object
attribute for a specified time period. The syntax for ABBGetAttributeValue is:
=ABBGetAttributeValue(ObjectName, TimeHandling, Time, TimeScope, AttributeID,
data provider)
where:
ObjectName Enter the object name directly if known. If not, use the History Values
dialog as described in Accessing Property Logs through OPC HDA
on page 170. If the Object Name has been inserted into the spreadsheet,
reference the applicable cell in this argument - for example: C9.
TimeHandling This is used in combination with Time and TimeScope to define the
time period for which to retrieve data. Enter one of the following text
strings:
To - Causes Time to be used as an end point for the time period. The
start point is set by TimeScope.
From - Causes Time to be used as a start point for the time period.
The end point is set by TimeScope.
Time This is the time period starting point (when TimeHandling is From)
or ending point (when TimeHandling is To)
TimeScope This specifies the amount of time (in seconds) to go back from Time
(when TimeHandling is To) or to go forward from Time (when
TimeHandling is From)
AttributeID is an integer value that identifies the attribute whose value is to be
retrieved. This ID is provided in the result of the ABBGetAttributes
function call.
data specifies the name of the data provider through which this query will
provider be routed. Specify the -name argument that uniquely identifies the
data provider. For further details regarding data providers refer to
Data Provider Connections on page 251.
Enter all parameters (except AttributeID and TimeScope) as text strings with double
quotes. For Time, the date and time must be separated by a space. AttributeID is an
integer. TimeScope is a long.
Examples:
3BUF001094-600 B 275
5 DataDirect Inform IT 5.20 Miscellaneous Functions
=ABBGetAttributeValue(“C9”, “From”, "06/03/02 14:30", 28800, 7,”AIPHDA”)

This query gets the attribute value for the attribute whose ID = 7 for the object whose
name is inserted in cell C9 of the spreadsheet, starting at 14:30 on June 3rd 2002 and
ending eight hours later (28,800 seconds).
5.20 Miscellaneous Functions

These functions may be used on 800xA System nodes and on pc clients without
800xA software:
• ABBSql on page 276.
• ABBArray on page 278.
• ABBConnect on page 279.
• ABBDisconnect on page 279.
5.20.1 ABBSql
The ABBSql function retrieves data according to the specified SQL query. It is intend-
ed primarily for access to Oracle data. This function is not intended for querying
historical and process objects on Windows-based data servers. These applications are
better supported by ABBGetOPCHDA and ABBGetOPCDA.
To use this function to query historical and process objects on a Windows-based
data server, then install the Open Data Access (ODA) option on the data server,
and configure an ADO data provider to support ODA. The easiest way to create
this data provider is to copy the existing ADO data provider, and make the follow-
ing two changes to the data provider argument list:
• Change the -name argument, for example: from DBA to DBA1.
• Set the -dbname argument to Database1.
Configuring data providers is an Information Management configuration activity.
During development, attempt data retrieval for Numeric Logs using both methods
ABBGetOPCHDA() and the ODA provider using ABBSql(). Similarly for Alarm
data test using both ABBAERetrieval() and ABBSql() to the Message log. There are
advantages and disadvantages to each in terms of performance and the ability to ma-
nipulate the data in a useful manner, often depending upon the application.
The syntax for ABBSql is:
276 3BUF001094-600 B
=ABBSql(SQL Statement, MaxCount [,data provider])

where:
SQL is an SQL statement. A query saved through the SQL Query dialog
Statement (Saving and Re-using SQL Queries on page 233) or OPC/Audit Trail
message dialog (Saving a Query on page 196)may be used. To do this,
enter @QueryName, for example @MsgLog1.
MaxCount This is used to set the maximum number of responses to a manageable
quantity. The largest possible number is 9999.
[data specifies the data provider through which this query will be routed.
provider] This parameter is optional. If a data provider is not specified, the
default data provider is used. To use a different data provider, specify
the -name argument that uniquely identifies the data provider. For
further details regarding data providers refer to Data Provider
Enter the SQL statement and data provider (if used) as text strings with double quotes.
MaxCount is an integer.
Example:
=ABBSql(“select localtime,message from modmsglog where localtime > sysdate-
1”, 50)
Example, entering a named query: =ABBSql(“@MsgLog1”,10)
on page 69.
Requesting All Data
The number of values returned by the ABBSql function is determined by the MaxCount
parameter, and by the number of rows selected in the Excel spreadsheet (step 2 in
Inserting DataDirect Functions Manually on page 73).
Use the MaxCount parameter to return all possible values according to the query. To
do this specify the MaxCount parameter as 0. For example:
=ABBSql(“select taskid,taskname from history.pdl_task_view”, 0)
If MaxCount > selected rows, excess values are truncated.
If MaxCount < selected rows, excess rows are filled in with blanks.
3BUF001094-600 B 277
Excel limits the maximum number of elements that can be returned per function
call to 5460, for example:
• 5460 rows and 1 column of data or
• 2730 rows and 2 columns of data or
• 1820 rows and 3 columns of data.
5.20.2 ABBArray
The ABBArray function retrieves data for the specified TCL unit array. The syntax
for ABBArray is:
=ABBArray(Object Type, Object, Attribute, MaxCount [,data provider])
where:
Object Type is the table name where TCL objects having a specific set of object
attributes reside. For example: TCL_AI_UNIT_VAR or
TCL_AS_UNIT_VAR.
Object is the name of the TCL object.
Attribute is the name of the attribute whose value is to be retrieved.
MaxCount This is used to set the maximum number of responses to a manageable
quantity. The largest possible number is 9999.
[data specifies the data provider through which this query will be routed.
provider] This parameter is optional. If data provider is not specified, the default
data provider is used. To use a different data provider, specify the
-name argument that uniquely identifies the data provider. For further
details regarding data providers refer to Data Provider Connections
on page 251.
Refer to the Object Types Reference Manual for more information on TCL Unit Array
object types, and their respective attributes.
Enter all parameters (except MaxCount) as text strings with double quotes. MaxCount
is an integer.
Example:
=ABBArray(“TCL_AI_UNIT_VAR”, “TIC101”, “AIVALUE”, 20)
Requesting All Data
278 3BUF001094-600 B
The number of values returned by the ABBArray function is determined by the

MaxCount parameter, and by the number of rows selected in the Excel spreadsheet
(step 2 in Inserting DataDirect Functions Manually on page 73).
Use the MaxCount parameter to return all values in the array. To do this specify the
MaxCount parameter as 0. For example:
=ABBArray(“TCL_AI_UNIT_VAR”, “TIC101”, “AIVALUE”, 0)
• If MaxCount > selected rows, the excess values are truncated.
• If MaxCount < selected rows, the excess rows are filled in with blanks.
The maximum number of values that Excel is used to return is 32,767. This number
may be limited further by the amount of data associated with each value.
5.20.3 ABBConnect
ABBConnect is used to connect the DataDirect client to the data server. This is the
same functionality provided by the Login dialog as described in Login on page 139.
=ABBConnect (Host, User, Password)
where:
Host is the computer name for the computer where the display server
software is installed. Refer to Host on page 141.
User the user name for the Display client. Refer to User on page 140.
Password is the password for the specified User. Refer to Password on page 141.
Enter all parameters as text strings with double quotes.
Example:
=ABBConnect ("tar220", "aid" ,"password")
5.20.4 ABBDisconnect
ABBDisconnect is used to disconnect the DataDirect client from the data server.
=ABBDisconnect ()
There are no parameters for this function.
3BUF001094-600 B 279
Example:
=ABBDisconnect ()
5.20.5 Using VBA Macros

The syntax for a VBA macro that references a DataDirect function is as follows:
<results> = Application.Run("abbdatadirect.xla!<functionName>",
[functionParameters] where
<results> is an array or worksheet range (outputRange.Value in the example below)
<functionName>
To schedule a DataDirect report with VBA macros, set the Macro security level
to low on the computer where the report will run. Refer to Enabling Macros on
page 52.
The following is a simple macro which extracts historical log data and charts it in an
xy scatter chart.
Sub runFunctionsFromMacro()
Dim outputRange As Range
'define output range

Set outputRange = ActiveSheet.Range("a1:c25")
'get ABB data

outputRange.Value = _ Application.Run("abbdatadi-
rect.xla!abbgetHistory", _ "AFWAV1,MEA-
SURE","any","9/12/2000 8:00:00", _
"9/12/2000 10:10:10", 25)
'set format for timestamps in first column

outputRange.Resize(outputRange.Rows.Count, -
1).NumberFormat = "mm/dd/yy hh:mm:ss"
'Create XY Scatter chart using first columns of data only

Charts.Add
ActiveChart.ChartType = xlXYScatterLines
ActiveChart.SetSourceData Source:=outputRange.Resize(out-
putRange.Rows.Count, 2), _ PlotBy:=xlColumns
ActiveChart.Location Where:=xlLocationAsObject, _
Name:=outputRange.Parent.Name
End Sub
5.20.6 Adding Charts to DataDirect Reports

Use the Chart Wizard in Microsoft Excel to add charts to DataDirect reports, Figure
5.136. Refer to the online help for this Excel function for general instructions on
280 3BUF001094-600 B
adding charts. This section provides guidelines and recommendations that are specific
to DataDirect.
Figure 5.136: Example, Chart Added to DataDirect Report
How to start the Chart Wizard is shown in Figure 5.137.
3BUF001094-600 B 281
Figure 5.137: Starting the Chart Wizard
Recommendations for Chart Type

It is recommended that the Line chart type and data point sub-type, Figure 5.138 be
used. The Line chart type provides time stamps on the y axis. With the data point
sub-type, the cursor can be hovered over individual data points to display the corre-
sponding values.
Selecting Line Type
Selecting Data Point

Sub-type
Figure 5.138: Selecting Chart Type
Making Charts Dynamic
282 3BUF001094-600 B
Make charts update dynamically by editing the start/end time specification in the array
formula. Use the TEXT function to specify a dynamic time range, for example NOW
minus one hour, Figure 5.139.
Original Formula
Edited Formula
Figure 5.139: Editing the Array Formula
3BUF001094-600 B 283
284 3BUF001094-600 B
6 Using Desktop Trends 6.1 Product Overview
6 Using Desktop Trends
This section describes how to use Desktop Trends for data access. To get familiar
with this application, refer to Product Overview on page 285. For connection and set-
up instructions, refer to Connection and Setup on page 286. For a solution to user errors
caused by changing regional settings, refer to Changing Regional Settings Causes
User Errors on page 291. For instructions on using the various desktop tools, refer to:
• Trend Display on page 293.
• Ticker on page 336.
• Tag Explorer on page 375.
• PDL Browser on page 386.
• Batch Batch Display on page 403.
• Event Browser on page 404.
• SQL Browser on page 408.
• OPC Browser on page 416.
6.1 Product Overview

Desktop Trends is used to view real time, trend, production, and event data through
ActiveX controls on the Information Management display client. There are seven
controls:
• The Trend Display shows graphical traces for up to eight tags. The Trend Display
supports common trend display tools including, zoom, ruler, filtering, and time
offset. Refer to Trend Display on page 293.
• The Ticker shows a repeating stream of real time data for selected tags, similar
to a stock market ticker. Refer to Ticker on page 336.
• The Tag Explorer is used to structure points in a familiar browsing and access
format. Refer to Tag Explorer on page 375.
3BUF001094-600 B 285
6 Using Desktop Trends 6.2 Connection and Setup
• The PDL Browser is used to access production data from Production Data Logs
for Produce IT Batch, Batch 300, TCL Batches, and Profile Historian. Refer to
PDL Browser on page 386.
• The Batch to Batch Display combines the functionality of the Trend Display
with the PDL Browser to navigate the PDL structure to find and display historical
trends for different batches. Refer to Batch Batch Display on page 403.
• The Event Browser is used to retrieve messages from OPC and Audit Trail
message logs configured through the Information Management - History Server
function. Refer to Event Browser on page 404.
• The SQL Browser is used to run ad-hoc SQL queries. A query can be saved
once it is run. It can then be reopened for viewing at some time in the future or
deleted. Refer to SQL Browser on page 408.
6.2 Connection and Setup

This section describes how to connect the Desktop Trend client to a data server, and
how to configure custom text files to:
• populate pick lists for tag/attribute selection.
• specify attributes for the high/low limits to be associated with each object type.
6.2.1 Connecting to the Data Server

The Desktop Trend controls are client applications that require a connection to a data
server. When the Desktop Trend software is installed directly on the server, the controls
are connected to the local server by default. To connect the controls to a different
server, or if the Desktop Trends software is installed on a remote computer client,
then use the ACC Setup utility to establish the connection with a remote data server.
The ACC Setup utility is used by other Information Management applications.
Check whether or not another user is already using the tool by looking for the
ACC.exe process in the Windows Task Manager. Use the tool simultaneously
with other users; however, connection changes made in this tool will not take affect
until the ACC.exe process is no longer active.
Use the ACC Setup tool to specify the IP address or alias for the server. To launch
this tool, from the Windows Taskbar choose:
286 3BUF001094-600 B
ABB Start Menu > ABB System 800xA > Information Mgmt>Utilities> IM
ACC Setup.
To maintain the connection to the local server, leave the Data Server Name specified
as localhost (default). To connect the desktop controls to a remote server, enter the
IP address or alias for the server in the Data Server Name field, Figure 6.1.
Enter the client user name and password. All other fields may be left at their default
values. All other fields may be left at their default values. Click OK when finished.
Figure 6.1: ACC Setup Tool
6.2.2 Setting Up Pick Lists

The Desktop Trends controls provide an OPC browser for browsing the connected
OPC server to select data points to query. This supports access to real-time process,
3BUF001094-600 B 287
softpoint, and historical property log data. For data points that do not reside on an
OPC server, configure text files to populate object type, object, and attribute pick
lists in these dialogs. This is required for access to OMF-based real-time and process
data on earlier Enterprise Historian platforms (systems with MOD 300 and Master
software).
Pre-defined text files are provided as a starting point. Customize these pick lists to
better fit the object/attribute selection requirements. This is done by creating new text
files and then associating those text files with the corresponding pick lists. Text files
define the contents of the pick lists for tag and attribute selection for the Ticker and
Tag Explorer controls. These text files are located in “%ABB_ROOT%InformIT\Desk-
top Trends\Default Files\Picklists”.4
A set of standard text files are provided as described in Table 6.1. These standard
files are not complete, and are only intended as a starting point. Create additional
files to customize tag/attribute selection for the application. For instance, create a file
structure such as the one shown in Figure 6.2 to follow the specific plant structure.

Object Type Populates object type pick list in the Ticker File • ModObjectTypes.txt
Configuration dialog.
• MasterObjectTypes.txt
• ObjectTypes.txt
Tag Names Populates tag name pick list in the Ticker File • TagNames.txt
Attribute Populates the attributes pick list in the Ticker File • ModAttributes.txt
• MasterAttributes.txt
• Attributes.txt
Data Populates the Data Providers pick list in the Ticker • Data Providers.txt
Providers File Configuration dialog.
4. The default path for %ABB_ROOT% is: C:\Program Files\ABB Industrial IT\
288 3BUF001094-600 B
Figure 6.2: Organizing Text Files According to The Plant Structure
6.2.3 Guidelines for Creating New Text Files

Follow these guidelines to create a new file. Use the standard text files for reference.
• File Naming and Directory Structure - There are no special requirements for
file names. Follow standard Windows conventions for file naming. It is not nec-
essary to put the text files in any specific directory.
• General File Syntax and Format - Enter one item (tag, object type, or attribute)
per line. Examples are provided in Figure 6.3.
Figure 6.3: Example Text Files
3BUF001094-600 B 289
6.2.4 Applying New Default Files

The default text files for all pick lists in the Ticker and Tag Explorer are specified
through the File tab in the Default Ticker Configuration and Tag Explorer Configu-
ration dialogs respectively. Change these defaults as required or edit the limits file
from this tab.
For the ticker, refer to File Specifications on page 363.
For the Tag Explorer, refer to File Specifications on page 382.
6.2.5 Setting Up the Limits File

When adding a tag to a Ticker or Tag Explorer file (Configuring Tags on page 339),
specify that a limit check be performed on the tag. When limit checking is enabled,
tags that exceed their limits are displayed in a specified color. The limit values can
also be specified directly, or the values can be derived from a data source on the
system where the tag resides. In this case, the data sources for each high and low
limit must also be specified. This association is made in a text file, similar to the pick
list text files described in Setting Up Pick Lists on page 287.
By default, this text file is “%ABB_ROOT%InformIT\Desktop Trends\Data\Limits.txt.
Files specifically for MOD 300 (ModLimits.txt) and Master (MasterLimits.txt) are
also provided.
Guidelines for Creating New Limits Files

As with pick lists, use the predefined text files, or create a custom file. The Limits.txt
file is shown in Figure 6.4. Use this file as a guide.
To create a new file, add a new line for each new object type. Enter the names for
the object type, low limit attribute, and high limit attribute, in that order, separated
by colons (:). For example:
CCF_CONTIN_LOOP:LO_CONV:HI_CONV
AO:RANGE_MIN:RANGE_MAX
For OPC data, set the low and high limits using other OPC tags. To do this, add a
line in the limits file for a user-defined object type, for example: OPCLoHi. Then,
specify the OPC tags whose values will be used for the low and high limits. Again,
separate the object type and tag names with colons. For example: if the OPC tag
whose value will be used for low limit is LIC101.LowLim and the OPC tag whose
value will be used for high limit is LIC101.HighLim, enter the following line in the
Limits text file:
290 3BUF001094-600 B
6 Using Desktop Trends 6.3 Changing Regional Settings Causes User E
OPCLoHi:LIC101.LowLim:LIC101.HighLim.
When adding an OPC tag to a ticker or tag explorer, and the OPC tag uses other OPC
tags to set the high/low limits, then enter the user-defined object type for high/low
limits in the new tag’s object type field, and set the Limit Check option to Get From
System. Refer to Tag Name on page 349, and Limit Check on page 351.
Figure 6.4: Limits.txt File
6.2.6 Applying New Default Files

The default text files for the limits file in the Ticker and Tag Explorer are specified
through the File tab in the Default Ticker Configuration and Tag Explorer Configu-
ration dialogs respectively. These defaults can be changed as required. The limits file
can also be edited from this tab. For the ticker, refer to File Specifications on page
363. For the Tag Explorer, refer to File Specifications on page 382.
6.3 Changing Regional Settings Causes User Errors

Every user who changes regional settings after installing and using Desktop Tools
will not be able to use Desktop Tools.
If this occurs, delete all .ini files in the following folder for each user:
c:\Documents and Settings\user_name\Application Data\ABB Industrial
IT\Desktop Trends
3BUF001094-600 B 291
6 Using Desktop Trends 6.4 Settings to open the Desktop Trend Tools
6.4 Settings to open the Desktop Trend Tools

Follow the steps below to perform the settings to open the Desktop trend tools from
the Windows Taskbar.
This settings has to be done to change the default settings of internet explorer 11
and above.
1. Open Internet Option.
2. Go to Programs tab.
3. In section opening Internet Explorer change the drop down to Always in In-
ternet Explorer on the Desktop as given in Figure 6.5.
Figure 6.5: Settings to Open Desktop Trend Tool
4. Click OK.
292 3BUF001094-600 B
6 Using Desktop Trends 6.5 Trend Display
6.5 Trend Display

If the Refresh function in Internet Explorer is used to refresh the Trend Display,
the file will be overwritten with a cleared display.
The Trend display exposes control system trend data as graphic traces. It can display
from one to eight trended tags. Trend data is retrieved from property logs. The trend
definitions are html files that support navigation through Internet Explorer conventions.
In addition to well known trending functionality (scope, zooming, ruler and so forth)
a unique active zoom functionality is implemented. Active zoom is used to magnify
a portion of the current scope, without changing the overall scope. In this way a spe-
cific part of the scope can be enlarged without losing the overview.
The Trend display is also used to:
• Zoom in to see greater detail, and zoom out to see a wider time scope.
• Use a ruler to select a point on the graphical view, and then read the corresponding
times and values for each trace.
• Apply filtering to a trace to reduce the percentage of samples.
• Apply a time offset for comparing different traces.
• Monitor the status for each trace.
• Capture data from either the graphical or table view, and then paste the data in
a third party application such as Microsoft Excel.
For instructions on setting up and using the Trend display refer to:
• Launching the Trend Display on page 293.
• Setting Up the Trend Display on page 298.
• Using the Trend Display on page 319.
6.5.1 Launching the Trend Display

Launch the Trend Display using any one of these methods:
• Windows Taskbar: ABB Start Menu > ABB System 800xA Information
Mgmt>Desktop Trends>IM Trend Display.
• Internet Explorer - Use the Internet Explorer navigation tools to open an existing
Trend display that was previously saved as an HTML file.
3BUF001094-600 B 293
• DataDirect - by selecting Trend Display as the Retrieval Type in the History

Values dialog, or by clicking the Trend button on the PDL display. Refer to
DataDirect Operation for details.
• Ticker - Refer to Launching the Trend Display from the Ticker on page 373.
• Tag Explorer - Refer to Launching the Trend Display from the Tag Explorer
on page 386.
• PDL Browser - Refer to History on page 401.
6.5.2 Description
The Trend Display, Figure 6.6, is divided into a Frame Bar, a toolbar for
Save/Open/Print/Browse operations, Graphical Trend Area, Value and Time Scales,
Scope/Zoom Tool Bar, and Table
294 3BUF001094-600 B
Figure 6.6: History Trend Display
Frame Bar
The frame bar is provided by Internet Explorer. The description along the top of the
display is specific to the trend object and identifies the display type and associated
tag or name.
Graphical Trend Area

The graphical trend area shows trend data as traces. The traces can be presented as
line, pole, step or reverse step. Each trace can have a set of high/low limit lines. The
portion of the trace beyond these limits is drawn with the limit color. If active zoom
3BUF001094-600 B 295
is enabled the magnified area is drawn with a gray background. The area can be moved
and re-sized using the slide bar below the trend area.
Value and Time Scales

The value scales for trends 1-4 are shown to the left of the trend area. The value scales
for trends 5-8 are shown to the right of the trend area. The color of the labels corre-
spond to the trace color. The value scales have no active response to mouse-click.
The time scale is shown below the trend area. The time scale displays five time/date
labels in a user defined format. Label lines show exact position of a particular time.
Specify either one time scale for all traces to share, or individual time scales for each
trace. Refer to Scope Properties on page 315. When specifying individual time scales,
only one is shown at a time. Select the trace whose time scale is to be shown by right-
clicking on the time scale and choosing the trace from the context menu.
Table View (Info Area)

The table view contains information about the individual traces including tag name,
description, ruler value, and status. A trace can be shown/hidden by checking/un-
checking in the Trace column. In the same way, the appearance of the limit lines is
determined by checking/un-checking in the Limits column. The Trace and Limits
cells indicate the trace color.
Scope/Zoom Tool Bar

The Scope/Zoom tool bar, Figure 6.7, contains buttons for using the scope and zoom
features of the trend display. Open or close the tool bar through the context menu or
View Tab (Shift+Right Mouse on the trend display) to adjust the screen space for
the graphical view.
296 3BUF001094-600 B
Backward Set Active

Scope Step Zoom Start Zoom
Large/Small Out Time Level/Enable
Zoom Default Small/Large

In Scope Forward
Scope Step
Figure 6.7: Tool Bar, Scope/Zoom
Both the Table and the Scope/Zoom Tool Bar can be undocked so that they float
and can be moved to another location on the screen. When undocked, re-docking
one of these components moves it back to its original location. The context menu
can be used for these actions. Refer to Showing/Hiding and Docking/Undocking
Trend Display Components on page 331.
Operations Tool Bar

The operations tool bar provides the functionality illustrated in Figure 6.8.
Print Toggle Tag PDL SQL

Trend Print Explorer Browser Browser
Trend
File Colors
Open
Trend Online Help
File
Save User Tag Browse Ticker Event
Trend Management OPC/HDA Browser
File
Figure 6.8: Operations Tool Bar
3BUF001094-600 B 297
6.5.3 Setting Up the Trend Display

The appearance and operating characteristics for the trend display are set up on two
levels:
• General display characteristics and operating parameters are configured through
the Setup dialog. This includes specifying data providers, showing/hiding columns
in the table area, trend background color, and data retrieval type (raw or interpo-
lated). This dialog also provides connection status and version information. For
details, refer to Setup Dialog on page 298.
• The Property Page is used to configure appearance and operating characteristics
for individual traces, and for the overall scope (time scale). This includes having
one time scale for all traces to share, or individual time scales for each trace, and
color/thickness characteristics for trace and limit lines. For details refer to Prop-
erty Page on page 310.
6.5.4 Setup Dialog

Use the Setup dialog to specify general display characteristics. To display this dialog
right-click in the trend area and choose Setup Dialog from the context menu, Figure
6.9.
Figure 6.9: Launching the Setup Dialog
This dialog is used to:

• configure data provider connections for traces, specify whether to retrieve raw
or interpolated data, and select aggregates. Refer to Data on page 299.
• show/hide various trend display components. Refer to Visibility on page 302.
• set column widths for the table (info) area. Refer to Column Widths on page 303.
• configure colors for trend background, ruler, and grid. Refer to Miscellaneous
Settings on page 304.
298 3BUF001094-600 B
• specify whether to read the limits, engineering units, and description information
from the database. Refer to Database Information on page 305.
• specify the maximum number of interpolated points when the retrieval type is
interpolated. Refer to Maximum Interpolated Points on page 306.
• configure data update. Refer to Miscellaneous Settings on page 304.
• specify whether to save debug messages to a text file. Refer to Miscellaneous
Settings on page 304.
• configure print colors. Refer to Print Colors on page 306.
• view connection status information. Refer to Status on page 308.
• view version information. Refer to Versions on page 309.
6.5.5 Data
The Data tab, Figure 6.10, is used to:
• specify default and trace-specific data provider connections. Refer to Data
Provider Connections on page 300.
• specify whether to retrieve raw or interpolated data. Refer to Raw/Interpolated
Data on page 300.
• apply an aggregate (calculation) to a trace. Refer to Aggregates on page 301.
3BUF001094-600 B 299
Figure 6.10: Trend Setup - Data Tab
Data Provider Connections

New traces are automatically assigned the default data provider specified in this dialog.
Change the specification for individual traces by entering the data provider name di-
rectly in the trace’s Data Provider field. Reset all individual traces to the default
specification by clicking Update All.
The initial default setting is AIPHDA. This connects to the 800xA OPC HDA server
which is used to access both trend and history logs.
Use the LOG data provider to access OMF-based history logs from a MOD 300 or
Master ABB OCS. Any other data provider can be specified for historical data access
that is configured on the system.
Raw/Interpolated Data
New traces are automatically assigned the default data type specified in this dialog,
Figure 6.11. Change the specification for individual traces by clicking the trace’s Int
or Raw option button. Reset all individual traces to the default specification by
clicking Update All.
300 3BUF001094-600 B
Data Type
Buttons
Figure 6.11: Selecting Raw or Interpolated Data
• Interpolated - This returns values at regular intervals. The specified time range
and the Maximum Interpolated Points property (set through Miscellaneous Set-
tings tab) divide the time range into discrete intervals for which interpolated
values are calculated. For example, if the time range is 15 hours and Maximum
Interpolated Points is 300 (default), a value will be provided for each three-minute
interval. The values are not actual samples, but rather values interpolated from
the actual samples.
If the number of values requested exceeds pixel capacity of the screen, the trend
will display as many points has it can, and the Maximum Interpolated Points setting
will automatically adjust itself to that number.
• Raw - This returns values for actual samples collected and stored by History. If
the quantity of raw values exceeds the width of the trend display, a warning
message will be displayed, and the trace will be drawn with interpolated values.
Aggregates
Any aggregate (calculation) can be applied to the trend that is supported by the
OPC/HDA server. To do this click in the Aggregates column, Figure 6.12. The Ag-
gregates menu includes all aggregates support by the HDA server. An aggregate
cannot be applied to any trace whose data type is set to Raw (Raw/Interpolated Data
on page 300).
3BUF001094-600 B 301
Figure 6.12: Applying an Aggregate
6.5.6 Visibility
This tab is used to specify whether to show or hide various features on the trend dis-
play, Figure 6.13, such as the Info area in its entirety, or individual columns in the
table.
The Trend Area X and Y-axis features relate to the standard time (X-axis) and value
(Y-axis) scales. Zoom Bar displays the Scope/Zoom Tool Bar. When checked, Value
Scales displays the numeric Max./Min. values along the left side of the trend graphic.
The Time Scales can be displayed without the Date Scales; however, the Date Scales
can not be shown without the Time Scales. The Slide option allows the slide to be
turned on or off; however, it only is useful with the Active Zoom feature.
All items are checked (shown) by default. Individual items can be unchecked to hide
them. After making selections, click OK to exit.
302 3BUF001094-600 B
Figure 6.13: Trend Setup - Visibility Tab
The Table or Scope/Zoom Tool Bar can also be shown or hidden directly from
the Trend area context menu.
6.5.7 Column Widths

This tab is used to adjust the width of columns in the Info area with pixel precision,
Figure 6.14.
3BUF001094-600 B 303
Figure 6.14: Trend Setup - Column Widths
• Column widths may also be set directly on the Table view. Refer to Using
the Table (Info) Area on page 328.
• If the Visibility of a column is turned off, the column width is set to zero and
cannot be changed in the Setup dialog.
6.5.8 Miscellaneous Settings

This tab, Figure 6.15, is used to specify:
• colors for trend background, ruler, and grid. Refer to Colors on page 305.
• data update rate. Refer to Data Update Rate on page 305.
• Maximum interpolated points. Refer to Maximum Interpolated Points on page
306.
• Whether or not to read limits, engineering units, and description information for
traces from the database. Refer to Database Information on page 305.
• whether or not to save debug information. Refer to Saving Debug Information
on page 306.
304 3BUF001094-600 B
Figure 6.15: Trend Setup - Miscellaneous Tab
Colors
To specify a color for trend background, ruler, or grid, double-click the applicable
box. This displays the standard Windows color-chooser dialog.
Data Update Rate

The data update rate may be set between 5 and 32000 seconds. The default is 30
seconds.
Database Information
The check boxes in this section are used to specify whether the corresponding attributes
will be read from the database. When a check box is checked, the database reading
can be superseded by entering a value directly in the table (info) area or through the
Property Page. However, the database settings will replace any entries made the next
time the Trend display is opened.
3BUF001094-600 B 305
Maximum Interpolated Points

This specifies the maximum number of interpolated points to retrieve. The default is
300. The specified Maximum Interpolated Points is used to divide the time range into
discrete intervals for which interpolated values are calculated. For example, if the
time range is 15 hours and Maximum Interpolated Points is 300, a value will be pro-
vided for each three-minute interval. If this setting exceeds the pixel capacity of the
screen, the Maximum Interpolated Points setting is automatically adjusted to match
the pixel capacity.
Saving Debug Information

To save debug information to a text file, click the Debug check box, and specify the
path and file name in the corresponding field. As an alternative browse to a folder
and select a file by clicking the browse button (...), Figure 6.16.
Figure 6.16: Saving Debug Information
6.5.9 Print Colors

This tab is used to modify the trend color scheme for printing and specify whether to
print in portrait or Landscape mode, Figure 6.17. The default settings on this tab are
preset optimized for printing (white background). The default settings can be modified.
Clicking any column in the Trace Colors section displays the standard Windows dialog
for color selection.
The print color scheme can be applied to all trend displays or only the current trend
display.
306 3BUF001094-600 B
Figure 6.17: Printing Tab
To preview the color scheme, click the Toggle Print Color icon on the toolbar, Figure
6.18. An example preview is shown in Figure 6.19.
Figure 6.18: Preview Print Colors
3BUF001094-600 B 307
Figure 6.19: Example Preview Print Colors
6.5.10 Status
The Status tab, Figure 6.20, lists messages relating to the success or failure of a
connection between the trend control and the history log that is the data source. When
a connection succeeded message is displayed, trend data is collected. A communication
failed message occurs when data can not be retrieved. The trend control will try to
re-establish the connection five times before terminating further attempts. If this
happens, check the Information Management server, and the client where this appli-
cation is running to make sure everything is ok. The Clear button clears the status
information.
308 3BUF001094-600 B
Figure 6.20: Connection Status Tab
6.5.11 Versions
This tab shows version information for the trend display, Figure 6.21.
3BUF001094-600 B 309
Figure 6.21: Version Information
6.5.12 Property Page

The Property Page is used to configure appearance and operating characteristics for
individual trend traces and the overall scope. The dialog has one tab per trace and
one tab for scope settings. To display the Property Page, right-click in the trend area
and choose Properties from the context menu, Figure 6.22.
Figure 6.22: Launching the Properties Page
6.5.13 Trace Properties

The Trace tabs in the Property Page dialog, Figure 6.23, are used to configure the
individual traces. Use this to:
• enable (show) or disable (hide) the trace. Refer to Enabled on page 312.
310 3BUF001094-600 B
• change the trace name. Refer to Name on page 312.

• specify a descriptor text. Refer to Description on page 312.
• specify whether to show the trace as a line, pole, step, or reverse step. Refer to
Trace Type on page 312.
• specify the color and thickness for trace lines for indicating Normal Data, No
Data, or Bad Data conditions. Refer to Trace Lines on page 312.
• specify high and low limits, whether or not to show limit lines, and if so, the
color and thickness for limit lines. Refer to Limit Lines on page 312.
• specify the overall range. Refer to Scale on page 312.
• specify the scope for individual traces on their respective tabs when multiple
scopes are enabled through the Scope tab. Refer to Scope on page 314.
Figure 6.23: Trace Properties
3BUF001094-600 B 311
Enabled
The Enabled check box in the upper right portion of this page is used to enable (show)
or disable (hide) the trace. The trace is enabled when the box is checked. Traces may
also be enabled/disabled directly in the Table (Info) area.
Name
This is the tag name for the trace’s data source. Follow the naming conventions for
the system where the tag resides.
Description
The Description is an optional text string to further identify the trace.
Trace Type
This pull-down list is used to specify whether to show the trace as a Line, Pole, Step,
and Rev. Step. Refer to Type on page 329.
Trace Lines
The controls in this section are used to specify the color and thickness of the trace
lines for indicating Normal Data, No Data, or Bad Data. Double click on the line to
get a color menu and select a color.
Limit Lines
The controls in this section are used to specify the high and low values, color and
thickness of the limit lines. The corresponding Enabled check box is used to enable
(show) or disable (hide) these lines.
Scale
The fields in this section are used to specify the minimum and maximum values and
format of the value scale.
312 3BUF001094-600 B
Scale Format
0 Digit placeholder. Display a digit or a zero. If the expression has a
digit in the position where the 0 appears in the format string, display
it; otherwise, display a zero in that position.
If the number has fewer digits than there are zeros (on either side of
the decimal) in the format expression, display leading or trailing zeros.
If the number has more digits to the right of the decimal separator
than there are zeros to the right of the decimal separator in the format
expression, round the number to as many decimal places as there are
zeros. If the number has more digits to the left of the decimal separator
than there are zeros to the left of the decimal separator in the format
expression, display the extra digits without modification.
# Digit placeholder. Display a digit or nothing. If the expression has a
digit in the position where the # appears in the format string, display
it; otherwise, display nothing in that position.
This symbol works like the 0 digit placeholder, except that leading
and trailing zeros aren't displayed if the number has the same or fewer
digits than there are # characters on either side of the decimal separator
in the format expression.
. Decimal placeholder. In some locales, a comma is used as the decimal
separator. The decimal placeholder determines how many digits are
displayed to the left and right of the decimal separator. If the format
expression contains only number signs to the left of this symbol,
numbers smaller than 1 begin with a decimal separator. To display a
leading zero displayed with fractional numbers, use 0 as the first digit
placeholder to the left of the decimal separator. The actual character
used as a decimal placeholder in the formatted output depends on the
Number Format recognized by the system.
% Percentage placeholder. The expression is multiplied by 100. The
percent character (%) is inserted in the position where it appears in
the format string.
3BUF001094-600 B 313
, Thousand separator. In some locales, a period is used as a thousand

separator. The thousand separator separates thousands from hundreds
within a number that has four or more places to the left of the decimal
separator. Standard use of the thousand separator is specified if the
format contains a thousand separator surrounded by digit placeholders
(0 or #). Two adjacent thousand separators or a thousand separator
immediately to the left of the decimal separator (whether or not a
decimal is specified) means "scale the number by dividing it by 1000,
rounding as needed." For example, use the format string "##0,," to
represent 100 million as 100. Numbers smaller than 1 million are
displayed as 0. Two adjacent thousand separators in any position other
than immediately to the left of the decimal separator are treated simply
as specifying the use of a thousand separator. The actual character
used as the thousand separator in the formatted output depends on the
E- E+ e- e+ Scientific format. If the format expression contains at least one digit
placeholder (0 or #) to the right of E-, E+, e-, or e+, the number is
displayed in scientific format and E or e is inserted between the
number and its exponent. The number of digit placeholders to the
right determines the number of digits in the exponent. Use E- or e- to
place a minus sign next to negative exponents. Use E+ or e+ to place
a minus sign next to negative exponents and a plus sign next to positive
exponents.
- + $ () Display a literal character. To display a character other than one of
those listed, precede it with a backslash (\) or enclose it in double
quotation marks (" ").
Scope
The Scope section, Figure 6.24, is only displayed when multiple scopes are enabled
through the Scope tab. In this case, the scope for each trace is specified through its
respective trace tab. If single scope is specified, all traces share the same scope which
is set through the Scope tab. For details on how to set the formats for the data and
time fields, refer to Date Format on page 317 and Time Format on page 318.
314 3BUF001094-600 B
Figure 6.24: Property Page When Multiple Scopes is Enabled
6.5.14 Scope Properties

The Property Page Scope tab, Figure 6.25, is used to configure properties related to
scope. Use this to:
• specify how to set the scope’s start and end time. Refer to Scope Type on page
316.
• specify that a single scope apply to all traces, or that each trace have a unique
scope. Refer to Mode on page 317.
• specify the scope duration when Scope Type is End Scope. Refer to Scope Width
on page 317.
3BUF001094-600 B 315
• Specify scope start and end times when the Mode is Single Scope. Refer to
StartTime and EndTime on page 317
• Date and Time formats. Refer to Date Format on page 317 and Time Format on
page 318.
Figure 6.25: Current Scope Properties
Scope Type
This determines how the scope start and end time are specified. The StartTime and
EndTime fields are enabled/disabled based on this setting.
• Start End - Used to specify the start and end time for the scope. In this case the
Scope Width fields are disabled.
• Start Scope - Used to specify the start time for the scope. The end time is deter-
mined by specifying the Scope Width.
• End Scope - Used to specify the end time for the scope. The start time is deter-
• Current Scope - Uses the current time as the end time. The start time is deter-
316 3BUF001094-600 B
Mode
This is used to specify whether all traces will share the same scope, or whether each
trace will have a unique scope. This feature is disabled when the Scope Type is
Current Scope. If a single scope is used for all traces, configure the StartTime and
EndTime on this tab.
If multiple time ranges are used, the scope for each trace must be specified on its re-
spective trace tab. Scopes are color-coded to match their respective traces. The trend
display shows the scope for one trace at a time. This is selected through the time scale
context menu as described in Selecting the Time Scale for a Trace on page 334.
Scope Width
The Scope Width is used to specify the duration of the trace in days and hours. This
option is disabled when Scope Type is set to Start End.
StartTime and EndTime

Use these fields to set the start and/or end time based on the selected Scope Type.
The formats for these fields are configurable. Refer to Date Format on page 317 and
Time Format on page 318.
Date Format
This specifies the format to use for the date portion of the time scale labels. Use the
dash (-) character to separate day, month, and year units. Valid character strings for
day, month, and year are described below:
Day options:
• d - Display the day as a number without a leading zero (1 - 31).
• dd - Display the day as a number with a leading zero (01 - 31).
• ddd - Display the day as an abbrethroughtion (Sun-Sat).
• dddd - Display the day as a full name (Sunday-Saturday).
• ddddd - Display the date as a complete date (including day, month, and year),
formatted according to the system's short date format setting. The default short
date format is m/d/yy - for example: 2-7-02 (February 7, 2002).
• dddddd - Display a date serial number as a complete date (including day, month,
and year) formatted according to the long date setting recognized by the system.
3BUF001094-600 B 317
The default long date format is mmmm dd, yyyy - for example February 07,
2002.
Month options:
• m- Display the month as a number without a leading zero (1 - 12).
• mm - Display the month as a number with a leading zero (01 - 12).
• mmm - Display the month as an abbrethroughtion (Jan -Dec).
• mmmm - Display the month as a full name (January-December).
Year options:
• y - Display the day of the year as a number (1 - 366).
• yy - Display the year as a 2-digit number (00 - 99).
• yyyy - Display the year as a 4-digit number (100 - 9999).
Examples for February 7, 2002
Date units can be entered in any order. Some valid combinations are illustrated below:
dd-mm-yy = 07-02-02
d-m-yy = 7-2-02
mm-d-yyyy = 02-7-2002
y = 38
Time Format
This specifies the format to use for the time portion of the time scale labels. Use the
colon (:) character to separate hour, minute, and second units. Valid character strings
hours, minutes, and seconds are described below:
Hour options:
• h - Display the hour as a number without a leading zero (0 - 23).
• hh - Display the hour as a number with a leading zero (00 - 23).
Minute options:
• m- Display the minute as a number without a leading zero (0 - 59).
• mm - Display the minute as a number with a leading zero (00 - 59).
Second options:
318 3BUF001094-600 B
• s - Display the second as a number without leading zero (0 - 59).

• ss - Display the second as a number with a leading zero (00 - 59).
24-hour Clock or 12-hour Clock:
Time is displayed in 24-hour format by default. To display time in 12-hour format
append AMPM to the time specification, for example: hh:mm:ss AMPM. In this case,
15:45:30 would be displayed as 03:45:30 PM
Examples for 15:45:30:
hh:mm:ss= 15:45:30
hh:mm:ss AMPM = 03:45:30 PM
6.5.15 Using the Trend Display

This section describes the following procedures for using the trend display:
• Adding and Removing Traces on page 320.
• Using User Tag Management (UTM) on page 513.
• Browsing an OPC Server on page 320.
• Reading Trend Data on page 322.
• Using the Scope/Zoom Tool Bar on page 326.
• Using the Table (Info) Area on page 328.
• Showing/Hiding and Docking/Undocking Trend Display Components on page
331.
• Viewing Trend Statistics on page 331.
• Copying and Pasting Trend Data to Other Applications on page 332.
• Applying Time Offsets on page 334.
• Saving the Current Display on page 335.
• Opening a Saved Display on page 336.
• Printing the Current Display on page 336.
• Launching Other Desktop Trend Tools from the Trend Display on page 336.
3BUF001094-600 B 319
6.5.16 Adding and Removing Traces

To add a trace, right-click in the trend area and choose Trace>Add from the context
menu, Figure 6.26.
Figure 6.26: Adding a Trace
This adds a new row in the Table . To configure the new trace, first enter the tag name
in the table (info) area, and then refer to Property Page on page 310.
Traces for OPC HDA objects may also be added through the OPC Browser. Refer
to Browsing an OPC Server on page 320.
To delete a trace, right-click in the trend area and choose Trace>Remove>Trace#
from the context menu, Figure 6.27.
Figure 6.27: Removing a Trace
6.5.17 Browsing an OPC Server

The OPC Browser is used to browse the connected OPC HDA server to find OPC
objects to add as traces on the Trend display. This section describes the basic procedure
for using the browser. For details regarding the various functions for navigating and
selecting objects, refer to Section 9 Tag Management.
To launch this browser, click the Browse Objects button on the tool bar, Figure 6.28.
320 3BUF001094-600 B
Figure 6.28: Launching the OPC Browser
To use the browser, Figure 6.29:

1. Select the data provider (AIPHDA or IMHDA).
2. In the left pane, browse to the location for property logs (usually the control
structure). The contents of the left pane varies, depending on the type of OPC
HDA server.
For AIPHDA, the browser provides a directory structure similar to the Plant
Explorer, Figure 6.29.
Figure 6.29: Example, OPC Browser
3BUF001094-600 B 321
For IMHDA, the left pane is used to choose one of three methods by which to
conduct a search: EH for local access, EH_PUBL for published archived log
data, and EH_NET for network-wide access (LOGMAN is not applicable).
The following browsing methods are supported:
shows all logs in the selected folder as well as logs from all sub-folders
• Apply a filter to either show or exclude all logs whose name has a specified
text string.
3. Select one or more objects in the middle pane, and then move them to the Selected
Tags (right) pane by clicking the > button. To move all objects from the middle
to the Selected Tags pane, click the >> button. To remove selected tags from the
list use either the < or << buttons.
4. Combine tags from different locations by repeating steps 2 and 3.
5. When finished selecting tags, click Add Traces. This adds traces for the selected
tags.
As an option, copy tags from this browser to the clipboard for pasting into external
applications.
6.5.18 Reading Trend Data

This section describes mouse functions for manipulating the trend display. This in-
cludes:
• Using the Ruler on page 323.
• Value Zoom on page 324.
• Time Zoom on page 325.
• Area Zoom on page 325.
Additional features are available on the Scope/Zoom toolbar. Refer to Using the
Scope/Zoom Tool Bar on page 326.
322 3BUF001094-600 B
Using the Ruler

The ruler is used to select a point on the graphical view and then read the time and
value for each trace at the selected point. To do this:
1. Click with the left mouse button in the graphic area to get the ruler, Figure 6.30.
2. Select the ruler with the left mouse button, and then drag left or right. The arrow
keys on the keyboard can also be used.
Dragging the mouse while the left mouse button is activated moves the ruler with
the motion. The Status, Ruler Time and Ruler Value fields in the table area
are updated for the enabled traces. Refer to Using the Table (Info) Area on page
328.
3BUF001094-600 B 323
Figure 6.30: Ruler in Graphical View Area
Value Zoom
SHIFT+Left Mouse starts a value zoom which is shown as the mouse is dragged as
white lines draw the new high and low value area (vertical lined box). When releasing
the mouse the value scales are changed.
324 3BUF001094-600 B
Time Zoom
CTRL+Left Mouse starts a time zoom which is shown as the mouse is dragged as
white lines draw the time area (horizontal lined box). When releasing the mouse the
time scales are changed.
Area Zoom
CTRL+SHIFT+Left Mouse starts an area zoom which is shown as the mouse is
dragged as white lines draw the combined value/time area, Figure 6.31. When releasing
the mouse the time and value scales are changed.
Figure 6.31: Area Zoom
3BUF001094-600 B 325
6.5.19 Using the Scope/Zoom Tool Bar

The Scope/Zoom tool bar, Figure 6.7, contains buttons for using the scope and zoom
features. To adjust the screen space for the graphical view, open or close the tool bar
through the context menu or the Visible tab on the Setup dialog (Setup Dialog on
page 298). This tool bar can also be undocked so that it floats and can be moved to
another location on the screen. When undocked, re-docking the tool bar moves it back
to its original location. This functionality is provided through a right-click (context)
menu. Refer to Showing/Hiding and Docking/Undocking Trend Display Components
on page 331.
Backward Active
Set Start
Scope Step Zoom Zoom
Time
Large/Small Out Level/Enable
Zoom Default Small/Large

In Scope Forward Set Start Time button is only
Scope Step available when Scope Type
is Start Scope or Start End.
Figure 6.32: Tool Bar
Backward Scope (Large step)

Activating the Backward Scope (Large Step) button will change the scope backwards
in time 75%.
Backward Scope (Small step)

Activating the Backward Scope (Small Step) button will change the scope backwards
in time 25%.
Zoom In
Activating the Zoom In button will decrease the scope Zoom Factor In amount (in
%). Default for Zoom Factor In is 25%.
326 3BUF001094-600 B
Zoom out
Activating the Zoom Out button will increase the scope Zoom Factor Out amount (in
%). Default for Zoom Factor Out is 25%
Default Scope
Activating the Default Scope button will restore the trend to the Current Scope with
a 30 minute scope width.
Set Start Time

This button is available when the Scope Type is Start Scope or Start End. Clicking
this button displays the Set Start Time dialog, Figure 6.33. This is used to set the start
time of the scope. The end time is moved accordingly so the scope width is the same
after the start time has been changed.
Figure 6.33: Set Start Time
Forward Scope (Small step)

Activating the Forward Scope (Small Step) button will change the scope forward in
time 25%.
Forward Scope (Large step)

Activating the Forward Scope (Large Step) button will change the scope forward in
time 75%.
Active Zoom Magnitude

If the Active Zoom is enabled this up/down button is used to change the Active Zoom
factor in the interval 1 to 10.
3BUF001094-600 B 327
Active Zoom Enable/Disable

Use the check box to enable/disable the Active Zoom. When enabled, the active zoom
area is shown with a grey background. A slide bar is used to adjust the size of the
active zoom. If the slide bar is turned off in the Visible tab (refer to Setup Dialog on
page 298), then the active zoom area is fixed at its last value.
The size of the slide bar is adjusted by clicking on either edge and dragging to increase
or decrease the width of the bar (similar to adjusting column widths in the table view).
At its maximum size, the slide bar presents the normal time scale of five periods each
about 20% of the total time span. At the minimum width, the slide bar zooms the
three center time scales into two 1% of range time segments. On a 30 minute time
scale, the minimum sized slide bar can be moved around to look closely at any two
18 second time segments, Figure 6.30.
6.5.20 Using the Table (Info) Area

The table view is used to view information for and adjust individual traces.
A trace can be shown/hidden by checking/un-checking in the Trace column. Limit
lines may also be shown or hidden in the same manner through the Limits column.
The Trace and Limits cells indicate the trace color.
To adjust the screen space for the graphical view, open or close the table through the
context menu or the Visible tab on the Setup dialog (Setup Dialog on page 298). The
table can also be undocked so that it floats and can be moved to another location on
the screen. When undocked, re-docking the table moves it back to its original location.
This functionality is provided through a right-click (context) menu. Refer to Show-
ing/Hiding and Docking/Undocking Trend Display Components on page 331
Adjusting Column Widths

Adjust column widths by placing the cursor over the border of a column heading,
holding the left mouse key down and dragging to the desired width. Use a double
click on the border to reset the width to its default (this includes columns dragged to
a zero width and hidden). As an alternative use the Column Widths tab on the Setup
dialog. Refer to Setup Dialog on page 298.
Trace
Alternately show or hide a trace by checking or unchecking its check box. These
check boxes are color-coded to match the trace color.
328 3BUF001094-600 B
Name
This is the tag name for the trace’s data source. Follow the naming conventions for
the system where the tag resides.
Description
The description is read from the system database by default. Disable this function
through the Miscellaneous Settings tab on the Setup dialog (Database Information
on page 305). When this function is enabled, the database reading can be superseded
by entering a value directly in the table (info) area or through the Property Page.
However, the database settings will replace any entries made the next time the Trend
display is opened.
Type
This pull-down list is used to select the presentation for the trace in the graphical
view. The options are shown in Figure 6.34 and described below:
Line - Time between values shown as line indicating interpolated rate of change.
When viewing interpolated data, the ruler value shows the interpolated values. When
viewing raw data, the ruler value only shows actual stored values. Refer to Ruler
Value on page 330.
Pole - Each pole represents a value.
Step and Rev. Step - Time between values represented as horizontal line.
Lines Poles Steps
Figure 6.34: Trace Types
Status
This cell shows the quality status of the tag data (trace colors are set on the Trace
tab of the Property Page - refer to Property Page on page 310):
• When the status is GOOD, the trace color appears as Normal Data.
3BUF001094-600 B 329
• When status is BAD, the trace color appears as Bad Data.

• When status is NODATA, the trace color appears as No Data.
Ruler Time
This column indicates the time corresponding to the current ruler position (when ruler
is active). If a time offset has been applied to one or several traces, the times in this
column will differ for each trace. When the ruler is placed between two data points
for a trace, the stored time for the closest point is used.
Ruler Value
This column indicates the value for each trace corresponding to the current ruler po-
sition. When the ruler is placed between two data points for a trace, the value for the
older point is used until the next sample time is reached.
Engineering Units
The engineering units are read from the system database by default. Disable this
function through the Miscellaneous Settings tab on the Setup dialog (Database Infor-
mation on page 305). When this function is enabled, the database reading can be su-
perseded by entering a value directly in the table (info) area or through the Property
Page. However, the database settings will replace any entries made the next time the
Trend display is opened.
Filter
The trend filter is a low pass filter that is used to smooth a trend and remove unwanted
signal noise. The filter value entered for each trace must be a value between 0.0 and
1.0 inclusive. At 1.0, no points are removed and a true trace is given. At 0.0, all but
one point is removed resulting in a flat trace. The relationship is linear so that fifty
percent of the points would be removed at 0.5.
Time Offset
This cell shows the time offset for the trace. To time scope directly, select the cell
and then enter the desired offset. Refer to Applying Time Offsets on page 334.
330 3BUF001094-600 B
Limits
Alternately show or hide the corresponding high/low limit lines by checking or un-
checking this cell. If these limits are violated, the trace is drawn with the limit color
where the limit is exceeded. The trace limits are read from the system database by
default. Disable this function through the Miscellaneous Settings tab on the Setup
dialog (Database Information on page 305). When this function is enabled, the database
reading can be superseded by entering a value directly in the table (info) area or
through the Property Page. However, the database settings will replace any entries
made the next time the Trend display is opened.
6.5.21 Showing/Hiding and Docking/Undocking Trend Display Compo-

nents
Right-clicking outside the trend area displays a context menu which is used to
show/hide or dock/undock the Zoom/Scope bar and Table (Info) area, Figure 6.35.
When a component is un-docked it floats so that it may be moved to another location
on the screen. Re-docking an un-docked component moves it back to its original lo-
cation.
Figure 6.35: Context Menu for Zoom Bar and Info Area
6.5.22 Viewing Trend Statistics

Statistical data can be displayed such as average, minimum, maximum, and standard
deviation for the trend traces through the Info area context menu. To do this right-
click in the Trend area and choose Statistics from the context menu, Figure 6.36.
Figure 6.36: Showing Statistics
3BUF001094-600 B 331
This displays the Statistics window, Figure 6.37. Set the resolution for the statistical
values through the Decimal Places control. The default is three decimal places.
Figure 6.37: Trace Statistics
Copy statistics for selected traces to the clipboard for pasting into external application
such as Microsoft Word or Excel. The copy function is shown in Figure 6.38. Statis-
tical information can also be dragged to the external application if this functionality
is supported by the application.
Figure 6.38: Copying Statistics for Selected Traces to the Clipboard
6.5.23 Copying and Pasting Trend Data to Other Applications

The copy trace function is used to copy data for a selected trace from the graphical
view and then paste the copied data into a third party software application such as
332 3BUF001094-600 B
Microsoft Excel. This copies the timestamp, value, and trace number as shown in the
example below.
To copy the trace data:
1. Right-click in the trend area and choose
Copy > Trace n to copy the selected trace data to the clipboard.
2. To paste the selected data to an external application (for instance, Microsoft
Excel), go to the external application and use the Paste function to copy the
contents of the Windows paste buffer.
Example of copied Trace Data
Date/Time Value Trace
01/05/01 13:50:35 28.00 1
01/05/01 13:51:35 16.50 1
01/05/01 13:52:35 14.00 1
01/05/01 13:54:15 24.50 1
01/05/01 13:54:56 35.00 1
01/05/01 13:55:36 36.00 1
01/05/01 13:56:36 24.50 1
01/05/01 13:57:36 14.00 1
01/05/01 13:58:36 16.50 1
01/05/01 13:59:36 29.00 1
01/05/01 14:00:36 37.50 1
Some applications, for example Microsoft Excel and DataDirect, may require
changing the timestamp format in order to show the seconds column when pasting
trace data into the application.
6.5.24 Copying and Pasting a Bitmap Image of the Trend Display

As an option, make a bitmap image of the graphical trend area and then paste the
bitmap image into an external application. To do this:
1. Right-click in the trend area and choose
Copy > Bitmap to copy the selected trace data to the clipboard.
3BUF001094-600 B 333
Figure 6.39: Copy Bitmap
2. To paste the bitmap image to an external application (for instance, Microsoft

Excel), go to the external application and use the Paste function to copy the
contents of the Windows paste buffer.
6.5.25 Selecting the Time Scale for a Trace

The Property Page is used to specify whether to use one common time scale for all
traces, or whether to use a dedicated time scale for each trace. If multiple time scales
are used, only one can be shown at a time. The default time scale is the scope width
as specified on the Scope tab of the Property Page. To select the time scale for a
specific trace, right-click on the time scale, and then choose the trace from the context
menu, Figure 6.40. The time scale is displayed in the same color as the trace.
Figure 6.40: Selecting the Time Scale for a Specific Trace
6.5.26 Applying Time Offsets

A time offset can be applied to a trace to compare one location (time) to another lo-
cation on the same trace. To do this, click the Time Offset field in the table view,
and then enter the offset time. The offset value is specified in seconds or in minutes:sec-
334 3BUF001094-600 B
onds (for example 2:00 is the same as 120). This value is added to the trace’s start
time. A positive value moves the trace to the right.
An example is shown in Figure 6.41. Two traces display the same data. To compare
the value at 11:11:47 in the upper trace, with the value at 11:13:50 in the lower trace,
set the Time Offset in the upper trace to 2:00. Times and values associate with the
nearest data point.
Placing the Ruler at 11:11:47 in the upper trace will display its own value and the
value for 11:13:50 in the lower trace as shown in the Table view. Time offset only
displays data within the scope width (a time offset of 30 minutes would show no data
if the scope width was also 30 minutes).
Figure 6.41: Example, Same Trend With and Without Time Offset
6.5.27 Saving the Current Display
The Save button is used to save the current Trend Display as an Html file.
Clicking this button displays a standard Windows Save dialog. This dialog points to
the default location where Trend Display html files are stored (C:\ABB Industrial
IT\Inform IT\Desktop Trends\Data\Html). This dialog can be pointed to another loca-
tion to store the files in another directory. Once a display has been saved as an Html
3BUF001094-600 B 335
file, it can be reopened for viewing as described in Opening a Saved Display on page
336.
The tool bar buttons for saving displays as HTML files and for printing displays
MUST be used rather than the File>Save and File>Print functions available through
the Internet Explorer user interface.
6.5.28 Opening a Saved Display
The Open button is used to open an existing Trend Display which was previously
saved as an html file. Clicking this button displays a standard Windows file chooser
dialog. This dialog points to the default location where Trend Display html files are
stored (C:\ABB Industrial IT\Inform IT\Desktop Trends\Data\Html). Point this dialog
to another location if files are stored in another directory.
6.5.29 Printing the Current Display
The Print button on the Trend Display is used to print the entire trend display,
including the table data. Clicking this button displays a standard Windows print dialog.
DO NOT use File>Print in Internet Explorer. This function does not work due to an
ActiveX limitation.
6.5.30 Toggling between Print and Display Colors
This button is used to preview the print color settings.
6.5.31 Launching Other Desktop Trend Tools from the Trend Display
The operations tool bar is used to launch the other tools from the Trend Display,
Figure 6.8.
6.5.32 Ticker
The Ticker displays a repeating stream of real time data for selected tags, similar to
a stock market ticker, Figure 6.42. It is an ActiveX control hosted within Windows
Internet Explorer. Access real-time data from the 800xA OPC DA server, a third
party OPC DA server, or an Advant OCS (MOD 300 and Master) by connecting to
the applicable data provider. Additionally, specify whether to retrieve the actual
336 3BUF001094-600 B
process data or the last history value from the history log associated with the process
tag.
Figure 6.42: Example, Ticker
Make sure the text files for the pick lists and limits file have been configured as
described in Setting Up Pick Lists on page 287.
To set up and use the ticker, follow the instructions in:
• Launching the Ticker on page 337.
• Configuring Ticker Files on page 337.
• Changing Ticker Defaults on page 359.
• Operating the Ticker on page 366.
6.5.33 Launching the Ticker

Access to the ticker is through the Windows Taskbar. To launch the ticker, from the
Windows Taskbar, choose:
ABB Start Menu > ABB System 800xA Information Mgmt>Desktop Trends>
IM Ticker.
6.5.34 Configuring Ticker Files

Ticker files are user-configured files that specify which tags to show on the ticker,
and also specify appearance characteristics such as text font, status indicator colors,
and ticker speed. The ticker displays one selected file at a time.
There are two basic methods for creating ticker files:
3BUF001094-600 B 337
• Create a ticker file through a configuration display. This procedure is described

in Configuring Tags on page 339.
• Create ticker files by exporting a Tag Explorer file. This procedure is described
in Exporting Files on page 385.
The ticker also has global operating parameters that apply to all ticker files. These
global parameters set up defaults for the appearance of the ticker files. In addition,
there are global parameters to specify whether to show or hide certain error conditions,
and whether or not the status indicator will blink for error conditions.
For the most part, the ticker can be operated using the defaults for these global oper-
ating parameters. To adjust one or more global operating parameters, refer to
Changing Ticker Defaults on page 359.
Working Off Line

During configuration, if the data source is unavailable or providing bad data, then
work in the offline mode. This is used to suppress the annunciation of spurious error
conditions. The status indicator will display the user-specified color for offline status
instead. To work offline, right click on the ticker status indicator and choose Work
Offline from the context menu, Figure 6.43.
Figure 6.43: Working Offline
338 3BUF001094-600 B
6.5.35 Configuring Tags

Ticker files may be configured through the Tag Configuration dialog. To open this
dialog, right click on the ticker status indicator and choose Configure Tags from the
context menu, Figure 6.44.
Figure 6.44: Opening the Configure Tags Dialog
The Tag Configuration dialog is shown in Figure 6.45. This dialog has two tabs.
3BUF001094-600 B 339
Figure 6.45: Tag Configuration Dialog
Use the Tags tab to specify which tags to include in the ticker file. Tags can be added
from the following data sources:
• 800xA OPC HDA server.
• OPC DA servers.
• Advant OCS (MOD 300 and Master).
Use the Appearance tab to configure ticker presentation characteristics and general
operating parameters.
This dialog and the procedures for adding and removing tags also apply for adding
tags to a tag group in the Tag Explorer. The only difference is the absence of the
Appearance tab which is not required for the Tag Explorer.
340 3BUF001094-600 B
6.5.36 Adding Tags

The Tags tab is used to select which tags to include in the ticker file.
It is recommended that the size of a Ticker File be limited to no more than 50 tags.
This tab has two views:

• The New Style view supports adding tags that reside on an OPC server (for ex-
ample the 800xA OPC DA server). This is the default view (selected by clicking
the New Style option button in the bottom left corner of the dialog, Figure 6.46.
For details on using this view, refer to Browsing for OPC Objects on page 341.
Also refer to User Tag Management (UTM) on page 513.
Figure 6.46: Selecting New Style View
• The Old Style view supports connecting to an older server that contains Advant
OCS (MOD 300 or Master) tags. To use this view select the Old Style option
button, then refer to Adding an Advant OCS Tag on page 347.
6.5.37 Browsing for OPC Objects

The Browser is used to find OPC objects on the connected OPC server and add selected
tags to the ticker. This section describes the basic procedure for using the browser.
Details regarding the various functions to help navigate and select objects are in
Section 9 Tag Management.
New Style Browser

To add the tag for an object property using the New Style browser selection:
structure).
The data provider defaults to AIPOPC which is used to browse the plant structure
for real time OPC-type tags. This is recommended when adding OPC tags for
the Ticker and Tag Explorer.
3BUF001094-600 B 341
To retrieve the last history value rather than the actual real time value, change
the data provider name to an HDA data provider (AIPHDA or IMHDA), then
click Change, Figure 6.47. The data provider specification may also be changed
for individual tags once they are selected. This is described later in this procedure.
Figure 6.47: Example, Changing the Data Provider
The browser defaults to the last selected location. The following browsing
methods are supported:
• Basic point and click to show the objects within a specific folder.
shows all objects in the selected folder as well as objects from all sub-folders
• Apply a filter to either show or exclude all objects whose name has a speci-
fied text string. Figure 6.48 shows how a filter may be used to limit the scope
of selectable objects.
342 3BUF001094-600 B
Example Filter
Filter result
Figure 6.48: Filtering Example
The available objects (of the applicable type) will be displayed in the avail-
able tags list in right pane.
2. Select one or more objects from the available tags list, Figure 6.49, and then click
Add Selected Tags to move them to the Selected Tags list (bottom pane), Figure
6.50.
3BUF001094-600 B 343
Figure 6.49: Selecting Available tags
Move all available tags by clicking Add All Tags. However, be careful when se-
lecting this option, particularly if the available tag list is unfiltered.
344 3BUF001094-600 B
Figure 6.50: Selected Tags Added
4. As an option, modify tag attributes by clicking the applicable cell as illustrated

in Figure 6.51.
Figure 6.51: Modifying Tag Attributes
3BUF001094-600 B 345
5. To remove a tag from the selected tags list, check the corresponding check box,
then click Remove Selected Tags, Figure 6.52.
Figure 6.52: Removing a Tag from the Selected Tags List
6. When finished selecting tags, click OK. This adds the tags to the ticker. As an
option, copy tags from this browser to the clipboard for pasting into external
applications.
Old Style Browser

To add the tag for an object property using the Old Style browser selection:
1. Click Browse. This displays a dialog used to browse for objects in the 800xA
System.
2. Use the Data Provider field at the bottom of the dialog to specify the applicable
data provider. This is the same as the New Style.
structure). The browsing methods are the same as the New Style. The contents
of the left pane varies, depending on the type of OPC HDA server.
• For AIPHDA, the browser provides a directory structure similar to the Plant
Explorer.
• For IMHDA, the left pane provides three methods to conduct a search: EH
for local access, EH_PUBL for published archived log data, and EH_NET
for network-wide access.
The available objects are displayed in the middle pane.
4. Select one or more objects in the middle pane, and then move them to the Selected
Tags (right) pane by clicking the > button. Click the >> button to move all objects
346 3BUF001094-600 B
from the middle to the Selected Tags pane. Remove selected tags from the list
using either the < or << buttons.
6. When finished selecting tags, click Add Tags. This adds the tags in the Tag
Configuration dialog’s tag list. It also adds the tags to the tag name pick list and
corresponding text file.
6.5.38 Adding an Advant OCS Tag

Use the Old Style view to add Advant OCS tags. First click the Old Style option
button in the bottom left corner of the Tag Configuration dialog, Figure 6.53. This
displays the Old Style view, Figure 6.54.
Figure 6.53: Selecting the Old Style View
3BUF001094-600 B 347
Figure 6.54: Old Style View
Specify the tag properties starting with tag name. To specify each property, click in
the corresponding field. This highlights the property label (bold type). If the field has
an associated pick list, the pick list contents are displayed on the right side of the di-
alog. For example, when clicking in the first field, the Tag Name label is highlighted,
and the tag name pick list is displayed, Figure 6.55.
348 3BUF001094-600 B
Tag Name Label

Highlighted
Tag Name
Picklist Displayed
Figure 6.55: Example Activating a Field
Configure the tag properties according to:

• Tag Name on page 349.
• Attribute and Object Type on page 350.
• Limit Check on page 351.
• Subscription Type on page 351.
• Data Provider on page 352.
Related procedures are described in:
• Adding Tags on page 352.
• Copying an Existing Tag on page 353.
• Removing Tags from the File on page 353.
• Reverting to the Saved Configuration for a Tag on page 354.
Tag Name
Tag name is one of three properties used to reference a specific data point. The other
two are Attribute and Object Type. To enter the tag name, click in the first field. This
highlights the Tag Name label and displays the tag name pick list, Figure 6.55. Either
enter the value directly in the field, or use the corresponding pick list.
3BUF001094-600 B 349
To add aspect objects from the platform’s OPC DA or OPC HDA server, use the
Browse button. Refer to Browsing for OPC Objects on page 341.
The Tag Name pick list shows up to 25 tags at a time. When the Ticker File contains
more than 25 tags, a pull-down list is displayed at the bottom of the dialog. This is
used to display another set of up to 25 tags in the pick list, Figure 6.56.
Use this pull-down list

to select another set
of up to 25 tags
Figure 6.56: Selecting the Next Set of Tags
Attribute and Object Type

These properties are used in combination with the Tag Name to reference a specific
data point. Syntax and usage rules vary based on the data source.
800xA OPC Server
Use the aspect object as described in Browsing for OPC Objects on page 341.
OPC DA Servers
The syntax for OPC tags is based on the OPC server. The Automation Connections
OPC server, which supports the Information Management PLC Interface, uses the
Tag Name only. The ABB AF100 OPC server uses tag.attribute. The entire string
(including the .attribute part) must be entered in the Tag Name field. For other OPC
servers, consult the OPC server administrator.
Do not use Object Type field for OPC tags unless the high and low limits are set by
referencing other OPC tags. In that case, enter the user-defined high/low limit object
type configured in the Limits text file (Refer to Setting Up the Limits File on page
290), and set the Limit Check option to Get From System (Limit Check on page 351).
MOD 300 and Master Data Sources
For systems with MOD 300 or Master software, tags are organized by object type.
To uniquely identify a tag, specify the object type, tag name, and attribute.
MOD 300 Example:
350 3BUF001094-600 B
Object Type = CCF_CONTIN_LOOP

Tag = AFWAVE1
Attribute = MEASURE
Master Example:
Object Type = PIDCON
Tag = AFWAVE2
Attribute = VALUE
Limit Check
The ticker can perform a limit check to determine whether the tag value is within the
normal range, or is out of range.
To enable this check the Tag(s) Out of Range option must be selected on the Indi-
cator tab of the Ticker Default Configuration dialog. Refer to Changing Ticker
Defaults on page 359.
Specify one of the following options:
• Get From System - Use high/low limits from the data source. This requires
configuring the Limits text file (refer to Setting Up the Limits File on page 290).
For OPC tags, specify the user-defined high/low limit object type in the Object
Type field. To see how this object type is defined, refer to Setting Up the Limits
File on page 290.
The limits are retrieved after all tags have been added to the ticker, and an attempt
has been made to get values for these tags. The limits are not refreshed unless
new tags are added, or the Refresh Limits menu item is invoked.
• Use these Limits - Use limits from Low Lim. & High Lim. fields in this dialog.
• Do Not Use Limits - Do not perform a limit check.
Subscription Type
When the data source is a system with MOD 300 or Master software, specify whether
to retrieve the Realtime Value directly from the process tag, or the Last History
Value from the corresponding History log.
To subscribe to the last history value, the corresponding data provider must reside
on the same node where the history log is located.
When the data source is an OPC server, the subscription type must be OPC Value.
3BUF001094-600 B 351
Data Provider
The correct data provider must be specified in order to access the applicable platform,
and retrieve the type of data (real-time process data or last history value).
When the aspect object browser is used, the corresponding data provider is automat-
ically filled in. For all other tags, specify the applicable data provider. Data providers
are uniquely identified by the -name argument. These data providers are configured
through the ADSS Config tool on the Windows Control Panel.
• For real-time data from a MOD 300 or Master data source, specify a DCS data
provider. The default -name is DCS.
• For last history value from a MOD 300 or Master data source, specify a LOG
data provider. The default -name is LOG.
To look up the -name for a data provider, use the Server Status tool ABB Start Menu
> ABB System 800xA > Information Mgmt> Display Services> IM Display
Server Status. When asked to indicate the server with which to connect, be sure to
specify the server where the tag resides.
6.5.39 Adding Tags

Up to 50 tags can be added. Each time a tag is added, the dialog will provide another
set of tag specification fields to add another tag, Figure 6.57.
Figure 6.57: Adding Additional Tags
As an alternative, use the following procedure to copy tag specifications.
352 3BUF001094-600 B
6.5.40 Copying an Existing Tag

To make one or more copies of an existing tag, select the context menu of the tag and
choose: Copy Once or Copy Multiple Times, Figure 6.58. If a single copy is made,
a dialog is provided for specifying the new tag’s name. Enter a unique tag name, then
click OK. This adds a new tag which is identical to the copied tag, except for the
unique tag name.
Figure 6.58: Copying an Existing Tag
When multiple copies are made, a dialog is provided for specifying the quantity. Do
not add more than 50 tags to a Ticker file. After specifying the number of copies, the
tag naming procedure described above is repeated as many times as required to add
the specified number of tags. When finished adding tags, click OK. This displays the
file on the ticker.
Be sure to save the ticker file. To do this, right click on the ticker status indicator and
choose Save from the context menu.
6.5.41 Removing Tags from the File

To remove a tag from the file, click the check box next to the tag, Figure 6.59, then
click Remove. This displays a confirmation message. Click Yes to confirm, or No
to cancel the remove request.
3BUF001094-600 B 353
Figure 6.59: Marking the Tag Specification
6.5.42 Reverting to the Saved Configuration for a Tag

While editing the tag specification for a ticker file, t is possible to revert back to the
saved version BEFORE saving the latest changes. To do this, click the check box
next to the tag, Figure 6.59, then click Revert. This displays a confirmation message.
Click Yes to confirm, or No to cancel the revert request.
6.5.43 Configuring the Appearance of the Ticker File

The Appearance tab in the Tag Configuration dialog is used to modify the appearance
attributes for the current ticker file, Figure 6.60. These attributes are described in
Table 6.2. When an appearance attribute is changed in this dialog, preview the result
in the sample ticker view on the bottom of the dialog.
354 3BUF001094-600 B
Figure 6.60: Appearance Tab on Tag Configuration Dialog
Table 6.2: Tag & Ticker Appearance Attributes
Attribute Description
Tag Appearance - Normal, Out These fields are used to specify the colors for indicating tag status
of Range, and Unconnected (normal and out-of-range), and connection status. To change a
Colors color, refer to Changing Colors on page 358.
Tag Appearance - Font This field is used to specify the font for the ticker text. To change
the font, refer to Changing the Font on page 358.
Ticker Appearance - This field is used to specify the background color for the ticker
Background Color area. To change a color, refer to Changing Colors on page 358.
Ticker Appearance - Border This field is used to specify whether or not to show a border around
Style the ticker area. The choices are Single border or None.
Ticker Appearance - Speed This field is used to adjust the speed at which tags move across
the ticker area. Lowering the number causes the tags to move
faster. The range is 1 to 65535.
3BUF001094-600 B 355
Table 6.2: Tag & Ticker Appearance Attributes

(Continued)
Ticker Appearance - Tag This field is used to specify the rate at which tag data is refreshed.
Refresh Rate The range is 1 to 65 seconds. The recommended refresh rate is
15 seconds for best performance.
Ticker Appearance - Data This field is used to specify the format of the numeric string. Refer
Format to Data Format on page 356.
Data Format
0 Digit placeholder. Display a digit or a zero. If the expression has a
digit in the position where the 0 appears in the format string, display
it; otherwise, display a zero in that position.
If the number has fewer digits than there are zeros (on either side of
the decimal) in the format expression, display leading or trailing zeros.
If the number has more digits to the right of the decimal separator
than there are zeros to the right of the decimal separator in the format
expression, round the number to as many decimal places as there are
zeros. If the number has more digits to the left of the decimal separator
than there are zeros to the left of the decimal separator in the format
expression, display the extra digits without modification.
# Digit placeholder. Display a digit or nothing. If the expression has a
digit in the position where the # appears in the format string, display
it; otherwise, display nothing in that position.
This symbol works like the 0 digit placeholder, except that leading
and trailing zeros aren't displayed if the number has the same or fewer
digits than there are # characters on either side of the decimal separator
in the format expression.
356 3BUF001094-600 B
. Decimal placeholder. In some locales, a comma is used as the decimal

separator. The decimal placeholder determines how many digits are
displayed to the left and right of the decimal separator. If the format
expression contains only number signs to the left of this symbol,
numbers smaller than 1 begin with a decimal separator. To display a
leading zero displayed with fractional numbers, use 0 as the first digit
placeholder to the left of the decimal separator. The actual character
used as a decimal placeholder in the formatted output depends on the
% Percentage placeholder. The expression is multiplied by 100. The
percent character (%) is inserted in the position where it appears in
the format string.
, Thousand separator. In some locales, a period is used as a thousand
separator. The thousand separator separates thousands from hundreds
within a number that has four or more places to the left of the decimal
separator. Standard use of the thousand separator is specified if the
format contains a thousand separator surrounded by digit placeholders
(0 or #). Two adjacent thousand separators or a thousand separator
immediately to the left of the decimal separator (whether or not a
decimal is specified) means "scale the number by dividing it by 1000,
rounding as needed." For example, use the format string "##0,," to
represent 100 million as 100. Numbers smaller than 1 million are
displayed as 0. Two adjacent thousand separators in any position other
than immediately to the left of the decimal separator are treated simply
as specifying the use of a thousand separator. The actual character
used as the thousand separator in the formatted output depends on the
E- E+ e- e+ Scientific format. If the format expression contains at least one digit
placeholder (0 or #) to the right of E-, E+, e-, or e+, the number is
displayed in scientific format and E or e is inserted between the
number and its exponent. The number of digit placeholders to the
right determines the number of digits in the exponent. Use E- or e- to
place a minus sign next to negative exponents. Use E+ or e+ to place
a minus sign next to negative exponents and a plus sign next to positive
exponents.
3BUF001094-600 B 357
- + $ () Display a literal character. To display a character other than one of

those listed, precede it with a backslash (\) or enclose it in double
quotation marks (" ").
Changing Colors
1. Click in the field to select it. The text label for the field changes to white.
2. Double-click the selected field to display a standard Windows color palette,
Figure 6.61.
Text Label for

Selected Field
Changes to
White
Figure 6.61: Configuring Tag Appearance Color
Changing the Font

To change the font:
1. Click in the field to select it. The text label for the selected field changes to white.
2. Double-click the selected field to display a standard Font Selection dialog, Figure
6.62.
358 3BUF001094-600 B
Figure 6.62: Changing the Font
6.5.44 Changing Ticker Defaults

The ticker has global operating parameters that apply to all ticker files. There are
four sets of global parameters:
• Ticker parameters set up the defaults for ticker appearance characteristics.
• Indicator parameters specify the method for indicating error conditions on the
ticker.
• File parameters are used to associate pick lists in the Tag Configuration dialog
with their corresponding text files.
• Miscellaneous parameters for the aspect object browser.
For the most part, the ticker is operated using the defaults. To adjust one or more
global operating parameters, right click on the ticker status indicator and choose
Configure Ticker Defaults from the context menu. This displays the Default Ticker
Configuration dialog, Figure 6.63.
3BUF001094-600 B 359
Figure 6.63: Default Ticker Configuration Dialog
Click the tab corresponding to the parameters that need to be configured:

• Use the Ticker tab to configure default appearance characteristics for ticker
based on the selected ticker file. Most of these characteristics are the same char-
acteristics configured when creating a new ticker file. For details, refer to Con-
figuring the Appearance of the Ticker File on page 354.
Data Delimiter must be configured on a global basis for all tags and cannot be
configured on an individual tag basis. Refer to Configuring the Data Delimiter
on page 360.
• Use the Indicator tab to configure the method for indicating error conditions on
the ticker. Refer to Configuring Error Condition Indicators on page 362.
• Use the Files tab to associate pick lists in the Tag Configuration dialog with their
corresponding text files. Refer to File Specifications on page 363.
6.5.45 Configuring the Data Delimiter

The data delimiter separates the tag name from the tag attribute in a tag specification,
for example TC101:MEASURE. The default delimiter is a colon (:). Change the de-
limiter as needed. When the delimiter is changed, then all ticker and tag explorer files
360 3BUF001094-600 B
that are currently using the old delimiter must also be converted. This is demonstrated
in the following example:
1. Start by changing the delimiter, for example, from: to -.
2. Click Yes to acknowledge the warning that requires all ticker and tag explorer
files to be changed.
3. Click OK to register the changes in the Default Ticker Configuration dialog.
This displays a confirmation message.
4. Click Yes to confirm. This displays a browser dialog for selecting the directory
where the ticker files reside.
5. Use the browser dialog to navigate to and select the applicable directory. The
default is:
C: Program Files\ABB Industrial IT\Inform IT\Desktop Trends\Data\Ticker
Files.
6. Once the Ticker Files directory is selected, click OK. This displays a prompt
asking whether or not to convert Explorer backup files.
7. Click Yes to convert Explorer backup files. This displays a browser dialog for
selecting the directory where the explorer files reside. In this case proceed with
step 8.
Click No to convert Ticker files only. This starts the conversion process. In this
case, skip step 8.
8. To convert Explorer backup files, use the browser dialog to navigate to and select
the applicable directory. The default is
C: Program Files\ABB Industrial IT\Inform IT\Desktop Trends\Bin.
Click OK to start the conversion process. This displays a progress indicator.
9. When the conversion is complete:
• If there are additional directories with files that require conversion, click
More Files. This displays a browser dialog to select additional files to con-
vert.
• If there are no more directories with files that require conversion, click Ok.
This exits the conversion mode.
3BUF001094-600 B 361
6.5.46 Configuring Error Condition Indicators

Click the Indicator tab to display the error indicator parameters, Figure 6.64. There
are four basic categories: Errors to Show, Colors, Priorities, and Behavior.
Figure 6.64: Indicator Tab
Errors to Show
This is used to specify whether to annunciate or ignore error conditions. Disable the
annunciation of any error condition by deselecting the check box.
Error conditions related to tags are annunciated by showing the tag text and status
indicator in a specified color. Also, under the Behavior category, the status indicator
can be specified to blink or not.
The Save Needed condition refers to the need for saving a new ticker file, or saving
changes to an existing file. This condition is annunciated by showing the status indi-
cator in the specified color. In addition, a warning message is displayed if an attempt
is made to clear the ticker without first saving the ticker file.
Colors
This is used to select a unique color for each error condition. For details on how to
select a new color refer to Changing Colors on page 358.
362 3BUF001094-600 B
Priorities
This is used to associate a priority with each of the possible error conditions. This
may be used when specifying the Behavior for the case where multiple error conditions
exist at the same time.
Behavior
This is used to enable/disable blinking, and specifies the behavior of the status indi-
cator light when multiple error conditions exist.
The options for When Multiple Errors Occur are:
• Do Not Show Errors - The status indicator light will remain in the specified No
Error color.
• Show First Error Encountered - The status indicator light will remain in the
specified color for the first condition that was detected.
• Show All Errors of the Highest Priority - The status indicator light will alternate
between the colors for each of the existing error conditions at the highest priority.
• Show All Errors - The status indicator light will alternate between the colors
for each of the existing error conditions.
6.5.47 File Specifications

The Files tab is used to associate text files with their respective pick lists, Figure 6.65.
It also is used to specify the default location for ticker files.
3BUF001094-600 B 363
Click Browse Button

to Display File Chooser
Click Ed. Button

to Open the File
in a Text Editor
Figure 6.65: Files Selection Dialog
To change any of the default specifications, click the corresponding browse button.
This displays a standard Windows File Chooser dialog. Use this dialog to navigate
to and select the text file (for pick lists) or folder (for ticker files).
Clicking the Ed. Button launches a text editor that is used to change the corresponding
text file, Figure 6.66.
For guidelines on editing text files, refer to:
• Setting Up Pick Lists on page 287.
• Setting Up the Limits File on page 290.
364 3BUF001094-600 B
Figure 6.66: Opening a File in a Text Editor
6.5.48 Aspect Object Browser Defaults

The Misc tab is used to specify the Default Data Provider and Default Subscription
Typefor the aspect object browser, Figure 6.67.
Default Data Provider

The default data provider is AIPOPC. This supports access to real-time process and
softpoint objects in the 800xA System. If the last history value is to be retrieved rather
than the actual real-time value, change the default to AIPHDA. This supports access
to property logs in the 800xA System.
Default Subscription Type

Specify whether to retrieve the actual OPC value directly from the OPC server tag,
or the Last History Value from the corresponding History log.
To subscribe to the last history value, the corresponding data provider must reside
on the same node where the history log is located.
3BUF001094-600 B 365
Figure 6.67: Misc Tab for OPC HDA Access
6.5.49 Operating the Ticker

The Ticker is an ActiveX control hosted within Windows Internet Explorer. It displays
a repeating stream of real time data for selected tags, similar to a stock market ticker.
The stream moves right-to-left at the specified ticker speed. The data are refreshed
at the specified refresh rate.
This section describes the following ticker functions:
• Displaying Real Time Data on the Ticker on page 367.
• Showing Errors on page 367.
• Saving the Ticker File on page 368.
• Clearing the Ticker on page 369.
• Dragging and Dropping Tags Between Desktop Trend Controls on page 369.
• Refreshing Tag Limits on page 372.
• Displaying Version Information for the Ticker Controls on page 373.
• Launching the Trend Display from the Ticker on page 373.
366 3BUF001094-600 B
Displaying Real Time Data on the Ticker

To display real time data on the ticker, open an existing ticker file, or configure a
new file. To configure a new file, refer to Configuring Ticker Files on page 337. To
open an existing file, right click on the ticker status indicator and choose Open
Ticker File from the context menu, Figure 6.68.
Figure 6.68: Opening a Ticker File
This displays a standard Windows file chooser dialog. By default, the dialog points
to the Data folder where ticker files are stored. Use this dialog to choose a file from
this folder, or navigate to another folder where ticker files are stored.
Showing Errors
Error conditions are annunciated by showing tag text and the status indicator light in
a specified color. The status indicator may also blink, if it is configured to do so. The
method and format for indicating error conditions on the ticker is configurable through
the Indicator tab in the Default Ticker Configuration dialog. For instance, configure
whether or not to annunciate tags out of range, or unconnected tags. In addition, how
to handle multiple error conditions can be specified, and whether or not to have the
status indicator blink. Regardless of how these parameters are configured, a message
box (refer to example in Figure 6.69) can always be displayed that describes the current
error conditions for the ticker.
1. Choose Show Current Errors from the context menu of the ticker status indica-
tor.
2. Click OK to acknowledge the message.
3BUF001094-600 B 367
Figure 6.69: Current Errors Message Box
Saving the Ticker File

The ticker file must be saved to be able to view it again. To do this right click on the
ticker status indicator and choose Save or Save As from the context menu, Figure
6.70.
Figure 6.70: Saving the Ticker File
The Save dialog points to the default folder for storing ticker files:
C:\Program Files\ABB IndustrialIT\InformIT\Desktop Trends\Data
It is recommended that the files be stored in this folder because this makes it easier
to find the files to display on the ticker. This is where the File-Open dialog points by
default. If necessary, another location can be specified.
368 3BUF001094-600 B
Clearing the Ticker

To remove the current file from the ticker, right click and choose Clear Ticker from
the context menu, Figure 6.71. If the current ticker file has not been saved, a warning
message will be displayed. Either save the file (Saving the Ticker File on page 368),
clear the file without saving, or cancel the clear request.
Figure 6.71: Clearing the Ticker
6.5.50 Dragging and Dropping Tags Between Desktop Trend Controls

An alternate method for putting tags on the ticker is to drag and drop the tags from:
• Another Desktop Trend control (another ticker or the Tag Explorer).
• A text editor or spreadsheet such as Microsoft Word or Excel.
The methods described in this section are applicable for dragging and dropping
tags between any two desktop trend controls, except that tags cannot be dragged
from the trend display.
Dragging and Dropping from Another Desktop Trend Control

This example shows how to drop a tag from one ticker onto another ticker. This same
method may be used to drag and drop between any two Desktop controls.
Drag the tags directly onto the desktop control, or into a tag specification in the
Tag Configuration dialog (refer to Configuring Tags on page 339).
3BUF001094-600 B 369
Two separate controls must be opened in two separate Internet Explorer windows.
In the source control, point to the tag to be copied with the left mouse button and then
drag and drop the tag on the destination control, Figure 6.72.
Indicates Suitable Location for Dropping
Figure 6.72: Dragging and Dropping
This note is only applicable when dropping tags on a ticker. If the ticker is empty,
the tag will simply be placed on the ticker. If the ticker is already displaying a
ticker file, then verify whether to join the new tag with the current file, or clear
the current file before putting the new tag on the ticker. In either case, to preserve
the new file, execute a save.
Dragging and Dropping from a Text Editor or Spreadsheet

To drag and drop a tag from a text editor or spreadsheet, enter the tag specification
as a properly formatted text string in the editor or spreadsheet. The properties are
listed in Table 6.3. For text editors, put each tag on a separate line, and separate each
370 3BUF001094-600 B
property with a colon (:). For spreadsheets, put each tag on a separate row, and enter
each property in a separate column.
Table 6.3: Tag Information Text String
Tag Properties Comment

Tag Name Enter the tag name, for example FC100.
Attribute Enter the tag attribute. Some OPC data sources do not use attributes. For
guidelines, refer to Tag Name on page 349.
Default Value Enter a value to display in the ticker if an actual value is not available, for
example if the data source is not connected, or when working offline.
Low Limit Enter the default low limit.
High Limit Enter the default high limit.
Use Limits Flag Enter the value (0, 1, or 2) that specifies how to perform the limit check:
0 = Do not perform limit check
1 = Use limits specified in this text string
2 = Get limits from the data source
Data Provider Enter the data provider name: (Refer to Data Provider on page 352)
• For actual real-time data for an OPC tag, enter AIPOPC.
• For last history value for an OPC tag, enter AIPHDA.
• For real-time data from a MOD 300 or Master data source, specify a DCS
data provider. The default -name is DCS.
• For last history value from a MOD 300 or Master data source, specify a
LOG data provider. The default -name is LOG.
Object Type Enter the object type, for example CCF_CONTIN_LOOP for MOD 300, or
PIDCON for Master. Some OPC data sources do not use object types. Refer
to Attribute and Object Type on page 350.
Subscription Type Enter one of the following subscription types, exactly as shown:
• Realtime Value.
• Last History Value.
• OPC Value.
The following are examples of complete tag specifications for a text editor:
• MOD 300:
FC100:Measure:100:0:500:1:DCS:CCF_CONTIN_LOOP:Realtime Value
3BUF001094-600 B 371
• For Master: FC100:Value:100:0:500:1:DCS:PIDCON:Realtime Value

An example for dragging and dropping a tag specification from Microsoft Word is
shown in Figure 6.73.
Figure 6.73: Dragging and Dropping a Tag From Microsoft Word
6.5.51 Refreshing Tag Limits

The ticker can perform a limit check to determine whether the tag value is within the
normal range, or is out of range. If the limits are derived from the data source, the
limits are retrieved after all tags have been added to the ticker, and an attempt has
been made to get values for these tags. The limits are not refreshed unless new tags
are added, or the Refresh Limits menu item is invoked. To do this, right click on the
ticker status indicator and choose Refresh Limits from the context menu, Figure
6.74.
372 3BUF001094-600 B
Figure 6.74: Refreshing High/Low Limits
6.5.52 Displaying Version Information for the Ticker Controls

To display version information for the ticker controls, right click on the ticker status
indicator and choose About from the context menu. This displays the About message
box.
6.5.53 Launching the Trend Display from the Ticker

The trend display can be launched directly from the ticker. To do this, right click on
the ticker status indicator and choose Launch Trend Display from the context menu,
Figure 6.75.
Figure 6.75: Launching the Trend Display from the Ticker
3BUF001094-600 B 373
This displays list of tags defined in the current tag file, Figure 6.76. Use this dialog
to select up to eight tags for display on the trend display. By checking the Include
Limits Where Applicable check box, the high and low limits, as well as the high
and low scale values are set for all tags not marked as No Limit Checking. Check the
Get Attributes From Database check box, to get the attributes for the tag.
Figure 6.76: Selecting Tags for the Trend Display
6.5.54 Refreshing the Ticker in Internet Explorer

If the Refresh function in Internet Explorer is used to refresh the Ticker File being
displayed, the file will be overwritten with an empty file. To refresh rather than
overwrite the current file, configure the refresh parameter in the current Ticker File’s
HTML file.
With the Ticker File displayed in Internet Explorer, choose View>Source to open
the HTML file in a text editor. Scroll to the section for the Ticker refresh parameter
as shown below and enter the full path for the Ticker File between the quotation marks
as shown in the example in bold.
<OBJECTID=”ABBTicker”Name=”ABBTicker”
CLASSID=”clsid:4CD2A7FE-E56F-11D4-89B8-005004830B74”
BORDER=”0” WIDTH=”557” HEIGHT=”45”>
374 3BUF001094-600 B
6 Using Desktop Trends 6.6 Tag Explorer

<Param name=”TickerFile” value=”%ABB_ROOT%\Inform IT\Desktop
Trends\Data\Ticker Files\Ticker1.tik”></PARAM>
</OBJECT></P>
6.6 Tag Explorer

The Tag Explorer provides a graphical interface, similar to Windows Explorer, for
navigating the tag database and displaying real time data in tabular format, Figure
6.77.
Figure 6.77: Example, Tag Explorer
Before configuring the Tag Explorer, make sure the text files for the pick lists and
limits file have been configured as described in Setting Up Pick Lists on page 287.
To set up and use the Tag Explorer, follow the instructions in:
• Launching the Tag Explorer on page 375.
• Configuring the Tag Explorer on page 376.
• Using the Tag Explorer on page 383.
6.6.1 Launching the Tag Explorer

Access to the Tag Explorer is through the Windows Taskbar. To launch the Tag Ex-
plorer, from the Windows Taskbar, choose:
ABB Start Menu > ABB System 800xA Information Mgmt>Desktop Trends>
IM Tag Explorer.
3BUF001094-600 B 375
6.6.2 Configuring the Tag Explorer

The Tag Explorer must be set up on two levels: tag groups and appearance/operation:
Tag Groups - The Tag Explorer organizes tags in tag groups. Tag information can
be viewed for one selected group at a time. To set up the Tag Explorer, add tag groups
to the Tag Explorer tree view, and then add tags to the groups. These procedures are
described in Creating Tag Groups on page 376 and Specifying the Contents Tag Groups
on page 377. Also refer to User Tag Management (UTM) on page 513.
Appearance/Operation - The Tag Explorer has configurable parameters that govern
its appearance and operation. Refer to Configuring the Tag Explorer Appearance and
Operational Characteristics on page 379.
Working Off Line

During configuration, if the data source is unavailable or providing bad data, then
work in the offline mode. This is used to suppress spurious error conditions. Tags
will be displayed in the user-specified offline status color instead. To work off line,
right click and choose Work Offline from the context menu.
6.6.3 Creating Tag Groups

Tags are organized in user-defined groups in the Tag Explorer. Groups can be added
on two levels. At the highest level, add a group directly under the Tag Groups object
in the Tag Explorer tree view, Figure 6.78.
Highest Level for Adding Tag Groups
Figure 6.78: Adding Tag Groups Under the Tag Groups Object
Tag groups can also be added as children under an existing parent tag group. The
existence of children tag groups under a parent tag group is indicated by the +/-
symbol.
To add a new tag group,
1. Click on the parent object where the tag group is being added.
2. Choose New>Tag Group from the context menu, Figure 6.79.
376 3BUF001094-600 B
Figure 6.79: Adding a New Tag Group
This adds a new group under the selected parent object. The default name is
highlighted to edit the name.
3. Rename the new group, Figure 6.80.
Figure 6.80: Changing the New Group’s Name
6.6.4 Specifying the Contents Tag Groups

Tags can be added to tag groups in either of two ways:
• Adding tags to an explorer file through the Tag Configuration dialog. This pro-
cedure is described in Adding Tags to an Explorer File on page 378.
• Importing an existing ticker or explorer file. This automatically adds all tags in
the file to the tag group as described in Importing Files on page 378.
It is recommended that the size of a tag group be limited to no more than 50 tags.
3BUF001094-600 B 377
Adding Tags to an Explorer File

Specify the contents of a tag group by manually adding tags to an explorer file. This
is done through the Tag Configuration dialog. To display this dialog, select the tag
group and choose New>Tag(s) from the context menu.
The operation of this dialog is the same as for adding tags to a ticker file. For details,
refer to Configuring Tags on page 339. Also refer to User Tag Management (UTM)
on page 513.
It is recommended that the size of a tag group be limited to no more than 50 tags.
Modifying the Configuration for an Existing Tag

The Tag Configuration dialog for an existing tag can be used to modify the tag’s
configuration. To do this, double-click on the tag.
Importing Files
Existing Ticker and/or Tag Explorer files may be imported into a tag group. This
automatically adds all tags in the file to the tag group. Ticker and explorer files are
built through the Tag Configuration dialog (refer to Configuring Tags on page 339).
To import ticker and explorer files,
1. Select a tag group,
2. Right click and choose from the context menu either:
• Import/Export > Import Ticker File or
• Import/Export > Import Explorer File.
This displays a dialog for selecting the Ticker file (*.tik) to import. By default, the
dialog points to the Data folder where the ticker (or explorer) files are stored. Choose
a file from this folder, or navigate to another folder where the ticker (or explorer)
files are stored.
6.6.5 Clearing the Current Tag Explorer Configuration

To clear the contents of the Tag Explorer:
1. Choose Import/Export > Clear Current Configuration File from the context
menu. This will display a confirmation message.
378 3BUF001094-600 B
2. Click Yes to confirm and continue the clear operation, or click No to cancel.
6.6.6 Configuring the Tag Explorer Appearance and Operational Char-

acteristics
To adjust the appearance and operating parameters for the Tag Explorer,
1. Choose Configure Tag Explorer from the context menu.
2. Use the configuration dialog, Figure 6.81, to configure three basic sets of appear-
ance/operational characteristics:
• Click the Appearance tab to configure general appearance characteristics.
• Click the Columns tab to selectively show or hide columns in the list view.
• Click the Files tab to associate pick lists in the Tag Configuration dialog
with their corresponding text files.
Figure 6.81: Tag Explorer Configuration Dialog
3BUF001094-600 B 379
Configuring the General Appearance

These attributes are organized in four basic categories as described in Table 6.4.
Table 6.4: Tag Explorer General Appearance Characteristics
Tree View The check boxes in this section are used to show or hide certain
aspects of the Tag Explorer tree view. Refer to Figure 6.82 for
details.
Colors These fields are used to specify the colors for indicating tag status
(normal and out-of-range), and connection status. To change a
color, refer to Changing Colors on page 358.
List View The check boxes in this section are used to show or hide certain
aspects of the Tag Explorer list view. Refer to Figure 6.83 for details.
Data These fields are used to set the tag refresh rate, and specify the
Data format.
Icons Enabled Lines Enabled Plus/Minus

All Enabled (Default) Enabled All Disabled
Figure 6.82: Tree View Adjustments
380 3BUF001094-600 B
Details - Default
List (or Small Icons) Large Icons
Figure 6.83: List View Adjustments
Columns
This tab is used to select which columns to show or hide in the list view, Figure 6.84.
The name of any column can also be changed.
Figure 6.84: Adjusting the List View Columns
3BUF001094-600 B 381
6.6.7 File Specifications

The Files tab is used to associate text files with their respective pick lists, Figure 6.85.
It also is used to specify the default location for tag group specifications.
Browse for File

To change any of the default specifications, click the corresponding browse button.
This displays a standard Windows File Chooser dialog. Use this dialog to navigate
to and select the Picklist text file (*.txt) or folder (for tag groups).
Edit File
Clicking the Ed. Button launches a text editor that is used to change the corresponding
text file. This is a text editor only. The HTML format requires special editing.
For guidelines on editing text files, refer to:
• Setting Up Pick Lists on page 287.
• Setting Up the Limits File on page 290.
Click Browse Button

to Display File Chooser
Click Ed. Button

to Open the File
in a Text Editor
Figure 6.85: Tag Explorer - Files Specification Dialog
382 3BUF001094-600 B
6.6.8 Aspect Object Browser Defaults

The Misc tab is used to specify the Default Data Provider and Default Subscription
Typefor the aspect object browser, Figure 6.67. Use the Add and Remove buttons
to edit the Data Provider list.
6.6.9 Aspect Object Browser

This Old Style view supports connecting to an older server that contains Advant OCS
(MOD 300 or Master) tags. To use this view select the Old Style option button, then
refer to Adding an Advant OCS Tag on page 347.
6.6.10 Using the Tag Explorer

The method of operation for Tag Explorer is similar to Windows Explorer. Use the
tree view to navigate to and select a tag group for viewing. This displays the corre-
sponding tags in the tag list, Figure 6.86. The context menu for tags supports several
viewing functions as described in Table 6.5.
Figure 6.86: Viewing Tags in Tag Explorer
Table 6.5: Tag Context Menu Items
Menu Item Description

View Used to select any one of the following viewing options for the
tag list: Large Icons, Small Icons, List, and Details. The Details
view is the only view that shows tag information.
Refresh This refreshes the tag values for all tags currently shown in the
tag list.
3BUF001094-600 B 383
Table 6.5: Tag Context Menu Items

(Continued)
Menu Item Description

Refresh Tag This refreshes the tag value for the currently selected tag.
Refresh Limits This refreshes the high/low limits for tags currently shown in the
tag list that are configured to Get System Values. Refer to Limit
Check on page 351.
Delete This deletes the currently selected tag.
Rename This is used to rename the currently selected tag.
Sort This is used to sort the tag list based on the selected tag property
(as shown in the Details view).
About This displays a message box with version information.
6.6.11 All Tags

The All Tags groups is a read-only Tag Group that is used to see all the tags configured
in the Tag Explorer. It shows (in the detail view) the same information as any other
tag group, but will not get new values.
6.6.12 Dragging and Dropping Tags in Tag Explorer

An alternate method for putting tags in the Tag Explorer is to drag and drop the tags
from:
• Another Desktop Trend control (ticker or Tag Explorer).
• A text editor or spreadsheet such as Microsoft Word or Excel.
The drag and drop methods are applicable for dragging and dropping tags between
any two desktop trend controls, except that tags cannot be dragged from the trend
display. The procedure is described in Dragging and Dropping Tags Between Desktop
Trend Controls on page 369.
384 3BUF001094-600 B
6.6.13 Exporting Files

Create a new ticker file by exporting the contents of a tag group. Similarly, create a
backup for an existing explorer file by exporting its contents. These procedures are
described in:
• Exporting a Tag Group to Create a New Ticker File on page 385.
• Exporting a Tag Explorer File for Backup on page 385.
Exporting a Tag Group to Create a New Ticker File

Select the contents of any tag group to create a new ticker file. To do this,
1. Select the tag group,
2. Right click, and choose Import/Export >Export Ticker File from the context
menu. This displays a dialog for saving the file to a specified location. By default,
the dialog points to the Data folder where the ticker files are stored. The name
defaults to the name of the selected tag group with the tik file extension. Rename
the file if necessary.
3. Click Save to save the file in the Data folder, or use the dialog to navigate to
another location.
Exporting a Tag Explorer File for Backup

When the contents of a tag explorer file is exported, the entire contents of the explorer
file is exported. Individual tag groups cannot be exported. This procedure may be
used to create a backup tag explorer file.
To create a backup tag explorer file,
1. Right click in the tag explorer and choose Import/Export>Export Explorer
File from the context menu. This displays a dialog for saving the file to a specified
location. By default, the dialog points to the Bin folder where the explorer files
are stored. The name defaults to the name of the current tag explorer file with
the suffix backup appended, for example tagexplorerbackup.ini. Rename the file
if necessary.
2. Click Save to save the file in the Bin folder, or use the dialog to navigate to an-
other location.
3BUF001094-600 B 385
6 Using Desktop Trends 6.7 PDL Browser
6.6.14 Displaying Version Information for the Tag Explorer Controls

To display version information for the Tag Explorer controls, right click and choose
About from the context menu. This displays the About message box.
6.6.15 Launching the Trend Display from the Tag Explorer

Launch the trend display directly from the Tag Explorer. To do this, right click on
the Tag Explorer tree view and choose Launch Trend Display from the context
menu.
This displays list of tags defined in the current tag group, Figure 6.76. Use this dialog
to select up to eight tags for display on the trend display.
By checking the Include Limits Where Applicable check box, the high and low
limits, as well as the high and low scale values are set for all tags not marked as No
Limit Checking.
Check the Get Attributes From Database check box, to get the attributes for the
tag.
6.7 PDL Browser

The PDL Browser, Figure 6.87, is used to query PDL tasks for production data. There
are three main sections. The top section is used to specify search criteria to find the
applicable PDL. This includes the task type, task name, and time range. The middle
section displays the search results and is used to drill up or down in the task hierarchy.
The bottom section displays five categories of information for the selected task -
Variables, Resources, Messages, History, and the Next Level. The Options button
displays a dialog for configuring certain parameters for PDL browsing.
386 3BUF001094-600 B
Search
Criteria
Search
Results
PDL
Data
Figure 6.87: PDL Browser
To set up and use the PDL Browser, follow the instructions in:
• Opening the PDL Browser on page 387.
• Setting Up the PDL Browser Interface on page 387.
• Using the PDL Browser on page 394.
6.7.1 Opening the PDL Browser

Access to the PDL Browser is through the Windows Taskbar. To launch the PDL
Browser, from the Windows Taskbar, choose: ABB Start Menu > ABB System
800xA > Information Mgmt>Desktop Trends>PDL Browser.
6.7.2 Setting Up the PDL Browser Interface

PDLs may be created by any one of four batch processing applications (refer to Type
of PDL on page 389). The type of PDL application being used through the Configure
3BUF001094-600 B 387
PDL Browser dialog, Figure 6.88, must be specified. Access this dialog by clicking
the Options button on the PDL Browser.
Figure 6.88: Configure PDL Browser Dialog
Refer to the following to specify date and time options as well as other miscellaneous
options.
• Type of PDL on page 389.
• Configuring 800xA Batch Management on page 390.
• Convert Task Value to Uppercase on page 391.
• Use Restored Archive on page 391.
• Maximum Values to be Returned on page 392.
• Warn If Exceeded on page 392.
• Default Time Span on page 392.
388 3BUF001094-600 B
• Date and Time Format on page 392.

• Query Timeout on page 394.
• Language on page 394.
• ProduceIT Messages on page 394.
• Trend File on page 394.
Type of PDL
Use this pick list to specify the PDL application: Batch 300, Taylor Control Language
(TCL), Produce IT Batch (default), Flexible, or Profile Historian. This determines
types of tasks available in the Task Type list in the PDL Browser. Task types for the
various PDL applications are indicated in Table 6.6.
Table 6.6: Resulting Task Type Options Based on Type of PDL Selected
Type of PDL Task Type Options

Batch 300 Job, Batch, Unit, Phase
TCL TCL Batch
Produce IT Batch (Default) Campaign - Level 0
(for Produce IT Batch version 1.1 and Batch - Level 1
1.2/0) Procedures Level 1 - Level 2,3
Phase - Level 12
Profile Profile Events (Reel, Grade, Dayshift) - Level 1
Roll Set Information - Level 2
Generic Returns Level 1, Level 2, Level 3, and Level 4.
Flexible Up to 15 user-configurable task types. Refer to Configuring
(use this option for Produce IT Batch 800xA Batch Management on page 390 for details.
version 1.2/1 and later)
The Produce IT Batch option is only applicable for Produce IT Batch versions 1.1
and 1.2/0. If version 1.2/1 or later is being used, select the Flexible PDL Type.
3BUF001094-600 B 389
Configuring 800xA Batch Management

The 800xA Batch Management option in the Type of PDL pick list is used to con-
figure up to 15 user-defined task types. Selecting 800xA Batch Management enables
the Customize button, Figure 6.89.
Figure 6.89: Selecting 800xA Batch Management of PDL
This button displays the Customize PDL Hierarchy dialog, Figure 6.90. Each level
has a default name. These names can be changed. To choose which levels to include
in the Task Type list in the PDL Browser check the corresponding check box. Any
level whose check box is checked is included in the list.
390 3BUF001094-600 B
Figure 6.90: Customize PDL Hierarchy Dialog
Convert Task Value to Uppercase

Queries for task names in the Oracle PDL database are case-sensitive. Use this option
to specify whether or not an input Task Value entry will be automatically converted
to uppercase characters before a search request is executed. When all task names are
stored in uppercase characters, this option will not hinder a user when entering low-
ercase values. The default is Unchecked (do not convert to uppercase).
Use Restored Archive

This option is used to access PDL data that has been restored from an archive. When
this option is checked, all queries are performed against a set of PDL tables that
contain restored PDL data only. A label is generated on the PDL Browser to indicate
that a restored archive is being used. No label is displayed when an active database
is being used. The default is Unchecked (use active database).
3BUF001094-600 B 391
Maximum Values to be Returned

This option is used to specify the maximum number of values to be returned to the
client for each query that is executed. This helps to avoid hanging the client computer
by generating queries that return an excessive number of values. The range is 1 to
65,534. The default is 500.
Warn If Exceeded
This check box is used to choose whether or not to display a message when the
specified query result has more than the specified maximum values. This message is
used to choose whether to disregard the limit and return all values, or impose the
limit and discard the values in excess of the specified limit. For more information,
refer to Limiting the Amount of Data Returned By Your Query on page 396.
If this option is unchecked, the specified maximum number of values to be returned
will always be imposed and no notification is made when the query result has addi-
tional values that are being discarded.
Default Time Span

The Default Time Span fields are used to specify the default time span for the PDL
Browser. This helps from having to adjust the start or end times in the PDL Browser
each time a new query is entered and the same time span is used.
The End Time in the PDL Browser defaults to the current time. The time span specified
here is subtracted from the End Time to determine the Start Time for the query.
First select an interval: Hour, Day, Week, or Month. Then select the number of in-
tervals. The range varies based on the interval type:
• Minutes, Hours, Days = 32767.
• Weeks = 20800.
• Months = 4800.
• Years = 400.
The default is 1 Week.
Date and Time Format

These pick lists are used to select the format for displaying dates and times, Figure
6.91. If a format is needed that is not available in the list, then build a custom format.
392 3BUF001094-600 B
To do this click the corresponding Build button and use the Build Date Format or
Build Time Format dialog, Figure 6.92 (for reference only).
Figure 6.91: Specifying Date and Time Formats
Figure 6.92: Building a Custom Date or Time Format
Selecting a different date or time will not affect PDL browser operation. Use this
feature to check how the selected format will look for different dates.
3BUF001094-600 B 393
Data Provider
The PDL Browser accesses PDL data through an ADO data provider on the Historian
server. This data provider is configured through the ADSS tool on the Windows
Control Panel. In most cases, the default ADO data provider (named DBA) should
be used. If the application uses more than one ADO data provider for PDL access,
or if the ADO data provider has a different name (not recommended), this field is
used to specify the name of the data provider. For details regarding the ADO data
provider refer to the post installation procedures in System 800xA Post Installation
(3BUA000156*).
Query Timeout
This is the maximum time to wait for the selected object to respond to the query before
timing out. The timeout interval may need to be increased for complex queries.
Language
This option specifies the language used for displaying message-type PDL data. Cur-
rently only English language is supported.
ProduceIT Messages
This specifies the method for retrieval of Produce IT Batch messages based on the
version:
• PDL Messages retrieves messages for Produce IT Batch v1.1 and 1.2 - For these
versions, PDL messages and events are stored in the PDL (level 15 task).
• Messages Log retrieves messages for Produce IT Batch v1.2/1 - For this version
PDL messages and events are stored in an OPC message log.
Trend File
This is used to specify which html file to open when the Trend Display is launched
from the History tab (Refer to History on page 401). The corresponding button
launches a file browser dialog for specifying a different html file.
6.7.3 Using the PDL Browser

Use the Search Criteria controls to retrieve the PDL tasks whose data will be accessed.
Any tasks meeting the specified criteria are displayed in the Search Results section.
394 3BUF001094-600 B
Use the controls in this section to drill up or down in the hierarchy for a selected task.
Data for the selected task are displayed in the Associated Data Listing below the
Search Results.
6.7.4 Search Criteria

Use this part of the PDL Browser to specify the Task Type, Task Value, and Time
Span for the search. Click Search when finished, Figure 6.93.
Figure 6.93: Search Criteria Section
Task Type
This specifies the level of the PDL hierarchy to be searched. The choices in the Task
Type list are based on the Type of PDL selected in the Configure PDL Browser dialog.
Refer to Type of PDL on page 389.
When the Task Type specification is changed, any previous results in the PDL
Browser are cleared.
For this release of the software, Batch 300 and TCL-specific criteria are automat-
ically applied to the search to prevent the retrieval of Batch records which do not
belong to the selected PDL type. If Batch 300 is the current PDL type, then TCL
Batch records will not be retrieved when a search for Batch records is executed.
If TCL is the current PDL type, then Batch 300 batch records will not be retrieved
during a Batch search.
Task Value
This specifies the name of the task to query. If a name is not specified, all tasks are
returned. Enter the complete name, or just a partial name. The wildcard character%
3BUF001094-600 B 395
can be used to search for a particular pattern or format. Leading and trailing blanks
are removed before the search is executed.
The Convert Task Value to Uppercase option in the Configure PDL Browser dialog
determines whether or not to convert the task name to uppercase characters. This is
a convenience option for those systems in which all names are stored as uppercase.
Time Span
The Time Span fields is used to specify a time range for the query for which data will
be retrieved. These fields can be enabled or disabled through their respective check
boxes as follows.
• To restrict the query to a time range, check both boxes, and enter both the Start
and End date/times.
• To make a query for all tasks starting before a specific date/time, check just the
End check box, and enter the End date/time.
• To make a query for all tasks starting after a specific date/time, check just the
Start check box, and enter the Start date/time.
By default, the End date/time are set to the current date and time when the PDL
Browser is opened. The Start date/time are set based on the Default Time Span
option on the Configure PDL Browser dialog (Start date/time = End date/time
minus Default Time Span).
Any part of the date and time can be modified by clicking directly on the unit to be
changed and entering the new value. For time, use the up/down arrows to change the
selected unit. For date, click the down arrow to display the Microsoft Date and Time
Picker dialog.
Entering an end time that precedes or equals the start time causes an error message
to be displayed when the query is executed. Click OK to clear the message, then
enter a valid start (or end) time.
Do not use either of the following options for short date style in the Regional
Settings dialog (Windows Control Panel function): yy-dd-mm or yyyy-dd-mm.
This causes the month and date values to be reversed in the DT Picker.
Limiting the Amount of Data Returned By Your Query

As a safeguard against retrieving an excessive amount of data, configure a limit for
the number of values to be returned for each query. Use the Maximum Values to be
396 3BUF001094-600 B
Returned field in the Configure PDL Browser dialog. Refer to Maximum Values to
be Returned on page 392. The default is set at 500 values. The range is 1 to 65,534.
If the Warn If Exceeded check box in the Configure PDL Browser dialog is checked,
the dialog shown in Figure 6.94 is displayed when the total number of values satisfying
the search criteria exceeds the specified limit.
Figure 6.94: Maximum Number of Retrieved Rows Exceeded Dialog
If this occurs, use this dialog to do one of the following:

• To retrieve all values, click Options. This displays the Configure PDL Browser
dialog. Adjust the number of rows to be returned. Refer to Maximum Values to
be Returned on page 392.
• To accept the results as is and return to the PDL Browser, simply click OK.
To not see this message each time the maximum number of rows is exceeded, click
the check box. This remains in effect for the current PDL Browser session. The Warn
If Exceeded check box in the Configure PDL Browser dialog can also be used to en-
able/disable this message. Refer to Warn If Exceeded on page 392.
6.7.5 Search Results

This displays a listing of tasks that meet the search criteria, Figure 6.95. The search
results include: Task Name, Start Time and End Time. The rows are sorted by Start
Time. The header for the first displayed column changes according to the Task Type
that was searched.
task in order to view the data at all levels of the hierarchy for a task. Refer to Drilling
on page 399 for details.
3BUF001094-600 B 397
If the search is performed for a level lower than the topmost (job or campaign) level
of the PDL hierarchy, the results will also include the task names at each level of the
hierarchy, up to the topmost level, for each row in the listing. For the example, the
results shown in Figure 6.95 are for a search done at the Job level in a Batch applica-
tion.
Figure 6.95: Example, Search Results
The first row in the Search Results listing is automatically selected (highlighted), and
the associated data for the selected item are available for viewing in the Associated
Data Listing section of the dialog. When a different row is selected, the contents of
the Associated Data Listing changes accordingly.
Some column values may be truncated in the display due to the fixed widths of the
columns. Horizontal and vertical scroll bars are provided when the number of rows
or columns exceeds the limits of the Search Results window.
The main search result count is displayed above the result listing. The associated data
search count is displayed below the listing. If a query does not return any results, a
row with the text No Data is displayed underneath the header row. Additionally, the
search count displays No rows returned.
Copying Search Results

Select and copy search results using either Ctrl-C or by right-clicking and choosing
Copy to Clipboard from the context menu. Results can be copied one-at-a-time.
Multiple subresults can be selected to copy at the same time. The copy function copies
all selected items with a header row.
398 3BUF001094-600 B
Drilling
task in order to view the data at all levels of the task hierarchy. Drilling down displays
data for the selected task at the next level down in the hierarchy. Drilling up displays
data for the selected task at the next level up in the hierarchy. For example, clicking
the drill down button for job-level task - Thur314Bat_job in Figure 6.95, displays the
batch-level search results for Thur314Bat, Figure 6.96.
Figure 6.96: Drill Down Example
The Task Type value indicates the current level. The Task Value is reset to a blank
value, and the time values retain their previous values.
The task that was selected before the drill function was performed will be highlighted
even when drilling in the opposite direction later. For example, if an initial search is
performed for a batch, the drill down function will display data at the unit level for
the selected batch. If drill down is executed again, data at the phase level for the se-
lected unit will be displayed. For Drill Up, data at the unit level will be displayed for
the unit that was originally selected.
The drill buttons are automatically enabled and disabled as follows:
• If the Search Results listing indicates ‘No Data’, the Drill Down and Drill Up
buttons are disabled.
• If the current Task Type value is at the bottom of the hierarchy for a PDL type,
the Drill Down button is disabled.
• If the current Task Type value is at the top of the hierarchy for a PDL type, the
Drill Up button is disabled.
• After each new search is completed, the Drill Up button is disabled. To drill
Down, perform a new search.
3BUF001094-600 B 399
Associated Data Listing

This part of the PDL Browser displays the data for selected task in the Search Results
listing. These data are organized under the following tabs: Variables, Resources,
Messages, History, and Next-Level Listing.
Variables
This tab displays: variable name, value, time, occurrence number, result value and
result time. The rows are sorted by Time, then by Variable Name, then by Occurrence,
Figure 6.97.
Figure 6.97: Example, Variables Tab
Resources
This tab displays: Resource Type, Name, Value, Time and Occurrence. The rows are
sorted by Type, then by Name, then by Occurrence, Figure 6.98.
Figure 6.98: Example, Resources Tab
400 3BUF001094-600 B
Messages
This tab displays the following message data for the selected task: Message Type,
Message and Local Time. The rows are sorted by Local Time, Figure 6.99.
When the PDL type is specified as Produce IT Batch, the time is displayed in UTC
time rather than local time.
Figure 6.99: Example, Messages Tab
History
The History tab displays Log Name, Start Time, End Time, Phase and Occurrence.
The rows are sorted by Log Name then by Start Time, Figure 6.100. Clicking the
Trend button to launch the Trend Display view of the selected log. Results can also
be dragged from this tab to the Trend display.
Figure 6.100: Example, History Tab
3BUF001094-600 B 401
The History association tables track the start and end times for which history values
were collected for a particular object. The PDL tables do NOT store the actual history
values, just the initial and final times of the collection period.
History Log associations can be retrieved at two levels — owner and individual task
level. Each history association record has a taskid for the level at which the history
log was started. Because the history log may span multiple tasks within a level of the
hierarchy, each history association record also has an “owner” task.
For example, consider a Batch application where history collection began during
Batch 123. Batch 123 had four Phases through which the history collection spanned.
Batch 123 is the owner for each of the four phases. When a search is executed for
Batch 123, a record is displayed in the History listing. Additionally, when a search
is done for each of the four phases, a record is also displayed for each of the phases,
even though the history collection spanned across all four. The Phase value will be
displayed if the owner task is the currently displayed item.
Next-Level Listing
Usually, the last tab in the Associated Data listings contains data from the history.task
table for the next level down in the hierarchy. The actual name of the tab is based on
the level in the hierarchy for the data. For example, if the current Task Type is a Unit
in a Batch 300 system, then the tab name will be Phase List. The header for the first
column of data changes to reflect the ‘child’ level name.
If the current Task Type is the last level in the hierarchy, this tab will not be displayed.
The following data are displayed: Task Name, Start Time and End Time. The rows
are sorted by Start Time, Figure 6.101.
Figure 6.101: Example, Next Level Tab
402 3BUF001094-600 B
6 Using Desktop Trends 6.8 Batch Batch Display
6.8 Batch Batch Display

This display combines the functionality of the Trend Display with the PDL Browser.
It is used to easily navigate the PDL structure to find and display historical trends for
different batches, Figure 6.102.
Figure 6.102: Batch to Batch Display
6.8.1 Opening the Batch to Batch Display

To open this dialog, from the Windows Taskbar choose: ABB Start Menu > ABB
System 800xA > Information Mgmt>Desktop Trends> IM Batch To Batch.
3BUF001094-600 B 403
6 Using Desktop Trends 6.9 Event Browser
6.8.2 Using the Batch to Batch Display

For details regarding the operation of the PDL Browser portion of this display, refer
to PDL Browser on page 386.
For details regarding the Trend Display portion of this display, refer to Trend Display
on page 293.
6.8.3 Setting Up the Batch to Batch Display

This display has a special Options dialog which is used to adjust the layout of the
display (whether trend portion is on top or bottom), Figure 6.103. This options dialog
also provides access to the Trend Display options and PDL Browser options.
For details regarding Trend Display options, refer to Setup Dialog on page 298.
For details regarding the PDL Browser options, refer to Setting Up the PDL Browser
Interface on page 387.
Figure 6.103: Batch to Batch Options Dialog
6.9 Event Browser

The Event Browser, Figure 6.104, is used to retrieve the time stamp, source, and
message from OPC and Audit Trail message logs configured through the Information
Management - History Server function. Other message log attributes may be accessed
using other desktop tools, refer to Section 11 Reading Message Logs.
The Trend Display can also be launched from the Event Browser. This is used to
display historical process data related to a specific event.
404 3BUF001094-600 B
Figure 6.104: Event Browser
To set up and use the Event Browser, follow the instructions in:
• Opening the Event Browser on page 405.
• Setting Up the Event Browser Interface on page 406.
• Retrieving Events on page 407.
• Viewing Trend Data Related to Events on page 408.
6.9.1 Opening the Event Browser

Access to the Event Browser is through the Windows Taskbar. To launch the Event
800xA > Information Mgmt>Desktop Trends>IM Event Browser.
3BUF001094-600 B 405
6.9.2 Setting Up the Event Browser Interface

Certain event browsing parameters may be configured to suit the application through
the Event Browser Configuration dialog, Figure 6.105. Specifically, this dialog is
used to adjust the default time span, date and time formats, and the query timeout
limit. These parameters are configured in the same manner as they are for the PDL
Browser control. Local time or UTC time can also be specified. To adjust these pa-
rameters, click Options, then refer to:
• Default Time Span on page 392.
• Date and Time Format on page 392.
• Local or UTC Time on page 407.
• Number of Return Values on page 407.
Figure 6.105: Event Browser Options
Clicking Use Defaults resets all parameters to their respective default settings.
406 3BUF001094-600 B
Local or UTC Time

Click the applicable option button to use either local or Universal Time Coordinate
(UTC) time in the Event Browser. UTC time (Greenwich Mean Time) is not affected
by the time zone, nor daylight savings time. This gives consistency throughout all
external changes such as Daylight Savings Time and any system resets that affect the
local time.
Number of Return Values

When set to ‘0’ all values are returned, can also be set to any of the messages to be
returned.
6.9.3 Retrieving Events

Specify the Log Name. The Time Span is optional. Click Execute to run the query.
The two fields below the time span specification indicate whether local or UTC time
is being used (left), and how many records have been returned (right).
Log Name
This pull-down list contains all message logs configured on the currently connected
server (Refer to Connecting to the Data Server on page 286).
Time Span
These fields are used to specify the time range for retrieval of message log entries.
Default Start and End times are automatically set according to the default time span
specified in the Event Browser Configuration dialog.
The time controls are Microsoft's DateTime Picker controls. Selecting the date drop-
down list displays a calendar for selecting days, months, and years. To modify a time
value, place the cursor in the portion to be changed and enter the new value, or click
on the up/down arrows to change the selected value. The Start Time must be set to a
value earlier in time to the End Time.
The check boxes in front of the time controls are used to select whether or not to use
the corresponding time as query criteria.
3BUF001094-600 B 407
6 Using Desktop Trends 6.10 SQL Browser
6.9.4 Viewing Trend Data Related to Events

View historical process data related to one or more (up to 8) events by dragging the
events from the Event Browser to the Trend Display.
The event’s source will be used for the tag name. Multiple events from the same
source may be selected as well as events from different sources. One trace will be
drawn for each source. The time scope for a source’s trace will be determined as
follows:
• If a single event is selected from a given source, the time scope will be 1/2 hour
before and 1/2 hour after the selected event’s time stamp.
• If more than one event is selected from a given source, the time scope will span
the earliest and latest time stamps.
6.10 SQL Browser

This tool is used to run ad-hoc SQL queries, Figure 6.106. A query can be saved once
it is run. The query can then reopened for viewing at some time in the future or delete.
To query for historical data, drag tag names, start times, and end times returned by
the query to a Desktop Trend to display the data graphically.
408 3BUF001094-600 B
Figure 6.106: SQL Browser
To set up and use the SQL Browser, follow the instructions in:
• Opening the SQL Browser on page 409.
• Setting Up the SQL Browser Interface on page 410.
• Using the SQL Browser on page 411.
6.10.1 Opening the SQL Browser

Access to the SQL Browser is through the Windows Taskbar. To launch the SQL
800xA > Information Mgmt>Desktop Trends>IM Sql Browser.
3BUF001094-600 B 409
6.10.2 Setting Up the SQL Browser Interface

Certain parameters for this browser may be configured to suit the application. This
is done through the SQL Browser Configuration dialog, Figure 6.107. Specifically,
this dialog is used to specify different colors for tag and time columns in the query
results pane, whether or not to show grid lines, the data provider name, and the query
timeout limit. To adjust these parameters, click Options, then refer to:
• Show Grid Lines in Results List on page 410.
• Column Colors on page 411.
Figure 6.107: SQL Browser Configuration
Show Grid Lines in Results List

This is used to choose whether or not to show grid lines to separate the records returned
for the query, Figure 6.108.
410 3BUF001094-600 B
Grid No Grid
Figure 6.108: Results With and Without Grid Lines
Column Colors
Add column colors to make them more distinguishable when configuring columns
for dragging tags and time stamps to the Trend Display, for the tag, start time, and
end time. Use the color boxes in the Display section of the SQL Browser Configuration
dialog. White text indicates which box is currently selected. For example, in Figure
6.107, the box for Tag Column Color is currently selected. Double-clicking a color
box displays the standard Windows color chooser dialog.
6.10.3 Using the SQL Browser

For instructions on using the SQL Browser, refer to:
• Specifying and Executing Ad-hoc SQL Queries on page 411.
• Managing Queries on page 412. This includes:
– Saving a Query on page 413.
– Opening a Saved Query on page 413.
– Deleting a Saved Query on page 414.
6.10.4 Specifying and Executing Ad-hoc SQL Queries

Enter the query in the SQL Statement window. An example query is shown in Figure
6.109.
Figure 6.109: SQL Query Dialog
3BUF001094-600 B 411
An example query result is shown in Figure 6.110.
Figure 6.110: Example Query Result
For complex queries, the Timeout interval may need to be increased. Click the
Options button to display the SQL Browser Configuration dialog. For details refer
to Query Timeout on page 394.
Windows and HP-UX Data Provider Considerations

SQL queries created in this browser are processed by the ADSdpDYN data provider
when directed to HP-UX platforms, and the ADO data provider on Windows platforms.
SQL queries to the ADO data provider cannot be used to access certain OCS objects
from earlier platforms. This includes basic objects such as AI, AO, DI, and DO, TCL
objects, and user objects built with the AdvaBuild Object Type Builder. Nor can
SQLPlus be used to access these objects. To access such objects, use an alternative
method such as the Process Values dialogs in DataDirect.
SQL access to numeric log data and OPC objects is supported when the ODA
Server software is installed.
6.10.5 Managing Queries

The browser is used to save query results (Query>Save Query), refer to Saving a
Query on page 413. To open a saved query (Open Query), refer to Opening a Saved
Query on page 413; or delete a saved query (Delete Saved Queries...), refer to
Deleting a Saved Query on page 414. These functions are available through the context
menu.
When any one of the Query functions (Save, Open, or Delete) is invoked, a dialog
such as the one shown in Figure 6.111 is displayed. The title bar indicates the selected
function (Save, Open, or Delete). For example, in Figure 6.111 the selected function
412 3BUF001094-600 B
is Open a Query. The two large buttons in the upper right part of the dialog are used
to toggle between the List View (left button) and Detail View (right button). An ex-
ample of a detail view is shown in Figure 6.112.
Figure 6.111: Dialog For Managing Queries
Saving a Query
To save a query:
1. Specify and execute the query as described in Specifying and Executing Ad-hoc
SQL Queries on page 411.
2. Right-click inside the query result pane and choose Query>Save from the context
menu.
3. Enter a name to identify the query then click OK.
Opening a Saved Query

To open a saved query:
1. Right-click inside the query result pane and choose Query>Open from the context
menu.
2. Select a query from the list, then click OK.
3BUF001094-600 B 413
Figure 6.112: Example, Detail View
Deleting a Saved Query

To delete a saved query:
1. Right-click inside the query result pane and choose Query>Delete Saved Queries.
This displays the query list with check boxes, Figure 6.113.
Figure 6.113: Delete Query View
2. Check one or more queries to delete then click OK (or Apply).
6.10.6 Dragging Tag Names and Time Stamps to the Desktop Trend Dis-
play
For a historical data query, drag the tag names and time stamps returned by the query
to a Desktop Trend display to set up a trend for viewing. One useful application for
this is to query for log names from the numericlog table, and then select up to eight
logs to display on the trend display.
To do this, specify which columns from the query result will be used for tag name,
trend start time, and trend end time.
414 3BUF001094-600 B
If a start or end time is not specified, the trend display’s default scope will be used.
The basic procedure is:

1. Select the columns. There are two methods for making this specification:
• Using the Configure Columns for Drag Dialog on page 415.
• Select Columns By Clicking on page 415.
2. Select up to eight log names from the specified logname column. If more than
eight is selected, then the first seven names plus the last name is returned.
3. Drag the columns to the trend display.
Using the Configure Columns for Drag Dialog

This dialog is available through the SQL Browser context menu. Right-click in the
browser and choose Configure Columns for Drag. Configure Columns for Drag
provides three pull-down lists for specifying the column to use as tag name, start
time, and end time. For example in Figure 6.114, the LogName column has been
selected for dragging as the tag name to the Desktop Trend display, and LocalTimeS-
tamp is being selected for dragging as the Start Timestamp.
Figure 6.114: Configure Columns for Dragging
Select Columns By Clicking

As an alternative, select a column in the query result, and then use the context menu
as shown in Figure 6.115.
3BUF001094-600 B 415
6 Using Desktop Trends 6.11 OPC Browser
Figure 6.115: Clicking Inside a Column
When right-clicking on a column in the query result, the context menu shows the
column name, for example, in Figure 6.115 the LocalTimeStamp column is selected.
The context menu can then be used to specify that column as the tag name, start
timestamp, or end timestamp for dragging.
6.11 OPC Browser

The trend display and ticker provide an OPC browser to help find OPC objects on
the connected OPC DA or OPC HDA server, Figure 6.29. Operating procedures are
basically the same whether it is used with the Trend display or Ticker. Refer to Section
9 Tag Management.
416 3BUF001094-600 B
7 Creating Reports 7.1 Report Building Applications
7 Creating Reports
Reports can be created either with DataDirect, or with various third party report
building applications such as Crystal Reports. These reports can then be scheduled
and run using the Application Scheduler and Report action plug-in.
The Report action is used to direct the report to various output destinations including
printers, e-mail, files such as PDF, html, Excel, and report logs configured with the
Information Management History Server function. completed report files may also
be attached to Completed Report objects in the 800xA System aspect directory. This
can be used to browse for completed report files through the Plant Explorer, and to
apply version control and electronic signatures to report files.
When a report is output to a Completed Report object or report log, the report can
then be archived to a removable media for permanent storage.
Web access can also be configured for reports so a browser can be used to open and
view the reports.
This section describes any set-up that may be required for reports to access data in
the 800xA System, and provides instructions for scheduling, running, and managing
reports. Configuring report logs and archiving reports (either through report logs or
Completed Report objects) is an Information Management configuration activity.
7.1 Report Building Applications

The following report builder options are supported:
• DataDirect - DataDirect is an add-in program for Microsoft Excel. DataDirect
is used to integrate into a Microsoft Excel spreadsheet real-time and historical
data from the 800xA System and other SQL data sources.
• Crystal Reports - This is a third-party report builder package which can access
historical and real-time data from the 800xA System through Open Data Access
(ODA).
3BUF001094-600 B 417
7 Creating Reports 7.2 Implementing Reports
• Microsoft Excel (without DataDirect Add-in) - can access historical and real-
time data from the 800xA System through Open Data Access (requires MS
Query).
• Generic Executable - This refers to any report file that is not Microsoft Excel
or Crystal Reports, for example, VBScript.
7.2 Implementing Reports

The architecture for reporting in the 800xA System is illustrated in Figure 7.1. Crystal
reports and Microsoft Excel (without DataDirect add-ins) require the Open Data Access
option to access process and historical data. Other third party applications access data
in the 800xA System through Open Data Access (ODA) also.
Reports are created as templates which may be stored as Windows files (.xls for Excel,
or .rpt for Crystal Reports), or as a file attached to a File Viewer aspect. Reports may
be configured to access real-time data, batch data, history data, and history events.
Reports are scheduled through the Application Scheduler. The scheduling instructions
are specified in a Job Description object which is created in the Scheduling structure.
This triggers a Report Action which specifies how the report will be executed. The
Report Action identifies the report template, specifies one or more output destinations,
and is used to pass in parameters to the report at execution time. The Report Action
is added as an aspect to the Job Description object.
Report building may be performed locally on the node where the scheduling server
runs, or on a remote computer client which does not have 800xA System software
installed. If reports are built on a remote computer, a copy of the report template must
be placed on the Information Management server where the scheduling server runs.
The report building package must also be installed on the Information Management
server where the scheduling server runs.
Most DataDirect add-in tools access data in the 800xA System without requiring any
set-up other than the standard post-installation set-up for Information Management.
418 3BUF001094-600 B
Schedule
Triggers
Report Action
Completed
Report
Executes
Output Options:
Aspect System
(File Viewer Aspect) Report Application Completed Report Object
Report Report Log
OR Template DataDirect
Microsoft Excel Printer
Crystal Reports E-mail
Windows File System Windows File
Generic
Data Sources:
Real-time
Batch
History
History Events
Figure 7.1: Report Services Architecture
Access to process and historical data from earlier Information Manager and Enterprise
Historian systems requires the applicable data providers to be started and selected in
DataDirect. This is described in Setup on page 249.
7.2.1 Example Reports

The Scheduler Installation includes three sets of example reports. There are three
example Batch reports, eight Information Management reports, and five other miscel-
laneous reports. These reports are intended as examples only. They can be modified
or used for reference. Be sure to copy and rename a report template before modifying
it. The templates for Batch and Information Management reports are attached to file
3BUF001094-600 B 419
viewer aspects on objects located under the Reports branch in the Scheduling structure.
The other report files are stored as Windows files.
For further information on these example reports, refer to:
• Example Batch Reports on page 420.
• Example Information Management Reports on page 422.
• Example Miscellaneous Reports on page 425.
Example Batch Reports

The example Batch reports are described in Table 7.1. The parameters for these reports,
which apply to both the Crystal reports and Excel reports, are described in Table 7.2.
Table 7.1: Example Batch Reports
Report (Job Description) Name Requires

Batch Report Crystal Crystal Reports
Batch Report Excel Raw Excel 2007
Batch Report Excel Excel 2007
Table 7.2: Parameters for Example Batch Reports
Parameters Description Required/Optional

PlantName Name of the Mill or Plant Required
BatchID Single Batch ID for which the report will return production Required
data. This will be populated by 800xA Batch Management
BMA Job at runtime. It also can be set manually in order
to run report against a desired Batch ID.
CampaignID Campaign ID as entered when Batch was scheduled in Not Used
800xA Batch Management.
LotID Lot ID as entered when Batch was scheduled in 800xA Not Used
Batch Management.
ProcedurePath The unique procedure identifier of the BMA Job Scheduler Not Used
Procedure block in 800xA Batch Management.
420 3BUF001094-600 B
Table 7.2: Parameters for Example Batch Reports

(Continued)
Parameters Description Required/Optional

LogicalNameList Comma separate list of Logical Names for the Batch Optional
Trends report. Do not include spaces before or after the
comma(s). For example: LN1, LN2, LN3
Intervals Interval between samples for the Batch Trends report. Optional
Defaults to 10 seconds.
The arguments list as described in the Job Log is not necessarily sent to the report.
It is the list as defined by the Schedule Definition Aspect\Job Arguments tab, or
explicitly passed in to the job by Batch Management. If an Argument is not includ-
ed in the Action Aspect Report Parameters definition then it is not sent to the report
but it is listed in the Job Log.
3BUF001094-600 B 421
Example Information Management Reports

The example Information Management Reports are described in Table 7.3.
Table 7.3: Information Management Reports
Name Description Parameters1

Hourly Log 1 hour log of 60 x 1 • Tag01 - Tag20 - List of tag names.
minute values
• Tag01Algorithm - Tag20Algorithm - list of algorithms to
be used for interpolation. Defaults to TimeAverage.
• Start - Time of first value to be displayed. Can be any
valid Excel time format, for example: 8:30:00.
• DescriptionAtom - Tag atom of the description, for
example: Description.
• EUAtom - Tag atom of the engineering units, for example:
Unit.
Note: if Start = 23:30:15 and the report is run on 2003/10/22,
the values will start at 2003/10/21 23:30:15 and extend to
2003/10/22 00:29:15. For times < 23:00:00 the report retrieves
data for the current day.
Shift Log 8 hour log of 32 x 15 • Tag01 - Tag20 - List of tag names.
minute values
Unit.
422 3BUF001094-600 B

(Continued)

Daily Log 1 day log of 24 x 1 • Tag01 - Tag20 - List of tag names.
hour values
Unit.
Monthly 31 day log of 31 x 1 • Tag01 - Tag20 - List of tag names.
Log day values
Unit.
Note: if the report is run on 2003/10/22, the values will start
at 2003/09/01 00:00:00 and extend to 2003/10/01 00:00:00.
The report always starts on the first day of the month before
the current day.
3BUF001094-600 B 423

(Continued)

Trip Log 31 values, 20 before • Tag01 - Tag20 - List of tag names.
the trip time, 10 after
the trip time and 1 at
the trip time.
• TripTime - Trip time. Can be any valid Excel time format.
eg. 8:30:00.
Unit.
Snapshot-Historical Single values for 20 • Tag01 - Tag20 - List of tag names.
tags at the specified
• ReportTime - Date and time of values. Can be any valid
time
Excel date/time format. eg. 10/28/2003 12:00:00 PM.
Unit.
Snapshot-Current Current values for 20 • Tag01 - Tag20 - List of tag names.
tags
Unit.
• ValueAtom - Tag atom of value.
• AlarmAtom - Tag atom of alarm state.
• QualityAtom - Tag atom of quality state.
Alarm and List of alarms and • AreaObject – Alarm and/or Event object.
Event events between two
• End Time - Report end date and time, defaults to current
times for a particular
time.
alarm and event
object • Start Time - Report start date and time, defaults to
1 day prior to the end time.
1. All parameters are optional
424 3BUF001094-600 B
Example Miscellaneous Reports

Additional example report files are provided to demonstrate the capabilities of the
Report Action plug-in. The files are located in:
C:\Program Files\ABB Industrial IT\Inform IT\Scheduler\samples\reports
There are two Excel Reports (20MinuteRaw.xls and 20MinuteSnap.xls). These reports
use the Open Data Access (ODA) connection to access history data. These reports
show how to use the retrieval type, and provide a simple example on how to work
with time. Edit queries by selecting the data area, and then right clicking and choosing
Edit Queries. This starts the wizard used to change tag references.
Also, there are six batch reports created with Crystal Reports:
Batch-MM-Report-detailed.rpt
BatchReport-detailed -001.rpt
BatchReport-detailed.rpt
Report1Campaigns.rpt
Report1CampaignsAndBatches.rpt
Report1CampaignsAndBatches-SelectACampaign.rpt
Some example *.rtf output files are available in the output subdirectory
Additional Crystal Report subreports are provided in: C:\Program Files\ABB Indus-
trial IT\Inform IT\History\ApiDevKit. The reports and the parameters expected to be
passed to the Scheduler are:
AuditMsgs.rpt (StartTime, EndTime)
GenericDa.rpt (ObjectName, PropertyName)
mm_auditEvent.rpt (StartTime, EndTime)
MMFormEvent.rpt (Batchid)
MsgsTypeandTime.rpt (StartTime, EndTime, MessageType) (MessageType =
Category)
Basic Steps for Building and Executing a Report

Follow these basic steps to build and run a report. Details are provided in referenced
sections:
1. Create the report using a report building package. If DataDirect is used, all data
access connections should already be established, and the report should access
the requested data transparently. Adjustments may be required to the connected
3BUF001094-600 B 425
data providers. Detailed instructions for using DataDirect are provided in Section
5 DataDirect Inform IT.
If Crystal Reports is used or another third-party report building application,
connect the report to the 800xA data source through Open Data Access. An ex-
ample of this is provided in Creating a Report with Crystal Reports - Example
on page 469.
2. Use the Application Scheduler to create the Job Description object. Then create
an Action aspect on that object. This is demonstrated in Creating Objects and
Aspects in the Scheduling Structure on page 428.
3. Configure the Action aspect to specify how the report will be executed. This is
described in Defining the Report Action on page 429 and includes:
a. Selecting the Report Action aspect.
b. Selecting the report template.
c. Specifying one or more output destinations for the report result.
d. Specifying parameters to pass into the report when it executes.
Login parameters must be specified under the following circumstances:
• If the Crystal Report will include queries for Oracle-based data (message logs
and/or PDL data), then define the DataServerLogin parameter in the report
schedule to connect the report to the ODBC driver for Oracle data.
• For DataDirect, define the DataServerLogin parameter in the Report action
to connect the report to the applicable data server:
4. Configure the Job Description object to specify the scheduling instructions for
the report. This is described in Defining the Schedule on page 458.
5. Before running a report, read the guidelines in Before Running a Report on page
460.
426 3BUF001094-600 B
If reports are to be scheduled and executed using the Application Scheduler, the
report file MUST be saved in Manual calculation mode; otherwise, they will run
twice when run through the Scheduler.
The Excel calculation mode is set to the mode of the first file opened (or calculated,
if no previously saved file has been opened). All workbooks that are opened in
that Excel session will be set to that same calculation mode, despite any previous
settings. The calculation mode is always Automatic when Excel is first opened.
To check the mode and change it if necessary, refer to Putting the Workbook in
Manual Mode on page 70.
Reports that use Visual Basic macros

If a report is scheduled that uses Visual Basic macros in a Microsoft Excel spreadsheet,
enable macros in Excel before the report runs. If this is not done, the report will hang.
To enable macros in Excel, refer to Enabling Macros on page 52.
Troubleshooting
For trouble with a report, refer to Troubleshooting Reports on page 468.
Viewing Reports Over the Web

To set up viewing of reports over the Web, create a virtual Web directory where the
reports can be stored and viewed over the web. Set up the output definition for the
Report action to send finished reports to that directory. Instructions are provided in
Viewing Reports Over the Web on page 461.
Managing Completed Report Objects

The Report Preferences aspect is used configure the maximum number of Completed
Report objects that the Scheduler will maintain within the Reports branch of the
Scheduling structure. It also provides options for removing Completed Report objects.
Refer to Report Preferences Aspect on page 465.
The Report Printing aspect is used to print report files attached to File Viewer aspects.
Refer to Report Printing Aspect on page 465.
3BUF001094-600 B 427
7 Creating Reports 7.3 Setting Up the Report Action and Schedul
7.3 Setting Up the Report Action and Scheduling

Definition
Reports are scheduled through the system scheduling function. The scheduling instruc-
tions are specified in a Job Description object which is created in the Scheduling
structure. This triggers a Report Action which specifies how the report will be execut-
ed. The Report Action identifies the report template, specifies one or more output
destinations, and is used to pass in parameters to the report at execution time. The
Report Action is added as an aspect to the Job Description object. This section de-
scribes how to create and configure these objects.
The Report Action of the Action Aspect can also be used to schedule a History
backup. This is done using History Database Maintenance.
1. Start with Creating Objects and Aspects in the Scheduling Structure on page 428.
2. Continue with Defining the Report Action on page 429.
3. Set up the Schedule as described in Defining the Schedule on page 458.
7.3.1 Creating Objects and Aspects in the Scheduling Structure

Add a Job Description object in the Scheduling structure:
1. In the Plant Explorer, select the Scheduling Structure.
2. Right-click on Job Descriptions and choose New Object from the context menu.
3. Add the Job object as a Job Description object. Assign the object a logical name
(for example BatchReportSchedule).
4. Click Create. This creates the new job under the Job Descriptions group, and
adds the Schedule Definition aspect to the object’s aspect list.
5. Right-click on the Job Description object (for example BatchReportSchedule)
and choose New Aspect from the context menu.
6. In the New Aspect dialog, select the Action aspect. Use the default aspect name,
or specify a new name (for example BatchReportAction).
7. Click Create to add the Action aspect to the job.
Continue with Defining the Report Action on page 429.
428 3BUF001094-600 B
7.3.2 Defining the Report Action

The Report Action specifies how the report will be executed. It specifies the report
template as well as output destinations, and is used to pass in parameters to the report.
Select the Action aspect from the object’s aspect list, Figure 7.2.
Figure 7.2: Action Aspect Configuration View
To configure the report action, use the Action aspect to perform the following:
• It is recommended that a time limit be entered, especially for large reports.
• Selecting the Report Action on page 430.
• Selecting the Report Template on page 430.
• Output Options on page 431.
3BUF001094-600 B 429
7.3.3 Selecting the Report Action

The functionality of the Action aspect is set by specifying the type of action. For re-
ports, select the Report Action from the Action pull-down list, Figure 7.3.
Figure 7.3: Selecting the Report Action Plug-in
7.3.4 Selecting the Report Template

Report templates may be stored as Windows files (for example .xls for Excel or
DataDirect, or .rpt for Crystal Reports), or as files attached to a File Viewer aspect.
When a report template is attached to a File Viewer aspect, the file can be browsed
to, opened, and managed the same as any other aspect in the aspect directory. Use
the Report Template Path section to select the report to be executed by this action.
1. Select the browsing method, click the Report Template Path button, then choose
either Windows Files or File Viewer aspects, Figure 7.5.
Click Here to Display Browser Menu
Figure 7.4: Using the Report Selection Menu
2. Use the browser dialog to find and select the report to be executed. If a File
Viewer aspect is selected, the file attached to the Work Document section is used.
430 3BUF001094-600 B
Figure 7.5: Example, Using File Viewer Aspect for Browsing Report Files
7.3.5 Output Options

The Output Options section is used to pass parameters into the report at execution
time, and specifies one or more destinations for the report result. The report can be
sent to a printer, exported to a file (or multiple files), exported to a Completed Report
object, emailed, and saved to a report log with the Information Management History
Server function. These options can be used in combination. Select the required output
options by clicking the corresponding check boxes, and then entering the required
information.
For the export, email, and save to history options:
• the output file name can be modified using parameters.
• the number of HTML files which are output can be controlled.
For details regarding each output method, refer to:
• Using Parameters to Modify an Output File Path on page 432.
• Output Options for HTML Files on page 432.
• Report Parameters on page 433.
• Export File on page 445 - Exports to Windows file or Completed Report object.
Not all export formats are available in all versions of Crystal Reports.
• Printer on page 451.
• Email on page 452.
• Save to History on page 455.
• Execute File on page 457 - Only available when the file scheduled is NOT a
Crystal Reports file or an Excel file. This option runs executable files or scripts
and cannot be used with any other output destination.
3BUF001094-600 B 431
Refer to Export Considerations on page 449 for additional information on using

each output method.
Using Parameters to Modify an Output File Path

If running scheduled reports that use DataDirect remote functionality on a node
that is not an IM server, the data server login parameter will need to be added and
configured.
Report parameters can be dynamically substituted in output file paths for reports ex-
ported to a directory, saved into a report log or sent through e-mail. The field to be
replaced is specified within <> brackets, for example: abc<Parm1>def. Parm1 is a
report parameter name such as batchid or unitid. The bracketed parameter name is
replaced with the value when the output file path is created.
For example, if the output file name is specified as abc<Parm1>def, and the value
of Parm1 is BatchX, the resulting output file name will be abcBatchXdef.
The following keywords (intrinsic parameters) may be used within the output file
path definition: TimeStamp, LongDate, LongTime, ShortDate, ShortTime, And JobID.
JobID is a unique identifier based on the running job name and the action that is
running. These parameters are used to insert date and time, and job ID information
into the report as a string without having to use a function that is re-calculated when
the report is opened.
For further information on parameters, refer to Report Parameters on page 433.
Output Options for HTML Files

For Crystal Reports:
When a Crystal Report is output as an HTML file, then specify whether the HTML
file is output as several pages which contain a page navigator at the bottom, or all on
one page without the navigator.
The default is for multiple pages. To switch the output to one page, use the Report
Parameters section to set the following two parameters to false:
• HTMLEnableSeparatedPages = False
• HTMLHasPageNavigator = False
For further information on parameters, refer to Report Parameters on page 433.
For DataDirect and Microsoft Excel
432 3BUF001094-600 B
When a DataDirect or Microsoft Excel report is output as an HTML file, by default

all supporting files such as bullets, background textures, and graphics are stored in a
separate subfolder. To get all supporting files to be stored in the same folder with the
report, do the following in Microsoft Excel:
1. On the Excel menu bar choose, Tools > Options, and then click the General
tab.
2. Click Web Options, and then click the Files tab.
3. Clear the Organize supporting files in a folder check box.
To output Excel files that contain multiple files to a Report log in HTML format,
disable the Organize supporting files in a folder option in the same folder option
in Excel. If this option is not disabled, the graphics will be lost. Also, archives
having this log will fail.
HTML format being saved in the Aspect Directory is intended for a single file
format to display data. Do not use this location to store multi-file HTML reports
that reference graphics or other information. Store to disk instead.
An Excel report cannot be output in HTML format to the aspect directory (object
path).
7.3.6 Report Parameters

The Report Parameters section is used to specify parameters to send to the report
before execution. The steps below describe the general procedure for adding, modi-
fying, and removing parameters. For guidelines on more specific applications related
to parameters, see the references at the end of these steps.
To specify a parameter:
1. Click the Report Parameters check box to activate the report parameters func-
tion, Figure 7.6.
Figure 7.6: Specifying the logname Parameter
2. Click Edit Parameter List. This displays the Report Parameters list, Figure 7.7.
3BUF001094-600 B 433
Figure 7.7: Report Parameter List
3. To add a parameter to the list, click Add. This displays the Configure a Report
Parameter dialog, Figure 7.8.
4. Enter the parameter name and value as shown in Figure 7.8, then click OK. This
adds the parameter to the parameter list, Figure 7.9.
Figure 7.8: Configure a Report Parameter
434 3BUF001094-600 B
Figure 7.9: Parameter Added to the List
5. Repeat steps 3 and 4 to define additional parameters as required.

6. To modify an existing parameter, select the parameter from the list, then click
Modify. This displays the Configure a Report Parameter dialog as shown in
Figure 7.8. Change the name or value or both. To remove a parameter from the
list, select the parameter, then click Remove.
7. When finished adding parameters, click Close. This adds all listed parameters
to the parameter list in the Report Action dialog, Figure 7.10.
Figure 7.10: Parameter List in the Report Action
• For Crystal Reports, refer to:

– Parameters for Crystal Reports on page 437.
• For DataDirect, refer to:
– Passing Parameters to an Excel Spreadsheet on page 444.
3BUF001094-600 B 435
• Parameter Substitution in an Output File Path on page 436.

• Substituting Argument Values for Parameter Values on page 436.
• Report Parameters required for Batch reports, refer to:
– Understanding the Predefined Batch Reports Action Aspect in Scheduler
on page 501
Parameter Substitution in an Output File Path

Report parameters can be dynamically substituted in output file paths for reports ex-
ported to a directory, saved into a report log or sent through e-mail. Refer to Using
Parameters to Modify an Output File Path on page 432.
Substituting Argument Values for Parameter Values

Use arguments to specify a parameter value. The arguments may be defined on the
Arguments tab of the Scheduling Definition aspect for the job (Arguments on page
495). Arguments may also be created dynamically by external applications such as
batch management applications. This lets the batch application dynamically specify
certain parameters that change from one batch to the next. The arguments that Batch
Management writes are:
CampaignID
BatchID
LotID
ProcedurePath
The following keywords (intrinsic parameters) may be used as arguments:
TimeStamp, LongDate, LongTime, ShortDate, ShortTime, and JobID. JobID is a
unique identifier based on the running job name and the action that is running. These
parameters are used to insert date and time, and job ID information into the report as
a string without having to use a function that is re-calculated when the report is opened.
To substitute an argument for a parameter value, enter the argument name in angle
brackets(< >), Figure 7.8. The argument value may be embedded in other text, Figure
7.11.
436 3BUF001094-600 B
Figure 7.11: Substituting Arguments for Parameter Values (Embedded)
Parameters for Crystal Reports

To pass a parameter to a Crystal Reports file, create a corresponding parameter field
directly in the report file. This is described in the Crystal Reports User’s Guide, and
is demonstrated in Creating a Report with Crystal Reports - Example on page 469.
Defining the DataServerLogin Parameter in Crystal Reports. The DataServerLogin

parameters are defined or used in the Report Action aspect only when the following
two conditions are true:
• The report will be run on a node other than the local node (a node that is not an
Information Management node) or if a report on Node 1 needs the data fetched
from Node 2 (or vice versa), where either Node 1 or Node 2 is an Information
Management node.
• The Crystal Report will include queries for Oracle-based data (message logs
and/or PDL data).
This requires setting up a connection to a remote Oracle Server. Refer to Establishing
a Connection to a Remote Oracle Server on page 438.
Provide the following information in the Parameters dialog box of the Report Action
aspect.
DataServerLogin = ServerName,DatabaseName,UserID,Password
Where:
ServerName = DataSource name in the System DSN tab of the ODBC Data Source
Administrator dialog box that is configured to connect to the remote server. Refer to
Establishing a Connection to a Remote Oracle Server on page 438for more information.
DatabaseName = ADVA
3BUF001094-600 B 437
UserID = history
Password = <enter the history account password>
The password is provided during the IM Post Installation or the Database Migration.
For example:
DataServerLogin = RemoteSrv, ADVA, history, history
Establishing a Connection to a Remote Oracle Server. For the reports running

on non-Information Management nodes, the Oracle client software must be installed
and the Local Net Service name configuration must be performed to be able to connect
to the Oracle Server on another node. Oracle client software is available as part of
the Information Management, Oracle Installer package. Refer to System 800xA
Manual Installation (3BSE034678*) to install the Oracle software.
Perform the following procedure after the Oracle software is installed on the non-In-
formation Management node in order to configure a connection to the remote Oracle
Server.
1. Open the Oracle Net Configuration Assistant from the Windows tiles All Apps
by name screen.
Figure 7.12: Net Configuration Assistant selection
438 3BUF001094-600 B
2. Look for Oracle - OraDb12c_ADVA or Oracle - OraDb12c_ADVAC

If more than one option is displayed; open its file location and launch the Oracle
client version as indicated in the screen below.
Figure 7.13: Net Configuration Assistant
3. Select the Local Net Service Name configuration option in the Oracle Net
Configuration Assistant Welcome dialog box and click Next.
4. Select the Add option in the Oracle Net Configuration Assistant: Net Service
Name Configuration dialog box and click Next.
5. Enter ADVA in the Service Name field in the Oracle Net Configuration Assistant:
Net Service Name Configuration, Service Name dialog box (Figure 7.14) and
click Next.
3BUF001094-600 B 439
Figure 7.14: Entering the Service Name
6. Select TCP in the Oracle Net Configuration Assistant: Net Service Name Con-
figuration, Select Protocols dialog box and click Next.
7. Enter the IP address of the remote Oracle Server for the host name field option
in the Oracle Net Configuration Assistant: Net Service Name Configuration,
TCP/IP Protocol dialog box (Figure 7.15).
8. Select the Use the standard port number of 1521 option (Figure 7.15) and click
Next.
440 3BUF001094-600 B
Figure 7.15: Entering the IP Address of the Oracle Server
9. Select the Yes, Perform a test option in the Oracle Net Configuration Assistant:
Net Service Name Configuration, Text dialog box and click Next.
10. The test will fail with an invalid username and password (Figure 7.16). Click
Change Login to launch the Change Login dialog box.
3BUF001094-600 B 441
Figure 7.16: Login Test Failure
11. Enter history as the user name.

12. Enter the password, and click OK to return to the Oracle Net Configuration As-
sistant: Net Service Name Configuration, Text dialog box.
13. The test should succeed with the new user name and password information.
14. Enter a name for the remote Oracle Server (for instance RemoteSrv) in the Oracle
Net Configuration Assistant: Net Service Name Configuration, Net Service Name
dialog box and click Next.
15. Select the No option in the Oracle Net Configuration Assistant: Net Service
Name Configuration, Another Net Service Name dialog box and click Next.
16. Click Next when the Oracle Net Configuration Assistant: Net Service Name
Configuration Done dialog box appears and then Finish when the Oracle Net
Configuration Assistant: Welcome dialog box appears.
17. ODBC Data Source Configuration: Enter the windows tile screen and type set
up odbc. Select the Set up ODBC data sources (32-bit). Figure 7.17
442 3BUF001094-600 B
Figure 7.17: set up odbs Search
18. Click Add to launch the Create a New Data Source dialog box.
19. Select the Oracle in OraDb12c_ADVA driver (Figure 7.18) and click Finish.
Figure 7.18: Adding the Oracle in OraDb12c_ADVADriver
20. The Oracle ODBC Driver Configuration dialog box (Figure 7.19) appears.
3BUF001094-600 B 443
Figure 7.19: Configuring the Oracle in OraDb11g_Adva Driver
21. Enter the date source name in the Data Source Name field (for example Ora-
cleSrvConnection).
22. Select the TNS Service Name from TNS Service Name drop-down list.
The TNS Service Name drop-down list shows the Net Service name configured
earlier.
23. Click Test Connection to launch the Oracle ODBC Driver Connect dialog box.
This will verify the connection to the remote Oracle Server.
24. Enter history as the user name.
25. Enter the user defined password and click OK.
26. If the connection is successful, Connection successful appears in the Testing
Connection dialog box. Click OK in the dialog boxes until they are all closed.
Passing Parameters to an Excel Spreadsheet

When passing a parameter to a spreadsheet in Excel or DataDirect, use the cell name
as the parameter name. For example, in Figure 7.20 cell A1 corresponds to a param-
eter named batch22.
444 3BUF001094-600 B
Figure 7.20: Specifying the logname Parameter
As an option, rename the cell in the spreadsheet to give it a more meaningful name.
For example, in Figure 7.21, cell C2 is renamed as batchid.
In the Batch reports using DataDirect for data retrieval, the following parameter
should be defined in the Scheduler Action aspect:
DataServerLogin = computer name, user name, password
This parameter is the login information for connecting the DataDirect report to the
applicable data server. The user name and the password are the ones that are defined
for Display Services (or DataDirect) during IM Post Installation.
Renaming Cell C2
with the batchid
Parameter name
Figure 7.21: Renaming a Cell as batchid
7.3.7 Export File

The Export Paths option, Figure 7.22, is used to export the report output to one or
more files of a specified type (Excel, Crystal Report, HTML, PDF, etc...). The com-
pleted report files may be attached to Completed Report objects in the Report branch
of the Scheduling structure, be stored as Windows files, or both. Refer to:
• Export to a Completed Report Object on page 446.
3BUF001094-600 B 445
• Export to Windows File on page 447.
Figure 7.22: Exporting Report Files
Export to a Completed Report Object

The report output can be exported as a file attached to a Completed Report object.
Use this to browse for completed report files through the Plant Explorer, and to apply
version control and electronic signatures to report files. When a report is exported to
a Completed Report object, a new Completed Report object is created under the Re-
ports branch in the Scheduling structure. A File Viewer aspect is automatically created
for that object, and the report file is attached to that aspect.
The maximum number of Completed Report objects to maintain in a folder can be
set. This is described in Report Preferences Aspect on page 465. In addition, the public
document can be selected from any File Viewer aspect on the Completed Report object,
and send it to a printer along with electronic signature information for the File
Viewer aspect. This is described in Report Printing Aspect on page 465.
To export the report to a Completed Report object:
1. Check the Export Paths check box.
2. Click Add Object Path. This displays the Configure Export to a Completed
Report Object dialog, Figure 7.23.
The format defaults to the format of the selected report template (Selecting the
Report Template on page 430). The object path defaults to an object which is
named after the selected report template with the word Folder and a time stamp
appended. This object will be created in the Reports branch of the Scheduling
structure if it does not already exist. The file name defaults to the name of the
selected report template.
The defaults may used as is, or change one or more definitions as required. For
guidelines on formats, refer to Table 7.5 and the note that follows the table.
446 3BUF001094-600 B
Figure 7.23: Exporting to a Completed Report Object
3. Click OK when done. The specification is then entered in the Export Paths list,
Figure 7.24.
If an export file specification needs to be removed from the Export Path list, select
the specification, then click Remove.
To modify a specification, double-click on it. This opens the Configure Export
to a Completed Report Object dialog.
Figure 7.24: Object and File Names Combined in File Name Field
Export to Windows File

1. Check the Export Paths check box.
2. Click Add File Path. This displays the dialog for specifying the file format,
name, and path to the Windows folder where the file will be stored, Figure 7.4.
The format defaults to the format of the selected report template (Selecting the
Report Template on page 430). The path defaults to the root directory and the
name of the selected report template.
3BUF001094-600 B 447
These defaults may be used as is, or changed as required. For guidelines on for-
mats, refer to Table 7.5 and the note that follows the table.
Table 7.4: Exporting to a Windows File
3. To change the path, click the Path button to display a Windows browser, then
browse to the folder where the file is to be stored. Click OK in the browser once
the selection is made.
4. To change the Max Files Per File Type, Per Directory value, type in the desired
value. This value must be configured on the Information Management node where
the reports are generated (the node where the Application Scheduler is running).
Changing the Max Files Per File Type parameter to a smaller number will result
in the scheduler removing any files in excess of the new configuration the next
time a file is stored. Please save any files you may wish to preserve before reducing
the maximum number of files stored.
5. Click OK when finished with the export specification. The specification is then
entered in the Export Paths list, Figure 7.25.
If an export file specification needs to be removed from the Export Path list, select
the specification, then click Remove. To modify a specification, double-click
on it. This opens the Configure Export to a File dialog.
448 3BUF001094-600 B
Figure 7.25: Windows Path Specification Entered
Table 7.5: Supported Formats
Builder Supported Formats

Crystal Reports Crystal Report (.rpt), Excel (.xls), HTML (.html), Rich Text
(.rtf), Acrobat PDF (.pdf), XML (.xml), Word (.doc), None,
As is
Microsoft Excel Excel (.xls, .pdf, xlsx, xlsm), HTML (.html), TrueText (.txt),
None, As is
Export Considerations
• Not all export formats are available in all versions of Crystal Reports. Refer to
the Crystal Reports documentation to see what is available. Regardless of the
version installed, be sure to install ALL dlls related to export file types.
• All exported report instances are saved. Each export file has a unique name so
that existing export files are not overwritten. This may result in a large accumu-
lation of export files. These files must be managed and periodically purged from
the export directory if necessary.
• If the file is being exported on a remote computer, network file sharing must be
used. If such files must be secured, refer to the guidelines for Securing Windows
Files on Shared Network Drives on page 511.
• Do not export XLS reports as File Viewer aspects. Only do so if Report Archiving
of XLS is required. Export XLS to the file system instead.
• Determine up front the output methods required for a particular report template.
The Excel template for HTML may need different formatting or layout in the
template than one used for XLS output, or output to a printer (font size, hidden
cells, multiple pages or sheets, etc).
3BUF001094-600 B 449
PDF Export Considerations

During the PDF export from the Scheduler, the report execution can hang.To
prevent this, do the following:
• For PDF export, default printers should be configured on the local machine.
For example default printer can be a valid printer or a Microsoft XPS document
writer.
• When establishing the Remote Desktop Connection for configuration clear
the Printers checkbox in the Local Devices and Resources area of the Remote
Desktop Connection dialog box as shown in Figure 7.27.
• During the PDF export of Excel sheets, the Excel divides each sheet into multiple
print areas and each VALID print area will be exported as a PDF page. If the
output data from the Excel sheets are unevenly getting split into different PDF
pages, then the Report template should be redesigned with appropriate Print area
by modifying the Page Size and Orientation, or the Page width as shown in
Figure 7.26 to get the required PDF output.
Figure 7.26: Page Layout
450 3BUF001094-600 B
Figure 7.27: Remote Destop Connection
7.3.8 Printer
The printer option provides a list of local printers available from the node where the
report will run, Figure 7.28.
Using the XPS Document printer for report printing is not supported as it results
an invisible Save As dialog and this will hang the report execution.
If it is desired to access a network printer:
• Standalone network printer: Use standard Windows procedures (Add Printer
Wizard) to add the standalone network printer. When doing so:
– Select to add the printer as a local printer and do not automatically detect.
– Choose to create a new port and select Standard TCP/IP Port.
– Enter the hostname or IP address of the printer.
3BUF001094-600 B 451
• Shared network printer that goes through a network printer server: Use
standard Windows procedures (Add Printer Wizard) to add the shared network
printer. When doing so:
– Select to add the printer as a network printer.
– Add the printer for any user account that will be used to manually print re-
ports.
– Add the printer to the service account to print reports as part of a scheduled
report.
Figure 7.28: Selecting a Printer for a Hardcopy Report
7.3.9 Email
The Email option is used to send a report through email. As an option to ending a
finished report, send the report template (the unprocessed report), or send a notice
that the report was executed.
A SMTP e-mail server must be set up for outgoing e-mail. The SMTP e-mail server
can be on any node that has access to the node where the reports will run. Contact
the network administrator to install a SMTP e-mail server. Detailed instructions are
not provided here since the installation may vary depending on the specific e-mail
server software package being used.
If the node where the e-mail server will be set up is protected by a firewall, ensure
that the firewall does not close the SMTP e-mail port (port 25 is standard).
Perform the following to send a report through e-mail:
1. Select the Email check box. This activates the Set button, Figure 7.29.
Figure 7.29: Activating the Set Button
452 3BUF001094-600 B
2. Click the Set button to launch the Email Information dialog box, Figure 7.30.
• The fields with asterisks (*) in the Email Information dialog box are manda-
tory.
• The fields with red borders in Figure 7.30 must be populated in the format
specified.
3. Enter the e-mail address of the sender account in the From: field. This field is
mandatory and must be in the format specified in the Email Information dialog
box (it must include the @ symbol).
4. Enter the e-mail addresses of the receiver accounts in the To: field. This field is
mandatory.
5. Enter the e-mail addresses of the desired accounts in the cc: and bcc: fields. These
fields are optional.
3BUF001094-600 B 453
Figure 7.30: Email Information Dialog Box
6. Enter the SMTP server IP address or SMTP server node name in the SMTP
Server: field. This field is mandatory and must be in the format shown in the
following examples:
• IP address example: 12.14.352.190
• Node name example: yoursmtpserver.yourcompany.com
7. Use the Attachment Format: drop-down list box to select the format for the
report output file. The choices for finished report files are described in Table 7.6.
To send an unprocessed report template, select as is. To send a notification
message with no attachment, select None.
454 3BUF001094-600 B
Table 7.6: Supported Attachment Formats
Builder Supported Formats

Crystal Reports Crystal Report (.rpt), Excel (.xls), HTML (.html), RichText
(.rtf), Acrobat PDF (.pdf), XML (.xml), Word (.doc), None, As
Is
Microsoft Excel Excel (.xls, .pdf, .xlsx, .xlsm), HTML (.html), TrueText (.txt),
None, As Is
When a report is eported as an HTML file, the number of files that are output can
be controlled. Refer to Output Options for HTML Files on page 432.
8. Enter the report output name in the Attachment Name: field. This is not required
to match the report name. An extension may be included; however, the extension
will not determine the file format. The format must be selected through the At-
tachment Format list. This field is disabled if None is selected for the Attachment
Format.
Report parameters can be dynamically substituted in the output file name. Refer
to Using Parameters to Modify an Output File Path on page 432.
9. Enter a subject and message in the fields for them if necessary.
10. Click OK when finished. The To: email address will be displayed next to the
Email Set button, Figure 7.31.
Figure 7.31: Email Feedback
7.3.10 Save to History

This option is used to save the report in a report log configured through the Information
Management History Server function. The report log must already be configured
(refer to Historizing reports section in System 800xA Information Management Con-
figuration (3BUF001092*).
To use this option, click the Save To History check box. This activates both the report
log selector, and the Format selector, Figure 7.32.
3BUF001094-600 B 455
Figure 7.32: Save To History
To select the report log, click Set, then use the browser to select the report log, Figure
7.33.
Figure 7.33: Selecting the Report Log
Use the Format selector to specify the format for storing the report in the log. The
choices are the same as the export formats for each report type as described in Table
7.5, plus Without Processing which saves just the report template without data that
would be gathered by processing the report.
As an option, save the report to history under a different file name. To do this, click
in front of the format extension in the Format field (for example in Figure 7.32, click
to the left of .html), then enter the new name. This name will completely replace the
original report output file name.
456 3BUF001094-600 B
As a further option report parameters can be dynamically substituted in the output

file name. Refer to Using Parameters to Modify an Output File Path on page 432.
Reports stored in the report log can be viewed through the View Report Logs aspect
for the Report Logs container in the Node Administration structure. Instructions for
using this aspect are provided in View Report Logs Aspect on page 466.
7.3.11 Saving HTML or XML reports to History

When Crystal Reports are exported to HTML or XML, automatic changes to file
names can effect their usability in History. Perform the applicable step below to
eliminate this problem:
• For HTML - If there is more than one page in the report, force the report to be
output on one page. To do this, set the page output parameters HTMLEnableSep-
aratedPages and HTMLHasPageNavigator to False (refer to Output Options for
HTML Files on page 432).
• For XML - Do not use spaces in the file name. Spaces are automatically changed
to underscores causing problems because of names that do not match.
When a DataDirect or Microsoft Excel report is output as an HTML file, by default
all supporting files such as bullets, background textures, and graphics are stored in a
separate subfolder. This causes a problem when the html version of a report is saved
into a Report Log. To prevent this from happening, follow the procedure for
DataDirect and Microsoft Excel in Output Options for HTML Files on page 432.
7.3.12 Execute File

This option is only available when the file selected to schedule is neither a Crystal
Reports file (.rpt), nor an Excel file (.xls), Figure 7.34. In this case use this option to
run the file as an executable or script, for example a VB script.
To do this, click the Execute File check box. This option is mutually exclusive with
the other Output Options. The Execute File option cannot be used in combination
with any other output option.
3BUF001094-600 B 457
Figure 7.34: Execute File
7.3.13 Defining the Schedule

Reports whose actions are defined through Report Action aspects, are scheduled
through a Job Description object. This object is created in the Scheduling structure
as described in Creating Objects and Aspects in the Scheduling Structure on page
428.
Select the Scheduling Definition aspect for a Job description object to display its
configuration view, Figure 7.35.
458 3BUF001094-600 B
Figure 7.35: Scheduling Definition Configuration View
The Scheduler supports several scheduling methods, for example: cyclic, periodic,
weekly, and monthly as described in Section 8 Scheduling. The schedule type is
presented as a plug-in dialog on the Schedule tab. The top section of this tab has a
set of common controls which are applicable for all schedule types, Figure 7.35.
It contains a field for selecting the following:
• A Schedule pull-down list to select the type of schedule.
• The Enabled check box must be checked in order for the scheduler to use the
selected schedule type for the job.
• The Service Group selection field is used to choose which server will execute
a given job in the case where there are multiple nodes running the Application
Scheduler. The default is the primary service group which is the first service
group created, not necessarily the first one listed in the Service structure. To
avoid unexpected results, specify a server where the report will run.
• A Run Now button to manually run the job.
3BUF001094-600 B 459
7 Creating Reports 7.4 Before Running a Report
7.3.14 Define Schedule Type - Periodic Scheduling

The Periodic plug-in is displayed when Periodic Schedule is selected from the
Schedule pull-down list. Refer to Periodic Scheduling on page 486 for the default be-
havior. Figure 7.36 shows a periodic schedule to execute the report once every eight
hours, starting July 23rd at 4:00 PM (16:00), and ending August 3rd at midnight
(12:00 AM or 00:00).
Figure 7.36: Periodic Schedule Plug-in
7.4 Before Running a Report

Follow these steps BEFORE scheduling a report for automatic execution:
• Configure an appropriate Time Limit for the Report Action. Use the Report Action
aspect (Defining the Report Action on page 429).
• Outside of the scheduler, test the report by manually opening the template, exe-
cuting it to obtain data, and then exporting it to the required format to make sure
that no errors or other dialogs occur.
• Before scheduling it for automatic execution, manually test a single execution
of the report using Run Now on the scheduler to make sure no other errors occur.
• For DataDirect (Excel) reports the report template file MUST be saved in Man-
ual calculation mode. The calculation mode is set to the mode of the first Excel
file opened (or calculated, if no previously saved file has been opened). All
workbooks that are opened in that Excel session will be set to that same calcula-
tion mode, despite any previous settings. The calculation mode is always Auto-
460 3BUF001094-600 B
7 Creating Reports 7.5 Viewing Reports Over the Web
matic when Excel is first opened. To check the mode and change it if necessary,
refer to Putting the Workbook in Manual Mode on page 70.
7.5 Viewing Reports Over the Web

To set up viewing of reports over the Web, create a virtual Web directory where the
reports will be stored and set up the output definition for the Report action to send
finished reports to that directory.
7.5.1 Creating A Virtual Web Directory

To create this directory:
1. Create a new directory in Windows Explorer, for example:
C:\Reports\Web
2. Open Control Panel > Administrative Tools > Internet Information Services
(IIS) Manager
to launch the Internet Information Services (IIS) Manager.
3. Navigate to:
Sites > Default Web Site
in the left pane.

4. Right-click Default Web Site and select Add Virtual Directory from the
context menu to launch the Add Virtual Directory dialog box.
5. Specify an Alias name such as Reports.
6. Set the Physical Path to the directory created in Step 1..
7. Click OK.
8. Close the Internet Information Services (IIS) Manager.
7.5.2 Creating Report Output And Viewing It Over The Web

In the Report action, use Output Options section to:
• check Export to file.
• set the output directory to the virtual directory created in step 1 of Creating A
Virtual Web Directory, for example: C:\Reports\Web, Figure 7.37.
3BUF001094-600 B 461
7 Creating Reports 7.6 Attaching a Report Template to a File Vi
Figure 7.37: Output Definition
After the job has successfully run, open Internet Explorer and go to http://localhost/re-
ports (assuming reports is used as the alias name for the virtual directory). A link to
the report just run should be there. Click on the report link to view the report. An
example is shown in Figure 7.38.
Link
Figure 7.38: Navigating to the Report
7.6 Attaching a Report Template to a File Viewer As-

pect
The report files created as templates can be integrated into the aspect system by at-
taching the report files to File Viewer aspects. This is used to browse for report tem-
462 3BUF001094-600 B
plate files through the Plant Explorer, and also applies version control and electronic
signatures to report files.
A File Viewer aspect may be added to an existing object, or create a new object. The
following procedure shows how to create a generic type object under the Reports
branch in the Scheduling structure, and then create the File Viewer aspect and attach
the file to the aspect.
To do this:
1. In the Plant Explorer, browse to the location where the File Viewer aspect is to
be added, for example, the Reports branch in the Scheduling Structure.
2. From the Reports object, choose New Object from the context menu.
3. In the New Object dialog, select the Generic type object, assign the object a
meaningful name (BatchReport1Template for example), then click OK.
4. Select the new object (BatchReport1Template for example) and choose New
Aspect from the context menu. This displays the Add New Aspect dialog.
5. Select the File Viewer aspect in the New Aspect dialog, then click Create. This
adds the File Viewer aspect to the selected object.
6. Open the Configuration view of the File Viewer aspect. To do this, either choose
Config View from the aspect’s context menu, or use the corresponding icon on
the tool bar, Figure 7.39.
Figure 7.39: Opening the Config View
7. Attach the report file as a Work Document. To do this, in the Work Document
section of the Configuration view, click the Attach button, Figure 7.40.
3BUF001094-600 B 463
Click Attach button

in Work Document section
Figure 7.40: Attaching the Report File to the Work Document Section
8. Use the File Browser dialog to select the report file (BatchReport1.rtp for exam-
ple), then click Open. The result is shown in Figure 7.41.
Figure 7.41: File Attached
464 3BUF001094-600 B
7 Creating Reports 7.7 Report Preferences Aspect
7.7 Report Preferences Aspect

The Report Preferences aspect, Figure 7.42, is used to configure the maximum number
of Completed Report objects that the Scheduler will maintain within the Reports
branch of the Scheduling structure (on a per folder basis). It also provides options for
removing Completed Report objects that have been created. If the Maximum number
of reports per folder field is set to 1 (one), then only one copy is kept (the existing
version is overwritten). The the previous report is kept as a backup under a different
name/extension.
An instance of the Report Preferences aspect is created in the Reports branch. By
default, there are no subfolders in the Reports branch, so the maximum number
specified in this aspect applies to the entire branch. If subfolders are created, the
maximum number applies to each subfolder. Additional instances of the Report
Preferences aspect can be created in any subfolder in the Reports branch. In this case
each subfolder looks upward in the Reports branch, and uses the maximum number
specified in the first Report Preferences aspect that it finds.
Figure 7.42: Report Preferences Aspect
7.8 Report Printing Aspect

A Report Printing aspect, Figure 7.43, is in every Completed Report object in the
Reports branch of the Scheduling structure. This aspect is used to select the public
3BUF001094-600 B 465
7 Creating Reports 7.9 View Report Logs Aspect
document from any File Viewer aspect on the Completed Report object, and send it
to a printer along with electronic signature information for the File Viewer aspect.
Figure 7.43: Report Printer Aspect
7.9 View Report Logs Aspect

The Inform IT History View Report Logs aspect provides access to a directory of
report logs that reside in the runtime and restored databases. The report logs are listed
in the upper pane, and the reports for a selected log are listed in the lower pane, Figure
7.44. The fields are described in Table 7.7. Use this window to:
• copy (archive) data for report logs from the runtime History database to the
specified archive media. Refer to Section 10 Reading and Managing Archive
Data.
• delete restored report logs, that have been restored from the archive media, to
the restored History database. Refer to Section 10 Reading and Managing Archive
Data.
466 3BUF001094-600 B
7 Creating Reports 7.9 View Report Logs Aspect
• view reports stored in a selected report log. Refer to Viewing Reports Stored in
a Report Log on page 468.
Report Log
Reports stored in
the selected log
Figure 7.44: View Report Logs Aspect
Table 7.7: View Report Logs Aspect
Field Description
Service Group Indicates the node where the displayed logs reside.
Log Class Indicates whether the displayed logs are Run Time or Restored.
Number of Logs Indicates the number of logs in the displayed list.
Status Indicates the status of a displayed log: ACTIVE or INACTIVE.
Log name Indicates the name of the displayed log.
3BUF001094-600 B 467
7 Creating Reports 7.10 Troubleshooting Reports

(Continued)
Field Description
Execution Time Lists the execution times for the reports.
Stored Time Lists the times when the executed report was stored.
User Name Lists the user that executed the report.
Report Name Lists the name of the report that was executed.
7.9.1 Viewing Reports Stored in a Report Log

To view a report stored in a report log:
1. Click the Retrieve tab.
2. Enter the retrieval criteria, then click Retrieve.
3. In the upper pane, select the log which contains the report to be viewed.
4. In the lower pane, select the report.
5. Click View Selected Report.
For further details on using the View Report Logs aspect, refer to View Report Logs
Aspect on page 546.
7.10 Troubleshooting Reports

If a report is clearly taking much longer than it should to finish executing and no
Time Limit was configured for the action, the job may need to be aborted (along with
any Excel programs which may still be running) so that other jobs in the queue can
run. Jobs that are waiting in the queue are shown in blue, and their state in the Job
Log will be Not run. If software is not installed properly, the Scheduler service may
need to be disabled and re-enabled and the running jobs queue must be manually
cleaned.
This situation is most often caused when a dialog is generated that cannot be responded
to since it is not visible when a report is automated by the Scheduler service. To
limit the probability of this situation occurring, follow the guidelines in Before Running
a Report on page 460. The following conditions will cause a report to hang:
468 3BUF001094-600 B
7 Creating Reports 7.11 Creating a Report with Crystal Reports
• Failure to enable macros in Excel - Scheduling a report that uses Visual Basic
macros in a Microsoft Excel spreadsheet, requires that macros be enabled in
Excel before the report runs.
• Failure to install Data Direct add-ins correctly - DataDirect add-ins must be
installed by an Industrial IT Admin user.
• Failure to pass parameters to a Crystal Report - If the Crystal Report file
expects parameters to be passed, then include those parameters in the report action.
• Failure to install Crystal Reports correctly - A report built with Crystal Reports
will fail if a complete installation (install all possible features and components)
was not performed. In this case re-install Crystal Reports.
• Failure to use an appropriate version of Microsoft Office - Older versions of
Microsoft Excel have undocumented memory limitations that can effect execution
of reports, especially larger ones.
• Fixing large Reports (Long Execution Time) - If a report is taking much longer
than it should to finish executing and no Time Limit was configured for the action,
other jobs in the queue may not run as scheduled. To fix this, abort the job along
with any Excel programs which may still be running. Set a maximum time for
Report Action Aspects, so the system will terminate the report instance if a report
hangs. This will give other working reports the chance to execute. Also, increase
the action time limit for large reports.
7.11 Creating a Report with Crystal Reports - Example

This section provides a quick tutorial on how to connect a Crystal Report to an 800xA
System data source. This tutorial does not provide detailed instructions for using
Crystal Reports. Rather it shows how to apply basic Crystal Reports functionality to
retrieve data from the 800xA System. Some knowledge of how to use Crystal Reports
is required to follow this tutorial. For details regarding any Crystal Reports procedures,
refer to the Crystal Reports documentation.
This tutorial shows how to build a report for historical process data related to a batch.
The Batch ID is dynamically updated for each report. The 800xA Batch Management
application writes the batch ID into an argument value which is then passed into the
report as a parameter. The architecture and data flow for this report is illustrated in
Figure 7.45.
3BUF001094-600 B 469
Report Schedule
Batch BatchID
Management Report Action
Report Completed
BATCHID Template Report
TIMESTAMP
DATAVALUE
ODBC
Batch Trend View
Figure 7.45: Report Architecture and Data Flow
7.11.1 Connecting the Report to the ODA Table for Historical Data
In order for the reports created with Crystal Reports to access data from the 800xA
System, the reports must be connected to the applicable database. For this tutorial,
the Crystal Report to an Oracle view called Batch_Trend which is specifically designed
to facilitate access to historical data for batches run using the 800xA Batch Manage-
ment application will be used. Refer to PDL Tables and Views on page 679.
There are several methods in Crystal reports to make this connection. This procedure
shows how to use the Database Expert.
1. Choose Database > Database Expert from the Crystal Reports menu bar.
2. Verify whether ABBODA datasource is listed under the My Connection tree. If it
is not, expand Create new Connection > ODBC(RDO) to launch the ODBC(RDO)
dialog.
3. Select ABBODA datasource and click Finish.
4. If no tables are visible under ABBODA > SCHEMA, right-click ABBODA and
select Options menu to launch the Options dialog.
470 3BUF001094-600 B
5. Select Tables under Data Explorer (Figure 7.46) and click OK.
6. Click -/+ of the ABBODA connection to refresh and display the Tables.
Figure 7.46: Selecting Tables
7. Select and add the BATCHTRENDs table to Selected Tables as shown in Figure
7.47.
3BUF001094-600 B 471
Figure 7.47: Adding BATCHTRENDs Table
8. Click OK to close the dialog.

The history data can also be derived by connecting to the Oracle tables and pre-
defined views. Refer to Connect to an Oracle Table, View, or Synonym from
Data Explorer on page 647 for a generic example.
7.11.2 Selecting Fields from the Batch_Trends View

This report will retrieve the following historical data for a specified property log:
batch ID, data values, and time stamps. These attributes are accessed from the con-
nected BATCH_TRENDS view. Use the Field Explorer:
1. Choose View > Field Explorer from the Crystal Reports menu bar
2. Expand the Database Fields branch.
3. Expand the BATCH_TRENDS branch.
4. Select a field, for example BATCHID, then choose Insert to Report from the
context menu.
5. Situate the field in the location where it will appear in the report.
6. Repeat Step 4. and Step 5. for other fields as required.
472 3BUF001094-600 B
7.11.3 Adding Parameters

The report will be run for each new batch that is completed. The historical data related
to each specific batch is accessed from the BATCH_TRENDS view using the batch’s
unique batch ID as a key. To dynamically change the batch ID for each report instance,
the ID must be passed in as a parameter. The Batch Management application writes
the batch ID to an argument value which may be specified as a parameter in the Report
action. The batch ID must also be specified as a parameter in the Crystal Report. The
logical name is also required to access batch-specific data in the BATCH_TREND
view. To create these parameters in Crystal Reports:
1. Select the Parameter Fields branch in the Field Explorer, and choose New from
the context menu.
2. In the Create Parameter Field dialog, enter the parameter name, for example:
batchID. Also make sure the Value Type is set to String, Figure 7.8. Click OK
when done.
Table 7.8: Specifying the Parameter
3. Repeat Step 1. and Step 2. for the second parameter (also String value type). The
report definition so far is shown in Figure 7.9.
3BUF001094-600 B 473
Table 7.9: Report So Far
7.11.4 Configuring the Query to Get Historical Process Data

The Record Selection Formula Editor can be used to get information for the selected
fields (batch ID, datavalue, and timestamp) for the current batch.
1. On the Crystal Reports menu bar, choose:
Reports > Selection Formulas > Record
2. Enter the query as shown in Figure 7.10. This will search the BATCH_TRENDS
view for the batch whose ID equals the batchID argument specified by the current
batch and passed in as a parameter by the Report action, and whose logicalname
equals the logicalName parameter passed in by the Report action.
474 3BUF001094-600 B
Table 7.10: Selection Formula Done
3. Save the report.
7.11.5 Integrating the Report into the 800xA System

To finish integrating the report into the 800xA System:
1. Attach the report template to a File Viewer aspect. Refer to Attaching a Report
Template to a File Viewer Aspect on page 462.
2. Create a Job Description object and Report Action aspect in the Scheduling
structure. Refer to Creating Objects and Aspects in the Scheduling Structure on
page 428.
3. Configure the Report Action. Refer to Defining the Report Action on page 429.
Be sure to add the batchID and logicalname to the parameter list. Specify the
batch ID value as an argument, and specify logicalname as a static value (the
logicalname value must be known before configuring the Report Action).
4. Configure the schedule. Refer to Defining the Schedule on page 458.
3BUF001094-600 B 475
7.11.6 Using DataDirect

This tutorial does not provide detailed instructions for using DataDirect. Rather
it shows how to apply basic DataDirect functionality to retrieve data from 800xA
aspect objects. Knowledge of DataDirect is required to follow this tutorial. Refer
to Section 5 DataDirect Inform IT for details about DataDirect.
This tutorial shows how to build a report for historical process data related to a batch.
The Batch ID is dynamically updated for each report. The 800xA Batch Management
application writes the batch ID into an argument value which is then passed into the
report as a parameter. The architecture and data flow for this report is similar to the
one shown in Figure 7.45 except the ADO Data Provider is used in place of ODBC.
Passing in batchid
The batchid must be passed in as a parameter through the Report Action. This proce-
dure is described later in this tutorial.
Make a placeholder for the batchid in the Excel spreadsheet. To do this, select a cell
in the spreadsheet, and rename the cell literally as batchid. For example, in Figure
7.48, cell C2 is renamed batchid.
Renaming Cell C2
with the batchid
Parameter name
Figure 7.48: Renaming a Cell as batchid
Retrieving Historical Log Data for the Batch

Use the Batch Data dialog in DataDirect to access the Batch_Trends view.
1. Launch DataDirect from Excel.
2. Open the Batch Data dialog from the menu bar (DataDirect > Batch Data) or
use the tool bar button.
476 3BUF001094-600 B
Figure 7.49: Opening the Batch Data Dialog
3. Use the Batch Data dialog, Figure 7.50, to configure a query against the
BATCH_TRENDS view for BATCHID, DATAVALUE, TIMESTAMP, and
LOGICALNAME. Use the filter on the LOGICALNAME column to specify a
value, for example tankTemp. Be sure to select the DataDirect formula option
in the Output section.
3BUF001094-600 B 477
Figure 7.50: Setting Up the Batch Trend Query
Integrating the Report into the 800xA System

To finish integrating the report into the 800xA System:
1. Attach the report to a File Viewer aspect. Refer to Attaching a Report Template
to a File Viewer Aspect on page 462.
2. Create a Job Description object and Report Action aspect in the Scheduling
structure. Refer to Creating Objects and Aspects in the Scheduling Structure on
page 428.
3. Configure the Report Action. Refer to Defining the Report Action on page 429.
Be sure to add the batchID and logicalname to the parameter list. Specify the
batch ID value as an argument, and specify logicalname as a static value (the
logicalname value must be known before configuring the Report Action).
478 3BUF001094-600 B
Login parameters for connecting the DataDirect report to the applicable data
server must be specified. To do this, define the following parameter:
DataServerLogin = computer name,user name, password
For example: DataServerLogin = roc74,aid,aid
4. Configure the schedule. Refer to Defining the Schedule on page 458.
This concludes the tutorial for DataDirect.
7.11.7 Using Excel Without DataDirect Add-ins

In order for the reports created with Microsoft Excel to access data from the 800xA
System, the reports must be connected to an Open Data Access (ODA) database. The
ODA database specifies which database tables the report will be able to access. One
ODA database named DATABASE1 is provided as standard. By default this ODA
database uses the AIP OPC HDA server, and connects to a real-time database named
DATABASE1. DATABASE1 is initially empty, meaning it has no custom-built real-
time database tables assigned. This set up supports access through the predefined
numericlog (history) and generic_da (real-time) tables.
The default set up for DATABASE1 can be changed to use the IM OPC HDA server,
and/or specify a different real-time database table. Further, additional ODA databases
can be created where each one specifies a different real-time database. This is used
to connect the client application to a different ODA database, depending on the par-
ticular data access requirements.
Microsoft Query must be installed to set up this functionality. If this application is
not installed, install it now from the Excel installation media.
The procedure for using Microsoft Query to connect the Excel spreadsheet to an
ODBC driver and create a query for history data is provided in System 800xA In-
formation Management Getting Started (3BUF001091*) (refer to Creating a
Simple History Report using ODBC and ODA). For more detailed instructions on
using Microsoft Query, refer to the online help available with Microsoft Excel.
3BUF001094-600 B 479
480 3BUF001094-600 B
8 Scheduling 8.1 Using Scheduling
8 Scheduling
The 800xA System allows jobs to be scheduled, executed, and maintained. Supported
jobs include reports, historical data archiving, event-driven data collection, calcula-
tions, consolidation of PDLs and message logs, and back-ups.
Installing the Application Scheduler on an Information Management server, auto-
matically creates the required Service Group and Service Provider objects in the
Service structure as part of the Information Management post-installation proce-
dure. Installing the Application Scheduler to run on a node that is NOT an Infor-
mation Management server requires that these objects be manually created under
the Scheduling Service group in the Service structure as part of Information
Management configuration.
8.1 Using Scheduling

Jobs are configured in two basic parts: a schedule, and one or more actions. Start
conditions may also be applied on an optional basis. The job schedule is implemented
as a Job Description object which are created in the Job Descriptions branch of the
Scheduling structure (one schedule per job), Figure 8.1.
Figure 8.1: Scheduling Structure with Job Descriptions and Running Jobs
3BUF001094-600 B 481
8 Scheduling 8.2 Adding a Job Description Object
Action aspects are added to the Job Description object to specify the activity to be
performed by the job. For example, a Report Action aspect is added to schedule and
execute a report job.
Start condition aspects may be added to impose further conditions by which to execute
the job.
The procedure for creating a job follows these basic steps. Detailed instructions are
provided in the referenced sections:
1. Create a Job Description object. A Schedule Definition aspect, through which
the schedule will be set up, is provided with this object when it is created. To
create the Job Description object and corresponding Schedule Definition aspect,
refer to Adding a Job Description Object on page 482.
2. As an option, add and configure one or more start condition aspects to specify
any conditions that must be met before the job will be allowed to run. Refer to
Specifying Start Conditions on page 492.
3. Add and configure an action aspect. This aspect defines the function that the job
will perform. Refer to Actions on page 498 to add an action aspect.
Five standard actions are supported. With the exception of reports, the section specified
below in System 800xA Information Management Configuration (3BUF001092*)
describes how to configure these actions:
• Reports - This user manual, refer to Section 7 Creating Reports.
• Archive - refer to Configuring the Archive Function.
• Event-driven data collection - refer to Historical Process Data Collection.
• Consolidation of PDLs and message logs - refer to Consolidating Historical Data.
• Calculations - refer to Configuring Calculations.
8.2 Adding a Job Description Object

Jobs are created in the Scheduling structure. To create a job:
1. In the Plant Explorer, select the Scheduling Structure.
2. Right-click on Job Descriptions and choose New Object from the context menu.
3. Select the Job Description object type in the New Object dialog. Assign the
object a logical name (DayShiftReport for example).
482 3BUF001094-600 B
4. Click Create. This creates the new job under the Job Descriptions group. This
object’s aspect list contains a Schedule Definition aspect.
5. Click on the Scheduling Definition aspect to display the configuration view,
Figure 8.2.
Figure 8.2: Scheduling Definition Configuration View
8.2.1 Scheduling Definition View

The Scheduling Definition view has three tabs:
• Schedule - specifies scheduling parameters. Refer to Defining the Schedule on
page 484.
• Arguments - specifies parameters which can be passed into jobs to establish
values for certain settings. For example, parameters in the Report action can
reference arguments to set parameter values. Refer to Arguments on page 495.
3BUF001094-600 B 483
• Log - for viewing a log of messages regarding job execution when the job is
running, or is finished running. Refer to Viewing a Job Log on page 497.
8.2.2 Defining the Schedule

The Scheduler supports several scheduling methods, for example: cyclic, periodic,
monthly, conditional, and so on. Use the Schedule tab to select the type of schedule
and then specify the scheduling parameters according to the selected type. The
schedule type is presented as a plug-in dialog on the Schedule tab. The top section
of this tab has a set of common controls which are applicable for all schedule types,
Figure 8.3. It contains a field for selecting the schedule type, a check box for enabling
scheduling for the job, and a button to manually run the job.
The Service Group selection field is used to choose which server will execute a given
job in the case where there are multiple nodes running the Application Scheduler.
Jobs that do not have a service group selected will display <default> in this field and
will be executed by the primary service group. The primary service group is determined
to be the first service group created, not necessarily the first one listed in the service
structure.
To avoid unexpected results, it is recommended that a specific service group be se-
lected to run the job.
Figure 8.3: Schedule Tab - Common Controls
• The Enabled check box must be checked in order for the scheduler to use
the selected plug-in for scheduling jobs.
• The Run Now button supports manual execution of a job independent of any
schedule type plug-in.
Use the Schedule pull-down list to select the type of schedule, then refer to the appli-
cable instructions below to learn how to use the plug-in dialog:
• To run a job at cyclic intervals specified in seconds, refer to Cyclic Scheduling
on page 485.
484 3BUF001094-600 B
• To run a job periodically at daily, hourly, minute, or second intervals, refer to

Periodic Scheduling on page 486.
• To run a job on a specified weekday during the month (for example first Monday,
third Wednesday, last Sunday, or every Tuesday), refer to Weekly Scheduling
on page 486.
• To run a job on a specific day of the month (for example 1st, 12th, 31st, or every
day), refer to Monthly Scheduling on page 488.
• To run a job according to a list of scheduled dates and times, refer to Creating a
Scheduling List on page 490.
• To run a job based on the evaluation of an expression, refer to Expression-based
Scheduling on page 490.
8.2.3 Cyclic Scheduling

The Cyclic Schedule plug-in, Figure 8.4, is used to specify a time interval between
each run. To create a cyclic schedule, select Cyclic Schedule from the Schedule pull-
down list, then specify the time in the Interval field. The time interval is specified in
seconds with a range of 1 to 4294967. The first execution will occur after one interval
has elapsed. For example, by setting the time interval as 60 seconds as shown in
Figure 8.4, the job will run at 60-second intervals.
Figure 8.4: Cyclic Schedule Plug-in
3BUF001094-600 B 485
8.2.4 Periodic Scheduling

The Periodic plug-in, Figure 8.5, is used to specify a periodic interval in weeks, days,
hours, minutes, or seconds. It can also specify a scheduling time-window which defines
a beginning and end time for the schedule.
To create a periodic schedule, select Periodic Schedule from the Schedule pull-down
list.
Specify the periodic interval using the Run Every pull-down list to select units (days,
hours, minutes, or seconds), and the edit field to specify the number of units.
The default behavior is to run the first instance of the job immediately, and to continue
running at the specified interval indefinitely. For example, if the interval is run every
1 Day, the job will start running at the time the schedule is submitted, and then once-
a-day at that time after that.
As an option, specify a definite start and/or end time. To do this, click either the
Scheduling time-window begins or ends, or both check boxes and specify the re-
spective start and end times.
Figure 8.5: Periodic Schedule Plug-in
8.2.5 Weekly Scheduling

The Weekly plug-in, Figure 8.6, is used to pick a weekday during the month (for ex-
ample first Monday, third Wednesday, last Sunday, or every Tuesday). It can also
specify a scheduling time-window which defines a beginning and end time for the
486 3BUF001094-600 B
schedule. To create a weekly schedule, select Weekly Schedule from the Schedule
pull-down list.
Specify the day of the week and time using the Frequency, Day of week, and Time
of day controls shown in Figure 8.6. The default behavior is to run the first instance
of the job at the next possible time, starting 1 minute after any changes are applied,
and to continue running at the specified interval indefinitely. For example, if the
schedule is to run every Sunday at 8:00 AM, the job will start running the first
Sunday at 8:00 AM after the schedule is submitted.
Figure 8.6: Weekly Schedule Plug-in
Frequency
Use this pull-down list to select whether to run the job on every specified weekday,
or one specific weekday (first, second, third, fourth, or last), Figure 8.7.
Figure 8.7: Selecting the Frequency
3BUF001094-600 B 487
Day of week
Use this pull-down list to select the weekday (Monday, Tuesday, Wednesday,
Thursday, Friday, Saturday, or Sunday), Figure 8.8.
Figure 8.8: Selecting the Day of the Week
Time of day
Use this control to select the time of day, Figure 8.9.
Figure 8.9: Selecting the Time of Day
8.2.6 Monthly Scheduling

The Monthly plug-in, Figure 8.10, is used to pick a day of the month (for example
1st, 12th, 31st, or Every Day). It can also specify a scheduling time-window which
defines a beginning and end time for the schedule. To create a monthly schedule, select
Monthly Schedule from the Schedule pull-down list.
Specify the days of the month. The Daily tab is used to specify a time of day at which
to run the job. The Hourly tab is used to specify one or more hours of the day at which
to run the job.
The default behavior is to run the first instance of the job at the next possible time,
starting 1 minute after any changes are applied, and to continue running at the specified
interval indefinitely. For example, if the schedule is to run on the first (1) day of the
month at 16:00 (4:00 PM), the job will start running on the first occurrence of the
first day of the month at 16:00 after the schedule is submitted.
488 3BUF001094-600 B
Figure 8.10: Monthly Schedule Plug-in
Days
Use this list to select one or more days of the month. Select one or more days as re-
quired by clicking the corresponding number. All selects every day of the month.
Clear List clears all selections.
Daily
Use the Daily tab to specify a time of day at which to run the job, Figure 8.11.
Figure 8.11: Daily
Hourly
Use the Hourly tab to specify one or more hours in the day at which to run the job,
Figure 8.12. All selects every hour of the day. Clear List clears all selections.
3BUF001094-600 B 489
Figure 8.12: Hourly
8.2.7 Creating a Scheduling List

The List plug-in, Figure 8.13, is used to specify a list of dates and times at which to
run the job. To create a list schedule, select List Schedule from the Schedule pull-
down list.
Specify a date and time with the respective controls, then click Add Schedule to add
the schedule to the list. Remove any added schedule by selecting it, and then clicking
Remove.
Figure 8.13: List Schedule
8.2.8 Expression-based Scheduling

The Expression plug-in, Figure 8.14, is used to schedule a job based on the evaluation
of an expression. To create an expression schedule, select Expression Schedule from
the Schedule pull-down list.
490 3BUF001094-600 B
Figure 8.14: Expression Schedule
Enter the expression in the edit window. Refer to the Expression Rules and Examples
section of System 800xA Configuration (3BDS011222*).Typically, the expression
will include a reference to an aspect object in a structure in the Plant Explorer. The
syntax is:
$’[Structure]/RootBranch/Branch/Branch/Object:Aspect:Property’
Use the pull-down list in the lower right corner of the dialog, Figure 8.15, to specify
whether to run the job whenever the expression value changes (Start when value
changes), or only when a boolean expression changes from false to true (Start when
TRUE).
Figure 8.15: Start When Specification
3BUF001094-600 B 491
8 Scheduling 8.3 Specifying Start Conditions
8.3 Specifying Start Conditions

Start conditions are configured as aspects placed on job description objects or their
descendents (actions). A start condition controls when any actions of the object and
its descendents can run. These Start Condition aspects may be used in combination
with the Scheduling Definition aspect associated with a job as described in Defining
the Schedule on page 484.
The Start Condition aspects may also be used to apply different start conditions to
individual action aspects for a job when the job contains more than one action as de-
scribed in Job Hierarchies on page 503.
When an action has one or more start condition aspects, the scheduler will allow the
action to run when all conditions associated with the action evaluate true. If a start
condition does not evaluate to true within its wait time then the action is skipped and
is marked as not run. Currently this wait time is zero and is not changeable so each
start condition is checked only once.
There are two types of start conditions, based either on:
• the evaluation of an expression. Refer to The Expression Start Condition on page
493.
• enabled/disabled switch setting - Refer to The Yes/No Start Condition on page
494.
To add a start condition aspect to the Job Description object in the Scheduling
Structure:
1. Right-click the Job object (for example DayShiftReport) and choose New Aspect
from the context menu.
2. In the New Aspect dialog, browse to the Scheduler category and select the Start
Condition aspect (path is: Scheduler>Start Condition>Start Condition). Use
the default aspect name, or specify a new name.
3. Click Create to add the Start Condition aspect to the job.
4. Click the Start Condition aspect to display the configuration view, Figure 8.16.
492 3BUF001094-600 B
Figure 8.16: Start Condition Aspect - Configuration View
8.3.1 Configuring a Start Condition

Use the Start Condition pull-down list to select the type of start condition, Figure
8.17.
Figure 8.17: Selecting the Type of Start Condition
Refer to the applicable section to learn how to configure the selected start condition:
• The Expression Start Condition on page 493.
• The Yes/No Start Condition on page 494.
8.3.2 The Expression Start Condition

The Expression start condition is used to enter an expression, Figure 8.18. Refer to
Expression-based Scheduling on page 490 for syntax guidelines.
3BUF001094-600 B 493
Figure 8.18: Expression Start Condition
8.3.3 The Yes/No Start Condition

The yes/no start condition is either enabled or disabled. When enabled (check box
checked), the step is allowed to execute. When disabled, the step is prevented from
executing, Figure 8.19.
Figure 8.19: Yes/No Start Condition
494 3BUF001094-600 B
8 Scheduling 8.4 Arguments
8.4 Arguments
Jobs whose actions support arguments can reference user-defined arguments to estab-
lish values for certain settings. For example, parameters in the Report action can ref-
erence arguments to set parameter values.
Argument lists are created on a per-job basis. This is done through the Arguments
tab of the Scheduling Definition aspect of the Job Description object, Figure 8.20.
Figure 8.20: Arguments List
Arguments may also be created dynamically by external applications such as Batch

Management applications. This lets the batch application dynamically specify certain
3BUF001094-600 B 495
8 Scheduling 8.4 Arguments
parameters that change from one batch to the next such as batch IDs. When a job
runs, the job log will show the values for each argument for the job.
When arguments are passed in dynamically by an application such as Batch
management, the list on the Arguments tab is ignored.
To create a list of arguments manually (reference Figure 8.20 for steps 1 & 2):
1. In the Scheduling structure, select the Job Description object for the job whose
argument list needs to be edited.
2. Select the Scheduling Definition aspect, then click on the Arguments tab.
3. Click in an empty field, then click Modify. This displays the Modify Arguments
dialog.
4. Enter the Argument name and value, Figure 8.21, then click OK.
Figure 8.21: Modify Arguments Dialog
This adds the new argument to the argument list, Figure 8.22.
496 3BUF001094-600 B
8 Scheduling 8.5 Viewing a Job Log
Figure 8.22: Argument Added
Remove an argument from the list by selecting the argument and then clicking Re-
move.
8.5 Viewing a Job Log

The Job Log tab provides a tree where each line contains status information such as
start and end times and error codes for each step in each job, Figure 8.23. Show the
details for any line by double-clicking, or clicking on the plus sign.
3BUF001094-600 B 497
8 Scheduling 8.6 Actions
Figure 8.23: Job Description - Log Tab
The log holds the last ten instances of the job's execution plus any instances that have
failed if they have not been deleted. To get information regarding a job that has failed,
use the Scheduled Job aspect for the Running Job object as described in The Running
Job on page 503.
The number of status entries for SUCCESSFUL runs of a job is limited to 10. The
status of failed jobs is not limited.
8.6 Actions
Actions are implemented as aspects on an object which is on or under a job description
in the scheduling structure.
To add an action:
1. Right-click on the Job object (for example DayShiftReport) and choose New
Aspect from the context menu.
498 3BUF001094-600 B
2. In the New Aspect dialog, browse to the Scheduler category and select the Action
aspect (path is: Scheduler>Action Aspect>Action Aspect). Use the default aspect
name, or specify a new name (for example RunXyzReport).
3. Click Create to add the Action aspect to the job.
4. Click on the Action aspect to display the corresponding view, Figure 8.24.
Figure 8.24: Action Aspect Configuration View
8.6.1 Action Aspect View

This view is used to configure an action, for example for running a report, consolidat-
ing PDLs and message logs, or event-driven historical data collection. The upper
section provides the means for selecting the type of action to configure, Figure 8.25,
and also contains properties which are common to all actions. These are described in
Table 8.1. Except for System Messages, their functionality if any is dependent on
how the specific plug-in is implemented. In fact, the values for Isolated and Priority
are not even persisted by the Action Aspect itself. Their values are totally dependent
on the values persisted and/or provided by the plug-in. (For example, if an action
3BUF001094-600 B 499
plug-in does not implement or use these two fields, they will immediately revert back
to default values whenever new values are applied.)
Figure 8.25: Selecting an Action
For details on configuring an action refer to:

• Defining the Report Action on page 429.
Refer to System 800xA Information Management Configuration (3BUF001092*)
for the following:
• Consolidating Message Logs and PDL data, refer to the Consolidation section.
• Event-driven data collection, refer to the process data collection section.
• Scheduling calculations, refer to the calculations section.
• Scheduling archive operations, refer to the configuring archiving section.
• Scheduling history backup, refer to the History Database Maintenance section.
Multiple actions may be added to an object. To add multiple actions, and control the
order in which they are executed, refer to Job Hierarchies on page 503.
500 3BUF001094-600 B
Table 8.1: Common Action Properties
Property Description
Time Limit This is how long (in seconds) an action is allowed to execute before it is requested
to shutdown. Both the time limit value and the shutdown handling is dependent on
which action plug-in is specified. By default, the field is blank meaning there is no
time limit. Zero may also be entered to clear the field.
Note: For the Report Action plug-in, shutdown of an Excel report may leave an
instance of the excel.exe process running which can be aborted using the Windows
Task Manager.
Isolated This is used to force an action to be executed on an independent processing thread
where it is less likely to effect other actions. This is required for actions that are to
be executed in parallel with each other since a single thread cannot really execute
multiple actions simultaneously.
Priority If a situation arises where more than one job schedules an action to be executed at
the exact same moment in either the isolated or non-isolated queue, the action with
the highest priority number will be executed first.
Attempts This is the maximum number of times an action is to be executed and should normally
be set to at least 1. Attempts beyond the first one will occur only in the case where
an error is immediately returned from the Run Job method of the action plug-in.
Note: for plug-ins such as the Report Action, no more than a single attempt is ever
made because a special success status for asynchronous operation is always
immediately returned so that a more detailed completion message can be returned
later.
System This combo box optionally allows a system message to be generated when an action
Messages is started, finished, or both.
8.6.2 Understanding the Predefined Batch Reports Action Aspect in

Scheduler
Scheduler provides default Batch report templates and configured Batch report jobs.
The report templates are attached in Reports objects of Scheduling structure and Batch
jobs in the Job Description object. For example, the Batch Report Excel is shown in
Figure 8.26.
For the Batch report template to execute successfully, we need to provide valid pa-
rameters through Edit Parameter List. The parameters are as follows:
3BUF001094-600 B 501
1. BatchID:There are two places from which we can get the value to this variable
as follows:
a. Arguments tab of Scheduling Definition Aspect as explained in Arguments
on page 495.
b. Schedule Job BMA (Batch Manager Action)of Production Management
System.
2. DataServerLogin: Login parameters for connecting the DataDirect report to the
applicable data server must be specified. The user name and the password are
by default configured as DataServerLogin = localhost, aid, aid. If the user name
and the password defined for Display Services(or DataDirect) during IM Post
Installation is not “aid, aid”, then it should be modified by clicking Edit Param-
eter List.
3. LogicalNameList: It represents the names of History associations specified in
DataCollection BMA of Produce IT. An example is shown in Figure 8.27. This
parameter is compulsory for Batch Trends Data retrieval. Parameter Intervals is
also used for Batch Trends data. For more information on Schedule BMA, refer
to the Batch Management documentation.
Figure 8.26: Batch Report Excel
502 3BUF001094-600 B
8 Scheduling 8.7 Job Hierarchies
Figure 8.27: Batch Data Collection
8.7 Job Hierarchies

Jobs can be subdivided into steps. This is used to control the order in which parts of
jobs are run. This is done by creating a hierarchical sub-tree of objects that contain
action aspects, and possibly start conditions. Each object is treated as another step in
the job.
The sub-tree specifies that the parent's actions must have completed before the children
can be run and that the sibling steps are run in parallel. If a step has a start condition
then it is held in a not-started state until the start condition reports that the step can
run.
Each is run when the start conditions on the step itself and all steps above it allow
the step to run, and all actions above the step in the tree have completed.
8.8 The Running Job

This section describes how to manage running jobs. This includes:
• Monitoring a Running Job on page 504.
• Viewing Alarm and Event List on page 505.
3BUF001094-600 B 503
8 Scheduling 8.8 The Running Job
• Purging Running Job Objects on page 506.

• Using the Test Action to Test a Job on page 507.
8.8.1 Monitoring a Running Job

A Running Job object is inserted under the Running Jobs branch for any job that is
currently running, Figure 8.28.
The running job object is only available as long as the job is running (typically a very
short time). Therefore, from a practical standpoint these objects are only available
for failed jobs.
A job collects job status information as it runs. This includes information for each
step and timestamps for each satisfied start condition as well as the start and comple-
tion of each action. Each action may also generate a text log that is saved with the
job. This information is available through the Scheduled Job aspect, Figure 8.29.
Figure 8.28: Running Jobs
504 3BUF001094-600 B
Figure 8.29: Scheduled Job Aspect
If a job fails it is left in an uncompleted state and must be manually completed (or
deleted). A system message is generated when a job fails and its status (S_STATUS)
is marked as bad. This allows the system status function to flag the condition in its
viewer.
When a job is completed the Running Job object is removed from the Running Job
Branch, and the status information collected for the job is transferred to its associated
job description. This information is available through the Job Log tab of the
Scheduling aspect. Refer to Viewing a Job Log on page 497.
8.8.2 Viewing Alarm and Event List

Alarms and events for running jobs may be viewed through the Alarm and Event List,
Figure 8.30.
3BUF001094-600 B 505
Figure 8.30: Alarm and Event List
8.8.3 Purging Running Job Objects

The objects for running jobs that do not complete remain in the Running Jobs branch
until deleted. This includes jobs that fail, and jobs that are interrupted when the
Scheduler is disabled for some reason. Delete the jobs one-at-a-time by right-clicking
on the object and choosing Delete from the context menu. As an alternative, click
Remove All on the RunningJobsHandler to delete all Running Job objects, Figure
8.31.
506 3BUF001094-600 B
Click to delete all

Running Job Objects
Figure 8.31: Deleting all Running Job Objects
8.8.4 Using the Test Action to Test a Job

The Test Action, Figure 8.32, runs the report through the interactive or workplace
user, instead of the Scheduler. This helps determine whether or not the scheduler is
having problems. If dialogs asking for userid/password or data source are shown, the
report will not run when executed by the Scheduler. Also, check the ODBC source
Localhost to make sure it was not configured with a userid (should be blank).
The results of the test are stored in ABBActions.log. That log file must be accessed
to see the results of the test as there is no visual indication (error message, dialog box,
etc.) regarding the test results. To access ABBActions.log:
1. Use the Folder Options in Windows Explorer to show hidden files and folders
on the C drive.
2. Navigate to the following folder:
C:\ProgramData\ABB\IM\Scheduler
3. Open ABBActions.log in a suitable application (Wordpad, Notepad, etc.).

4. Use the Folder Options in Windows Explorer to hide hidden files and folders on
the C drive.
3BUF001094-600 B 507
8 Scheduling 8.9 Security
Figure 8.32: Test Action Function on the Action Aspect
8.9 Security
Operations related to Application Scheduler aspects are secured by restricting access
to certain users. Restrict access based on permissions, or a combination of user role
and permissions. When restricted solely on permissions, any user having the specified
permissions can perform the operation. Binding a user role to an operation means
only that user type can perform the operation, and that user must be assigned the ap-
plicable permissions.
The default security configuration allows:
• Any user to read scheduling aspects.
• Operators to configure (modify) the scheduling definition and run (manage) the
scheduled jobs.
• Application Engineers to create and configure action and start condition aspects
which specify what a job will do.
The following procedure describes how to change permissions and user roles for
scheduling aspect operations. Report templates and report output stored as Windows
files on shared network drives may also be secured. Refer to Securing Windows Files
on Shared Network Drives on page 511.
Before applying any changes to the Security settings, read Industrial IT 800xA
System Security and understand the concepts presented.
508 3BUF001094-600 B
Permissions and user role bindings for aspects are configured in the Aspect System
structure in the Plant Explorer. To do this: (reference Figure 8.33):
1. Go to the Aspect System structure in the Plant Explorer and select the Scheduler
Aspect System.
2. Expand the branch to show the four Scheduler aspect types (Action, Job Descrip-
tion, Scheduled Job, and Start Condition). Then further expand the branch for
the aspect whose permissions need to be modified. For example, in Figure 8.33
the Job Description branch is expanded to show the Scheduling Definition aspect
category.
3. Click on the Aspect Category Definition in the aspect list, and then click the
Permissions tab.
Figure 8.33: Changing the Security Permissions for Application Scheduler
For each operation listed, select the appropriate permission, Figure 8.34. Refer to
Table 8.2 for details.
3BUF001094-600 B 509
Figure 8.34: Changing the Permission for an Operation
Table 8.2: Default Scheduling Aspect Permissions
Aspect Operations Required Permission

Action Modify Configure
Read None
Scheduling Modify Operate
Definition Read None
Start - Run Now button Operate
Scheduled Modify Operate
Job Read None
Manage - Pause/Resume and Abort buttons Operate
Start Modify Configure
Condition Read None
1. To further restrict access based on user role, click the User Role Bindings tab.
For each operation listed, select the appropriate user role, Figure 8.35.
510 3BUF001094-600 B
Figure 8.35: Binding User Roles to Scheduler Operations
8.9.1 Securing Windows Files on Shared Network Drives

Report templates and report output may reside in shared network folders as Windows
files. If Windows files in shared network folders need to be secure, follow these
guidelines to set up network sharing with proper security:
• Access rights must be limited to those Industrial IT users that need to access the
shared file, preferably with read access only.
• For shared files that are accessed by Industrial IT services, access rights must be
limited to the service account (the admin group). The service account is the ac-
count under which the Industrial IT services run. This is specified during system
configuration. The account information is available through the 800xA Configu-
ration Wizard. To get it, launch the configuration wizard: (ABB Start Menu >
ABB System 800xA > System > Configuration Wizard), then select System
software user settings dialog.
• If the shared file is accessed by clients, access rights must at least be limited to
the group “Industrial IT Users”, preferably with read access only.
• The shared file or folder must be hidden. To hide a shared resource, enter $ as
the last character of the shared resource name. Users can map a drive to this
shared resource, but they cannot see it when they browse for it in Windows Ex-
plorer, or in My Computer on the remote computer, or when they use the net
view command on the remote computer.
3BUF001094-600 B 511
512 3BUF001094-600 B
9 Tag Management 9.1 User Tag Management (UTM)
9 Tag Management
This section describes two tag management tools: User Tag Management (UTM) and
Information Management Browser on page 524).
9.1 User Tag Management (UTM)

The UTM display, Figure 9.1, is used to find and organize log configuration and trend
tags for easier tag management. It is started as a separate Information Management
utility and is also accessible from Desktop Trends, Ticker, and Tag Explorer, and
from DataDirect Inform IT History Values and Inform IT Process Values dialogs.
Supporting tables for client groups and client tags are installed with and backed up
with the History database.
Tags can be found using a hierarchical view, a search for tags view, and a HDA
browser. The explorer has a primary system configuration group that gets log config-
uration and trend tags and displays them in the structure used in the base system.
Update must be run to view the 800xA System Configuration whenever a change is
made (refer to User Tag Management Status on page 523). Public and private groups
of tags are used to organize tags in additional logical ways.
9.1.1 Starting UTM

To start UTM, select:
ABB Start Menu > ABB System 800xA > Information Mgmt > Utilities >
IM User Tag Management
UTM may also be started from the following Desktop Tools applications (refer to
Using UTM from Desktop Tools on page 522 for more information):
• Trend Display using the UTM button.
• Ticker and Tag Explorer using the context menu.
• DataDirect using the Inform IT History and Process Values Dialogs Browser.
3BUF001094-600 B 513
When opened from the Start menu, the utility will open but will not be connected to
any host. To log in to a host,
1. Select:
File > Connect
2. Enter the User Name, Password, and Host Name for the DBA Data Provider in
the Login dialog.
3. Click OK.
Default groups are provided. The display will update to list the tags for the groups
selected.
Figure 9.1: UTM Display
514 3BUF001094-600 B
9.1.2 Displaying User Tags, Hierarchical View

The hierarchical view has a primary system configuration group that automatically
gets log configuration and trend tags and displays them in the structure used in the
Plant Explorer Workplace. Additional public and private groups are added by the
user. Multiple levels of groups are supported. A description for the group name is
provided.
No tags are listed in the 800xA System Configurations node. Expanding the Log
Configurations node or the Trend Aspect node and some of its children nodes will
show a group for each part of an object path down to any Log Configuration Aspects
or Trend Aspects.
For instance, if Root/Area1/Group1/ObjectA has a Log Configuration Aspect, the
hierarchy (from parent to child) will read:
Root
Area1
Group1
ObjectA
Groups and tags can be categorized in any logical way using the Public and Private
groups. For instance, a group called Boilers may contain all the tags, both History
and Real Time, associated with all the boilers in the system, regardless of where they
are configured the 800xA System. The default groups and system groups can not be
added or deleted.
Refer to Managing User Groups on page 518 for information on adding, deleting, and
finding groups and using the UTM Display Workspace to add tags to a group.
Displaying Tag Information

Select a node with log configuration or trend tags to list all associated logs. Information
about the tags comes from the tag database and is displayed in the columns to the
right. All logs associated with a Trend aspect, except TRIM logs, are shown with a
Trend icon ( ).
Use the System Groups, Private User Groups, and Public User Groups check
boxes to control which groups are displayed (check box is enabled) or not displayed
(check box is disabled).
3BUF001094-600 B 515
9.1.3 Displaying User Tags, Search View

The search view options, Figure 9.1, allow quick access to specific groups and tags
or to a number of groups and tags by using various search tools. The tag results of
the search can be added to the Tag Workspace and the group results can be used to
go directly to a group (Go To Group context menu item) in the hierarchical view.
Results include, tag name, display name, and group.
Table 9.1: Search Options
Basic Search Options

By default, the most basic search type is shown (search all group names and tag names
for a group and/or tag that matches the name specified by the user). This can be lim-
ited by disabling the Match Group Names or Match Tags Names check boxes. Use
the Search String field to enter the search string. The single character wildcard is ?
and the mixed character wildcard is *. These can be used in combination. Upper and
lower case characters can be distinguished enabling the Match Case check box. En-
516 3BUF001094-600 B
abling the Seamless Tags Only check box limits the search to tags without logs. As
searches are run, they are kept in a list in the Previous Searches field for reuse.
The behavior is as follows when the Match Group Names check box is enabled.
This behavior is independent of the status (enabled/disabled) of the Match Tag Names
check box.
The tags that appear in the right pane of the search window are those found within
the group entered into the search string. If the search string has no wild card and
matches the group name text exactly, it displays all tags within that group. If a wildcard
is used, it returns all tags found within any group that match the wildcard search
string. Expanding the full path of a returned tag reveals the source of the tag.
Group Search Options

Enable the Search System Groups check box to search only the system groups or
enable the Search Public/Private Groups check box to search the public and private
groups. If the Search System Groups check box is enabled, use the browse button
(...) to select a group. For greater resolution on selecting what group to search, select
the Set Groups To Search option. Use the browse button (...) to select a group.
Use the results for quick access to a group. Select an entry from the search results on
the right, and select Go To Group... from the context menu and the group requested
is displayed in the hierarchical view.
Searching and Adding Tags to Workspace

After all search options and rules are set, click the Search button. The list on the right
should return the matched tags and/or groups. A label at the top right shows how
many matches were returned.
Drag and drop the desired tags in the list to the Tag Workspace (Figure 9.2). Option-
ally, use the context menu to copy and paste selected tags into the Tag Workspace.
To select all of the tags in the list, select Select All Tags from the context menu.
3BUF001094-600 B 517
Table 9.2: Search Results and Tag Workspace
9.1.4 Displaying User Tags, HDA Browser

The HDABrowser control is described in Information Management Browser on page
524. Click the Change button (or press enter when in the Data Provider text box) sets
the DataProvider property, and attempts to connect the browser to that data provider,
if the browser is connected to a server.
9.1.5 Managing User Groups

Five default groups are provided:
• 800xA System Configuration.
– Log Configurations.
– Trend Configurations.
• Public Groups: Displays any combination of tags for all users.
518 3BUF001094-600 B
• Private Groups: Displays any combination of tags for logged on user. It is dis-
played as logged on user name’s, Groups.
The System Groups hierarchy does not allow changes to the groups and tags.
Only public and private groups allow groups and tags to be added, deleted, and
modified.
Adding Public and Private Groups

Additional public and private groups of tags can be established.
1. Open the Public or Private group where a group is to be added.
2. Right-click and select New Group from the context menu.
3. Enter the group name.
4. Click OK.
Deleting Public and Private Groups

Select the Delete Group context menu item to delete a group after confirmation. If
allowed, all sub groups and their associated tags are also deleted.
Renaming Public and Private Groups

Select the Rename Group context menu item renames a group.
Cut, Copy and Paste Groups

Group edit functions are performed on groups from the hierarchical group tree. Any
group can be copied; however, only public and private groups can be cut or have a
group pasted into them. To copy groups:
1. Select the Copy Group context menu item to copy the groups and tags within
those groups.
2. Highlight the folder where it is desired to paste the groups and tags.
3. Right-click and select Paste Group from the context menu.
To copy and past only the tags within a group:
1. Select the Copy Tag(s) context menu item to copy the desired tags in the tag
list.
3BUF001094-600 B 519
2. Place the cursor in the list area for the group where the tags are to be pasted and
select Paste.
Export and Import Groups and Export Options

The Export Group feature is used to save groups and their tags to an XML file. In
addition, related information, such as the parent groups is also included and is used
to import the tags and groups back to their same location.
The Import Group feature is used to read saved groups and their tags back into the
public and private group hierarchy using the exported location information.
Go To Group
Select the Go To Group context menu item to find a group or find the next group
when in the hierarchical view.
View Group in Desktop Trends and View Tag(s) in Desktop Trends

The View Group in Desktop Trends selection is available when a Group with tags
is selected. The View Tag(s) in Desktop Trends selection is available when tags in
a group are selected.
9.1.6 Managing User Tags Using Tag Workspace

Use the Tag Workspace (Figure 9.3) to build up, modify, and save tag groups, either
as Public Groups or Private Groups.
The Add Tags button is only available when the utility is launched from DataDirect
or Desktop Trends. It is used to add tags directly to the spreadsheet or trend
without having to use the Tag Workspace.
520 3BUF001094-600 B
Table 9.3: Tag Workspace
Adding Tags to Workspace

After tags are found, they can be added to the Tag Workspace by copying and pasting,
or by dragging and dropping. If a tag already exists in the Tag Workspace, then a
warning dialog appears before allowing the tag to be added as a copy, replaced, or
skipped. An Apply to All Items check box can be used to apply to multiple tags when
enabled.
Tag Workspace Toolbar

The Tag Workspace Toolbar (Figure 9.4) includes group functions (Open Group,
Close, Save, and Save Group As), edit functions (Cut, Copy, Paste, Delete, and
View/Edit Tag Info), and a Launch Desktop Trends button. In addition, the context
menu supports the ability to Select All Tags.
Table 9.4: Tag Workspace Toolbar
3BUF001094-600 B 521
9 Tag Management 9.2 Using UTM from Desktop Tools
Editing Tag Presentation Information

Presentation information (Minimum, Maximum, Scale Min, Scale Max, Eng Units,
and Scope) can be edited to best match the presentation of the tags in the group. This
configuration information is used when launching a trend from this tag manager. If
the scales are set the same, then a default of 100 to -100 is used.
9.2 Using UTM from Desktop Tools

The UTM utility is accessible from the following desktop tools:
• A UTM button in Desktop Trends.
• The User Tag Management context menu from Ticker and Tag Explorer (User
Tag Management).
• The DataDirect menu from Excel, select:
DataDirect > Inform IT > History Values or Inform IT > Process Values
Next, select the User Tag Management tab, Figure 9.2, and click Browse.
522 3BUF001094-600 B
9 Tag Management 9.3 User Tag Management Status
Figure 9.2: DataDirect’s Inform IT History Values User Tag Management Tab
The Browse button accesses the UTM utility. Find and select tags to add directly to
the spreadsheet or trend using the Add Tags button. The Clear List and Remove
Selected buttons aid in managing the list.
9.3 User Tag Management Status

The User Tag Management Status display retrieves information about groups and
tags in the system.
1. Select the Inform IT History Object under the applicable node in the Node
Administration structure.
2. Select the Inform IT History Control aspect.
3. Select User Tag Management under Maintenance in the left pane to view the
User Tag Management Status in the right pane (Figure 9.5).
3BUF001094-600 B 523
9 Tag Management 9.4 Information Management Browser
4. Click Update. This populates the database with all the tags (and associated
groups) from the Log Configuration and Trend aspects in the system.
Update is typically a one-time operation to build system groups. It must be run
to get new system groups when new tags are added to the system.
Running Update on an Information Management node in a Multisystem Integration
Subscriber system does not retrieve tags and groups for Log Configuration and
Trend Display aspects found in the Multisystem Integration Provider system.
Table 9.5: User Tag Management Status
The Clear button is used to clear the database of user tags. When clicked, a warning
dialog is displayed if there is information saved in the database. Click No in the
warning dialog to close it without loss of data. Click Yes in the warning dialog to
close it and clear the group and client tag tables of data.
The Refresh button refreshes the view.
9.4 Information Management Browser

The Information Management Browser (Figure 9.6) helps when finding and selecting
OPC objects on the connected OPC DA or OPC HDA server for real-time and histor-
ical data access. The browser can be launched from the Process and History Values
524 3BUF001094-600 B
dialogs in DataDirect, the Trend or Ticker display in Desktop Trends, or it may be

launched from the Windows Taskbar to support Open Data Access.
Table 9.6: Information Management Browser
When using the browser with DataDirect or Desktop Trends dialogs, the selected tags
are automatically entered into the applicable tag selection field or list in the dialog.
When using the browser for ODA (or for DataDirect function calls), the browser is
used to copy the selected tag names to paste in a data query application, for example
Microsoft Query or Crystal Reports.
This section describes how to use the browser when launched from the Windows
Taskbar. Instructions for DataDirect and Desktop Trend applications are provided in
the respective sections. The basic steps for using the browser are described below.
Details are provided in the referenced sections.
1. Launch the browser from the Windows Taskbar. Select:
3BUF001094-600 B 525
ABB Start Menu > ABB System 800xA > Information Mgmt > Utilities >
IM Structure Browser
2. By default, the Information Management Browser connects to the server specified
in the ACC Setup dialog. The connected server is indicated in the Connected To:
field. To specify a different server, click the Connect/Change Connection button
(Figure 9.6) and then specify the IP address or host name for the new server in
the Connection dialog.
The browser uses the AIPHDA data provider (for History log access) by default. The
Data Provider specification determines the type of tags that can be accessed through
the browser:
• AIPOPC is used to browse for real-time (process or softpoint) tags.
• AIPHDA connects to the 800xA OPC HDA server and is used to browse the
Aspect Directory for numeric property logs. This supports seamless access to
trend logs and history logs. It also is used to access log attributes.
• IMHDA connects to an alternative OPC HDA server. For further information,
refer to Appendix C.
The mode of operation for the browser differs slightly depending on whether
AIPHDA or IMHDA is being used. For further information, refer to Considerations
for History Access on page 527.
The data provider specification defaults to AIPHDA. To change the specification,
click inside the Data Provider field, enter the data provider name, then click
Change (Figure 9.6).
1. Use the browser according to the guidelines in Navigation Methods on page 526
and Filtering on page 527. Also, for history access applications, refer to Consid-
erations for History Access on page 527.
2. Copy one or more tags to paste in the client application. Refer to Copying Items
on page 527.
9.4.1 Navigation Methods

Use the left pane to browse the directory structure of the connected server to find the
folders where the data objects reside. The applicable objects within the selected
folders will be displayed in the right pane. The type of object displayed depends on
the specified data provider.
Two navigation options are supported.
526 3BUF001094-600 B
• Selecting a specific folder will show the applicable objects within that folder.
• Use the Get Entire List function from the context menu. This gets not only the
objects in the selected folder, but also the objects from sub-folders within the
selected folder. To get the entire list, select the folder, then right-click and choose
Get Entire List.
To avoid overloading the system when using Get Entire List, limit the number
of objects to be returned to 500 or less (i.e. DO NOT select an object too high in
the object structure). If an excessive number of objects is accidentally requested,
abort the Get Entire List request by selecting Abort Get Entire List from the
context menu.
9.4.2 Filtering
Specify a filter to narrow the scope of items returned by the Get Entire List method.
This helps keep the list at a manageable size. For example:
• IM - gets all items whose name includes the text string IM.
• *IM - gets all items whose name ends with the text string IM.
• IM* - gets all items whose name starts with the text string IM.
Enabling the Exclude Filtered Items check box retrieves all items whose names DO
NOT meet the filter criteria. For example, enabling this check box with the filter text
IM will get all items whose names do not include the IM text string.
9.4.3 Copying Items

The Copy Item(s) function in the context menu is used to copy the selected items to
the clipboard. From there the items can be pasted into an external data access appli-
cation such as Microsoft Query or Crystal Reports.
1. Select the desired items in the right-pane.
2. Right-click and select Copy Item(s) from the context menu.
3. Paste the copied items into the external application.
9.4.4 Considerations for History Access

When using the browser for History access, the contents of the left pane varies, de-
pending on the type of OPC HDA server.
3BUF001094-600 B 527
AIPHDA Access
For AIPHDA, the browser, Figure 9.3, provides a directory structure similar to the
Plant Explorer and includes all structures and directories where log aspects reside.
With the AIPHDA server, the Seamless retrieval option can be used when it is uncer-
tain which log in a property log hierarchy will provide the best coverage for the re-
quired time range. When the Seamless option is not used, the browser passes the
query application the name of a specific component log in the property log hierarchy.
This limits the query to the time range covered by that log. With Seamless retrieval,
the browser passes the query application the base name of the property log. This lets
the query retrieve data from any component log within the property log. To use
seamless retrieval rather than select a specific log, enable the Seamless check box.
IMHDA Access
For IMHDA, the left pane is used to choose one of three paths or categories by which
to conduct a search, Figure 9.3 (LOGMAN is not applicable):
• EH is used to access logs that are local to the connected data provider. This is
the fastest method and is recommended when querying a log that resides on the
local server. It supports the ability to modify existing log entries, but it does not
support adding new entries.
• EH_NET is used to access logs on all servers on the network. This requires OMF
access to be extended on the TCP/IP network. It supports the ability to modify
existing log entries, and add new entries.
• EH_PUBL is used to access archived log data that is published. Publishing
archived data is described in Publishing an Archive Volume on page 573.
528 3BUF001094-600 B
Figure 9.3: IMHDA Access
3BUF001094-600 B 529
530 3BUF001094-600 B
10 Reading and Managing Archiv
10 Reading and Managing Archive Data
The archive function supports permanent offline storage for historical data collected
in property (numeric), message, PDL, and report logs as well as reports stored as
Completed Report objects. Archiving is set up during Information Management
configuration. This section describes how to make archive data available for desktop
applications such as DataDirect, how to perform manual archives, and how to maintain
archive data. This includes:
• Maintaining archive media - When an archive media becomes full it will require
maintenance to permit archive operations to continue. For MO media, periodically
remove and replace platters. For hard disks, ensure that archive entries are saved
to a removable media (CD or DVD). After entries have been saved to a removable
media, the hard disk must be periodically purged of old entries to provide space
for new entries.
• Formatting and initializing archive media - The archive media must be format-
ted and initialized before data can be stored on it. For MO drives, use the Windows
disk formatting tool to format each new platter before initializing it. Select the
NTFS format. Both sides of the platter need to be formatted.
For timed archiving, the media are re-initialized automatically as long as the
device behavior is set to either Wrap When Full or Advance When Full. For
manual archiving, manually initialize the media.
• Manual archiving.
• Publishing archive volumes for access by external applications - Archive
volumes can be published to let client applications such as DataDirect access the
archived data. This saves from having to restore individual logs from the archive
volumes. Publishing applies to propertyand profile and message logs only.
• Restoring archived logs for access by external applications - To access
archived log data that has not, or cannot be published, restore the archived logs
from the archive media to the restored History database. Restored logs may also
be deleted when they are no longer needed.
3BUF001094-600 B 531
10 Reading and Managing Archiv 10.1 User Interface
• Importing archive data from other 800xA Systems and from earlier historian
platforms - This is done using the Archive Import tool.
10.1 User Interface

The user interface for runtime archive operations is supported by four basic displays:
the archive device aspect - main view, archive volume aspect main view, archive
group aspect, and view logs aspect. The functions that each aspect supports, and
general operating instructions are described in User Interface for Managing Archive
Data on page 533.
10.2 Archive Operations

Basic archive operations are organized into four categories:
• Maintaining Archive Media on page 550 describes:
Removing/Replacing Platters on page 551
Activating/Deactivating an Archive Device on page 551
Remounting a Volume on page 552
Initializing an Archive Volume on page 553
Copying Volumes on page 556
Overriding Volume Backup on page 558
• Archiving Logs Manually on page 558 describes how to perform ad-hoc archive
operations for archive groups, or selected logs.
• Verifying Archive Data on page 570 describes how to verify electronic signatures
on an archive volume to determine whether or not the volume has been altered
without authorization.
• Making Archived Data Available to Client Applications on page 572 describes
how to publish volumes and/or restore archived data from the archive media.
To import archived data from other 800xA Systems or from earlier historian platforms,
refer to Importing Archive Data on page 588.
532 3BUF001094-600 B
10 Reading and Managing Archiv 10.3 User Interface for Managing Archive Dat
10.3 User Interface for Managing Archive Data

The user interface for runtime archive operations is supported by four basic displays:
• the archive device aspect - main view - provides device- and volume-level in-
formation for an archive device. It supports remounting and initialization of
volumes, as well as publishing and unpublishing of volumes. The archive volume
aspect of a selected volume can also be opened from this view. Refer to Archive
Device Aspect on page 533.
• the archive volume aspect provides detailed information for a volume. This
includes a listing of the archive entries currently stored within the volume, and
a listing of the items (logs and/or aspect objects) within a selected entry. This
view is used to restore archive entries from the volume to the restored database.
As an option, select individual message or report logs within an entry to restore.
This view also supports initialization of volumes, as well as publishing and un-
publishing of volumes. Refer to Archive Volume Aspect on page 537.
• the archive group aspect lists all archive groups configured in the system. It
supports manual archiving on an archive group basis. Archive group configura-
tions may be added, deleted, and modified from this view. Refer to Archive
Group Aspect on page 542.
• the view logs aspects. There are three view log aspects: one for numeric and
message logs, one for report logs, and one for PDLs. These aspects provide access
to a directory of logs that reside in the runtime and restored databases. These
views support manual archiving on an individual log basis, and deletion of restored
logs from the restored database. Refer to:
• View Logs Aspect on page 544.
• View Report Logs Aspect on page 546.
• View Production Data Logs Aspect on page 548.
10.3.1 Archive Device Aspect

The Archive Device aspect has two views. The config view is used to configure the
archive device. The main view, Figure 10.1, provides a user interface for managing
the archive volumes on the archive device. This view provides device- and volume-
level information for an archive device. It supports remounting and initialization of
3BUF001094-600 B 533
volumes, as well as publishing and unpublishing of volumes. The Archive Volume

Aspect of a selected volume can also be opened from this view.
The aspect view is displayed by selecting the archive device aspect in the archive
device object’s aspect list. Toggle between the config and main views by right
clicking the aspect and choosing config view or main view from the context menu.
The view selector icon, Figure 10.1, is used to display the selected view in a separate
window.
Node
Archive
Service
Object
View
Selector
Figure 10.1: Archive Device Aspect - Main View
The functions supported by this aspect are listed in Supported Functions on page 535.
The information provided on this aspect is described in Archive Device Information
on page 536.
534 3BUF001094-600 B
Supported Functions
The archive functions supported by this aspect are described in Table 10.1. These
functions are available through the context menu and Actions button, Figure 10.2.
Table 10.1: Archive Functions Supported by the Archive Device Aspect - Main View
Function Description
Opening an Archive Volume from the Alternative to accessing a volume directly from the
Archive Device Aspect. browser. To do this, select the volume, then right click
and choose Open from the context menu. This opens the
aspect in a separate window.
Remounting a Volume on page 552 Volumes should be remounted prior to initializing. Also,
remount a volume to refresh the volume information on
the archive device aspect.
Initializing an Archive Volume on page Each new archive volume must be initialized prior to
553 archiving data on it. For scheduled archives, volumes are
automatically initialized if the device behavior is set to
Advance When Full or Wrap When Full. For manual
archives, the volume must be manually initialized.
Archiving Logs Manually on page 558 Alternative to scheduled archives.
Mark Volume Full Marks a volume full to prevent any additional timed
archives from writing to the volume.
Publishing an Archive Volume on page Recommended method for making archived numeric data
573 available for data access.
Overriding Volume Backup on page 558 There are certain situations when a volume may need to
be marked as backed up, even though the volume has
not been backed up.
Activating/Deactivating an Archive Device must be active to perform archive operations. MO
Device on page 551. devices must be deactivated to change platters.
Showing Volume Information on page
586.
3BUF001094-600 B 535
Actions
Button
B
OR
Context
Menu
Figure 10.2: Commands Available on the Archive Device Aspect
Archive Device Information

The device and volume information provided in this aspect is described in Table 10.2.
Table 10.2: Archive Device Aspect Main View
Field Description
Device Name Name assigned to archive device when the device was configured.
Device State Current state of the device: Idle or Active.
Active Volume Indicates which volume is currently active.
Volume Indicates the Volume number (Volume Index).
Volume ID For scheduled archive, the volume ID is auto-generated based on the
configured Next label and Volume Format attributes. For manual archive, the
volume ID must be specified in the Initialize Volume dialog.
536 3BUF001094-600 B
Table 10.2: Archive Device Aspect Main View

(Continued)
Field Description
(Volume) State Indicates the state of the volume. Possible states are:
VALID If the media is initialized and has space for archiving
additional information includes: Fully Published or Partially Published
and if the media is from HPUX, HP-UX will be shown.
NOT_INIT Not initialized but configured in the device, or corrupt
FULL When archive is unable to archive in this volume due to not enough
space, then media becomes FULL.
NO_MEDIA There is no media present in this slot.
Timeout Overwrite timeout for this volume as specified when the volume was
initialized.This specifies the delay between the time when the volume becomes
full and the time when the volume can be re initialized (overwritten).
Usage Indicates the amount of space that is currently occupied on this volume.
Init Time Time when the volume was initialized.
Last Archive Time Time when the last archive entry was written to this volume.
10.3.2 Archive Volume Aspect

The Archive Volume aspect provides a user interface for managing an archive volume
and provides detailed information for the volume, Figure 10.3. This includes a listing
of the archive entries currently stored within the volume, and a listing of the logs
within a selected entry. This view is used to restore archive entries from the volume
to the restored database. As an option, select individual logs within an entry to restore.
This view also supports initialization of volumes, as well as publishing and unpublish-
ing of volumes.
Archive Volume objects are located under their respective archive device object which
is typically under an Industrial IT Archive service provider object in the Node Admin-
istration structure.
The aspect view is displayed by selecting the archive volume aspect in the aspect list.
This aspect is organized in three parts. The top section provides information for the
selected volume. The middle section lists the entries currently stored on this volume.
3BUF001094-600 B 537
When an entry is selected in the middle section, the logs that were archived for the
selected entry are shown in the bottom section.
The functions supported by this aspect are listed in Supported Functions on page 539.
The information provided on this aspect is described in Archive Volume Aspect In-
formation on page 540.
Figure 10.3: Archive Volume Aspect
538 3BUF001094-600 B
Supported Functions
The archive functions supported by this aspect are described in Table 10.3.
Table 10.3: Archive Functions for Archive Volume Aspect
Initializing an Archive Volume on Each new archive volume must be initialized prior to archiving
page 553 data on it. For scheduled archives, volumes are automatically
initialized if the device behavior is set to Advance When Full or
Wrap When Full. For manual archives, the volume must be
manually initialized.
Publishing an Archive Volume on Method for making archived numeric and message data available
page 573 for data access.
Restoring Logs from Archive Archived data must be restored to the runtime historical database
Media to Restored Database on before it can be viewed with a desktop data access tool such as
page 577 DataDirect. For numeric logs, always publish rather than restore.
Showing Volume Information on
page 586
Showing Platform Information for Provides access to aspects of the selected object(s), for example,
a Log on page 586 the Log Configuration aspect.
Verifying Signatures for a Volume Used to verify electronic signatures on a volume to determine
on page 571 whether or not the contents of the volume have been altered
without authorization.
Showing Signature Information Used to view the signature information for a volume
for a Volume on page 572
Copying Volumes on page 556 Used to manually back up archive volumes.
All functions are through the Actions button, Figure 10.4. Some may also be invoked
through the context menu (Restore Archive, Restore Logs, and Platform Info).
3BUF001094-600 B 539
Figure 10.4: Commands Available on the Archive Volume Aspect
Archive Volume Aspect Information

The information provided on this aspect is organized in three parts. The top section
provides information for the selected volume, Table 10.4. The middle section lists
the entries currently stored on this volume, Table 10.5. When an entry is selected in
540 3BUF001094-600 B
the middle section, the logs that were archived for the selected entry are shown in the
bottom section, Table 10.6.
Table 10.4: Volume Information - Top Section
Field Description
Volume ID For scheduled archive, the volume ID is auto-generated based on
the configured Next label and Volume Format attributes. For manual
archive, the volume ID must be specified in the Initialize Volume
dialog.
Volume Label Optional descriptor to further identify the volume.
Volume State Indicates the volume state. Possible states are:
No Media, Not Initialized, Valid, and Full
additional information for Valid includes:
Fully Published or Partially Published
and if the media is from HPUX, HP-UX will be shown.
Archive Entries Number of occasions when data have been archived to this volume
(number of archive entries written to the volume).
Data Mbytes Used Amount of log data in megabytes stored on the volume.
Directory Mbytes Used Amount of data in megabytes stored on the volume.
Total Mbytes Media Total amount of data (log data and directory data combined) in
megabytes stored on the volume. If the total for Data and Directory
combined exceeds 4 gigabytes, this number is the quantity in excess
of 4 gigabytes.
Table 10.5: Entry Information - Middle Section
Field Description
Index Sequential number
Type How archive was initiated - Scheduled or Manual
Archive Time When the archive entry occurred.
Logs Number of logs that were archived for this entry.
3BUF001094-600 B 541
Table 10.5: Entry Information - Middle Section

(Continued)
Field Description
Archive Group Archive Group through which this entry was archived.
Description Optional description given to this entry (either through manual archive dialog,
or archive action plug-in when scheduled)
Table 10.6: Log Information for Selected Entry - Bottom Section
Field Description
Index Sequential number
Type Numeric, IM object, or Platform Object as specified in the archive group
Start Time Start time for archived data.
End Time End time for archived data.
Entries Number of log entries archived for this log.
Log Name Log name.
10.3.3 Archive Group Aspect

The Archive Group aspect lists all archive groups configured in the system, Figure
10.5. Typically, only one such aspect is required; however, additional archive group
aspects may be created for organizational purposes. This aspect is used to perform
manual archives on a group basis. This is described in Manual Archiving for Archive
Groups on page 559. In addition, archive group configurations may be added, deleted,
and modified.
The upper pane in this aspect indicates the following for each group: name, state,
service group, number of items (logs) in the group, and description. When an archive
group is selected, a list of the entries assigned to the selected group is displayed in
the lower pane.
For each entry, the lower pane indicates the entry type. If the entry was added through
the Add Group Entry function on the Archive Group aspect, the type will be indicated
as numeric, IM Object (message or report log), or Platform Object (completed report
stored as file viewer aspect). Also the selected root object will be indicated in the
details column. If the entry was added by entering the Archive group name on a log
542 3BUF001094-600 B
configuration template (Property, Message, or Report log), the type will be indicated
as Ref By Name, and the number of logs referenced by name for that group will be
indicated in the Details column.
Further details related to archive group entries are accessible through the List Group
Items function.
Figure 10.5: Archive Group Aspect
The functions supported by this aspect are described in Supported Functions.
Supported Functions
The runtime functions supported by this aspect are described in Table 10.7. Some
functions are related to archive group configuration. These are described in System
3BUF001094-600 B 543
800xA Information Management Configuration (3BUF001092*). All functions are

available through the Action button and context menu, Figure 10.6.
Table 10.7: Functions Supported by Archive Group Aspect
Archiving Logs Manually on page 558 An alternative to scheduled archiving.
Resetting the Last Archive Time for an If needed, reset the last archive time to cause the next
Archive Group on page 585 archive operation to go back farther in time, for example
to account for a failed archive, or skip ahead to a later
time.
List Group Items on page 585 Used to determine the exact content of an archive
group (items contained within the archive entries).
Figure 10.6: Archive Group Aspect Context Menu
10.3.4 View Logs Aspect

The Inform IT History View Logs aspect provides access to a directory of property
logs and message logs that reside in the runtime and restored databases, Figure 10.7.
This aspect is used to:
• manually archive data for property and message logs. Refer to Archiving Logs
Manually on page 558.
• delete restored message logs from the restored History database. Refer to Deleting
Restored Logs on page 583.
544 3BUF001094-600 B
Figure 10.7: View Logs Aspect
The information provided in this aspect is described in Table 10.8.

Table 10.8: View Logs Aspect
Field Description
Archive Group Indicates the archive group to which a displayed log is assigned.
Status Indicates whether the status of a displayed log is ACTIVE or INACTIVE.
Log Name Indicates the name of the displayed log.
3BUF001094-600 B 545
10.3.5 View Report Logs Aspect

The Inform IT History View Report Logs aspect provides access to a directory of
report logs that reside in the runtime and restored databases. The report logs are listed
in the upper pane, and the reports for a selected log are listed in the lower pane, Figure
10.8. The information provided in this aspect is described in Table 10.9. This aspect
is used to:
• view reports stored in a selected report log. Refer to Viewing Reports Stored in
a Report Log on page 548.
• manually archive data for report logs. Refer to Archiving Logs Manually on page
558.
• delete restored report logs from the restored History database. Refer to Deleting
Restored Logs on page 583.
546 3BUF001094-600 B
Figure 10.8: View Report Logs Aspect
Field Description
Log Type Indicates the type of logs displayed REPORT is only valid type.
3BUF001094-600 B 547

(Continued)
Field Description
Status Indicates the status of a displayed log: ACTIVE or INACTIVE.
Log name Indicates the name of the displayed log.
Execution Time Lists the execution times for the reports.
Stored Time Lists the times when the executed report was stored.
User Name Lists the user that executed the report.
Report Name Lists the name of the report that was executed.
Viewing Reports Stored in a Report Log

To view a report stored in a report log:
1. Click the Retrieve tab.
2. Enter the retrieval criteria, then click Retrieve.
3. In the upper pane, select the log which contains the report that to be viewed.
4. In the lower pane, select the report.
5. Click View Selected Report.
10.3.6 View Production Data Logs Aspect

This aspect provides access to a directory of Production Data Logs (PDLs) that reside
in the runtime and restored databases, Figure 10.9. This aspect is used to:
• manually archive data for PDLs. Refer to Manually Archiving PDLs on page
567.
• delete restored PDLs from the restored History database. Refer to Deleting Re-
stored Logs on page 583.
• delete runtime PDLs and tasks from the runtime database. Refer to Deleting
Restored PDLs and Tasks on page 584.
This window displays the following information for PDLs and their corresponding
tasks, Table 10.10.
548 3BUF001094-600 B
Figure 10.9: View Production Data Logs Aspect
Table 10.10: View Production Data Logs
Field Description
Log Type Indicates the type of logs displayed. PDL is only valid type.
Log Name The log name is derived from the name of the root task. When a log is
selected from this list, the associated tasks are displayed in the Task field.
3BUF001094-600 B 549
Table 10.10: View Production Data Logs

(Continued)
Field Description
Task If the PDL is a job created by Batch 300, Task is a list of batches in the job.
If the PDL is a batch created by TCL, Task is the same as the log name.
Start Time & End Start Time & End Time specify the time range for the Batch or Job
Time Fields
10.3.7 Maintaining Archive Media

The media where archive data is written will eventually become full and need to be
replaced or erased to make room for new archive data. When an archive device is
configured, consider generating an alarm message when the media is approaching
full capacity. These messages are stored by 800xA System message services (and
IMMSGLOG when Information Management History Services is installed and the
message log is configured). Use a desktop application, such as DataDirect, to read
these messages periodically to check the status of the archive media.
MO Media
For MO archive media, the platter must be removed and replaced when it becomes
full. The new platter must then be initialized. Refer to:
• Removing/Replacing Platters on page 551.
• Initializing an Archive Volume on page 553.
Hard Disk Media

When archiving to a hard disk, it is strongly recommended that an archive backup
function be configured. With archive backup, when a volume becomes full, the con-
tents are written to an ISO Image file at a specified location. These files can then be
burned onto CD ROM or DVD media for permanent storage. Rather than write ISO
image files, specify that a backup copy of the archive be created at the specified loca-
tion. Both an ISO image and a shadow copy can be created. Once the entries have
been saved to a removable media, the hard disk must be periodically purged of old
entries to provide space for new entries.
550 3BUF001094-600 B
Other Maintenance Operations

This section also covers:
• Activating/Deactivating an Archive Device on page 551.
• Remounting a Volume on page 552.
• Copying Volumes on page 556.
• Overriding Volume Backup on page 558.
10.3.8 Removing/Replacing Platters

If MO media is being used for archiving, the platter in the MO drive must be changed
periodically as the platter is filled. To remove the platter, first deactivate the device
as described in Activating/Deactivating an Archive Device on page 551. If the platter
still cannot be removed, power down the MO drive, then power it up and remove the
platter. Once the platter is replaced, use the Windows disk formatting tool to format
the new platter. This is illustrated in Figure 10.10. Select the NTFS file system. This
procedure must be done for both sides of the platter.
Figure 10.10: Using the Windows Disk Formatting Tool Option
10.3.9 Activating/Deactivating an Archive Device

The device must be active in order to archive data to, or restore data from the device.
When the archive media is MO Drive, the corresponding archive device must be de-
activated to remove and replace a platter. To activate/deactivate an archive device,
3BUF001094-600 B 551
go to the Archive Device Aspectmain view, click Actions and choose Activate or
Deactivate, Figure 10.11.
Figure 10.11: Activating an Archive Device
10.3.10 Remounting a Volume

Volumes should be remounted prior to initializing. A volume may also be remounted
to refresh the volume information on the archive device aspect. Remounting is per-
formed through the Archive Device Aspect. To remount a volume, select the volume
on the archive device aspect, right click and choose Remount from the context menu,
Figure 10.12.
Or use the
Actions button
Figure 10.12: Remounting a Volume
552 3BUF001094-600 B
10.3.11 Initializing an Archive Volume

Each new archive volume must be initialized prior to archiving data on it. For
scheduled archives, volumes are automatically initialized if the device behavior is
set to Advance When Full or Wrap When Full. For manual archives, the volume
must be manually initialized.
For MO drives, before the archive volume is initialized, make sure the media has
been formatted as described in Removing/Replacing Platters on page 551.
Initialization of archive volumes may be done using the archive device aspect for the
archive device whose volume needs to be initialized, or the Archive Volume As-
pectmay be used.
To initialize a volume:
1. Install the archive media in the disk drive.
2. Navigate to and select either the archive device aspect whose volume is being
initialized, or select the applicable Archive Volume Aspect.
3. If the archive volume aspect is being used, invoke the Initialize command from
the Action button or context menu, Figure 10.13.
Figure 10.13: Initializing a Volume From the Archive Volume Aspect
3BUF001094-600 B 553
Then skip steps 4 and 5 which pertain only when using the archive device aspect.
Resume the procedure at Step 6..
4. If the archive device aspect is being used, select and remount the volume. This
is not required when using the archive volume aspect.
Always remount a volume BEFORE initializing it from the archive device aspect.
The information in the archive device aspect is not automatically updated when
a new archive media is inserted, and so may not accurately indicate the current
contents of the archive device. Remounting the volume will ensure that the se-
lected volume is actually installed in the archive device. To do this, select the
volume, right click and choose Remount from the context menu (Remounting
a Volume on page 552).
5. If the archive device aspect is being used, once the volume has been remounted,
re-select the volume, right click and choose Initialize from the context menu,
Figure 10.14.
Figure 10.14: Initializing the Selected Volume
6. Whether the archive volume aspect or the archive device aspect is being used,
invoking the Initialize command displays the Initialize Volume dialog, Figure
10.15.
554 3BUF001094-600 B
Figure 10.15: Initialize Archive Media Window
The Volume ID and Overwrite Timeout default to the values specified for all
volumes on the archive device config view. Use this dialog to change these values
if necessary. As an option, enter a Volume Label. For further details regarding
these initialization parameters refer to Table 10.11.
7. Click OK to initialize the media. If the initialization parameters are specified
correctly, a message indicating the initialization was successful will be displayed
in the message box, and the Volume State will go to Valid, Figure 10.16. If one
or more parameters were defined incorrectly, an error message will be displayed.
If the Overwrite Timeout has not expired on the media being initialized, then
verify whether or not to overwrite it.
Table 10.11: Initializing Archive Media
Field Description
Overwrite This defaults to the Overwrite Timeout as configured in the Archive Device aspect’s
Timeout config view. The Overwrite Timeout specifies the delay between the time when a
media becomes full and the time when the media can be re-initialized (overwritten).
Set this to the duration for which the data must be preserved. For example, if data
must be preserved for one year, set the Overwrite Timeout to 365 days. This
means 365 days after the LAST data has been written to the media, the media
can be automatically initialized by archival if the media is in the drive.
Select a unit (Days, Hours, Minutes, Seconds), and then specify the number of
units, for example: 365 Days.
The Overwrite Timeout is stored on the media, so removing the media from the
drive for a period of time and then replacing it will not affect the Overwrite Timeout.
Volume ID This is a name assigned to this specific volume. The format was specified when
the archive device was configured.
3BUF001094-600 B 555
Table 10.11: Initializing Archive Media

(Continued)
Field Description
Volume ID When a formatted string is entered in the Volume ID field, the format characters
Evaluated are replaced with corresponding values in this field. The # signs will be replaced
by the configured next label when the media is actually initialized.
Volume Label This is an optional descriptor to further identify the media.
Figure 10.16: Initialize Successful Volume
10.3.12 Copying Volumes

Archive devices can be configured to automatically create shadow copies and/or ISO
images of archive volumes when those volumes become full. The Copy Volume
function is used to perform these functions on-demand. This function is available on
the Archive Volume aspect. Click the Action button and choose Copy Volume.
This displays the Copy Volume dialog, Figure 10.17. Use this dialog to specify the
copy volume parameters as described in Table 10.12. Click OK when done.
If the contents of the selected entries exceeds the specified Destination Quota, the
Copy Volume dialog will re-open, and it will be necessary to specify another
Destination Volume ID in order to continue copying entries.
Volumes backed up this way are not automatically marked as backed up. Use the
procedure in Overriding Volume Backup on page 558 to do this if necessary.
556 3BUF001094-600 B
Figure 10.17: Copy Volume Dialog
Table 10.12: Copy Volume Specification
Field Description
Source Volume ID Automatically filled in based on the volume whose aspect is selected.
Destination Volume Enter the Volume ID for the new copy. This is typically the same as the Source
ID Volume ID.
Destination Path Enter the full path to the location (drive\folder\folder...) where the copy will be
created.
Destination Volume Used to specify a new volume label. The default is to use the label of the
Label volume being copied.
Overwrite Timeout Used to specify a new overwrite timeout. The default is to use the overwrite
timeout of the volume being copied.
Include Archives Used to specify the range of archive entries to copy.
Destination Quota Used to specify a new quota. The default is to use the quota of the volume
being copied. The value is entered in megabytes (MB).
Temporary Storage
path
3BUF001094-600 B 557
10 Reading and Managing Archiv 10.4 Archiving Logs Manually
Table 10.12: Copy Volume Specification

(Continued)
Field Description
Overwrite This check box is used to specify whether or not to overwrite the current
Destination contents of the specified destination. Checking this box will allow the contents
of the destination directory to be overwritten.
Create ISO Image Checking this check box will create an ISO Image in addition to the shadow
copy in the specified destination.
Do Not Verify Used to specify whether or not to verify signatures. If signatures are verified,
Signatures the volume will not be copied if signatures are not verified.
Preserve Init Time This check box is used to specify whether or not to preserve the initialization
time stamp. Checking this box will preserve the time stamp.
10.3.13 Overriding Volume Backup

When archive backup is configured, volumes are marked as backed up whenever a
volume backup is successful. This indicates that the volume may be overwritten. The
archive service will not overwrite any volume that is not marked as backed up.
This function is used to mark a volume as backed up, whether or not the volume ac-
tually has been backed up.
To override a volume backup, go to the Archive Device Aspectmain view, click Ac-
tions and choose Override Volume Backup. This displays a warning message. Click
Yes to continue or No (or Cancel) to cancel.
10.4 Archiving Logs Manually

Typically, archiving is configured to occur periodically according to schedules con-
figured through the Application Scheduler. A manual (on-demand) archive may also
be performed. For manual archives, if the specified time range has no samples, no
data will be archived. There are two methods for performing a manual archive:
• Perform a manual archive of an archive group. This functionality is supported
by the Archive Group aspect. For details, refer to Manual Archiving for Archive
Groups on page 559.
558 3BUF001094-600 B
• Select logs to be archived. This functionality is provided by the view logs aspects.
For property (numeric) and report logs, refer to Manual Archiving Property and
Message Logs on an Ad-hoc Basis on page 560.
Manual archiving for PDLs is described in Manually Archiving PDLs on page
567.
10.4.1 Manual Archiving for Archive Groups

This procedure is done using the archive group aspect. This aspect provides a list of
all archive groups configured within the system. Other functions supported by this
aspect that may be useful for archiving on a group basis are:
• List Group Items on page 585.
• Resetting the Last Archive Time for an Archive Group on page 585.
To perform a manual archive of an archive group:
1. Select the Archive Group whose entries are to be manually archived, then right
click and choose Manual Archive from the context menu, Figure 10.18.
Figure 10.18: Selecting the Archive Group
This displays the Manual Archive dialog, Figure 10.19.
3BUF001094-600 B 559
Figure 10.19: Manual Archive Dialog
2. Specify the manual archive settings as described in Table 10.13.

Table 10.13: Manual Archive Settings
Parameter Description
Device Archive device to process the archive entry.
Volume Volume on selected archive device where archive entry
will be written
Start and End Times Time span for data to be archived.
Description Optional description to label the archive entry
10.4.2 Manual Archiving Property and Message Logs on an Ad-hoc Basis

This procedure is supported by the view log aspects (numeric/message or reports).
There are four basic steps. Details are provided in the referenced sections:
• Opening the View Logs Aspect on page 561.
• Retrieving Log Information on page 561.
• Filtering the Retrieved Logs List on page 563.
• Completing the Archive Request on page 564.
560 3BUF001094-600 B
Opening the View Logs Aspect

Manual archival is performed through the View Logs aspect for property/message
logs, and the View Report Logs aspect for report logs.
To display the applicable aspect (reference Figure 10.7):
1. Select the Node Administration structure in the Plant Explorer.
2. Select the History service provider for the node where the logs to be archived
are located (InformIT History_BasicYourNodeService Provider).
3. From the History service provider, navigate to and select one of the following
groups under InformIT History Object:
Numeric Log - for Property logs
Message Log - for Message logs
Report Log - for Report logs
4. Then select the View Logs aspect from the aspect list.
The window is empty when it is first opened. For the logs that will be archived, first
retrieve the log information. This procedure varies depending on the log type. For
numeric, message, and report logs continue with this procedure as described in Re-
trieving Log Information. For PDLs, refer to View Production Data Logs Aspect on
page 548.
Retrieving Log Information

For numeric, message, and report logs, start on the Retrieve tab. This tab is selected
by default. Logs can be retrieved based on location (History server), or archive group.
Enter the required information as described below.
To retrieve by current location:
1. Select Current Location from the Retrieve By pull-down list.
2. When retrieved by location, specify the log class and log type. The log class for
manual archival is Run Time.
(Restored is for deleting one or more restored logs from the restored database
(Deleting Restored Logs on page 583). Published logs is used to list logs that are
published on the selected volume.)
For log type, the choices are Numeric and Message. Log Type is not applicable
when retrieving information for report logs.
3BUF001094-600 B 561
3. Once the log class and type are specified, click Retrieve. The logs belonging to
the specified log class and type will be displayed in the log list on the bottom of
the View Logs aspect.
Figure 10.20: Retrieve Tab
To retrieve by archive group:

1. Select Archive Group from the Retrieve By pull-down list.
2. Select the archive group from the Group Name pull-down list, then click Retrieve.
Figure 10.21: Select Archive Group Dialog
The retrieved logs and corresponding information are displayed in the View Logs
window based on the specified location or archive group. An example is shown in
Figure 10.22.
The retrieved log list may be too large to manage. For example, the list in Figure
10.22 has 9000 logs. The Search tab is used to apply a filter to reduce the retrieved
log list. This is described in Filtering the Retrieved Logs List on page 563. Apply a
filter to reduce the log list if needed, then select the logs to be archived and complete
the archive as described in Completing the Archive Request on page 564.
562 3BUF001094-600 B
Figure 10.22: Example - Retrieved Log Information
Filtering the Retrieved Logs List

Reduce the number of logs displayed in the window by applying a filter based on a
user-defined combination of log name, archive group, and log status. To do this go
to the Search tab. Then specify one or more of the filtering criteria as described in
Table 10.14.
Table 10.14: Filter Criteria
Parameter Description
Log Name List logs whose name has the specified text string.
Archive Group List logs that belong to the specified archive group.
Log Status List logs that have the specified log status. When Not Used
is selected, both active and inactive logs are displayed.
Match All Conditions These option buttons are used to choose whether the search
Match Any Condition will include logs that match ANY one or more of the three
conditions described above, or only those logs that match
ALL three conditions.
3BUF001094-600 B 563
Wildcard Character - The * character is a wildcard. It can used as a substitute

for any character string in the Log Name or Archive Group fields. It can be used
in the beginning, end, and/or middle of a character string.
An example search specification and result are shown in Figure 10.23. This search
filtered the list to include only logs whose status is active, and whose names include
the text string 2-o (indicating second hierarchical log in a property log hierarchy).
This reduced the list from 9000 to 2250 items.
Figure 10.23: Example Search Specification and Result
Completing the Archive Request

Complete the archive request through the Archive tab.
First select the logs to be archived. Select any combination of contiguous and/or non-
contiguous logs from the list. An example is shown in Figure 10.24.
For Report logs, select the entries (Reports) to be archived, Figure 10.25.
After selecting the logs to archive, enter required information is described in Table
10.15. Specify the Archive Device and Surface (volume). Optionally, specify a Start
& End Time, and enter a description. Click Archive when finished.
564 3BUF001094-600 B
This completes the manual archive.

Table 10.15: Archive Tab
Field/Button Description
Archive Device Enter the name of the archive device where the logs will be
copied.
Surface (volume) This pick list is populated with the list of surfaces corresponding
to the selected archive device. The default choice is the active
surface.
Volume State This is a read-only field that indicates the status of the selected
volume.
Usage This is a read-only field that indicates the amount of space
already occupied on the selected volume.
Active Volume This is a read-only field that indicates the current volume where
timed archiving is writing data.
Start & End Time As an option, enter a time range for the archive. If a time range
is not specified, the entire log is archived.
Description Enter an optional description to identify this archive entry.
3BUF001094-600 B 565
Figure 10.24: Archive Tab - Numeric or Message Logs
566 3BUF001094-600 B
Figure 10.25: Archive Tab - Report Logs
10.4.3 Manually Archiving PDLs

Manual archival is performed through the View Production Data Logs aspect. To
display the this aspect:
1. Select the Node Administration structure in the Plant Explorer.
2. Select the History service provider for the node where the logs to be archived
are located (InformIT History_BasicYourNodeService Provider).
3. From the History service provider, navigate to and select the Production Data
Logs group under InformIT History Object
4. Then select the View PDL aspect from the aspect list.
To retrieve the PDL information (reference Figure 10.26):
3BUF001094-600 B 567
Figure 10.26: Manual Archive
1. The log class for manual archival is Run Time. Use the Log Type pull-down
list on the Retrieve tab to select the Run Time option.
2. Click Apply. This will display all PDLs for the selected log type.
3. Select one PDL from the list to retrieve its corresponding tasks.
This may take some time depending on the number of tasks. The message bar at
the bottom of the window will indicate that History Services is retrieving the in-
formation. DO NOT click again. Doing this would put another request in the queue
and delay the information retrieval process.
The tasks are displayed in the lower pane beneath the log list.
The retrieved Log or Task list may be too large to manage. The Filter Tasks tab is
used to apply a filter to reduce the retrieved Task list. To do this, follow the guidelines
in Filtering the Task List on page 569.
568 3BUF001094-600 B
Filtering the Task List

Reduce the number of tasks displayed in the Task list by applying a filter based on
start and/or end times. To do this go to the Filter Tasks tab, Figure 10.27. This tab
provides two Start Time fields, and two End Time fields. Use these fields in ether of
the following ways:
Figure 10.27: Filter Tasks Tab
• specify a start time range. This will exclude any tasks whose start time does not
not fall within the specified range. To do this, check both Start Time fields and
specify a from and to start time. Uncheck the End Time fields.
• specify an end time range. This will exclude any tasks whose end time does not
not fall within the specified range. To do this, check both End Time fields and
specify a from and to end time. Uncheck the Start Time fields.
• specify both a start time range and an end time range. To do this, check and
specify all time fields.
Click Update Filter to apply the new filter specification.
Completing the Archive Request

At this point, either archive all tasks for the selected PDL, or select specific tasks to
archive.
To archive the entire PDL:
1. Click the Archive PDLs tab, Figure 10.28.
2. Fill in the information as described in Table 10.16. Specify the Archive Device
and Surface (volume). Optionally, enter a description.
3. Click Archive when finished.
3BUF001094-600 B 569
10 Reading and Managing Archiv 10.5 Verifying Archive Data
To archive selected tasks, click the Archive Tasks tab. This tab is identical to the
Archive PDLs tab, except that the Archive button is not active until tasks have been
selected from the Task list. Select the tasks from the Task list, fill in the information
as described in Table 10.16, then click Archive.
Figure 10.28: Archive PDLs Tab
Table 10.16: Archive Tab
Field/Button Description
Archive Device Enter the name of the archive device where the logs will be
copied.
Surface This pick list is populated with the list of surfaces corresponding
to the selected archive device. The default choice is the active
surface.
Volume State This is a read-only field that indicates the status of the selected
volume.
Usage This is a read-only field that indicates the amount of space
already occupied on the selected volume.
Active Volume This is a read-only field that indicates the current volume where
timed archiving is writing data.
Description Enter an optional description to identify this archive entry.
10.5 Verifying Archive Data

The archive service uses electronic signatures in combination with machine-generated
keys as a means of determining whether archive data has been falsified or altered
without authorization. Every archive volume is marked with an encrypted electronic
570 3BUF001094-600 B
10 Reading and Managing Archiv 10.5 Verifying Archive Data
signature/machine key. The signature and key may be read and verified at any time
to determine whether or not the contents of the volume have been altered. How to do
this is described in Verifying Signatures for a Volume on page 571.
Restoring a volume to a different machine (not same machine where the volume was
created), or on a machine whose operating system has been reloaded will cause a
mismatch between the signature and the machine-generated key. A check of the sig-
natures will indicate that the signatures are valid, but the keys do not match. In this
case, to verify the integrity of the volume a record of the original key used when the
archive was made will be required. This record may then be compared to the key
which is currently stored on the volume.
Therefore, for each archive volume, read and record the signature information to
record the public key. How to do this is described in Showing Volume Information
on page 586. Use this same function to compare a recorded public key with the current
public key stored on an archive volume.
10.5.1 Verifying Signatures for a Volume

This is used to verify signatures on a selected volume, Figure 10.30.
1. Select the archive volume aspect.
2. Click Actions then choose Verify Signatures (or use context menu).
Indicates public key on this machine

does not match key with which archive
entry was originally stored
(different machine or new operating
system)
Figure 10.29: Verifying Signatures
3BUF001094-600 B 571
10 Reading and Managing Archiv 10.6 Making Archived Data Available to Clien
10.5.2 Showing Signature Information for a Volume

This function is used to view the signature information for a volume, Figure 10.30.
To use this function:
2. Click Actions then choose Signature Info (or use context menu).
Figure 10.30: Signature Information
10.6 Making Archived Data Available to Client Applica-

tions
In order for external applications such as Display Services, DataDirect, and Desktop
Trends to access archived log data (except property logs), the archived logs must be
restored from the archive media to the restored History database. This is described
in Restoring Logs from Archive Media to Restored Database on page 577.
For property logs, publish rather than restore the archive data.This is described in
Publishing an Archive Volume on page 573.
Message log data stored on the published volume is also published. This is used to
access the message log data through alarm/event lists configured in the 800xA System.
Archive message logs must be restored to access the archive data through the SQL-
based tools in DataDirect, Desktop Trends, and Crystal Reports.
572 3BUF001094-600 B
10.6.1 Publishing an Archive Volume

The contents of one or more archive volumes can be published to let client applications
such as Display Services, DataDirect, and Report Services access the archived data.
This provides access to the archived data without having to restore individual logs
from the archive volumes. Publishing applies to propertyand profile and message
logs only.
Publishing reads the information needed to locate the archive entries from the archive
volume and copies the information to media database files located in the directory
pointed to by the HS_TMP environment variable. When a request for published
archive data occurs, History uses this media database to find the requested data.
This method for making archive data available is simpler than restoring the archived
data. The contents of a complete volume, or even multiple volumes can be published
in relatively few steps. Also, this method does not require the archive data to be
written to Oracle tables in the restored database. Since Oracle tablespace is limited,
the publishing method is used to expose a larger amount of archive data for client
applications at any one time.
The media database files require a certain amount of free disk space on the hard
drive. Unpublish any volumes that are not being accessed on a regular basis to
limit the size of the media database.
This procedure may be is performed through either an Archive Device Aspect, Figure
10.31, or an archive volume aspect, Figure 10.32.
Archive Device Aspects are typically located in the Node Administration structure,
under the Industrial IT Archive container for a selected node as shown in Figure
10.31. Select the volume to be published, then right-click and choose Publish from
the context menu.
Archive volume aspects are typically located in the Node Administration structure,
under their respective archive device aspects. When using an Archive Volume Aspect,
the Publish command is available through the Action button, Figure 10.32.
3BUF001094-600 B 573
Figure 10.31: Publishing a Volume from the Archive Device Aspect
Completion of the publish operation is indicated by a Success message in the

status window, Figure 10.33.
Archive entries written to the volume after publishing will not be in the media
database. Access to this data would require the volume to be unpublished and then
republished.
At this point the archive data are available for client applications. Refer to Accessing
Published Logs on page 576.
574 3BUF001094-600 B
Figure 10.32: Publishing from the Archive Volume Aspect
Figure 10.33: Success Message
3BUF001094-600 B 575
10.6.2 Accessing Published Logs

Published logs can be accessed by external applications such as Display Services,
DataDirect, and Desktop Trends as easily as runtime logs. The only difference is that
the full log name must be used, and the -r suffix must be used in place of the -o suffix
to distinguish between original (runtime) and published logs.
This is the same syntax used to access restored logs. If an archived log has been
restored and published, the restored log supersedes the published log. Thus, by
attempting to retrieve archive data for such a log using the above syntax, the re-
stored data will be retrieved rather than the published data.
When using the Information Management Browser, if the connection is through the
IMHDA data provider, the browser provides a folder specifically for browsing pub-
lished logs. Guidelines for using this browser are provided in Information Management
10.6.3 Unpublishing a Volume

The media database files are pre-allocated to a certain size. When there is not enough
room in the files to publish another volume, the files will increase in size. Unpublishing
a volume makes the file space used by that volume available for other volumes to be
published in the future. Therefore, unpublish a volume when it is finished. To do this:
1. Select the volume as described in Publishing an Archive Volume on page 573.
2. Right-click and choose Unpublish Volume from the context menu.
Unpublishing a volume does not decrease the size of the media database files. To
recover disk space, these files may be deleted. The files are located in the directory
pointed to by the HS_TMP environment variable. Unpublish all published volumes
before deleting the media database files.
576 3BUF001094-600 B
Figure 10.34: Unpublishing a Volume
10.6.4 Restoring Logs from Archive Media to Restored Database

In order for external applications such as Display Services, DataDirect, and Desktop
Trends to access archived log data, the archived logs must be restored from the archive
media to the restored History database.
For property logs, publish rather than restore the archive data. Refer to Publishing
an Archive Volume on page 573.
Restoring is performed through the Archive Volume Aspect. Archive volumes are
typically located in the Node Administration structure under their respective archive
devices.
Either restore an entire archive entry, or select a subset of logs to restore from the
entry. Also, the procedure for restoring an entry with Platform Objects is slightly
different.
• Restoring an Archive Entry on page 578.
• Restoring Selected Logs in an Entry on page 578.
• Restoring an Entry With Platform Objects on page 579.
Guidelines for referencing restored logs are provided in Accessing Restored Logs
on page 583.
3BUF001094-600 B 577
Restoring an Archive Entry

Only entries that were archived at the same time can be restored in a single restore
operation. Two or more restore operations are required to restore entries that were
archived at different times.
To restore an entire archive entry, select one or more entries from the middle section
of the archive volume aspect, then right click and choose Restore Archive from the
context menu, Figure 10.35. Filter the entries list as described in Filtering Archive
Entries on page 580.
While the restore is in progress, a Restoring... message is displayed. This message
box may be closed by clicking Return; however, no additional notification is made
when the restore is finished. It is therefore recommended that this message be left
open while the restore is in progress.
Figure 10.35: Restore Archive
Restoring Selected Logs in an Entry

To restore one or more selected logs:
1. Select an archive entry from the middle section. When an archive entry is selected,
the corresponding logs are displayed in the bottom section.
2. Either apply a filter to the logs in the list or search the list for a specific log. Refer
to Filtering Logs on page 581.
578 3BUF001094-600 B
3. Select the logs to be restored.

4. Right-click and choose Restore Logs from the context menu.
Figure 10.36: Example, restoring Selected Logs
Restoring an Entry With Platform Objects

When restoring an entry with platform objects, specify the location where the objects
will be restored. This is illustrated in Figure 10.37.
Object for restoring

Completed Reports
Created through Plant
Explorer Workplace
Figure 10.37: Selecting the Location for Restoring Platform Objects
3BUF001094-600 B 579
Filtering Archive Entries

When a volume contains a very large number of entries, apply a filter based on archive
group and/or archive type to reduce the number to a manageable level. To do this:
1. Click Set Filter for the entries list, Figure 10.38.
Set Filter
for Entries List
Figure 10.38: Set Filter for Entries List
This displays the Filter Entries dialog. This dialog is used to filter the entries list
based archive type (Manual or Scheduled), archive group, and archive group
description.
2. Enter the filtering criteria. Use one, two, or all three criteria. Figure 10.39 shows
a filter for Scheduled archives for the group named IMlog1.
Leading and trailing wildcard characters are present by default (but not shown).
Do not enter wildcard characters in this dialog.
3. Click OK when done. The result for this filter is shown in Figure 10.40.
Reset Filter restores all archive entries to the list.
580 3BUF001094-600 B
Figure 10.39: Filter/Search Archives Tab
Figure 10.40: Entry Filter Result
Filtering Logs
When an archive entry is selected, the log list initially displays all logs for the selected
archive entry. Reduce the number of logs in the list by applying a filter based on log
name and/or log type.
To do this:
1. Click Set Filter for the log list, Figure 10.41.
3BUF001094-600 B 581
Set Filter
for Log List
Figure 10.41: Set Filter for Entries List
This displays the Filter Logs dialog. This dialog is used to filter the log list based
log type, and log name. Log type options are: Object (for example, Completed
Report), Numeric, Message, Profile, Generic, PDL, and SPC.
2. Enter the filtering criteria. Use one or both criteria. Figure 10.42 shows a filter
for Numeric logs whose name contains the string HSSIN.
Leading and trailing wildcard characters are present by default (but not shown).
Do not enter wildcard characters in this dialog.
3. Click OK when done. The result for this filter is shown in Figure 10.42.
Reset Filter restores all logs to the list.
Figure 10.42: Log Filter Dialog
582 3BUF001094-600 B
Figure 10.43: Log Filter Result
10.6.5 Accessing Restored Logs

Client applications such as Display Services, DataDirect, and Desktop Trends can
access archived log data that has been restored to the restored History database. To
access restore logs:
For Message Logs - append _R to the end of the access name (for example:
ENG117_System_R).
10.6.6 Deleting Restored Logs

Delete logs from the restored portion of the History database through the View Logs
(or View Report Logs) window. (To delete restored PDLs and tasks, refer to Deleting
Restored PDLs and Tasks on page 584.)
To delete restored message, or report logs:
1. Retrieve the log information to select the specific logs to be deleted. The basic
procedure is described in Retrieving Log Information on page 561.
Restored logs must be retrieved by location. Also, for Log Class, select Restored.
2. Select the logs to be deleted from the retrieved log list.
The retrieved log list may too large to manage. Filter or search the displayed log
list using the Filter and Search functions.
3. Right-click and choose Delete Restored Logs. This displays a message box to
confirm or cancel the delete command.
4. Click on Delete to continue the delete function or Cancel to cancel it.
3BUF001094-600 B 583
10 Reading and Managing Archiv 10.7 Miscellaneous Archive Operations
Deleting Restored PDLs and Tasks

When a PDL is deleted, all batch, unit procedure, and phase tasks under that PDL are
deleted and the object is deleted from History. When a batch task is deleted, all unit
procedure, and phase tasks under that batch are deleted. Also, all log and resource
associations belonging to the job or batch are deleted.
To delete a PDL from the View Production Data Logs window:
1. Open the View Production Data Logs aspect. To do this:
a. Select the Node Administration structure in the Plant Explorer.
b. Select the History service provider for the node where history is being con-
figured (InformIT History_BasicYourNodeService Provider).
c. From the History service provider, navigate to and select the Production
Data Log group under InformIT History Object.
2. Then right-click and choose Inform IT History View Production Data Logs
from the context menu.
3. Use the Retrieve tab to retrieve PDLs by location. Select the Restored log type.
Refer to Manually Archiving PDLs on page 567 for details.
4. Select the PDL or PDLs from the Log Name field.
5. Go to the Delete tab and click Delete Runtime PDLs. This displays a confirma-
tion message.
6. Click on Yes to confirm or No to cancel.
To delete a batch task from the View Production Data Logs window:
1. Select the PDL whose batch tasks will be deleted. Only one PDL can be selected.
2. Select one or more batch tasks to delete.
3. Go to the Delete tab and click Delete Runtime Tasks. This displays a confirma-
tion message.
4. Click on Yes to confirm or No to cancel.
10.7 Miscellaneous Archive Operations

This section covers:
• List Group Items on page 585.
584 3BUF001094-600 B
• Resetting the Last Archive Time for an Archive Group on page 585.
• Showing Volume Information on page 586.
• Showing Platform Information for a Log on page 586.
10.7.1 List Group Items

When an Archive Group is selected in the top portion of the Archive Group aspect,
the entries that have been added to the selected group are listed in the bottom portion.
Each entry may represent many items, for example, a numeric log entry may represent
hundreds or thousands of logs. The List Group Items function is used to determine
the exact content of an archive group. An example is shown in Figure 10.44. To do
this, go to the Archive Group Aspect. Then select the group, click Actions and choose
List Group Items (or use the context menu).
Figure 10.44: Archive Group Item List
10.7.2 Resetting the Last Archive Time for an Archive Group

The last archive time is the time the last archive operation occurred for a group. This
time is remembered by the system so that the next archive operation will archive data
starting at that time. It may be necessary to change (reset) this time to cause the next
archive operation to go back farther in time, for example to account for a failed archive
3BUF001094-600 B 585
or skip ahead to a later time. Or, for example, when the data collected for a certain
time period should not be archived.
This is done through the Archive Group aspect. Select the group, click Actions and
choose Reset Last Archive Time (or use the context menu).
10.7.3 Showing Volume Information

This function shows information for a selected volume, Figure 10.45. This function
may be invoked from either the archive device aspect, or the Archive Volume Aspect.
Select the volume, then click Actions and choose Show Volume Info.
Figure 10.45: Volume Information
10.7.4 Showing Platform Information for a Log

Platform information is applicable for property (numeric) logs. This function shows
information for a selected log within an archive entry, Figure 10.46. This information
is described in Table 10.17. The Platform information dialog also lists the aspects for
each log. This is used to display the log configuration aspect’s view directly from
this dialog. This can be used to verify that the logs have been published.
586 3BUF001094-600 B
Aspect List
for selected
log
Figure 10.46: Platform Information
Table 10.17: Platform Information
Item Description
Index Sequential Number
Log Full Log name
Object Object where the log configuration aspect was added
Property Aspect Aspect category for the logged property
Configuration Aspect Name of the log configuration aspect
Property Name Property name
Log name Configured log name
The function is available on the archive volume aspect. To use this function (reference
Figure 10.47):
2. Select an archive entry from list of entries in the upper pane.
3. Select one or more logs from the list in the lower pane.
4. Click Actions then choose Platform Info (or use context menu).
3BUF001094-600 B 587
10 Reading and Managing Archiv 10.8 Importing Archive Data
To display the log configuration aspect for a log, select the log in the upper log list,
then click the log configuration aspect icon in the lower pane.
Select an
entry
Then select
one or more
logs
Figure 10.47: Showing Platform Information
10.8 Importing Archive Data

The Archive Import tool is used to import archived historical data from earlier histo-
rian platforms, and from other 800xA Systems. This is used to:
• View archive data produced within one 800xA System on another 800xA System.
• Restore archive data to a system where the object has been removed, but the
historical information is still relevant.
• Transfer archive data from earlier platforms to the 800xA System.
When importing archive data from earlier platforms; once restored, standard 800xA
capabilities can be applied against the data. The following platforms are supported:
• Enterprise Historian HP-UX (Advant MOD 300 or Advant Master, including
TTD data).
• Enterprise Historian Windows (Advant MOD 300 or Advant Master, including
TTD data and OPC).
• Advant IMS (Advant MOD 300 or Advant Master, including TTD data).
• Information Manager.
The archive data must be readable on the Windows platform. This can be either
CD/DVD media or disk/network disks.
588 3BUF001094-600 B
A good working knowledge of property log configuration and archiving in the

800xA System is required before using this tool. These are Information Manage-
ment configuration topics.
For a brief description of the Archive Import tool refer to the Overview on page 589.
For instructions on using the tool refer to Step 10.8.2 on page 594.
10.8.1 Overview
The Archive Import tool, Figure 10.48, is accessible through the Config view on an
Archive Volume aspect. It is based on an Excel workbook with embedded buttons
and functions designed specifically for importing archives from other platforms.
3BUF001094-600 B 589
Figure 10.48: Workbook for Archive Import
The Process
1. Start by selecting an archive volume from which to import the archive data. The
volume must be mounted in a drive on the Information Management Application
Server or a mapped drive, and the drive must have an archive volume aspect that
supports reading from the volume.
2. Select one or more archive groups that have entries on the volume. This is used
to if it is desired to limit the number of logs that will be imported in one session.
The Archive Import Tool creates new log configuration aspects to hold the im-
ported archive data. If the system has objects where these new log configuration
590 3BUF001094-600 B
aspects can be added, then those objects may be used. If no object exists for the
data from the archive, the Archive Import tool creates an Object Structure to
provide navigation for the restored data. The tool also creates new log templates
from which to instantiate the new log configuration aspects.
The Workbook
The workbook has three sheets. The first sheet shown in Figure 10.48 is named Log
List. The top of this sheet, Figure 10.18, contains a row of command buttons arranged
so the import operation can proceed in stepwise fashion from left to right. The two
rows below the buttons provide feedback for the button commands.
Table 10.18: Command Buttons and Feedback Rows
The remaining rows provide log information. Colored headings indicate the source
of the data. For example, blue indicates information extracted from the archive files.
Yellow indicates information for which the tool has provided a default value, but
which may be modified by the user. Purple indicates information created by the tool
in the 800xA System.
The second sheet is named Log Templates, Figure 10.49. As the import progresses,
this sheet is populated with the information needed to create the log templates that
will be used to instantiate the archive log configurations. This sheet uses the same
color coding as the Log List sheet. Certain parameters on this sheet can be modified
if necessary, for example, log names and log template names.
3BUF001094-600 B 591
Figure 10.49: Log Templates Sheet
The third sheet is named Messages, Figure 10.50.
592 3BUF001094-600 B
Figure 10.50: Messages Sheet
This sheet provides more detailed feedback, status and error reporting. If something
unexpected happens, this sheet may show why. Each message is time stamped, and
operations that may take time include a time duration report. This will help when
determining how long certain operations may take with the particular combination
of archives, media, and hardware.
3BUF001094-600 B 593
10.8.2 Step-by-Step Instructions

The procedure for importing an archive involves several basic steps. Detailed instruc-
tions for these basic steps are provided in the following sections.
1. Select the archive volume from which to import data, and start the Archive Import
Tool.
The first time the Archive Import Tool is started, ABB Inc. must be added to the
Trusted Publishers in Microsoft Excel.
2. Create a new Aspect Reference Data Source file.

3. Select one or more archive groups whose data will be imported.
4. Load the archive data from the volume.
5. Create new objects where the new log configurations will be added or select ex-
isting objects.
6. Create log templates and log configuration aspects from which to instantiate the
new log configurations, or select existing archived logs.
7. Update the aspect reference information.
When the Excel workbook is saved, the file name defaults to the volume label.
Do not change this name. This is how the system finds the correct file when it
needs to be re-opened.
Starting the Archive Import Tool

Before starting the Archive Import Tool, the archive data to be imported must reside
on a readable media, and that media must have a dedicated archive volume aspect to
read the volume. Archive volume aspects already exist for all removable disk drives
(DVD and CD drives). Additional read-only volumes may be created for reading
archive volumes that have been copied to a mapped network drive, or for viewing
archive files that have been copied to the local drive. Configuring a new archive
volume aspect is an Information Management configuration topic.
To select an archive volume and start the Archive Import Tool (Reference Figure
10.19):
1. Go to the Node Administration structure and select the Archive Volume object
for the media where the archive volume is mounted. For example, in Figure 10.19
the Archive Volume object for Drive F is selected.
594 3BUF001094-600 B
2. Select the Archive Volume aspect from the object’s aspect list.
3. Use the View Selector to change the view to the Config View. This displays a
dialog that is used to start a new workbook or open an existing workbook. Con-
tinue with this dialog as described in Generating an Aspect Reference Data Source
on page 595.
Table 10.19: Starting the Archive Import Tool
Generating an Aspect Reference Data Source

The 800xA System creates an Aspect Reference Data Source file for each archive
volume. The system uses this file to relate the archive data on the volume with the
correct objects in the target system. When archive data is imported from one 800xA
System to another system, the information contained in the reference file on the
archive volume produced on the source system will not match the target system infor-
mation. For archives made on earlier platforms such as Enterprise Historian versions
2.2 (HP-UX based) or 3.2 (Windows-based), this file does not exist. Therefore, to
successfully import archives from these systems, generate a new reference file that
3BUF001094-600 B 595
will relate the archive data to the correct objects on the target system. Use the dialog
in Figure 10.20 to begin this process.
1. Use the Service Group and Volume Path default values that correspond to the
Archive Volume selected in the previous step.
2. Select the User Generated option button and click New as shown in Figure
10.20 to create a new Aspect Reference Data Source file.
Table 10.20: Aspect Reference Data Source Setup Dialog
This opens a new workbook. The system and archive volume path specifications are
already defined, Figure 10.21. Therefore, it is not necessary to use the first two
command buttons corresponding to those steps. Start with the third button for Setting
the Archive Group Filter.
Table 10.21: Initial Workbook View
596 3BUF001094-600 B
Setting the Archive Group Filter

Each entry in the archive volume is the archive instance for a specific archive group,
or a manual archive. Every time a group gets archived, or a manual archive is per-
formed, another entry is generated. There may be hundreds of archive entries in the
directory, but typically they represent relatively few distinct groups.
Select one or more groups (and/or manual archive instances) on the Archive Volume
whose archive files will be imported. Perform the following:
1. Click Set Archive Group Filter, Figure 10.22.
Table 10.22: Set Archive Group Filter Button
This displays the Choose Groups dialog, Figure 10.23.
3BUF001094-600 B 597
Table 10.23: Choose Groups Dialog
This dialog lists the names of the archive groups represented on the Archive
Volume. Manual archive instances are represented by the common name: Custom.
The number of logs contained in each group is indicated by the first number in
parentheses following the group name. The second number indicates the number
of occurrences of the group on the archive volume.
Since group definitions may change between one archive event and the next, the
number in parentheses indicates the maximum log count over all instances of the
archives of that group in this Volume. The number in parentheses indicates the
total number of logs recorded in the Archive Header files as belonging to that
particular group. The number of numeric logs may be considerably less than this
number. The total log number is just a guide.
2. Select one or more groups. Hold down the Ctrl key to select multiple groups or
to deselect already selected groups. Selecting no groups is equivalent to selecting
all groups.
3. Click OK once the selections are made.
The selected group names will be indicated in the report area under Archive
Group Filter. Each name will be separated by the character (:), Figure 10.51. Log
598 3BUF001094-600 B
counts are not indicated. As a result of this operation, a message will be created
on the Message sheet (sheet 3). An example is shown in Figure 10.52.
Figure 10.51: Set Archive Group Filter
Figure 10.52: Example Set Archive Group Filter Message
Loading Data From Archive Volume

This step loads the data for the selected archive groups. Perform the following:
1. Click Load Data From Archive Volume, Figure 10.24. This displays a progress
bar and a Start button.
Table 10.24: Load Data From Archive Volume Button
2. Select the Start button. This will initiate a read of Archive information which
can not be interrupted (a progress bar will appear). The time to read this informa-
tion may be significant, depending on the size of the archive and other factors.
During this operation, information for the logs in the selected groups is read from
the archive volume.
3BUF001094-600 B 599
The tool will create a new log template for each unique combination of Aggregate
and Storage Rate found. This information is entered on the Log Templates sheet,
along with the default names for the property log templates and log configurations.
Table 10.25: Template Sheet Results
The Template value in the Logs / Templates report cell on the first sheet is incremented
when a new Template row is added to the second (Log Template) sheet.
After the information has been read into memory, the Archive Log Names, Data
Sources, Aggregates, and Storage Rates for each log are entered into the four left
columns of the Log List sheet, one row per log, Figure 10.26.
Table 10.26: Load Data Result on Log List Sheet
In addition to data extracted from the Archive, default Template Row Numbers
(pointing to a Property Log Template configuration on the Log Template sheet) is
also entered for each log, along with default values for the 800xA Object Names,
Property Names, and Data Types.
600 3BUF001094-600 B
Once the Log rows have been created, duplicate rows are purged automatically. Du-
plicate rows will occur if the same log information is read in more than once, or if
the same log occurs in multiple groups. In order to remove duplicate entries from the
workbook, the Log list is sorted. If a duplication is found, the most recent entry is
preferred, unless the older entry already contains an Object Path. As duplicate rows
are removed, the progress bar advances backwards (right-to-left), indicating which
spreadsheet row is being processed.
As a result of this operation, a message will be created on the Message sheet (sheet
3). An example is shown in Figure 10.53.
Figure 10.53: Example Load Archive Data From Volume Message
At this point, the workbook has rows representing archived logs on Sheet 1. Filter
these rows, if desired, to process only a subset of logs. The remaining buttons will
operate only on the rows left unfiltered (visible).
Each header column on the Log List sheet already has an Excel Filter defined, Figure
10.27. Filtering on multiple columns, especially using the built in Custom filtering
feature, is an effective way to isolate a set of log rows that need to be processed
identically.
Table 10.27: Filtering
After executing the Load Data From Archived Volume command, the results may be
modified. For example, object names can be modified. For details, refer to Overriding
The Defaults on page 611.
Creating Objects for the Archive Log Configurations

This step creates (or specifies) the objects where the log configurations will be instan-
tiated. Just as property logs are instantiated by adding log configuration aspects to
3BUF001094-600 B 601
the objects whose properties are being logged, each archive log configuration must
belong to an object in the system. Either create new objects specifically for this pur-
pose, or associate the log configurations with existing objects.
Generally, new objects are created when the archive data is being imported for the
first time. The objects created are simply placeholders for the log configuration aspects.
For details, refer to Creating New Objects on page 602.
If archive data is being re-imported for objects whose archive data has been previously
imported, then choose to match existing objects. Refer to Match Existing Objects on
page 600 for more information.
Creating New Objects

To create dummy (placeholder) objects where the new log configurations can be in-
stantiated, use the Create New Objects option. To create new objects, click Create
New Objects, Figure 10.28.
Table 10.28: Create New Objects Button
This displays an Object Browser for selecting a single parent (root) object in the
800xA System, Figure 10.29. The default parent object is based on the volume name.
Another object may be selected.
602 3BUF001094-600 B
Table 10.29: Object Browser
When a parent object is selected, the object browser is replaced by a progress bar
which monitors the progress of creating new objects having properties with the
specified data types as immediate children of the chosen Parent Object.
The process of creating objects can be stopped by clicking on the Stop button of the
progress bar.
As rows are processed, the Create New Objects report cell keeps track of successes
and attempts. Success is marked by entering information in the next three columns
of the Log row: Object Path, Object GUID, and Property Aspect GUID. This infor-
mation is stored (persisted) in the workbook as it is needed for subsequent operations,
which may not occur in the same Excel session.
If an existing object with the same name as the proposed new object is found (as a
child of the parent object), the tool will not create a duplicate object, but will use the
existing object. Otherwise, the tool will create a new object, with object type = Archive
Import Object.
If an existing property with the same name as the proposed new property is found,
the tool will not create a duplicate property, but will use the existing property. Other-
wise, the tool will create (or expand) a General Properties aspect, adding a new
property with the specified name and data type.
Messages on the Messages Sheet indicate final success/attempts status, whether the
operation was stopped, and reasons for failures. An example is shown in Figure 10.30.
3BUF001094-600 B 603
Table 10.30: Example Create New Objects Message
Match Existing Objects

If the system already has objects where the new log configurations can be instantiated,
use the Match Existing Objects option. Click Match Existing Objects, Figure 10.31
to match existing objects.
Table 10.31: Match Existing Objects Button
This displays an Object Browser for selecting a set (one or more) of parent (root)
objects in the 800xA System, Figure 10.32. These parent objects must have already
been created in the 800xA System.
604 3BUF001094-600 B
Table 10.32: Object Browser for Matching Existing Objects
The label of the Object Browser window keeps track of the number of root objects
selected so far, as does the Success / Attempts / #Roots report cell beneath the Match
Existing Objects command button.
After selecting the first object, the Select prompt on the Object Browser changes to
Add Another Parent. Click Done when finished adding Parent Objects.
In the current Archive Import Tool session, if a set of root objects were previously
specified for matching, the Done button will read Use Previous. Clicking Use
Previous without selecting any objects will use the previous root object set. This
feature only works during a single session, since the set of matching object roots
is not persisted in the workbook between sessions.
Close the window to cancel at any time.
When parent objects are selected, the tool creates an internal list of all objects that
are descendents of those parent objects. The tool then matches the object names in
the log rows of the worksheet against that internal list. If a match is found, the tool
looks for a matching property name.
The Object Browser is replaced by a progress bar that monitors the progress of
matching existing objects and properties. The process of matching objects can be
stopped by clicking on the Stop button of the progress bar.
3BUF001094-600 B 605
The Match Existing Objects functionality does not create either Objects or Properties.
Messages on the Messages Sheet indicate final success/attempts status, whether the
operation was stopped, and reasons for failures.
The following is a typical Message Sheet entry:
Time Message Delta Time

4/6/2004 MatchExistingObjects 1m 41.7s
4:38:13 PM Matched/Attempted/#RootObjects
9000 / 9000 / 1
Creating New Archived Templates and Logs

This step creates the log templates from which all archive log configurations will be
instantiated, and instantiates log configurations for the logs defined in the log list.
To start, click Create New Archived Templates and Logs, Figure 10.33.
Table 10.33: Create New Archived Templates and Logs Button
This displays an Object Browser for selecting a parent object for the Property Log
Templates whose configurations are defined on the Log Templates sheet. The default
is the Archive Import Template Library Object under the History Log Templates
object in the Library Structure, Figure 10.34. A different parent object may be selected.
For each unfiltered (visible) row on the Log List sheet, the tool locates the object
specified in the Object Path column and creates a log configuration aspect for that
object. If a log configuration aspect already exists, that aspect is used. The tool then
creates a new property log in that aspect, using the property, data type and log template
indicated by the information (names and GUIDs) stored for that row in the workbook.
606 3BUF001094-600 B
Table 10.34: Object Browser for Creating Archive Log Templates
This command only operates on unfiltered visible rows of the Log Template sheet
and will not create duplicate templates if the templates already exist.
Upon selecting the parent template library, the object browser is replaced by a progress
bar with a Stop button. However, the number of Property Log Templates is usually
very small, compared to the number of Property Logs, and the progress bar may not
be noticed.
The Aspect Reference column of the Template rows on the Log Template sheet are
filled in by the tool, for use in subsequent commands.
As a result of this operation, a message will be created on the Message Sheet (Sheet
Table 10.35: Example Create Archive Log Templates Message
3BUF001094-600 B 607
Matching Existing Archive Logs

If the system already has archived logs where the new log configurations can be in-
stantiated, use the Match Existing Archive Logs option. Click Match Existing Archive
Logs, Figure 10.31 to match existing archived logs.
Table 10.36: Match Existing Archived Logs Button
This displays the progress bar. Clicking Start initiates the process. Clicking Stop
terminates the process.
The Success / Attempts report cell beneath the Match Existing Archived Logs
command button shows how many archived log matches were successful out of those
attempted.
Close the window to cancel at any time.
A log template will be created if a log template is not available for an archived log.
The Log Config Aspect GUID and Log ID GUID columns of the log rows on the
Log List sheet are filled in by the tool, for use in subsequent commands.
As a result of this operation, a message will be created on the Message sheet (sheet
Table 10.37: Example Match Archived Logs Message
Creating/Updating New AIP INFO File

This step updates the new Aspect Reference Data Source file to relate the imported
archive data with the relevant objects in the 800xA System.
608 3BUF001094-600 B
Skip the Specify New Aspect Reference Data File step, since this information is
already specified and should not be changed.
1. Click Create/Update New Aspect Reference File, Figure 10.38.
Table 10.38: Create/Update New Aspect Reference Data File
2. Click on the Start button of the progress bar. The tool creates an internal list of
the unfiltered (visible) log rows on the Log List sheet. The file path is indicated
under the Specify a New Aspect Reference Data File button.
3. When prompted to continue building the file (Building Aspect Reference File),
click OK.
The tool creates or locates the specified new AIP_INFO file. 800xA information
for each Log in the workbook is written to a new file using information stored
in the workbook. If an AIP_INFO file was included in the original Archive Vol-
ume, any digital signature information for each log is copied from the old
AIP_INFO file to the new. The tool also updates the alternate AIP_INFO file
path of the Volume Configuration aspect.
A record of entries and log rows is kept in the report cell beneath the Create/Up-
date New Aspect Reference File button, Figure 10.38.
4. When the Operation Complete message appears, acknowledge the prompt by
clicking OK.
5. Once the AIP_INFO file is created, apply the changes by clicking Apply on the
Archive Volume config view, Figure 10.20.
6. When prompted to update the version on the server with the local copy (Update
Server?), click Yes. This will copy the new file to the correct location and set
the user available flag to TRUE (represented in Archive volume information).
3BUF001094-600 B 609
Viewing the Imported Archive Data

1. Select Publish in the Main view of the Archive Volume aspect, Figure 10.39.
Table 10.39: Publishing
2. View the archive data, Figure 10.40, from the log configuration aspect Status
tab.
610 3BUF001094-600 B
Table 10.40: Viewing Imported Archive Data
Overriding The Defaults

After executing the Load Data From Archived Volume command, the results may be
modified as follows (Figure 10.41):
1. The Template Name and Log Name entries on the Log Template Sheet may be
modified or extended by editing their entries or appending new rows.
2. The template row number entries on the Log List sheet may be modified to point
to user-defined Log Templates on the second sheet.
Template Name Aggregate Storage Log Name

(Calculation) Rate
ArchTemplate_Average_6s AVERAGE(3) 6s Log_Average_6s_Rst
FrodoTemplate_None_1m NOAGGREGATE(0) 1m Frodo_None_1m_Rst
MyName_1m NOAGGREGATE(0) 1m MyName_1m_Rst
When new entries are created on the second sheet, then retarget the template row
number of any logs on the first sheet that will be used.
3BUF001094-600 B 611
Do not sort or rearrange the rows on the second sheet, unless care is taken to retar-
get the template row numbers of all the logs on the first sheet that reference tem-
plates that have new row numbers.
Table 10.41: Excel Template Row
3. The Object Names and Property Names on the Log List sheet may be modified.
The workbook has filled in default values based on a few simple patterns it can
recognize. If the workbook cannot recognize a pattern, it will fill in names that
incorporate the line number on the worksheet of the Log as it was loaded, just
to have unique Object Names.
If there is a better way to construct Object and Property Names from Archive
Log Names and Data Sources, then create an Excel formula and fill the Object
Name and Property Name cells with it (Table 10.42).
Table 10.42: Excel Spreadsheet Example Columns
Object Name Property Name Data Type

H050B000J-000500 Measure Float (32-bit)
H050B000J-000500 Measure2 Float (32-bit)
612 3BUF001094-600 B
Table 10.42: Excel Spreadsheet Example Columns

(Continued)
Object Name Property Name Data Type

For example, if the Log Names look like:

$HSH050B000J-000500,MEASURE-1-o
Then, in column F9, enter:

=MID(A9,4,SEARCH(",",A9,5)-4)
And, in column G9, enter:
=MID(A9,SEARCH(",",A9,5)+1,SEARCH("-",A9,SEARCH(",",A9,5)+1)-
SEARCH(",",A9,5)-1)
Then Fill Down, perhaps after doing a filter to get all similar objects into visible rows,
to create similar Object and Property names in other rows.
As another example, say the log names look like:
$HSpvAC1DigSec1:AC1DIGSEC1_100.VALUE:IM_4d-1-o
Then this might be used:

=MID(A9,4,SEARCH(":",A9,4)-4)
and
=
MID(A9,SEARCH(":",A9,1)+1,SEARCH(":",A9,SEARCH(":",A9,1)+1)-SEARCH(":",A9,1)-1)
To get Object Names like pvAC1DigSec1 and Property Names like

AC1DIGSEC1_100.VALUE.
The examples used above exist in the workbook.

1. The Data Type may be modified.
3BUF001094-600 B 613
Since Data Type information is not stored in the Archive, all Data Types are
defaulted as Float. Right-click on a cell in the Data Type column to access a
Data Type choice list.
Use Filtering and Data Fill (Fill Down) skills to get the Data Types the way they
are needed (Table 10.42).
10.8.3 Modifying a Workbook

To re-open a saved workbook, select the archive volume aspect as described in
Starting the Archive Import Tool on page 594, then select User Generated and click
Modify in the Aspect Reference File Setup dialog.
614 3BUF001094-600 B
11 Reading Message Logs 11.1 Message Log Tables
11 Reading Message Logs
When the system is equipped with the Information Management History Server
function, and the IMMSGLOG is configured, all system alarm/event messages will
be forwarded to the IMMSGLOG. The messages can be read through interactive di-
alogs in DataDirect and Desktop Trends. Data can also be accessed using SQL queries.
This section provides guidelines for using SQL queries to read messages from this
log.
11.1 Message Log Tables

OPC message log data are stored in three Oracle tables. This section describes the
contents of these tables, and provides guidelines for accessing message data from
these tables through SQL queries.
The relationship between the three Oracle tables for storing OPC message information
is illustrated in Figure 11.1.
One MSGLOG table is created for each message log configured. Each message oc-
currence creates a new row in the table, and is identified by a unique message index
(IDX). For each message, this table stores OPC attributes such as date and time stamps,
message text, and various other message attributes. The contents of this table are de-
scribed in Table 11.1.
One MSGATTRS table is also created for each message log. This table stores the
vendor-specific attribute values for each message. Attribute values in this table are
associated with their respective messages in the MSGLOG table by the unique message
index number. The contents of the MSGATTRS table are described in Table 11.2.
3BUF001094-600 B 615
MSGLOG
IDX LOCALTIME MESSAGE ETC...
17
18
19
20
MSGATTRS
IDX VALUE ETC... ATTRID
17 4
17 5
17 6
18 4
19 4
19 5
19 6
20 6
MSGVENDORS
ETC... ATTRNAME ATTRID

4
5
6
7
Figure 11.1: Relationship Between Oracle Tables for Storing OPC Message Information
Vendor-specific attribute names are defined in the MSGVENDORS table, Table 11.3.
There is one such table on each Information Management server where the message
logs reside. The attribute names in this table are associated with their corresponding
attributes in the MSGATTRS table by an Attribute ID.
616 3BUF001094-600 B
Attribute names for Batch Management are described in Table 11.4.

Attribute names for Audit Trail messages are described in Table 11.5.
Table 11.1: MSGLOG (Continued)

IDX Number Internally generated number to uniquely identify each
message in the log.
LOCALTIME Date Local Time and date of the message.
TIME Date UTC Time and date of the message.
TIME_UTC Number UTC Time and date of message in seconds since 1/1/70.
TIME_NANO NUMBER Number of Hundreds of Nanoseconds of fractional portion
of seconds of the TIME field.
performance.
CHANGE_MASK Number Indicates which properties changed to cause the event.
NEW_STATE Number Specifies the new state of the condition
TASK_ID Number Task ID for PDL Messages.
SOURCE Varchar2(255) Source of the event (i.e. tag name)
MESSAGE Varchar2(4000) Textual description of the event
EVENT_TYPE Number Simple, Condition Related, or Tracking event.
CATEGORY Number Standard OPC and Vendor Specific event category codes.
SEVERITY Number Vendor Defined Event severity (0…1000)
CONDITION Varchar2(255) Name of condition related to event
SUB_COND Varchar2(255) Name of sub-condition for multi-state conditions, or condition
name for single-state
QUALITY Number Quality associated with condition state (refer to OPC/DA
spec.)
ACK_REQ Number Acknowledgement required for event
ACTIVE_TIME Date UTC Time that the condition became active or time of
sub-condition transition
3BUF001094-600 B 617
Table 11.1: MSGLOG (Continued)

(Continued)

ACT_TIME_UTC Number Active_time (UTC) in seconds since 1/1/70
ACT_TIME_NANO NUMBER Number of Hundreds of Nanoseconds of fractional portion
of seconds of the ACTIVE_TIME field
COOKIE Number Server defined cookie associated with the event
ACTOR_ID Varchar2(64) User ID for tracking type events, Acknowledged ID for
condition related events.
NUM_ATTRS Number Number of vendor specific attributes associated with the
message.
Table 11.2: MSGATTRS (Continued)

IDX Number Associates attribute value with the corresponding message
in the MSGLOG table.
TIME_UTC Number Time and date (UTC) of the message in seconds since
1/1/70
TIME_NANO Number Number of Hundreds of Nanoseconds of fractional portion
of seconds of the TIME_UTC field
performance
ATTR_ID Number Unique identifier for this vendor specific attribute (generated
internally in history)
NBR_VALUE1 Number Numeric Value for this attribute
STR_VALUE(1) Varchar2(4000) String Value for this attribute
DATE_VALUE(1) Date Date Value for this attribute
1. Only one of these columns will contain data, depending on the data type specified in the MSGVENDORS Table
618 3BUF001094-600 B
Table 11.3: MSGVENDORS

VENDOR_NAME Varchar2(32) Name of the Vendor
CATEGORY Number OPC Event Category for this Vendor
ATTR_NAME Varchar2(32) Vendor specific attribute name. Refer to Table 11.4.
ATTR_ID Number Associates attribute name with the corresponding attribute
value in the MSGATTRS table.
SEQ_NBR Number Position in the list of vendor specific attributes for events of
this category
DATA_TYPE Number Data type specified by the VARIANT data types
Table 11.4: Attribute Types for Batch Management
Attribute Type Description

BatchID BSTR ID of a batch associated with the event
RecipePath BSTR Path to the recipe block associated with the event
BlockType BSTR String identifier of a recipe block type
Table 11.5: Audit Trail Attribute Names

AuditID long User defined counter field
LinkID long User defined ID to link to another event, object, or
transaction
Action BSTR Action causing the event, such as Created, Modified,
Deleted, etc.
Object BSTR Name of the object audited. Will be placed in the source
field of the MSGLOG table.
Parameter BSTR Name of the parameter changed for the object
Message BSTR Actual text of the Message. Will be placed in the Message
field of the MSGLOG table.
Comment BSTR User defined comment field
3BUF001094-600 B 619
11 Reading Message Logs 11.2 Example Queries
Table 11.5: Audit Trail Attribute Names

(Continued)

PrevVal VARIANT Previous Value of the parameter (may be numeric or string
value)
NewVal VARIANT New Value of the parameter (may be numeric or string value)
TimeStamp DATE Time stamp of the audit trail message. Will be placed in the
Time field of the MSGLOG table.
Workstation BSTR Location where the change was performed
EmployeeID BSTR User Name associated with the change. Will be placed in
the actor_id field of the MSGLOG table.
ElecSignature BSTR Electronic Signature string for the employee ID
ReasonCode long Number from a user defined enumerated list of reasons for
the change. The enumerated list is NOT stored in the
message.
ReasonText BSTR User defined string describing the reason for change
PrevVersionTime DATE Time stamp of the previous version of the object
PrevVersionNbr long Version number of the previous version of the object
CurVersionNbr long Version number of the current version of the object
ArchiveDate DATE Time stamp of when the object was archived
11.2 Example Queries

Any query against the OPC message log tables must be performed in two parts.
First execute a query to get the name of the MSGLOG table corresponding to the
message log whose data is to be retrieved.
Then use the table name in a second query that specifies attribute names, time ranges,
or any other criteria.
620 3BUF001094-600 B
11 Reading Message Logs 11.2 Example Queries
11.2.1 Query for MSGLOG Table Name for PDL Message Logs
select o.object_name,m.table_name from object_table o,log_map_table m, numer-
ic_attrib n where o.object_type in (2,26) and o.object_id = n.log_id and o.object_name
= m.log_name and n.attrib_id = 108 and n.attrib_value in (2) order by o.object_id
NOTES:
object_type 2 = Runtime message logs
object_type 26 = Restored message logs
attrib_id 108 = message log type attribute in the numeric_attrib table
attrib_value 2 = OPC message log
This query provides a listing of all OPC message logs and their respective MSGLOG
table names. Use the applicable table name(s) in the query below to get message text
and vendor-specific data for a specified time range.
11.2.2 Example Query for Data

SELECT rpad(a.message,50) message, rpad(source, 15) source, a.utc, a.time_nano,
NULL attr_name, NULL value
FROM msg3 a, msgattrs3 b, msgvendors c
WHERE a.idx = b.idx
AND a.localtime > to_date ('JAN-21-2001 00:00:18', 'MON-DD-YYYY
HH24:MI:SS')
AND a.localtime < to_date ('JAN-21-2001 00:00:20', 'MON-DD-YYYY
HH24:MI:SS')
UNION
SELECT NULL, NULL, a.utc, a.time_nano, rpad(c.attr_name,15,'_') attr_name,
rpad((b.nbr_value || rpad(b.str_value,30) || to_char(b.date_value, 'MON-DD-YYYY
HH24:MI:SS')),30) value
FROM msgattrs3 b, msg3 a, msgvendors c where a.idx = b.idx
AND b.attr_id = c.attr_id
AND a.localtime > to_date ('JAN-21-2001 00:00:18', 'MON-DD-YYYY
HH24:MI:SS')
AND a.localtime < to_date ('JAN-21-2001 00:00:20', 'MON-DD-YYYY
HH24:MI:SS')
3BUF001094-600 B 621
11 Reading Message Logs 11.3 System 800xA ATTVAL Oracle Function for
ORDER BY 3, 4
11.3 System 800xA ATTVAL Oracle Function for IM

Message Log
An oracle function entitled ATTVAL was developed to support the Excel Data Access
Data Direct component of System 800xA. The ATTVAL function may also be useful
for other SQL based applications.
The ATTVAL function was developed to improve access to the Vendor Specific at-
tribute values of the MSGLOG tables.
For each message a single row will be created in the base MSGLOG table, and several
rows will be created in the MSGATTRS table, one each for every Vendor Specific
attribute that the message defines. The combination of the MSG and all its Vendor
Specific attributes is the complete message as provided as an Event from the 800xA
System.
The Oracle function is as follows:
Function attval (logIdx in number, aid in number, msgIdx in num-
ber) return varchar2 as
query_str varchar2(2000);
nVal number;
sVal varchar2(4000);
dVal date;
The parameters for the attval function are defined as follows:
• The logidx (objectID of the IMMSGLOG).
• he aid (ATTR_ID from the MsgVendors).
• The msgidx (message IDX key from the MSG table).
To determine the LOGIDX Index use the following query:
select object_id, object_name from object_table where object_type
= 2;
To determine the AID use the following query:
Select attrid from MSGVENDORS
where ATTRNAME = ‘Vendor Attribute Name’;
Once the LOGIDX and AID have been determined for the specific system, these
values can be used in conjunction with the ATTVAL function to return the Vendor
Specific Attributes Values.
622 3BUF001094-600 B
11 Reading Message Logs 11.3 System 800xA ATTVAL Oracle Function for
Example (additional examples can be generated using Excel Data Access):

SELECT DISTINCT TO_CHAR(L.LOCALTIME, 'mm-dd-yyyy hh24:mi:ss'),
L.MESSAGE, AttVal(49, 1015, L.idx) FROM OPS$OCSHIS.MSG49 L, MsgVendors
V, OPS$OCSHIS.MsgAttrs49 A WHERE L.LocalTime >= to_date('08-14-2008
08:11:09', 'MM-DD-YYYY HH24:MI:SS') and L.LocalTime <= to_date('08-15-2008
08:11:09', 'MM-DD-YYYY HH24:MI:SS') and L.IDX = A.idx and V.Attr_ID =
A.Attr_ID and ((V.Category = 37))‘m
The value 49 in the preceding query comes from the LOGIDX index query.
3BUF001094-600 B 623
624 3BUF001094-600 B
A Using Open Data Access A.1 ODA for Real-time Data
Appendix A Using Open Data Access
This section provides guidelines and reference information for using Open Data Access
(ODA) to support real-time and historical data access for third-party applications
such as Crystal Reports.
ODA does not support the concept of transactions, commits, or rollbacks. The
following statements specifically CANNOT be used:
BEGIN TRANSACTION
COMMIT TRANSACTION
ROLLBACK TRANSACTION
The following topics are covered:
• ODA for Real-time Data on page 625.
• ODA for Historical Data Access on page 632.
• Accessing ODA Programmatically using ADO on page 655.
An Information Management Browser tool is provided to facilitate locating and
selecting OPC data points on the connected OPC server. The operation of this tool
is described in Information Management Browser on page 524.
A.1 ODA for Real-time Data

Open Data Access supports two methods for real-time data access. The primary
method is to use custom database tables configured through the Database and Table
Definition aspects. These tables support both read and write access.
In addition to these custom tables, there is one preconfigured table named Generic_DA.
This table consists of one row for each property in the system and provides access to
all properties in objects under the Object Root of the current database. It is used to
access properties in untyped objects, or objects to which extra aspects or properties
have been added, without having to create a table definition for each such object.
3BUF001094-600 B 625
If multiple properties are to be read from a group of objects of the same type, it will
be more efficient to use a custom table. Also, for security reasons, the generic_DA
table is read-only; configured tables must be used in order to modify any property
values. Configuring Open Data Access is an Information Management configuration
topic.
A.1.1 Guidelines for Using Custom Database Tables

The custom database tables support Select and Update (for writable columns). Insert
and Delete are not supported.
Columns defined to represent the :NAME, :PATH, and :ID object attributes, or any
Name Category, are indexed to improve efficiency when they are used in the WHERE
clause of a query. This is the recommended way to select objects. These columns
support the LIKE keyword (so that wildcards can be used), and are case-insensitive.
The use of these columns is not required, however; queries with no WHERE clause
will get all objects of the given type, and other columns may be used, for instance,
to find all objects of the type with a given status.
• If the column name includes a dot (.), space, or other special character, the
column name text string must be delimited with double quotation marks when
used in a query, for example: SELECT “object1.value” FROM ai. Some client
programs, for example Microsoft Query, handle this automatically.
• For table names that have leading numeric characters (for example 01Motor,
or are completely numeric (01), the name must be entered in double quotation
marks (“01Motor”).
All qualities except those which are indexed are nullable, in order to handle missing
objects or aspects.
Data quality (columns with "_qual" appended to their names because a column was
configured to support data quality) is returned in the form of an OPC data quality
code. To make it easier to use these, the following scalar functions are supplied:
• isQualityGood(x).
• isQualityBad(x).
• isQualityUncertain(x).
• isQualityNotYetReceived(x).
These return 1 when they are true, and 0 when they are false. For example, to find
all objects with bad data quality on the Value column, use
626 3BUF001094-600 B
"WHERE isQualityBad(value_qual)=1".
When a table is defined on an instance rather than an object type, it will have just one
row. In this case it is not necessary to use a WHERE clause to specify the name.
A.1.2 Sample Queries for Custom Database Tables

These examples are based on an ODA configuration which includes a table AI on the
AnalogInCC object type, with columns including Name (:NAME), Description
(:DESCRIPTION), Id (:ID), Value (with Value_Qual, Value_Time), and Status. There
are two AnalogInCC objects called AI1 and AI2. In the samples below, SQL keywords
are in capitals and words specific to the database are in lower case; this is just for
convention, and is not required.
• To get one property from one object.
SELECT value FROM ai
WHERE name='ai1'
WHERE path=’[direct]Root/MyProgram/AI1’
WHERE id=’{E8A75B02-E95E-4943-999D-2C4E266CE17C}’
• To get one property from all objects of the type.
• To get one property from several objects of the same type.
WHERE name='ai1' OR name='ai2'
• To get selected properties from all objects of the type with value less than 50.
SELECT name, value FROM ai
WHERE value<50
• To get selected properties from all objects of the type with good data quality.
SELECT name, value FROM ai
WHERE isqualitygood(value_qual)=1
• To get all configured properties from one object.
SELECT * FROM ai
WHERE name=’ai1’
3BUF001094-600 B 627
SELECT * FROM ai
WHERE id=’{E8A75B02-E95E-4943-999D-2C4E266CE17C}’
• To get all configured properties from all objects of the type, and sort them alpha-
betically.
SELECT * FROM ai
ORDER BY name
• To get all properties from several objects with related names, using LIKE and
wildcards.
SELECT * FROM ai
WHERE name LIKE ’ai%’
• To get a property from each child of a given object that has a given type (complex
query using join).
This assumes there is a table named Group defined for an object type whose in-
stances have AnalogInCC objects as children in the Control structure.
SELECT c.name, c.value FROM group AS p, ai AS c
WHERE p.name=’group1’
AND c.parent=p.id
• To set the value of one property in an object.
This requires the column to be configured as writable.
UPDATE ai SET value = 5 WHERE name = ‘ai1’
A.1.3 Guidelines for Using the Generic_DA Table

The contents of the generic_DA table are described in Table A.1. Each row is identified
by either the name, ID, or path of the object, together with the name of a property in
that object. It is also possible to use the Object_Type column to find all objects of a
specific type, optionally specifying the property to be found in those objects. Any
query against this table MUST use one of these keys (marked in PK column in Table
A.1).
Other columns include the value of the property represented by a row, together with
its data quality and timestamp, in addition to all the object attributes that may be read
from any object via configured tables.
Each of the keys is compatible with the LIKE keyword, allowing wildcards. The path
follows Operator Workplace rules, allowing such features as [up], [down], [direct],
628 3BUF001094-600 B
and name categories. It is not necessary to give a complete path, but it is recommended
to guarantee that an object is specified uniquely. Structure categories should be
avoided, because any objects found must reside under the database's Object Root.
The Variant value is available from the Value column in the table. For ODBC, which
does not support Variants, the value is presented as a FLOAT, INTEGER, and
VARCHAR in the Value_Flt, Value_Int, and Value_Str columns respectively. The
Value_Type column indicates which of these best matches the actual data. For exam-
ple, a real value 1.23 will appear in the three data types as 1.23, 1, and "1.23" respec-
tively, but the first of these is most accurate. Some values can not be converted, but
will result in NULL in one or more columns; for example, a string value of "12", or
a numeric value of 12, will appear correctly in all three types, but a string value of
"A" or "" will produce nulls in the two numeric types. A timestamp such as "2002-
08-16 12:00:00.000" will appear as the float 37484.5 (the way times are actually
stored in the system, as a fractional number of days), as the integer 37484 (just the
number of days), and as the string "8/16/2002 12:00:00 AM" (the date string as con-
verted within the server, following different rules than those used by the SQL client).
Sample queries are demonstrated in Sample Queries for Generic_DA on page 630.
Table A.1: Generic_DA Table
PK1 Field ODBC Type Description

X Name SQL_VARCHAR Name of the object.
X ID SQL_VARCHAR ID (Guid) of the object.
X Path SQL_VARCHAR Path to the object. This is returned as a complete
path, but may be specified as an incomplete path.
Keywords such as [Direct] or {Relative Name} are
allowed.
X Object_Type SQL_VARCHAR Type of the object.
X Property SQL_VARCHAR Name of a property in the object. This is the
second key that may be used with any of the four
primary keys above in order to specify a single
row of the table. If not specified, all properties of
the object will be returned, each in its own row.
Description SQL_VARCHAR Description of the object (object attribute
":DESCRIPTION").
3BUF001094-600 B 629
Table A.1: Generic_DA Table

(Continued)
PK1 Field ODBC Type Description

HierName SQL_VARCHAR Hierarchical name of the object (object attribute
":HIERNAME").
Parent SQL_VARCHAR ID of the object's parent (object attribute
":PARENT").
Domain SQL_VARCHAR Domain of the object (object attribute ":DOMAIN").
ARD SQL_VARCHAR Absolute Reference Designation of the object
(object attribute ":ARD").
Value_Flt SQL_FLOAT Value of property as float.
Value_Int SQL_INTEGER Value of property as integer.
Value_Str SQL_VARCHAR Value of property as string.
Value_Type SQL_VARCHAR Data type of property: string "FLOAT",
"INTEGER", or "VARCHAR".
Value_Qual SQL_INTEGER Data quality of property.
Value_Time SQL_ Time when property was last changed.
TIMESTAMP
1. Any query against this table must use one of the marked Primary Keys.
A.1.4 Sample Queries for Generic_DA

The more complex queries (the last two in particular), should not be used often, as
they will be very inefficient; but they may be of use in browsing a system.
The value of the property column must be specified fully (including the aspect name),
but the LIKE keyword can make it easier to use (and less efficient).
All keys (Name, Path, ID, and Object_Type, as well as Property) are case-insensitive,
so they need not be capitalized correctly in a WHERE clause as they are in these ex-
amples.
• To get one property from one object.
SELECT value FROM generic_da
WHERE path='/My Objects/Object 1'
AND property='GENERAL PROPERTIES:PROPERTY1'
630 3BUF001094-600 B
NOTE: This is an incomplete path.

WHERE path='[Direct]Root/My Objects/Object 1'
NOTE[direct] ensures that the path is complete)
WHERE name=' Object 1'
WHERE id='{E8A75B02-E95E-4943-999D-2C4E266CE17C}'
AND property LIKE '%:property1'
NOTE: In order to omit the aspect name, wildcards are required.
• To get one property (and object name) from all objects of a type.
SELECT name, value FROM generic_da
WHERE object_type='My Object Type'
• To get value of all properties from one object.
SELECT property, value FROM generic_da
WHERE path='/My Objects/Object 1'
WHERE id='{E8A75B02-E95E-4943-999D-2C4E266CE17C}'
• To get all value of properties from all objects of a type:
SELECT name, property, value FROM generic_da
WHERE object_type='My Object Type'
• To get a property from each child of a given object that has a given type (complex
query using join).
SELECT c.name, c.value FROM generic_da as p, generic_da as c
WHERE p.name=' Object 1'
3BUF001094-600 B 631
A Using Open Data Access A.2 ODA for Historical Data Access
AND c.parent=p.id
AND c.object_type='My Object Type'
AND c.property='GENERAL PROPERTIES:PROPERTY1'
• To get several properties with related names, from several objects with related
names, using LIKE and wildcards.
SELECT name, property, value FROM generic_da
WHERE name LIKE ' Object %'
AND property LIKE 'general properties:property%'
• To get names of all objects of the type whose parent is a Control Module.
This example uses the generic_da table in combination with a custom table.
SELECT c.name FROM ai AS c, generic_da AS p
WHERE c.parent=p.id
AND p.object_type='Control Module'
A.2 ODA for Historical Data Access

COM-compliant applications such as Crystal Reports can submit SQL queries toward
the Numericlog table provided with the ODA server. This table supports access to
data stored in numeric property logs, and is described in Table A.2.
Table A.2: NumericLog Table
Field String1 Description

LOGNAME X Access name or log name for the numeric log. Use the
Information Management Browser as described in Information
Management Browser on page 524.
AGGREGATE X Raw - retrieves stored values with actual time stamps.
Interpolative retrieves interpolated values with evenly distributed
time stamps based on the interpolation interval.
If an aggregate is not specified, raw data will be retrieved by
default.
INTERVALS Time in seconds between interpolated data points. Default value
= 1 second.
TIMESTAMP Timestamp in local time. Must conform to ANSI SQL 92 spec.
632 3BUF001094-600 B
Table A.2: NumericLog Table

(Continued)

DATAVALUE Value of data.
QUALITY Data quality code. These codes are based on OPC Data Quality
constants. Refer to Table A.3.
1. Any field designated as String data must be entered in single quotes.
Table A.3: Data Quality Codes
Hex Code Decimal Code Description

0xC0 192 Good data
0x200C0 131264 Good interpolated data
0x400C0 262336 Good raw data
0x20000 131072 Bad interpolated data
0x40000 262144 Bad raw data
0x50000 327872 Good raw data with more than one entry for the same
time stamp. A time stamp may have more than one value
associated with it when adding values to or modify values
for an asynchronous log.
0x800C0 524480 Good calculated data
0x80000 524288 Bad calculated data
0x200000 2097152 No data
0x400000 4194304 Data lost (Collection started/stopped/lost)
A.2.1 SQL Query Structure

ODA places some restrictions on query structure and content. This section provides
guidelines for creating queries for ODA. Refer to the applicable third-party documen-
tation to learn how to write and execute queries in the client application. Use the ex-
ample queries in this section as the basis for queries in your own reports.
Following this section as refer to Query Guidelines on page 635, and Example Queries
on page 637.
3BUF001094-600 B 633
Basics
ODA supports the SELECT statement including all its clauses (INTO, FROM,
WHERE, GROUP BY, HAVING, and ORDER BY).
It also supports INSERT and UPDATE statements.
Example
SELECT DataValue, Quality FROM NumericLog
WHERE LogName = 'TC100:VALUE,Log1'
AND Timestamp > '2000-10-15 08:00:00'
AND Timestamp <= '2000-10-15 09:00:00'
SQL queries are not case-sensitive, except for text in single quotes. SQL keywords
(for example select) can be written in uppercase or lowercase. The same is true
for table and attribute names. Object (log) names must be entered exactly as they
were configured.
The basic clauses are briefly described below.
The SELECT Clause

The SELECT clause specifies the data to be retrieved (object attributes). Data values
can be manipulated mathematically. For instance, this example retrieves a value equal
to the data value plus 10:
SELECT DataValue + 10
The FROM Clause

The FROM clause specifies the ODA table name. All queries MUST be written toward
an ODA table.
The WHERE Clause

The WHERE clause specifies the conditions for the query. For numeric log queries,
the WHERE clause MUST specify the access name or log name for the numeric log.
The WHERE clause may also be used to specify additional conditions, for example
a time range.
634 3BUF001094-600 B
The ORDER BY Clause

The ORDER BY clause determines the order in which instances are returned. If an
order is not specified, the order is determined by an internal criterion. If the ORDER
BY attribute is specified, instances are returned in ascending order. Instances can be
specified to return in descending order by entering DESC after the attribute. For in-
stance:
ORDER BY DataValue DESC
A.2.2 Query Guidelines

Numeric history data is stored in log objects in the Information Management history
database. For example, a log named FC100:MEASURE,Log2 stores timestamped
instances of the measured value property for FC100.
Each instance is referred to as a log entry, or simply entry. The timestamp format
conforms to the ANSI SQL-92 standard as shown below:
Timestamp Data Value

2001-07-15 10:00:00 65.7
2001-07-15 10:01:00 66.4
2001-07-15 10:02:00 65.9
2001-07-15 10:03:00 66.7
and so on...
Review the guidelines in this section, and then refer to the example queries shown
in:
• Basic Query for Numeric Data on page 637.
• Query for Numeric Data from a Secondary Log on page 637.
• Query for a Specific Time Range on page 638.
• Query for Interpolative Data on page 638.
A.2.3 Specifying the Log in a Query

For numeric log queries, the WHERE clause MUST specify the log’s access name
or log name. If this name is not supplied, ODA will not return data. Also, the named
log must already exist in the History database on the Information Management node.
3BUF001094-600 B 635
Aggregate
Either raw or interpolative data can be requested. If an aggregate is not specified, raw
data will be retrieved by default. The AIPHDA and IMHDA servers support different
aggregates. The AIPHDA aggregates are:
Interpolative Total Average Time Average

Count Std Dev Minimum Actual Time Minimum
Maximum Start End Delta
Regslope Reg Const Reg Dev Variance
Range Duration Good Duration Bad Percent Good
Percent Bad Worst Quality Raw
The IMHDA aggregates are:

INTERPOLATIVE
OPCHDA_TIMEAVERAGE
OPCHDA_MINIMUM
OPCHDA_MAXIMUM
Raw
The aggregate lists for AIPHDA and IMHDA are subject to change. Obtain a
definitive list of aggregates currently supported on the system by executing the
following query:
SELECT AGGREGATE FROM NUMERICLOG
Intervals
When the retrieval type is interpolated, the intervals variable establishes the time in-
terval between data values. The default interpolation interval is 1 second. Specify a
different interval as required. The interval unit is seconds. Enter the quantity as an
integer. For example to make the interpolation interval 5 seconds, set the Intervals
attribute to 5.
636 3BUF001094-600 B
Time Range
While a time range is not required in the query, it is recommended. If a complete time
range (with start and end time) is not specified, all data occurring within that time
range will be returned.
If a time range is not specified, or if an open-ended time range (just start time, or just
end time) is specified, all qualified data will be returned. It is not limited.
Timestamp Format
All timestamps must conform to the ANSI SQL-92 specification. This format is yyyy-
mm-dd hh:mm:ss[.fffffffff], where f is an optional up-to-nine digit parameter repre-
senting nanoseconds.
A.2.4 Example Queries

The examples below are applicable for the AIPHDA server. Additional considerations
for the IMHDA server are described in IMHDA Access on page 640.
In the following queries SQL keywords are shown in UPPERCASE for emphasis,
however, they can also be written in lowercase.
A.2.5 Basic Query for Numeric Data

This query does not specify a time range or instance. Therefore, it returns all entry
values with their respective timestamps for TC100:MEASURE. If no timestamp range
is specified, data will be gathered from the earliest time with valid data until the latest
time with valid data or until the maximum number of records is achieved.
Query:
SELECT LogName, Timestamp, DataValue, Quality
FROM NumericLog
WHERE LogName = ‘TC100:MEASURE,Log1’
A.2.6 Query for Numeric Data from a Secondary Log

A query for a secondary log should use the full log name, if known. This insures access
to the intended log. If just the access name is used, the seamless retrieval function
3BUF001094-600 B 637
will select the log based on the seamless retrieval criteria as described in Criteria for
Selection for Seamless Retrieval on page 34.
This query is identical to the one before, except that it uses the full log name to
specify a secondary log.
Query:
SELECT LogName, Timestamp, DataValue, Quality
FROM NumericLog
A.2.7 Query for a Specific Time Range

This query is similar to the basic numeric query. The WHERE clause is expanded
with two AND phrases that specify the time range as: after 13:34 (1:34 pm) on
February 15, 2001, and before 13:37 (1:37 pm) on February 15, 2001.
Query:
SELECT Timestamp, DataValue
FROM NumericLog
AND Timestamp >=‘2001-02-15 13:34:00’
AND Timestamp <= ‘2001-02-15 13:37:00’
A.2.8 Query for Interpolative Data

An interpolation feature of the NumericLog view is used to query for data at fixed
intervals such as every five, ten, or fifteen minutes, even if data is not sampled and
stored at such intervals.
The following example shows how to read interpolated values from a numeric log
with a one-minute time interval, and a time span of 12 hours. Note that the Aggregate
and Intervals in the where clause must be specified.
Query
SELECT Timestamp, DataValue
FROM NumericLog
WHERE LogName = ‘tc100:value,Log1’
AND Aggregate = ‘interpolative‘
638 3BUF001094-600 B
AND Intervals = 60
AND Timestamp >=‘2001-02-15 8:00:00’
AND Timestamp <= ‘2001-02-15 20:00:00’
A.2.9 UPDATE and INSERT Functions

Updates and Inserts are supported for asynchronous lab logs. These apply only to
Raw data.
These commands insert or update the DATAVALUE. The insert query also is used
to specify the data quality (QUALITY) as good or bad. For updates the data quality
is always set to good whether the original value was good or bad.
The examples below are applicable for the AIPHDA server. Additional considerations
for the IMHDA server are described in Using UPDATE and INSERT with the IMHDA
Server on page 641.
Insert Query Examples:

The code for good data quality in decimal is 192. To insert a bad data quality, use the
decimal code 0, or any value other than 192.
If no data quality code is specified, the data quality will be set to good by default.
The INSERT and UPDATE functions only accept data quality in decimal format.
Examples - Good Data Quality:

INSERT INTO NumericLog (Logname, Timestamp, DataValue) VALUES
('TC100:MEASURE,Log1', '2002-04-10 13:34:00', 123.45)
INSERT INTO NumericLog (Logname, Timestamp, DataValue, Quality) VALUES
('TC100:MEASURE,Log1', '2002-04-10 13:34:00', 123.45, 192)
Example - Bad Data Quality:
('TC100:MEASURE,Log1', '2002-04-10 13:34:00', 123.45, 0)
Update Query Example:

UPDATE NumericLog SET DATAVALUE=123.4 WHERE Logname='TC100:MEA-
SURE,Log1' and Timestamp='2002-04-10 13:34:00'
3BUF001094-600 B 639
A.2.10 IMHDA Access

When specifying the log for queries against the NumericLog table, there are three
methods that support different data access requirements. Each method requires a
different prefix be used which determines which provider is used as the data connection
for accessing data. The prefixes are LOGMAN, EH_NET and EH.
These methods are only applicable for queries against the NumericLog table.
PPA Naming
With out any prefix, the IM HDA server supports any valid PPA OPC/HDA item ID
for a IM numeric log defined in system. If the item ID works for PPA OPC/HDA and
item ID points to a IM numeric log, it should work for IMHDA.
Examples:
[Control Structure]Root/Object1:Property1,Log1
Object1:Property1,Log1
{Object GUID}{Aspect GUID}:Property1,Log1
LOGMAN
LOGMAN uses the local log manager to access logs on any server with which the
local log manager can communicate. This is the only method that is used to use access
name. Use this method when the location of the log is not known or it is unimportant
where the log is located. This is the default if no prefix is specified.
Examples:
'LOGMAN.$HSTC100,MEASURE-1-o'
'LOGMAN.TC100,MEASURE
'$HSTC100,MEASURE-1-o'
'TC100,MEASURE'
This method does not support UPDATE or INSERT statements in SQL queries.
640 3BUF001094-600 B
EH
EH communicates with the local History server only. This is the fastest method and
is recommended when querying a log that resides on the local History server. The
log name must be used in conjunction with this prefix.
Example:
'EH.$HSTC100,MEASURE-1-o'
This method supports UPDATE statements in SQL queries. It does not support
INSERT statements.
EH_NET
EH_NET connects directly to a specified History server. This requires specifying the
node name or IP address. Use this method to query a log on a specific History server.
For example, use this when the system uses duplicate log names.
The log name must be used in conjunction with this prefix. The IP address is specified
by string IP followed by four sets of numbers separated by underscores (_).
Examples:
'EH_NET.eng130.$HSTC100,MEASURE-1-o'
'EH_NET.IP130_110_66_130.$HSTC100,MEASURE-1-o'
This method supports both UPDATE and INSERT statements in SQL queries.
Using UPDATE and INSERT with the IMHDA Server

When using the IMHDA server, Insert statements require the EH_NET provider be
used. Refer to EH_NET on page 641.
Update statements are supported by both EH_NET and EH providers.
Insert Query Examples:

The code for good data quality in decimal is 192. To insert a bad data quality, use the
decimal code 0, or any value other than 192.
If no data quality code is specified, the data quality will be set to good by default.
Examples - Good Data Quality:
3BUF001094-600 B 641
A Using Open Data Access A.3 ODA for Profile Data Access
INSERT INTO NumericLog (Logname, Timestamp, DataValue) VALUES

('EH_NET.eng130.$HSTC100,MEASURE-1-o', '2002-04-10 13:34:00', 123.45)
('EH_NET.eng130.$HSTC100,MEASURE-1-o', '2002-04-10 13:34:00', 123.45, 192)
Example - Bad Data Quality:
('EH_NET.eng130.$HSTC100,MEASURE-1-o', '2002-04-10 13:34:00', 123.45, 0)
Update Query Example:

UPDATE NumericLog SET DATAVALUE=123.4 WHERE Log-
name='EH.$HSTC100,MEASURE-1-o' and Timestamp='2002-04-10 13:34:00'
A.3 ODA for Profile Data Access

History profiles are used to monitor critical quality measurements in flat-sheet man-
ufacturing applications. For instance, in the Pulp and Paper industry history profiles
may be used to monitor basis weight and moisture content. Collection, storage and
retrieval of the profile data is supported by the Profile Historian. COM-compliant
applications such as Crystal Reports can submit SQL queries toward the two pre-
configured tables for profile data access provided with the ODA server. These tables
are described in:
• Table A.4 - ProfileLog Table - This table supports access to the profile data
which is common to all data boxes for a given scan array.
• Table A.5 - ProfileLogData Table - This table supports access to all data box
values for a given scan array.
– ODA supports SQL SELECT statements only for profile data access.
– Profile data access is via the IM HDA server. The ODA server must reside
on the same node as the IM HDA server.
Table A.4: ProfileLog Table

LOGNAME X Log name for the profile log (full log name required).
642 3BUF001094-600 B
Table A.4: ProfileLog Table

(Continued)

MACHINEPOSITION The position of the sensor along the spool of paper (distance
from the beginning of the spool).
FIRSTBOX The first sensor that gathers data along the spool.
LASTBOX The last sensor that gathers data along the spool.
LOWVALUE Low data value from the profile log.
HIGHVALUE High data value from the profile log.
AVERAGEVALUE Average data value from the profile log.
PROFILESIZE The number data samples within a profile log.
CONTENT Bitset which indicates presence or absence of data for the
different fields in the ProfileLog and ProfileLogData tables.
0x0001 - Array Data (log data values)
0x0002 - Array Status
0x0004 - Average Value
0x0008 - Min Value
0x0010 - Max Value
0x0020 - Machine Value
Bitset = 63 (decimal) indicates all values present
Bitset = 0 indicates no values present
Table A.5: ProfileLogData Table

LOGNAME X Log name for the profile log (full log name required)
DATABOX The index of the Data Values.
DATAVALUE Value of Data.
QUALITY Data quality code. Refer to Table A.3.
3BUF001094-600 B 643
A.3.1 Profile Historian Example

When accessing the ProfileLog or ProfileLogData table, use the log name with the
EH. prefix, for example: 'EH.$HSTC100,MEASURE-1-o'. EH communicates with
the local History server.
The following example shows how to use a query against the ProfileLog table to get
a valid data box range, and then use the data box range in a second query to get the
scalar values stored with each scan such as MachinePosition and FirstBox, LastBox.
In an AC450 system, the FirstBox/LastBox range is 0-based, so the indices will
align correctly with the values in the data boxes. In a QCS system, this range is
1-based so the indices will be mis-aligned by one box against the value in the data
boxes. The example below compares the indices for the two different systems
when the same array data occurs in both systems.
Comparing Data Box Indices for AC450 and QCS
System FirstBox LastBox Description

AC450 45 565 These indices are correctly aligned.
QCS 46 566 These indices are offset by one.
Queries
This query returns the valid range of indices for data boxes, as well as other informa-
tion stored in the ProfileLog table.
Select * from ProfileLog where LogName =‘EH.$HSPM1.S1.CW1.PROF-1-o’
AND TimeStamp > '2002-4-1 12:00:00'
AND TimeStamp < '2002-4-1 12:30:00'
Given that the above query returned a data box range of 45-565, this query returns
values for databoxes 45 to 565.
Select * from ProfileLogData where LogName =‘EH.$HSPM1.S1.CW1.PROF-1-o’
AND TimeStamp > '2002-4-1 12:00:00'
AND TimeStamp < '2002-4-1 12:30:00'
AND DataBox <= 565
AND DataBox >= 45
644 3BUF001094-600 B
A Using Open Data Access A.4 Connecting Client Applications to an ODA
A.4 Connecting Client Applications to an ODA

Database
The following tutorials demonstrate how to connect a client application to an ODA
database and access data:
• Using Crystal Reports on page 645.
• Using Excel Without DataDirect Add-ins on page 479.
A.4.1 Using Crystal Reports

In order for the reports created with Crystal Reports to be able to access data from
the 800xA System, the reports must be connected to an Open Data Access (ODA)
database. The ODA database specifies which database tables the report will be able
to access. One ODA database named ABBODA is provided as standard. By default
this ODA database supports access via the predefined numericlog (history) and
generic_da (real-time) tables.
The default set up for ABBODA can be changed and/or additional ODA databases
created. Configuring ODA is an Information Management configuration topic.
The reports may be connected to a selected ODA database via an OBDC data source.
This method is demonstrated in this section.
This connection must be established for each new report created, or to change the
connection for an existing report.
The tool for establishing a data provider connection in Crystal Reports is the Data
Explorer. The procedure for using the Data Explorer is the same whether a new report
is created or an existing one opened. The only difference is how the Data Explorer
is accessed.
Accessing the Data Explorer

When creating a new report in Crystal Reports, either create the new report as a blank
report, or use the Report Wizard listed in the Start Page of Crystal Reports.
If the Report Wizard is being used, then Figure A.1 is displayed. Then refer to Connect
to an ODA Database from Data Explorer on page 646.
3BUF001094-600 B 645
Figure A.1: Launching Data Explorer Via Report Expert
If creating the new report as a blank report, the Data Explorer is launched directly
upon making that selection.
Connect to an ODA Database from Data Explorer

The Data Explorer is used to connect a new or existing report to an ODA database.
This section shows how to make the connection via an ODBC data source. Reference
Figure A.6:
1. Verify whether ABBODA datasource is listed under the My Connection tree. If it
is not, expand Create new Connection > ODBC(RDO) to launch the ODBC(RDO)
dialog.
2. Select ABBODA datasource and click Finish.
3. If no tables are visible under ABBODA > SCHEMA, right-click ABBODA and
select Options menu to launch the Options dialog.
4. Select Tables under Data Explorer and click OK.
5. Click -/+ of the ABBODA connection to refresh and display the Tables.
646 3BUF001094-600 B
Table A.6: Data Explorer - ODBC Access
6. Select one or more schemas that the report will access (the example in Figure
A.6 shows BATCHTRENDs added):
a. Select a schema, then click Add. This adds the schema to the
Tables available for report list in the Report Expert, Figure A.6.
b. Repeat Step 6a for as many schemas as required, then click Close.
Connect to an Oracle Table, View, or Synonym from Data Explorer

Access to Oracle-based PDL data such as job (campaign) names and batch start/end
times is via PDL views which are connected to the report via an ODBC driver. This
driver should already have been configured during the Oracle ADO data provider
setup. In this example, the name of the ODBC DataSource is LocalHost.
Use the Data Explorer to connect the subreport to LocalHost. Perform the following:
1. Click the +/- button next to ODBC, Figure A.7. This shows all ODBC Data-
Sources available on this computer.
3BUF001094-600 B 647
Table A.7: Data Explorer
2. Select the ODBC DataSource that supports the ADO data provider for Oracle
access. In this example, this datasource is named Localhost. Click Finish. This
displays the associated tables, views, and synonyms of the selected driver accord-
ing to the specified viewing options, Figure A.2. Filter this list to simplify the
search for the applicable synonym.
648 3BUF001094-600 B
Figure A.2: Standard Report Creation Wizard
3. Right-click the localhost connection and select Options menu to display the
Options dialog.
4. Clear all Show options except Tables, Views and Synonyms , Figure A.8.
5. Click OK when finished.
3BUF001094-600 B 649
Table A.8: Selecting Synonyms as the Show Option
6. To apply these new explorer options, toggle (hide/show) the driver’s list. To do
this, go back to the -/+ button for the driver, click - to hide the view, and then
click + to re-show it. Now only Synonyms with the specified like string are listed
under the driver’s expanded view.
7. Expand History and select the PDL_TASK_VIEW, Figure A.3, then click >.
This adds the selected synonym to the list of tables (views and synonyms)
available for the report.
650 3BUF001094-600 B
Figure A.3: Selecting PDL_TASK_VIEW
8. Select the attributes from the PDL_TASK_VIEW to be included in the subreport.

For example: TASKID, TASKNAME as shown in Figure A.4 using the Standard
Report Expert.
3BUF001094-600 B 651
Figure A.4: Choosing the Information to Display on the Report
9. Click Finish to fetch the all available TaskID and TaskName Oracle database
of a particular node. An example of this result is shown in Figure A.5.
Figure A.5: Available TaskIDs and TaskNames Example
652 3BUF001094-600 B
For further information regarding PDL access, refer to Appendix B.

1. Parameters can be added to the reports to filter or limit the data retrieved from
the database based on user preferences. In the example, the TaskName retrieval
is being filtered based on the TaskID parameter. This can be done as follows.
Right-click Parameter Fields in the Design view of the report, using the Field
Explorer, and select New to add a parameter. This is shown in Figure A.6.
Figure A.6: Adding a Parameter
2. This launches the Create New Parameter dialog to create a variable. vartaskID
is the variable of type Number used in this example (Figure A.7).
Figure A.7: Create New Parameter Dialog
3BUF001094-600 B 653
3. Use the Select Expert > Record to set the TASKID field (from
PDL_TASK_VIEW) equal to the vartaskID parameter, Figure A.8. This directs
the query to retrieve batch data for a given TASK_ID specified via vartaskID.
Click OK to close the dialog.
Figure A.8: Select Expert - Record Dialog
4. To fetch the report data, Click F5 or Report > Refresh Report Data. This
launches the Enter Values dialog where a value for the parameter vartaskID is
provided, as shown in Figure A.9.
Figure A.9: Enter ValuesDialog
654 3BUF001094-600 B
A Using Open Data Access A.5 Accessing ODA Programmatically using ADO
5. Click OK to retrieve the data.
A.5 Accessing ODA Programmatically using ADO

As an alternative to using a desktop application such as Crystal Reports or Microsoft
Excel, ODA databases can also be connected programmatically via an ADO object.
The program must specify the ODA data provider and database. The connection string
that performs this function is highlighted in bold type in the example VB program
below.
ODA does not support record-level locking of data, nor does it support transaction
handling such as Commits and Rollbacks.
The Provider is set to ABBOpenDataAccess. The Data Source is set to the ODA
database name, in this case: Database1.
Private Sub Command1_Click()
Dim adoconn As New ADODB.Connection
Dim i As Long
Dim query As String
Dim temp As String
On Error Resume Next
adoconn.ConnectionString = "DSN=ABBODA;Data Source=ABBODA"
adoconn.Mode = adModeRead
adoconn.Open , , , adOpenUnspecified
If Err.Number = 0 Then
Set rs = New Recordset
query = "select datavalue from numericlog where logname = 'SIN-
000000:MEASURE,PPA'"
rs.CursorLocation = adUseClient
rs.CacheSize = 1000
rs.Open query, adoconn, adOpenForwardOnly, adLockOptimistic,
adCmdText
If Not rs Is Nothing Then
If rs.RecordCount > 0 Then
formPopup.SetMax rs.RecordCount
i = 0
While Not rs.EOF
temp = rs("DataValue").Value
rs.MoveNext
Wend
End If
End If
End If
End Sub
3BUF001094-600 B 655
656 3BUF001094-600 B
B PDL for Batch Management B.1 PDL Extractor
Appendix B PDL for Batch Management
The Production Data Log (PDL) and OPC message Log applications support data
storage and retrieval for Batch Management. PDL software is an option for the Infor-
mation Management History Server function. PDLs are History logs that store pro-
duction data such as batch start/end times, batch variables, and recipe data. PDL
supports collection, storage, and retrieval of this production data for presentation in
batch reports.
The following sections provide guidelines and reference information for accessing
PDL and OPC message data for Batch Management.
B.1 PDL Extractor

The PDL Extractor is the utility for restoring batch archive information from PDL.
The file formats created by the extractor are used with the Batch Management History
Overview for viewing PDL PFC archives. Refer to the Batch History Overview section
in System 800xA Batch Management Operation (3BUA000145*).
B.2 Installing the PDL Extractor

The PDL Extractor is bundled with the Information Manager.
To install the PDL Extractor, perform the following steps:
1. Double click ABB Inform IT - PDL Browser Light.msi.
PDL Browser Light.msi can be found under <System 800xAmedia>\Applications\In-
formation Management\ as in Figure B.1.
3BUF001094-600 B 657
B PDL for Batch Management B.3 Launching the PDL Extractor
Figure B.1: PDL Browser Light.msi
1. Follow the installation procedures given in the installation wizard and install the
PDL Extractor.
PDL Extractor utility can be launched through: Program>ABB Industrial IT 800xA>
Production Mgmt - Batch> Utilities >PDL Batch Procedure Extractor
B.3 Launching the PDL Extractor

After the installation, the Extractor directory is available in IM server node as in
Figure B.2.
658 3BUF001094-600 B
B PDL for Batch Management B.4 Using PDL Extractor
Figure B.2: Extractor Directory
Select the ABB Batch Procedure Extractor to launch the PDL extractor.
B.4 Using PDL Extractor

1. Select the Start Date and then click the Query Data button.
3BUF001094-600 B 659
Figure B.3: PDL Extractor Data Query
2. Drill down to the last level until two recipes are listed as in Figure B.4.
660 3BUF001094-600 B
Figure B.4: Batch Extractor Recipes
3. Highlight one of the recipes.

4. Click the button Extra Selected Item.
5. Click Save in the pop-up appears as in Figure B.5.
Figure B.5: Extract selected data to file
3BUF001094-600 B 661
B PDL for Batch Management B.5 Setting up PDL Extractor
B.4.1 Viewing the PFC

1. Delete the batch recipe from the batch historian and the PFC displays from the
PDL extractor.
2. Click the PDL PFC button in the Batch history Overview.
Figure B.6: PDL PFC
It will launch a Windows Explorer to find an xxx.PFC file.

1. Click the file, the PFC will be displayed on the screen.
B.5 Setting up PDL Extractor

Set up steps to let IM save the batch PFC displays are as follows.
1. IM server should be running in the system, PDLMSGLOG object should be
created and activated in the system.
2. To make the PDL extractor working, check Use 800xA Historian check box as
in Figure B.7.
662 3BUF001094-600 B
Figure B.7: PDL Extractor
3. Select System Variable HS_CLIENT_DATA on the IM server node.
3BUF001094-600 B 663
Figure B.8: HS_CLIENT_DATA
4. Set up HS_CLIENT_DATA shared permissions to everyone. After the execution

of a batch receipe, files are sent to EH_Transfer directory. Figure B.9.
664 3BUF001094-600 B
B PDL for Batch Management B.6 Configuration Requirements for Batch Man
Figure B.9: EH_Transfer Directory
5. At the IM server side, set up a shared directory as well. For more information
refer to Setting Up Storage of Batch Procedures in PDL.
B.6 Configuration Requirements for Batch Manage-

ment
PDL data storage only supports batch procedure paths of 40 characters or less.
Batch Management can:

• Send task information to the PDL. For example campaign, batch, unit procedure,
operation and phase start/end times.
• Send history associations for creation of logs, and time markers for specific his-
tory data. How to do this is described in Establishing History Associations in
Batch Management on page 667.
• Send variable/tag data to be stored with the tasks.
3BUF001094-600 B 665
• Send batch procedures to the PDL for PFC archive and retrieval.
This requires some set up on both the Batch Management node and the Information
Management server where the PDLs reside. This set up is described in Setting Up
Storage of Batch Procedures in PDL on page 670.
B.6.1 Batch Management Data Flow

Data passes from the Batch Manager to the Information Manager as a series of events.
These events produce records (tasks) in the Production Data Log in the Information
Manager. The Production Data Log is a series of views and tables that represent the
events. Certain events, for example the starting of a job, batch, or subprocedure occur
automatically. Other records are recorded based on the command added to the batch
recipe.
The resulting information is stored in the Production Data Log (PDL) as a set of as-
sociated records. Each record is associated to the parent by the parents record or task
identifier.
A record is created for a job (campaign) another record is created for a batch. Every
time a phase executes a new record is created. This also includes subprocedures
Resource transactions are created as a result of following BMAs actions: Acquire,
Reserve, Select, Release, Unreserved, and Deselect. Each time one of those blocks
execute, a new resource transaction is sent to PDL. The database level Acquire is al-
ways matched with Release, Reserve with Unreserved and Select with Deselect. As
a result there is a single record in PDL for each Acquire-Release pair.
Every time the Data Collection BMA with Start option is used, a new history associ-
ation is created. Data Collection BMA blocks with the Once option do not create an
association. An association links numeric trend data with the production data record.
There are approximately 12 task variables that get created every time a batch starts
and ends. Each completed batch will have at least 12 variables associated with the
batch. Every time a bdbput() function is used in an expression, a task variable would
be created. All procedure and phase parameters are also recorded as task variables.
B.6.2 Information Management Archive Sessions for Batch Management

Batch data archiving and aging is handled on a batch basis rather than strictly based
on time. When archiving occurs at the completion of a batch, all the production data,
events, and numeric logs associated to the batch are stored in one archive. The data
666 3BUF001094-600 B
is aged (removed) from the system based when the data was archived and a period
of retention period established.
This policy is established as part of the Information Manager Archive server. To ensure
that the system has been configured properly, make sure to specifically define the
Batch/PDL archive configuration policy. Refer to the Configuring the Archive
Function Information (specifically PDL Archive Configuration) section in System
800xA Information Management Configuration (3BUF001092*).
B.6.3 Establishing History Associations in Batch Management

Historical batch data is stored in numeric history logs which must be configured in
the Information Management History Services. Batch Manager Actions (BMAs)
configured in the Batch Management Recipe Procedure hierarchy create history asso-
ciations in a Production Data Log (PDL) on the Information Management server. The
history association marks the start and end times for log data that correspond to a
specific batch, Figure B.10. This is used to retrieve data for a specific batch without
having to know the actual time when the batch was executed.
History Services also supports archival of this data, and alternative retrieval methods
such as Inform IT DataDirect, Desktop Trends, Report Services, and SQL queries.
Guidelines for configuring BMAs to support this functionality are provided below
and illustrated in Figure B.11 and Figure B.12. Details regarding the configuration
of a Data Collection BMA are provided in the section on Collecting Data from an
PFC in System 800xA Batch Management Configuration (3BUA000146*).
Figure B.11 illustrates the procedure for creating a Data Collection BMA to start
history collection. A second BMA is required to stop history collection.
The Data Collection Rate should be start or stop. Start will flag the time the
block was executed as the start time of the History Association. Stop is optional
and should be used if it is desired to have different end times for the Batch and
History Associations. Without a specific Stop coded in the recipe, all History
Associations will have end times the same as the batch.
The Logical Name can be anything. Using one logical name for all the history
associations might make queries simpler to use. It could then be hard coded into
queries instead of having to be obtained from another query.
The OPC Item must be a valid PPA OPC DA or HDA path. If the item ID, ob-
ject:property, is not unique, then more of the path must be entered. If the exact
name of the history log is not known, use a browser or User Tag Management
3BUF001094-600 B 667
to locate the log and copy the log name. The name can then be pasted in the
BMA editor. This is illustrated in Figure B.12. Enclose both the Logical Name
and OPC Item with double-quotation marks.
The Information Management Browser is launched through the Windows Taskbar.
Choose ABB Start Menu > ABB System 800xA > Information Management >
Utilities > and select either IM User Tag Management or IM Structure Browser.
For further information, refer to Section 9 Tag Management.
Action to Start History Data Collection
Action to Stop History Data Collection
Figure B.10: Implementing a History Association in Batch Management
668 3BUF001094-600 B
Figure B.11: Configuring Data Collection BMAs for History Association
Figure B.12: Obtaining Log Name through the Information Management Browser
Logical Name and Item ID get mapped into the batch tables/views and the PDL
Browser as follows.
3BUF001094-600 B 669
Logical Name is ASSOCIATIONNAME in the pdl_history_view, NAME in the

HISTORY_ASSOCIATIONS table and the HISTORY_ASSOC_OCC_xx tables,
and Access Name in the PDL Browser.
Item ID gets translated to the HDA item for the DA item. For example:
[Control Structure]root/object:property
becomes:
[Control Structure]root/object :property,1s1d
where 1s1d is the IM log name on the property. This HDA item id then gets
stored as LOGNAME (not Logical Name) in the PDL view / tables and the PDL
Browser. The HDA Item ID stored in LOGNAME must be used to retrieve Nu-
meric Data.
B.6.4 Setting Up Storage of Batch Procedures in PDL

Batch procedures are periodically deleted from online storage on the Batch Manage-
ment application server. These procedures can be stored in PDLs on the Information
Management node for long-term storage. This enables the batch procedures to be re-
trieved and the PFCs viewed, even after they have been deleted from online storage.
Batch procedures to be stored in the PDL are temporarily held in a folder named
EH_Transfer on the Batch Management node. The Information Management node
copies the batch procedures from this folder to a local folder on the Information
Management node. The local folder on the Information Management node must be
shared as HS_CLIENT_DATA. This is where the PDL will look to collect the batch
procedures.
Some set-up is required on the Information Management server in order to implement
this functionality. Specifically, a folder on the Information Management node must
be shared as HS_CLIENT_DATA. Instructions for this set-up procedure are provided
below.
Setting Up a Shared Folder on the Information Management Node

An existing directory may be used to share as HS_CLIENT_DATA; however, a new
one should be created specifically for this purpose. Whether an existing directory is
used, or a new one created, the directory must be located on the drive where the
History Services software is installed and where the PDL will reside.
To share the directory:
670 3BUF001094-600 B
1. Select the directory, right-click, and then choose Sharing… from the context
menu. The directory's Properties dialog get displayed.
2. Click the button Advanced Sharing to launch the dialog box to set the permis-
sions to access the folder.
Figure B.13: PDL Properties
3. Type HS_CLIENT_DATA in the Share name field. Figure B.13.

4. Click Permissions button. (You will find user did not have full control)
5. Check the check box Allow for Full control, Change and Read options.
3BUF001094-600 B 671
B PDL for Batch Management B.7 Accessing PDL Data (Using PDL Task ID)
Figure B.14: Permissions for doc
6. Click OK when finished.
The current architecture of the Batch Management interface to Information Man-

agement does not support the recording of the Batch Recipes (PFCs) to more than
one Information Management PDL. The PFC is guaranteed to be on one of the
Information Management Server nodes. If trying to view a PFC from a PDL on
one Information Management Server node results in one not being found, look
for the PFC on another Information Management Server node.
The PDL Extractor can only be used for recipes from PDL that have not been re-
stored.
B.7 Accessing PDL Data (Using PDL Task ID)

This section provides example queries for PDL retrieval applications that cannot be
managed using the standard batch views. Tables which list all PDL attributes included
in PDL views for use in batch reports are provided in PDL Tables and Views on page
672 3BUF001094-600 B
679. Guidelines for accessing archived data are provided in Accessing Archived Data
on page 679.
PDLs can be read through:
• DataDirect - DataDirect is an add-in for Microsoft® Excel. DataDirect supports
PDL access through SQL queries, and through a PDL browser dialog.
• Display Services - Display Services is used to build and view dynamic runtime
displays on client nodes connected to a Display server.
• Oracle SQL*NET.
Refer to the applicable user’s guides and associated reference manuals for detailed
instructions on how to use these applications.
The following PDL access applications are covered in this section:
• Querying for a Specific Task Type in the Task Hierarchy on page 673.
• How to Get taskid if it is Unknown on page 675.
• How To Query for the Entire Campaign Hierarchy on page 675.
• How to Exclude Parts of the Hierarchy on page 675.
• Joining Task Views on page 676.
• Retrieve Variable Data for a Specific Batch Occurrence on page 677.
• Accessing Archived Data on page 679.
B.7.1 Querying for a Specific Task Type in the Task Hierarchy

When a Campaign is run, one PDL is produced for that campaign. The PDL is repre-
sented as a hierarchy that has multiple levels and branches to accommodate the various
tasks, Figure B.15. Each task is assigned a unique task ID according to the order in
which it was created.
3BUF001094-600 B 673
LEVELNUMBER TASK TYPE TASKID
0 Campaign 10
1 Batch 11 12
2-15 Procedure or Phase 13 14 15
Figure B.15: PDL Hierarchy
A query can be written to access one or more tasks on one or more levels. Since only
campaigns and batches exist at fixed levels, the task type should generally be used
as the criteria for querying against different levels in the PDL hierarchy (for example,
all phases).
Example: Query for all Campaigns

Campaign tasks exist on level 0. To query for all campaigns, use the following query:
SELECT taskname
FROM history.pdl_task_view
WHERE levelnumber = 0
Example: Query for all Phases for a Specific Operation

The START WITH and CONNECT BY clauses in SQL can be used to write a query
that finds a specific task or set of tasks of a specific type in the task hierarchy. For
example to find the start time for all phases for the unit whose TASKID is 18, use
the following query:
SELECT taskname, type, fstarttime
WHERE type = Batch_Phase
START WITH taskid = 16
CONNECT BY PRIOR taskid = parentid
674 3BUF001094-600 B
The type specifies the kind of task to query (campaign, batch, unit procedure, opera-
tion, phase). In this case, the type is Batch_Phase.
The START WITH clause specifies the starting point for the query. In this case, the
task whose taskid = 16 will be the starting point. The CONNECT BY clause narrows
the scope of tasks to be returned by the query to those whose parentid = the prior
taskid. The prior taskid is set to the starting taskid. Thus the query will return data
for all tasks in the hierarchy of the task whose taskid = 16.
B.7.2 How to Get taskid if it is Unknown

For the START WITH clause, if the taskid of the starting task is not known, use a
sub-query such as the one below within the clause:
START WITH taskid = (SELECT taskid FROM history.pdl_task_view
WHERE taskname = ‘CAMPAIGN_1’ AND occurrence = 1)
B.7.3 How To Query for the Entire Campaign Hierarchy

To query the entire campaign hierarchy, use the following query:
SELECT taskname, fstarttime
START WITH taskid = (SELECT taskid FROM history.pdl_task_view
WHERE taskname = ‘CAMPAIGN_1’ AND occurrence = 1)
CONNECT BY PRIOR taskid = parentid
In the query above, no task type is specified. Therefore, the entire hierarchy is queried.
B.7.4 How to Exclude Parts of the Hierarchy

Use the WHERE clause to exclude rows (levels) in the hierarchy. For example:
WHERE type != Batch_Phase
!= is the symbol for not equal to. So, the query above selects all task levels except
phases.
Use the CONNECT BY clause to exclude a branch (a task and its descendants). For
example:
CONNECT BY prior taskid = parentid
AND taskid !=19
3BUF001094-600 B 675
This query excludes the branch with the unit task whose taskid = 19 and the phase
task whose taskid = 20.
B.7.5 Joining Task Views

Joining task views is a method for retrieving data for different task levels. For instance,
a query can be written for data from batches started by a specific campaign. Task
views are joined by specifying an attribute that occurs in all the views being joined.
The taskid and parentid attributes work well as shown in the example below.
Example: Query for Batch Started by a Specific Job

Use the taskid and parentid to join the history.pdl_task_view for the campaign and
batch levels. This query joins the history.pdl_task_view to itself. This can not be done
using the view name; therefore, use aliases to identify the view.
The aliases are specified in the FROM clause by simply entering them after their re-
spective view names. These aliases are used in the other clauses to specify the appro-
priate views for the attributes being used in the query. In the example below b (for
batch) and c (for campaign) are used as aliases. The join is the taskid of the campaign
(c) view and the parentid of the batch (b) view, Figure B.16.
SELECT history.pdl_task_view Campaign Data

taskid
parentid
history.pdl_task_view Batch Data
Figure B.16: Example, Join history.pdl_task_view to Itself
An example query is as follows:

SELECT b.taskname, b.fstarttime, b.fendtime
FROM history.pdl_task_view c, history.pdl_task_view b
WHERE c.taskname = ‘CAMPAIGN_1’
AND c.occurrence = 1
676 3BUF001094-600 B
AND c.taskid = b.parentid
B.7.6 Retrieve Variable Data for a Specific Batch Occurrence

This example shows how to retrieve the variablename and variablevalue for a specific
batch occurrence. The example process makes tomato sauce using tomatoes, onions,
and garlic. Table B.1 and Table B.2 show the contents of the history.pdl_task_view
and history.pdl_variable_view resulting from five batch runs.
Each time a batch is run, the production data are entered in the database and can be
read through their respective views. To read the variable values for occurrence 3 of
the spicy batch, then relate the variablevalue records for that task in the variable view
to the corresponding taskname record in the task view.
Variable name and occurrence do not uniquely identify variable instances in the
variable view. The only reliable way of relating records in different views to a specific
task is through the taskid. The taskid attribute is common to all PDL views, and the
taskid value is consistent in all views for a given task.
The query to read the variablevalues and variablenames for tomato, onion, and garlic
for occurrence 3 of the spicy batch is shown in Figure B.17.
Table B.1: Example, Task View
TASKNAME OCCURRENCE TASKID

spicy 1 12
spicy 2 13
light 1 14
light 2 15
spicy 3 16
Table B.2: Example, Variable View
VARIABLENAME OCCURRENCE1 TASKID VARIABLEVALUE

tomato 1 12 75.00
onion 1 12 5.00
garlic 1 12 1.25
3BUF001094-600 B 677
Table B.2: Example, Variable View

(Continued)
VARIABLENAME OCCURRENCE1 TASKID VARIABLEVALUE

tomato 1 13 75.00
onion 1 13 5.00
garlic 1 13 1.25
tomato 1 14 75
onion 1 14 2.50
garlic 1 14 0.75
tomato 1 15 75.00
onion 1 15 2.50
garlic 1 15 0.75
tomato 1 16 75.00
onion 1 16 5.00
garlic 1 16 0.75
1. Variable occurrences are related to their respective tasks. This is why all variable instances
in Table B.2 are at occurrence 1.
SELECT history.pdl_task_view.taskname, history.pdl_task_view.occurrence,

history.pdl_task_view.taskid, variablevalue, variablename
FROM history.pdl_taskview, history.pdl_variable_view
WHERE history.pdl_task_view.taskname = ‘spicey’
AND history.pdl_task_view.occurrence = 3
Figure B.17: Query with Join
In the SELECT clause, any attribute that occurs in only one view can be specified
using just the attribute name (for example variablevalue and variablename only
occur in the history,pdl_variable_view). Since taskname, occurrence, and taskname
occur in more than one view, they must be identified using the complete specifi-
cation.
678 3BUF001094-600 B
B.7.7 Accessing Archived Data

Archived PDL data can be restored from the archive media, and then be accessed by
external applications. The procedure is essentially the same as for accessing runtime
data. The only difference is that the restored table names or view names must be ref-
erenced in the queries. The restored table and view names are listed in PDL Tables
and Views on page 679. Instructions for restoring archived data are provided in Making
Archived Data Available to Client Applications on page 572.
B.7.8 PDL Tables and Views

This section describes the tables and views where PDL data are stored.
An Oracle view is a virtual table defined on one or more base tables. Views, like tables,
are made up of columns and rows. A view does not exist independently of base tables.
It does reduce the need for complex queries by reducing the number of tables that
need to be referenced in the query. It is also useful if there is a need to restrict access
to part of a table.
Views for Batch Management

There are 12 views designed specifically for Batch Management applications:
• Batch_Header - Table B.4.
• Batch_Equipment - Table B.5.
• Batch_Vars_MatchedPair - Table B.6.
• Batch_Variables - Table B.7.
• Batch_Procedures - Table B.8.
• Batch_ProcessEvents - Table B.9.
• Batch_AuditEvents - Table B.10.
• Batch_CommentEvents - Table B.11.
• Batch_Events - Table B.12.
• Batch_BatchMgrEvents - Table B.13.
• Batch_SystemEvents - Table B.14.
• Batch_Trend - Table B.15.
3BUF001094-600 B 679
Tables and Views for Restored Archive Data

The tables and views for restored archive data have the same structure as the runtime
tables. Only the table/view names are different, Table B.16.
Additional Views and Tables

These tables and consolidated views are also available:
• TASK (Table B.17).
• TASK_VARIABLES (Table B.18). Produce IT Batch only makes use of the
Name and the Taskid columns. Some of the variables can have the same name,
but are being stored by different tasks within the task table.
• TASK_VARIABLES_OCCURRENCES (Table B.19). This table stores the ac-
tual variable values along with the time that the variable was created and a
modification field if the variable is modified. Variables can be recorded to any
task within the task structure for a pdl, and can have as many variables as is
necessary for the application. If the same variable name is used more than once
for the same taskid, then the occurrence column is incremented to indicate the
number of occurrences within the task. If a name is used by another task within
the structure, it is independent of the other occurrence on other tasks and starts
again with an occurrence number of 1. Use the application occurrence to better
manage the order that PDL messages were sent.
• RESOURCE_ASSOCIATIONS.
• RESOURCE_TRANSACTIONS.
These tables define the different resources that are related to the task structure
that is defined by the task table structure. In the case of ProduceIT, only equipment
resources are stored along with the transactions that define the reserving of this
equipment. As with task_variables, the resource_associations table keeps the
information about a resource while the resource-transactions table keeps the ac-
tual transactions involving the resource.
• HISTORY_ASSOCIATIONS (Table B.20).
• HISTORY_ASSOC_OCC_START (Table B.21).
• HISTORY_ASSOC_OCC_END (Table B.22).
680 3BUF001094-600 B
As with variables and resources, the history-associations tables can be attached

to any task within the data structure, and each task can have multiple occurrences
of the same log association.
While the data stored in these tables represent the start and end times that are
important to a log, a mechanism used to retrieve the data is the Batch_Trends
table. This table takes a request that has the batchname and association name and
passes this information to the ODA service. The ODA service queries the database
for the start and end times from these tables, makes an OPCHDA request for the
logs numerical data from the platform, and returns the data back to oracle in the
form of a rowset. This is used in the report templates to retrieve the batch data
as it pertains to numerical logs.
• MODIFICATIONS_ATTRIBUTES (Table B.23).
• pdl_task_view (Table B.24).
This view is basically equivalent to the TASK table. Some TASK attributes that
are not currently used are not included in this view. In addition, the attributes
that indicate date and time have been re-formatted so algorithms do not have to
be applied to the raw data to get formatted date and time. For instance, START-
TIME in the TASK table gives date and time in terms of seconds elapsed since
00:00 (midnight) January 1, 1970. In the pdl_task_view, the equivalent attribute
is FSTARTTIME which gives date and time in the following format: mm/dd/yy
hh:mm:ss.
• pdl_variable_view (Table B.25).
This view is a combination of the TASK_VARIABLES and TASK_VARI-
ABLES_OCCURRENCES tables. Attributes that are not currently used are not
included in this view, and date/time attributes are re-formatted.
• pdl_resource_view.
This view is a combination of the RESOURCE_ASSOCIATIONS and RE-
SOURCE_TRANSACTIONS tables. Attributes that are not currently used are
not included in this view, and date/time attributes are re-formatted.
• pdl_history_view (Table B.26).
This view is a combination of the HISTORY_ASSOCIATIONS, HISTORY_AS-
SOC_OCC_START, HISTORY_ASSOC_OCC_END, and TMODIFICA-
TIONS_ATTRIBUTES tables. Attributes that are not currently used are not in-
cluded in this view, and date/time attributes are re-formatted.
3BUF001094-600 B 681
• MMI_FORMEVENTS view for the Manufacturing Management MES component

of System 800xA.
• Logattrs View.
The definition (SQL > desc logattrs) of this view is shown in Table B.3.
Table B.3: Logattrs View Definition
Name Null Type

OBJECTNAME VARCHAR2(77)
PRESRANGEMAX NOT NULL NUMBER
PRESRANGEMIN NOT NULL NUMBER
ENGUNIT VARCHAR2(10)
The object name is the name of the 800xA object the log configuration aspect is
on. This view is a composite of the presrangemin, presrangemax, and engunit
views. These views are filled in from the attribute tables based on the information
entered on the log configuration presentation tab.
NumericLog2 and GenericDa Oracle Views

These two Oracle views are equivalent to the NumericLog and Generic_Da ODA
tables using the same columns and syntax as the ODA tables. They give Oracle client
applications such as SqlPlus and Microsoft Query access to the history and OPC real-
time data supported by the ODA NumericLog and Generic_Da ODA tables.
These Oracle views cannot be added to and are not available from ODA databases
such as Database1.
The numericlog2 table has one additional column named ObjectName. This allows
the object name to be returned in queries for history data when the object name is
more meaningful (easier to recognize) than the log name. The log name is still required
in the WHERE clause. For example: SELECT DataValue, ObjectName from Numer-
icLog2 WHERE Logname = ‘$HSBrewkettle1:F1Level,tar188im’;
The new oracle views need to be manually added to the oracle user. To do this:
1. Use Windows Explorer to find the oda_views.sql file.
682 3BUF001094-600 B
a. Open an explorer window and enter %HS_SQL% in the address bar. This
opens the sql folder specified in the %HS_SQL% environment variable
(c:\Program Files (x86)\ABB Industrial IT\Inform IT\History\sql).
b. Find the oda_views.sql file in the sql folder.
2. Run the oda_views.sql file (reference Figure B.18):
a. From the 800xA Install User, Open a command prompt and enter:
sqlplus /@localhost
This starts an sqlplus session.
b. At the sql command prompt, enter @ then drag the oda_views.sql file onto
the command line and press Enter.
c. When the command prompt returns after creating the views, quit sqlplus.
Figure B.18: Running ora_views.sql
Message Views
Three message views, the IMMSGLOGBYCAT, AUDIT_EVENT and the
MM_AUDITEVENTS views, are provided to make message reporting simpler.
The IMMSGLOGBYCAT view was created to easily get category name information.
A sample query would be:
Select message from immsglogbycat where eventcategory = 'category name';
3BUF001094-600 B 683
The AUDIT_EVENT view supports AUDIT messages. The MM_AUDITEVENTS

view supports Manufacturing Management audit events.
Table and View Attributes
Table B.4: Batch_Header View
Attribute Data Type Description

BatchID Character (32) Batch ID of the batch
CampaignID Character (40) Campaign ID of the batch
LotID Character (40) Lot ID of the batch
RecipeName Character (40) Name of the batch recipe
RecipeVersion Character (40) Version of the batch recipe
UserAccount Character (40) Account of the user that scheduled the batch
UserFullName Character (40) Full name of the user that scheduled the batch
StartDate Date Batch start date
StartTime Character (9) Batch start time
EndDate Date Batch end date
EndTime Character (9) Batch end time
Table B.5: Batch_Equipment View

ProcedurePath Character (40) Procedure path of the active block
PName Character (32) Name of the procedure containing the active block
PLabel Character (255) Label of the procedure containing the active block
Occurrence Number Occurrence of Equipment in this task.
Equipment Character (32) Equipment name
EquipOccurrence Number User-defined occurrence.
StartDate Date Date of acquire, reserve, or select transaction
684 3BUF001094-600 B
Table B.5: Batch_Equipment View

(Continued)

StartTime Character (9) Time of acquire, reserve, or select transaction
EndDate Date Date of release, unreserve, or deselect transaction
EndTime Character (9) Time of release, unreserve, or deselect transaction
TransactionType Character (255) Type of batch equipment transaction (acquire, release,
etc.)
Table B.6: Batch_Vars_MatchedPair View

TaskID Number Unique number associated with a particular block
(e.g. Job, batch, unit, and phase) at particular level
of batch hierarchy
ProcedurePath Character (40) Procedure path of the active block, campaign ID for
level 0, or batch ID for level 1
PName Character (32) Active phase name or procedure name of the
procedure containing the active block
PLabel Character (255) Active phase label or procedure label of the procedure
containing the active block
Occurrence Number Occurrence of variable.
VariableName Character (32) Name of the variable
VarOccurrence Number User-defined occurrence.
SPDate Date Date the input variable was recorded
SPTime Character (9) Time the input variable was recorded
Setpoint Character (255) Value of the input variable
ActualDate Date Date the output variable was recorded
ActualTime Character (10) Time the output variable was recorded
Actual Character (255) Value of the output variable
3BUF001094-600 B 685
Table B.7: Batch_Variables View

Task ID Number Task identifier for associated task.
Occurrence Number Occurrence of variable
VariableName Character (32) Name of the variable
VarOccurrence Number User-defined occurrence
Day Date Date the variable was recorded
Time Character (9) Time the variable was recorded
VariableValue Character (255) Value of the variable
ResultDay Date The Date and Timestamp at time of variable entry for
Procedure or Phase [parameter name] out for Batch
Management matched parameter pairs.
ResultTime Character (9) The timestamp at time of variable entry for Procedure
or Phase [parameter name] out for Batch Management
matched parameter pairs.
ResultValue Character (255) The Procedure or Phase [Parameter name] out for
Batch Management matched parameters pairs.
Table B.8: Batch_Procedures View

686 3BUF001094-600 B
Table B.8: Batch_Procedures View

(Continued)

Occurrence Number Occurrence of procedure name
StartDate Date Date the procedure started
StartTime Character (9) Time the procedure started
EndDate Date Date the procedure ended
EndTime Character (8) Time the procedure ended
Table B.9: Batch_ProcessEvents View

Name Character (32) Batch name
LocalTime Date Local time message occurred
UTCDATE Date UTC Time message occurred
TIME_NANO Number Number of Hundreds of Nanoseconds
of fractional portion of seconds of
UTCDATE or LOCALTIME columns
EventCategory Character (4000) Message event category
Message Character (4000) Event text
Severity Number Vendor Defined Event severity (0…1000)
CampaignName Character (40) Campaign ID of the batch
ProcedurePath Character (40) Procedure path of the active block,
campaign ID for level 0, or batch ID for
level 1
3BUF001094-600 B 687

(Continued)

UnitID Character (40) Name of the batch equipment associated
with the event
CategoryName Character (40) Name of the original event category
SourceName Character (40) Name of the source of the event
ObjectDescription Character (40) Description of the source of the event
Class Character (40) User-configured for the source of the
event
Condition Character (255) Event condition
SubCondition Character (255) Event subcondition
LongMessage Character (300) Event long message
MessageDescription Character (40) Event description
Priority Character (40) Event priority
Section Character (40) Event section
EventCode Character (40) Event code
XMLData Character (4000) User-configured event data
DESCRIPTION Character (4000) Event description
HIDINGMASKCONFIGURATION Character (40) Configuration of the hiding mask
ALARMSTATE Character (40) Current alarm state
OBJECTNAME Character (40) Name of the object
HIDINGRULECONDITION Character (40) Hiding mask condition
ALARMCHANGE Character (40) Alarm change flag
USERCOMMENT Character (40) User comments
HIDINGMASKNAME Character (40) Name of the hiding mask
ACKHIGHTIME Character (40) Ack time high portion filetime
ACKLOWTIME Character (40) Acl time low portion filetime
HIDDEN Character (40) Alarm hiding flag
688 3BUF001094-600 B

(Continued)

AUTODISABLED Character (40) Auto disable flag
PRIORTIYLEVEL Character (40) Alarm priority level
NODENAME Character (40) Node name
BLOCKEDREPETITIVE Character (40) Alarm blocking flag
ACTIVECHANGETIME Character (40) Active change timestamp
Table B.10: Batch_AuditEvents View

LocalTime Date Time event occurred
TIME_NANO Number Number of Hundreds of Nanoseconds of fractional
portion of seconds of UTCDATE or LOCALTIME
columns
EventCategory Character (4000) Event category
UnitID Character (40) Name of the batch equipment associated with the
event
UserAccount Character (40) Logged-on user
UserFullName Character (40) Full name of the logged-on user
UserFirstAccount Character (40) First authenticator
3BUF001094-600 B 689
Table B.10: Batch_AuditEvents View

(Continued)

UserFirstReason Character (40) Reason of first authenticator
UserFirstComment Character (40) Comment of first authenticator
UserSecondaryAccount Character (40) Second authenticator
UserSecondaryReason Character (40) Reason of second authenticator
UserSecondaryComment Character (40) Comment of second authenticator
UserSecondaryFullName Character (40) Full name of second authenticator
NodeName Character (40) Name of the node where the event originated
Path Character (40) Path of the modified object
AspectName Character (40) Name of the modified aspect
Locale Character (40) Language used by the user
TransactionType Character (40) Type of audit transaction
ToValue Character (40) Aspect value after modification
FromValue Character (40) Aspect value before modification
NewUser Character (40) New user during logover
OldUser Character (40) Old user during logover
XMLData Character (4000) User- defined event data
Object Description Character (40) Description of the source of the event
Description Character (4000) Event description
LongMessage Character (300) User defined event data
ObjectName Character(40) Object Name
690 3BUF001094-600 B
Table B.11: Batch_CommentEvents View

columns
ProcedurePath Character (40) Procedure path of the active block, campaign ID
for level 0, or batch ID for level 1
3BUF001094-600 B 691
Table B.12: Batch_Events View

columns
Severity Number Vendor Defined Event severity (0…1000)
UnitID Character (40) Name of the batch equipment associated with the
event
692 3BUF001094-600 B
Table B.12: Batch_Events View

(Continued)

Path Character (40) Path of the modified object
AspectName Character (40) Name of the modified aspect
Locale Character (40) Language used by the user
TransactionType Character (40) Type of audit transaction
ToValue Character (40) Aspect value after modification
FromValue Character (40) Aspect value before modification
NewUser Character (40) New user during logover
OldUser Character (40) Old user during logover
XMLData Character (4000) User- defined event data
ObjectDescription Character (40) Description of the source of the event
Class Character (40) User-configured for the source of the event
Condition Character (40) Event condition
SubCondition Character (40) Event subcondition
LongMessage Character (300) Event long message
Priority Character (40) Event priority
Section Character (40) Event section
EventCode Character (40) Event code
Description Character (4000) Event description
Table B.13: Batch_BatchMgrEvents View

3BUF001094-600 B 693
Table B.13: Batch_BatchMgrEvents View

(Continued)

columns
Table B.14: Batch_SystemEvents View

MsgDate Date Date of system event
MsgTime Character (9) Time of system event
columns
Attr1 - Attr40 Character (40) Additional event attributes
694 3BUF001094-600 B
Table B.15: Batch_Trends View

BatchID Character (40) Name of the batch.
LogicalName Character (255) User name for log.
LogName Character (255) History log name.
TimeStamp Date Sample time stamp
Aggregate Character (32) Raw - retrieves stored values with actual time stamps.
Interpolative retrieves interpolated values with evenly
distributed time stamps based on the interpolation
interval.
If an aggregate is not specified, raw data will be
retrieved by default.
Intervals Number (10) Time in seconds between interpolated data points.
Default value = 1 second.
DataValue Number (53) Data value.
Quallity Number (10) Data quality code.
Improving Performance: The performance of queries on the Batch_Trends view

may be improved by following the guidelines in Improving the Performance of
the Batch_Trend View on page 215.
Table B.16: Restored Table/View Names
Runtime Name Restored Name

TASK TASK_RST
TASK_VARIABLES TASK_VARIABLES_RST
TASK_VARIABLES_OCCURRENCES TASK_VARIABLES_OCCURRENCES_RST
HISTORY_ASSOCIATIONS HISTORY_ASSOCIATIONS_RST
HISTORY_ASSOC_OCC_START HISTORY_ASSOC_OCC_START_RST
HISTORY_ASSOC_OCC_END HISTORY_ASSOC_OCC_END_RST
MODIFICATIONS_ATTRIBUTES MODIFICATIONS_ATTRIBUTES_RST
pdl_task_view pdl_restored_task_view
3BUF001094-600 B 695
Table B.16: Restored Table/View Names

(Continued)
Runtime Name Restored Name

pdl_variable_view pdl_restored_variable_view
pdl_history_view pdl_restored_history_view
Resource_Associations Resource_Associations_RST
Resource_Transactions Resource_Transactions_RST
pdl_resource_view pdl_restored_resource_view
Table B.17: TASK Log Attributes
Data Source
[] = optional
NAME Character (40) Application Task name defined by user, or generated
automatically by Batch Management.
Used in combination with Occurrence in
query for retrieval of task data.
OCCURRENCE Number System Occurrence of this task within the parent
task, for example the execution of the
same phase within an operation would
have an occurrence of 2 under the parent
task.
TASKID Number System System-generated identifier. Example:
Not Null 1110000110
PARENTID Number [Application] Taskid of the task that started this task.
Supplied by application at time of task
log creation. If a task has a parentid of
<NULL> or is blank, then it is the root or
starting point of a PDL structure.
LEVELNUMBER Number Application PDL task level number (0 through 15):
0 = Campaign
1 = Batch
2-15 = Procedure or Phase
696 3BUF001094-600 B

(Continued)
Data Source
[] = optional
TYPE Character (32) System Describes the task type. Type can be:
Batch_Job
Batch_Batch
Batch_RCP
Batch_Phase
Batch_Evt_Block
Batch_Evt_OPChange
Batch_Evt_HSI
CAPACITY Number(6) Not used in this release.
STATUS Character(10 Not used in this release.
ACCESSAUTHORITY Character(32) Not used in this release.
ARCHIVESTATUS Number(1) Not used in this release.
CREATOR Character(32) [Application] The name of the batch to which this task
belongs. It is being used by some oracle
views to query data by batch name.
CREATIONTIME Date System or Time stamp generated when task was
[Application] created. Time is given as local time with
resolution to the second. Use application
supplied time unless 0 passed in. It is
the same time as the starttime, and is
not used in reporting
CREATIONTIMEUTC Number System or Creation time as Universal Time
[Application] Coordinate (UTC) - Number of seconds
since January 1, 1970.
CREATIONTIMEMSEC Number System Number of microseconds into the second
that creation time occurred.
STARTTIME Date System or Time stamp generated when task
[Application] started. Time is given as local time with
supplied time unless 0 passed in.
3BUF001094-600 B 697

(Continued)
Data Source
[] = optional
STARTTIMEUTC Number System or Start time as Universal Time Coordinate
[Application] (UTC) in seconds since January 1, 1970.
STARTTIMEMSEC Number System Number of microseconds into the second
that start time occurred.
ENDTIME Date System or Time stamp generated when task is
[Application] ended. Time is given as local time with
ENDTIMEUTC Number System or End time as Universal Time Coordinate
[Application] (UTC) in seconds since January 1, 1970.
ENDTIMEMSEC Number System or Number of microseconds into the second
[Application] that end time occurred.
USERPARAMETER1 Number [Application] Not used in this release.
USERPARAMETER2 Character(32) Phase or Procedure Name.
USERNAME Character (32) Application Not used in this release.
USERCOMMENT Character(255) [Application] Batch Management Procedure Block
Label
ARCHIVESTATUS Number [Application] Consolidation of PDL data to another
node is done by looking at any task at
level 1, and if it has a valid endtime and
the archive status of zero then it must be
consolidated, once it is consolidated, the
archive status is modified to a 1.
698 3BUF001094-600 B
Table B.18: TASK_VARIABLES Log Attributes
Data Source
[] = optional
NAME Character (32) Application User-defined name for variable or
Not Null parameter as declared in Batch
Management. Used in combination with
Occurrence in query for retrieval of
variable data.
Example: ReactorTemp
TASKID Number Application Task identifier for associated task.
Not Null
TYPE Character (1) System Not used in this release.
CREATIONTIME Date/Time System/ Time stamp generated when request to
[Application] create this variable was made. Currently,
this time stamp comes from Batch
Management. Time is given as local time
with resolution to the second. PDL
computes time stamp if application
passes 0.
TAGNAME Character (32) [Application] Not used in this release.
DESCRIPTION Character (32) [Application] Not used in this release.
UNITS Character (10) [Application] Not used in this release.
FORMAT Character (30) [Application] Not used in this release.
3BUF001094-600 B 699
Table B.18: TASK_VARIABLES Log Attributes

(Continued)
Data Source
[] = optional
Number Batch Management uses
UserParameter1 UserParameter1 attribute to identify
matching parameter pair type
(0=non-matching, 1=MatchingPair) in
order for Batch_Vars_MatchedPairs view
to filter out only matched-pairs. Batch
Management creates variable on phase
start and modifies existing variable to
update ResultValue with actual value
from Phase Post-Compute action.
Character(32) Not used in this release.
UserParameter2
UserComment Character(255) Not used in this release.
UserName Character(32) Not used in this release.
ArchiveStatus Number(1) Not used in this release.
Table B.19: TASK_VARIABLES_OCCURRENCES Log Attributes
Data Source
[] = optional
NAME Character (32) Application User-defined name for TagkeyData or
Not Null parameter as declared in Batch
Management. Used in combination with
variable data.
Example: ReactorTemp
OCCURRENCE Number System or Occurrence of this variable within the
Not Null [Application] task. Example: 2
Not Null
700 3BUF001094-600 B

(Continued)
Data Source
[] = optional
VARIABLEVALUE Number Application Initial value of the variable from a Batch
Not Null Management Procedure and Phase with
parameters start, result of a bdbput( )
function call or BMA Data Collect with
Once option.
The Procedure or Phase [parameter
name].in for Batch Management matched
parameter pairs.
VARIABLETIME Date/Time System or Time stamp at time of variable entry
[Application] operation. Time is given as local time
with resolution to the second.
For lab data entries where actual value
will be entered later. PDL computes time
stamp if application passes 0.
VARIABLETIMEUTC Number System or Variable time as Universal Time
VARIABLETIMEMSEC Number System Number of microseconds into the second
that variable time occurred.
RESULTVALUE Number Application The Procedure or Phase [parameter
Not Null name].out for Batch Management
RESULTTIME Date/Time The timestamp at time of variable entry
for Procedure or Phase [parameter
name].out for Batch Management
RESULTTIMEUTC Number System or Result time as Universal Time
RESULTTIMEMSEC Number System Number of microseconds into the second
that result time occurred.
3BUF001094-600 B 701

(Continued)
Data Source
[] = optional
APPLICATION Number Application User-defined occurrence
OCCURRENCE
STATUS Character(10) Not used in this release.
USERCOMMENT Character(255) Not used in this release.
USERNAME Character(32) Not used in this release.
ARCHIVESTATUS Number(1) Not used in this release.
USERBLOBSIZE Number System Size of blob.
USERBLOB Blob Batch recipe stored as blob.
Table B.20: HISTORY_ASSOCIATIONS Log Attributes
Data Source
[] = optional
NAME Character (32) Application Batch Management BMA Data Collection
Not Null Logical Name
Example: Temperature
TASKID Number Application System generated identifier. Example:
Not Null 1 110 000 110
LOGTYPE Character (1) Application N = Numeric Log
M = Message Log
G = Generic - used by Operations
STORAGEINTERVAL Number [Application]/ Recording rate of process object in
System seconds.
Example: 10 (sec)
DATASOURCE Data source for history log as defined in
Composite log window in History.
Example: [object
path]objectname:property
702 3BUF001094-600 B

(Continued)
Data Source
[] = optional
CAPACITY Number [Application]/ Log capacity as indicated in the Log
System Attribute Edit window in AdvaInform
History. This is the maximum number of
log entries for this log. Not used in this
release.
LOGNAME Character (32) Application/ Identifies the specific logname of the
System object. Basically, the OPC itemid for
retrieval through OPCHDA. Example:
[object
path]objectname:property,logname
FAILURENOTIFY Number Application Indicates that application will be notified
in event of history log failure. Requires
application to be able to handle
notification and take appropriate action.
Y = Notify in event of failure
N = Do not notify in event of failure
Not used in this release.
TIMEPERIODSOURCE TBD [Application] Association time is set relative to the
start or end of the task which is linked to
this association.
S:Task+5:00 (5 min + task start)
E:S+30:00 (30 min from start (S))
Not used in this release.
CREATIONTIME Date/Time System/ Time stamp generated at time when
[Application] History association was created. Time is
given as local time with resolution to the
second. PDL computes time stamp if
application passes 0.
3BUF001094-600 B 703

(Continued)
Data Source
[] = optional
STATUS Character (10) [Application] Not used in this release.
USERPARAMETER2 Character (32) [Application] Not used in this release.
USERCOMMENT Character(255) [Application] Not used in this release.
ARCHIVESTATUS Number System Indicates if this log has been saved to
archive media.
Table B.21: HISTORY_ASSOC_OCC_START Log Attributes
Data Source
[] = optional
NAME Character Application Batch Management BMA Data
(32) Collection Logical Name
OCCURRENCE Number System Occurrence of this resource usage
within the task.
Example: 1
TASKID Number Application Task that created the association.
System generated identifier.
Example: 1 110 000 110
OWNERID Number Batch ID that created the association.
TIMEPERIODSTART Date/Time System Time stamp generated at time of start
association. Time is given as local time
with resolution to the second.
704 3BUF001094-600 B
Table B.21: HISTORY_ASSOC_OCC_START Log Attributes

(Continued)
Data Source
[] = optional
TIMEPERIODSTARTUTC Number System or Time period start time as Universal
[Application] Time Coordinate (UTC) - Number of
seconds since January 1, 1970.
TIMEPERIODSTARTMSEC Number System Number of microseconds into the
second that time period start time
occurred.
ENTRYTIME Date/Time System Same as TIMEPERIODSTART.
ENTRYTIMEUTC Number System or Same as TIMEPERIODSTARTUTC
[Application]
ENTRYTIMEMSEC Number System Same as TIMEPERIODSTARTMSEC
USERNAME Character Application Not used in this release.
(32)
archive media.
Table B.22: HISTORY_ASSOC_OCC_END Log Attributes
Data Source
[] = optional
NAME Character (32) Application Batch Management BMA Data
Collection Logical Name
OCCURRENCE Number System Occurrence of this name usage within
the task.
Example: 1
TASKID Number Application Task that ended the association.
System generated identifier.
Example: 1 110 000 110
3BUF001094-600 B 705
Table B.22: HISTORY_ASSOC_OCC_END Log Attributes

(Continued)
Data Source
[] = optional
OWNERID Number Batch ID that created the association.
TIMEPERIODEND Date/Time System Time stamp generated at time of end
association. Time is given as local
time with resolution to the second.
TIMEPERIODENDUTC Number System or Time period end time as Universal
[Application] Time Coordinate (UTC) - Number of
seconds since January 1, 1970.
TIMEPERIODENDMSEC Number System Number of microseconds into the
second that time period end time
occurred.
ENTRYTIME Date/Time System Same as TIMEPERIODEND.
ENTRYTIMEUTC Number Same as TIMEPERIODENDUTC.
ENTRYTIMEMSEC Number System Same as TIMEPERIODENDMSEC.
archive media.
Table B.23: MODIFICATIONS_ATTRIBUTES Log Attributes
Data Source
[] = optional
TASKID Number Application Identifier of task being modified.
Example: 1 110 000 110
TABLENAME Character(30) Application Table that was modified.
COLUMNNAME Character(32) Application Column that was modified.
NAMEFROM Character(64) System/ Not used in this release.
CHANGEDRECORD [Application]
706 3BUF001094-600 B

(Continued)
Data Source
[] = optional
VARIABLETIME Date System/ Original time (before modification).
[Application]
VARIABLETIMEUTC Number System/ Time as Universal Time Coordinate
[Application] (UTC) - Number of seconds since
January 1, 1970
VARIABLETIMEMSEC Number System/ Number of microseconds into the second
[Application] that variable time occurred.
RESOURCETYPE Character(15) System/ Resource type for resource association.

[Application]
RESOURCEVERSION Character(32) System/ Resource version for resource
[Application] association.
MODIFYTIME Date/Time System/ Time stamp generated at time of modify

[Application] operation. PDL generates time stamp if
application passes 0. Time is given in
local time with resolution to the second.
MODIFYTIMEUTC Number System or Modify time as Universal Time
ITEMOCCURRENCE Number [Application] Occurrence number of item being
updated
Example: 3
OLDVALUE Character(255) Application Previous Value
Example: 4.00
NEWVALUE Character(255) Application Updated Value
Example: 3.56
3BUF001094-600 B 707

(Continued)
Data Source
[] = optional
archive media.
Table B.24: pdl_task_view Attributes
Data Source
[] = optional
TASKNAME Character (40) Application User-defined name for task. TASKNAME
is used in combination with
OCCURRENCE in query for retrieval of
task data.
TASKTYPE Character (32) System Describes the task type. Type can be:
Batch_Job
Batch_Batch
Batch_RCP
Batch_Phase
Batch_Evt_Block
Batch_Evt_OPChange
Batch_Evt_HSI
OCCURRENCE Number System Occurrence of this task within the parent
task, for example the execution of the
same phase within a unit procedure.
Example: 2
TASKID Number System System-generated identifier.
Not Null Example: 14
PARENTID Number [Application] Supplied by application at time of task log
creation.
Example: 1 110 001 113
708 3BUF001094-600 B
Table B.24: pdl_task_view Attributes

(Continued)
Data Source
[] = optional
LEVELNUMBER Number Application PDL task level number (0 through 15)
0 = Campaign
1 = Batch
FCREATIONTIME Character (75) System or Formatted time stamp generated when
[Application] task was created. Use application supplied
time unless 0 passed in.
Example: 25-AUG-2000 14:45:00
FSTARTTIME Character (75) System or Same as FCREATIONTIME.
[Application]
FENDTIME Character (75) System or Formatted time stamp generated when
[Application] task is ended. Use application supplied
time unless 0 passed in.
Example: 25-FEB-2001 14:45:00
DURATION Number Application Duration of the task given in seconds
elapsed.
FDURATION Character(122) Formatted duration.
Table B.25: pdl_variable_view Attributes
Data Source
[] = optional
VARIABLENAME Character (32) Application User-defined name for variable or
Not Null parameter (as declared in Batch
Management). Used in combination with
variable data.
Not Null
TASKTYPE Character (19) Application Refer to TASKTYPE in Table B.24.
3BUF001094-600 B 709

(Continued)
Data Source
[] = optional
OCCURRENCE Number System or Occurrence of this variable within the
Not Null [Application] task.
Example: 2
APPLICATION Number Application User-defined occurrence.
OCCURRENCE
VARIABLETYPE Character (1) System Describes the type of variable.
n = normal
p = parameter
VARIABLEVALUE Character(255) Application Initial value of the variable when a record
variable is received. If another request
comes in to record to the same variable
and occurrence, the times and value are
put in the Result fields.
FCREATIONTIME Character (20) System or Formatted time stamp generated when
[Application] the request to create this variable was
made. Currently, this time stamp comes
from Batch Management. Use application
Example: 25-FEB-2001 14:45:00
FVARIABLETIME Character (20) System or Formatted time stamp at time of variable
[Application] entry operation.
To be used with lab data entries where
actual value will be entered later. PDL
computes time stamp if application
passes 0.
Example: 25-FEB-2001 14:45:00
RESULTVALUE Number Application Updated value of the variable when
Not Null another request comes in to record to the
same variable and occurrence through
Batch Management.
FRESULTTIME Character (20) Application Formatted time stamp at time of at time
of variable entry operation.
710 3BUF001094-600 B

(Continued)
Data Source
[] = optional
TASKNAME Character (40) Application User-defined name for task. TASKNAME
task data.
0 = Campaign
1 = Batch
PARENTID Number [Application] Supplied by application at time of task log
creation.
Example: 1 110 001 113
Table B.26: pdl_history_view Attributes
Data Source
[] = optional
ASSOCIATIONNAME Character (32) Application Batch Management BMA Data
Not Null Collection Logical Name
Refer the Note at the end of this table.
OCCURRENCE Number System Occurrence of this history association
Not Null usage within the task.
Not Null
OWNERID Number Application Batch task ID
OWNERNAME Character(40) Not used in this release.
DATASOURCE Character(64) Not used in this release.
STORAGEINTERVAL Character(6) Not used in this release.
CAPACITY Number Not used in this release.
3BUF001094-600 B 711
Table B.26: pdl_history_view Attributes

(Continued)
Data Source
[] = optional
LOGNAME Character Example: [object
(1023) path]objectname:property
PARENTID Number [Application] Supplied by application at time of task
log creation.
Example: 1 110 001 113
0 = Campaign
1 = Batch
TASKTYPE Character(19) System Describes the task type. Type can be:
Batch_Job
Batch_Batch
Batch_RCP
Batch_Phase
Batch_Evt_Block
Batch_Evt_OPChange
Batch_Evt_HSI
FCREATIONTIME Character (20) System/ Formatted time stamp generated at time
[Application] when History association was created.
FTIMEPERIODSTART Character (20) System Formatted time stamp generated at time

of start association.
FTIMEPERIODEND Character (20) System Formatted time stamp generated at time
of end association.
Unique trend AssociationNames (BMA Data Collect Logical Names) within a

batch will be enforced. If not unique, a second occurrence will be created. In this
case, the first stop trend will set the endtime for the first occurrence, the second
stop trend will set the endtime for the second occurrence etc. which may not be
the matched pairs of start and stop trend intended.
712 3BUF001094-600 B
Table B.27: pdl_resource_view Attributes
Data Source
[] = optional
RESOURCENAME Character (32) Application Name of Batch Management Equipment
Not Null
OCCURRENCE Number Indicates the transaction occurrence of
NUMBER the Resource used by a Batch.
Example:
Batch Management Acquire = 1
Batch Management Release = 2
TASKNAME Character(40) User-defined name for task. TASKNAME
task data.
TASKTYPE Character(40) Describes the task type. Type can be:
Batch_Job
Batch_Batch
Batch_RCP
Batch_Phase
Batch_Evt_Block
Batch_Evt_OPChange
Batch_Evt_HSI
LEVELNUMBER Number(2) PDL task level number (0 through 15)
0 = Campaign
1 = Batch
PARENTID Number Supplied by application at time of task
log creation.
Example: 1 110 001 113
FCREATIONTIME Character(20) Application Formatted time stamp generated at time
when History association was created.
RESOURCETYPE Character (15) [Application] Not used in this release
Not Null
3BUF001094-600 B 713
Table B.27: pdl_resource_view Attributes

(Continued)
Data Source
[] = optional
VERSION Character (32) [Application] Not used in this release
Not Null
ACTUALVALUE Number Application Not used in this release
Not Null
FENTRYTIME Date/(System& System or Formatted time stamp at time of acquire
Normalized) [Application] or release.
Example: 25-AUG-2003 14:45:00
Table B.28: RESOURCE_ASSOCIATIONS Attributes
Data Source
[] = optional
TASKID Number Application Task to associate resource with.
Not Null
NAME
TYPE Character (15) [Application] Not used in this release
Not Null
UNITS Character (10) [Application] Not used in this release.
FORMAT Character (30) [Application] Not used in this release.
SETVALUE Character (255) Not used in this release
CREATIONTIME Date/Time System or Time stamp generated when task was
[Application] created. Time is given as local time with
714 3BUF001094-600 B
Table B.28: RESOURCE_ASSOCIATIONS Attributes

(Continued)
Data Source
[] = optional
VERSION System Not used in this release.
USERPARAMETER2 Character (32) [Application] Not used in this release.
USERRNAME Character (32) Application Not used in this release.
archive media.
Table B.29: RESOURCE_TRANSACTIONS Attributes
Data Source
[] = optional
NAME Character(32) Not used in this release.
TYPE Character(15) Not used in this release.
USAGE Character(15) Not used in this release.
OCCURRENCE Number System Occurrence of this resource usage in the
Not Null task.
Example: 2
TASKID Number Application Task to associate resource with.
Not Null
ACTUALVALUE [Application] Not used in this release.
SAMPLETIME Date/Time System/ Not used in this release.
[Application]
SAMPLETIMEUTC Number System or Not used in this release.
[Application]
SAMPLETIMEMSEC Number System Not used in this release.
3BUF001094-600 B 715
Table B.29: RESOURCE_TRANSACTIONS Attributes

(Continued)
Data Source
[] = optional
ENTRYTIME Date/Time System/ Same as CREATIONTIME.
[Application]
ENTRYTIMEUTC Number System or Same as CREATIONTIMEUTC.
[Application]
ENTRYTIMEMSEC Number System Same as CREATIONTIMEMSEC.
VERSION System Date and timestamp if the resource is a
sequence.
FROMSTORAGENAME Character (32) [Application] Not used in this release.
TOSTORAGENAME Character (32) [Application] Not used in this release.
STATUS Character (10) [Application] Not used in this release.
archive media.
716 3BUF001094-600 B
C Using the IM OPC HDA Server C.1 Accessing History Servers in Other Aspec
Appendix C Using the IM OPC HDA Server
The IM OPC HDA server is installed with the Information Management History
Server option and provides an alternative to the 800xA OPC HDA server for history
access. It is generally recommended that the 800xA OPC HDA server be used for
historical data access; however, it may be advantageous to use the IM OPC HDA
server under some circumstances. This section describes the potential benefits and
limitations when using the IM OPC HDA server.
To connect to the IM OPC HDA server, use the IMHDA data provider.
C.1 Accessing History Servers in Other Aspect Sys-

tems
The 800xA OPC HDA server provides access to history servers in the same Aspect
System where the OPC HDA server resides. If history servers need to be accessed
from more than one Aspect System, or to access a history server in a different Aspect
System, use the IM OPC HDA server.
C.2 Enhanced Browsing Features for History Logs

The 800xA OPC HDA server supports a method for browsing for property log objects
that is similar to the Plant Explorer. The IM OPC HDA server provides a browser
that is specifically designed to facilitate browsing history log objects for Information
Management applications.
With the IM OPC HDA server, when browsing for history objects, the browser is
used to choose one of three paths or categories by which to conduct the search.
C.3 Syntax for Log Name References

There is a different syntax for referencing log names in data queries for the two OPC
HDA servers. Refer to Property Log Naming Conventions on page 32.
3BUF001094-600 B 717
C Using the IM OPC HDA Server C.4 Direct Access to Trend Logs
C.4 Direct Access to Trend Logs

The 800xA OPC HDA server provides seamless access to both trend and history logs.
It also provides access to log attributes. The IM OPC HDA server can only access
history logs. Data from the trend logs will be available through the connected history
logs; however, the data will be delayed by the blocking rate imposed by the history
log, and may not be immediately available. Also, the IM OPC HDA server does not
support access to log attributes.
718 3BUF001094-600 B
D Revision History D.1 Introduction
Appendix D Revision History
D.1 Introduction
This section provides information on the revision history of this User Manual.
The revision index of this User Manual is not related to the 800xA 6.0 System
Revision.
D.2 Revision History

The following table lists the revision history of this User Manual.
Revision
Description Date
Index
- First version published for 800xA 6.0 August 2014
A Updated for 800xA 6.0.1 August 2015
B Updated for 800xA 6.0.3.1 November 2017
3BUF001094-600 B 719
D Revision History D.3 Updates in Revision Index A
D.3 Updates in Revision Index A

The following table shows the updates made in this User Manual for System 800xA
6.0.1:
Updated Section/Sub-section Description of Update

All Sections New interface Datadirect Screen shots have
been updated.
D.4 Updates in Revision Index B

The following table shows the updates made in this User Manual for System 800xA
6.0.3.1:
Updated Section/Sub-section Description of Update

Section 5: Using Desktop Trends Figure 6.1 ACC Setup Tool updated
720 3BUF001094-600 B
Index
Index
A manual (on demand), 558
A/E Linked Server Configuration, 132 restoring archived logs, 572, 577
ABBArray, 278 Area Zoom, 325
ABBGetAttributes, 274 Aspect
ABBGetAttributeValue, 275 A/E Linked Server Configuration, 132
ABBGetHistory, 268 Action, Report, 429
ABBGetObj, 265 Action, Scheduler, 499
ABBSql, 276 Archive Device, 534
about button, 58 Archive Group, 542
access name, 34 Archive Volume, 537
ACC Setup, 286 File Viewer, Report Template, 463
Action Aspect Inform IT History Control, 523
Report, 429 Inform IT History View Logs, 544
Scheduler, 499 Inform IT History View PDL, 567
Active Zoom, 293, 296 Inform IT History View Report Logs, 466,
add-ins, 49, 53 546
alarms/events Report Preferences, 465
Industrial IT dialog, 105 Report Printing, 466
aliases, 260, 262 Scheduled Job, 504
Archive Scheduling Definition, 483
delete restored logs, 583 Start Condition, 492
device delay, 537 Start Condition Expression, 493
initialize media, 553 attribute, 350
Initialize Media, 553 attributes text file, 259, 288
Location, 548 audit trail, 43
Log Class, 467, 547 auto create, 256
Log Name, 467, 548 autofit columns, 112, 241
Log Type, 547
Number of Logs, 467, 547 B
publishing, 572 Backward Scope, 326
Status, 467, 548 batch to batch, 403
Archive Device, 534 Browser, 341
Archive Group, 542
Archive Volume, 537 C
archiving calculation, 93, 173
3BUF001094-600 B 721
Index
cell reference, 208 enabling macros, 53

color, 305, 358 export a file, 385
communication settings export report output, 445
channel, 115, 249 completed report object, 446
port, 115, 250 Windows file, 447
timeout, 115, 250 export to file, 446
completed report object, 427 Expression Start Condition, 493
Connection Status, Trends, 308
copying tags, 353 F
Copy Trace, 333 file setup, 255
Crystal Reports, 29, 417 File Viewer
Report Template, 463
D font, 358
data delimiter, 361 format, data, 110, 239
DataDirect, 417 FROM clause, 634
data format, 356 function calls, 68
Data Format tab, 110, 239
data provider, 44, 251, 352 G
name, 45 generic_DA, 628
referencing in client applications, 45 Groups, Tags, 515
trend display, 300
data quality, 112, 241 H
data quality codes, ODA, 633 HDA Browser, 518
data server, 286 headers, orientation option, 111, 240
connection, 286 help, 58
name, 287 historical values, ABBGetHistory, 268
data type, 300 history association, Batch, 667
data update rate, 305 History Control, 523
date and time format, 113, 242 history log calculation, 112, 241
Daylight Saving Time, 37 history object text file, 259
debug file, 115, 117, 250, 253 history update, 42
deleting tags, 353 history values
delimiter, 361 Inform IT dialog, 165
disable functions, 117, 254 horizontal list, 111, 240
drag and drop, 369 host, 141, 279
drilling, 221, 399 HS_TMP environment variable, 573
E I
email, 452 import a file, 378
722 3BUF001094-600 B
Index
Industrial IT alarms & events, 105 N

Infoarea, Table View, 296 number of values
Information Management browser, 525 history, 95, 176
Information Manager, 308 SQL, 232
Inform IT History View Logs, 544 TCL unit array, 236
Inform IT History View Report Logs, 466, 546 numericlog table, 632
insert function, 61, 164, 189
insert history entries, 42 O
Interpolated, 301 object name, 112, 241
interpolation, 37 object status, 127, 181, 183, 272
object text file, 259
L object type, 147, 350
last history value, 31 object type text file, 259
limit check, 351 ODA, PDL access, 647
limits file, 290 ODA database, 645–646
log ODA Table Definition, 47
name, 32, 34 on-line help, 58
restoring archived logs, 572, 577 OPC
long format, 111, 240 browser, 237, 416, 525
Browser, ticker, 341
M Get Entire List, 527
macros, 280 objects, 237, 416
message log OPC Browser
batch name, 199 ticker, 346
dialog, 190 OPC HDA Browser, 341
filtering criteria, 198 trend display, 320
log name, 198, 407 OPC message log, 615
options, 257 Open Data Access, 625
property,event texts, 199 opening trend display, 336
search, 199 Options dialog, DataDirect, 110, 238
sequence name, 199 ORACLE_SID, environment variable, 48
tag name, 199 ORDER BY clause, 635
text file, 256, 260 Orientation, data format, 110, 239
time range, 407 output options, 431
type, 199
unit name, 199 P
modify history entries, 42 parameters, 433
password, 279
PDL
3BUF001094-600 B 723
Index
delete, 584 restoring archived logs, 572, 577

dialog, 386 retrieval type, 92, 169
history, 228, 402 Ruler Time, 323
message, 227, 401 Ruler Value, 323
output results, 223
resource, 227, 400 S
search criteria, 218, 395 save settings, 141
search results, 220, 397 saving trend display, 336
task type, 218, 395 Scheduled Job, 504
variable, 226, 400 Scheduling Definition, 483
PDL/Batch tab, 244 Scope/Zoom, 326
PDL Information, 567 seamless retrieval, 34, 528
permissions, 508 Search Criteria is Case Sensitive, 249
pick list, 288 search results, 220, 397
plug icon, 67 Search Tags, 517
port, 253 security, 508
printing, 451 SELECT clause, 634
printing trend display, 336 SQL
Private Groups (Tags), 519 function call, 276
process value query, ad-hoc, 232
function call, 265, 274 SQL*Plus, 48
process values start cell, 60–61
Industrial IT dialog, 77, 79 Start Condition, 492
Inform IT dialog, 142, 144 Start Time, MOD Trend, 327
production data, 43, 202 start-up, 57
Public Groups (Tags), 518 Status, MOD Trend Trace, 323
publish, 573 Subreports, Crystal, 425
published logs access, 528, 576 subscription type, 351
R T
Raw, 301 Table View (Info Area), 296
Readable Name, Batch Data, 248 tag
Report Action, 429 adding to ticker file, 341
report builder, 29, 417 configuration, 341
Report Preferences, 465 limits refresh, 372
Report Printing, 466 name, 349
Reports, Test Action, 507 tag configuration, 341
resample, 93, 173 tag explorer, 375
Restore Defaults button, 239 operation, 383
724 3BUF001094-600 B
Index
set up, 376 type, 329

start-up, 375 Trend Area, MOD, 294
tag group, 376 trend display
Tag Groups, 515 browse OPC HDA, 321
Tag Search, 517 copy/paste, 333
Tag Workspace, 521 description, 294
task type, 218, 395 launching from tag explorer, 386
TCL Unit Array launching from ticker, 373
ABBArray, 278 operation, 319
ad-hoc, 235 save Html file, 336
text file, 259, 288 scope, 315
attributes, 259, 288 set-up, 298
changing selection, 255 start-up, 293
configuring new files, 289 troubleshooting, 462
history object, 259
object, 259, 288 U
object type, 259, 288 uninstalling, 57
ticker, 337 update function references, 53, 55
browse OPC DA, 341, 346 update history values
changing defaults, 359 Industrial IT dialog, 98
clear, 369 update process values
configuring ticker files, 337 Industrial IT dialog, 84
error indication, 367 upgrade Excel, 57
operation, 366 user interface, 50
start-up, 337 user name, 140, 279
ticker file User Tag Management, 513
appearance, 354 User Tag Management Status, 523
display, 366 UTC time, 407
saving, 368 UTM button, 522
selecting for display, 367
Time Offset, 330, 335 V
time out, 117, 253, 394 values, 236, 277–278
time stamp, 112, 241 value scale, 296
Time Zoom, 325 Value Zoom, 324
tnsname, 48 VBA macro, 280
toolbar, 50 version information, 373
trace vertical list, 111, 240
enable, 312 View Logs, 544
properties, 310 View PDL, 567
3BUF001094-600 B 725
Index
View Report Logs, 466, 546 write history data, 42

volume, 536 write history values
Volume ID, 555 Industrial IT dialog, 98
Volume label, 556 write process values
volume state, 537 Industrial IT dialog, 84
W Z
WHERE clause, 634 Zoom, 296, 326
work off-line Active, 293, 296
tag explorer, 376 Area, 325
ticker, 338 Time, 325
write access, 116, 253 Value, 324
726 3BUF001094-600 B
Contact us
www.abb.com/800xA Copyright © 2017 ABB.

www.abb.com/controlsystems All rights reserved.
3BUF001094-600 B

3BUF001094-600 B en

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

3BUF001094-600 B en

Uploaded by

Copyright:

Available Formats

System 800xA

System Version 6.0

Document Number: 3BUF001094-600

1 About This User Manual

2 Data Access Tools

2.12 Set-up for SQL*Plus ................................................................................................ 47

3 General Information for DataDirect

3.8 Using DataDirect Functions ..................................................................................... 68

4 DataDirect System 800xA

4.7.5 ABBGetOPCHDAAttributes ..................................................................... 128

5.9.7 Time Span for Retrieval ............................................................................. 176

5.19.4 ABBGetAttributes ..................................................................................... 274

6 Using Desktop Trends

6.5.12 Property Page ............................................................................................. 310

6.5.45 Configuring the Data Delimiter ................................................................. 360

6.8 Batch Batch Display ................................................................................................. 403

7.3.11 Saving HTML or XML reports to History ................................................ 457

8.2.8 Expression-based Scheduling .................................................................... 490

9.4.3 Copying Items ............................................................................................ 527

10 Reading and Managing Archive Data

10.6.6 Deleting Restored Logs ............................................................................. 583

11 Reading Message Logs

Appendix A Using Open Data Access

A.2.9 UPDATE and INSERT Functions .............................................................. 639

Appendix B PDL for Batch Management

Appendix C Using the IM OPC HDA Server

C.3 Syntax for Log Name References ............................................................................ 717

Appendix D Revision History

1 About This User Manual

1.1 User Manual Conventions

1.2 Warning, Caution, Information, and Tip Icons

Caution icon indicates important information or warning related to the concept

1.4 Released User Manuals and Release Notes

2 Data Access Tools

2.1 Desktop Applications

2.2 Excel Data Access - DataDirect

There are three classes of functions/dialogs in DataDirect.

2.3 DeskTop Trends

2.4 Display Services

2.6 Selecting Which Tool to Use

• Production Data on page 43.

Table 2.1: Tools for Data Access

2.6.1 Real-time Data

Retrieving Last History Value

2.6.2 Historical Process Data

2.6.3 Property Log Naming Conventions

Syntax for 800xA OPC HDA Server

Figure 2.1: Log Reference for 800xA OPC HDA Server

Syntax for History Server (IM) OPC HDA Server

Syntax for Enterprise Historian - DCSLOG (LOGMAN)

Prefix - $HS indicates History Log

Figure 2.2: Log Name

2.6.4 Criteria for Selection for Seamless Retrieval

Figure 2.3: Numerical Data Retrieval by Interpolation

2.6.6 Daylight Savings

Transition from Daylight Saving to Standard Time

Retrieving Standard Time Stamps Only

Retrieving Both Daylight Saving and Standard Time Stamps

Ruler Points to Entry for 1:30 Daylight Saving Time

Ruler Points to Entry

Figure 2.5: Example, Reading Entry for Time on Desktop Trend

Transition from Standard to Daylight Saving Time

Figure 2.6: Example, Transition to Daylight Saving Time using DataDirect