IndustrialIT800xA - Information Management

System Version 4.1

Operation

IndustrialIT800xA - Information Management

System Version 4.1

Operation

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

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 hard-ware described in this document.

This document and parts thereof must not be reproduced or copied without written per-mission 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 requirements specified in EMC Directive 89/336/EEC and in Low Voltage Directive 72/23/EEC.

Copyright © 2003 - 2004 by ABB. All rights reserved. Release: May 2005 Document number: 3BUF001094R4101

TRADEMARKSRegistrations and trademarks used in this document include:

Windows Registered trademark of Microsoft Corporation.

ActiveX Registered trademark of Microsoft Corporation.

Acrobat Reader Registered trademark of Adobe Systems Inc.

Industrial IT Trademark of ABB.

TABLE OF CONTENTS

About This BookIntended User...................................................................................................................33

Use of Warning, Caution, Information, and Tip Icons....................................................33

Document Conventions ...................................................................................................34

Related Documentation ...................................................................................................35

Section 1 - Product OverviewDesktop Applications ......................................................................................................38

Excel Data Access - DataDirect ...........................................................................38

DeskTop Trends ...................................................................................................40

Display Services...................................................................................................41

Reports.............................................................................................................................42

Thin Clients .....................................................................................................................44

Selecting Which Tool to Use...........................................................................................46

Real-time Data.................................................................................................................48

Retrieving Last History Value .............................................................................48

Historical Process Data....................................................................................................49

Property Log Naming Conventions .....................................................................50

Syntax for 800xA OPC HDA Server ..................................................50

Syntax for History Server (IM) OPC HDA Server .............................51

Syntax for Enterprise Historian - DCSLOG (LOGMAN) ..................52

Criteria for Selection for Seamless Retrieval.......................................................53

Interpolation .........................................................................................................55

Daylight Savings ..................................................................................................56

Transition from Daylight Saving to Standard Time............................56

Retrieving Standard Time Stamps Only .............................................57

3BUF001094R4101 5

Table of Contents

Retrieving Both Daylight Saving and Standard Time Stamps ........... 57

Transition from Standard to Daylight Saving Time ........................... 60

Writing to History Logs ....................................................................................... 62

Inserting New Values.......................................................................... 62

Modifying Existing Values ................................................................. 62

Alarm/Event Messages.................................................................................................... 63

Production Data............................................................................................................... 64

SQL Access ..................................................................................................................... 64

Data Providers ................................................................................................................. 65

Data Provider Architecture .................................................................................. 65

How Data Providers Work.................................................................. 67

Guidelines for Referencing Data Providers ......................................................... 69

When is Referencing Necessary? ....................................................... 69

DataDirect ...................................................................................... 69

Desktop Trends ................................................................................... 70

Display Services ................................................................................. 70

Batch Management PDL Browser ...................................................... 70

Accessing the Display Server Status Window.................................... 71

Open Data Access ........................................................................................................... 73

ODA Architecture............................................................................... 75

Set-up for SQL*Plus ....................................................................................................... 77

ORACLE_SID .................................................................................... 77

tnsname ...................................................................................... 77

Section 2 - DataDirect - Excel Data AccessGeneral ............................................................................................................................ 79

User Access to DataDirect Add-in Tools ............................................................ 79

Populating Pick Lists for Data Retrieval/Entry Dialogs ...................................... 79

Product Overview............................................................................................................ 80

Data Access Methods........................................................................................... 81

User Interface - DataDirect Add-in Tools ........................................................... 84

Accessibility to Add-in Tools for Different Windows Users ............. 84

Showing/Hiding DataDirect Add-in Tools ......................................... 84

6 3BUF001094R4101

Table of Contents

Licensing .............................................................................................................85

Application Set-up...........................................................................................................86

Enabling Macros ..................................................................................................86

Manually Adding the DataDirect Add-in.............................................................88

Updating Function References in Worksheets .....................................................90

Fixing DataDirect After Upgrading Microsoft Excel ..........................................93

Changing the Language Selection for Microsoft Office ......................................93

Change the File Open Set-Up for Microsoft Excel Worksheets ..........................93

Starting DataDirect ..........................................................................................................94

Enabling Macros .................................................................................94

What You Should Know Before You Get Started ...............................................95

Logging In ......................................................................................95

Customizing Your Application ...........................................................95

Getting Help ......................................................................................95

About DataDirect ................................................................................96

Finding the Right Tool ........................................................................97

Login ..............................................................................................................................98

Perpetual Login ...................................................................................99

Login As Needed for Ad-hoc Data Requests ......................................99

Using the Login Dialog.....................................................................100

User ....................................................................................100

Password ....................................................................................101

Host ....................................................................................101

Save Settings ....................................................................................101

Using DataDirect Dialogs..............................................................................................102

Selecting the Starting Cell..................................................................................103

Opening the Dialog ............................................................................................103

Changing the Start Cell ......................................................................................103

Inserting or Overwriting Rows...........................................................................104

Specifying One-time Data Access or Reusable Formulas .................................104

Date and Time ....................................................................................................105

Date and Time ...................................................................................105

3BUF001094R4101 73BUF001094R4101 7

Table of Contents

Cell Reference................................................................................... 106

Dynamic Time .................................................................................. 106

Formatting.......................................................................................................... 107

Monitoring/Changing the Server Connection.................................................... 108

Apply, OK, & Cancel Buttons ........................................................................... 108

Reading and Writing Process Values ............................................................................ 109

Using the Industrial IT Process Values Dialog ............................................................. 110

Reading Process Values..................................................................................... 111

Selecting Objects to Query ............................................................... 112

Specifying Whether or Not to Include Child Objects....................... 113

Applying a Filter to the List of Returned Object Properties............. 114

Expanding the Items Columns in the Returned Properties List (Right Pane)116

Writing Process Values...................................................................................... 117

User Authority .................................................................................. 117

Using the Object Browser................................................................. 118

Use Spreadsheet for Input................................................................. 120

Using the Inform IT Process Values Dialog ................................................................. 122

Reading Process Values..................................................................................... 124

Selecting Objects to Query ................................................................................ 125

Selecting OPC Tags ........................................................................................... 125

Selecting ABB OCS Tags ................................................................................. 127

Changing the Object Text File.......................................................... 128

Selecting the Object Type................................................................. 129

Selecting Object Attributes ............................................................... 130

Adding New Items to the Object and Attribute Pick Lists ............... 131

Writing Process Values...................................................................................... 132

User Authority .................................................................................. 132

Update Process Values Tab .............................................................. 133

Updating OPC Tags .......................................................................... 134

Building an Ad-hoc List ................................................................... 137

Importing a Formatted Range of Cells from a Spreadsheet.............. 141

8 3BUF001094R4101

Table of Contents

Importing Non-formatted Ranges of Cells from a Spreadsheet........144

Recording the Output Results ...........................................................147

Reading/Writing History Data.......................................................................................149

Using the Industrial IT History Values Dialog..............................................................150

Reading History Data .........................................................................................152

Retrieval Type....................................................................................................153

Interpolated Data ...............................................................................153

Raw Data ....................................................................................153

Log Calculation Algorithm ................................................................................154

Number of Values ..............................................................................................156

Time Span for Retrieval .....................................................................................156

Selecting Logs ....................................................................................................156

Specifying Whether or Not to Include Child Objects .......................157

Applying a Filter to the List of Returned Logs .................................158

Changing the Output Options.............................................................................160

Writing History Data..........................................................................................161

User Authority...................................................................................161

Using the Object Browser .................................................................162

Use Spreadsheet for Input .................................................................164

Using the Inform IT History Values Dialog..................................................................167

Retrieving History Data .....................................................................................169

Selecting the Data Provider................................................................................170

Retrieval Type....................................................................................................171

Trend Display....................................................................................171

Interpolated Data ...............................................................................171

Raw Data ....................................................................................171

Bulk Data Export...............................................................................172

Selecting History Objects...................................................................................173

Accessing Property Logs via OPC HDA ..........................................173

ABB OCS (Enterprise Historian Platform) History Access .............175

Log Calculation Algorithm ................................................................................176

Log Calculation for OPC HDA Server .............................................176

3BUF001094R4101 93BUF001094R4101 9

Table of Contents

Log Calculation for Enterprise Historian version 3.2/1 or Earlier (LOG)179

Number of Values .............................................................................................. 180

Bulk Format Interval.......................................................................................... 180

Time Span for Retrieval..................................................................................... 180

Changing the Output Options ............................................................................ 181

Adding/Modifying Entries for a Lab Data Log ................................................. 182

User Authority .................................................................................. 182

Other Considerations ........................................................................ 182

Accessing the Add/Modify Tab........................................................ 183

Updating an OPC HDA Property Log .............................................. 184

Building an Ad-hoc List ................................................................... 188

Importing a Formatted Range of Cells from a Spreadsheet.............. 191

Importing Non-formatted Ranges of Cells from a Spreadsheet ....... 193

Recording Output Results ................................................................. 195

Retrieving Alarm/Event and Message Data .................................................................. 197

Using the Industrial IT Alarm/Events Dialog.................................................... 198

Using the Alarms and Events Dialog................................................................. 199

Selecting Alarm and Event Lists ...................................................... 200

Applying a Filter to the List of Returned Alarm and Event Lists..... 200

Using the Inform IT Message Log Dialog......................................................... 202

Selecting Which Tab to Use ............................................................. 203

OPC/Audit Trail................................................................................................. 204

OPC Attributes.................................................................................. 205

Using the Vendor/Categories List..................................................... 207

OPC Attribute Query ........................................................................ 208

Vendor Attribute Query .................................................................... 209

Generate SQL ................................................................................... 209

Saving a Query.................................................................................. 210

Additional Output Options................................................................ 210

Alarm and Event ................................................................................................ 211

Log Name .................................................................................... 212

10 3BUF001094R4101

Table of Contents

Search Text ....................................................................................212

Message Type....................................................................................212

Database Fields .................................................................................212

Browse ....................................................................................213

Auto-Create ....................................................................................213

Alarm/Event Format Output ..............................................................................215

Generate SQL....................................................................................215

Output Selection................................................................................215

Sort Order ....................................................................................215

Output Fields ....................................................................................215

Buttons ....................................................................................215

Retrieving Production Data ...........................................................................................216

Using the Batch Data Dialog..............................................................................216

Using the Batch Data Dialog..............................................................................219

Functions ....................................................................................220

Batch ID ....................................................................................222

Other Methods for Specifying Batch ID ...........................................223

Selecting Columns ............................................................................224

Filtering ....................................................................................225

Sorting ....................................................................................228

Output Type ....................................................................................229

Maximum Rows ................................................................................229

Editing the Function or SQL Query ..................................................230

SQL Queries ....................................................................................230

DataDirect Functions ........................................................................230

Improving the Performance of the Batch_Trend View.....................231

Using the Production Data Log Dialog..............................................................232

Setting Up the PDL Interface ............................................................233

Opening the Dialog ...........................................................................233

Using the Dialog ...............................................................................233

Search Criteria...................................................................................234

Task Type ....................................................................................234

3BUF001094R4101 113BUF001094R4101 11

Table of Contents

Task Value .................................................................................... 235

Time Span .................................................................................... 235

Limiting the Amount of Data Returned By Your Query .................. 236

Search Results................................................................................... 237

Drilling .................................................................................... 238

Output Results................................................................................... 240

Output Items .................................................................................... 240

Output Choices ................................................................................. 241

Associated Data Listing .................................................................... 243

Variables .................................................................................... 244

Resources .................................................................................... 245

Messages .................................................................................... 246

History .................................................................................... 246

Next-Level Listing............................................................................ 249

Printing a Screen Dump of the PDL Dialog ..................................... 249

Retrieving Data by SQL Query..................................................................................... 250

Saving and Re-using SQL Queries .................................................................... 252

Save SQL Query ............................................................................... 252

Open SQL Query .............................................................................. 252

Retrieving Values for TCL Unit Arrays........................................................................ 254

Using the OPC Browser ................................................................................................ 256

Navigation Methods........................................................................................... 257

Filtering .......................................................................................................... 258

Copying Items.................................................................................................... 259

Considerations for History Access .................................................................... 259

Seamless Retrieval for AIPHDA ...................................................... 260

Configuring Options...................................................................................................... 261

Data Format ....................................................................................................... 262

Horizontal List .................................................................................. 263

Vertical List .................................................................................... 263

Attributes as Headers ........................................................................ 264

Long Format .................................................................................... 264

12 3BUF001094R4101

Table of Contents

Headers ....................................................................................264

Object Names ....................................................................................265

History Log Calculation ....................................................................265

Attribute Names ................................................................................265

History Data Quality .........................................................................265

Symbolic ....................................................................................265

Numeric ....................................................................................265

Autofit All Columns..........................................................................265

Time Stamp ....................................................................................266

Date and Time Formatting ................................................................266

View ...........................................................................................................267

PDL/Batch..........................................................................................................268

Type of PDL ....................................................................................269

Configuring Flexible Task Types......................................................269

Search Time Span .............................................................................271

Search Criteria is Case Sensitive.......................................................271

Use Restored Archive .......................................................................271

Options for the Batch Data Dialog....................................................271

Maximum Rows to be Returned .......................................................272

Language for Message Type .............................................................273

Allow PDL Updates ..........................................................................273

Setup ...........................................................................................................273

Data Provider Connections ...............................................................274

Name or Channel Number ................................................................276

Enable/Disable Write Access to History and Process Values...........277

Port Number ....................................................................................277

Timeout ....................................................................................277

Write Debug File...............................................................................278

Disable Functions..............................................................................278

History Server ...................................................................................278

File Setup ...........................................................................................................279

Changing the Text File Specification for a Pick List ........................280

3BUF001094R4101 133BUF001094R4101 13

Table of Contents

Editing a Text File ............................................................................ 280

Setting Object Name and Alias Options ........................................... 280

Deleting/Retaining Bulk Data Temporary Files ............................... 280

Auto-Creating a Text File ................................................................. 281

Messages .......................................................................................................... 283

Configuring Pick Lists for Advant OCS Objects .......................................................... 284

Populating Pick Lists..................................................................................................... 285

Guidelines for Creating New Text Files ............................................................ 287

Applying New Default Files ............................................................. 288

Aliases .................................................................................... 289

Section 3 - DataDirect - Excel Data Access FunctionsStoring Report Templates ................................................................. 292

Inserting Functions in the Spreadsheet .............................................................. 293

Putting the Workbook in Manual Mode ........................................... 294

Inserting DataDirect Functions with the Function Wizard ............... 295

Inserting DataDirect Functions Manually......................................... 297

Storing, Updating and Scheduling Reports........................................................ 298

Saving a Report Template................................................................. 298

Updating the Excel Spreadsheet ....................................................... 298

Functions for Reading/Writing Process Values ............................................................ 299

Industrial IT Functions for Process Values....................................... 299

Inform IT Functions for Process Values........................................... 299

ABBGetOPCDASimple..................................................................................... 300

ABBGetOPCDA................................................................................................ 301

ABBWriteOPCDA............................................................................................. 302

ABBGetObj ....................................................................................................... 303

ABBUpdateObj.................................................................................................. 304

User Authority .................................................................................. 304

Data Provider Specification .............................................................. 304

Functions for Reading/Writing History Values ............................................................ 306

Industrial IT Functions for History Values....................................... 306

Inform IT Functions for History Values ........................................... 306

14 3BUF001094R4101

Table of Contents

ABBGetOPCHDA .............................................................................................307

Matching the Number of Returned values with the Number of Rows Selected.......................................................................309

Formatting the Date...........................................................................309

ABBGetOPCHDAAggregates ...........................................................................310

ABBWriteNOPCHDA .......................................................................................311

Guidelines for Writing History Data.................................................311

Log Entry Specification ....................................................................311

Syntax ....................................................................................312

ABBWriteOPCHDA ..........................................................................................313

Guidelines for Writing History Data.................................................313

Syntax ....................................................................................313

ABBGetOPCHDAAttributes .............................................................................315

ABBGetOPCHDAAttributeValue .....................................................................316

Matching the Number of Returned values with the Number of Rows Selected.......................................................................318

Formatting the Date...........................................................................318

ABBGetHistory..................................................................................................319

Matching the Number of Returned values with the Number of Rows Selected.......................................................................320

Formatting the Date...........................................................................321

ABBEditLog ......................................................................................................322

User Authority...................................................................................322

Data Provider Specification ..............................................................322

Syntax ....................................................................................323

ABBEditNLogs ..................................................................................................324

User Authority and Data Provider Specification ..............................324

Log Entry Specification ....................................................................324

Syntax ....................................................................................325

ABBGetAttributes..............................................................................................326

ABBGetAttributeValue......................................................................................326

Functions for Reading Messages...................................................................................328

ABBAERetrieval................................................................................................328

3BUF001094R4101 153BUF001094R4101 15

Table of Contents

Miscellaneous Functions ............................................................................................... 330

ABBSql .......................................................................................................... 330

Requesting All Data.......................................................................... 331

ABBArray .......................................................................................................... 332

Requesting All Data.......................................................................... 333

ABBConnect ...................................................................................................... 334

ABBDisconnect ................................................................................................. 334

Using VBA Macros ........................................................................................... 335

Adding Charts to DataDirect Reports ................................................................ 336

Recommendations for Chart Type.................................................... 337

Making Charts Dynamic................................................................... 338

Section 4 - Using Desktop TrendsProduct Overview.......................................................................................................... 340

Connection and Set-up .................................................................................................. 340

Connecting to the Data Server ........................................................................... 341

Setting Up Pick Lists ......................................................................................... 343

Guidelines for Creating New Text Files ............................................................ 345

Applying New Default Files .............................................................................. 345

Setting Up the Limits File.................................................................................. 346

Guidelines for Creating New Limits Files ........................................ 346

Applying New Default Files .............................................................................. 347

Trend Display................................................................................................................ 348

Launching the Trend Display ............................................................................ 349

Description......................................................................................................... 350

Frame Bar .................................................................................... 350

Graphical Trend Area ....................................................................... 351

Value and Time Scales ..................................................................... 351

Table View (Info Area)..................................................................... 351

Scope/Zoom Tool Bar....................................................................... 351

Miscellaneous Tool Bar .................................................................... 352

Setting Up the Trend Display ............................................................................ 353

Setup Dialog ...................................................................................................... 354

16 3BUF001094R4101

Table of Contents

Data ...........................................................................................................355

Data Provider Connections ...............................................................355

Raw/Interpolated Data ......................................................................356

Aggregates ....................................................................................357

Visibility ...........................................................................................................358

Column Widths ..................................................................................................359

Miscellaneous Settings.......................................................................................360

Colors ....................................................................................360

Data Update Rate ..............................................................................361

Database Information ........................................................................361

Maximum Interpolated Points...........................................................361

Saving Debug Information................................................................361

Print Colors ........................................................................................................362

Status ...........................................................................................................364

Versions ...........................................................................................................365

Property Page .....................................................................................................366

Trace Properties .................................................................................................366

Enabled ....................................................................................367

Name ....................................................................................367

Description ....................................................................................367

Trace Type ....................................................................................368

Trace Lines ....................................................................................368

Limit Lines ....................................................................................368

Scale ....................................................................................368

Scale Format ....................................................................................369

Scope ....................................................................................370

Scope Properties.................................................................................................372

Scope Type ....................................................................................373

Mode ....................................................................................373

Scope Width ....................................................................................373

StartTime and EndTime ....................................................................373

Date Format ....................................................................................374

3BUF001094R4101 173BUF001094R4101 17

Table of Contents

Time Format .................................................................................... 375

Using the Trend Display .................................................................................... 376

Adding and Removing Traces ........................................................................... 377

Browsing an OPC Server ................................................................................... 378

Reading Trend Data ........................................................................................... 380

Using the Ruler ................................................................................. 381

Value Zoom .................................................................................... 382

Time Zoom .................................................................................... 382

Area Zoom .................................................................................... 382

Using the Scope/Zoom Tool Bar ....................................................................... 383

Backward Scope (Large step) ........................................................... 383

Backward Scope (Small step) ........................................................... 383

Zoom In .................................................................................... 383

Zoom out .................................................................................... 384

Default Scope.................................................................................... 384

Set Start Time ................................................................................... 384

Forward Scope (Small step).............................................................. 384

Forward Scope (Large step).............................................................. 384

Active Zoom Magnitude................................................................... 384

Active Zoom Enable/Disable............................................................ 385

Using the Table (Info) Area............................................................................... 385

Adjusting Column Widths ................................................................ 385

Trace .................................................................................... 386

Name .................................................................................... 386

Description .................................................................................... 386

Type .................................................................................... 386

Status .................................................................................... 387

Ruler Time .................................................................................... 387

Ruler Value .................................................................................... 387

Engineering Units ............................................................................. 387

Filter .................................................................................... 387

Time Offset .................................................................................... 388

18 3BUF001094R4101

Table of Contents

Limits ....................................................................................388

Showing/Hiding and Docking/Undocking Trend Display Components............388

Viewing Trend Statistics ....................................................................................389

Copying and Pasting Trend Data to Other Applications....................................391

Copying and Pasting a Bitmap Image of the Trend Display..............................392

Selecting the Time Scale for a Trace .................................................................392

Applying Time Offsets.......................................................................................393

Saving the Current Display ................................................................................394

Opening a Saved Display ...................................................................................395

Printing the Current Display ..............................................................................396

Toggling between Print and Display Colors ......................................................396

Launching Other Desktop Trend Tools from the Trend Display .......................396

Ticker ............................................................................................................................397

Launching the Ticker .........................................................................................398

Configuring Ticker Files ....................................................................................398

Working Off Line..............................................................................399

Configuring Tags ...............................................................................................400

Adding Tags .......................................................................................................402

Browsing for OPC Objects.................................................................................403

Adding an Advant OCS Tag ..............................................................................407

Tag Name ....................................................................................409

Attribute and Object Type.................................................................410

Limit Check ....................................................................................411

Subscription Type .............................................................................411

Data Provider ....................................................................................412

Adding Tags .......................................................................................................412

Copying an Existing Tag....................................................................................413

Removing Tags from the File ............................................................................414

Reverting to the Saved Configuration for a Tag ................................................415

Configuring the Appearance of the Ticker File .................................................415

Data Format ....................................................................................417

Changing Colors................................................................................419

3BUF001094R4101 193BUF001094R4101 19

Table of Contents

Changing the Font............................................................................. 420

Changing Ticker Defaults .................................................................................. 421

Configuring the Data Delimiter ......................................................................... 423

Configuring Error Condition Indicators ............................................................ 427

Errors to Show .................................................................................. 427

Colors .................................................................................... 428

Priorities .................................................................................... 428

Behavior .................................................................................... 428

File Specifications.............................................................................................. 429

Aspect Object Browser Defaults........................................................................ 430

Default Data Provider ....................................................................... 431

Default Subscription Type ................................................................ 431

Operating the Ticker .......................................................................................... 432

Displaying Real Time Data on the Ticker ........................................ 432

Showing Errors ................................................................................. 433

Saving the Ticker File....................................................................... 434

Clearing the Ticker ........................................................................... 436

Dragging and Dropping Tags Between Desktop Trend Controls...................... 437

Dragging and Dropping from Another Desktop Trend Control ....... 437

Dragging and Dropping from a Text Editor or Spreadsheet............. 439

Refreshing Tag Limits ....................................................................................... 442

Displaying Version Information for the Ticker Controls .................................. 442

Launching the Trend Display from the Ticker .................................................. 443

Refreshing the Ticker in Internet Explorer ........................................................ 444

Tag Explorer.................................................................................................................. 445

Launching the Tag Explorer .............................................................................. 446

Configuring the Tag Explorer............................................................................ 446

Working Off Line ............................................................................. 446

Creating Tag Groups.......................................................................................... 447

Specifying the Contents Tag Groups ................................................................. 448

Adding Tags to an Explorer File....................................................... 449

Modifying the Configuration for an Existing Tag ............................ 449

20 3BUF001094R4101

Table of Contents

Importing Files ..................................................................................450

Clearing the Current Tag Explorer Configuration .............................................451

Configuring the Tag Explorer Appearance and Operational Characteristics.....452

Configuring the General Appearance................................................454

Columns ....................................................................................455

File Specifications ..............................................................................................457

Using the Tag Explorer ......................................................................................459

All Tags ...........................................................................................................460

Dragging and Dropping Tags in Tag Explorer ..................................................461

Exporting Files ...................................................................................................461

Exporting a Tag Group to Create a New Ticker File ........................461

Exporting a Tag Explorer File for Backup........................................463

Displaying Version Information for the Tag Explorer Controls ........................463

Launching the Trend Display from the Tag Explorer ........................................464

PDL Browser .................................................................................................................466

Opening the PDL Browser .................................................................................467

Setting Up the PDL Browser Interface ..............................................................468

Type of PDL ....................................................................................470

Configuring Flexible Task Types......................................................471

Convert Task Value to Uppercase.....................................................472

Use Restored Archive .......................................................................472

Maximum Values to be Returned .....................................................472

Warn If Exceeded..............................................................................472

Default Time Span ............................................................................473

Date and Time Format ......................................................................474

Data Provider ....................................................................................475

Query Timeout ..................................................................................476

Language ....................................................................................476

ProduceIT Messages .........................................................................476

Trend File ....................................................................................476

Using the PDL Browser .....................................................................................476

Search Criteria....................................................................................................477

3BUF001094R4101 213BUF001094R4101 21

Table of Contents

Task Type .................................................................................... 477

Task Value .................................................................................... 477

Time Span .................................................................................... 478

Limiting the Amount of Data Returned By Your Query .................. 480

Search Results.................................................................................................... 481

Copying Search Results .................................................................... 482

Drilling .................................................................................... 482

Associated Data Listing .................................................................... 483

Variables .................................................................................... 483

Resources .................................................................................... 484

Messages .................................................................................... 485

History .................................................................................... 485

Next-Level Listing............................................................................ 487

Batch to Batch Display.................................................................................................. 488

Opening the Batch to Batch Display................................................. 488

Using the Batch to Batch Display..................................................... 488

Setting Up the Batch to Batch Display ............................................. 489

Event Browser ............................................................................................................... 491

Opening the Event Browser ............................................................................... 492

Setting Up the Event Browser Interface ............................................................ 493

Local or UTC Time........................................................................... 494

Retrieving Events............................................................................................... 494

Log Name .................................................................................... 494

Time Span .................................................................................... 494

Viewing Trend Data Related to Events ............................................................. 495

SQL Browser................................................................................................................. 496

Opening the SQL Browser................................................................................. 497

Setting Up the SQL Browser Interface .............................................................. 497

Show Grid Lines in Results List ....................................................... 498

Column Colors .................................................................................. 499

Using the SQL Browser ..................................................................................... 499

Specifying and Executing Ad-hoc SQL Queries ............................................... 500

22 3BUF001094R4101

Table of Contents

Considerations for Data Providers on Windows and HP-UX Platforms501

Managing Queries ..............................................................................................501

Saving a Query..................................................................................503

Opening a Saved Query ....................................................................503

Deleting a Saved Query ....................................................................503

Dragging Tag Names and Time Stamps to the Desktop Trend Display ............504

Using the Configure Columns for Drag Dialog ................................505

Select Columns By Clicking .............................................................506

OPC Browser.................................................................................................................507

Changing the Data Provider ...............................................................................508

Getting the Entire List of Available Objects......................................................509

Filtering ...........................................................................................................510

Considerations for History Access.....................................................................511

AIPHDA Access ...............................................................................511

IMHDA Access .................................................................................512

Selecting Tags ....................................................................................................513

Copying Items ....................................................................................................513

Section 5 - Creating ReportsOverview .......................................................................................................................515

Report Building Applications ...........................................................516

Implementing Reports .......................................................................516

Example Reports ................................................................................................518

Example Batch Reports.....................................................................518

Example Information Management Reports .....................................520

Example Miscellaneous Reports .......................................................523

Basic Steps for Building and Executing a Report .............................524

Reports that use Visual Basic macros ...............................................525

Troubleshooting ................................................................................525

Viewing Reports Over the Web ........................................................525

Managing Completed Report Objects ...............................................525

Setting Up the Report Action and Scheduling Definition .............................................526

Creating Objects and Aspects in the Scheduling Structure................................526

3BUF001094R4101 233BUF001094R4101 23

Table of Contents

Defining the Report Action................................................................................ 529

Selecting the Report Action ............................................................................... 530

Selecting the Report Template........................................................................... 530

Output Options................................................................................................... 532

Using Parameters to Modify an Output File Path............................. 533

Output Options for HTML Files ....................................................... 534

Report Parameters.............................................................................................. 535

Parameter Substitution in an Output File Path.................................. 537

Substituting Argument Values for Parameter Values....................... 537

Parameters for Crystal Reports ......................................................... 539

Specifying the Data Server for Queries in Crystal Reports .............. 539

Specifying the Data Server for DataDirect ....................................... 539

Passing Parameters to an Excel Spreadsheet .................................... 540

Export File ......................................................................................................... 541

Export to a Completed Report Object............................................... 541

Export to Windows File .................................................................... 543

Printer .......................................................................................................... 546

Email .......................................................................................................... 546

Save to History................................................................................................... 548

Saving HTML or XML reports to History........................................ 550

Execute File ....................................................................................................... 551

Defining the Schedule........................................................................................ 552

Periodic Scheduling .......................................................................... 553

Before Running a Report .............................................................................................. 554

Viewing Reports Over the Web .................................................................................... 555

Creating A Virtual Web Directory..................................................................... 555

Creating Report Output And Viewing It Over The Web................................... 558

Attaching a Report Template to a File Viewer Aspect ................................................. 559

Report Preferences Aspect ............................................................................................ 565

Report Printing Aspect .................................................................................................. 566

View Report Logs Aspect ............................................................................................. 567

Viewing Reports Stored in a Report Log.......................................... 568

24 3BUF001094R4101

Table of Contents

Setting Up E-mail for Reports .......................................................................................569

Guidelines for Setting Up the POP3 Server .......................................................569

Guidelines for Outlook Express .........................................................................570

Troubleshooting Reports ...............................................................................................578

Creating a Report with Crystal Reports - Example .......................................................579

Connecting the Report to the ODA Table for Historical Data..........580

Selecting Fields from the Batch_Trends View to Include in the Report582

Adding Parameters ............................................................................583

Configuring the Query to Get Historical Process Data for the Current Batch...........................................................................585

Integrating the Report into the 800xA System..................................587

Using DataDirect................................................................................................588

Passing in batchid..............................................................................589

Retrieving Historical Log Data for the Batch ...................................589

Integrating the Report into the 800xA System..................................592

Using Excel Without DataDirect Add-ins..........................................................593

Connecting the Excel Spreadsheet to the ODBC Data Source .........593

Section 6 - SchedulingAdding a Job Description Object ..................................................................................599

Scheduling Definition View..............................................................601

Defining the Schedule ........................................................................................602

Cyclic Scheduling ..............................................................................................603

Periodic Scheduling ...........................................................................................604

Weekly Scheduling ............................................................................................605

Frequency ....................................................................................606

Day of week ....................................................................................606

Time of day ....................................................................................606

Monthly Scheduling ...........................................................................................607

Days ....................................................................................608

Daily ....................................................................................608

Hourly ....................................................................................608

Creating a Scheduling List .................................................................................609

3BUF001094R4101 253BUF001094R4101 25

Table of Contents

Expression-based Scheduling ............................................................................ 610

Specifying Start Conditions .......................................................................................... 611

Configuring a Start Condition........................................................... 613

The Expression Start Condition ......................................................................... 614

The Yes/No Start Condition .............................................................................. 615

Arguments ..................................................................................................................... 616

Viewing a Job Log ........................................................................................................ 618

Actions .......................................................................................................................... 619

Action Aspect View.......................................................................... 621

Job Hierarchies.............................................................................................................. 623

The Running Job ........................................................................................................... 623

Monitoring a Running Job ................................................................................. 624

Viewing Alarm and Event List .......................................................................... 626

Purging Running Job Objects ............................................................................ 627

Using the Test Action to Test a Job ................................................................... 627

Security ......................................................................................................................... 628

Securing Windows Files on Shared Network Drives ........................................ 632

Section 7 - Browsing for OPC TagsLaunching the OPC Browser ............................................................................. 634

Changing the Server Connection ....................................................................... 635

Changing the Data Provider............................................................................... 636

Navigation Methods........................................................................................... 637

Filtering .......................................................................................................... 639

Copying Items.................................................................................................... 640

Considerations for History Access .................................................................... 641

AIPHDA Access ............................................................................... 642

IMHDA Access................................................................................. 642

Section 8 - Reading and Managing Archive DataUser Interface.................................................................................... 646

Archive Operations ........................................................................... 646

User Interface for Managing Archive Data................................................................... 647

26 3BUF001094R4101

Table of Contents

Archive Device Aspect ......................................................................................648

Supported Functions..........................................................................649

Archive Device Information .............................................................650

Archive Volume Aspect .....................................................................................651

Supported Functions..........................................................................653

Archive Volume Aspect Information................................................654

Archive Group Aspect........................................................................................657

Supported Functions..........................................................................658

View Logs Aspect ..............................................................................................660

View Report Logs Aspect ..................................................................................661

Viewing Reports Stored in a Report Log..........................................663

View Production Data Logs Aspect ...................................................................664

Maintaining Archive Media ..........................................................................................666

MO Media ....................................................................................666

Hard Disk Media ...............................................................................666

Other Maintenance Operations .........................................................666

Removing/Replacing Platters.............................................................................667

Activating/Deactivating an Archive Device ......................................................668

Remounting a Volume .......................................................................................669

Initializing an Archive Volume..........................................................................669

Copying Volumes...............................................................................................674

Overriding Volume Backup ...............................................................................677

Archiving Logs Manually..............................................................................................677

Manual Archiving for Archive Groups ..............................................................678

Manual Archiving Property and Message Logs on an Ad-hoc Basis ................680

Opening the View Logs Aspect ........................................................680

Retrieving Log Information ..............................................................682

Filtering the Retrieved Logs List ......................................................685

Completing the Archive Request ......................................................687

Manually Archiving PDLs .................................................................................690

Filtering the Task List .......................................................................692

Completing the Archive Request ......................................................693

3BUF001094R4101 273BUF001094R4101 27

Table of Contents

Verifying Archive Data................................................................................................. 694

Verifying Signatures for a Volume.................................................................... 695

Showing Signature Information for a Volume .................................................. 696

Making Archived Data Available to Client Applications ............................................. 696

Publishing an Archive Volume.......................................................................... 697

Accessing Published Logs ................................................................................. 700

Unpublishing a Volume .................................................................... 700

Restoring Logs from Archive Media to Restored Database .............................. 701

Restoring an Archive Entry .............................................................. 702

Restoring Selected Logs in an Entry................................................. 703

Restoring an Entry With Platform Objects ....................................... 704

Filtering Archive Entries .................................................................. 705

Filtering Logs.................................................................................... 707

Accessing Restored Logs................................................................................... 709

Deleting Restored Logs ..................................................................................... 709

Deleting Restored PDLs and Tasks .................................................. 710

Miscellaneous Archive Operations ............................................................................... 711

Listing Group Items ........................................................................................... 711

Resetting the Last Archive Time for an Archive Group.................................... 712

Showing Volume Information ........................................................................... 712

Showing Platform Information for a Log .......................................................... 713

Importing Archive Data ................................................................................................ 715

Overview .......................................................................................................... 716

The Process .................................................................................... 716

The Workbook .................................................................................. 717

Step-by-Step Instructions................................................................................... 719

Starting the Archive Import Tool...................................................... 719

Generating an Aspect Reference Data Source .................................. 721

Setting the Archive Group Filter ...................................................... 722

Loading Data From Archive Volume ............................................... 724

Creating Objects for the Archive Log Configurations...................... 728

Creating New Objects ....................................................................... 729

28 3BUF001094R4101

Table of Contents

Match Existing Objects .....................................................................731

Creating Archive Log Templates ......................................................733

Creating Archived Logs ....................................................................734

Creating/Updating New AIP INFO File ...........................................735

Viewing the Imported Archive Data .................................................738

Overriding The Defaults ...................................................................739

Importing an Archive With More Than 65,000 Logs ........................................742

Modifying a Workbook......................................................................................742

Section 9 - Reading Message LogsMessage Log Tables...........................................................................................743

Example Queries ................................................................................................750

Query for MSGLOG Table Name for PDL Message Logs ..............750

Example Query for Data ...................................................................750

Appendix A - Using Open Data AccessODA for Real-time Data ...............................................................................................753

Guidelines for Using Custom Database Tables .................................................755

Sample Queries for Custom Database Tables ....................................................756

To get one property from one object.................................................756

To get one property from all objects of the type...............................756

To get one property from several objects of the same type ..............756

To get selected properties from all objects of the type with value less than 50 ................................................................................756

To get selected properties from all objects of the type with good data quality .........................................................................756

To get all configured properties from one object..............................757

To get all configured properties from all objects of the type, and sort them alphabetically..............................................................757

To get all properties from several objects with related names, using LIKE and wildcards..............................................................757

To get a property from each child of a given object that has a given type (complex query using join).........................................757

To set the value of one property in an object ....................................757

3BUF001094R4101 293BUF001094R4101 29

Table of Contents

Guidelines for Using the Generic_DA Table .................................................... 758

Sample Queries for Generic_DA....................................................................... 760

General Guidelines ........................................................................... 760

To get one property from one object ................................................ 761

To get one property (and object name) from all objects of a type.... 761

To get value of all properties from one object.................................. 761

To get all value of properties from all objects of a type: .................. 762

To get a property from each child of a given object that has a given type (complex query using join) ........................................ 762

To get several properties with related names, from several objects with related names, using LIKE and wildcards.................. 762

To get names of all objects of the type whose parent is a Control Module762

ODA for Historical Data Access................................................................................... 763

SQL Query Structure ......................................................................................... 764

Basics .................................................................................... 764

Example .................................................................................... 765

The SELECT Clause......................................................................... 765

The FROM Clause ............................................................................ 765

The WHERE Clause ......................................................................... 765

The ORDER BY Clause ................................................................... 766

Query Guidelines ............................................................................................... 766

Specifying the Log in a Query ........................................................................... 767

Aggregate .................................................................................... 767

Intervals .................................................................................... 768

Time Range .................................................................................... 768

Timestamp Format ............................................................................ 768

Example Queries................................................................................................ 768

Basic Query for Numeric Data .......................................................................... 768

Query: .................................................................................... 769

Query for Numeric Data from a Secondary Log ............................................... 769

Query: .................................................................................... 769

Query for a Specific Time Range ...................................................................... 769

30 3BUF001094R4101

Table of Contents

Query: ....................................................................................769

Query for Interpolative Data ..............................................................................770

Query ....................................................................................770

UPDATE and INSERT Functions .....................................................................771

Insert Query Examples:.....................................................................771

Update Query Example: ....................................................................771

IMHDA Access ..................................................................................................772

LOGMAN ....................................................................................772

EH ....................................................................................773

EH_NET ....................................................................................773

Using UPDATE and INSERT with the IMHDA Server...................774

Insert Query Examples:.....................................................................774

Update Query Example: ....................................................................774

ODA for Profile Data Access ........................................................................................775

Profile Historian Example..................................................................................777

Comparing Data Box Indices for AC450 and QCS ..........................777

Queries ....................................................................................777

Connecting Client Applications to an ODA Database ..................................................778

Using Crystal Reports ........................................................................................778

Accessing the Data Explorer .............................................................779

Using the Data Explorer to Connect to an ODA Database ...............780

Using the Data Explorer to Connect to an Oracle Table, View, or Synonym.....................................................................782

Using Excel Without DataDirect Add-ins..........................................................790

Connecting the Excel Spreadsheet to the ODBC Data Source .........790

Using OLE DB...................................................................................................794

Accessing ODA Programmatically using ADO ............................................................800

Appendix B - PDL for Batch ManagementConfiguration Requirements for Batch Management....................................................803

Establishing History Associations in Batch Management .................................804

Setting Up Storage of Batch Procedures in PDL ...............................................807

Setting Up a Shared Folder on the Information Management Node.808

3BUF001094R4101 313BUF001094R4101 31

Table of Contents

Accessing PDL Data ..................................................................................................... 809

Querying for a Specific Task Type in the Task Hierarchy ................................ 810

Example: Query for all Campaigns .................................................. 810

Example: Query for all Phases for a Specific Operation .................. 811

How to Get taskid if it is Unknown ................................................................... 811

How To Query for the Entire Campaign Hierarchy .......................................... 811

How to Exclude Parts of the Hierarchy ............................................................. 812

Joining Task Views............................................................................................ 813

Example: Query for Batch Started by a Specific Job ....................... 813

Retrieve Variable Data for a Specific Batch Occurrence .................................. 814

Accessing Archived Data................................................................................... 816

PDL Tables and Views.................................................................................................. 817

Tables and Views for Restored Archive Data .................................. 832

Appendix C - Using the IM OPC HDA ServerAccessing History Servers in Other Aspect Systems ....................... 857

Enhanced Browsing Features for History Logs ................................ 857

Syntax for Log Name References ..................................................... 859

Direct Access to Trend Logs ............................................................ 859

Appendix D - Terminology

INDEX

32 3BUF001094R4101

About This Book

This book provides instructions for using Information Management DataDirect and Desktop Trends for data access in the 800xA system. This book also provides guidelines for using DataDirect or third party applications to build, schedule, and manage reports for 800xA system applications.

Intended User This book is intended for anyone that uses the Display and Client Services and/or third-party applications to access data in the 800xA system. This book is not the sole source of instruction for this functionality. It is recommended that you attend the applicable training courses offered by ABB. Also refer to Related Documentation on page 35 to find other documents on this subject.

Use of Warning, Caution, Information, and Tip IconsThis publication 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 indicates the presence of a hazard which could result in electrical shock.

Warning indicates the presence of a hazard which could result in personal injury.

3BUF001094R4101 33

Document Conventions About This Book

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, comply fully with all Warning and Caution notices.

Document ConventionsThe following conventions are used for the presentation of material:

• The words in names of screen elements (for example, the title in the title bar of a window, the label for a field of a dialog box) are initially capitalized.

• Capital letters are used for the name of a keyboard key if it is labeled on the keyboard. For example, press the ENTER key.

• Lowercase letters are used for the name of a keyboard key that is not labeled on the keyboard. For example, the space bar, comma key, and so on.

• Press CTRL+C indicates that you must hold down the CTRL key while pressing the C key (to copy a selected object in this case).

• The names of push and toggle buttons are boldfaced. For example, click OK.

• The names of menus and menu items are boldfaced. For example, the File menu.

– The following convention is used for menu operations: MenuName > MenuItem > CascadedMenuItem. For example: choose File > New > Type.

Caution indicates important information or warning related to the concept discussed in the text. It might indicate the presence of a hazard which could result in corruption of software or damage to equipment/property.

Information alerts the reader to pertinent facts and conditions.

Tip indicates advice on, for example, how to design your project or how to use a certain function.

34 3BUF001094R4101

About This Book Related Documentation

– The Start menu name always refers to the Start menu on the Windows Task Bar.

• System prompts/messages are shown in the Courier font, and user responses/input are in the boldfaced Courier font. For example, if you enter a value out of range, the following message is displayed:

Entered value is not valid. The value must be 0 to 30.

You may be told to enter the string TIC132 in a field. The string is shown as follows in the procedure:

TIC132

Variables are shown using lowercase letters.

sequence name

Related DocumentationTable 1 provides listing of documentation related to Information Management functions in the 800xA system.

All documentation is supplied in Adobe® Acrobat® reader (.pdf) format. Acrobat Reader is a freeware program, which can be downloaded from the internet. You can get it from: http://www.adobe.com. Windows must be set up to start the Acrobat Reader for.pdf files.

This book is available as on-line documentation on the 800xA System Documentation CD. In addition, you can subscribe to our internet site for on-line documentation.

3BUF001094R4101 35

Related Documentation About This Book

Table 1. Related Documents

Category Title Description

Software Installation

Industrial IT 800xA System Installation

How to install 800xA system.

Industrial IT 800xA System Automation System Network Configuration and design

How to set up network for 800xA system.

Industrial IT 800xA - Information Management Release Notes

Known problems, fixed problems and other release information not described in the administrator’s guide.

Getting Started

Industrial IT 800xA - Information Management Getting Started

Provides a series of tutorials that show you how to configure and use a real-world Information Management application.

Configuration Industrial IT 800xA - Information Management Configuration

Focal point for configuring all Information Management applications for an 800xA system. Provides instructions for configuring data access via data providers and Open Data Access, historical process data logging, system message logging, report logging, historical archive, softpoint database, and calculations.

Industrial IT 800xA - Information Management Configuration for Display Services

Provides instructions for building custom graphic displays using Information Management Display Services.

36 3BUF001094R4101

Section 1 Product Overview

This section provides a brief introduction to the data access tools provided by the Information Management Desktop Applications. It covers:

• Desktop Applications on page 38

• Reports on page 42

• Thin Clients on page 44

• Selecting Which Tool to Use on page 46

This section also provides guidelines and considerations for these data access applications:

• Retrieving Last History Value on page 48

• Property Log Naming Conventions on page 50

• Daylight Savings on page 56

• Writing to History Logs on page 62

• Data Provider Architecture on page 65

3BUF001094R4101 37

Desktop Applications Section 1 Product Overview

Desktop ApplicationsThe 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, on-line and off-line 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 let you apply calculations to both process and softpoint objects.

Read and write access to historical and real-time data is supported a set of desktop applications installed with the Information Management Display and Client Services. These applications let you generate ad-hoc queries through interactive dialogs, create reports, and in some cases, modify existing values or enter new values via 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 Industrial IT 800xA - Information Management Configuration.

Excel Data Access - DataDirectDataDirect is an add-in for Microsoft Excel. DataDirect is installed with the Information Management server software, and may be installed on remote PC clients using the Information Management Desktop tools software bundle. DataDirect may also be installed as a core component on other 800xA system nodes (Aspect Servers, Connectivity Servers, other Application servers, and Workplace Clients).

38 3BUF001094R4101

Section 1 Product Overview Excel Data Access - DataDirect

DataDirect provides re-executable functions to integrate into the spreadsheet. With functions you can specify certain parameters to meet your data access requirements, for example, when retrieving historical data you specify the log name, time range and so on. These functions are re-executed whenever you open or re-calculate the spreadsheet. This lets you create Excel reports for 800xA system applications.

Rather than enter functions manually, you may also use Interactive dialogs for data access. Some dialogs support ad-hoc (on-demand, one-time) queries only. Other dialogs let you 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 different storage types in the system.

DataDirect may run directly on 800xA system client and server nodes, or on remote PC clients (independent of 800xA core system software). In some cases, the function or dialog you use depends on where you are using DataDirect (on an 800xA system node or remote PC client).

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 lets you 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 core system software. These tools cannot be used on a remote PC client.

The Inform IT dialogs (and corresponding functions) do run on remote PC clients (without 800xA core 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 PC client.

The Inform IT and Batch Data dialogs and functions access data via data providers. Some configuration and set-up may be required, depending on your application. A brief overview of the data providers is provided in Data Providers on page 65. Detailed instructions for configuring and managing data providers are provided in Industrial IT 800xA - Information Management Configuration.

3BUF001094R4101 39

DeskTop Trends Section 1 Product Overview

DeskTop TrendsDesktop Trends lets you view real time, trend, production, and event data via ActiveX controls. 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.

• The Ticker shows a repeating stream of real time data for selected tags, similar to a stock market ticker.

• The Tag Explorer lets you structure data source objects in a format similar to Microsoft Windows Explorer for easy browsing and access.

• The PDL Browser lets you 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 lets you easily navigate the PDL structure to find and display historical trends for different batches.

• The Event Browser lets you retrieve messages from OPC message logs configured with Information Management - History Server function.

• The SQL Browser lets you run ad-hoc SQL queries. You can save a query once you’ve run it, and then reopen the query for viewing at some time in the future. You can also delete saved queries.

The Desktop Trends may run directly on server nodes, or on remote PC clients. All Desktop Trends tools access data via data providers. Some configuration and set-up may be required, depending on your application. A brief overview of the data providers is provided in Data Providers on page 65. Detailed instructions for

By default, Windows XP SP2 blocks ActiveX controls unless you explicitly allow access to such controls. This includes Desktop Trends and the Profile Client display. Change the default security in Internet Explorer (Tools > Internet Options..., Advanced 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.

40 3BUF001094R4101

Section 1 Product Overview Display Services

configuring and managing data providers are provided in Industrial IT 800xA - Information Management Configuration.

Display ServicesDisplay Services lets you create custom graphics and view them from your 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 Industrial IT 800xA - Information Management Configuration for Display Services.

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 alternative, displays may be viewed in a web browser, or from Thin Clients.

A display can include data from OPC servers and ADO (ODBC) data sources. Displays can read data from and write data to the system.

All data access for these displays is via data providers. Some configuration and set-up may be required, depending on your application. A brief overview of the data providers is provided in Data Providers on page 65. Detailed instructions for configuring and managing data providers are provided in Industrial IT 800xA - Information Management Configuration.

3BUF001094R4101 41

Reports Section 1 Product Overview

ReportsReporting 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 let you integrate the data into your chosen report building application. The Application Scheduler lets you set up schedules (periodic, conditional, etc...) for executing the reports. The Report Action plug-in lets you specify 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 off-line storage media, and retrieve the reports either from on-line or off-line storage.

The following report building applications are supported:

• DataDirect

• Crystal Reports - This is a third-party report builder package. Crystal Reports can access historical and real-time data via Open Data Access. This release supports Crystal Reports versions 8.5, 9.n, and 10.0.

• Microsoft Excel - You can use Microsoft Excel independent of DataDirect. Excel can access historical and real-time data via Open Data Access.

• Generic Executable - This refers to any report file that is not Microsoft Excel or Crystal Reports.

42 3BUF001094R4101

Section 1 Product Overview Reports

The architecture for reporting is illustrated in Figure 1. Crystal reports and Microsoft Excel (without DataDirect add-ins) require the Open Data Access option to access process and historical data. The report builder package must be installed on the node with the scheduling server. You can 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.

Figure 1. Report Services Architecture

ReportTemplate

Aspect System(File Viewer Aspect)

OR

Windows File System

Report Application

Microsoft ExcelCrystal Reports

Schedule

Report Action

Triggers

Executes

CompletedReport

Completed Report ObjectReport LogPrinterE-mailWindows File

Data Sources:

Real-timeBatchHistoryHistory Events

Output Options:

DataDirect

Generic

3BUF001094R4101 43

Thin Clients Section 1 Product Overview

Thin ClientsThe Thin Client feature lets you run DataDirect, Desktop Trends, and Display Client displays on remote PCs that do not have these applications installed. The remote PCs must have Citrix Client software installed. These PCs may connect to a terminal server which has Windows 2000 Server, Citrix MetaFrame XP Server, and the Display and Client Services software installed. The terminal server may be set up directly on an Information Management server, or you may set up this functionality on a dedicated terminal server PC. This architecture is illustrated in Figure 2.

Any number of users may be set up on the terminal server. The Citrix server software lets you configure these users to have access to any application on that computer, including Display and Client Services. Configuration settings are saved in the standard Windows directories on a per-user basis to support this.

Once the terminal server has been configured, any machine that has the required Citrix client software set up may now open these remote applications, which will run virtually on their local machine, but in reality will be running on the terminal server. Multiple users may run the same application simultaneously. The only limitation is than no more than five instances of Microsoft Excel may be running on the same machine at one time. This limitation is imposed by Microsoft.

The Display and Client Services applications operate in the same manner as if they were being run locally. The applications must still connect to a data server, in some cases to specify which data server is to accessed, or for some applications, to simply obtain a valid license.

44 3BUF001094R4101

Section 1 Product Overview Thin Clients

Figure 2. Thin Client Architecture

Data Server

Client Server* w/

- W2K Server- Citrix Server- Display &

Client Services

Running:2 Desktop Trends2 DataDirect1 Desktop Ticker

Citrix Client 1 w/Citrix Client

Running DesktopTicker &

Citrix Client 2 w/Citrix Client

Running DesktopTrend Display

Citrix Client 3 w/Citrix Client

Running DesktopTrend Display &

ACC/ADC/ADP

Data Requested

Data Returned

DataDirect

*Client Server may be on same node as the Data Server,or the Client Server may be installed on a dedicated PC.

DataDirect

3BUF001094R4101 45

Selecting Which Tool to Use Section 1 Product Overview

Selecting Which Tool to UseTable 3 directs you to the specific tool, and corresponding instructions in this book, that most closely fit any data access application. For further guidelines and special considerations, refer to the referenced sections below:

• Real-time Data on page 48

• Historical Process Data on page 49

• Alarm/Event Messages on page 63

• Production Data on page 64

• SQL Access on page 64

Some of the key topics covered in these sections include:

• Retrieving Last History Value on page 48

• Daylight Savings on page 56

• Data Providers on page 65

• Open Data Access on page 73

• Set-up for SQL*Plus on page 77

Table 2. Tools for Data Access

Application Tool

Reading and Writing Process Values

DataDirect: Dialogs for Reading and Writing Process Values on page 109. Functions for Reading/Writing Process Values on page 299.

Desktop Trends: Ticker on page 397.

Reading and Writing History Values

DataDirect: Dialogs for Reading and Writing Process Values on page 109. Functions for Reading/Writing History Values on page 306

Desktop Trends: Trend Display on page 348.

46 3BUF001094R4101

Section 1 Product Overview Selecting Which Tool to Use

Reading Messages DataDirect: Dialogs for Retrieving Alarm/Event and Message Data on page 197. Functions for Reading Messages on page 328

Desktop Trends: Event Browser on page 491.

Querying Oracle tables via SQL queries

DataDirect:Dialogs for Retrieving Data by SQL Query on page 250. ABBSql on page 330.

Desktop Trends: SQL Browser on page 496

Production Data (PDL) DataDirect: Industrial IT PDL Dialog - Retrieving Production Data on page 216. Desktop Trends:

PDL Browser on page 466 Batch to Batch Display on page 488

For further guidelines, see Appendix B, PDL for Batch Management.

Report Building with DataDirect Crystal Reports, Microsoft Excel, Third-party APIs

The third party packages require Open Data Access (ODA). To configure, refer to Industrial IT 800xA - Information Management Configuration. For guidelines on how to access data via ODA, see Appendix A, Using Open Data Access.For Report Building see Section 5, Creating Reports. For scheduling see Section 6, Scheduling.

Table 2. Tools for Data Access

Application Tool

3BUF001094R4101 47

Real-time Data Section 1 Product Overview

Real-time DataReal-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, see Table 2 at the end of this section.

Retrieving Last History ValueAs an alternative to retrieving real-time process data, you can retrieve data from a process object’s corresponding History log. This reduces the load on the control network, 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

You can set up this functionality on a global basis for all desktop applications by setting the user preference: AID-DATARETRIEVAL-DCSDATA. This is described in Industrial IT 800xA - Information Management Configuration. For Desktop Trends and Display Services, when this user preference is set up for real-time data retrieval, you can still retrieve the last history value on an ad-hoc basis.

48 3BUF001094R4101

Section 1 Product Overview Historical Process Data

Historical Process DataHistorical 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 supports 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, see Appendix C, Using the IM OPC HDA Server.

If your system has numeric property logs which use the Oracle storage type, you must have an ADO data provider configured via the ADSS utility. This procedure is described in Industrial IT 800xA - Information Management Configuration.

To find the tool which best fits your historical data access application, see Table 2. Other topics related to historical data access which are covered in this section are:

• Property Log Naming Conventions on page 50

• Criteria for Selection for Seamless Retrieval on page 53

• Interpolation on page 55

• Daylight Savings on page 56

• Writing to History Logs on page 62

3BUF001094R4101 49

Property Log Naming Conventions Section 1 Product Overview

Property Log Naming ConventionsThis section describes the syntax for referencing a property (numeric) log. The syntax varies slightly depending on which OPC HDA server you are using. There is also a special syntax when accessing logs on earlier Enterprise Historian platforms.

• Syntax for 800xA OPC HDA Server on page 50

• Syntax for History Server (IM) OPC HDA Server on page 51

• Syntax for Enterprise Historian - DCSLOG (LOGMAN) on page 52

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

When using a tool other than the Industrial IT tools in DataDirect, it is recommended that you use the OPC Browser to select logs for data access applications. This way you are sure to always use the correct syntax for the connected data provider. Instructions for using the OPC Browser are provided in Section 7, Browsing for OPC Tags.

Figure 3. Log Reference for 800xA OPC HDA Server

TC100:MEASURE,Log1

Property Name

Object Name

Log Name(as defined when you add the log to a log template)

50 3BUF001094R4101

Section 1 Product Overview Property Log Naming Conventions

Syntax for History Server (IM) OPC HDA Server

When you access history logs via the History Server OPC HDA server, there are two methods by which the logs can be referenced: the access name and log name.

• The Access Name defaults to the name of the object to which you added the log configuration aspect, and the object property you chose to historize. You can change the access name at your discretion.

• The Log Name is based on the Access Name with some additional characters as described in Figure 4.

Figure 4. Log Reference for HIstory Server OPC HDA Server

$HSTC100.00001.001,MEASURE-1-o

Property Name

Object Name

Integer to uniquely identify different logs in a

o = original, p = PHL, r = restored (from archive media)

composite log (for example 0 = PHL, 1 = primary,2 = first secondary, 3 = next secondary, and so on). The number is assignedaccording to the order the log was added to the template.

Prefix - $HS indicates History Log

Supplemental Object Name(1)

Supplemental Composite Log Name(2)

(1) - Only used when collecting from objects with duplicate object,property names(2) - Only used when property log has more than one composite log. See section on property logs in Industrial IT 800xA - Information Management Configuration.

3BUF001094R4101 51

Property Log Naming Conventions Section 1 Product Overview

Syntax for Enterprise Historian - DCSLOG (LOGMAN)

When you configure a property log, the access name defaults to the name of the data source that you assign to the log. For instance, TC100,MEASURE or TC100,VALUE. You can change the access name at your discretion. By virtue of the hierarchical structure of History logs, there can be more than one log using the same data source. To distinguish multiple 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 5. You can change the default log name when you configure the log.

You can use the access name to reference a log when you know the data source but do not know the log name. When you use 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 algorithm, and has a log period that provides the best coverage of the requested time period.

Use the log name when you do not want to rely on the seamless retrieval criteria to select the log, and you know the log name of the log that stores the required data. For instance, you can use the log name if you want the log that uses the STANDARD DEVIATION algorithm, and know that this data is stored in $HSTC100,MEASURE-3-o (or $HSTC100,VALUE-3-o).

Figure 5. Log Name

$HSTC100,MEASURE-1-o

Prefix - $HS indicates History Log

Access Name

Integer to uniquely identify different logs in a

o = original, p = PHL, r = restored (from archive media)

composite log (for example 0 = PHL, 1 = primary,2 = first secondary, 3 = next secondary, and so on). The number is assignedaccording to the order the log was added to thecomposite log.

52 3BUF001094R4101

Section 1 Product Overview Criteria for Selection for Seamless Retrieval

Criteria for Selection for Seamless RetrievalSeamless retrieval uses the following criteria to search the History database and select a log when a request for history data is issued:

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 descending 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 consideration.

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

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.

Seamless retrieval is only applicable for history logs. This does not apply to trend logs.

3BUF001094R4101 53

Criteria for Selection for Seamless Retrieval Section 1 Product Overview

3. This set is now sorted, depending on the specified retrieval type. One log is selected 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).

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:

1) Pick the log whose storage interval is less than and closest to the time between points (so interpolation is more accurate).

2) Pick the log whose storage interval is equal to the time between points in request.

3) Pick the log whose storage interval is greater than and closest to the time between points.

c. If retrieval type is DISPLAY, one log is selected according to retrieval type as follows:

1) Pick the log whose storage interval is equal to the time between points in request. The request is changed to RAW unless the log uses Deadband compaction, in which case the request is changed to INTERPOLATE/AVE.

2) Pick the log whose storage interval is greater than and closest to the time between points. The request is changed to INTERPOLATE/AVE.

3) Pick the log whose storage interval is less than and closest to the time between points. The request is changed to INTERPOLATE/AVE.

54 3BUF001094R4101

Section 1 Product Overview Interpolation

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.

InterpolationHistory 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 different interval, the software returns an interpolated value. Figure 6 shows an example where data is saved every 10 seconds.

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

Figure 6. Numerical Data Retrieval by Interpolation

t = 8076

y = ?

60 90

o

t = 701

y = 292

y = 221

2

3BUF001094R4101 55

Daylight Savings Section 1 Product Overview

seconds 70 and 80 are used to perform a mathematical interpolation. In this case, the value 26.2 is returned.

Daylight SavingsHistory 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 important for you to understand how your client application handles this mapping to effectively access property log data stored during these transition periods.

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 cycles. 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 the different client applications use different mapping techniques, you may have some difficulty accessing data for the exact time range you are looking for. You may also have difficulty recognizing what time range you are actually looking at. Use the following guidelines to help you access the correct data, and interpret the time stamps based on the client application you are using.

56 3BUF001094R4101

Section 1 Product Overview Daylight Savings

Retrieving Standard Time Stamps Only

If you are only interested in 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 presented 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 7 (for DataDirect and Figure 8 and Figure 9 (for Desktop Trends).

Figure 7. DataDirect Query Result with Duplicated Time Stamps between 1:00 AM & 1:59 AM

Daylight

StandardTime

SavingTime

Standard Timeonly from thisPoint On

3BUF001094R4101 57

Daylight Savings Section 1 Product Overview

Figure 8. Example, Reading Entry for Daylight Saving Time on Desktop Trend

Ruler Points to Entry for 1:30 Daylight Saving Time

58 3BUF001094R4101

Section 1 Product Overview Daylight Savings

Figure 9. Example, Reading Entry for Standard Time on Desktop Trend

Ruler Points to Entry for 1:30 Standard Time

3BUF001094R4101 59

Daylight Savings Section 1 Product Overview

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

Figure 10. Example, Transition to Daylight Saving Time using DataDirect

Daylight

StandardTime

SavingTime

Daylight SavingTime from thisPoint On

60 3BUF001094R4101

Section 1 Product Overview Daylight Savings

Figure 11. Example, Transition to Daylight Saving Time using Desktop Trends

3BUF001094R4101 61

Writing to History Logs Section 1 Product Overview

Writing to History LogsBoth DataDirect and Display Services support writing to numeric history (property) logs. You may either replace (modify) existing values, or insert new values. 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 synchronous 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 configured storage rate. For example, for a user supplied, synchronous log, if you try to add 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.

62 3BUF001094R4101

Section 1 Product Overview Alarm/Event Messages

Alarm/Event MessagesAll alarm and event messages for the 800xA system are collected and stored by the 800xA system message server. This provides a short-term storage facility with the capacity to store up to 50,000 messages. The messages can be organized into filtered lists for viewing. This functionality is described in Industrial IT 800xA Operator Workplace Configuration. The Audit Trail function records operator changes including log configuration changes, add/delete and activate/deactivate operations, and updates to lab data logs.

If your 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 on-line storage. This message log can store up to five million messages. In addition, with the History Server function you can save the messages on an archive media for permanent off-line storage. The IMMSGLOG message log must be configured as described in the Alarm/Event Message Logging section in Industrial IT 800xA - Information Management Configuration.

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 core system software. For all other desktop tools, or if you need to access messages that extend beyond the storage limit of the 800xA system software message server, you must query the OPC message log. See Table 2 for details.

For further guidelines on reading alarm/event messages from the message log, see Section 9, Reading Message Logs.

3BUF001094R4101 63

Production Data Section 1 Product Overview

Production DataProduction data for Batch Management applications may be stored in production data logs (PDLs). PDL is an option for the History Server function.

The Batch Data dialog lets you retrieve production data for a selected batch. The data is organized in eleven pre-configured views which are described in Functions on page 220. 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.

• 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 your PDL application, see Table 2.

SQL AccessSQL 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. You can also submit SQL queries 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 your SQL query application, see Table 2.

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

64 3BUF001094R4101

Section 1 Product Overview Data Providers

Data ProvidersData 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. This section provides a quick overview of:

• Data Provider Architecture on page 65

• Guidelines for Referencing Data Providers on page 69

Data Provider ArchitectureDifferent 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. This architecture is illustrated in Figure 12.

The default data providers described in Table 3 support most data access applications. You can configure additional data providers as required by your application. For example, you may want to create an additional ADO data provider to support access to another third-party database. Also, you can activate and deactivate data providers so as not to exceed the limit you are licensed to use. If you require more data providers than you are currently licensed for, you can purchase additional licenses. For further information on configuring and managing data providers, see Industrial IT 800xA - Information Management Configuration.

3BUF001094R4101 65

Data Provider Architecture Section 1 Product Overview

Figure 12. Data Provider Data Access

2) The Industrial IT Process Values, History Values, and Alarm/Event dialogsin DataDirect do not use data providers.

Display and Client Services

Display ServicesDataDirectDesktop Trends

Data ProvidersAIPHDA

IMHDAServer

AIPHDAServer

Information Management Server

IMHDA

History Logs

DBA

OPC DA Proxy

SoftpointServer

CalculationServices

AIPOPC

Connectivity Server

Process Data Sources

ODBC

Oracle

Oracle-based Message LogsNumeric LogsPDLs

Trend Logs

NOTES:1) The Information Management andConnectivity Servers may reside on the same node.

66 3BUF001094R4101

Section 1 Product Overview Data Provider Architecture

How Data Providers Work

Client applications that use data providers connect via a specified service provider which resides on a data server, Figure 13.

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.

Table 3. Default Data Providers

ADSS Label(1)

(1) Used to uniquely identify data provider in the ADSS Configuration tool.

DefaultName(2)

(2) Used by data access applications to reference a specific data provider when there is more than one of the same type.

Description

AIPHDA AIPHDA Connects to the 800xA OPC HDA server. This server supports seamless access to trend logs and history logs. It also lets you access log attributes. Returns up to 65,534 values per request.

AIPOPC AIPOPC Provides access to real-time data from aspect object properties.

ADO DBA Provides access to Oracle data for Display Services, DataDirect, and Batch Management PDL Browser.

DCSOBJ DCS Provides access to real-time process data from Advant OCS objects (Enterprise Historian 3.2/1 or earlier), for example CCF_CONTIN_LOOP in systems with MOD 300 software, and PIDCON for systems with Master software.

DCSLOG LOG Provides access to historical process (numeric) data (Enterprise Historian 3.2/1 or earlier). Returns up to 3200 values per request.

OPC OPC Provides access to real-time data from third party DA 1.0 & 2.0 data access server.

ADO-DEMO DEMO Supports Oracle data access for the Display Services demonstration displays.

3BUF001094R4101 67

Data Provider Architecture Section 1 Product Overview

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 on remote servers. The service provider to which a data provider is connected is specified in the data provider configuration. This is described in Industrial IT 800xA - Information Management Configuration.

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. This is described in Guidelines for Referencing Data Providers on page 69.

Figure 13. Desktop Client/Data Server Architecture

DataDirectCLIENT

Desktop Trends

OPC HDA

Information Management #2

OPC DA

Information Management #1

Data Providers

Service

CLIENT

ADO (DBA)Oracle Data

Provider

Local Data Server Remote Data Server

OPC HDA OPC DA

68 3BUF001094R4101

Section 1 Product Overview Guidelines for Referencing Data Providers

Guidelines for Referencing Data ProvidersData providers are configured and managed via the ADSS Configuration tool as described in Industrial IT 800xA - Information Management Configuration.

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. This section describes when specific data providers must be referenced, and how to reference the data providers.

When is Referencing Necessary?

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. For instructions on how to access this window, see Accessing the Display Server Status Window on page 71.

If you don’t use more than one data provider of a given type, your 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 referenced, the data request will default to the data provider with channel 0. If you need to use a different data provider, it must be explicitly referenced.

Client applications use different methods for referencing data providers as described below.

DataDirect

In DataDirect use the Setup tab on the Options dialog to specify the default data providers for all dialogs and functions (see Data Provider Connections on page 274). You can also choose whether to use channel number or -name. The default setup is to use -name. This is recommended because channel number does not support process value update, history update, history retrieval of raw data, and history bulk data retrieval. When you use -name you must also select the default data provider for each data provider type.

If you use channel number, the same channel number applies to all data providers. The default channel is zero (0). You can select a different channel if necessary.

3BUF001094R4101 69

Guidelines for Referencing Data Providers Section 1 Product Overview

The DataDirect functions let you specify data providers by -name argument when you need to reference a data provider other than the default specified in the Options dialog.

Desktop Trends

In Desktop Trends, the Trend and Ticker tools let you specify the data provider for each trace on a Trend display (see Data Provider Connections on page 355) and tag on a Ticker (see Data Provider on page 412). Data providers are always referenced by -name.

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 Industrial IT 800xA - Information Management Configuration for Display Services.

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. You must ensure the ADO data provider supporting those applications is named DBA, and that no other active data providers use the -name DBA.

70 3BUF001094R4101

Section 1 Product Overview Guidelines for Referencing Data Providers

Accessing the Display Server Status Window

To open this window, from the Windows task bar, Figure 14, choose Start> Programs>ABB Industrial IT 800xA>Information Mgmt> Display Services>Server Status.

This displays a dialog for specifying the server hostname, Figure 15. Enter the hostname for the data server where the data providers are located. Leaving the hostname blank defaults to localhost. Click OK. As an option you can specify the maximum time to wait for the server to respond.

This displays the server status window, Figure 16.

Figure 14. Checking Server Status

Figure 15. Specifying Server Hostname

3BUF001094R4101 71

Guidelines for Referencing Data Providers Section 1 Product Overview

Figure 16. Display Server:COMM Window

Number of Client Licenses

Number & List of Connected Clients

Number of Data Providers

List of Connected Data Providers

72 3BUF001094R4101

Section 1 Product Overview Open Data Access

Open Data AccessOpen Data Access (ODA) supports client applications that use either an ODBC or OLE DB data source, for example: Crystal Reports and Microsoft Excel (Excel requires Microsoft Query).

Virtual database tables in ODA map 800xA system data types to OLE DB and ODBC data types. When the client application submits SQL queries toward these virtual tables, ODA parses the queries, and returns the requested data to the client.

There is one predefined table named numericlog to support access to historical process data.

For real-time data access, you can configure custom tables to expose selected those aspect object properties. These tables are then combined to form one or more virtual real-time databases. The custom-built real-time databases support read and write access. The custom views also let you impose restrictions on data access for certain users.

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 PC client. Remote clients require ODA client software. This component may be installed with the Display and Client Services bundle as described in Industrial IT 800xA - Information Management Installation.

The architecture for Open Data Access is illustrated in Figure 17, and described in ODA Architecture on page 75.

For information on configuring ODA refer to the section on Open Data Access in Industrial IT 800xA - Information Management Configuration. For guidelines on accessing data via ODA, see Appendix A, Using Open Data Access.

3BUF001094R4101 73

Open Data Access Section 1 Product Overview

Figure 17. Historical and Real-time Data Access Via ODA Server

Third PartyCrystal Reports

ADO-supported

IMHDAServer

AIPHDAServer

Information ODA Database

ODA Server

ABB ODAOLE DB Provider

ODA Data Source

Numericlog

ODBC

Table

Real-timeDB1

Applications

SoftpointServer

CalculationServices

OPC DA Proxy

OLE DB

Real-timeDB2

Real-timeDBn

generic_daTable

Programming Languages(VB, etc...)

ADO

Microsoft OfficeExcel, etc...

History Logs

Connectivity Server

Process Data Sources

Trend Logs

ManagementServer

74 3BUF001094R4101

Section 1 Product Overview Open Data Access

ODA Architecture

Client applications that use Open Data Access must connect to a specified ODA database. This is a virtual database which merges the predefined numericlog and generic_da tables with one user-configured real-time database. The real-time database is configured to have one or more custom table definitions which expose selected object properties. Thus, each ODA database supports access to both historical and real-time data.

For example, Figure 18 shows two sets of user configured table definitions (motor1, pump1, valve1; and motor2, pump2, valve2). These table definitions are combined to form two real-time database definitions: DatabaseX and DatabaseZ. These two database definitions are then used to create two different ODA databases: Database1 and Database2, each of which includes the two predefined tables (numericlog and generic_da), and one custom real-time database definition. The client application may connect to one ODA database at a time.

Figure 18. ODA Database Architecture

numericlogTable

motor1Table

pump1Table

valve1Table

motor2Table

pump2Table

valve2Table

DatabaseX

ODA Database1

numericlogTableDatabaseX

motor1Table

pump1Table

valve1Table generic_da

Table

generic_daTable

ODA Database2

numericlogTable

DatabaseZmotor2Table

pump2Table

valve2Tablegeneric_da

Table

Client Application

DatabaseZ

3BUF001094R4101 75

Open Data Access Section 1 Product Overview

The contents and operating parameters for the ODA database are specified in a configuration file that you set up using the ODBC Data Source Administrator. This is required whether you use an ODBC data source or an OLE DB data source.

This configuration file specifies:

• which user-configured real-time database to use for real-time data access. Only one database can be connected at one time.

• whether to use the 800xA OPC HDA server, or the IM OPC HDA server for accessing history data.

The AIP OPC HDA server is the default, and is recommended because it supports seamless access to trend logs and history logs. This server also supports the ability to access log attributes.

The IM OPC HDA server is provided primarily to support earlier data access applications configured to use this server. See Appendix C, Using the IM OPC HDA Server for further information.

• for remote client connections, this file also specifies the server’s IP address.

One 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 table definition aspects. This set up supports access via the predefined numericlog and generic_da tables. You can change the default set up use the IM OPC HDA server, and/or specify a different real-time database table.

Further, you can create additional ODA databases where each one specifies a different real-time database. This lets you connect your client application to a different ODA database, depending on you particular data access requirements.

For instructions on configuring ODA table and database definitions, refer to the section on Open Data Access in Industrial IT 800xA - Information Management Configuration. For instructions on connecting client applications to an ODA database, refer to Appendix A, Using Open Data Access.

76 3BUF001094R4101

Section 1 Product Overview Set-up for SQL*Plus

Set-up for SQL*PlusYou can use SQL*Plus to access Oracle-based data. The basic syntax is as follows:

sqlplus [<username>]/[<password>][@<tnsname>]

This is further described in Table 4.

ORACLE_SID

Setting this environment variable gives you access to a specified Oracle database on the local server (where you run SQL*Plus). For Information Management applications, you should set ORACLE_SID = ADVA. This is the Oracle database installed with Information Management.

tnsname

You may use the Net Configuration Assistant to configure additional net service names to support SQL*Plus access to remote Information Management servers.

Table 4. SQL*Plus Syntax

Syntax Description

sqlplus / This requires you to be logged in as a historyadmin user, and requires the ORACLE_SID environment variable to be set.

sqlplus /@<tnsname> This requires you to be logged in as a historyadmin user, and requires the tnsname to be configured.

sqlplus history/history This logs you in as the read-only history user, and requires the ORACLE_SID environment variable to be set.

sqlplus history/history@<tnsname This logs you in as the read-only history user, and requires the tnsname to be configured.

3BUF001094R4101 77

Set-up for SQL*Plus Section 1 Product Overview

78 3BUF001094R4101

Section 2 DataDirect - Excel Data Access

GeneralDataDirect (Excel Data Access) is a desktop tool for integrating information from various data sources into a Microsoft® Excel spreadsheet. It lets you work with industry-standard tools, using familiar techniques common to other Microsoft Office products.

DataDirect is implemented as an add-in for Microsoft Excel. It provides both interactive dialogs and functions that support different platforms and data retrieval applications. This section describes the dialogs. Functions are described in Section 3, DataDirect - Excel Data Access Functions.

Some dialogs and functions can only be used on nodes where the core 800xA system software is installed. There are equivalent dialogs and functions for use on remote PC clients that do not have the core 800xA software installed. This is clearly indicated at the beginning of the instruction for each dialog and function.

User Access to DataDirect Add-in ToolsThe DataDirect add-in is integrated into Microsoft Excel on a user-basis. The add-in is automatically available for the user that performed the 800xA software installation (including DataDirect). 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 88.

Populating Pick Lists for Data Retrieval/Entry DialogsFor data points that exist outside the 800xA system, you must configure text files 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 284.

3BUF001094R4101 79

Product Overview Section 2 DataDirect - Excel Data Access

Product OverviewDataDirect can run on Windows XP, Windows 2000, and Windows 2003 workstations. DataDirect integrates add-in tools into Microsoft Excel to facilitate access to information from aspect objects in the 800xA system aspect directory. Some tools also support access to earlier ABB control systems, as well as Oracle and OPC data sources. For example, Figure 19 shows the DataDirect add-in tool for accessing historical data from property logs. With the proper authority you can update process values, and add/modify entries in numeric (lab data) logs. This overview briefly describes:

• Data Access Methods on page 81

• Licensing on page 85

Figure 19. Example - Using DataDirect Add-in Tool for Historical Data Access

80 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Data Access Methods

Data Access MethodsDataDirect supports access to:

• process, historical, and softpoint data from aspect objects in the 800xA system.

• alarm and event messages stored in the 800xA system message buffer, or stored on archive media.

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

DataDirect provides both interactive dialogs and programmable functions for integrating data into an Excel spreadsheet. Some dialogs and functions also support 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 20 provide a graphical user interface for generating and executing data queries. These dialogs are generally intended for on-demand (one-time) data access functions, although some dialogs let you generate re-usable function calls.

DataDirect functions may be used to create re-executable reports with Microsoft Excel, Figure 21. 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 see Configuring Options on page 261.

3BUF001094R4101 81

Data Access Methods Section 2 DataDirect - Excel Data Access

The DataDirect functions can be embedded in VBA macros, as an alternative to inserting them directly in an Excel spreadsheet. By embedding the functions in the macros, they are not automatically executed when the spreadsheet is opened. This gives you the capability to archive reports. In addition, these reports can be distributed to Excel users that do not have DataDirect.

Figure 20. Example Dialog

82 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Data Access Methods

Figure 21. Example, DataDirect Function in an Excel Spreadsheet

3BUF001094R4101 83

User Interface - DataDirect Add-in Tools Section 2 DataDirect - Excel Data Access

User Interface - DataDirect Add-in ToolsThe DataDirect user interface is embedded in Excel. When you install DataDirect, the DataDirect add-in tools are added to the tool bar and menu bar, Figure 22.

Accessibility to Add-in Tools for Different Windows Users

Add-in tools are embedded in Excel on a user basis. The DataDirect add-in tools are available for the user that installed the DataDirect software by default. If you log onto the PC as a different user, you will be required to manually add the add-in tools for that user. The add-ins must be installed for the 800xAService user in order for the Application Scheduler to schedule Excel reports. See Manually Adding the DataDirect Add-in on page 88.

Showing/Hiding DataDirect Add-in Tools

You can specify whether to show or hide each DataDirect add-in tool on the Excel menu and tool bars on an individual basis. This is done via the View tab on the Options dialog. For details refer to View on page 267.

Figure 22. DataDirect Add-in Toolbar and Menu

DataDirect ToolbarDataDirect Menu

84 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Licensing

LicensingDataDirect is licensed on a concurrent-user basis. You can install DataDirect on as many PCs as you wish. The server will control the number of clients that may connect to the server based on the number of client licenses you have purchased. For example, you may install DataDirect on ten PCs, but if you purchase two licenses, only two client PCs 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 PC. Thus one PC may occupy two or more client licenses concurrently. See Industrial IT 800xA - System Installation for instructions on installing and managing licenses.

3BUF001094R4101 85

Application Set-up Section 2 DataDirect - Excel Data Access

Application Set-upThis section describes the following set-up procedures:

• Enabling macros. The first time you open an Excel Worksheet with the DataDirect add-in tools, you may see a message asking whether or not to enable macros. If you get this prompt, click the Enable macros button. Macros MUST be enabled in order to use the DataDirect add-in tools. This does not enable the macros permanently. This is required if you intend to schedule DataDirect reports with VBA macros. To enable macros permanently, see Enabling Macros on page 86.

• Manually Adding the DataDirect Add-in on page 88. Add-in tools are embedded in Excel on a user basis. The DataDirect add-in tools are available for the user that installed the DataDirect software by default. If you log onto the PC where you run DataDirect as a different user, you must also add the add-in tools for that user.

• Updating Function References in Worksheets on page 90. This procedure is required for worksheets with functions from an earlier DataDirect version, and for worksheets that you exchange between two DataDirect installations where the home directories are different.

• Changing the Language Selection for Microsoft Office on page 93.

• Change the File Open Set-Up for Microsoft Excel Worksheets on page 93.

Enabling MacrosMacros MUST be enabled (macro security level = Low) in order to use the DataDirect add-in tools. The first time you open an Excel Worksheet with the DataDirect add-in tools, you may see a message asking whether or not to enable macros. If you get this prompt, click the Enable macros button. This sets the macro security level to Low for the current session. The security setting will revert back to

If you upgrade your Microsoft Excel software AFTER installing DataDirect, you may experience problems when you try to start DataDirect. This is because the Excel files may be installed in a different location. Refer to Fixing DataDirect After Upgrading Microsoft Excel on page 93.

86 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Enabling Macros

medium the next time Excel is opened. Scheduled DataDirect reports with VBA macros will not run unless the macro security is permanently set low. To do this:

1. From the Excel menu bar, choose Tools>Macro>Security, Figure 23.

2. Select the Low security level in the Security dialog, Figure 24, then click OK.

Figure 23. Accessing Macro Security Settings

Figure 24. Macro Security Dialog

3BUF001094R4101 87

Manually Adding the DataDirect Add-in Section 2 DataDirect - Excel Data Access

Manually Adding the DataDirect Add-inAdd-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. If you log onto the PC where DataDirect runs as a different user, follow these steps to manually add the add-in tools.

1. Launch Microsoft Excel.

2. From the Excel menu bar choose Tools>Add-Ins, Figure 25.

This displays the Add-ins dialog, Figure 26.

Figure 25. Launching the Add-ins Tool

Figure 26. Add-ins Dialog

88 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Manually Adding the DataDirect Add-in

3. Click the Browse button, and use the Windows file chooser dialog to find and select the DataDirect.xla file, Figure 27. This file is located in “%ABB_ROOT%InformIT\DataDirect\Bin”1.

This makes the DataDirect Add-in available in the Add-ins dialog, Figure 28. Any add-ins listed in this dialog may be added or removed from Excel by checking or unchecking the corresponding check box.

1. The default path for %ABB_ROOT% is C:\Program Files\ABB Industrial IT\

Figure 27. Selecting the ABBDataDirect.xla File

Figure 28. DataDirect Add-in Available in Add-ins Dialog

3BUF001094R4101 89

Updating Function References in Worksheets Section 2 DataDirect - Excel Data Access

4. Make sure the DataDirect check box is checked, then click OK.

Updating Function References in Worksheets

In either of the above cases the home directories are different, so the ABBSql, ABBGetObj, ABBArray, and ABBGetHistory functions will not operate with the new add-in. Therefore you are required to update all references in the worksheet.

To do this:

1. Open a workbook in Excel. If the workbook contains DataDirect functions that reference a relocated add-in, the following message is displayed, Figure 29.

2. Answer No to this prompt, and then run the utility as described in step 3.

This procedure is required under the following circumstances:• for worksheets with functions from an earlier DataDirect version• for worksheets that you exchange between two DataDirect installations

where the home directories are different.

Figure 29. Prompt for Updating References

If you want 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 (see Setup on page 273 for details). This records changes to the debug.txt file in the \DataDirect\tmp directory.

90 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Updating Function References in Worksheets

3. Enable the Update Functions menu item via the View tab in the Options dialog, Figure 30.

4. Choose DataDirect>InformIT>Update Function References, Figure 31.

Figure 30. Enable Update Functions

Figure 31. Running the Worksheet Function Upgrade Utility

3BUF001094R4101 91

Updating Function References in Worksheets Section 2 DataDirect - Excel Data Access

5. When you see the confirmation message, Figure 32, click Continue. This updates all worksheets in the selected workbook.

6. When you see the update function references completed message, click OK to acknowledge, Figure 33.

7. After updating the function references, you must execute each function once, before you can use the F9 key to calculate the entire workbook.

• For each function that returns multiple values (for example, ABBGetHistory):

a. Select the cell where the function is defined.

b. Starting with that cell, select a range of cells where the data will be entered.

c. Put the cursor in the formula bar, and then Press CTRL+SHIFT+ENTER.

Figure 32. Prompt to Continue Update Function References

Figure 33. Update Function Completed Message

Any time you disable and then re-enable functions, all functions in the spreadsheet must be executed individually before you can use the F9 key to calculate the entire workbook.

92 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Fixing DataDirect After Upgrading Microsoft Excel

• For each function that returns one value (for example, ABBGetObj):

a. Select the cell where the function is defined.

b. Put the cursor in the formula bar.

c. Press ENTER.

Fixing DataDirect After Upgrading Microsoft ExcelIf you upgrade your Microsoft Excel software AFTER installing DataDirect, you will experience problems when you try to start DataDirect. This is because the Excel files are installed in a different location. Specifically, when you try to launch DataDirect from the Windows Start menu, you’ll get an error message indicating that the applicable folder was moved or removed. 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 the Windows task bar (choose Start>Programs> ABB Industrial IT 800xA>Operations>DataDirect).

When you see the message that the folder was moved or removed, 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 88.

Once you have completed these two steps, DataDirect will start-up normally.

Changing the Language Selection for Microsoft OfficeIf you change the language selection for Microsoft Office after DataDirect has been installed, you must uninstall and then reinstall DataDirect.

Change the File Open Set-Up for Microsoft Excel WorksheetsDataDirect reports which include the ABB function and the interaction between Plant Explorer and Excel will not behave correctly unless Excel is set up to not browse in the same window. Change the Excel set-up as follows:

1. In Windows Explorer, choose Tools>Folder Options.

3BUF001094R4101 93

Starting DataDirect Section 2 DataDirect - Excel Data Access

2. Select the File Types tab.

3. Select the XLS Microsoft Excel Worksheet file type.

4. Click Advanced.

5. Uncheck the browse in same window check box.

6. Click OK in the Advanced dialog.

7. Click OK in the Folder Options dialog.

Starting DataDirectDataDirect is started from the Start menu on the Windows task bar. To do this, from the Windows task bar choose: Start>Programs> ABB Industrial IT 800xA>Operations >DataDirect, Figure 34.

Enabling Macros

The first time you open an Excel Worksheet with the DataDirect add-in tools, you may see a message asking whether or not to enable macros. If you get this prompt,

Figure 34. Starting DataDirect

94 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Starting DataDirect

click the Enable macros button. Macros MUST be enabled in order to use the DataDirect add-in tools.

What You Should Know Before You Get StartedThe following sections provide some quick tips for using DataDirect:

• Logging In on page 95

• Customizing Your Application on page 95

• Getting Help on page 95

• About DataDirect on page 96

• Finding the Right Tool on page 97

Logging In

You must log in to a data server before you can use DataDirect. There are two log-in modes. Perpetual log-in means you stay logged in until you specifically log off. For ad-hoc log-in, you are automatically logged off when you close the current dialog. Refer to Login on page 98 for details.

Customizing Your Application

The DataDirect user interface has default settings so you can begin using DataDirect without having to do any preliminary set up. If you want to make any adjustments, refer to Configuring Options on page 261.

Getting Help

To access general on-line help files, choose DataDirect > Help, or click the Help (?) button in the DataDirect tool bar, Figure 35.

Figure 35. Help Button

3BUF001094R4101 95

Starting DataDirect Section 2 DataDirect - Excel Data Access

You can also get context-sensitive help for a specific dialog by clicking the dialog’s Help button. This button displays the on-line help topic for the current dialog, Figure 36.

About DataDirect

The DataDirect>About menu item displays the About message box. Clicking More displays the About message for AdvaInform Active Data Provider, Figure 37.

Figure 36. Example, Displaying On-Line Help

Figure 37. Data Direct About Message Box

96 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Starting DataDirect

Finding the Right Tool

The DataDirect dialogs let you generate ad-hoc data queries and data objects and display the results in an Excel spreadsheet. With the proper authority the process and history values dialogs also let you insert and/or update values. These dialogs have equivalent functions that let you create reusable Excel reports.

Most dialogs provide the option of inserting a reusable formula in the spreadsheet. This lets you perform the ad-hoc query, and insert the formula in the spreadsheet so that it may be reused for reporting.

Use Table 5 to determine which DataDirect tool best fits your data retrieval requirements.

Table 5. Which Tool to Use

Application Add-in Tool

Reading and Writing Process Values To use a dialog, see Reading and Writing Process Values on page 109.For equivalent functions, see Functions for Reading/Writing Process Values on page 299.

Reading and Writing History values To use a dialog, see Reading/Writing History Data on page 149.For equivalent functions, see Functions for Reading/Writing Process Values on page 299.

Read Alarm/Event Messages To use a dialog, see Retrieving Alarm/Event and Message Data on page 197.For equivalent functions, see Functions for Reading Messages on page 328.

Read Production data from PDL tasks for 800xA Batch Management, Batch 300, or TCL

PDL dialog - See Retrieving Production Data on page 216.

SQL queries SQL dialog - See Retrieving Data by SQL Query on page 250.ORABBSql on page 330.

3BUF001094R4101 97

Login Section 2 DataDirect - Excel Data Access

LoginYou must log on to a data server to obtain a runtime license. For all dialogs except the Industrial IT Process Values, History Values, Alarm/Event dialogs, the login procedure also connects your Excel spreadsheet to a specified host data server. For the Industrial IT Process and History Values dialogs, once you are logged in you have full access to all aspects and objects represented in the aspect system to which you are connected.

One runtime license is taken up for each user that logs in to the data server. DataDirect provides two methods for logging in, depending on how you plan to use your licenses.

You can:

• log in on an ad-hoc basis. In this case you disconnect automatically when you close the current dialog. This minimizes the time that a runtime license is occupied.

• log in on a perpetual basis. In this case you stay logged in regardless of how many dialogs you open and close until you choose to disconnect.

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. If you log onto the PC as a different user, you will be required to add the add-in tools for that user. See Manually Adding the DataDirect Add-in on page 88.

98 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Login

Perpetual Login

Perpetual login means you remain logged in until you actively choose to disconnect from the host server. This lets you 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 for as long as you remain logged in. You must log in on a perpetual basis when working with DataDirect functions.

To log in perpetually, click the ABB button, Figure 38, or choose DataDirect > Login from the menu bar. Then log in as described under Using the Login Dialog on page 100.

To disconnect from the data server, press the Disconnect button in the Login dialog, or exit Excel.

Login As Needed for Ad-hoc Data Requests

If you do not log in prior to using a data retrieval/entry dialog, the login dialog is displayed each time you attempt to use one of the dialogs. You must still log in as described under Using the Login Dialog on page 100, but you are automatically disconnected when the current data retrieval/entry dialog is closed. This login method minimizes the time that the runtime license is occupied.

You cannot use the ad-hoc log-in method for executing DataDirect function calls. If you are not logged in when you attempt to run a function, the login dialog is displayed, and you will be perpetually logged in upon completing the login procedure.

Figure 38. Login Button

3BUF001094R4101 99

Login Section 2 DataDirect - Excel Data Access

Using the Login Dialog

The login dialog, Figure 39, is displayed when you click the ABB button, or choose DataDirect > Login from the menu bar. This results in a Perpetual Login. The dialog is also displayed when you attempt to open a data retrieval/entry dialog when you are not yet logged in. This lets you Login As Needed for Ad-hoc Data Requests.

Also, all data retrieval/entry dialogs have a plug icon located in the bottom right corner. This icon lets you 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. If you check the Save Settings option, these login parameters will automatically be entered for you the next time you log in. Click Connect when you are finished.

User

Enter the user name for the host data server. There are three default users: aid, mdi, and sdi. User names are case-sensitive. For further details on users and user passwords, refer to Industrial IT 800xA - Information Management Configuration.

Figure 39. Login Dialog

Before Connection

After Connection

100 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Login

Password

Enter the password for the specified User. The default passwords are the same as their respective user names.

Host

The Host specification is used in two different ways, depending on whether you are using the Industrial IT version of the Process and History Values dialogs (and equivalent functions), or any other dialog (or their equivalent functions).

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 license, the Host specification also connects the spreadsheet to the specified data server so that you may access data 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. You can look up the computer name for your PC where the Network Identification information is listed for your PC. On the Windows 2000 platform, this is on the Network Identification tab of the System Properties dialog in the Control Panel. On the Windows NT platform, this is on the Network dialog in the Control Panel.

You can use the host server IP address rather than the computer name if you prefer.

Save Settings

When this option is selected, your user name, password, and host specification are saved, so you do not have to re-enter them the next time you log in. The data server name and user ID are indicated in the status bar. Also, when Save Settings is selected, you remain logged in until you disconnect from the data server by pressing the Disconnect button in the Login dialog, or exit Excel.

3BUF001094R4101 101

Using DataDirect Dialogs Section 2 DataDirect - Excel Data Access

Using DataDirect DialogsBasic operating procedures for all DataDirect dialogs are similar. This section describes these basic procedures to help you begin 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 you open the dialog, select the starting cell to insert data.

2. Open the dialog. After you open the dialog, you may change the starting cell.

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. If you want to apply data formatting options.

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, see:

Selecting the Starting Cell on page 103 Opening the Dialog on page 103 Changing the Start Cell on page 103 Specifying One-time Data Access or Reusable Formulas on page 104 Date and Time on page 105 Formatting on page 107 Monitoring/Changing the Server Connection on page 108 Apply, OK, & Cancel Buttons on page 108

Specific instructions for each dialog are provided in:

Reading and Writing Process Values on page 109 Reading/Writing History Data on page 149 Retrieving Alarm/Event and Message Data on page 197 Retrieving Production Data on page 216 Retrieving Data by SQL Query on page 250 Retrieving Values for TCL Unit Arrays on page 254

102 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Selecting the Starting Cell

Selecting the Starting CellFor any query you must specify the starting cell where you want to insert the query result. To do this, click the applicable cell in the Excel Spreadsheet, Figure 40. You can change the Start Cell specification from the dialog if necessary.

Opening the DialogUse either the DataDirect menu, or equivalent tool bar to open any dialog. Figure 53 demonstrates how to open the Industrial IT Process Values dialog.

If you are not already logged in, you will be prompted to log in now. See Login on page 98 for details. When you are logged in, the chosen dialog is displayed.

Changing the Start CellThe 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 you open the dialog. You can change the Start Cell value by entering a new value directly in this field. The syntax is ColumnLetterRowNumber. For example G5 is the fifth row in the seventh column.

Figure 40. Selecting the Starting Cell

Figure 41. Opening the Dialog

If the options you require are not available in the menu and tool bars, use the View tab on the Options dialog to make these options available. See View on page 267.

Selected Cell - B2

Menu Corresponding Tool Bar Button

3BUF001094R4101 103

Inserting or Overwriting Rows Section 2 DataDirect - Excel Data Access

Inserting or Overwriting RowsThe Insert check box lets you 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 you do not select this check box, any cells already containing data may be overwritten by new data.

Specifying One-time Data Access or Reusable FormulasThe Output radio buttons on the top right part of the dialog let you 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 261).

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). See Disable Functions on page 278.

When using Formula output, selecting any cell that has output in the spreadsheet will display the formula in the formula bar, Figure 43.

If you use the Formula output option, refer to Storing, Updating and Scheduling Reports on page 298 for further guidelines for creating a report with DataDirect.

Figure 42. Output Options

Figure 43. Showing the Formula

104 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Date and Time

Date and TimeDialogs that retrieve historical data require you to specify 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 44.

Then refer to the sections referenced below for details on how to use the selected method:

• Date and Time on page 105

• Cell Reference on page 106

• Dynamic Time on page 106

Date and Time

This option lets you modify any part of the date and time by clicking directly on the unit to be changed and entering the new value. For time, you can also use the up/down arrows to change the selected unit. For date, you can click the down arrow to display the Microsoft DT Picker dialog, Figure 45.

Figure 44. Selecting the Method for Specifying Start and End Times

Figure 45. Example, Microsoft DT Picker Dialog

Up down arrows for adjusting time units

3BUF001094R4101 105

Date and Time Section 2 DataDirect - Excel Data Access

Cell Reference

This option lets you reference a cell in the spreadsheet where the start or end time is specified, Figure 46.

Dynamic Time

This option lets you 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 47, the start time is specified as now minus one day, and the end time is specified as now.

You can use dynamic time in combination with date and time. For example, in Figure 48, the start time is specified as end time minus four days, and the end time is specified as 9/18/2004 11:30:00.

If you enter an end time that precedes or equals the start time, an error message will be displayed when you try to execute the query. 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.

Figure 46. Specifying Start and End Times by Cell Reference

Lets you return focus to the spreadsheet to click rather than enter the cell by typing

106 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Formatting

Formatting

The presentation format is set via the Data Format tab in the Options dialog. If you choose Horizontal List, attributes are listed horizontally and objects are listed vertically, Figure 49. If you choose Vertical List, attributes are listed vertically 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 261 for details.

Figure 47. Dynamic Time Example

Figure 48. Dynamic Time in Combination with Date and Time

Figure 49. Process Value Query Result - Example Horizontal List Format

3BUF001094R4101 107

Monitoring/Changing the Server Connection Section 2 DataDirect - Excel Data Access

Monitoring/Changing the Server ConnectionThe plug icon near the bottom of the dialog indicates whether or not you are currently connected to a data server, Figure 50. If not, you can use this icon to establish a connection, or connect to a different server. To do this double-click the Plug icon. This displays the Login dialog. See Login on page 98 for further details.

Apply, OK, & Cancel ButtonsUse OK or Apply to execute the query. Use Apply when you want the dialog to remain open after you execute a query, so you can continue to work with the dialog. Use OK when you want to close the dialog after you apply your entries. The OK button always executes the query that is currently specified in the dialog, so if you have executed several queries using the Apply button, and then you use the OK button to close the dialog, the last query entered will be executed again. If you do not want to re-execute the query, use the Cancel button to close the dialog.

Figure 50. Plug Icon

Disconnected

Connected

108 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Reading and Writing Process Values

Reading and Writing Process ValuesDataDirect provides two dialogs for reading and writing real-time process values. The Industrial IT version lets you query aspect objects in the 800xA system. With the proper authority you can also update process values. This dialog is only available on 800xA system nodes that have core 800xA software installed (Aspect Servers, Connectivity Servers, Application Servers, and Workplace Clients). This dialog is not available on remote PC clients running Information Management Desktop tools without 800xA software.

If you are running DataDirect on a PC that does not have 800xA core system software (a remote Desktop Tools client), you must 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 you need to connect the dialog to a server that is outside the 800xA system, for example an earlier Enterprise Historian server. This lets you query objects on that server that are not a part of the 800xA system. This functionality is not supported by the Industrial IT version.

For querying 800xA system objects, if the Industrial IT version is available, it is generally recommended that you use it rather than the Inform IT version. The Industrial IT 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 Industrial IT and Inform IT versions are distinguishable by color - the Industrial IT icon is red, while the Inform IT icon is blue, Figure 51. If an icon is not available on the tool bar, use the View tab on the Options dialog to make it available. See View on page 267.

Refer to the applicable section below for instructions on using the appropriate dialog:

• Using the Industrial IT Process Values Dialog on page 110

• Using the Inform IT Process Values Dialog on page 122

Figure 51. Industrial IT and Inform IT Process Value Icons

Industrial IT Version Inform IT Version

3BUF001094R4101 109

Using the Industrial IT Process Values Dialog Section 2 DataDirect - Excel Data Access

Using the Industrial IT Process Values DialogThe Industrial IT Process Values dialog, Figure 52, lets you query aspect objects in the 800xA system for real-time process data (including softpoints).

With the proper authority you can also update process values. The Update Process Values tab is not enabled unless the Allow Process Updates option is selected via the Setup tab on the Options dialog (see Setup on page 273). Also, user authority must be configured in the aspect system to allow you to update certain object properties. This is described in Industrial IT 800xA System Security.

• This dialog requires 800xA core system software to be installed on the PC where you are running DataDirect.

• This dialog does not support querying objects on servers outside the 800xA system. For this you need to use the Inform IT version of this dialog. See Using the Inform IT Process Values Dialog on page 122.

Figure 52. Process Values Dialog

110 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Reading Process Values

Follow these steps to display the process values dialog for data retrieval or updates:

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 Industrial IT Process Values dialog.

Either click the Process Value button in the tool bar, or choose DataDirect > Industrial IT Process Values from the menu bar, Figure 53.

3. For data retrieval, see Reading Process Values on page 111. For data updates, see Writing Process Values on page 117.

Reading Process ValuesThe Process Values tab lets you 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 radio 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 you want to retrieve.

3. Click Apply or OK to retrieve the data.

For further details on these steps and other optional procedures see:

• Specifying One-time Data Access or Reusable Formulas on page 104

• Selecting Objects to Query on page 112

• Changing the Start Cell on page 103

Figure 53. Opening the Dialog

MenuCorresponding (Red)Tool Bar Button

3BUF001094R4101 111

Reading Process Values Section 2 DataDirect - Excel Data Access

• Inserting or Overwriting Rows on page 104

• Formatting on page 107

• Some information columns in the properties list (right pane) are hidden by default. You can expand these columns to show the information as described in Expanding the Items Columns in the Returned Properties List (Right Pane) on page 116.

Selecting Objects to Query

The object browser (left pane) in the Process Values dialog is similar to the Plant Explorer. It lets you browse the aspect directory for the objects whose property data you want to retrieve and display 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 properties list, then click OK. You can also copy the selected properties to the clipboard to use (paste) in another application.

You can 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 113).

You may also apply a filter to include or exclude certain objects, aspects, and properties (Applying a Filter to the List of Returned Object Properties on page 114).

112 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Reading Process Values

You may abort the retrieval process 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 54. 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.

Specifying Whether or Not to Include Child Objects

This check box, Figure 55, lets you 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.

Figure 54. Abort Button

Figure 55. Specifying Whether or Not to Include Child Objects

Abort button showing 15 of 251 objects searched

3BUF001094R4101 113

Reading Process Values Section 2 DataDirect - Excel Data Access

Applying a Filter to the List of Returned Object Properties

You can limit the list of returned object properties in the right pane to a specific set based on any combination of up to five filtering criterion. There are two type filters: object and data type; and three pattern filters: object, aspect, and property name.

The default condition is to retrieve all object properties with no filtering. To apply a filter, click the Edit Filter button to display the Process Values Filter dialog, Figure 56. Then specify any combination of type and pattern filters according to these guidelines.

The type filters let you select one or more object or data types from the respective lists. You may use one, both, or neither of the type filters. Making no selection is equivalent to selecting all types.

The pattern filters let you specify one or more patterns for each criteria. If you specify multiple patterns, separate them with the pipe (|) delimiter character. You may use the following wildcard characters:

* - any character string ? - any single alphabetic character # - any single numeric character

You can 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.

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

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 you’ve made in this dialog and revert back to the last saved filter. The Reset button returns all settings to their default state.

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.

114 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Reading Process Values

The filter is applied any time you make a new selection in the browser (left pane). To apply the filter to the currently selected object in the left pane, click Apply Filter.

Figure 56. Process Values Filter

3BUF001094R4101 115

Reading Process Values Section 2 DataDirect - Excel Data Access

Expanding the Items Columns in the Returned Properties List (Right Pane)

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. You can expand these hidden columns to show the contents by clicking and dragging the column header as shown in Figure 57. The fully expanded columns are shown in Figure 58. The columns remain expanded for the current object selection. When a new object is selected, the columns will be hidden again.

Figure 57. Default View of Items Columns

Figure 58. Fully Expanded Columns

Click and drag here to expand these columns

116 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Writing Process Values

Writing Process ValuesThe Update Process Values tab on the Process Values dialog is shown in Figure 59. This tab lets you update property values for aspect objects (including softpoints).

User Authority

The Update Process Values tab is not enabled unless the Allow Process Updates option is selected via the Setup tab on the Options dialog (see Setup on page 273). Also, user authority must be configured in the aspect system to allow you to update certain object properties. This is described in Industrial IT 800xA System Security.

Figure 59. Update Process Value Tab

3BUF001094R4101 117

Writing Process Values Section 2 DataDirect - Excel Data Access

The method of operation for this tab is similar to reading process values as described in Reading and Writing Process Values on page 109. You can use either of two methods:

• The basic method is to use the object browser (left pane) in combination with an edit filter. See Using the Object Browser below.

• As an alternative you can make a list of object properties and values in the spreadsheet, and then import this data from the spreadsheet. See Use Spreadsheet for Input on page 120.

Using the Object Browser

This is similar to retrieving items for data retrieval (reference Figure 60):

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 112. This list is displayed in the right pane.

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

You can remove selected items from the list if necessary. To do this, select the item in the list, and then click Remove From List. You may also 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 you apply the changes.

4. Click Apply when you are finished. The Updated column in the Update list (lower pane) will indicate whether or not the update was successful, Figure 61.

DO NOT check the Use Spreadsheet for Input check box. This disables the object browser.

118 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Writing Process Values

Figure 60. Selecting Items to Update

Figure 61. Update Success Indication

2a) Items selectedfor update

2b) Click Add to

3) Edit value

1) Use objectbrowser &edit filterto retrieve objectproperties

4) Click Apply.

List

3BUF001094R4101 119

Writing Process Values Section 2 DataDirect - Excel Data Access

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

2. Enter the range of cells that contain the object names in the Objects Range field. You can enter the range directly, or click the button to collapse the dialog, Figure 63, 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 64.

Figure 62. Use Spreadsheet for Input

Figure 63. Collapsing the Process Values Dialog

Figure 64. Selecting a Range of Cells

ClickHere

Click here to collapse the dialog

Click Here

Objects

to Restore

RangeSelected

120 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Writing Process Values

3. As an option, you may repeat step 2 to import values from the spreadsheet (using the Values Range field). If you do, the number of rows selected for the values must match the number of rows selected for the object names.

4. When you are finished with the object and value ranges, Figure 65, click Add to List.

This creates the update list, Figure 66.

You can remove selected items from the list if necessary. To do this, select the item in the list, and then click Remove From List. You may also clear the entire list by clicking Clear List.

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

All cells must contain data, and the range CANNOT contain spaces. This will generate an error message, in which case you must reselect the cell range.

Figure 65. Selected Range

Figure 66. Preview Selected Updates for Formatted Range

3BUF001094R4101 121

Using the Inform IT Process Values Dialog Section 2 DataDirect - Excel Data Access

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 you apply the changes.

8. Click Apply when you are finished. The Updated column in the Update list (lower pane) will indicate whether or not the update was successful, Figure 67.

Using the Inform IT Process Values DialogThe Inform IT Process Values dialog, Figure 52, is required when you are running DataDirect on a PC client that does not have 800xA core software installed, or when you need to query objects outside the 800xA system.

With the proper authority you can also update process values. The Update Process Values tab is not shown unless the Allow Process Updates option is selected via the Setup tab on the Options dialog (see Setup on page 273), and you log in to DataDirect as a user with authority to update process values. See User Authority on page 117. Also, the tab may be visible, but not active unless you deactivate the Use Channel Numbers option via the Setup tab on the Options dialog (see Setup on page 273).

Figure 67. Update OK Indication

122 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Inform IT Process Values Dialog

When you use this dialog, you can not use the F9 function 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 Configuring Options on page 261.

Figure 68. Process Values Dialog

3BUF001094R4101 123

Reading Process Values Section 2 DataDirect - Excel Data Access

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

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. See View on page 267.

3. To query process tags for data retrieval, see Reading Process Values on page 124. To update the process values for tags, see Writing Process Values on page 132.

Reading Process ValuesFollow these steps to retrieve process values. Further details for each step, and other optional procedures are provided in the sections referenced below. Basic steps:

1. Use the Output radio 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 you want to retrieve.

3. Click Apply or OK to retrieve the data.

For further details regarding these basic steps and other optional procedures see:

• Specifying One-time Data Access or Reusable Formulas on page 104

• Selecting Objects to Query on page 125

• Changing the Start Cell on page 103

Figure 69. Opening the Dialog

Menu Blue Tool Bar Button

124 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Selecting Objects to Query

• Inserting or Overwriting Rows on page 104

• Formatting on page 107

Selecting Objects to QueryThe method for selecting which objects to query differs depending on the selected object type.

When you select the OPC object type, an OPC browser dialog is provided. See Selecting OPC Tags on page 125.

For all other object types, use the applicable pick lists as described in Selecting ABB OCS Tags on page 127. This requires the corresponding text files to be configured as described in Configuring Pick Lists for Advant OCS Objects on page 284.

Selecting OPC TagsWhen the selected object type is OPC, the Process Values dialog provides a dialog for browsing OPC objects on the connected OPC server.

Select OPC in the Object Type pull-down list. This changes the Select Objects area of the display into an OPC Browser, Figure 70. Use the browser to find and select the OPC tag.

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:

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

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 you need to change this connection, click the Options button and see Data Provider Connections on page 274.

3BUF001094R4101 125

Selecting OPC Tags Section 2 DataDirect - Excel Data Access

• Apply a filter to either show or exclude all objects whose name has a specified text string.

Select one or more objects from the right pane. Click OK when you are finished. This executes the query and puts the requested data in the spreadsheet. You can also copy the selected object list to the clipboard to use (paste) in another application.

For further guidelines on using this tool, see Using the OPC Browser on page 256.

Figure 70. Browsing for OPC Process Objects

126 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Selecting ABB OCS Tags

Selecting ABB OCS Tags To access real-time data for ABB OCS (Enterprise Historian platform-based) process tags you must specify the object and attribute names using the corresponding pick lists. You may also be required to select the object type. These pick lists are populated by text files specified via the Options dialog File Setup tab (see File Setup on page 279).

The contents of the Select Object pick list is determined by the Select Object File specification, and the Object Type specification (if necessary), Figure 71.

You can change the contents of the Select Object pick list by changing the file specified in the Select Object File field. This text file provides the object names for the Select Object pick list.

This text file may be configured with or without object type specifications for the object names (see Configuring Pick Lists for Advant OCS Objects on page 284). 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, then you will be required to select the Object Type to make objects of that type available in the Select Object pick list.

Figure 71. Selecting ABB OCS Objects

Object File and Object Type Determine Contents of the Select Objects List

3BUF001094R4101 127

Selecting ABB OCS Tags Section 2 DataDirect - Excel Data Access

The instructions in the following sections are only applicable for selecting ABB OCS tags. Ignore these sections when selecting OPC tags:

Changing the Object Text File Selecting the Object Type Selecting Object Attributes Adding New Items to the Object and Attribute Pick Lists

Changing the Object Text File

When selecting ABB OCS tags, if you need to change the Object text file, click the Browse button to display a standard Windows file chooser dialog, Figure 72.

Several object files are provided with DataDirect as standard. You can create additional object files to customize object selection for your application. For details, see Configuring Pick Lists for Advant OCS Objects on page 284.

Figure 72. Browsing for Text Files

128 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Selecting ABB OCS Tags

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

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 example, CCF_PID_LOOP for systems with MOD 300 software, or PIDCON for systems with Master software.

Whether or not you need to specify object type, depends on how the object text file is configured. If object types are associated with objects, then you must use the Object Type pick list, Figure 73, 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.

This populates the Object and Attribute pick lists with the object and attribute names corresponding to the selected object type. For example, Figure 74 shows the Select Objects and Select Attributes pick lists populated according to the CCF_PID_LOOP object type.

Figure 73. Selecting the Object Type

3BUF001094R4101 129

Selecting ABB OCS Tags Section 2 DataDirect - Excel Data Access

Selecting Object Attributes

ABB OCS objects require you to specify which attribute(s) to query. You can 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 you want to select, hold down the SHIFT key, and then click on the last item you want to select.

• To select multiple items that are not contiguous, hold down the CTRL key and click on the items you want to select.

You can use the up and down arrows next to the pick lists to adjust the object and attribute presentation order, Figure 74.

Figure 74. Selecting Objects and Attributes

Use these Buttons to Adjust Presentation Order for Object Names and Attributes

130 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Selecting ABB OCS Tags

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.

1. You can use the New Process Object and New Object Attribute fields to add new items to their respective pick lists, Figure 75. You can also 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 automatically 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 75. Adding a New Item

3BUF001094R4101 131

Writing Process Values Section 2 DataDirect - Excel Data Access

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. You must be logged on to the PC as an Administrator-level user to change these settings. See Enable/Disable Write Access to History and Process Values on page 277.

• At the data server level, the applicable data provider must be configured to allow write transactions. This is the default set-up. If you want to verify this set-up, refer the section on configuring data access for display and client services in Industrial IT 800xA - Information Management Configuration.

• On the user level, the user with which you log onto the data server (DataDirect Log-in dialog) must be authorized to write to process objects. This is configured in the user preference file. By default, users are NOT granted this authority. To adjust this preference for a user, refer to the section on managing Information Management users in Industrial IT 800xA - Information Management 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). See Setup on page 273.

132 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Writing Process Values

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

2. Click the Update Process Values tab. This displays the controls for updating process values for one or more process tags, Figure 59.

Basically, this procedure requires you to build 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 you output the results of the update operation to your spreadsheet. This gives you a permanent record of the update operation.

Figure 76. Update Process Value Tab

3BUF001094R4101 133

Writing Process Values Section 2 DataDirect - Excel Data Access

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 you to have a properly formatted range of tag update specifications within your Excel spreadsheet.

– Importing Non-formatted Ranges of Cells from a Spreadsheet

Updating OPC Tags

Use the OPC browser to select one OPC tag at a time. To do this:

1. Select OPC in the Object Type pull-down list, Figure 77.

For ABB OCS tags, it is recommended that you 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.

Figure 77. Selecting the OPC Object Type

134 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Writing Process Values

This displays a Browse button and two corresponding fields as shown in Figure 78.

2. Click Browse to launch the OPC Browser, then use the browser to find and select the OPC tag, Figure 79.

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:

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

b. Select an object from the right pane. Click OK when you are finished. The full path to the selected tag is displayed in the Selected Tag field.

For further guidelines on using this tool, see Using the OPC Browser on page 256.

Figure 78. OPC Tag Update Controls

3BUF001094R4101 135

Writing Process Values Section 2 DataDirect - Excel Data Access

3. Enter the tag value in the Value field.

4. When you are satisfied with the tag specification, click the Add to List button. This adds the specification to the Preview Selected Updates list, Figure 80.

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 information 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 Remove From List. If only one row is selected, the row will be deleted immediately. If more than one row is selected, you will be prompted to confirm

Figure 79. Browsing for the OPC Tag

Figure 80. Preview Selected Updates List

136 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Writing Process Values

whether or not to remove ALL selected rows. Click Yes to confirm, or No to cancel the remove operation.

6. When you are 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 81.

7. It is recommended that you make a permanent record of this update operation by recording the results in a spreadsheet. See Recording the Output Results on page 147.

Building an Ad-hoc List

This procedure is similar to building a data retrieval query as described in Reading Process Values on page 124.

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

Figure 81. Send Updates Result

3BUF001094R4101 137

Writing Process Values Section 2 DataDirect - Excel Data Access

3. Select the object name and attribute name from their respective lists, Figure 83.

4. Enter the value as shown in Figure 84.

Figure 82. Selecting the Object Type

Figure 83. Selecting the Object and Attribute

Figure 84. Specifying the Tag Value

138 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Writing Process Values

5. When you are satisfied with the tag specification, click the Add to List button. This adds the specification to the Preview Selected Updates list, Figure 85.

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.

To remove a specification, select the specification in the list, and then click Remove From List. If only one row is selected, the row will be deleted immediately. If more than one row is selected, you will be prompted to confirm whether or not to remove ALL selected rows. Click Yes to confirm, or No to cancel the remove operation.

8. When you are 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 86.

DO NOT check the Use Spreadsheet for Input check box.

Figure 85. Preview Selected Updates List

3BUF001094R4101 139

Writing Process Values Section 2 DataDirect - Excel Data Access

9. It is recommended that you make a permanent record of this update operation

by recording the results in a spreadsheet. See Recording the Output Results on page 147.

Figure 86. Send Updates Result

140 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Writing Process Values

Importing a Formatted Range of Cells from a Spreadsheet

This procedure lets you 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:

1. Click the Use Spreadsheet for Input check box, Figure 62.

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. You can enter the range directly, or click the button to collapse the Update Process Values dialog, Figure 63, and then select the range directly in the spreadsheet.

Figure 87. Use Spreadsheet for Input

Figure 88. Collapsing the Process Values Dialog

ClickHere

Click here to collapse the dialog

3BUF001094R4101 141

Writing Process Values Section 2 DataDirect - Excel Data Access

An example is shown in Figure 64.

3. With the selected range indicated in the Formatted Range field, Figure 65, click the Add to List button.

Figure 89. Selecting a Formatted Range of Cells

All cells must contain data, and the range CANNOT contain spaces. This will generate an error message, in which case you must reselect the cell range.

Figure 90. Selecting the Starting Cell for a Formatted Range

Click Here to Restore

Formatted Range Selected

142 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Writing Process Values

This adds the update specifications to the Selected Updates list, Figure 66.

4. Continue adding specifications as required by repeating steps 2 and 3.

5. You can remove specifications from the list if necessary. To do this, select the specification in the list, and then click Remove From List. You cannot edit the specifications.

6. When you are 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 92.

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 see Recording the Output Results on page 147.

Figure 91. Preview Selected Updates for Formatted Range

Figure 92. Updates Sent for Formatted Range

3BUF001094R4101 143

Writing Process Values Section 2 DataDirect - Excel Data Access

Importing Non-formatted Ranges 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 93.

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

Figure 93. Unformatted, Non-contiguous Ranges

Figure 94. Select Individual Ranges From Spreadsheet

144 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Writing Process Values

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 you must select each range individually. An example is shown in Figure 95.

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

5. Continue adding unformatted ranges to the list. To add another specification, repeat steps 3 and 4.

Figure 95. Selecting Unformatted Ranges

Figure 96. Adding Unformatted Ranges to the List

3BUF001094R4101 145

Writing Process Values Section 2 DataDirect - Excel Data Access

6. You can remove specifications from the list if necessary. To remove a specification, select the specification in the list, and then click Remove From List. These specifications cannot be edited.

7. When you are ready to apply the updates, click Apply. This adds to columns to the preview list: Updated and Error Message. These columns indicate the status of each update, Figure 97.

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 see Recording the Output Results on page 147.

Figure 97. Updates Sent for Unformatted Range

146 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Writing Process Values

Recording the Output Results

You can 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, you can 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 so you can click to select a cell, Figure 98.

After you select the start cell, click the restore button (red dot) to restore the dialog, Figure 99.

Figure 98. Collapsing Select Start Cell Dialog

Figure 99. Indication of Selected Starting Cell

Selected Cell

Click Here to Collapse thisDialog and Return Focus tothe Spreadsheet

Click Here to Restore

3BUF001094R4101 147

Writing Process Values Section 2 DataDirect - Excel Data Access

3. If you enter the cell specification directly, the syntax is ColumnLetterRowNumber. For example A1 is the first row in the first column, Figure 100.

The orientation of the data is set via the Data Format tab in the Options dialog. You can display the options dialog by clicking the Options button in the Starting Cell dialog. For details on using the Options dialog, see Configuring Options on page 261.

The Insert check box lets you 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 you do not select this check box, any existing cells may be overwritten by new data.

4. Click OK when you are finished. This inserts the tag update records in the spreadsheet, Figure 101.

Figure 100. Select Start Cell Dialog

Figure 101. Output Results Inserted

148 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Reading/Writing History Data

Reading/Writing History DataDataDirect provides two dialogs for reading and writing numeric history data. The Industrial IT version lets you query aspect objects (property logs) in the 800xA system. With the proper authority you can also insert and/or replace log entries. This dialog is only available on 800xA system nodes that have core 800xA software installed (Aspect Servers, Connectivity Servers, Application Servers, and Workplace Clients). This dialog is not available on remote PC clients running Information Management Desktop tools without 800xA software.

If you are running DataDirect on a PC that does not have 800xA core system software (a remote Desktop Tools client), you must 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 you need to connect the dialog to a server that is outside the 800xA system, for example an earlier Enterprise Historian server. This lets you query objects on that server that are not a part of the 800xA system. This functionality is not supported by the Industrial IT version.

For querying 800xA system objects, if the Industrial IT version is available, it is generally recommended that you use it rather than the Inform IT version. The Industrial IT 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 Industrial IT and Inform IT versions are distinguishable by color - the Industrial IT icon is red, while the Inform IT icon is blue, Figure 102. If an icon is not available on the tool bar, use the View tab on the Options dialog to make it available. See View on page 267.

Refer to the applicable section below for instructions on using the appropriate dialog:

• Using the Industrial IT History Values Dialog on page 150

• Using the Inform IT History Values Dialog on page 167

Figure 102. Industrial IT and Inform IT History Value Icons

Industrial IT Version Inform IT Version

3BUF001094R4101 149

Using the Industrial IT History Values Dialog Section 2 DataDirect - Excel Data Access

Using the Industrial IT History Values DialogThe Industrial IT History Values dialog, Figure 103, lets you query aspect objects in the 800xA system for historical process data. The results are displayed according to the selections you make on the Data Format tab on the Options dialog. You can modify these selections via the Output Options tab on the History Values dialog.

With the proper authority you can also insert new log entries, or replace existing entries. The Insert/Replace tab is not enabled unless the Allow History Updates option is selected via the Setup tab on the Options dialog (see Setup on page 273). Also, user authority must be configured in the aspect system to allow you to update certain object properties. This is described in Industrial IT 800xA System Security.

Figure 103. History Values Dialog

150 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Industrial IT History Values Dialog

Follow these basic steps to retrieve or update history values with this dialog:

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 Industrial IT History Values dialog, Figure 104.

Either click the History Values button, or choose DataDirect > Industrial IT History Values from the menu bar.

3. To read history values, see Reading History Data on page 152. To update history values, see Writing History Data on page 161.

• This dialog requires 800xA core system software to be installed on the PC where you are running DataDirect.

• This dialog does not support querying objects on servers outside the 800xA system. For this you need to use the Inform IT version of this dialog. See Using the Inform IT History Values Dialog on page 167.

Figure 104. Opening the History Values Dialog

Menu Corresponding (Red)Tool Bar Button

3BUF001094R4101 151

Reading History Data Section 2 DataDirect - Excel Data Access

Reading History DataFollow 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. Use the Output radio buttons to specify whether to execute a one-time (ad-hoc) data query, or insert a reusable formula.

2. Specify whether to retrieve raw or interpolated data.

3. You may select a calculation algorithm (aggregate) 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. You may adjust the time range. The default time span is one hour from the current time.

6. Select the property logs whose values you want to see.

7. Click Apply or OK to retrieve the data.

For further details regarding these basic steps, and other optional procedures see:

• Specifying One-time Data Access or Reusable Formulas on page 104

• Retrieval Type on page 153

• Log Calculation Algorithm on page 154

• Number of Values on page 156

• Date and Time on page 105

• Selecting Logs on page 156

• Changing the Start Cell on page 103

• Inserting or Overwriting Rows on page 104

• Formatting on page 107

• Some information columns in the returned properties list (right pane) are hidden by default. You can expand these columns to show the information as described in Expanding the Items Columns in the Returned Properties List (Right Pane) on page 116.

152 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Retrieval Type

Retrieval TypeThe Retrieval Type pull-down list lets you select: Interpolated Data or Raw Data, Figure 105.

Interpolated Data

This returns values at regular intervals. You must 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.

Raw Data

This returns values for actual samples collected and stored by History. You must specify 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.

Figure 105. Retrieval Type

3BUF001094R4101 153

Log Calculation Algorithm Section 2 DataDirect - Excel Data Access

Log Calculation AlgorithmWhen the Retrieval Type is Interpolated, you can use this pull-down list to select a calculation to apply to the history data you are retrieving. This list is not available when the Retrieval Type is Raw or Bulk Data Export.

The pull-down list for Log Calculation Algorithms is based on the OPC HDA server to which you are connected. The implementation of these calculations is server dependent. The system OPC HDA server is the default. Figure 106 shows the list of calculation types for this server. These calculation types are described in Table 6.

The selected calculation is performed on the data stored in the log from which you are retrieving data. 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 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 106. Log Calculation Algorithm List for AIPHDA

Table 6. 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.

154 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Log Calculation Algorithm

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

Percentage Bad Percentage of data in the resample interval which has bad quality (1 equals 100 percent).

Worst Quality Worst quality of data in the resample interval.

Table 6. Calculation Options for 800xA OPC HDA Server

Calculation Retrieves

3BUF001094R4101 155

Number of Values Section 2 DataDirect - Excel Data Access

Number of ValuesThis pull-down list lets you specify the number of values to return. The default is 100 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, you can retrieve all data up to 3200 values.

Time Span for RetrievalSee Date and Time on page 105.

Selecting LogsThe object browser in the left pane of the History Values dialog is similar to the Plant Explorer. It lets you browse the aspect directory for the logs whose data you want to retrieve and display 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.

You can 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 157).

You may also apply a filter to include or exclude certain objects, aspects, and properties (Applying a Filter to the List of Returned Logs on page 158).

Figure 107. Number of Values Menu

156 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Selecting Logs

Also, you may abort the retrieval process 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 54. 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.

To put history data onto the spreadsheet, select one or more items in the log list, then click OK. You can also copy the selected logs to the clipboard to use (paste) in another application.

Specifying Whether or Not to Include Child Objects

This check box, Figure 109, lets you 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.

Figure 108. Abort Button

Figure 109. Specifying Whether or Not to Include Child Objects

Abort button showing 81 of 250 items retrieved

3BUF001094R4101 157

Selecting Logs Section 2 DataDirect - Excel Data Access

Applying a Filter to the List of Returned Logs

You can limit the list of returned logs in the right pane 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 110. Then specify any combination of type and pattern filters according to these guidelines.

The type filters let you select one or more object types, property log templates, or data types from the respective lists. You may use any combination of the type filters. Making no selection is equivalent to selecting all types.

The pattern filters let you specify one or more patterns for each criteria. If you specify multiple patterns, separate them with the pipe (|) delimiter character. You may use the following wildcard characters:

* - any character string ? - any single alphabetic character # - any single numeric character

You can 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.

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.

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.

158 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Selecting 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 Cancel will discard any changes you’ve made in this dialog and revert back to the last saved filter. The Reset button returns all settings to their default state.

Figure 110. History Values Filter

3BUF001094R4101 159

Changing the Output Options Section 2 DataDirect - Excel Data Access

Changing the Output OptionsYou can specify whether or not to display the following information as a result of a historical data query:

Headers Tag Names Calculation Timestamp Data Quality

The output format defaults to the settings made on the Data Format tab on the Options dialog (Data Format on page 262). You can change these default selections via the Output Options tab on this dialog, Figure 111. Clicking the Restore Options Dialog Settings will reset the output options to the settings on the Data Format tab.

Figure 111. Modifying Output Options

160 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Writing History Data

Writing History Data The Insert/Replace tab on the History Values dialog is shown in Figure 112. This tab lets you modify existing entries and insert new entries in property logs. There are certain restrictions and important considerations that you should read prior to writing history data. Refer to Writing to History Logs on page 62.

User Authority

The Insert/Replace tab is not enabled unless the Allow History Updates option is selected via the Setup tab on the Options dialog (see Setup on page 273). Also, user authority must be configured in the aspect system to allow you to update log objects. This is described in Industrial IT 800xA System Security.

Figure 112. Insert/Replace Tab

3BUF001094R4101 161

Writing History Data Section 2 DataDirect - Excel Data Access

The method of operation for this tab is similar to reading history values as described in Reading/Writing History Data on page 149. You can use either of two methods:

• The basic method is to use the object browser (left pane) in combination with an edit filter. See Using the Object Browser below.

• As an alternative you can make a list of data retrieval parameters in the spreadsheet, and then import this data from the spreadsheet. See Use Spreadsheet for Input on page 164.

Using the Object Browser

This is similar to retrieving items for data retrieval (reference Figure 113):

1. Use the object browser (left pane) and edit filter to retrieve an object property list as described in Selecting Logs on page 156. This list is displayed in the right pane.

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

You can remove selected items from the list if necessary. To do this, select the item in the list, and then click Remove From List. You may also clear the entire list 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.

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 log list (upper right pane) when you apply the changes.

4. Click in the Insert/Replace column and select Insert or Replace.

5. Click Apply when you are finished. The Updated column in the Update list (lower pane) will indicate whether or not the update was successful, Figure 114.

DO NOT check the Use Spreadsheet for Input check box. This disables the object browser.

162 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Writing History Data

Figure 113. Selecting Items to Update

Figure 114. Updated Values in refreshed Log List

2a) Items selectedfor update

2b) Click Add to List

3) Edit value

1) Use objectbrowser & edit filterretrieve logs

5) Click Apply.

4) Select Replace orInsert from Menu

3BUF001094R4101 163

Writing History Data Section 2 DataDirect - Excel Data Access

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:

1. Click the Use Spreadsheet for Input check box, Figure 115.

2. Enter the range of cells that contain the object names in the Objects Range field. You can enter the range directly, or click the button to collapse the dialog, Figure 116, 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 117.

Figure 115. Use Spreadsheet for Input

Figure 116. Collapsing the Process Values Dialog

Figure 117. Selecting a Range of Cells

ClickHere

Click here to collapse the dialog

Objects RangeSelected

Click Here to Restore

164 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Writing History Data

3. As an option, you may repeat step 2 to import timestamps, milliseconds, values and/or object status data from the spreadsheet. If you do, the number of rows selected for each additional parameter must match the number of rows selected for the object names.

4. When you are finished, Figure 118, click Add to List.

This creates the update list, Figure 119.

You can remove selected items from the list if necessary. To do this, select the item in the list, and then click Remove From List. You may also clear the entire list by clicking Clear.

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

All cells must contain data, and the range CANNOT contain spaces. This will generate an error message, in which case you must reselect the cell range.

Figure 118. Selected Range

Figure 119. Preview Selected Updates for Formatted Range

3BUF001094R4101 165

Writing History Data Section 2 DataDirect - Excel Data Access

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 log list (upper right pane) when you apply the changes.

6. Click in the Insert/Replace column and select Insert or Replace.

7. Click Apply when you are finished.The Updated column in the Update list (lower pane) will indicate whether or not the update was successful, Figure 120.

Figure 120. Update Completed

166 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Inform IT History Values Dialog

Using the Inform IT History Values DialogThe Inform IT History Values dialog, Figure 121, is required when you are running DataDirect on a PC client that does not have 800xA core software installed, or when you need to query objects outside the 800xA system.

The Add/Modify tab is not shown unless:

• the Allow History Updates option is selected via the Setup tab on the Options dialog. See Enable/Disable Write Access to History and Process Values on page 277.

• you log in to DataDirect as a user with update history authority.

Also, the tab will be visible, but not active unless you deactivate the Use Channel Numbers option via the Setup tab on the Options dialog (Setup on page 273).

Figure 121. History Values Dialog

3BUF001094R4101 167

Using the Inform IT History Values Dialog Section 2 DataDirect - Excel Data Access

Follow these basic steps to access history values with this dialog:

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

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. See View on page 267.

3. To retrieve historical data, see Retrieving History Data on page 169.

To add/modify lab data log entries, see Adding/Modifying Entries for a Lab Data Log on page 182.

When you use this dialog, you can not use the F9 function 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 Configuring Options on page 261.

Figure 122. Opening the Dialog

MenuBlue Tool Bar Button

168 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Retrieving History Data

Retrieving History DataFollow 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.

3. Use the Output radio buttons to specify whether to execute a one-time (ad-hoc) data query, or insert a reusable formula.

4. Select the property logs whose values you want to see.

5. You may select a calculation algorithm (aggregate) 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. You may adjust the time range. The default time span is 24 hours from the current time.

8. Click Apply or OK to retrieve the data.

For further details regarding these basic steps and other optional procedures see:

• Selecting the Data Provider on page 170

• Retrieval Type on page 171

• Specifying One-time Data Access or Reusable Formulas on page 104

• Selecting History Objects on page 173

• Log Calculation Algorithm on page 176

• Number of Values on page 180

• Date and Time on page 105

• Changing the Start Cell on page 103

• Inserting or Overwriting Rows on page 104

• Formatting on page 107

• Changing the Output Options on page 181

3BUF001094R4101 169

Selecting the Data Provider Section 2 DataDirect - Excel Data Access

Selecting the Data ProviderYou must specify the data provider to use for historical data access. The choices are:

• AIPHDA (Default) - for access via the 800xA OPC HDA server. This supports 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. See Appendix C, Using the IM OPC HDA Server.

• LOG - for ABB OCS logs (Enterprise Historian version 3.2/1 or earlier).

This specification is made via 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 123.

Figure 123. Selecting the AIPHDA Data Provider

170 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Retrieval Type

Retrieval TypeThe History Values dialog lets you select one of four retrieval types: Trend Display, Interpolated Data, Raw Data, or Bulk Data Export. Select the retrieval type by clicking the corresponding radio button, Figure 105.

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. You must 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.

Raw Data

This returns values for actual samples collected and stored by History. You must specify 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.

Figure 124. Retrieval Type

3BUF001094R4101 171

Retrieval Type Section 2 DataDirect - Excel Data Access

Bulk Data Export

The Bulk Data Export option lets you import interpolated data from numeric logs directly into DataDirect. The presentation includes a single row of column headers composed of a TIME string followed by log names. In the TIME column, each row contains the time corresponding to the interpolated data values. Under each log name is a column of that log’s interpolated data values corresponding to the time. The file size is limited to 100Meg (10,080 points x 500 logs max). An example is shown in Figure 125.

Figure 125. Example Output File for Interpolated Data

• The Bulk Data Export option requires you to configure the History Server parameter in the Setup tab of the Options dialog. See Setup on page 273.

• The Raw Data, Bulk Data Export, and Trend Display functions do not recognize data providers by channel number, but rather by the -name argument. Therefore the Use Channel Number option in the Options dialog Setup tab must be DEACTIVATED (not selected). See Data Provider Connections on page 274. If you do not deactivate this option, you will only be allowed to use the Interpolated Data option.

Time Column Columns for Each Log Specified in Input File

Number of Rows According to Start and End Times, and Retrieval Interval

172 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Selecting History Objects

Selecting History ObjectsUse the Select History Objects section to select the logs for which you want to retrieve data. The operation of this section differs, depending on the LOG/HDA data provider to which you are connected (Selecting the Data Provider on page 170). For operating instructions based on the selected data provider, refer to:

• Accessing Property Logs via OPC HDA below

• ABB OCS (Enterprise Historian Platform) History Access on page 175

Accessing Property Logs via OPC HDA

When you are connected to an OPC HDA server, for example via 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 126. 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 lets you choose one of three methods by which to conduct your search: EH for local access, EH_PUBL for published archived log data, and EH_NET for network-wide access (LOGMAN is not applicable for this release).

3BUF001094R4101 173

Selecting History Objects Section 2 DataDirect - Excel Data Access

Whether you are using the AIPHDA or IMHDA data provider, these same browsing methods are supported:

• 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 selected folder.

• Apply a filter to either show or exclude all logs whose name has a specified text string.

• With AIPHDA, you can use the Seamless retrieval option when you are unsure 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 you are finished. This executes the query and puts the requested data in the spreadsheet. You can also copy the selected object list to the clipboard to use (paste) in another application.

For further guidelines on using this tool, see Using the OPC Browser on page 256.

Figure 126. Browsing for Property Logs

View for AIPHDA

View for IMHDA

174 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Selecting History Objects

ABB OCS (Enterprise Historian Platform) History Access

When accessing history data from an Enterprise Historian platform via the LOG data provider, the object list in the Select History Objects section is populated according to the text file specified in the Select History Object File field, Figure 127. To select a different text file, click the button to display a standard Windows file chooser dialog.

You can select any number of objects 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 you want to select, hold down the SHIFT key, and then click on the last item you want to select.

• To select multiple items that are not contiguous, hold down the CTRL key and click on the items you want to select.

The New History Object field lets you add new History objects to the object list. You can also remove objects. 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.

Figure 127. Select History Objects List

Add/remove operations neither add to, nor remove from the current History object text file. However you can save the changes to a new text file by clicking the Save File button.

3BUF001094R4101 175

Log Calculation Algorithm Section 2 DataDirect - Excel Data Access

Log Calculation AlgorithmWhen the Retrieval Type is Interpolated, you can use this pull-down list to select a calculation to apply to the history data you are retrieving. This list is not available when the Retrieval Type is Raw or Bulk Data Export. This list has two modes of operation depending on whether you retrieving history data from an OPC HDA server, or from an Enterprise Historian 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 OPC HDA server to which you are connected. The implementation of these calculations is server dependent.

The default OPC HDA server is the 800xA OPC HDA server which is connected via the AIPHDA data provider. Figure 106 shows the list of calculation types for this server. These calculation types are described in Table 6.

The calculation options for the IMHDA server are listed in Table 8.

The selected calculation is performed on the data stored in the log from which you are retrieving data. 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 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 128. Log Calculation Algorithm List for AIPHDA

176 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Log Calculation Algorithm

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

3BUF001094R4101 177

Log Calculation Algorithm Section 2 DataDirect - Excel Data Access

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

Percentage Bad Percentage of data in the resample interval which has bad quality (1 equals 100 percent).

Worst Quality Worst quality of data in the resample interval.

Table 8. Calculation Options for Information Management OPC HDA Server

Calculation Retrieves

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.

Table 7. Calculation Options for 800xA OPC HDA Server

Calculation Retrieves

178 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Log Calculation Algorithm

Log Calculation for Enterprise Historian version 3.2/1 or Earlier (LOG)

When DataDirect is connected to an Enterprise Historian server version 3.2/1 or earlier via the LOG data provider, log calculation options are as described below and shown in Figure 129. In this case, the choice you make 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 for you. Refer to Industrial IT 800xA - Information Management Configuration for details.

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.

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 129. Log Calculation Algorithm for LOG Data Provider

3BUF001094R4101 179

Number of Values Section 2 DataDirect - Excel Data Access

Number of ValuesThis pull-down list lets you 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 and Bulk Data Export Retrieval Types, you can retrieve all data up to 3200 values.

Bulk Format IntervalThis list replaces the Log Calculation Algorithm list when the Retrieval Type is Bulk Data Export. Use this list to specify the intervals for which interpolated data values will be returned, Figure 131. Select the units from the pull down list. The options are: Minute, Hour, Day, or Week. Enter the unit quantity in the field to the left of the list. For example, in Figure 131 values will be time-stamped at 1-hour intervals.

Time Span for RetrievalSee Date and Time on page 105.

Figure 130. Number of Values Menu

Figure 131. Bulk Format Interval

180 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Changing the Output Options

Changing the Output OptionsYou can specify whether or not to display the following information as a result of a historical data query:

Headers Tag Names Calculation Timestamp Data Quality

The output format defaults to the settings made on the Data Format tab on the Options dialog (Data Format on page 262). You can change these default selections via the Output Options tab on this dialog, Figure 111. Clicking the Restore Options Dialog Settings will reset the output options to the settings on the Data Format tab.

Figure 132. Modifying Output Options

3BUF001094R4101 181

Adding/Modifying Entries for a Lab Data Log Section 2 DataDirect - Excel Data Access

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. You must be logged in as an Administrator-level user to change these settings. See Enable/Disable Write Access to History and Process Values on page 277.

• At the data server level, the applicable data provider must be configured to allow write transactions. This is the default set-up. If you want to verify this set-up, refer the section on configuring data access for data providers in Industrial IT 800xA - Information Management Configuration.

• On the user level, the user with which you log 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. To adjust this preference for a user, refer to the section on managing users in Industrial IT 800xA - Information Management Configuration.

Other Considerations

• For add/modify operations, if you need to reference a specific data provider you must use the -name argument. Therefore the Use Channel Numbers option in the Options dialog Setup tab must be DEACTIVATED (not selected).

• If you are using the IMHDA OPC HDA server, if you need to add new log entries, you must use the EH_NET option in the OPC Browser (Using the OPC Browser on page 256). This option lets you modify existing log entries, and add new entries. EH supports the ability to modify existing log entries, but not to add new entries.

182 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Adding/Modifying Entries for a Lab Data Log

Accessing the Add/Modify Tab

To Add a History value to a lab data log:

1. Click the History Values button, or choose DataDirect > History Values from the menu bar.

2. Click the Add/Modify tab. This displays the controls for adding or modifying a log entry, Figure 133.

3. Click the applicable radio button to specify whether you want to add a new entry to the log, or modify an existing entry, Figure 134.

Figure 133. Add/Modify Tab

3BUF001094R4101 183

Adding/Modifying Entries for a Lab Data Log Section 2 DataDirect - Excel Data Access

The remainder of this procedure requires you to build log entry update specifications, add these specifications to a list, and then send the list. Also, it is recommended that you output the results of the update operation to your spreadsheet. This gives you 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. Refer to the applicable instructions below for the method you want to use:

• Updating an OPC HDA Property Log

• Updating ABB OCS (Enterprise Historian platform) logs:

– Building an Ad-hoc List

– Importing a Formatted Range of Cells from a Spreadsheet

– Importing Non-formatted Ranges of Cells from a Spreadsheet

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). See Selecting the Data Provider on page 170.

When using an HDA data provider, the History Object section of this dialog provides controls for browsing the OPC server for property logs, Figure 135.

Figure 134. Add/Modify Radio Buttons

When updating ABB OCS logs on an Enterprise Historian platform, it is recommended that you 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.

184 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Adding/Modifying Entries for a Lab Data Log

Select one property log at a time. To do this:

1. Click Browse to launch the OPC Browser.

2. Use the browser to find and select the Property Log, Figure 136. 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. Whether you are using the AIPHDA or IMHDA data provider, these same browsing methods are supported:

– 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 selected folder.

– Apply a filter to either show or exclude all logs whose name has a specified text string.

– With AIPHDA, you can use the Seamless retrieval option when you are unsure which component log within the property log will provide best coverage of the requested time range.

– For IMHDA, if you need to add new log entries, you must use the EH_NET option in the OPC Browser. This option lets you modify existing log entries, and add new entries. EH supports the ability to modify existing log entries, but not to add new entries.

Figure 135. Update OPC HDA History Object

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 you must either restart the IMHDA data provider, or use local (EH) access.

3BUF001094R4101 185

Adding/Modifying Entries for a Lab Data Log Section 2 DataDirect - Excel Data Access

For further details regarding the OPC Browser, see Using the OPC Browser on page 256.

3. Click OK when you are finished. This puts the full path to the property log in the History Object field, Figure 137.

4. Enter a value in the Value field.

5. Specify the date and time for the entry. When you are modifying an existing entry you must match the time stamp to one-second resolution. It is recommended that you retrieve the raw data for the log entry as described in Retrieving History Data on page 169 to get the precise time stamp.

6. As an option, you can use the Object Status field to enter an integer value that you want to associate 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). You are not required to change this value if you choose not to use this functionality.

A completed specification is shown in Figure 138.

Figure 136. Browsing for the OPC Tag

Figure 137. Selected Log

186 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Adding/Modifying Entries for a Lab Data Log

7. When you are satisfied with the log entry specification, click the Add to List button. This adds the specification to the Preview Selected Updates list, Figure 139.

8. Continue adding specifications to the list as required. To do this, repeat 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.

To remove a specification, select the specification in the list, and then click Remove From List. If only one row is selected, the row will be deleted immediately. If more than one row is selected, you will be prompted to confirm whether or not to remove ALL selected rows. Click Yes to confirm, or No to cancel the remove operation.

Figure 138. Completed Property Log Update Specification

Figure 139. Preview Selected Updates List

3BUF001094R4101 187

Adding/Modifying Entries for a Lab Data Log Section 2 DataDirect - Excel Data Access

10. When you are 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 146.

11. It is recommended that you record the update results in a spreadsheet. See Recording Output Results on page 195.

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 141. Logs are listed by their full log name as required for log editing functions.

Figure 140. Send Updates Result

Figure 141. Select a History Object

188 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Adding/Modifying Entries for a Lab Data Log

3. Specify the date and time for the entry, Figure 142. When you are modifying an existing entry you must match the time stamp to one-second resolution. It is recommended that you retrieve the raw data for the log entry as described in Retrieving History Data on page 169 to get the precise time stamp.

4. Enter the value as shown in Figure 143.

5. As an option, you can use the Object Status field to enter an integer value that you want to associate with this log entry, Figure 144. For example integer values may be used to identify the user that added/modified the entry. This value defaults to 0 (zero). You are not required to change this value if you choose not to use this functionality.

6. When you are satisfied with the log specification, click the Add to List button. This adds the specification to the Preview Selected Updates list, Figure 145.

Figure 142. Specifying the Time Stamp for the Log Entry

Figure 143. Specifying the Log Entry Value

Figure 144. Specifying the Object Status

DO NOT check either the Use Spreadsheet for Input or Use Current Time Stamp check boxes.

3BUF001094R4101 189

Adding/Modifying Entries for a Lab Data Log Section 2 DataDirect - Excel Data Access

7. Continue adding specifications to the list as required. To do this, repeat 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.

To remove a specification, select the specification in the list, and then click Remove From List. If only one row is selected, the row will be deleted immediately. If more than one row is selected, you will be prompted to confirm whether or not to remove ALL selected rows. Click Yes to confirm, or No to cancel the remove operation.

9. When you are 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 146.

10. It is recommended that you record the update results in a spreadsheet. See Recording Output Results on page 195.

Figure 145. Preview Selected Updates List

Figure 146. Send Updates Result

190 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Adding/Modifying Entries for a Lab Data Log

Importing a Formatted Range of Cells from a Spreadsheet

This procedure lets you import a formatted range of log entry 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 Name, Time Stamp, Value, Object Status.

To import log entry update specifications from a formatted range spreadsheet:

1. Click the Use Spreadsheet for Input check box, Figure 147.

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. An example is shown in, Figure 148.

Figure 147. Use Spreadsheet for Input

3BUF001094R4101 191

Adding/Modifying Entries for a Lab Data Log Section 2 DataDirect - Excel Data Access

3. With the selected range indicated in the Formatted Range field, Figure 149,

click the Add to List button.

This adds the log entry update specifications to the Preview Selected Updates list, Figure 150.

Figure 148. Selecting a Full Range of Cells

All cells must contain data, and the range CANNOT contain spaces. This will generate an error message, in which case you must reselect the cell range.

Figure 149. Selecting the Starting Cell for a Formatted Range

Figure 150. Preview Selected Updates for Formatted Range

192 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Adding/Modifying Entries for a Lab Data Log

4. Continue adding specifications to the list as required. To do this, repeat steps 2 and 3. You can also remove a specification from the list by selecting it and clicking Remove from List. These specifications cannot be edited.

5. When you are 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 151.

6. To make a permanent record of this update operation, see Recording Output Results on page 195.

Importing Non-formatted Ranges of Cells from a Spreadsheet

This method lets you select non-contiguous ranges of cells. There is no formatting requirements for the ranges that you select.

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 specifying individual log entry 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 History Objects Range. Also, the fields for History Objects Range, Time Stamps Range, Values Range, and Object Status Range are enabled, Figure 152.

Figure 151. Updates Sent for Formatted Range

3BUF001094R4101 193

Adding/Modifying Entries for a Lab Data Log Section 2 DataDirect - Excel Data Access

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 you must select each range individually. Click the button to minimize the dialog, and then select the full range of cells.

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, see Recording Output Results on page 195.

Figure 152. Select Individual Ranges From Spreadsheet

• 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• Blank cells WITHIN a range selection will give an error message, then

allowing the user to correct the selection• You may only select ONE cell from the range input field, which will return a

confirmation 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, prompting you to correct the range selection

• When entries are added to the Preview Selected Updates list, all date values are formatted according to options from date/time values

194 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Adding/Modifying Entries for a Lab Data Log

Recording Output Results

You can 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, you can 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 so you can click to select a cell, Figure 153.

After you select the start cell, click the restore button (red dot) to restore the dialog, Figure 154.

Figure 153. Collapsing Select Start Cell Dialog

Figure 154. Indication of Selected Starting Cell

Click Here to Collapse thisDialog and Return Focus to theSpreadsheet

Selected Cell

Click Here to Restore

3BUF001094R4101 195

Adding/Modifying Entries for a Lab Data Log Section 2 DataDirect - Excel Data Access

3. If you enter the cell specification directly, the syntax is ColumnLetterRowNumber. For example A1 is the first row in the first column, Figure 155.

The orientation of the data is set via the Data Format tab in the Options dialog. You can display the options dialog by clicking the Options button in the Starting Cell dialog. For details on using the Options dialog, see Configuring Options on page 261.

The Insert check box lets you 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 you do not select this check box, any existing cells may be overwritten by new data.

4. Click OK when you are finished. This inserts the log entry updates in the spreadsheet, Figure 156.

Figure 155. Select Start Cell Dialog

Figure 156. Output Results Inserted

196 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Retrieving Alarm/Event and Message Data

Retrieving Alarm/Event and Message DataDataDirect provides two dialogs for reading alarm/event and message data. The Industrial IT Alarm and Events dialog lets you retrieve alarm and event messages for a selected alarm/event list. This dialog requires 800xA core system software to be installed on the PC where you are running DataDirect.

The Inform IT Messages dialog lets you retrieve data from message logs configured via 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 Industrial IT version is generally recommended for viewing recent alarm/event data on the 800xA alarm/event server. Since messages on this server are eventually overwritten, you may need to use the Inform IT version 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 toolbar icons for the Industrial IT and Inform IT versions are distinguishable by color - the Industrial IT icon is red, while the Inform IT icon is blue, Figure 157. If an icon is not available on the tool bar, use the View tab on the Options dialog to make it available. See View on page 267.

Refer to the applicable section below for instructions on using the appropriate dialog:

• Using the Industrial IT Alarm/Events Dialog on page 198

• Using the Inform IT Message Log Dialog on page 202

Figure 157. Industrial IT and Inform IT Alarm/Event Message Icons

Industrial IT Version Inform IT Version

3BUF001094R4101 197

Using the Industrial IT Alarm/Events Dialog Section 2 DataDirect - Excel Data Access

Using the Industrial IT Alarm/Events DialogThe Industrial IT Alarms and Events dialog, Figure 158, lets you retrieve alarm and event messages for a selected alarm/event list. These lists are user-configurable as described in Industrial IT 800xA Operator Workplace Configuration. This dialog requires 800xA core system software to be installed on the PC where you are running DataDirect.

If you need 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 as described in Using the Inform IT Message Log Dialog on page 202.

Figure 158. Industrial IT Alarms and Events Dialog

198 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Alarms and Events 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 > Industrial IT > Alarm and Events from the menu bar, Figure 159.

3. Use the Alarm and Events dialog to select the alarm or event list and specify a time range. See Using the Alarms and Events Dialog on page 199.

Using the Alarms and Events DialogTo use the Industrial IT Alarms and Events dialog:

1. Use the Output radio buttons to specify whether to execute a one-time (ad-hoc) data query, or insert a reusable formula. See Specifying One-time Data Access or Reusable Formulas on page 104.

2. Select the alarm and event list whose messages you want to retrieve and display in the spreadsheet. See Selecting Alarm and Event Lists on page 200.

3. The default time span is 24 hours from the current time. You can change the default time span via the Messages tab of the Options dialog. See Messages on page 283. You can also change the start and end time using the controls on this dialog as described in Date and Time on page 105.

4. Use the Maximum Rows pull-down list to specify the number of values to return. The default is 100 and the maximum is 3200.

5. Click Apply or OK to retrieve the data.

As an option you may also specify the following alarm/event retrieval parameters:

Changing the Start Cell on page 103 Inserting or Overwriting Rows on page 104

Figure 159. Opening the Dialog

Menu Corresponding (Red)Tool Bar Button

3BUF001094R4101 199

Using the Alarms and Events Dialog Section 2 DataDirect - Excel Data Access

Selecting Alarm and Event Lists

The object browser (left pane) in the Alarm and Events dialog is similar to the Plant Explorer. It lets you browse the aspect directory for the objects whose alarm and event lists you want to query. 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.

You can 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

You may also apply a filter to include or exclude certain objects, aspects, and properties.

You may abort the retrieval process 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

You can limit the list of returned alarm and event lists in the right pane 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 160. Then specify any combination of type and pattern filters according to these guidelines.

The type filter lets you 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.

200 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Alarms and Events Dialog

The pattern filters let you specify one or more patterns for each criteria. If you specify multiple patterns, separate them with the pipe (|) delimiter character. You may use the following wildcard characters:

* - any character string ? - any single alphabetic character # - any single numeric character

You can 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.

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

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 Cancel will discard any changes you’ve 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 you make a new selection in the browser (left pane). To apply the filter to the currently selected object in the left pane, click Apply Filter.

Figure 160. Edit Alarm and Event Filters

3BUF001094R4101 201

Using the Inform IT Message Log Dialog Section 2 DataDirect - Excel Data Access

Using the Inform IT Message Log DialogThe Message Log dialog lets you retrieve data from message logs configured via the Information Management History Server function. Instructions for configuring these message logs are provided in the section on configuring message logs in Industrial IT 800xA - Information Management Configuration.

Follow these basic steps to access history values with this dialog:

1. Select the starting cell 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 Message Log button in the tool bar, or choose DataDirect > Inform IT > Message Log from the menu bar, Figure 159.

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. See View on page 267.

When you use this dialog you can not use the F9 function to re-calculate the workbook and retrieve new data. DataDirect does not provide an equivalent function for this dialog at this time.

Figure 161. Opening the Dialog

Menu

Corresponding BlueTool Bar Button

202 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Inform IT Message Log Dialog

Selecting Which Tab to Use

This dialog has two tabs, depending on the type of message log you want to access:

• Use the OPC/Audit Trail tab for:

– OPC_MESSAGE logs for Batch Management, the 800xA system Alarm/Event Server, and other OPC data sources.

– The AUDIT_MESSAGE log for History event messages stored in the Audit Trail message log.

See OPC/Audit Trail on page 204.

• 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. See Alarm and Event on page 211.

Other optional procedures are:

• Changing the Start Cell on page 103

• Specifying One-time Data Access or Reusable Formulas on page 104

• Inserting or Overwriting Rows on page 104

• Formatting on page 107

3BUF001094R4101 203

OPC/Audit Trail Section 2 DataDirect - Excel Data Access

OPC/Audit TrailThe OPC/Audit Trail tab, Figure 162, lets you retrieve data from OPC_MESSAGE and AUDIT_MESSAGE logs based on user-specified criteria.

Follow these guidelines to retrieve alarm/event message using this tab. Refer to the referenced sections for details.

1. Use the Output radio buttons to specify whether to execute a one-time data query, or insert a reusable formula.

When you select Data Only, you may also choose whether or not to generate the SQL query. See Generate SQL on page 209. When you select Formula, you may change the default name for the saved query. See Saving a Query on page 210.

Figure 162. Message Log - OPC/Audit Trail Tab

204 3BUF001094R4101

Section 2 DataDirect - Excel Data Access OPC/Audit Trail

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. See Date and Time on page 105 for details.

4. Select which OPC attributes and/or Vendor Attributes you want to retrieve from their respective lists.

The OPC attributes are described in Table 9. Rather than use the list you may use the OPC attribute query function. See OPC Attribute Query on page 208.

The Vendor/Category list is unfiltered by default. You may apply a filter to limit the scope of vendor attributes to retrieve. See Using the Vendor/Categories List on page 207. Or you may use the vendor attribute query function as described in Vendor Attribute Query on page 209

5. The Additional Output Options section lets you select additional information to include in the output. You may show the SQL query with a data only output, or save the query when you use the Formula option. See:

– Generate SQL on page 209

– Saving a Query on page 210

– Additional Output Options on page 210.

OPC Attributes

Use this list to select one or more OPC attributes whose values you want to retrieve. These attributes are described in Table 9.

Table 9. 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.

3BUF001094R4101 205

OPC/Audit Trail Section 2 DataDirect - Excel Data Access

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.

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 (see 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

Table 9. OPC/Audit Trail Message Log Attributes

Field Name Type Description

206 3BUF001094R4101

Section 2 DataDirect - Excel Data Access OPC/Audit Trail

Using the Vendor/Categories List

This pick list is populated with all attributes for all vendors and categories that exist in the MSGVENDORS table (see Section 9, Reading Message Logs). Use this list to select one or more vendor-specific attributes whose values you want to retrieve.

This list is unfiltered by default. You may apply a filter to limit the scope of vendor attributes to retrieve. To do this, click the Filter button. This displays the Filter dialog shown in Figure 163.

Create a filter by selecting the vendors, categories, and attributes to include.

The Filter Here check box for each list lets you apply a filter to the other lists. Filters are applied from left to right by default. For example, if you check Filter Here for Vendors, the Categories list will show categories only for the selected vendors.

You may reverse the filter order using the Filter Order pull-down list. For example, when you check Filter Here for both Vendors and Categories, you may 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 let you select all items in a list. The Reset button restores the defaults.

Click OK when you are done.

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 9. OPC/Audit Trail Message Log Attributes

Field Name Type Description

3BUF001094R4101 207

OPC/Audit Trail Section 2 DataDirect - Excel Data Access

OPC Attribute Query

This check box and edit field lets you specify a query for an OPC attribute, for example: EVENT_TYPE = 1. This would return all selected OPC or vendor-specific attributes for messages whose EVENT_TYPE is set to 1 (simple).

Figure 163. Vendor and Category Filter

208 3BUF001094R4101

Section 2 DataDirect - Excel Data Access OPC/Audit Trail

Vendor Attribute Query

This check box and edit field lets you specify a query for a vendor attribute. You are required to specify the attribute by ID rather than name. For example in Figure 162 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’.

Generate SQL

Selecting this option lets you 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 in order for the Generate SQL option to be available.

All vendor attributes are returned to DataDirect as character strings. Therefore you must 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 9, Reading Message Logs to determine the actual data types.

Figure 164. Generate SQL

3BUF001094R4101 209

OPC/Audit Trail Section 2 DataDirect - Excel Data Access

Saving a Query

When you use the Formula option, the resulting SQL query is saved and may be used either in the SQL Query dialog (Using the Production Data Log Dialog on page 232), or the ABBSQL function (ABBSql on page 330).

The query name defaults to MsgLog1. The next query will be MsgLog2, and so on. You may rename the queries as required. The saved queries will be available via the Open Query function on the SQL Query dialog, Figure 166.

Additional Output Options

The check boxes in this section let you specify whether or not to include the following information in the query output:

Vendor Category Category Number Attribute ID

Figure 165. Saving the SQL Query

Figure 166. MsgLog Queries Saved

210 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Alarm and Event

Alarm and EventThe Alarm and Event tab, Figure 167, lets you specify filtering criteria to retrieve data from DCS_MESSAGE logs. You must specify Log Name and Message Type. Search Text and Date and Time are optional. The middle section lets you specify database fields as additional search criteria.

Before you begin, make sure the applicable message type is selected via the filter on the Messages tab in the Options dialog Click Options, then refer to Messages on page 283.

Results are formatted according to the settings described in Alarm/Event Format Output on page 215.

Figure 167. Message Log - Alarm and Event Tab

3BUF001094R4101 211

Alarm and Event Section 2 DataDirect - Excel Data Access

Log Name

This pull down list contains all message logs configured in your system.

Search Text

This field lets you 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 you will be able to enter an exact message entry, DataDirect adds the wildcard to the beginning and end of every value entered when generating the query.

Message Type

This pick list lets you specify the types of alarm/events to retrieve. This field is enabled only when the Filter option in the Options/Messages dialog is set to MOD 300 or Other.

The default selection is ALL. You can specify multiple message types 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 let you specify message attribute values as additional search criteria. The wildcard characters % or * can be used. You can either enter 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. See File Setup on page 279. You can use the Browse and Auto-Create functions 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.

212 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Alarm and Event

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 lets you 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 will revert back to the file specified in the File Setup tab the next time you use the Message Log dialog.

Auto-Create

The Auto Create function lets you 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 that you build and run via the Auto Create dialog, Figure 168. To open this dialog click Auto Create.

The Property Text and Event Text fields are disabled when the version of History software is earlier than History Services 2.4.

3BUF001094R4101 213

Alarm and Event Section 2 DataDirect - Excel Data Access

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. You can change these settings if necessary.

The Filter edit box lets you 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. You can 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.

The Browse button launches the standard Windows dialog for directory navigation and file selection. The Edit button lets you open the specified file in a text editor such as notepad.

Figure 168. Auto Create Dialog

214 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Alarm/Event Format Output

Alarm/Event Format OutputThe 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 lets you 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 selected 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, you will prompted to 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 row in the Output Fields listbox up or down one row. Only one row can be selected and moved at a time.

3BUF001094R4101 215

Retrieving Production Data Section 2 DataDirect - Excel Data Access

Retrieving Production DataDataDirect provides two dialogs for retrieving production data generated by batch process applications. The Batch Data dialog provides twelve pre-configured views, Table 10. The Production Data Log dialog lets you drill the task hierarchy. Both dialogs may be used either on a node where the 800xA core software is installed, or on a remote PC client without 800xA software.

The toolbar icons for the Production Data Log and Batch Data versions are shown in Figure 169. If an icon is not available on the tool bar, use the View tab on the Options dialog to make it available. See View on page 267.

Refer to the section below for instructions on using the appropriate dialog:

• Using the Batch Data Dialog on page 216

• Using the Production Data Log Dialog on page 232

Using the Batch Data DialogThe Batch Data dialog lets you retrieve production data for a selected batch. The data is organized in twelve pre-configured views which are described in Functions on page 220. 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.

• Data Only - executes a one-time (ad-hoc) request for data.

Figure 169. Production Data Log and Batch Data Icons

Production Data Log Batch Data

216 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Batch Data Dialog

Follow these basic steps to retrieve production data with this dialog:

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 Batch data dialog, Figure 104.

Either click the Batch Data button, or choose DataDirect > Batch Data from the menu bar.

3. Use the Batch Data dialog, Figure 171, to specify data retrieval parameters including batch ID, view (function), and batch attributes (columns in the selected view) to retrieve. See Using the Batch Data Dialog on page 219.

Figure 170. Opening the Dialog

Menu Tool Bar Button

3BUF001094R4101 217

Using the Batch Data Dialog Section 2 DataDirect - Excel Data Access

Figure 171. Batch Data Dialog

218 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Batch Data Dialog

Using the Batch Data DialogThe Batch Data dialog lets you retrieve production data for a selected batch. The data is organized in twelve pre-configured views. Follow these basic steps, and refer to the sections that follow for further details.

Start by selecting the function that will retrieve data from the view that contains the batch information you require. This creates a basic query to access the view.

Then refine the query by specifying the batch ID, and which batch attributes (columns in the view) to include. You can also specify filters for one or more selected columns, and you can adjust the sorting order of the selected columns.

Select output type for the data request. The options are: DataDirect formula, SQL query, or one-time data request.

As an option you may also specify the following:

• Changing the Start Cell on page 103

• Inserting or Overwriting Rows on page 104

• Maximum Rows on page 229

3BUF001094R4101 219

Using the Batch Data Dialog Section 2 DataDirect - Excel Data Access

Functions

The Function list, Figure 172, contains the names of the functions that retrieve data from pre-configured views which are described in Table 10.

These names are configurable via the PDL/Batch tab on the Options dialog (See Options for the Batch Data Dialog on page 271). Selecting a function creates the DataDirect function or SQL query as a starting point for your data retrieval application. This function (or SQL query) is further specified as you use the other fields in this dialog.

When you select either DataDirect Formula or SQL Query as the Output Type, you may view and edit the function by clicking the Edit button. See Editing the Function or SQL Query on page 230.

Figure 172. Selecting the Function

Table 10. 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). See Table 66.

Batch_BatchMgrEvents ABBGetBatchBatchMgrEvents All batch manager events for a batch (events generated by batch manager). See Table 69.

Batch_CommentEvents ABBGetBatchCommentEvents Batch audit comment events (entered using block status dialog) for a batch. See Table 67.

Batch_Equipment ABBGetBatchEquipment Equipment transactions for a batch

220 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Batch Data Dialog

Batch_Events ABBGetBatchEvents All batch audit, batch manager and batch process events for a batch. See Table 61.

Batch_Header ABBGetBatchHeader Batch header (basic batch information). See Table 60.

Batch_Procedures ABBGetBatchProcedures List of procedures executed by a batch. See Table 64.

Batch_ProcessEvents ABBGetBatchProcessEvents All events generated by sources external to the batch server and associated with a batch (does not include batch audit events). See Table 65.

Batch_SystemEvents ABBGetBatchSystemEvents All system events (events not associated with a batch) for the time frame that a batch executed. See Table 70.

Batch_Trends ABBGetBatchTrends Continuous data recorded for a batch. See Table 71.Note: When using the Batch_Trends view, you must 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). See Search Criteria is Case Sensitive on page 271. Improving Performance: You may improve the performance of queries on the Batch_Trends view by following the guidelines in Improving the Performance of the Batch_Trend View on page 231.

Batch_Variables ABBGetBatchVariables Variables recorded for a batch. See Table 63.

Batch_Vars_MatchedPair ABBGetMatchedPair Matched pairs of variables recorded for a batch. See Table 62.

Table 10. Views

View Name Function Name Returns

3BUF001094R4101 221

Using the Batch Data Dialog Section 2 DataDirect - Excel Data Access

Batch ID

This list contains the ID of the batches which have been executed during the time span specified via the Time Span Start Time and End Time controls, and whose data is stored in a PDL.

The default span is specified via the Search Time Span field on the PDL/Batch tab of the Options dialog (see Search Time Span on page 271). You can adjust the time span as required, Figure 173. This control operates like a standard Microsoft date/time picker. After adjusting the time span, click Get Batch IDs to update the list.

Once you have the correct time span, use the pull-down list to select the batch whose data you want to retrieve, Figure 174, or enter the batch ID directly.

Figure 173. Adjusting the Time Span for Batch IDs

Figure 174. Selecting a Batch

222 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Batch Data Dialog

Other Methods for Specifying Batch ID

There are two additional methods by which you can specify the batch ID:

• Use Cell Reference - Checking this check box hides the list of batches and displays a cell reference text box in its place, Figure 175. This text box operates much like the Start Cell text box. It lets you reference a specific cell in the spreadsheet which contains the batch ID. To specify the starting cell, you can either enter the column/row specification directly in the Batch ID field, or use the corresponding button to return focus to the spreadsheet so you can click to select a cell, This cell may be filled in during report generation.

• PDL Browser - You may launch the PDL dialog by clicking the PDL Browser button. This dialog lets you drill up and down in the task hierarchy to find the batch whose data you want to retrieve. You may use the PDL dialog to simply find the applicable batch ID so that you may enter it in this dialog, or you may actually continue with your 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 232.

Figure 175. Using a Cell Reference

1) Check Use Cell Reference

2) Enter Cell ReferenceDirectly

3a) Click button to returnfocus to spreadsheet

OR3c) Clickhere toclose

3b) select a cell

3BUF001094R4101 223

Using the Batch Data Dialog Section 2 DataDirect - Excel Data Access

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 Columns list contains a list of all columns for the selected view, Figure 176. 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. You may also 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 817.

When you are finished selecting columns, you may specify a filter for one or more selected columns, and you may adjust the sorting order.

Figure 176. Selecting Columns

224 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Batch Data Dialog

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 lets you specify values or patterns by which to compare column values. Values that do not satisfy the filter will be excluded from the query. It you apply a filter and decide you do not want to use it, you may reset the filter 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 177. 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 then click Ok. Values that do not match the selected value will be filtered out. You may negate the filter by checking the NOT box. This filters out values that do match the selected value(s).

The Pattern tab lets you specify a textual pattern by which to compare column values, Figure 178. Use the pull-down list to specify whether the value must be an exact match (EQUALS), or simply contain the specified text string (LIKE).

Figure 177. Text Filter Dialog - List Tab

3BUF001094R4101 225

Using the Batch Data Dialog Section 2 DataDirect - Excel Data Access

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.

You may apply a NOT operator by clicking the NOT check box. This filters out values that match the pattern.

You can extend the filter with AND or OR clauses by clicking the Add Filter button. This is illustrated in Figure 179. When you click 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 178. Text Filter Dialog - Pattern Tab

Figure 179. Adding an OR Clause

226 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Batch Data Dialog

• Number Filtering - Choose a comparative operator from the pull-down list, then adjust the minimum and maximum numbers as required, Figure 180.

• 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 181.

Text filters case sensitive by default. You can make them not case sensitive by unchecking the Search Criteria is Case Sensitive check box on the PDL/Batch tab of the Options dialog. See Search Criteria is Case Sensitive on page 271. 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.

Figure 180. Number Filter Dialog

Figure 181. Date Filter

3BUF001094R4101 227

Using the Batch Data Dialog Section 2 DataDirect - Excel Data Access

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

You may also specify whether to sort the returned values in ascending or descending order. Clicking the Sort Order column for an item will display a pick list with the following choices: None, Ascending, and Descending, Figure 182. 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 182. Specifying Ascending or Descending Order for Columns

228 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Batch Data Dialog

Output Type

The radio buttons on the top right part of the dialog let you 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 183.

• 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). See Disable Functions on page 278.

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

• Data Only: executes the query on a one-time basis.

The Edit button is enabled when you select either DataDirect Formula or SQL Query. This lets you view and edit the function (or query) before it is executed. For further information, see Editing the Function or SQL Query on page 230.

Maximum Rows

When this box is checked, you can specify the maximum number of rows on the spreadsheet 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.

Figure 183. Output Types

If there are fewer values available than there are rows specified, the excess rows are left blank.

3BUF001094R4101 229

Using the Batch Data Dialog Section 2 DataDirect - Excel Data Access

Editing the Function or SQL Query

This dialog lets you edit the current function or SQL query, Figure 184.

For further guidelines, see:

• SQL Queries below

• DataDirect Functions on page 230

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 described 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

Figure 184. Editing the Function or Query

230 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Batch Data Dialog

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

You may 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 the section on configuring data providers in Industrial IT 800xA Information Management Configuration. Then you must enter the Batch_Views function manually, and modify the query to specify the new ADO data provider, Figure 185.

Figure 185. Editing the batch_Trend Query

Data provider Specification Added

3BUF001094R4101 231

Using the Production Data Log Dialog Section 2 DataDirect - Excel Data Access

Using the Production Data Log DialogThe PDL dialog, Figure 186, lets you query PDL tasks for production data.

Figure 186. PDL Dialog

When you use this dialog, you can not use the F9 function to re-calculate the workbook and retrieve new data. DataDirect does not provide an equivalent function for this dialog at this time.

232 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Production Data Log Dialog

Setting Up the PDL Interface

PDLs may be created by any one of four batch processing applications: Batch Management/Flexible (default), Batch 300, Taylor Control Language (TCL), or Profile Historian. You must specify PDL application via the PDL tab on the Options dialog. This tab also lets you 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 via the Options button. To configure these PDL parameters, refer to PDL/Batch on page 268. You must also specify the batch application for which messages will be logged. This is done via the Message tab (see Messages on page 283).

Opening the Dialog

Follow these basic steps to access history values with this dialog:

1. Select the starting cell 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 Message Log button in the tool bar, or choose DataDirect > Inform IT > Message Log from the menu bar, Figure 159.

Using the Dialog

Use the Search Criteria controls to retrieve the PDL tasks whose data you want to access. Any tasks meeting the specified criteria are displayed in the Search Results section. Use the controls in this section to drill up or down in the hierarchy for a selected task. You can then insert to selected task data into your spreadsheet via the Output Results button. Data for the selected task are also displayed in the Associated Data Listing below the Search Results.

Figure 187. Opening the Dialog

Menu

Corresponding Tool Bar Button

3BUF001094R4101 233

Using the Production Data Log Dialog Section 2 DataDirect - Excel Data Access

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 you are finished, Figure 188.

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 that you select in the Messages tab of the Options dialog (Messages on page 283).

When you change the Task Type specification, any previous results in the PDL dialog are cleared.

Figure 188. Search Criteria Section

For this release of the software, Batch 300 and TCL-specific criteria are automatically 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.

234 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Production Data Log Dialog

Task Value

This specifies the name of the task to query. If you do not specify a name, all tasks are returned. You can enter the complete name, or just a partial name. The wildcard character% 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 lets you specify a time range for the query. These fields can be enabled or disabled via their respective check boxes.

To restrict the query to a time range, you must 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.

The method of operation for the date and time fields is the same as for the History dialog. For further information see Time Span for Retrieval in Retrieving History Data on page 169.

By default, the End date/time are set to the current date and time when you open the PDL dialog. 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).

3BUF001094R4101 235

Using the Production Data Log Dialog Section 2 DataDirect - Excel Data Access

Limiting the Amount of Data Returned By Your Query

As a safeguard against retrieving an excessive amount of data, you can configure a limit for the number of rows to be returned for each query. This is done via 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 189 is displayed when the total number of rows satisfying the search criteria exceeds the specified limit.

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. See Messages on page 283.

• To accept the results as is and return to the PDL dialog, simply click OK.

If you don’t want to see this message each time you exceed maximum number of rows, click the check box. This remains in effect for the current Excel session.

Figure 189. Maximum Number of Retrieved Rows Exceeded Dialog

236 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Production Data Log Dialog

Search Results

This part displays a listing of tasks that meet your search criteria, Figure 190. 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 let you 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. See Drilling on page 238 for details.

To enter the PDL data into the Excel worksheet, click the Output Results button. See Output Results on page 240 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 190 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.

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.

Figure 190. Example, Search Results

3BUF001094R4101 237

Using the Production Data Log Dialog Section 2 DataDirect - Excel Data Access

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 191, let you move up and down the PDL hierarchy for a selected 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 unit R-101 in Figure 191, displays the phase-level search results for R-101, Figure 192.

Figure 191. Drill Buttons

Drill Buttons

238 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Production Data Log Dialog

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. You can only drill Down after a new search is performed.

Figure 192. Drill Down Example

3BUF001094R4101 239

Using the Production Data Log Dialog Section 2 DataDirect - Excel Data Access

Output Results

The PDL Output dialog, Figure 193, lets you enter PDL data into the Excel worksheet. 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 lets you format the output results.

Output Items

The Output Items grouping lets you 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.

Figure 193. PDL Output Dialog

240 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Production Data Log Dialog

Output Choices

The output choices lists the data categories that can be output for the selected item(s), Figure 194. The choices correspond with the data tabs provided on the PDL dialog in the Associated Data Listing and are described in Table 11.

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

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

If you do not place any entries in the Chosen Outputs list and click Apply or OK, the output will consist of the data as it appears in the Search Results listing on the PDL dialog.

Figure 194. Output Choices

Use these buttons to change the sequence

3BUF001094R4101 241

Using the Production Data Log Dialog Section 2 DataDirect - Excel Data Access

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 you choose to output History Values (actual History data). It lets you 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.

Table 11. 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.

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.

242 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Production Data Log Dialog

When you submit an output request, the number of queries to be executed is estimated. If the estimate is above 20, you are prompted to confirm whether or not to continue with the request.

If you choose to continue, 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 query(s) are allowed to complete; however, all remaining queries are canceled.

An example output result is shown in Figure 195.

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.

Figure 195. Example, PDL Output

3BUF001094R4101 243

Using the Production Data Log Dialog Section 2 DataDirect - Excel Data Access

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

If the DataDirect client PC has History Client software installed, the Modify button will be enabled. This lets you modify PDL variables.

To modify a variable, select the variable, then click Modify. In the Modify PDL dialog, Figure 197, enter the new variable value. The time stamp defaults to the current date and time. You can modify the time stamp if necessary. You can also enter a comment to associate with the modified value.

Figure 196. Example, Variables Tab

Figure 197. Modify PDL Dialog

244 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Production Data Log Dialog

Click OK when you are finished with the dialog. The new value and time stamp are written to the RESULTVALUE and FRESULTTIME attributes in the pdl_variable_view. These values are also displayed in the Result Value and Result Time columns on this tab, Figure 198.

Resources

This tab displays: Resource Type, Name, Value, Time and Occurrence. The rows are sorted by Type, then by Name, then by Occurrence, Figure 199.

Figure 198. Modify Results

Figure 199. Example, Resources Tab

3BUF001094R4101 245

Using the Production Data Log Dialog Section 2 DataDirect - Excel Data Access

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

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 via 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 201.

When the PDL type is specified as Produce IT Batch or Batch Management/Flexible, the time is displayed in UTC time rather than local time.

Figure 200. Example, Messages Tab

246 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Production Data Log Dialog

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.

Clicking the Trend Display button launches the Trend Display view of the selected log.

Figure 201. Example, History Tab

3BUF001094R4101 247

Using the Production Data Log Dialog Section 2 DataDirect - Excel Data Access

Clicking View displays the PDL History Data dialog, Figure 202. This dialog provides 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.

Clicking Copy to Clipboard copies the entire contents of the listing into the computer’s clipboard. Each line is separated by a carriage control character. Each column value is separated with a tab within the line.

Figure 202. Viewing PDL History Data

248 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Using the Production Data Log Dialog

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

Printing a Screen Dump of the PDL Dialog

If your computer is connected to a printer, the printer button is displayed below the Cancel button, Figure 204. 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 203. Example, Next Level Tab

Figure 204. Printer Icon

Clicking PrinterIcon Producesa Screen Dump

3BUF001094R4101 249

Retrieving Data by SQL Query Section 2 DataDirect - Excel Data Access

Retrieving Data by SQL QueryThe SQL Query dialog, Figure 205, lets you build ad-hoc SQL queries and display the results in your Excel Spreadsheet. It also lets you save and re-use queries. The saved queries may be used in this dialog, or in the ABBSQL function (ABBSql on page 330). This dialog may be used either on a node where the 800xA core software is installed, or on a remote PC 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. If you want to use this dialog to query historical and process objects on a Windows-based data server, you must install the Open Data Access (ODA) option on the data server, and configure an ADO data provider to support ODA.

To enter an SQL query:

1. Click on the starting cell where you want to display the query results.

2. Open the SQL Query dialog. To do this, click the SQL button, or choose DataDirect > SQL Query from the menu bar. If you are not already logged in, you will be prompted to log in now. See Login on page 98.

3. The selected starting cell is indicated in the Start Cell field. You can use this field to change the Start Cell if necessary.

Figure 205. SQL Query Dialog

250 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Retrieving Data by SQL Query

4. Use the Output radio buttons to specify whether to execute a one-time (ad-hoc) data query, or insert a reusable formula.

5. Select the number of values to be returned in the Number of Values field. This lets you set the maximum number of responses to a manageable quantity.

You can 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. If you enter the number of values directly, the largest possible number is 65,534.

6. Click the Insert check box if you need to ensure that existing data are not overwritten by new data.

7. Enter the query in the SQL Statement window.

As an option you may 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 252.

If you want to be prompted to save a new query before you run the query or when you close 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 262 DO NOT apply to SQL queries. An example query result is shown in Figure 206.

Figure 206. Example Query Result

For complex queries, you may need to increase the Timeout interval. Click the Options button to display the Options dialog. For details refer to Timeout in Setup on page 273.

3BUF001094R4101 251

Saving and Re-using SQL Queries Section 2 DataDirect - Excel Data Access

Saving and Re-using SQL QueriesIf you want to save the query that you are currently entering for re-use later, click the Save icon in the upper right corner of the dialog, Figure 207.

Save SQL Query

This displays the Save dialog, Figure 208. Enter a name for the query, then click OK.

Open SQL Query

To open an existing query, click the Open icon in the upper right corner of the dialog, Figure 209.

Figure 207. Save Icon

Figure 208. Saving a Query

Figure 209. Open Icon

Save Icon

Open Icon

252 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Saving and Re-using SQL Queries

This dialog, Figure 210, lets you select an existing query to re-use in the SQL Query dialog. You may also delete a selected query, and toggle 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 if you want to use the query by name rather than the actual query. If you use the named query, if the named query is modified the modifications will be implemented whenever you use a spreadsheet with the named query. If you use the actual query (Use Named Query not checked), you will be required to make the changes in all spreadsheets that use the query.

To delete an existing query, select the query then click the Delete icon, Figure 210.

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 date and time when the query was last saved, and the full query text. Figure 210 shows the detailed view.

Figure 210. Open Query Dialog

Click here todelete the selectedquery

Click to list queries byname without details

Click to list queries byname with details

3BUF001094R4101 253

Retrieving Values for TCL Unit Arrays Section 2 DataDirect - Excel Data Access

Retrieving Values for TCL Unit ArraysThe TCL Unit Array command can only be used when conected 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.

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

To get TCL Unit Array data:

1. Use the Values field to set the maximum number of responses to a manageable quantity. You can 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. If you enter the number of values directly, the largest possible number is 65,534. If the array has fewer elements than the specified Number of values, only the actual number of elements will be returned.

2. Use the Select Object File field, if necessary, to change the text file for the TCL Object pick list.

When you use this dialog, you can not use the F9 function to re-calculate the workbook and retrieve new data.

Figure 211. Opening the Dialog

Menu Tool Bar Button

254 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Retrieving Values for TCL Unit Arrays

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:

• Changing the Start Cell on page 103

• Inserting or Overwriting Rows on page 104

• Formatting on page 107

Figure 212. TCL Unit Array Dialog

3BUF001094R4101 255

Using the OPC Browser Section 2 DataDirect - Excel Data Access

Using the OPC BrowserThe OPC browser lets you 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 you use the browser. For example Figure 213 shows the browser associated with the History Values dialog.

This section describes browser operation using the History Values dialog an example. The procedures in this section also apply when using the browser with the Process Values dialog. Refer to the referenced sections below:

• Navigation Methods on page 257

• Filtering on page 258

• Copying Items on page 259

• Considerations for History Access on page 259

Figure 213. Example, OPC Browser

OPC Browser inHistory Values Dialog

256 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Navigation Methods

Navigation MethodsUse the left pane to browse the connected server’s directory structure to find the folder(s) where the data objects reside. The applicable objects within the selected folder(s) will be displayed in the right pane. The type of object displayed depends on where you are using the browser - from the Process or History Values dialog.

Two navigation options are supported. Selecting a specific folder shows the applicable objects within that folder. As an alternative you can use the Get Entire List function. This gets not only the objects in the selected folder, but also objects from sub-folders within the selected folder. To get the entire list, select the folder, then right-click and choose Get Entire List, Figure 214.

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 you accidentally request an excessive number of objects, you can abort the Get Entire List request by selecting Abort Get Entire List from the context menu.

Figure 214. Example, Get Entire List

Get Entire List Result

Getting Entire List of Tags UnderAC800M6ProcessValues Folder

Abort Get Entire List

3BUF001094R4101 257

Filtering Section 2 DataDirect - Excel Data Access

Filtering You can narrow the scope of items returned by the Get Entire List method by specifying a filter. This helps you 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

Checking the Exclude Filtered Items check box retrieves all items whose names DO NOT meet the filter criteria. For example, clicking this check box with the filter text IM will get all items whose names do not include the IM text string. Figure 215 shows two filter examples.

Figure 215. Example, Filter

Basic FilterGet items with IM text string

Same Filterusing ExcludeCheck Box

258 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Copying Items

Copying ItemsThe Copy Item(s) function in the context menu lets you copy the selected items to the clipboard. From there you can paste the items into an external data access application such as Crystal Reports. To do this, right-click and choose Copy Item(s) as shown in Figure 216.

Considerations for History AccessWhen using the browser for History access, the contents of the left pane varies, depending on the type of OPC HDA server, Figure 217. For AIPHDA, the browser provides a directory structure similar to the Plant Explorer. The view includes all structures and directories where log aspects reside.

For IMHDA, the left pane lets you choose one of three paths or categories by which to conduct your search:

• EH lets you access logs that are local to the data provider to which you are connected. This is the fastest method and is recommended if you are querying a log that resides on the local server. It supports the ability to modify existing log entries, but not to add new entries.

• EH_NET lets you access logs on all servers on the network. This requires OMF access to be extended on the TCP/IP network. This is described in Industrial IT 800xA - Information Management Configuration. It supports the ability to modify existing log entries, and add new entries.

• EH_PUBL lets you access archived log data that is published. For instructions on publishing archived data, see Publishing an Archive Volume on page 697.

Figure 216. Copying Items

3BUF001094R4101 259

Considerations for History Access Section 2 DataDirect - Excel Data Access

Seamless Retrieval for AIPHDA

With the AIPHDA server, you can use the Seamless retrieval option when you are not sure which log in a property log hierarchy will provide the best coverage for the requested 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, check the Seamless check box.

Figure 217. Browsing for Property Logs

View for AIPHDA

View for IMHDA

260 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Configuring Options

Configuring OptionsData formatting, communications, and file setup options have default settings so you can begin using DataDirect without having to do any preliminary set up. If you want to change any of these options, use the Options dialog. This dialog is displayed when you click the Options button, Figure 218, or choose DataDirect > Options from the Microsoft Excel menu bar.

The configurable options are grouped on six tabs:

• Use the Data Format tab to configure orientation and data options. For instance, this tab lets you 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 via data providers, enabling/disabling write access to process and history values, and specifying the History server for bulk data export.

• 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 also lets you configure the default time span for queries.

Figure 218. Options Button

3BUF001094R4101 261

Data Format Section 2 DataDirect - Excel Data Access

Data FormatThis tab, Figure 219 lets you specify:

• whether or not you want to show Attributes as Headers.

• whether or not to use Long Format

• whether to use a Horizontal List or Vertical List

• whether or not to include Headers

• whether or not to show Object Names

• whether or not to show the History Log Calculation

• whether or not to provide a Time Stamp for each entry in the list

• the Date and Time Formatting for the Time Stamp (if you choose to include the time stamp)

• whether or not to include Attribute Names

• whether or not to provide an indication for History Data Quality

• if you provide an indication for History Data Quality, whether to show it as Symbolic or Numeric

• whether or not to Autofit All Columns

The Restore Defaults button in the Options dialog restores the defaults for the currently selected tab.

262 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Data Format

Horizontal List

If you choose Horizontal List, attributes are listed horizontally and objects are listed vertically. An example is shown in Figure 220.

Vertical List

If you choose Vertical List, attributes are listed vertically and objects are listed horizontally. An example is shown in Figure 220.

Figure 219. Options Dialog, Data Format Tab

3BUF001094R4101 263

Data Format Section 2 DataDirect - Excel Data Access

Attributes as Headers

When this orientation option is selected, the names of the selected attributes are used as column headers (for Horizontal List) or row headers (for Vertical List). An example is shown in Figure 220.

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

Headers

When this option is selected, headers are included in the list.

Figure 220. Example, Using Attributes as Headers

Figure 221. Example, Long Format

Horizontal Orientation

Vertical Orientation

264 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Data Format

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

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.

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.

3BUF001094R4101 265

Data Format Section 2 DataDirect - Excel Data Access

Time Stamp

When this option is selected, a time stamp is provided for values that have an associated time stamp, for instance History objects.

Date and Time Formatting

These fields let you specify the date and time formats. These formats apply to date and time presentation in the Excel spreadsheets. The available formats are shown in Figure 222.

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.

Figure 222. Date and Time Formatting

Date

Time

266 3BUF001094R4101

Section 2 DataDirect - Excel Data Access View

ViewThe View tab, Figure 223, lets you select which add-in tools to show or hide on the DataDirect tool bar and menu bar. Add-in tools are grouped in three categories:

• Industrial IT for use in the 800xA system

• Inform IT for use with earlier platforms, and when using DataDirect on a remote PC 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. You can restore the default settings at any time by clicking Restore Defaults. Figure 223 shows the default settings when you initially install DataDirect on an 800xA system node.

Figure 223. View Tab

3BUF001094R4101 267

PDL/Batch Section 2 DataDirect - Excel Data Access

PDL/BatchThis tab, Figure 224, lets you specify:

• Type of PDL (Batch Management/Flexible, 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

• Allow PDL Updates

Figure 224. PDL/Batch Tab

268 3BUF001094R4101

Section 2 DataDirect - Excel Data Access PDL/Batch

Type of PDL

Use this pick list to specify the PDL application: Batch Management/Flexible (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 (Configuring Options on page 261). Task types for the various PDL applications are indicated in Table 12.

Configuring Flexible Task Types

The Batch Management/Flexible option in the Type of PDL pick list lets you configure up to 15 user-defined task types. Selecting this option enables the Customize button, Figure 225.

Table 12. Resulting Task Type Options Based on Type of PDL Selected

Type of PDL Task Type Options

Batch Management/Flexible(Default) Up to 15 user-configurable task types. See Configuring Flexible Task Types on page 269 for details.

Produce IT Batch version 1.1 (and 1.2/0) Campaign - Level 0 Batch - Level 1 Procedures Level 1 - Level 2,3 Procedures Level 2 - Level 3,12 Phase - Level 12

Batch 300 Job, Batch, Unit, Phase

TCL TCL Batch

Profile 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. If you are using Produce IT batch version 1.2/1 or later, or 800xA Batch Management select the Batch Management/Flexible PDL Type.

3BUF001094R4101 269

PDL/Batch Section 2 DataDirect - Excel Data Access

This button displays the Customize PDL Hierarchy dialog, Figure 226. Each level has a default name. You can change these names. You can also choose which levels to include in the Task Type list in the PDL dialog by checking the corresponding checkbox. Any level whose checkbox is checked is included in the list.

Figure 225. Selecting Flexible Type of PDL

Figure 226. Customize PDL Hierarchy Dialog

270 3BUF001094R4101

Section 2 DataDirect - Excel Data Access PDL/Batch

Search Time Span

The Search Time Span fields let you specify a default time span for the queries you execute 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 you always use the same time span, you will not have to adjust the start or end times in the PDL or Batch Data dialog. 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. You can 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 lowercase values. The default is Unchecked (do not convert to uppercase).

Use Restored Archive

This lets you 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 lets you edit the names of the functions that are displayed in the Functions list on the Batch Data dialog, Figure 227. The actual function names (as indicated in the Function Name column) are fixed and cannot be changed. You are permitted to change the name in the Readable Name column. This is the text which is used in the Functions list on the dialog. You may also change the minimum and maximum values for numeric filters for each function.

3BUF001094R4101 271

PDL/Batch Section 2 DataDirect - Excel Data Access

The View name is provided for reference. This is the name to use if you choose to enter a function call manually.

When you click an editable field on this dialog, the background turns grey, and the field becomes an edit box as shown in Figure 227.

The Search Criteria is Case Sensitive check box lets you 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 lets you specify the maximum number of rows to be returned to the client for each query that is executed. This helps you avoid hanging the client PC by generating queries that return an excessive number of rows. The range is 1 to 65,534. The default is 500.

Figure 227. Batch Data Functions Options

272 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Setup

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.

Allow PDL Updates

The Allow PDL Updates check box let you enable/disable write access to PDL variables in the Inform IT PDL dialog (this functionality is not supported in the Batch Management/PDL Batch Data dialog). You must be logged in as an Administrator-level user to change this setting.

This authority is also controlled by data server and user:

• At the data server level, the ADO data provider must be configured to allow write transactions. This is the default set-up. If you want to verify this set-up, refer the section on configuring data providers in Industrial IT 800xA - Information Management Configuration.

• On the user level, individual users must be authorized to add or modify. This is configured in the user preference file. By default, users are NOT granted this authority. To adjust this preference for a user, refer to the section on managing users in Industrial IT 800xA - Information Management Configuration.

SetupThis tab, Figure 228, lets you configure the following communications settings:

• Data Provider Connections

• Enable/Disable Write Access to History and Process Values

• Port Number

• Timeout

• Write Debug File

• Disable Functions

• History Server (required for Bulk Data Export option on History Values dialog)

3BUF001094R4101 273

Setup Section 2 DataDirect - Excel Data Access

Data Provider Connections

The Inform IT and Batch Data tools access data via data providers which are managed via 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 let you select which data providers to use for ad-hoc requests via 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. If you have special requirements, for example if you need write access to historical data, you can

Figure 228. Options Dialog, Setup Tab

274 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Setup

change the default set-up. To do this select the data provider via the Named Data Provider pull-down lists, Table 13.

Table 13. 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 via 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. See Appendix C, Using the IM OPC HDA Server.

• 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 via 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.

If you need to configure a data provider, refer to the section on Configuring Data Providers for display and client services in Industrial IT 800xA - Information Management Configuration.

Data from a DCS data provider will be unavailable and its type set to UNK (unknown) 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.

3BUF001094R4101 275

Setup Section 2 DataDirect - Excel Data Access

Name or Channel Number

DataDirect can reference data providers using either the Channel Number or -name argument. The default setup is to use -name. You must reference data providers by -name when accessing data from the 800xA system, or any platform later than Enterprise 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

• and history bulk data retrieval

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 you specify an invalid channel, the request defaults to channel 0. If you do not want use channel 0 as the default for an invalid channel specifications, you must insure that no data providers are assigned channel 0.

276 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Setup

Enable/Disable Write Access to History and Process Values

The Allow History Updates and Allow Process Updates check boxes let you enable/disable write access to history logs and process objects respectively. You must be logged in as an Administrator-level user to change these settings.

For the Industrial IT versions of the History and Process Values dialogs, user authority must be configured in the aspect system to allow you to update log objects. This is described in Industrial IT 800xA System Security.

For the Inform IT History and Process values dialogs, this authority is also controlled by data server and user:

• At the data server level, the applicable data provider must be configured to allow write transactions. This is the default set-up. If you want to verify this set-up, refer the section on configuring data providers in Industrial IT 800xA - Information Management Configuration.

• On the user level, individual users must be authorized to add or modify. This is configured in the user preference file. By default, users are NOT granted this authority. To adjust this preference for a user, refer to the section on managing users in Industrial IT 800xA - Information Management Configuration.

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. You may need to increase the timeout interval if your application uses complex SQL queries.

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

3BUF001094R4101 277

Setup Section 2 DataDirect - Excel Data Access

Write Debug File

When this option is selected DataDirect writes status information to a text file that you can read when troubleshooting. The file name is debug.txt. This file is located in “%ABB_ROOT%InformIT\DataDirect\tmp”1.

Disable Functions

When this check box is selected, all DataDirect functions in the Excel spreadsheet are disabled. Functions must be disabled when you insert functions as described in Configuring Options on page 261. The functions must be enabled when you execute a specific function, or calculate the entire workbook.

History Server

The Bulk Data Export function must know the platform for the History server (Windows or HP-UX), and the location where History is installed. For HP-UX, the install path is fixed and cannot be changed. For Windows 2000, the default install path is provided. If you chose to install History in a different location, you can enter the correct path in the History Server Install Path field.

1. The default path for %ABB_ROOT% is: C:\Program Files\Abb Industrial IT\

Any time you disable and then re-enable functions, all functions in the spreadsheet must be executed individually before you can use the F9 key to calculate the entire workbook.

278 3BUF001094R4101

Section 2 DataDirect - Excel Data Access File Setup

File SetupThe File Setup tab is only applicable for Inform IT tools in DataDirect. This tab is NOT applicable for Industrial IT tools. Use the File Setup tab, Figure 229, to manage text files for object and attribute pick lists in the ad-hoc data retrieval/entry dialogs, as well as the data provider pick lists on the Setup tab in the Options dialog. The operations supported by this tab are:

• Changing the Text File Specification for a Pick List• Editing a Text File• Setting Object Name and Alias Options• Deleting/Retaining Bulk Data Temporary Files• Auto-Creating a Text File

Figure 229. File Setup Tab

3BUF001094R4101 279

File Setup Section 2 DataDirect - Excel Data Access

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. If you want to use a different text file, you can enter a new path specification directly in the Name field, or you can use the Browse button to navigate to and select a different file.

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, see Configuring Pick Lists for Advant OCS Objects on page 284.

Setting Object Name and Alias Options

These three radio buttons let you 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

Deleting/Retaining Bulk Data Temporary Files

When the Bulk Data Export brings bulk History data into your spreadsheet, it creates an intermediate ASCII file. You can specify whether to retain or delete the 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.

If you choose one of the alias options (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.

280 3BUF001094R4101

Section 2 DataDirect - Excel Data Access File Setup

Auto-Creating a Text File

The Auto Create function lets you create new text files for database fields associated with the Message Log Type.

To auto create a text file select one of the Message Log types, and then click the Auto Create button, Figure 230.

This displays the Auto Create dialog, Figure 231.

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.

Figure 230. Launching the Auto Create Function

3BUF001094R4101 281

File Setup Section 2 DataDirect - Excel Data Access

The Log Name and Database Field settings in this dialog 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 instances of the tag TC101, only one entry for that tag is returned.

The Filter edit box lets you 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. You can 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 lets you open the specified file in the notepad text editor.

Figure 231. Auto Create Dialog

282 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Messages

MessagesThis tab lets you configure message viewing options, Figure 232.

• 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 specifies both MOD 300 and Master.

• Query Time Span - specifies the default time span for message queries. This time span can be changed when you actually generate the message query as described in Using the Industrial IT Alarm/Events Dialog on page 198.

• 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

Figure 232. Messages Tab

3BUF001094R4101 283

Configuring Pick Lists for Advant OCS Objects Section 2 DataDirect - Excel Data Access

Configuring Pick Lists for Advant OCS ObjectsWhen 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, you must 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. You can customize these pick lists to better fit your object/attribute selection requirements. This is done by creating new text files and then associating those text files with the corresponding pick lists. This procedure is described in Populating Pick Lists on page 285.

284 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Populating Pick Lists

Populating Pick ListsText 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_ROOT%InformIT\DataDirect\etc”.1

A set of standard text files are provided with DataDirect as described in Table 14. These standard files are not complete, and are only intended as a starting point. You can create additional files to customize object selection for your application. For instance, you can create a file structure such as the one shown in Figure 233 to follow your specific plant structure. The default text file for each type of pick list is specified via the Options dialog File Setup tab.

1. The default path for %ABB_ROOT% is: C:\Program Files\Abb Industrial IT\

Table 14. Standard Text Files

Category Description Standard Files

Object Type File

Populates object type pick lists for all dialogs that require an object type specification. For an example, see Selecting the Object Type in Reading Process Values on page 124.

• ModObjectTypes.txt• MasterObjectTypes.txt

Object File Populates object pick lists for all dialogs that require an object specification. This along with the selected object type determine the contents of the object pick list. You can use the Object File pick list to select a different text file.

• ModObjects.txt • MasterObjects.txt

Attribute File Populates the attributes pick lists for all dialogs that require an attribute specification.

• ModAttributes.txt• MasterAttributes.txt

History Object File

Populates the object pick list for the History Value dialog. You can use the Object File pick list to select a different text file. For an example, see Log Calculation Algorithm in Retrieving History Data on page 169.

• ModHistoryObjects.txt • MasterHistoryObjects.txt

3BUF001094R4101 285

Populating Pick Lists Section 2 DataDirect - Excel Data Access

Message Log Files

These files populate the following drop down menus in the Message Log dialog.

• TagNames.txt• 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 with object names where ever object names are used.

• ModObjects with Aliases.txt • MasterObjects with

Aliases.txt

Data Providers This file populates the data provider pick lists on the Setup tab.

• DataProviders.txt

Figure 233. Organizing Text Files According to The Plant Structure

Table 14. Standard Text Files

Category Description Standard Files

Object Text Filesfor Area1-Unit1

286 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Populating Pick Lists

Guidelines for Creating New Text FilesFollow 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. You are 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 - When you create an object text file, you can associate a specific object type with each object. To do this, use the following format: object name, object type, Figure 234.

When you associate a specific object type with an object, the object will only be included in the Object pick list when the corresponding object type is selected. If you do not associate an object type with an object, the object will always be included in the Object pick list, no matter which object type is chosen.

• 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 50 for details regarding log name syntax.

Figure 234. Example Text Files

DO NOT enter a comma (,) after the object name unless you are also specifying an object type.

Example MOD 300 Object Text File Example Master Object Text File

3BUF001094R4101 287

Populating Pick Lists Section 2 DataDirect - Excel Data Access

• 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 separate line. For example in Figure 235, there are two DCS (real-time data) data providers. One is named DCS (the default). The second is named DCS2.

Applying New Default Files

The default text files for all pick lists are specified via the File Setup tab on the Options dialog. You can change these defaults as required. For details, refer to File Setup.

Figure 235. Example, Data Provider Text File

Data Provider NameData Provider Type

288 3BUF001094R4101

Section 2 DataDirect - Excel Data Access Populating Pick Lists

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. An example is shown in Figure 236.

Aliases are optional, and apply only to Object and History object text files. If you create the object text file with aliases, you can use the Options File Setup tab to specify whether to show just aliases, just object names, or both aliases and object names.

Figure 236. Example - Using Both Aliases and Object Names

Object Names

Aliases

Excel Output withBoth Alias & Object Name

3BUF001094R4101 289

Populating Pick Lists Section 2 DataDirect - Excel Data Access

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

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

These Lines HaveAliases Configured

290 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions

You can use the DataDirect functions listed in Table 15 to build a report. For many of these functions you may enter them manually in the spreadsheet, or use the Formula option in the equivalent dialog.

There are two methods for applying these functions.

• Inserting Functions Directly in the Spreadsheet - To insert the functions directly in an Excel spreadsheet, refer to Inserting Functions in the Spreadsheet on page 293.

Guidelines for re-executing a spreadsheet are provided in Updating the Excel Spreadsheet on page 298.

• VBA Macros - If you are capable of programming in VBA, you can write macros that reference these functions. By embedding the functions in the macros, they are not automatically executed when the spreadsheet is opened. This gives you the capability to archive 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 335.

• If you have DataDirect installed in two different locations and you want to exchange worksheets between the two installations, use the Update Function References utility to make the worksheets compatible. Refer to Updating Function References in Worksheets on page 90.

• DataDirect stops updating functions when focus is shifted from the spreadsheet. The Excel spreadsheet must maintain focus while the report is running (retrieving data).

3BUF001094R4101 291

Section 3 DataDirect - Excel Data Access Functions

Storing Report Templates

The Excel files that you create to use 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 lets you browse for report files via the Plant Explorer, and also lets you apply version control and electronic signatures to report files. When you are finished building a report, refer to Storing, Updating and Scheduling Reports on page 298 for further guidelines.

Table 15. List of Functions

Application Function

Reading and Writing Process ValuesFor a quick overview, see Functions for Reading/Writing Process Values on page 299.

ABBGetOPCDASimple on page 300 ABBGetOPCDA on page 301 ABBWriteOPCDA on page 302 ABBGetObj on page 303 ABBUpdateObj on page 304

Reading and Writing History ValuesFor a quick overview, see Functions for Reading/Writing History Values on page 306.

ABBGetOPCHDA on page 307 ABBGetOPCHDAAggregates on page 310 ABBWriteNOPCHDA on page 311 ABBWriteOPCHDA on page 313 ABBGetOPCHDAAttributes on page 315 ABBGetOPCHDAAttributeValue on page 316 ABBGetHistory on page 319 ABBEditLog on page 322 ABBEditNLogs on page 324 ABBGetAttributes on page 326 ABBGetAttributeValue on page 326

Reading MessagesFor a quick overview, see Functions for Reading Messages on page 328

ABBAERetrieval on page 328

Miscellaneous FunctionsFor a quick overview, see Miscellaneous Functions on page 330

ABBSql on page 330 ABBArray on page 332 ABBConnect on page 334 ABBDisconnect on page 334 Using VBA Macros on page 335 Adding Charts to DataDirect Reports on page 336

292 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions Inserting Functions in the Spreadsheet

Inserting Functions in the SpreadsheetWhen you insert functions in the spreadsheet, you must execute each function at least once as you insert them.

To insert a function call, the workbook must be in manual mode. DataDirect sets the workbook to manual mode by default. You may confirm this setting as described in Putting the Workbook in Manual Mode on page 294. You can either use the Excel Function wizard, or you can insert function calls manually.

• To use the Excel Function Wizard, see Inserting DataDirect Functions with the Function Wizard on page 295.

• To insert functions manually, see Inserting DataDirect Functions Manually on page 297.

While the cursor is in the formula bar, pressing F9 after inserting or changing a function will cause Excel to hang.

You can use the Excel Chart Wizard to add charts in a DataDirect report. See Adding Charts to DataDirect Reports on page 336.

3BUF001094R4101 293

Inserting Functions in the Spreadsheet Section 3 DataDirect - Excel Data Access Functions

Putting the Workbook in Manual Mode

When you use one of these functions in an Excel spreadsheet, make sure that your workbook calculation mode is set to Manual. To do this:

1. Choose Tools > Options from the Excel menu bar. This displays the Excel Options dialog.

2. Click the Calculation tab.

3. Select the Manual calculation option and click OK, Figure 238.

Figure 238. Excel Options Dialog, Calculation Tab

294 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions Inserting Functions in the Spreadsheet

Inserting DataDirect Functions with the Function Wizard

To use the Excel function wizard to set up your functions:

1. Make sure the workbook is in Manual calculation mode as described in Putting the Workbook in Manual Mode on page 294.

2. Make sure Disable Functions is checked on the DataDirect Options dialog. See Setup on page 273.

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.

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

6. Select the function that you want to insert. This displays a dialog for specifying the selected function’s parameters. For example, if you selected ABBGetOPCHDA, the dialog shown in Figure 240 is displayed.

Figure 239. Paste Function Dialog

3BUF001094R4101 295

Inserting Functions in the Spreadsheet Section 3 DataDirect - Excel Data Access Functions

7. Enter a specification for each parameter. Be sure to embed text strings (for example, object names) in double quotes. Refer to the applicable function description for details. See Table 15.

8. Click OK when you are finished with the Parameters dialog.

9. Repeat steps 3-8 for as many functions as you need to insert.

10. Go back to the DataDirect Options dialog, and un-select Disable Functions. See Setup on page 273.

11. You must execute each function once, before you can use the F9 key to calculate the entire workbook.

Figure 240. Function Specification Dialog

Any time you disable and then re-enable functions, all functions in the spreadsheet must be executed individually before you can use the F9 key to calculate the entire workbook.

The Excel spreadsheet must maintain focus while the report is running (retrieving data).

296 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions Inserting Functions in the Spreadsheet

• For each function that returns multiple values (for example, ABBGetOPCHDA):

a. Select the cell where the function is defined.

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

a. Select the cell where the function is defined.

b. Put the cursor in the formula bar.

c. Press ENTER.

Inserting DataDirect Functions Manually

For functions that return multiple values (for example, ABBGetOPCHDA):

1. Make sure the workbook is in Manual calculation mode as described in Putting the Workbook in Manual Mode on page 294.

2. Select a range of cells. For example, you may select an area on your worksheet that is 3 columns wide and 500 rows long.

3. Enter the function according to the function syntax. Refer to Table 15. 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):

1. Make sure the workbook is in Manual calculation mode as described in Putting the Workbook in Manual Mode on page 294.

2. Select a cell.

3. Enter the function according to the function syntax. Refer to Table 15. Each parameter must be separated by a comma. Strings must be in double-quotes (").

4. Press ENTER to run the function.

3BUF001094R4101 297

Storing, Updating and Scheduling Reports Section 3 DataDirect - Excel Data Access Functions

Storing, Updating and Scheduling ReportsReports may be scheduled via the 800xA system scheduler. For details see Section 5, 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 lets you browse for report files via the Plant Explorer, and also lets you apply version control and electronic signatures to report files.

The first time you save a report, use the File>Save As command from the Excel menu bar. This lets you enter a unique name for the report, and specify the path where you want to save the report. Each time you run the report, if you want to save multiple instances, use File>Save As to enter a unique name for each instance. If you do not need to save each instance, use File>Save instead.

Updating the Excel Spreadsheet

The purpose of using functions (or dialog in the formula mode) is to create a spreadsheet that will be updated each time it is opened or executed via the Application Scheduler. You can also update the spreadsheet 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 you must use the Calculate Full function in Microsoft Excel. Calculate Full will update all functions on the spreadsheet, including Inform IT functions. Refer to the on-line help for Microsoft Excel for instructions on using Calculate Full.

If you intend to schedule and execute reports 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. DataDirect sets the calculation mode to Manual by default. To check the mode and change it if necessary, see Putting the Workbook in Manual Mode on page 294.

298 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions Functions for Reading/Writing Process Values

Functions for Reading/Writing Process ValuesDataDirect provides two sets of functions for reading and writing real-time process values. The Industrial IT functions let you query aspect objects in the 800xA system. With the proper authority you can also update process values. These functions will only run on 800xA system nodes that have core 800xA software installed (Aspect Servers, Connectivity Servers, Application Servers, and Workplace Clients). Further, these functions will not work with Excel versions before Office 2000.

If you are running DataDirect on a PC that does not have 800xA core system software (a remote Desktop Tools client), you must 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 you need to connect to a server that is outside the 800xA system, for example an earlier Enterprise Historian server. This lets you query objects on that server that are not a part of the 800xA system. This functionality is not supported by the Industrial IT functions.

Industrial IT Functions for Process Values

• ABBGetOPCDASimple on page 300 (Read value for one object)

• ABBGetOPCDA on page 301 (Read value for multiple objects)

• ABBWriteOPCDA on page 302 (Write to an object)

Inform IT Functions for Process Values

• ABBGetObj on page 303 (Read value for one object)

• ABBUpdateObj on page 304 (Write to an object)

3BUF001094R4101 299

ABBGetOPCDASimple Section 3 DataDirect - Excel Data Access Functions

ABBGetOPCDASimpleThe ABBGetOPCDASimple function will return real-time object data for one OPCDA item.

The syntax for this function is described below:

=ABBGetOPCDASimple(ObjectName [,Server])

where:

ObjectName is the object name. You can use the OPC browser to find objects in the aspect directory. The browser lets you copy and paste the object names to ensure the name is specified correctly. See Section 7, Browsing for OPC Tags.

[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.AfwOPCDASurrogate")

For instructions on inserting functions, see Inserting Functions in the Spreadsheet on page 293.

This function requires 800xA core system software to be installed on the PC where you are running DataDirect. If you need to query objects on a server that is not part of the 800xA system, use ABBGetObj on page 303.

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.

300 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBGetOPCDA

ABBGetOPCDAThis 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 specified data for all and cause all cells to be populated with the correct data. You may also use the Industrial IT Process Values dialog in the Formula mode to insert this function (Using the Industrial IT Process Values Dialog on page 110).

The syntax for this function is described below:

=ABBGetOPCDA(ObjectName[,bTS] [,Server])

where:

ObjectName is object name. You can use the OPC browser to find objects in the aspect directory. This lets you copy and paste to ensure the name is specified correctly. See Section 7, Browsing for OPC Tags.

[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

[Server] specifies the OPCDA server ProgID. This defaults to the 800xA 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.AfwOPCDASurrogate")

For instructions on inserting functions, see Inserting Functions in the Spreadsheet on page 293.

This function requires 800xA core system software to be installed on the PC where you are running DataDirect. If you need to query objects on a server that is not part of the 800xA system, use ABBGetObj on page 303.

3BUF001094R4101 301

ABBWriteOPCDA Section 3 DataDirect - Excel Data Access Functions

ABBWriteOPCDAThe ABBWriteOPCDA function lets you update process values.

The syntax is as follows:

=ABBWriteOPCDA (objname, value, [,Server])

where:

ObjName is the object name. You can use the OPC browser to find objects in the aspect directory. The browser lets you copy and paste the object names to ensure the name is specified correctly. See Section 7, Browsing for OPC Tags.

Value is the new value to be applied to the specified attribute.

[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, 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.AfwOPCDASurrogate")

For instructions on inserting functions, see Inserting Functions in the Spreadsheet on page 293.

This function requires 800xA core system software to be installed on the PC where you are running DataDirect. If you need to write to an object on a server that is not part of the 800xA system, use ABBUpdateObj on page 304.

302 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBGetObj

ABBGetObjThe ABBGetObj function retrieves the specified attribute value for the specified object. You may also use the Inform IT Process Values dialog in the Formula mode to insert this function (Using the Inform IT Process Values Dialog on page 122). 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. You can use the object browsing tools in the Process Values dialog to find object names for the specified object type. See Selecting OPC Tags on page 125.

[Attribute] is the name of the attribute whose value you want to retrieve. The attribute specification is NOT required for queries on OPC objects. The Value attribute is always returned.

[data provider] specifies the name of the data provider through which this query will 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 see Data Provider Connections on page 274.

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

For OPC object values, the data provider must be referenced using the -name argument and not the channel number. The Use Channel Numbers option must NOT be selected in the Setup tab of the Options dialog.

3BUF001094R4101 303

ABBUpdateObj Section 3 DataDirect - Excel Data Access Functions

ABBUpdateObjThe ABBUpdateObj function lets you update process values. This is the same functionality provided by the Update Process Values dialog as described in Writing Process Values on page 132.

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. You must be logged in as an Administrator-level user to change these settings. See Enable/Disable Write Access to History and Process Values on page 277.

• At the data server level, the applicable data provider must be configured to allow write transactions. This is the default set-up. If you want to verify this set-up, refer the section on configuring data providers in Industrial IT 800xA - Information Management Configuration.

• 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. To adjust this preference for a user, refer to the section on managing Information Management users in Industrial IT 800xA - Information Management Configuration.

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). See Setup on page 273.

304 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBUpdateObj

The syntax is as follows:

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

ObjName is the tag name for the object. You can use the object browsing tools in the Process Values dialog to find object names for the specified object type. See Selecting OPC Tags on page 125.

Value is the new value to be applied to the specified attribute.

ObjAtt is the name of the attribute whose value you want to retrieve. The attribute specification is NOT required for queries on OPC objects. The Value attribute is always returned.

[data provider] specifies the data provider through which this update 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 see Data Provider Connections on page 274.

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

3BUF001094R4101 305

Functions for Reading/Writing History Values Section 3 DataDirect - Excel Data Access Functions

Functions for Reading/Writing History ValuesDataDirect provides two sets of functions for reading and writing history data. The Industrial IT functions let you query aspect objects in the 800xA system. With the proper authority you can also insert and/or replace log entries. These functions will only run on 800xA system nodes that have core 800xA software installed (Aspect Servers, Connectivity Servers, Application Servers, and Workplace Clients). Further, these functions will not work with Excel versions before Office 2000.

If you are running DataDirect on a PC that does not have 800xA core system software (a remote Desktop Tools client), you must 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 you need to connect to a server that is outside the 800xA system, for example an earlier Enterprise Historian server. This lets you query objects on that server that are not a part of the 800xA system. This functionality is not supported by the Industrial IT functions.

Industrial IT Functions for History Values

• ABBGetOPCHDA on page 307 (Read values)

• ABBGetOPCHDAAggregates on page 310 (Get Aggregate List for OPC HDA Server, an aggregate must be entered in the ABBGetOPCHDA function)

• ABBWriteNOPCHDA on page 311 (Write to multiple entries)

• ABBWriteOPCHDA on page 313 (Write to single entry)

• ABBGetOPCHDAAttributes on page 315 (Get a list of log attributes)

• ABBGetOPCHDAAttributeValue on page 316 (Get Log attribute values)

Inform IT Functions for History Values

• ABBGetHistory on page 319 (Read values)

• ABBEditLog on page 322 (Write to single entry)

• ABBEditNLogs on page 324 (Write to multiple entries)

• ABBGetAttributes on page 326 (Get a list of log attributes)

• ABBGetAttributeValue on page 326 (Get attribute values)

306 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBGetOPCHDA

ABBGetOPCHDAThe 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. See Data Format on page 262. The default is to display Time Stamp, History Data Quality Indication, and Value. You can change the settings on the Data Format tab, or use the output parameter in this function to change the output specification.

You can generate a query for this function using the Industrial IT History Values dialog in the Formula mode as described in Using the Industrial IT History Values Dialog on page 150, or you can enter the function manually.

The syntax is:

=ABBGetOPCHDA(Logname, Interpolation, Start Time, End Time, MaxCount [,Format Date] [,Server][,output])

where:

Logname is the name of the log whose data you want to retrieve. You can use the OPC browser to find logs in the aspect directory. This lets you copy and paste log names to ensure the name is specified correctly. See Section 7, Browsing for OPC Tags.

Interpolation is the type of calculation. The available options depend on the OPC server. You may use the ABBGetOPCHDAAggregates function to get the list of available aggregates.

Start/End Time specify the time range for which data will be retrieved.

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 Date] is an optional parameter that lets you specify whether to use standard Excel formatting (n) or DataDirect formatting (y). See Formatting the Date on page 321.

This function requires 800xA core system software to be installed on the PC where you are running DataDirect. If you need to query an object on a server that is not part of the 800xA system, use ABBGetHistory on page 319.

3BUF001094R4101 307

ABBGetOPCHDA Section 3 DataDirect - Excel Data Access Functions

[Server] specifies the OPCHDA server ProgID. This defaults to the 800xA OPCDA server when the parameter is left undefined.

[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 262). You may use this option 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 that you want to display. 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. You may specify that only the history value be displayed by entering 0.

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:

=ABBGetOPCHDA(“H0000X000K-000000:MEASURE”, “max”, "11/3/00 14:30", “11/3/00 19:30”, 5, “n”, "ABB.AdvHtHistoryHdlr.1",10)

For instructions on inserting functions, see Inserting Functions in the Spreadsheet on page 293.

This function returns an array of data. The width (columns) is based on the log attributes you choose to display. 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.

308 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBGetOPCHDA

Matching the Number of Returned values with the Number of Rows Selected

The maximum number of values that can be returned in one call is 3200. The number of values returned by the ABBGetOPCHDA function is determined by the MaxCount parameter, and by the number of rows you select in the spreadsheet.

If MaxCount > selected rows, the excess values are truncated. If MaxCount < selected rows, excess rows are left blank.

You can 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. If you want to edit date and time information in the spreadsheet, or use this information in Excel charts, you must 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.

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

3BUF001094R4101 309

ABBGetOPCHDAAggregates Section 3 DataDirect - Excel Data Access Functions

ABBGetOPCHDAAggregatesThe ABBGetOPCHDAAggregates function returns a list of aggregates supported by the OPCHDA server to which you are connected. This may be used when you are manually entering the ABBGetOPCHDA function rather than using the Industrial IT History Values dialog.

The syntax for this function is described below:

=ABBGetOPCHDAAggregates([Server])

where:

[Server] specifies the OPCDA server ProgID. This defaults to the 800xA OPCDA server when the parameter is left undefined.

Enter the server parameter as a text strings with double quotes.

Example:

=ABBGetOPCHDAAggregates( "ABB.AfwOPCDASurrogate")

For instructions on inserting functions, see Inserting Functions in the Spreadsheet on page 293.

This function requires 800xA core system software to be installed on the PC where you are running DataDirect.

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 and press Ctrl-Shift-Enter.

310 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBWriteNOPCHDA

ABBWriteNOPCHDAThe ABBWriteNOPCHDA function lets you add multiple entries to a history log, or modify existing log entries. This is the same functionality provided by the Insert/Replace tab on the History Values dialog as described in Writing History Data on page 161. To add a single entry, use ABBWriteOPCHDA on page 313.

Guidelines for Writing History Data

User authority must be configured in the aspect system to allow you to update log objects. This is described in Industrial IT 800xA System Security.

There are certain restrictions and important considerations that you should read prior to writing history data. Refer to Writing to History Logs on page 62.

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 information is entered. An example is shown in Figure 242. Syntax for value, time stamp, and object status are described in ABBWriteOPCHDA on page 313.

This function requires 800xA core system software to be installed on the PC where you are running DataDirect. If you need to write to an object on a server that is not part of the 800xA system, use ABBEditNLogs on page 324.

Figure 241. Example, Log Entry Specification

Values Time Stamps Object Statuses

3BUF001094R4101 311

ABBWriteNOPCHDA Section 3 DataDirect - Excel Data Access Functions

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:

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. You may also use the complete word (Insert, Add, Replace, or Modify)

logName is the name of the log whose data you want to write. You can use the OPC browser to find logs in the aspect directory. The browser lets you copy and paste the log names to ensure the name is specified correctly. See Section 7, Browsing for OPC Tags.

theRange is 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.

[Server] specifies the OPCHDA server ProgID. This defaults to the 800xA OPCDA server when the parameter is left undefined.

Examples:

To add a log:

=ABBWriteNOPCHDA ("INSERT", "H000X000K-000000,MEASURE", A1:C5)

To modify a log:

=ABBWriteNOPCHDA ("REPLACE", "H000X000K-000000,MEASURE", A1:C5)

312 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBWriteOPCHDA

ABBWriteOPCHDAThe ABBWriteOPCHDA function lets you 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 161. To add multiple entries in one function call, use ABBWriteNOPCHDA on page 311.

Guidelines for Writing History Data

User authority must be configured in the aspect system to allow you to update log objects. This is described in Industrial IT 800xA System Security.

There are certain restrictions and important considerations that you should read prior to writing history data. Refer to Writing to History Logs on page 62.

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. You may also use the complete word (Insert, Add, Replace, or Modify)

logName is the name of the log whose data you want to write. You can use the OPC browser to find logs in the aspect directory. The browser lets you copy and paste the log names to ensure the name is specified correctly. See Section 7, Browsing for OPC Tags.

logValue is the new value for the log entry.

This function requires 800xA core system software to be installed on the PC where you are running DataDirect. If you need to write to an object on a server that is not part of the 800xA system, use ABBEditLog on page 322.

3BUF001094R4101 313

ABBWriteOPCHDA Section 3 DataDirect - Excel Data Access Functions

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, you can retrieve the raw data for the log entry as described in Reading History Data on page 152.

[fractSec] Optional fractional seconds specification (floating point).

objectStatus is an option you can use 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). You are not required to change this value if you choose not to use this functionality.

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

[Server] specifies the OPCHDA server ProgID. This defaults to the 800xA OPCDA server when the parameter is left undefined.

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

314 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBGetOPCHDAAttributes

ABBGetOPCHDAAttributesThe ABBGetOPCHDAAttributes function returns a list of available attributes for the OPCHDA server to which you are connected.

The syntax for this function is described below:

=ABBGetOPCHDAAttributes([Server])

where:

[Server] specifies the OPCDA server ProgID. This defaults to the 800xA OPCDA server when the parameter is left undefined.

Enter the server parameter as a text strings with double quotes.

Example:

=ABBGetOPCHDAAttributes( "ABB.AfwOPCDASurrogate")

This function requires 800xA core system software to be installed on the PC where you are running DataDirect. If you need to query an object on a server that is not part of the 800xA system, use ABBGetAttributes on page 326.

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 and press Ctrl-Shift-Enter.

3BUF001094R4101 315

ABBGetOPCHDAAttributeValue Section 3 DataDirect - Excel Data Access Functions

ABBGetOPCHDAAttributeValueThis 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. See Data Format on page 262. The default setting on this tab is to display Time Stamp, History Data Quality Indication, and Value. You can change the settings on the Data Format tab, or use the output parameter in this function to change the output specification.

You can 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 152, or you can enter the function manually.

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 you want to retrieve. You can use the OPC browser to find logs in the aspect directory. The browser lets you copy and paste the log names to ensure the name is specified correctly.

AttributeID is the name of the attribute whose value you want to retrieve. The available attributes depend on the connected OPC server. You may use the ABBWriteNOPCHDA function to get the list of available attributes.

Start/End Time specify the time range for which data will be retrieved. You can specify that only the current value be returned by entering the Start Time as “NOW”.

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.

This function requires 800xA core system software to be installed on the PC where you are running DataDirect. If you need to query an object on a server that is not part of the 800xA system, use ABBGetAttributeValue on page 326.

316 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBGetOPCHDAAttributeValue

[Format Date] is an optional parameter that lets you specify whether to use standard Excel formatting (n) or DataDirect formatting (y). See Formatting the Date on page 321.

[Server] specifies the OPCHDA server ProgID. This defaults to the 800xA OPCDA server when the parameter is left undefined.

[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 262). You may use this option 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 that you want to display. 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. You may specify that only the history value be displayed by entering 0.

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”, “attributeName”, "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 you choose to display. 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.

3BUF001094R4101 317

ABBGetOPCHDAAttributeValue Section 3 DataDirect - Excel Data Access Functions

Matching the Number of Returned values with the Number of Rows Selected

The maximum number of values that can be returned in one call is 3200. The number of values returned by this function is determined by the MaxCount parameter, and the number of rows you select in the spreadsheet.

If MaxCount > selected rows, the excess values are truncated. If MaxCount < selected rows, excess rows are left blank.

You can 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”, “attributename”, "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. If you want to edit date and time information in the spreadsheet, or use this information in Excel charts, you must use the standard Excel formatting instead. To specify standard Excel formatting rather than DataDirect formatting, use the Format Date parameter in the ABBGetOPCHDAAttributevalue 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 ABBGetOPCHDAAttributeValue function. Additionally, the returned timestamp is a date data type.

“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 ABBGetOPCHDAAttributeValue 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 ABBGetOPCHDAAttributeValue function. This is the same as specifying formatDate as y or Y.

318 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBGetHistory

ABBGetHistoryThe 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. See Data Format on page 262. The default setting on this tab is to display Time Stamp, History Data Quality Indication, and Value. You can 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 you want to retrieve. You can use the object browsing tools in the History Values dialog to find log names. See Accessing Property Logs via OPC HDA on page 173.

Interpolation is the type of calculation performed by the log. The available options depend on the data provider to which you are connected for history access. For further information see Log Calculation Algorithm on page 154.

Start/End Time these specify the time range for which data will be retrieved.

MaxCount specifies the number of values to return. This in combination with the time span divides the time range into discrete intervals for which data values are returned.

[Format Date] is an optional parameter that lets you specify whether to use standard Excel formatting (n) or DataDirect formatting (y). See Formatting the Date below.

[data provider] specifies the data provider through which this operation will be routed. 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 see Data Provider Connections on page 274.

3BUF001094R4101 319

ABBGetHistory Section 3 DataDirect - Excel Data Access Functions

[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 262). You may use this option 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 that you want to display. 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. You may specify that only the history value be displayed by entering 0.

[mSec] specifies whether or not 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”)

=ABBGetHistory(“H0000X000K-000000:MEASURE,log1”, “max”, "11/3/00 14:30", “11/3/00 19:30”, 5, “n”,“AIPHDA”)

Matching the Number of Returned values with the Number of Rows Selected

The number of values returned by the ABBgetHistory function is determined by the MaxCount parameter, and by the number of rows you select in the Excel spreadsheet (step 2 in Inserting DataDirect Functions Manually on page 297).

320 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBGetHistory

• If MaxCount > selected rows, the excess values are truncated.

• If MaxCount < selected rows, the excess rows are left blank.

You can 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 example:

=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

Normally, date and time are formatted as specified in the Data Format tab of the Options dialog. If you want to edit date and time information in the spreadsheet, or use this information in Excel charts, you must use the standard Excel formatting instead. To specify standard Excel formatting rather than DataDirect formatting, use the Format Date parameter in the ABBGetHistory function.

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 ABBGetHistory function. Additionally, the returned timestamp is a date data type.

“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 ABBGetHistory 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 ABBGetHistory function. This is the same as specifying formatDate as y or Y.

The maximum number of values that can be returned in one call is 3200.

3BUF001094R4101 321

ABBEditLog Section 3 DataDirect - Excel Data Access Functions

ABBEditLogThe ABBEditLog function lets you 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 182. To add multiple entries in one function call, use ABBEditNLogs on page 324.

User Authority

The proper user authority is required to add and/or modify logs. 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. You must be logged in as an Administrator-level user to change these settings. See Enable/Disable Write Access to History and Process Values on page 277.

• At the data server level, the applicable data provider must be configured to allow write transactions. This is the default set-up. If you want to verify this set-up, refer the section on configuring data access for display and client services in Industrial IT 800xA - Information Management Configuration.

• 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. To adjust this preference for a user, refer to the section on managing Information Management users in Information Management Configuration.

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). See Data Provider Connections on page 274.

322 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBEditLog

Syntax

Enter all parameters as text strings with double-quotes. The syntax is as follows:

=ABBEditLog ("ADD" or "MODIFY”, ObjName, ObjValue, timeStamp, objectStatus [,data provider])

where:

ObjName is the log name. You may use the access name to add an entry. You MUST use the full log name to modify. You can use the object browsing tools in the History Values dialog to find log names. See Accessing Property Logs via OPC HDA on page 173.

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, you can retrieve the raw data for the log entry as described in Using the Inform IT History Values Dialog on page 167.

objectStatus is an option you can use 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). You are not required to change this value if you choose not to use this functionality.

[data provider] specifies the name of the data provider through which this update 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 see Data Provider Connections on page 274.

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

3BUF001094R4101 323

ABBEditNLogs Section 3 DataDirect - Excel Data Access Functions

ABBEditNLogsThe ABBEditNLogs function lets you 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 182. To change one entry at a time, use ABBConnect on page 334.

User Authority and Data Provider Specification

The requirements for user authority and data provider specification are the same as for ABBConnect on page 334.

Log Entry Specification

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

Refer to ABBConnect on page 334 for details regarding values, time stamps, and object statuses.

Figure 242. Example, Log Entry Specification

Values Time Stamps Object Statuses

324 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBEditNLogs

Syntax

The syntax is as follows:

=ABBNEditNLogs ("ADD" or "MODIFY”, ObjName, range, [,data provider])

where:

ObjName is the log name. You may use the access name to add an entry. You MUST use the full log name to modify. You can use the object browsing tools in the History Values dialog to find log names. See Accessing Property Logs via OPC HDA on page 173.

range is the range of rows and columns in the spreadsheet where the pre-formatted log entry specification is located.

[data provider] specifies the data provider through which this update 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 see Data Provider Connections on page 274.

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

3BUF001094R4101 325

ABBGetAttributes Section 3 DataDirect - Excel Data Access Functions

ABBGetAttributesThe ABBGetAttributes function retrieves the attribute list for history objects that reside on an OPC HDA server (for example, the 800xA OPC HDA server). You can use the result from this function call to query for attribute values in the ABBGetAttributeValue function.

To specify the server whose attribute list you want to retrieve, indicate the corresponding data provider -name in the function call. The syntax for ABBGetAttributes is:

=ABBGetAttributes(dataProvider)

where:

data provider indicates the -name argument of data provider that supports the OPC HDA server whose attribute list you want to retrieve. For example, the -name argument for the data provider that supports the 800xA OPC HDA server is AIPHDA.

For further details regarding data providers see Data Provider Connections on page 274.

Enter the data provider text string with double quotes. Example:

=ABBGetAttributes(“AIPHDA”)

ABBGetAttributeValueThe 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 you know it. If not you can use the History Values dialog as described in Accessing Property Logs via OPC HDA on page 173. If the Object Name has been inserted into the spreadsheet, you can reference the applicable cell in this argument - for example: C9.

326 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBGetAttributeValue

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 you want to retrieve. This ID is provided in the result of the ABBGetAttributes function call.

data provider specifies the name of the data provider through which this query will be routed. Specify the -name argument that uniquely identifies the data provider. For further details regarding data providers see Data Provider Connections on page 274.

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:

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

3BUF001094R4101 327

Functions for Reading Messages Section 3 DataDirect - Excel Data Access Functions

Functions for Reading MessagesThe 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 core 800xA software installed (Aspect Servers, Connectivity Servers, Application Servers, and Workplace Clients).

To use this function, see ABBAERetrieval on page 328.

You may also use the Inform IT Message dialog to generate SQL queries against the IMMSGLOG, and then execute the queries via either the SQL dialog for the ABBSQL function. See:

• Using the Inform IT Message Log Dialog on page 202

• Saving and Re-using SQL Queries on page 252

• ABBSql on page 330

ABBAERetrievalThe ABBAERetrieval function retrieves runtime or archived event data for a specified 800xA system alarm and event list.

The Message Type combo box on the Filter tab of the Alarm and Event List Configuration 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

This function requires 800xA core system software to be installed on the PC where you are running DataDirect.

328 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBAERetrieval

• 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. See Timeout on page 277.

The format of the timestamp (if the time is a selected attribute to be output) is determined by the time format setting on the DataDirect Options dialog. See Date and Time Formatting on page 266.

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.

You can generate a query for this function using the Alarm and Event Retrieval dialog in the Formula mode as described in Using the Industrial IT Alarm/Events Dialog on page 198, or enter the function manually. The syntax is:

=ABBAERetrieval(startTime, endTime, AEListAspect[,MaxRows] [,Timeout])

where:

start and end times time range for messages to be retrieved. Note: if endTime comes before startTime, the messages are ordered oldest first.

AEListAspect name of object containing Alarm and Event List Aspect which 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 lets you specify maximum seconds to wait for response. This defaults to the Timeout specified on the Setup tab of the Data Direct Options dialog. See Setup on page 273.

For instructions on inserting functions, see Inserting Functions in the Spreadsheet on page 293.

3BUF001094R4101 329

Miscellaneous Functions Section 3 DataDirect - Excel Data Access Functions

Miscellaneous FunctionsThese functions may be used on 800xA system nodes and on pc clients without 800xA software:

• ABBSql on page 330

• ABBArray on page 332

• ABBConnect on page 334

• ABBDisconnect on page 334

ABBSqlThe ABBSql function retrieves data according to the specified SQL query. It is intended 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.

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 manipulate the data in a useful manner, often depending upon the application.

If you want to use this function to query historical and process objects on a Windows-based data server, you must 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 following two changes to the data provider argument list:• Change the -name argument, for example: from DBA to DBA1.• Set the -dbname argument to Database1.

To configure data providers, refer to the section on configuring data providers in Industrial IT 800xA - Information Management Configuration.

330 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBSql

The syntax for ABBSql is:

=ABBSql(SQL Statement, MaxCount [,data provider])

where:

SQL Statement is an SQL statement. You may use a query saved via the SQL Query dialog (Saving and Re-using SQL Queries on page 252) or OPC/Audit Trail message dialog (Saving a Query on page 210). To do this, enter @QueryName, for example @MsgLog1.

MaxCount This lets you set the maximum number of responses to a manageable quantity. The largest possible number is 9999.

[data provider] specifies the data provider through which this query will 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 see Data Provider Connections on page 274.

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)

For instructions on inserting functions, see Inserting Functions in the Spreadsheet on page 293.

Requesting All Data

The number of values returned by the ABBSql function is determined by the MaxCount parameter, and by the number of rows you select in the Excel spreadsheet (step 2 in Inserting DataDirect Functions Manually on page 297).

You can use the MaxCount parameter to return all possible values according to the query. To do this specify the MaxCount parameter as 0. For example:

3BUF001094R4101 331

ABBArray Section 3 DataDirect - Excel Data Access Functions

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

ABBArrayThe 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 you want to retrieve.

MaxCount This lets you set the maximum number of responses to a manageable quantity. The largest possible number is 9999.

[data provider] specifies the data provider through which this query 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 see Data Provider Connections on page 274.

Refer to the Object Types Reference Manual for more information on TCL Unit Array object types, and their respective attributes.

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

332 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions ABBArray

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

The number of values returned by the ABBArray function is determined by the MaxCount parameter, and by the number of rows you select in the Excel spreadsheet (step 2 in Inserting DataDirect Functions Manually on page 297).

You can 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 lets you return is 32,767. This number may be limited further by the amount of data associated with each value.

3BUF001094R4101 333

ABBConnect Section 3 DataDirect - Excel Data Access Functions

ABBConnectABBConnect lets you use a function 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 98.

The syntax is as follows:

=ABBConnect (Host, User, Password)

where:

Host is the computer name for the computer where the display server software is installed. See Host on page 101.

User the user name for the Display client. See User on page 100.

Password is the password for the specified User. See Password on page 101.

Enter all parameters as text strings with double quotes.

Example:

=ABBConnect ("tar220" ,"aid" ,"aid")

ABBDisconnectABBDisconnect lets you use a function to disconnect the DataDirect client from the data server.

The syntax is as follows:

=ABBDisconnect ()

There are no parameters for this function.

Example:

=ABBDisconnect ()

334 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions Using VBA Macros

Using VBA MacrosThe 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> see Table 15

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("abbdatadirect.xla!abbgetHistory", _ "AFWAV1,MEASURE","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(outputRange.Rows.Count, 2), _ PlotBy:=xlColumns ActiveChart.Location Where:=xlLocationAsObject, _ Name:=outputRange.Parent.NameEnd Sub

To schedule a DataDirect report with VBA macros, set the Macro security level to low on the PC where the report will run. See Enabling Macros on page 86.

3BUF001094R4101 335

Adding Charts to DataDirect Reports Section 3 DataDirect - Excel Data Access Functions

Adding Charts to DataDirect ReportsYou may use the Chart Wizard in Microsoft Excel to add charts to DataDirect reports, Figure 243. Refer to the on-line help for this Excel function for general instructions on adding charts. This section provides guidelines and recommendations that are specific to DataDirect.

Figure 243. Example, Chart Added to DataDirect Report

336 3BUF001094R4101

Section 3 DataDirect - Excel Data Access Functions Adding Charts to DataDirect Reports

How to start the Chart Wizard is shown in Figure 244.

Recommendations for Chart Type

It is recommended that you use the Line chart type and data point sub-type, Figure 245. The Line chart type provides time stamps on the y axis. With the data point sub-type, you can hover the cursor over individual data points to display the corresponding values.

Figure 244. Starting the Chart Wizard

Figure 245. Selecting Chart Type

Click here to start Chart Wizard

Selecting Line Type

Selecting Data Point Sub-type

3BUF001094R4101 337

Adding Charts to DataDirect Reports Section 3 DataDirect - Excel Data Access Functions

Making Charts Dynamic

You can 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 246.

Figure 246. Editing the Array Formula

Original Formula

Edited Formula

338 3BUF001094R4101

Section 4 Using Desktop Trends

This section describes how to use Desktop Trends for data access. If you are not familiar with this application, refer to Product Overview on page 340.

For connection and set-up instructions, see Connection and Set-up on page 340.

For instructions on using the various desktop tools, see:

• Trend Display on page 348

• Ticker on page 397

• Tag Explorer on page 445

• PDL Browser on page 466

• Batch to Batch Display on page 488

• Event Browser on page 491

• SQL Browser on page 496

• OPC Browser on page 507

3BUF001094R4101 339

Product Overview Section 4 Using Desktop Trends

Product OverviewDesktop Trends lets you view real time, trend, production, and event data via ActiveX controls on your 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. See Trend Display on page 348.

• The Ticker shows a repeating stream of real time data for selected tags, similar to a stock market ticker. See Ticker on page 397.

• The Tag Explorer lets you structure points in a format similar to Microsoft Windows Explorer for easy browsing and access. See Tag Explorer on page 445.

• The PDL Browser lets you access production data from Production Data Logs for Produce IT Batch, Batch 300, TCL Batches, and Profile Historian. See PDL Browser on page 466.

• The Batch to Batch Display combines the functionality of the Trend Display with the PDL Browser. It lets you easily navigate the PDL structure to find and display historical trends for different batches. See Batch to Batch Display on page 488.

• The Event Browser lets you retrieve messages from OPC and Audit Trail message logs configured via the Information Management - History Server function. See Event Browser on page 491.

• The SQL Browser lets you run ad-hoc SQL queries. You can save a query once you’ve run it, and then reopen the query for viewing at some time in the future. You can also delete saved queries. See SQL Browser on page 496.

Connection and Set-upThis 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.

340 3BUF001094R4101

Section 4 Using Desktop Trends Connecting to the Data Server

Connecting to the Data ServerThe 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. If you want to connect the controls to a different server, or if the Desktop Trends software is installed on a remote PC client, you must use the ACC Setup utility to establish the connection with a remote data server.

Use the ACC Setup tool to specify the IP address or alias for the server. To launch this tool, from the Windows task bar choose Start>Programs> ABB Industrial IT 800xA>Information Mgmt>Utilities> ACC Data Server Setup, Figure 247.

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

The ACC Setup utility is used by other Information Management applications. You can check whether or not another user is already using the tool by looking for the ACC.exe process in the Windows Task Manager. You can use the tool simultaneously with other users; however, connection specifications that you enter in this tool will not take affect until the ACC.exe process is no longer active.

Figure 247. Launching the ACC-Setup Tool

3BUF001094R4101 341

Connecting to the Data Server Section 4 Using Desktop Trends

The username defaults to aid. You must enter the password for the aid user (default password is aid). All other fields may be left at their default values. Click OK when you are finished.

Figure 248. ACC Setup Tool

342 3BUF001094R4101

Section 4 Using Desktop Trends Setting Up Pick Lists

Setting Up Pick ListsThe 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, softpoint, and historical property log data. For data points that do not reside on an OPC server, you must 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. You can customize these pick lists to better fit your 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\Desktop Trends\Default Files\Picklists”.1

A set of standard text files are provided as described in Table 16. These standard files are not complete, and are only intended as a starting point. You can create additional files to customize tag/attribute selection for your application. For instance, you can create a file structure such as the one shown in Figure 249 to follow your specific plant structure.

1. The default path for %ABB_ROOT% is: C:\Program Files\ABB Industrial IT\

Table 16. Standard Text Files

Category Description Standard Files

Object Type Populates object type pick list in the Ticker File Configuration dialog.

• ModObjectTypes.txt• MasterObjectTypes.txt• ObjectTypes.txt

Tag Names Populates tag name pick list in the Ticker File Configuration dialog.

• TagNames.txt

3BUF001094R4101 343

Setting Up Pick Lists Section 4 Using Desktop Trends

Attribute Populates the attributes pick list in the Ticker File Configuration dialog.

• ModAttributes.txt• MasterAttributes.txt• Attributes.txt

Data Providers

Populates the Data Providers pick list in the Ticker File Configuration dialog.

• Data Providers.txt

Figure 249. Organizing Text Files According to The Plant Structure

Table 16. Standard Text Files

Category Description Standard Files

Object Text Filesfor Area1-Unit1

344 3BUF001094R4101

Section 4 Using Desktop Trends Setting Up Pick Lists

Guidelines for Creating New Text FilesFollow 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. You are not required 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 250.

Applying New Default FilesThe default text files for all pick lists in the Ticker and Tag Explorer are specified via the File tab in the Default Ticker Configuration and Tag Explorer Configuration dialogs respectively. You can change these defaults as required. You can also edit the limits file from this tab.

For the ticker, refer to File Specifications on page 429.

For the Tag Explorer, refer to File Specifications on page 457.

Figure 250. Example Text Files

3BUF001094R4101 345

Setting Up the Limits File Section 4 Using Desktop Trends

Setting Up the Limits FileWhen you add a tag to a Ticker or Tag Explorer file (Configuring Tags on page 400), you can 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. You can also specify the limit values directly, or specify that the values be derived from a data source on the system where the tag resides. In this case you must also specify the data sources for each high and low limit. This association is made in a text file, similar to the pick list text files described in Setting Up Pick Lists on page 343.

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, you can use the predefined text files, or create a custom file. The Limits.txt file is shown in Figure 251. 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

Figure 251. Limits.txt File

346 3BUF001094R4101

Section 4 Using Desktop Trends Setting Up the Limits File

For OPC data, you can 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 you want to use for the low and high limits. Again, separate the object type and tag names with colons. For example: if the OPC tag whose value you want to use for low limit is LIC101.LowLim and the OPC tag whose value you want to use for high limit is LIC101.HighLim, enter the following line in the Limits text file: OPCLoHi:LIC101.LowLim:LIC101.HighLim.

When you add an OPC tag to a ticker or tag explorer, and the OPC tag uses other OPC tags to set the high/low limits, you must 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. See Tag Name on page 409, and Limit Check on page 411.

Applying New Default FilesThe default text files for the limits file in the Ticker and Tag Explorer are specified via the File tab in the Default Ticker Configuration and Tag Explorer Configuration dialogs respectively. You can change these defaults as required. You can also edit the limits file from this tab.

For the ticker, refer to File Specifications on page 429.

For the Tag Explorer, refer to File Specifications on page 457.

3BUF001094R4101 347

Trend Display Section 4 Using Desktop Trends

Trend DisplayThe Trend display is an ActiveX control hosted inside Internet Explorer, which exposes control system trend data as graphic traces. The Trend display can have from one to eight trended tags. The trend data is retrieved from property logs. The trend definitions are html files that support navigation via 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 lets you magnify a portion of the current scope, without changing the overall scope. In this way a specific part of the scope can be enlarged without losing the overview.

The Trend display also lets you:

• 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 see:

• Launching the Trend Display on page 349

• Setting Up the Trend Display on page 353

• Using the Trend Display on page 376

348 3BUF001094R4101

Section 4 Using Desktop Trends Launching the Trend Display

Launching the Trend DisplayYou can launch the Trend Display using any one of these methods:

• via the Windows task bar: Start>Programs>ABB Industrial IT 800xA> Information Mgmt>Desktop Trends>Trend Display, Figure 252.

• via Internet Explorer - You can use the Internet Explorer navigation tools to open an existing Trend display that was previously saved as an HTML file.

• via 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.

• via the Ticker - See Launching the Trend Display from the Ticker on page 443.

• via the Tag Explorer - See Launching the Trend Display from the Ticker on page 443.

• via the PDL Browser - See History on page 485.

• via the Event Browser - See Viewing Trend Data Related to Events on page 495. This lets you display trend data for a tag associated with a selected event.

Figure 252. Launching the Trend Display

3BUF001094R4101 349

Description Section 4 Using Desktop Trends

DescriptionThe Trend Display, Figure 253, 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 (Info) Area

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.

Figure 253. History Trend Display

Frame Bar

GraphicalTrend

Table(Info)

Scope/Zoom

Area

Area

Time

ValueScale

Toolbar

Scale

(Traces 1-4)

Value Scale(Traces 5-8)

350 3BUF001094R4101

Section 4 Using Desktop Trends Description

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 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 correspond 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. You have the option of specifying one time scale for all traces to share, or individual time scales for each trace. See Scope Properties on page 372. If you specify individual time scales, only one is shown at a time. You can select the trace whose time scale you want to show 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 254, contains buttons for using the scope and zoom features of the trend display. You can open or close the tool bar via the context menu or View Tab (Shift+Right Mouse on the trend display) to adjust the screen space for the graphical view.

3BUF001094R4101 351

Description Section 4 Using Desktop Trends

Miscellaneous Tool Bar

The miscellaneous tool bar provides miscellaneous functionality as illustrated in Figure 255.

Figure 254. Tool Bar

Both the Table View (Info Area) 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. This functionality is provided via a right-click (context) menu. See Showing/Hiding and Docking/Undocking Trend Display Components on page 388.

Figure 255. Miscellaneous Tool Bar

BackwardScope Step

Large/Small

Zoom DefaultScope

SetStartTime

ZoomOut

InSmall/LargeForward

Scope Step

ActiveZoom

Level/Enable

OpenTrendFile

SaveTrendFile

PrintTrendFile

BrowseOPC/HDA

On-line Help

Trend

Ticker

PDLBrowser

EventBrowser

SQLBrowser

TogglePrintColors

TagExplorer

352 3BUF001094R4101

Section 4 Using Desktop Trends Setting Up the Trend Display

Setting Up the Trend DisplayThe appearance and operating characteristics for the trend display are set up on two levels:

• General display characteristics and operating parameters are configured via the Setup dialog. This includes specifying data providers, showing/hiding columns in the table area, trend background color, and data retrieval type (raw or interpolated). This dialog also provides connection status and version information. For details, see Setup Dialog on page 354.

• The Property Page lets you 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 see Property Page on page 366.

3BUF001094R4101 353

Setup Dialog Section 4 Using Desktop Trends

Setup DialogUse 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 256.

This dialog lets you:

• configure data provider connections for traces, specify whether to retrieve raw or interpolated data, and select aggregates. See Data on page 355.

• show/hide various trend display components. See Visibility on page 358.

• set column widths for the table (info) area. See Column Widths on page 359.

• configure colors for trend background, ruler, and grid. See Miscellaneous Settings on page 360.

• specify whether to read the limits, engineering units, and description information from the database. See Database Information on page 361.

• specify the maximum number of interpolated points when the retrieval type is interpolated. See Maximum Interpolated Points on page 361.

• configure data update. See Miscellaneous Settings on page 360.

• specify whether to save debug messages to a text file. See Miscellaneous Settings on page 360.

• configure print colors. See Print Colors on page 362.

• view connection status information. See Status on page 364.

• view version information. See Versions on page 365.

Figure 256. Launching the Setup Dialog

354 3BUF001094R4101

Section 4 Using Desktop Trends Data

DataThe Data tab, Figure 257, lets you:

• specify default and trace-specific data provider connections. See Data Provider Connections on page 355.

• specify whether to retrieve raw or interpolated data. See Raw/Interpolated Data on page 356.

• apply an aggregate (calculation) to a trace. See Aggregates on page 357.

Data Provider Connections

New traces are automatically assigned the default data provider specified in this dialog. You can change the specification for individual traces by entering the data provider name directly in the trace’s Data Provider field. You can 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 lets you access both trend and history logs.

Use the LOG data provider if you need to access OMF-based history logs from a MOD 300 or Master ABB OCS. You can also specify any other data provider for historical data access that is configured on your system. Refer to Information Management Configuration for further information regarding data providers.

Figure 257. Trend Setup - Data Tab

3BUF001094R4101 355

Data Section 4 Using Desktop Trends

Raw/Interpolated Data

New traces are automatically assigned the default data type specified in this dialog, Figure 258. You can change the specification for individual traces by clicking the trace’s Int or Raw radio button. You can reset all individual traces to the default specification by clicking Update All.

• Interpolated - This returns values at regular intervals. The specified time range and the Maximum Interpolated Points property (set via Miscellaneous Settings 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.

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

Figure 258. Selecting Raw or Interpolated Data

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.

Data TypeButtons

356 3BUF001094R4101

Section 4 Using Desktop Trends Data

Aggregates

You can apply any aggregate (calculation) to the trend that is supported by the OPC/HDA server. To do this click in the Aggregates column, Figure 259. The Aggregates menu includes all aggregates support by the HDA server. You cannot apply an aggregate to any trace whose data type is set to Raw (Raw/Interpolated Data on page 356).

Figure 259. Applying an Aggregate

3BUF001094R4101 357

Visibility Section 4 Using Desktop Trends

VisibilityThis tab lets you specify whether to show or hide various features on the trend display, Figure 260. You can specify whether to show or hide the Info area in its entirety, or select individual columns in the table to show or hide.

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 you to turn the slide on or off; however, it only is useful with the Active Zoom feature.

All items are checked (shown) by default. You can uncheck individual items to hide them. After making your selections, click OK to exit.

Figure 260. Trend Setup - Visibility Tab

The Table View (Info Area) or Scope/Zoom Tool Bar can also be shown or hidden directly from the Trend area context menu.

358 3BUF001094R4101

Section 4 Using Desktop Trends Column Widths

Column WidthsThis tab lets you adjust the width of columns in the Info area with pixel precision, Figure 261.

Figure 261. Trend Setup - Column Widths

• Column widths may also be set directly on the Table view. See Using the Table (Info) Area on page 385.

• If the Visibility of a column is turned off, the column width is set to zero and cannot be changed in the Setup dialog.

3BUF001094R4101 359

Miscellaneous Settings Section 4 Using Desktop Trends

Miscellaneous SettingsThis tab, Figure 262, lets you specify:

• colors for trend background, ruler, and grid. See Colors on page 360.

• data update rate. See Data Update Rate on page 361.

• Maximum interpolated points. See Maximum Interpolated Points on page 361.

• Whether or not to read limits, engineering units, and description information for traces from the database. See Database Information on page 361.

• whether or not to save debug information. See Saving Debug Information on page 361.

Colors

To specify a color for trend background, ruler, or grid, double-click the applicable box. This displays the standard Windows color-chooser dialog.

Figure 262. Trend Setup - Miscellaneous Tab

360 3BUF001094R4101

Section 4 Using Desktop Trends Miscellaneous Settings

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 let you specify whether the corresponding attributes will be read from the database. When a check box is checked, you can supersede the database reading by entering a value directly in the table (info) area or via the Property Page; however, the database settings will replace any entries you’ve made the next time you open the Trend display.

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 provided for each three-minute interval. If this setting exceeds the pixel capacity of your 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 you can browse to a folder and select a file by clicking the browse button. See Figure 263.

Figure 263. Saving Debug Information

Click here to browse

3BUF001094R4101 361

Print Colors Section 4 Using Desktop Trends

Print ColorsThis tab lets you modify the trend color scheme for printing and specify whether to print in portrait or Landscape mode, Figure 264. The default settings on this tab are preset optimized for printing (white background). You can modify the default settings if you wish. Clicking any column in the Trace Colors section displays the standard Windows dialog for color selection.

You may also specify whether to apply this print color scheme to all trend displays, or only the current trend display.

To preview the color scheme you have created, click the Toggle Print Color icon on the toolbar, Figure 265. An example preview is shown in Figure 266.

Figure 264. Printing Tab

Figure 265. Preview Print Colors

Toggle between display and print colors

362 3BUF001094R4101

Section 4 Using Desktop Trends Print Colors

Figure 266. Example Preview Print Colors

3BUF001094R4101 363

Status Section 4 Using Desktop Trends

Status The Status tab, Figure 267, 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, you should check the Information Management server, and the client where this application is running to make sure everything is ok. The Clear button clears the status information.

Figure 267. Connection Status Tab

364 3BUF001094R4101

Section 4 Using Desktop Trends Versions

VersionsThis tab shows version information for the trend display, Figure 268.

Figure 268. Version Information

3BUF001094R4101 365

Property Page Section 4 Using Desktop Trends

Property PageThe Property Page lets you 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 269.

Trace PropertiesThe Trace tabs in the Property Page dialog, Figure 270, let you configure the individual traces. You can:

• enable (show) or disable (hide) the trace. See Enabled on page 367.

• change the trace name. See Name on page 367.

• specify a descriptor text. See Description on page 367.

• specify whether to show the trace as a line, pole, step, or reverse step. See Trace Type on page 368.

• specify the color and thickness for trace lines for indicating Normal Data, No Data, or Bad Data conditions. See Trace Lines on page 368.

• specify high and low limits, whether or not to show limit lines, and if so, the color and thickness for limit lines. See Limit Lines on page 368.

• specify the overall range. See Scale on page 368.

• When multiple scopes are enabled via the Scope tab, you can also specify the scope for individual traces on their respective tabs. See Scope on page 370.

Figure 269. Launching the Properties Page

366 3BUF001094R4101

Section 4 Using Desktop Trends Trace Properties

Enabled

The Enabled check box in the upper right portion of this page lets you 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.

Figure 270. Trace Properties

Enable/DisableTrace

3BUF001094R4101 367

Trace Properties Section 4 Using Desktop Trends

Trace Type

This pull-down list lets you specify whether to show the trace as a Line, Pole, Step, and Rev. Step. See Type on page 386.

Trace Lines

The controls in this section let you 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 let you specify the high and low values, color and thickness of the limit lines. The corresponding Enabled check box lets you enable (show) or disable (hide) these lines.

Scale

The fields in this section let you specify the minimum and maximum values and format of the value scale.

368 3BUF001094R4101

Section 4 Using Desktop Trends Trace Properties

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 your system.

% Percentage placeholder. The expression is multiplied by 100. The percent character (%) is inserted in the position where it appears in the format string.

3BUF001094R4101 369

Trace Properties Section 4 Using Desktop Trends

, 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, you can 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 Number Format recognized by your system.

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

This section, Figure 271, is only displayed when multiple scopes are enabled via the Scope tab. In this case, the scope for each trace is specified via its respective trace tab. If single scope is specified, all traces share the same scope which is set via the Scope tab. For details on how to set the formats for the data and time fields, see Date Format on page 374 and Time Format on page 375.

370 3BUF001094R4101

Section 4 Using Desktop Trends Trace Properties

Figure 271. Property Page When Multiple Scopes is Enabled

Specify scope for trace herewhen Multiple Scope functionis enabled

3BUF001094R4101 371

Scope Properties Section 4 Using Desktop Trends

Scope PropertiesThe Property Page Scope tab, Figure 272, lets you configure properties related to scope. You can:

• specify how to set the scope’s start and end time. See Scope Type on page 373.

• specify that a single scope apply to all traces, or that each trace have a unique scope. See Mode on page 373.

• specify the scope duration when Scope Type is End Scope. See Scope Width on page 373.

• Specify scope start and end times when the Mode is Single Scope. See StartTime and EndTime on page 373

• Date and Time formats. See Date Format on page 374 and Time Format on page 375.

Figure 272. Current Scope Properties

372 3BUF001094R4101

Section 4 Using Desktop Trends Scope Properties

Scope Type

This determines how you specify the scope start and end time. The StartTime and EndTime fields are enabled/disabled based on this setting.

• Start End - Lets you specify the start and end time for the scope. In this case the Scope Width fields are disabled.

• Start Scope - Lets you specify the start time for the scope. The end time is determined by specifying the Scope Width.

• End Scope - Lets you specify the end time for the scope. The start time is determined by specifying the Scope Width.

• Current Scope - Uses the current time as the end time. The start time is determined by specifying the Scope Width.

Mode

This lets you 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 you choose to have a single scope for all traces, configure the StartTime and EndTime on this tab.

If you choose to have multiple time ranges, the scope for each trace must be specified on its respective 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 via the time scale context menu as described in Selecting the Time Scale for a Trace on page 392.

Scope Width

The Scope Width lets you 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. See Date Format on page 374 and Time Format on page 375.

3BUF001094R4101 373

Scope Properties Section 4 Using Desktop Trends

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 abbreviation (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 your 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 your system. 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 abbreviation (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).

374 3BUF001094R4101

Section 4 Using Desktop Trends Scope Properties

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:

• 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

3BUF001094R4101 375

Using the Trend Display Section 4 Using Desktop Trends

Using the Trend DisplayThis section describes the following procedures for using the trend display:

• Adding and Removing Traces on page 377

• Browsing an OPC Server on page 378

• Reading Trend Data on page 380

• Using the Scope/Zoom Tool Bar on page 383

• Using the Table (Info) Area on page 385

• Showing/Hiding and Docking/Undocking Trend Display Components on page 388

• Viewing Trend Statistics on page 389

• Copying and Pasting Trend Data to Other Applications on page 391

• Applying Time Offsets on page 393

• Saving the Current Display on page 394

• Opening a Saved Display on page 395

• Printing the Current Display on page 396

• Launching Other Desktop Trend Tools from the Trend Display on page 396

376 3BUF001094R4101

Section 4 Using Desktop Trends Adding and Removing Traces

Adding and Removing TracesTo add a trace, right-click in the trend area and choose Trace>Add from the context menu, Figure 273.

This adds a new row in the Table View (Info Area). To configure the new trace, first enter the tag name in the table (info) area, and then see Property Page on page 366.

To delete a trace, right-click in the trend area and choose Trace>Remove>Trace# from the context menu, Figure 274.

Figure 273. Adding a Trace

Traces for OPC HDA objects may also be added via the OPC Browser. See Browsing an OPC Server on page 378.

Figure 274. Removing a Trace

3BUF001094R4101 377

Browsing an OPC Server Section 4 Using Desktop Trends

Browsing an OPC ServerThe OPC Browser lets you 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 helping you navigate and select objects see Section 7, Browsing for OPC Tags.

To launch this browser, click the Browse Objects button on the tool bar, Figure 275.

To use the browser, Figure 276:

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

For IMHDA, the left pane lets you choose one of three methods by which to conduct your search: EH for local access, EH_PUBL for published archived log data, and EH_NET for network-wide access (LOGMAN is not applicable for this release).

The following browsing methods are supported:

– 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 selected folder.

– Apply a filter to either show or exclude all logs whose name has a specified text string.

Figure 275. Launching the OPC Browser

Browse Objects Button

378 3BUF001094R4101

Section 4 Using Desktop Trends Browsing an OPC Server

– With AIPHDA, you can use the Seamless retrieval option when you are unsure which component log within the property log will provide best coverage of the requested time range.

3. Select one or more objects in the middle pane, and then move them to the Selected Tags (right) pane by clicking the > button. You can move all objects from the middle to the Selected Tags pane by clicking the >> button. You can remove selected tags from the list using either the < or << buttons.

4. You can combine tags from different locations by repeating steps 2 and 3.

5. When you are finished selecting tags, click Add Traces. This adds traces for the selected tags.

As an option, you can copy tags from this browser to the clipboard for pasting into external applications.

Figure 276. Example, OPC Browser

3BUF001094R4101 379

Reading Trend Data Section 4 Using Desktop Trends

Reading Trend DataThis section describes mouse functions for manipulating the trend display. This includes:

• Using the Ruler on page 381

• Value Zoom on page 382

• Time Zoom on page 382

• Area Zoom on page 382

Additional features are available on the Scope/Zoom toolbar. See Using the Scope/Zoom Tool Bar on page 383.

380 3BUF001094R4101

Section 4 Using Desktop Trends Reading Trend Data

Using the Ruler

The ruler lets you 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 277.

2. Select the ruler with the left mouse button, and then drag left or right. You can also use the arrow keys on the keyboard.

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. See Using the Table (Info) Area on page 385.

Figure 277. Ruler in Graphical View Area

Ruler

RulerValues

3BUF001094R4101 381

Reading Trend Data Section 4 Using Desktop Trends

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.

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 278. When releasing the mouse the time and value scales are changed.

Figure 278. Area Zoom

382 3BUF001094R4101

Section 4 Using Desktop Trends Using the Scope/Zoom Tool Bar

Using the Scope/Zoom Tool BarThe Scope/Zoom tool bar, Figure 254, contains buttons for using the scope and zoom features. If you need to adjust the screen space for the graphical view, you can open or close the tool bar via the context menu or the Visible tab on the Setup dialog (Setup Dialog on page 354). 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 via a right-click (context) menu. See Showing/Hiding and Docking/Undocking Trend Display Components on page 388.

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

Figure 279. Tool Bar

BackwardScope Step

Large/Small

Zoom DefaultScope

ZoomOut

InSmall/LargeForward

Scope Step

ActiveZoom

Level/Enable

Set StartTime

Set Start Time button is onlyavailable when Scope Typeis Start Scope or Start End.

3BUF001094R4101 383

Using the Scope/Zoom Tool Bar Section 4 Using Desktop Trends

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 280. This lets you 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.

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 lets you change the Active Zoom factor in the interval 1 to 10.

Figure 280. Set Start Time

384 3BUF001094R4101

Section 4 Using Desktop Trends Using the Table (Info) Area

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 lets you adjust the size of the active zoom. If the slide bar is turned off in the Visible tab (see Setup Dialog on page 354), 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 277.

Using the Table (Info) AreaThe table view lets you 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 via the Limits column. The Trace and Limits cells indicate the trace color.

If you need to adjust the screen space for the graphical view, you can open or close the table via the context menu or the Visible tab on the Setup dialog (Setup Dialog on page 354). 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 via a right-click (context) menu. See Showing/Hiding and Docking/Undocking Trend Display Components on page 388

Adjusting Column Widths

You can 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 you can use the Column Widths tab on the Setup dialog. See Setup Dialog on page 354.

3BUF001094R4101 385

Using the Table (Info) Area Section 4 Using Desktop Trends

Trace

You can alternately show or hide a trace by checking or unchecking its check box. These check boxes are color-coded to match the trace color.

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. You can disable this function via the Miscellaneous Settings tab on the Setup dialog (Database Information on page 361). When this function is enabled, you can supersede the database reading by entering a value directly in the table (info) area or via the Property Page; however, the database settings will replace any entries you’ve made the next time you open the Trend display.

Type

This pull-down list lets you select the presentation for the trace in the graphical view. The options are shown in Figure 281 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. See Ruler Value on page 387.

Pole - Each pole represents a value.

Step and Rev. Step - Time between values represented as horizontal line.

Figure 281. Trace Types

Poles StepsLines

386 3BUF001094R4101

Section 4 Using Desktop Trends Using the Table (Info) Area

Status

This cell shows the quality status of the tag data (trace colors are set on the Trace tab of the Property Page - see Property Page on page 366):

• When the status is GOOD, the trace color appears as Normal Data.

• 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. If you place the ruler 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 position. If you place the ruler 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. You can disable this function via the Miscellaneous Settings tab on the Setup dialog (Database Information on page 361). When this function is enabled, you can supersede the database reading by entering a value directly in the table (info) area or via the Property Page; however, the database settings will replace any entries you’ve made the next time you open the Trend display.

Filter

The trend filter is a low pass filter that lets you 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 you are given a true trace. At 0.0, all but one point is removed resulting in a flat trace. The relationship is linear so that at 0.5 fifty percent of the points would be removed.

3BUF001094R4101 387

Showing/Hiding and Docking/Undocking Trend Display Components Section 4 Using Desktop

Time Offset

This cell shows the time offset for the trace. You can set the time scope directly by selecting the cell, and then entering the desired offset. See Applying Time Offsets on page 393.

Limits

You can 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. You can disable this function via the Miscellaneous Settings tab on the Setup dialog (Database Information on page 361). When this function is enabled, you can supersede the database reading by entering a value directly in the table (info) area or via the Property Page; however, the database settings will replace any entries you’ve made the next time you open the Trend display.

Showing/Hiding and Docking/Undocking Trend Display ComponentsRight-clicking outside the trend area displays a context menu which lets you show/hide or dock/undock the Zoom/Scope bar and Table (Info) area, Figure 282. 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 location.

Figure 282. Context Menu for Zoom Bar and Info Area

388 3BUF001094R4101

Section 4 Using Desktop Trends Viewing Trend Statistics

Viewing Trend StatisticsYou can display statistical data such as average, minimum, maximum, and standard deviation for the trend traces via the Info area context menu. To do this right-click in the Trend area and choose Statistics from the context menu, Figure 283.

This displays the Statistics window, Figure 284. You can set the resolution for the statistical values via the Decimal Places control. The default is three decimal places.

You can 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 285. You can also drag statistical information to the external application if this functionality is supported by the application.

Figure 283. Showing Statistics

Figure 284. Trace Statistics

3BUF001094R4101 389

Viewing Trend Statistics Section 4 Using Desktop Trends

Figure 285. Copying Statistics for Selected Traces to the Clipboard

390 3BUF001094R4101

Section 4 Using Desktop Trends Copying and Pasting Trend Data to Other Applications

Copying and Pasting Trend Data to Other ApplicationsThe copy trace function lets you copy data for a selected trace from the graphical view and then paste the copied data into a third party software application such as 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. If you want 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/TimeValue Trace01/05/01 13:50:3528.00101/05/01 13:51:3516.50101/05/01 13:52:3514.00101/05/01 13:54:1524.50101/05/01 13:54:5635.00101/05/01 13:55:3636.00101/05/01 13:56:3624.50101/05/01 13:57:3614.00101/05/01 13:58:3616.50101/05/01 13:59:3629.00101/05/01 14:00:3637.501

Some applications, for example Microsoft Excel and DataDirect, may require you to change the timestamp format in order to show the seconds column when you paste trace data into the application.

3BUF001094R4101 391

Copying and Pasting a Bitmap Image of the Trend Display Section 4 Using Desktop Trends

Copying and Pasting a Bitmap Image of the Trend DisplayAs an option you can 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.

2. If you want 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.

Selecting the Time Scale for a TraceThe Property Page lets you specify whether to use one common time scale for all traces, or whether to use a dedicated time scale for each trace. If you choose to use multiple time scales, 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 287. The time scale is displayed in the same color as the trace.

Figure 286. Copy Bitmap

Figure 287. Selecting the Time Scale for a Specific Trace

392 3BUF001094R4101

Section 4 Using Desktop Trends Applying Time Offsets

Applying Time OffsetsYou can apply a time offset to a trace to compare one location (time) to another location 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:seconds (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 288. 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 288. Example, Same Trend With and Without Time Offset

3BUF001094R4101 393

Saving the Current Display Section 4 Using Desktop Trends

Saving the Current DisplayThe Save button, Figure 289, lets you save the current Trend Display as an Html file.

Clicking this button displays a standard Windows Save dialog, Figure 292. This dialog points to the default location where Trend Display html files are stored (C:\ABB Industrial IT\Inform IT\Desktop Trends\Data\Html). You can point this dialog to another location if you want to store the files in another directory.

Once a display has been saved as an Html file, you can reopen it for viewing as described in Opening a Saved Display on page 395.

Figure 289. Opening the Save Dialog

Figure 290. Saving the Current Trend Display as an Html File

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 via the Internet Explorer user interface.

Save Button

394 3BUF001094R4101

Section 4 Using Desktop Trends Opening a Saved Display

Opening a Saved DisplayThe Open button lets you open an existing Trend Display which was previously saved as an html file, Figure 291.

Clicking this button displays a standard Windows file chooser dialog, Figure 292. This dialog points to the default location where Trend Display html files are stored (C:\ABB Industrial IT\Inform IT\Desktop Trends\Data\Html). You can point this dialog to another location if you have files stored in another directory.

Figure 291. Opening the Open Dialog

Figure 292. Opening a Trend Display Saved as an Html File

Open Button

3BUF001094R4101 395

Printing the Current Display Section 4 Using Desktop Trends

Printing the Current DisplayThe Print button on the Trend Display, Figure 293, lets you 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.

Toggling between Print and Display ColorsThe button shown in Figure 294 lets you preview the print color settings.

Launching Other Desktop Trend Tools from the Trend DisplayThe tool bar lets you launch the other tools from the Trend Display, Figure 295.

Figure 293. Printing the Current Display

Figure 294. Toggling Print/Display Colors

Figure 295. Miscellaneous Tool Bar

Print Button

Toggle Print/Display Colors Button

TagExplorer

PDLBrowser

EventBrowser

SQLBrowser

Trend

Ticker

396 3BUF001094R4101

Section 4 Using Desktop Trends Ticker

TickerThe Ticker displays a repeating stream of real time data for selected tags, similar to a stock market ticker, Figure 296. It is an ActiveX control hosted within Windows Internet Explorer. You may 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. You may also specify whether to retrieve the actual process data or the last history value from the history log associated with the process tag.

To set up and use the ticker, follow the instructions in:

• Launching the Ticker on page 398

• Configuring Ticker Files on page 398

• Changing Ticker Defaults on page 421

• Operating the Ticker on page 432

Figure 296. 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 343.

3BUF001094R4101 397

Launching the Ticker Section 4 Using Desktop Trends

Launching the TickerAccess to the ticker is via the Windows task bar. To launch the ticker, from the Windows task bar, choose: Start>Programs>ABB Industrial IT 800xA> Information Mgmt>Desktop Trends>Ticker, Figure 297.

Configuring Ticker FilesTicker 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:

• You can create a ticker file via a configuration display. This procedure is described in Configuring Tags on page 400.

• You can also create ticker files by exporting a Tag Explorer file. This procedure is described in Exporting Files on page 461.

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, you can operate the ticker using the defaults for these global operating parameters. To adjust one or more global operating parameters, see Changing Ticker Defaults on page 421.

Figure 297. Launching the Ticker

398 3BUF001094R4101

Section 4 Using Desktop Trends Configuring Ticker Files

Working Off Line

During configuration, if the data source is unavailable or providing bad data, you can work in the off-line mode. This lets you suppress the annunciation of spurious error conditions. The status indicator will display the user-specified color for off-line status instead. To work off-line, right click on the ticker status indicator and choose Work Offline from the context menu, Figure 298.

Figure 298. Working Off-line

3BUF001094R4101 399

Configuring Tags Section 4 Using Desktop Trends

Configuring TagsTicker files may be configured via the Tag Configuration dialog. To open this dialog, right click on the ticker status indicator and choose Configure Tags from the context menu, Figure 299.

The Tag Configuration dialog is shown in Figure 300. This dialog has two tabs.

Use the Tags tab to specify which tags to include in the ticker file. You can add tags 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.

Figure 299. Opening the Configure Tags Dialog

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.

400 3BUF001094R4101

Section 4 Using Desktop Trends Configuring Tags

Figure 300. Tag Configuration Dialog

3BUF001094R4101 401

Adding Tags Section 4 Using Desktop Trends

Adding TagsThe Tags tab lets you select which tags to include in the ticker file.

This tab has two views:

• The New Style view supports adding tags that reside on an OPC server (for example the 800xA OPC DA server). This is the default view (selected by clicking the New Style radio button in the bottom left corner of the dialog, Figure 301. For details on using this view, see Browsing for OPC Objects on page 403.

• 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 radio button, then refer to Adding an Advant OCS Tag on page 407.

It is recommended that you limit the size of a Ticker File to no more than 50 tags.

Figure 301. Selecting New Style View

402 3BUF001094R4101

Section 4 Using Desktop Trends Browsing for OPC Objects

Browsing for OPC ObjectsThe New Style view provides an OPC Browser that lets you browse the connected OPC server to find OPC objects to add as tags on the ticker. This section describes the basic procedure for using the browser. For details regarding the various functions for helping you navigate and select objects see Section 7, Browsing for OPC Tags.

To add the tag for an object property:

1. In the left pane, browse to the location for property logs (usually the control structure).

The data provider defaults to AIPOPC which lets you browse the plant structure for real time OPC-type tags. This is recommended when adding OPC tags for the Ticker and Tag Explorer.

If you want 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 302. You may also change the data provider specification for individual tags once they are selected. This is described later in this procedure.

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.

– Select a folder then choose Get Entire List from the context menu. This shows all 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. Figure 303 shows how a filter may be used to limit the scope of selectable objects.

Figure 302. Example, Changing the Data Provider

3BUF001094R4101 403

Browsing for OPC Objects Section 4 Using Desktop Trends

– With AIPHDA, you can use the Seamless retrieval option when you are unsure which component log within the property log will provide best coverage of the requested time range.

The available objects (of the applicable type) will be displayed in the available tags list in right pane.

2. Select one or more objects from the available tags list, Figure 304, and then click Add Selected Tags to move them to the Selected Tags list (bottom pane), Figure 305.

Figure 303. Filtering Example

Example Filter

Filter result

404 3BUF001094R4101

Section 4 Using Desktop Trends Browsing for OPC Objects

3. You can combine tags from different locations by repeating steps 2 and 3.

Figure 304. Selecting Available tags

You can move all available tags by clicking Add All Tags, however, you should be careful when selecting this option, particularly if the available tag list is unfiltered.

Figure 305. Selected Tags Added

3BUF001094R4101 405

Browsing for OPC Objects Section 4 Using Desktop Trends

4. As an option, you can modify tag attributes by clicking the applicable cell as illustrated in Figure 306.

5. To remove a tag from the selected tags list, check the corresponding check box, then click Remove Selected Tags, Figure 307.

6. When you are finished selecting tags, click OK. This adds the tags to the ticker. As an option, you can copy tags from this browser to the clipboard for pasting into external applications.

Figure 306. Modifying Tag Attributes

Figure 307. Removing a Tag from the Selected Tags List

406 3BUF001094R4101

Section 4 Using Desktop Trends Adding an Advant OCS Tag

Adding an Advant OCS TagUse the Old Style view to add Advant OCS tags. First click the Old Style radio button in the bottom left corner of the Tag Configuration dialog, Figure 308. This displays the Old Style view, Figure 309.

Figure 308. Selecting the Old Style View

Figure 309. Old Style View

3BUF001094R4101 407

Adding an Advant OCS Tag Section 4 Using Desktop Trends

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 dialog. For example, when you click in the first field, the Tag Name label is highlighted, and the tag name pick list is displayed, Figure 310.

Configure the tag properties according to:

• Tag Name on page 409

• Attribute and Object Type on page 410

• Limit Check on page 411

• Subscription Type on page 411

• Data Provider on page 412

Related procedures are described in:

• Adding Tags on page 412

• Copying an Existing Tag on page 413

• Removing Tags from the File on page 414

• Reverting to the Saved Configuration for a Tag on page 415

Figure 310. Example Activating a Field

Tag Name LabelHighlighted

Tag Name Picklist Displayed

408 3BUF001094R4101

Section 4 Using Desktop Trends Adding an Advant OCS Tag

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 310. You can enter the value directly in the field, or use the corresponding pick list.

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 lets you display another set of up to 25 tags in the pick list, Figure 311.

To add aspect objects from the platform’s OPC DA or OPC HDA server, use the Browse button. See Browsing for OPC Objects on page 403.

Figure 311. Selecting the Next Set of Tags

Use this pull-down listto select another setof up to 25 tags

3BUF001094R4101 409

Adding an Advant OCS Tag Section 4 Using Desktop Trends

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

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 you are setting the high and low limits by referencing other OPC tags. In that case, enter the user-defined high/low limit object type configured in the Limits text file (see Setting Up the Limits File on page 346), and set the Limit Check option to Get From System (Limit Check on page 411).

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, you must specify the object type, tag name, and attribute. MOD 300 Example:

Object Type = CCF_CONTIN_LOOP Tag = AFWAVE1 Attribute = MEASURE

Master Example:

Object Type = PIDCON Tag = AFWAVE2 Attribute = VALUE

410 3BUF001094R4101

Section 4 Using Desktop Trends Adding an Advant OCS Tag

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.

Specify one of the following options:

• Get From System - Use high/low limits from the data source. This requires you to configure the Limits text file (see Setting Up the Limits File on page 346). 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 346.

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 you invoke the Refresh Limits menu item.

• 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, you can specify whether to retrieve the Realtime Value directly from the process tag, or the Last History Value from the corresponding History log.

When the data source is an OPC server, the subscription type must be OPC Value.

To enable this check the Tag(s) Out of Range option must be selected on the Indicator tab of the Ticker Default Configuration dialog. See Changing Ticker Defaults on page 421.

To subscribe to the last history value, the corresponding data provider must reside on the same node where the history log is located.

3BUF001094R4101 411

Adding Tags Section 4 Using Desktop Trends

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 you use the aspect object browser, the corresponding data provider is automatically filled in. For all other tags, you must specify the applicable data provider. Data providers are uniquely identified by the -name argument. These data providers are configured via 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.

If you need to look up the -name for a data provider, use the Server Status tool (Start>Programs ABB Industrial IT 800xA>Information Mgmt> Display Services>Server Status). When asked to indicate the server with which to connect, be sure to specify the server where the tag resides. Refer to Industrial IT 800xA - Information Management Configuration for further information regarding the Server Status tool, and data providers in general.

Adding TagsYou can add up to 50 tags. Each time you add a tag, the dialog will provide another set of tag specification fields to let you add another tag, Figure 312.

As an alternative, you can use the following procedure to copy tag specifications.

Figure 312. Adding Additional Tags

Another Set of Tag Specification Fields Added

412 3BUF001094R4101

Section 4 Using Desktop Trends Copying an Existing Tag

Copying an Existing TagTo make one or more copies of an existing tag, right click on the tag to be copied. This displays a context menu with two options: Copy Once or Copy Multiple Times, Figure 313

If you choose to make a single copy, a dialog is provided for specifying the new tag’s name, Figure 314. 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.

When you make multiple copies, 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 you are 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.

Figure 313. Copying an Existing Tag

Figure 314. Copy Once

3BUF001094R4101 413

Removing Tags from the File Section 4 Using Desktop Trends

Removing Tags from the FileTo remove a tag from the file, click the check box next to the tag, Figure 315, then click Remove.

This displays a confirmation message Figure 316. Click Yes to confirm, or No to cancel the remove request.

Figure 315. Marking the Tag Specification

Figure 316. Confirming the Remove Request

Tag Marked forRemoval

414 3BUF001094R4101

Section 4 Using Desktop Trends Reverting to the Saved Configuration for a Tag

Reverting to the Saved Configuration for a TagWhile editing the tag specification for a ticker file, you can revert back to the saved version BEFORE you save the latest changes. To do this, click the check box next to the tag, Figure 315, then click Revert.

This displays a confirmation message. Click Yes to confirm, or No to cancel the revert request.

Configuring the Appearance of the Ticker FileThe Appearance tab in the Tag Configuration dialog lets you modify the appearance attributes for the current ticker file, Figure 317. These attributes are described in Table 17. When you change an appearance attribute in this dialog, you can preview the result in the sample ticker view on the bottom of the dialog.

Figure 317. Appearance Tab on Tag Configuration Dialog

PreviewChanges

3BUF001094R4101 415

Configuring the Appearance of the Ticker File Section 4 Using Desktop Trends

Table 17. Tag & Ticker Appearance Attributes

Attribute Description

Tag Appearance - Normal, Out of Range, and Unconnected Colors

These fields let you specify the colors for indicating tag status (normal and out-of-range), and connection status. To change a color, see Changing Colors on page 419.

Tag Appearance - Font This field lets you specify the font for the ticker text. To change the font, see Changing the Font on page 420.

Ticker Appearance - Background Color

This field lets you specify the background color for the ticker area. To change a color, see Changing Colors on page 419.

Ticker Appearance - Border Style

This field lets you specify whether or not to show a border around the ticker area. The choices are Single border or None.

Ticker Appearance - Speed This field lets you 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.

Ticker Appearance - Tag Refresh Rate

This field lets you specify the rate at which tag data is refreshed. The range is 1 to 65 seconds. The recommended refresh rate is 15 seconds for best performance.

Ticker Appearance - Data Format

This field lets you specify the format of the numeric string. See Data Format on page 417.

416 3BUF001094R4101

Section 4 Using Desktop Trends Configuring the Appearance of the Ticker File

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.

. 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 your system.

% Percentage placeholder. The expression is multiplied by 100. The percent character (%) is inserted in the position where it appears in the format string.

3BUF001094R4101 417

Configuring the Appearance of the Ticker File Section 4 Using Desktop Trends

, 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, you can 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 Number Format recognized by your system.

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

418 3BUF001094R4101

Section 4 Using Desktop Trends Configuring the Appearance of the Ticker File

Changing Colors

To change a color:

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 Windows color palette, Figure 318.

Figure 318. Configuring Tag Appearance Color

Text Label for Selected Field Changes to White

3BUF001094R4101 419

Configuring the Appearance of the Ticker File Section 4 Using Desktop Trends

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

Figure 319. Changing the Font

420 3BUF001094R4101

Section 4 Using Desktop Trends Changing Ticker Defaults

Changing Ticker DefaultsThe 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 let you associate pick lists in the Tag Configuration dialog with their corresponding text files.

• Miscellaneous parameters for the aspect object browser.

For the most part, you can operate the ticker 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, Figure 320.

Figure 320. Configuring Ticker Defaults

3BUF001094R4101 421

Changing Ticker Defaults Section 4 Using Desktop Trends

This displays the Default Ticker Configuration dialog, Figure 321.

Click the tab corresponding to the parameters you need to configure:

• Use the Ticker tab to configure default appearance characteristics for ticker based on the selected ticker file. Most of these characteristics are the same characteristics that you configure when you create a new ticker file. For details, see Configuring the Appearance of the Ticker File on page 415.

Data Delimiter must be configured on a global basis for all tags, and cannot be configured on an individual tag basis. See Configuring the Data Delimiter on page 423.

• Use the Indicator tab to configure the method for indicating error conditions on the ticker. See Configuring Error Condition Indicators on page 427.

• Use the Files tab to associate pick lists in the Tag Configuration dialog with their corresponding text files. See File Specifications on page 429.

Figure 321. Default Ticker Configuration Dialog

422 3BUF001094R4101

Section 4 Using Desktop Trends Configuring the Data Delimiter

Configuring the Data DelimiterThe data delimiter separates the tag name from the tag attribute in a tag specification, for example TC101:MEASURE. The default delimiter is a colon (:). You can change the delimiter as needed. When you change the delimiter you must also convert all ticker and tag explorer files that are currently using the old delimiter. This is demonstrated in the following example:

1. Start by changing the delimiter, for example, from : to -.

This displays a warning that you will be required to change all ticker and tag explorer files, Figure 322.

2. Click Yes to acknowledge the warning.

3. Click OK to register the changes in the Default Ticker Configuration dialog. This displays a confirmation message, Figure 323.

4. Click Yes to confirm. This displays a browser dialog for selecting the directory where the ticker files reside.

Figure 322. Change Delimiter Warning

Figure 323. Change Delimiter Confirmation

3BUF001094R4101 423

Configuring the Data Delimiter Section 4 Using Desktop Trends

5. Use the browser dialog, Figure 324, 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 you’ve selected the Ticker Files directory, click OK. This displays a prompt asking whether or not to convert Explorer backup files, Figure 325.

7. Click Yes if you want 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 if you want to convert Ticker files only. This starts the conversion process as illustrated in Figure 327. In this case, skip step 8.

Figure 324. Selecting the Ticker Files Directory

Figure 325. Prompt to Convert Explorer Backup Files

424 3BUF001094R4101

Section 4 Using Desktop Trends Configuring the Data Delimiter

8. To convert Explorer backup files, use the browser dialog, Figure 326, to navigate to and select the applicable directory. The default is C: Program Files\ABB Industrial IT\Inform IT\Desktop Trends\Bin.

Then click OK to start the conversion process. This displays a progress indicator, Figure 327.

Figure 326. Selecting the Ticker Files Directory

3BUF001094R4101 425

Configuring the Data Delimiter Section 4 Using Desktop Trends

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

– If there are no more directories with files that require conversion, click Ok. This exits the conversion mode.

Figure 327. Conversion In Progress

426 3BUF001094R4101

Section 4 Using Desktop Trends Configuring Error Condition Indicators

Configuring Error Condition IndicatorsClick the Indicator tab to display the error indicator parameters, Figure 328. There are four basic categories: Errors to Show, Colors, Priorities, and Behavior.

Errors to Show

This lets you specify whether to annunciate or ignore error conditions. You can 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 you can specify whether or not the status indicator will blink.

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 indicator in the specified color. In addition, a warning message is displayed if you attempt to clear the ticker without first saving the ticker file.

Figure 328. Indicator Tab

3BUF001094R4101 427

Configuring Error Condition Indicators Section 4 Using Desktop Trends

Colors

This lets you select a unique color for each error condition. For details on how to select a new color see Changing Colors on page 419.

Priorities

This lets you associate a priority with each of the possible error conditions. This may be used when you specify the Behavior for the case where multiple error conditions exist at the same time.

Behavior

This lets you enable/disable blinking, and lets you specify the behavior of the status indicator 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.

428 3BUF001094R4101

Section 4 Using Desktop Trends File Specifications

File SpecificationsThe Files tab lets you associate text files with their respective pick lists, Figure 329. It also lets you specify the default location for ticker files.

To change any of the default specifications, click the corresponding browse button. This displays a standard Windows File Chooser dialog, Figure 330. 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 lets you change the corresponding text file, Figure 331.

For guidelines on editing text files, see:

• Setting Up Pick Lists on page 343

• Setting Up the Limits File on page 346

Figure 329. Files Selection Dialog

Click Browse Buttonto Display File Chooser

Click Ed. Buttonto Open the Filein a Text Editor

3BUF001094R4101 429

Aspect Object Browser Defaults Section 4 Using Desktop Trends

Aspect Object Browser DefaultsThe Misc tab lets you specify the default data provider and default subscription type for the aspect object browser, Figure 332.

Figure 330. Browsing for a Text File

Figure 331. Opening a File in a Text Editor

430 3BUF001094R4101

Section 4 Using Desktop Trends Aspect Object Browser Defaults

Default Data Provider

The default data provider is AIPOPC. This supports access to real-time process and softpoint objects in the 800xA system. If you intend to retrieve the last history value rather than the actual real-time value, you can change the default to AIPHDA. This supports access to property logs in the 800xA system.

Default Subscription Type

You can 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.

Figure 332. Misc Tab for OPC HDA Access

3BUF001094R4101 431

Operating the Ticker Section 4 Using Desktop Trends

Operating the TickerThe 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 432

• Showing Errors on page 433

• Saving the Ticker File on page 434

• Clearing the Ticker on page 436

• Dragging and Dropping Tags Between Desktop Trend Controls on page 437

• Refreshing Tag Limits on page 442

• Displaying Version Information for the Ticker Controls on page 442

• Launching the Trend Display from the Ticker on page 443

Displaying Real Time Data on the Ticker

To display real time data on the ticker you must open an existing ticker file, or configure a new file. To configure a new file, refer to Configuring Ticker Files on page 398.

To open an existing file, right click on the ticker status indicator and choose Open Ticker File from the context menu, Figure 333.

Figure 333. Opening a Ticker File

432 3BUF001094R4101

Section 4 Using Desktop Trends Operating the Ticker

This displays a standard Windows file chooser dialog, Figure 334. 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 you have stored ticker files.

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 via the Indicator tab in the Default Ticker Configuration dialog. For instance, you can configure whether or not to annunciate tags out of range, or unconnected tags. You can also specify how to handle multiple error conditions, and whether or not to have the status indicator blink.

Regardless of how you configure these parameters, you can always display a message box that describes the current error conditions for the ticker. To do this right click on the ticker status indicator and choose Show Current Errors from the context menu, Figure 335.

Figure 334. Open Ticker File

3BUF001094R4101 433

Operating the Ticker Section 4 Using Desktop Trends

An example message box is shown in Figure 336. Click OK to acknowledge.

Saving the Ticker File

The ticker file must be saved if you want 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 337.

Figure 335. Showing Current Errors

Figure 336. Current Errors Message Box

434 3BUF001094R4101

Section 4 Using Desktop Trends Operating the Ticker

The Save dialog points to the default folder for storing ticker files, Figure 338: (C:\Program Files\ABB IndustrialIT\InformIT\Desktop Trends\Data). It is recommended that you store the files in this folder because this makes it easier to find the files when you want to display one on the ticker. This is where the File-Open dialog points by default. If necessary, you can specify another location.

Figure 337. Saving the Ticker File

Figure 338. Save Ticker File Dialog

3BUF001094R4101 435

Operating the Ticker Section 4 Using Desktop Trends

Clearing the Ticker

To remove the current file from the ticker, right click and choose Clear Ticker from the context menu, Figure 339.

If the current ticker file has not been saved, a warning message will be displayed, Figure 340.

At this point you can either save the file (Saving the Ticker File on page 434), clear the file without saving, or cancel the clear request.

Figure 339. Clearing the Ticker

Figure 340. File Not Saved Warning

436 3BUF001094R4101

Section 4 Using Desktop Trends Dragging and Dropping Tags Between Desktop Trend Controls

Dragging and Dropping Tags Between Desktop Trend ControlsAn 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

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.

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, Figure 341.

Drag and drop the tag on the destination control, Figure 342.

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.

You can drag the tags directly onto the desktop control, or into a tag specification in the Tag Configuration dialog (see Configuring Tags on page 400).

Figure 341. Pointing to the Tag to Be Copied

Pointing to the Tag in the Source Ticker

3BUF001094R4101 437

Dragging and Dropping Tags Between Desktop Trend Controls Section 4 Using Desktop Trends

Figure 342. 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, you will be asked 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, if you want to preserve the new file, you must execute a save.

Indicates Suitable Location for Dropping

438 3BUF001094R4101

Section 4 Using Desktop Trends Dragging and Dropping Tags Between Desktop Trend Controls

Dragging and Dropping from a Text Editor or Spreadsheet

To drag and drop a tag from a text editor or spreadsheet, you must enter the tag specification as a properly formatted text string in the editor or spreadsheet. The properties are listed in Table 18. For text editors, put each tag on a separate line, and separate each property with a colon (:). For spreadsheets, put each tag on a separate row, and enter each property in a separate column.

Table 18. 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, see Tag Name on page 409.

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 you are working off-line.

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: (See Data Provider on page 412)• 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.

3BUF001094R4101 439

Dragging and Dropping Tags Between Desktop Trend Controls Section 4 Using Desktop Trends

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. See Attribute and Object Type on page 410.

Subscription Type Enter one of the following subscription types, exactly as shown:• Realtime Value• Last History Value• OPC Value

Table 18. Tag Information Text String

Tag Properties Comment

440 3BUF001094R4101

Section 4 Using Desktop Trends Dragging and Dropping Tags Between Desktop Trend Controls

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

• 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 343.

Figure 343. Dragging and Dropping a Tag From Microsoft Word

3BUF001094R4101 441

Refreshing Tag Limits Section 4 Using Desktop Trends

Refreshing Tag LimitsThe 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 you invoke the Refresh Limits menu item. To do this, right click on the ticker status indicator and choose Refresh Limits from the context menu, Figure 344.

Displaying Version Information for the Ticker ControlsTo 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, Figure 345.

Figure 344. Refreshing High/Low Limits

Figure 345. Ticker About Message Box

442 3BUF001094R4101

Section 4 Using Desktop Trends Launching the Trend Display from the Ticker

Launching the Trend Display from the TickerYou can launch the trend display directly from the ticker. To do this, right click on the ticker status indicator and choose Launch Trend Display from the context menu, Figure 346.

This displays list of tags defined in the current tag file, Figure 347. You can use this dialog to select up to eight tags for display on the trend display. If you check 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.

Figure 346. Launching the Trend Display from the Ticker

Figure 347. Selecting Tags for the Trend Display

3BUF001094R4101 443

Refreshing the Ticker in Internet Explorer Section 4 Using Desktop Trends

Refreshing the Ticker in Internet ExplorerIf you use the Refresh function in Internet Explorer to refresh the Ticker File which is currently displayed, the file will be overwritten with an empty file. You can configure a parameter in the current Ticker File’s HTML file so that the current file is refreshed rather than overwritten.

To do this, 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 in the top view of Figure 348, and enter the full path for the Ticker File between the quotation marks. An example is illustrated in the bottom view of Figure 348.

Figure 348. Editing the Refresh Parameter in the Ticker File

Enter the full path for the Ticker File between These Quotation Marks

Example of full path for the Ticker File

444 3BUF001094R4101

Section 4 Using Desktop Trends Tag Explorer

Tag ExplorerThe Tag Explorer provides a graphical interface, similar to Windows Explorer, for navigating the tag database and displaying real time data in tabular format, Figure 349.

To set up and use the Tag Explorer, follow the instructions in:

• Launching the Tag Explorer on page 446

• Configuring the Tag Explorer on page 446

• Using the Tag Explorer on page 459

Figure 349. Example, Tag Explorer

Before you begin 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 343.

3BUF001094R4101 445

Launching the Tag Explorer Section 4 Using Desktop Trends

Launching the Tag ExplorerAccess to the Tag Explorer is via the Windows task bar. To launch the Tag Explorer, from the Windows task bar, choose: Start>Programs>ABB Industrial IT 800xA> Information Mgmt>Desktop Trends>Tag Explorer, Figure 350.

Configuring the Tag ExplorerThe Tag Explorer must be set up on two levels: tag groups and appearance/operation:

Tag Groups - The Tag Explorer organizes tags in tag groups. You can view tag information for one selected group at a time. To set up the Tag Explorer you must 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 447 and Specifying the Contents Tag Groups on page 448.

Appearance/Operation - The Tag Explorer has configurable parameters that govern its appearance and operation. See Configuring the Tag Explorer Appearance and Operational Characteristics on page 452.

Working Off Line

During configuration, if the data source is unavailable or providing bad data, you can work in the off-line mode. This lets you suppress spurious error conditions. Tags will be displayed in the user-specified off-line status color instead. To work off-line, right click and choose Work Offline from the context menu.

Figure 350. Launching the Tag Explorer

446 3BUF001094R4101

Section 4 Using Desktop Trends Creating Tag Groups

Creating Tag GroupsTags are organized in user-defined groups in the Tag Explorer. You can add groups on two levels. At the highest level, you can add a group directly under the Tag Groups object in the Tag Explorer tree view, Figure 351.

You can also add tag groups as children under an existing parent tag group. The existence of children tag groups under a parent tag group is indicated by the +/- symbol, Figure 352.

To add a new tag group, click on the parent object where you want to add the tag group, then right click and choose New>Tag Group from the context menu, Figure 353.

This adds a new group under the selected parent object. The default name is highlighted, and the cursor is poised to let you rename the new group, Figure 354.

Figure 351. Adding Tag Groups Under the Tag Groups Object

Figure 352. Indication of Children Tag Groups Under a Parent

Figure 353. Adding a New Tag Group

Highest Level for Adding Tag Groups

+/- Symbol Indicates Existence of Children Tag Groups Under a Parent

3BUF001094R4101 447

Specifying the Contents Tag Groups Section 4 Using Desktop Trends

Specifying the Contents Tag GroupsTags can be added to tag groups in either of two ways:

• Adding tags to an explorer file via the Tag Configuration dialog. This procedure is described in Adding Tags to an Explorer File on page 449.

• Importing an existing ticker or explorer file. This automatically adds all tags in the file to the tag group. This procedure is described in Importing Files on page 450.

Figure 354. Changing the New Group’s Name

It is recommended that you limit the size of a tag group to no more than 50 tags.

448 3BUF001094R4101

Section 4 Using Desktop Trends Specifying the Contents Tag Groups

Adding Tags to an Explorer File

You can specify the contents of a tag group by manually adding tags to an explorer file. This is done via the Tag Configuration dialog. To display this dialog, select the tag group, right click, and then choose New>Tag(s) from the context menu, Figure 355.

The operation of this dialog is the same as for adding tags to a ticker file. For details, see Configuring Tags on page 400.

Modifying the Configuration for an Existing Tag

You can display the Tag Configuration dialog for an existing tag to modify the tag’s configuration. To this, double-click on the tag.

Figure 355. Adding an Individual Tag

It is recommended that you limit the size of a tag group to no more than 50 tags.

3BUF001094R4101 449

Specifying the Contents Tag Groups Section 4 Using Desktop Trends

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 via the Tag Configuration dialog. This procedure is described in Configuring Tags on page 400.

The procedure for importing ticker and explorer files is essentially the same. To import a file, select the tag group, right click, and then choose Import Ticker File or Import Explorer File from the context menu. The example in Figure 356 illustrates the procedure for importing a ticker file.

This displays a dialog for selecting the file to import, Figure 357. 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 you have stored ticker (or explorer) files.

Figure 356. Example - Importing a Ticker File

450 3BUF001094R4101

Section 4 Using Desktop Trends Clearing the Current Tag Explorer Configuration

Clearing the Current Tag Explorer Configuration

You can clear the contents of the Tag Explorer. To do this right click, and then choose Import/Export>Clear Current Configuration File from the context menu, Figure 358.

This will display a confirmation message. Click Yes to confirm and continue the clear operation, or click No to cancel.

Figure 357. Import Ticker File Dialog

Figure 358. Clearing the Current Configuration File

3BUF001094R4101 451

Configuring the Tag Explorer Appearance and Operational CharacteristicsSection 4 Using Desktop

Configuring the Tag Explorer Appearance and Operational CharacteristicsTo adjust the appearance and operating parameters for the Tag Explorer, right click and choose Configure Tag Explorer from the context menu, Figure 359.

The configuration dialog, Figure 360, lets you configure three basic sets of appearance/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 359. Launching the Dialog for Configuring the Tag Explorer

452 3BUF001094R4101

Section 4 Using Desktop Trends Configuring the Tag Explorer Appearance and Operational

Figure 360. Tag Explorer Configuration Dialog

3BUF001094R4101 453

Configuring the Tag Explorer Appearance and Operational CharacteristicsSection 4 Using Desktop

Configuring the General Appearance

These attributes are organized in four basic categories, and are described in Table 19.

Table 19. Tag Explorer General Appearance Characteristics

Attribute Description

Tree View The check boxes in this section let you show or hide certain aspects of the Tag Explorer tree view. See Figure 361 for details.

Colors These fields let you specify the colors for indicating tag status (normal and out-of-range), and connection status. To change a color, see Changing Colors on page 419.

List View The check boxes in this section let you show or hide certain aspects of the Tag Explorer list view. See Figure 362 for details.

Data These fields let you set the tag refresh rate, and specify the Data format.

Figure 361. Tree View Adjustments

All Enabled(Default)

Icons Enabled Lines Enabled Plus/MinusEnabled All Disabled

454 3BUF001094R4101

Section 4 Using Desktop Trends Configuring the Tag Explorer Appearance and Operational

Columns

This tab lets you select which columns to show or hide in the list view, Figure 363. You can also change the name of any column.

Figure 362. List View Adjustments

Details - Default

List (or Small Icons)

Large Icons

3BUF001094R4101 455

Configuring the Tag Explorer Appearance and Operational CharacteristicsSection 4 Using Desktop

Figure 363. Adjusting the List View Columns

456 3BUF001094R4101

Section 4 Using Desktop Trends File Specifications

File SpecificationsThe Files tab lets you associate text files with their respective pick lists, Figure 364. It also lets you specify the default location for tag group specifications.

To change any of the default specifications, click the corresponding browse button. This displays a standard Windows File Chooser dialog, Figure 330. Use this dialog to navigate to and select the text file (for pick lists) or folder (for tag groups).

Clicking the Ed. Button launches a text editor that lets you change the corresponding text file, Figure 366.

For guidelines on editing text files, see:

• Setting Up Pick Lists on page 343

• Setting Up the Limits File on page 346

Figure 364. Tag Explorer - Files Specification Dialog

Click Browse Buttonto Display File Chooser

Click Ed. Buttonto Open the Filein a Text Editor

3BUF001094R4101 457

File Specifications Section 4 Using Desktop Trends

Figure 365. Browsing for a Text File

Figure 366. File Editor

458 3BUF001094R4101

Section 4 Using Desktop Trends Using the Tag Explorer

Using the Tag ExplorerThe method of operation for Tag Explorer is similar to Windows Explorer. You use the tree view to navigate to and select a tag group for viewing. This displays the corresponding tags in the tag list, Figure 367.

The context menu for tags, Figure 368, supports several viewing functions as described in Table 20.

Figure 367. Viewing Tags in Tag Explorer

Figure 368. Context Menu for Tags in Tag Explorer

3BUF001094R4101 459

All Tags Section 4 Using Desktop Trends

All Tags

The All Tags groups is a read-only Tag Group that lets you 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.

Table 20. Tag Context Menu Items

Menu Item Description

View This lets you 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.

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. See Limit Check on page 411.

Delete This deletes the currently selected tag.

Rename This lets you rename the currently selected tag.

Sort This lets you 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.

460 3BUF001094R4101

Section 4 Using Desktop Trends Dragging and Dropping Tags in Tag Explorer

Dragging and Dropping Tags in Tag ExplorerAn 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 437.

Exporting FilesYou can create a new ticker file by exporting the contents of a tag group. Similarly, you can 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 461

• Exporting a Tag Explorer File for Backup on page 463

Exporting a Tag Group to Create a New Ticker File

You can select the contents of any tag group to create a new ticker file. To do this select the tag group, right click, and then choose Import/Export >Export Ticker File from the context menu, Figure 369.

This displays a dialog for saving the file to a specified location, Figure 370. 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. You can rename the file if necessary. Click Save to save the file in the Data folder, or use the dialog to navigate to another location.

3BUF001094R4101 461

Exporting Files Section 4 Using Desktop Trends

Figure 369. Example - Exporting a Ticker File

Figure 370. Renaming the Exported File

462 3BUF001094R4101

Section 4 Using Desktop Trends Displaying Version Information for the Tag Explorer Controls

Exporting a Tag Explorer File for Backup

When you export the contents of a tag explorer file, the entire contents of the explorer file is exported. You cannot export individual tag groups. This procedure may be used to create a backup tag explorer file.

To create a backup tag explorer file, 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. You can rename the file if necessary. Click Save to save the file in the Bin folder, or use the dialog to navigate to another location.

Displaying Version Information for the Tag Explorer ControlsTo display version information for the Tag Explorer controls, right click and choose About from the context menu. This displays the About message box, Figure 345.

Figure 371. Ticker About Message Box

3BUF001094R4101 463

Launching the Trend Display from the Tag Explorer Section 4 Using Desktop Trends

Launching the Trend Display from the Tag ExplorerYou can 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, Figure 372.

This displays list of tags defined in the current tag group, Figure 373. You can use this dialog to select up to eight tags for display on the trend display.

If you check 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.

Figure 372. Launching the Trend Display from the Tag Explorer

464 3BUF001094R4101

Section 4 Using Desktop Trends Launching the Trend Display from the Tag Explorer

Figure 373. Selecting Tags for Trend Display

3BUF001094R4101 465

PDL Browser Section 4 Using Desktop Trends

PDL BrowserThe PDL Browser, Figure 374, lets you query PDL tasks for production data. There are three main sections. The top section lets you 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 lets you 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.

Figure 374. PDL Browser

SearchCriteria

SearchResults

PDLData

466 3BUF001094R4101

Section 4 Using Desktop Trends Opening the PDL Browser

To set up and use the PDL Browser, follow the instructions in:

• Opening the PDL Browser on page 467

• Setting Up the PDL Browser Interface on page 468

• Using the PDL Browser on page 476

Opening the PDL BrowserAccess to the PDL Browser is via the Windows task bar. To launch the PDL Browser, from the Windows task bar, choose: Start>Programs>ABB Industrial IT 800xA >Information Mgmt>Desktop Trends>PDL Browser, Figure 375.

Figure 375. Launching the PDL Browser

3BUF001094R4101 467

Setting Up the PDL Browser Interface Section 4 Using Desktop Trends

Setting Up the PDL Browser InterfacePDLs may be created by any one of four batch processing applications: Batch 300 (default), Taylor Control Language (TCL), Produce IT Batch, and Profile Historian. You must specify the type of PDL application you are using via the Configure PDL Browser dialog, Figure 376. This dialog also lets you specify date and time options as well as other miscellaneous options.

Figure 376. Configure PDL Browser Dialog

468 3BUF001094R4101

Section 4 Using Desktop Trends Setting Up the PDL Browser Interface

To configure these parameters, click Options, then refer to:

• Type of PDL on page 470

• Configuring Flexible Task Types on page 471

• Convert Task Value to Uppercase on page 472

• Use Restored Archive on page 472

• Maximum Values to be Returned on page 472

• Warn If Exceeded on page 472

• Default Time Span on page 473

• Date and Time Format on page 474

• Data Provider on page 475

• Query Timeout on page 476

• Language on page 476

• ProduceIT Messages on page 476

• Trend File on page 476

3BUF001094R4101 469

Setting Up the PDL Browser Interface Section 4 Using Desktop Trends

Type of PDL

Use this pick list to specify your 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 21.

Table 21. 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)(for Produce IT Batch version 1.1 and 1.2/0)

Campaign - Level 0 Batch - Level 1 Procedures Level 1 - Level 2,3 Procedures Level 2 - Level 3,12 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(use this option for Produce IT Batch version 1.2/1 and later)

Up to 15 user-configurable task types. See Configuring Flexible Task Types on page 471 for details.

The Produce IT Batch option is only applicable for Produce IT Batch versions 1.1 and 1.2/0. If you are using version 1.2/1 or later, select the Flexible PDL Type.

470 3BUF001094R4101

Section 4 Using Desktop Trends Setting Up the PDL Browser Interface

Configuring Flexible Task Types

The Flexible option in the Type of PDL pick list lets you configure up to 15 user-defined task types. Selecting Flexible enables the Customize button, Figure 377.

This button displays the Customize PDL Hierarchy dialog, Figure 378. Each level has a default name. You can change these names. You can also choose which levels to include in the Task Type list in the PDL Browser by checking the corresponding check box. Any level whose check box is checked is included in the list.

Figure 377. Selecting Flexible Type of PDL

Figure 378. Customize PDL Hierarchy Dialog

3BUF001094R4101 471

Setting Up the PDL Browser Interface Section 4 Using Desktop Trends

Convert Task Value to Uppercase

Queries for task names in the Oracle PDL database are case-sensitive. You can 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 lowercase values. The default is Unchecked (do not convert to uppercase).

Use Restored Archive

This option lets you 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).

Maximum Values to be Returned

This option lets you specify the maximum number of values to be returned to the client for each query that is executed. This helps you avoid hanging the client PC 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 lets you choose whether or not to display a message when the specified query result has more than the specified maximum values. This message lets you 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, see Limiting the Amount of Data Returned By Your Query on page 480.

If you uncheck this option, the specified maximum number of values to be returned will always be imposed and you will not be notified when the query result has additional values that are being discarded.

472 3BUF001094R4101

Section 4 Using Desktop Trends Setting Up the PDL Browser Interface

Default Time Span

The Default Time Span fields let you specify the default time span for the PDL Browser. If you generally use the same time span, this saves you from having to adjust the start or end times in the PDL Browser each time you enter a new query.

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 intervals. The range varies based on the interval type:

• Minutes, Hours, Days = 32767

• Weeks = 20800

• Months = 4800

• Years = 400

The default is 1 Week.

3BUF001094R4101 473

Setting Up the PDL Browser Interface Section 4 Using Desktop Trends

Date and Time Format

These pick lists let you select the format for displaying dates and times, Figure 379. If you need a format that is not available in the list you can build a custom format. To do this click the corresponding Build button and use the Build Date Format or Build Time Format dialog, Figure 380.

Figure 379. Specifying Date and Time Formats

The example fields are for reference only. Selecting a different date or time with these controls will not affect PDL browser operation. You may use this feature to check how the selected format will look for different dates.

Date Formats Time Formats

474 3BUF001094R4101

Section 4 Using Desktop Trends Setting Up the PDL Browser Interface

Data Provider

The PDL Browser accesses PDL data via an ADO data provider on the Historian server. This data provider is configured via the ADSS tool on the Windows Control Panel. In most cases, you should use the default ADO data provider (named DBA). If your application uses more than one ADO data provider for PDL access, or if your ADO data provider has a different name (not recommended), this field lets you specify the name of the data provider. For details regarding the ADO data provider refer to the Information Management Installation - post-installation procedures.

Figure 380. Building a Custom Date or Time Format

3BUF001094R4101 475

Using the PDL Browser Section 4 Using Desktop Trends

Query Timeout

This is the maximum time to wait for the selected object to respond to the query before timing out. You may need to increase the timeout interval for complex queries.

Language

This option specifies the language used for displaying message-type PDL data. Currently 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 lets you specify which html file to open when you launch the Trend Display from the History tab (See History on page 485). The corresponding button launches a file browser dialog if you need to specify a different html file.

Using the PDL BrowserUse the Search Criteria controls to retrieve the PDL tasks whose data you want to access. Any tasks meeting the specified criteria are displayed in the Search Results section. 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.

476 3BUF001094R4101

Section 4 Using Desktop Trends Search Criteria

Search CriteriaUse this part of the PDL Browser to specify the Task Type, Task Value, and Time Span for the search. Click Search when you are finished, Figure 381.

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 that you select in the Configure PDL Browser dialog. See Type of PDL on page 470.

When you change the Task Type specification, any previous results in the PDL Browser are cleared.

Task Value

This specifies the name of the task to query. If you do not specify a name, all tasks are returned. You can enter the complete name, or just a partial name. The wildcard character% 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.

Figure 381. Search Criteria Section

For this release of the software, Batch 300 and TCL-specific criteria are automatically 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.

3BUF001094R4101 477

Search Criteria Section 4 Using Desktop Trends

Time Span

The Time Span fields lets you specify a time range for the query. These fields can be enabled or disabled via their respective check boxes.

To restrict the query to a time range, you must 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.

Specify the time span for which data will be retrieved by specifying the starting and ending date and time in the Start Time and End Time fields. You can modify any part of the date and time by clicking directly on the unit to be changed and entering the new value. For time, you can also use the up/down arrows to change the selected unit. For date, you can click the down arrow to display the Microsoft DT Picker dialog, Figure 382.

By default, the End date/time are set to the current date and time when you open the PDL Browser. 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).

Figure 382. Example, Microsoft DT Picker Dialog

478 3BUF001094R4101

Section 4 Using Desktop Trends Search Criteria

If you enter an end time that precedes or equals the start time, an error message will be displayed when you try to execute the query. 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.

3BUF001094R4101 479

Search Criteria Section 4 Using Desktop Trends

Limiting the Amount of Data Returned By Your Query

As a safeguard against retrieving an excessive amount of data, you can configure a limit for the number of values to be returned for each query. Use the Maximum Values to be Returned field in the Configure PDL Browser dialog. See Maximum Values to be Returned on page 472. 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 383 is displayed when the total number of values satisfying the search criteria exceeds the specified limit.

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. See Maximum Values to be Returned on page 472.

• To accept the results as is and return to the PDL Browser, simply click OK.

If you don’t want to see this message each time you exceed maximum number of rows, click the check box. This remains in effect for the current PDL Browser session. You can also use the Warn If Exceeded check box in the Configure PDL Browser dialog to enable/disable this message. See Warn If Exceeded on page 472.

Figure 383. Maximum Number of Retrieved Rows Exceeded Dialog

480 3BUF001094R4101

Section 4 Using Desktop Trends Search Results

Search ResultsThis displays a listing of tasks that meet your search criteria, Figure 384. 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 let you 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. See Drilling on page 482 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 384 are for a search done at the Job level in a Batch application.

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.

Figure 384. Example, Search Results

3BUF001094R4101 481

Search Results Section 4 Using Desktop Trends

Copying Search Results

You can 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. You can select multiple subresults to copy at the same time. The copy function copies all selected items with a header row.

Drilling

The Drill buttons, Figure 385, let you move up and down the PDL hierarchy for a selected 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 385, displays the batch-level search results for Thur314Bat, Figure 386.

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.

Figure 385. Drill Buttons

Figure 386. Drill Down Example

Drill Buttons

482 3BUF001094R4101

Section 4 Using Desktop Trends Search Results

While drilling, the task that was selected before the drill function was performed will be highlighted if you later drill in the opposite direction. 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 selected unit will be displayed. If you 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. You can only drill Down after a new search is performed.

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

3BUF001094R4101 483

Search Results Section 4 Using Desktop Trends

Resources

This tab displays: Resource Type, Name, Value, Time and Occurrence. The rows are sorted by Type, then by Name, then by Occurrence, Figure 388.

Figure 387. Example, Variables Tab

Figure 388. Example, Resources Tab

484 3BUF001094R4101

Section 4 Using Desktop Trends Search Results

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

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

When the PDL type is specified as Produce IT Batch, the time is displayed in UTC time rather than local time.

Figure 389. Example, Messages Tab

Figure 390. Example, History Tab

3BUF001094R4101 485

Search Results Section 4 Using Desktop Trends

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.

Clicking the Trend button launches the Trend Display view of the selected log.

You can also drag results from this tab to the Trend display.

486 3BUF001094R4101

Section 4 Using Desktop Trends Search Results

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

Figure 391. Example, Next Level Tab

3BUF001094R4101 487

Batch to Batch Display Section 4 Using Desktop Trends

Batch to Batch DisplayThis display combines the functionality of the Trend Display with the PDL Browser. It lets you easily navigate the PDL structure to find and display historical trends for different batches, Figure 393.

Opening the Batch to Batch Display

To open this dialog, from the Windows task bar choose: Start>Programs> ABB Industrial IT 800xA>Information Mgmt>Desktop Trends> Batch to Batch, Figure 394.

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

For details regarding the Trend Display portion of this display, refer to Trend Display on page 348.

Figure 392.

488 3BUF001094R4101

Section 4 Using Desktop Trends Batch to Batch Display

Setting Up the Batch to Batch Display

This display has a special Options dialog which lets you adjust the layout of the display (whether trend portion is on top or bottom), Figure 395. This options dialog also provides easy access to the Trend Display options and PDL Browser options.

For details regarding Trend Display options, refer to Setup Dialog on page 354.

For details regarding the PDL Browser options, refer to Setting Up the PDL Browser Interface on page 468.

Figure 393. Batch to Batch Display

3BUF001094R4101 489

Batch to Batch Display Section 4 Using Desktop Trends

Figure 394. Launching the Batch-to-Batch Display

Figure 395. Batch to Batch Options Dialog

490 3BUF001094R4101

Section 4 Using Desktop Trends Event Browser

Event BrowserThe Event Browser, Figure 396, lets you retrieve the time stamp, source, and message from OPC and Audit Trail message logs configured via the Information Management - History Server function. Instructions for configuring these message logs are provided in Information Management Configuration. Other message log attributes may be accessed using other desktop tools. For details regarding message log attributes, see Section 9, Reading Message Logs.

You can also launch the Trend Display from the Event Browser. This lets you display historical process data related to a specific event.

Figure 396. Event Browser

3BUF001094R4101 491

Opening the Event Browser Section 4 Using Desktop Trends

To set up and use the Event Browser, follow the instructions in:

• Opening the Event Browser on page 492

• Setting Up the Event Browser Interface on page 493

• Retrieving Events on page 494

• Viewing Trend Data Related to Events on page 495

Opening the Event BrowserAccess to the Event Browser is via the Windows task bar. To launch the Event Browser, from the Windows task bar, choose: Start>Programs>ABB Industrial IT 800xA >Information Mgmt>Desktop Trends>Event Browser, Figure 397.

Figure 397. Launching the Event Browser

492 3BUF001094R4101

Section 4 Using Desktop Trends Setting Up the Event Browser Interface

Setting Up the Event Browser InterfaceCertain event browsing parameters may be configured to suit your application via the Event Browser Configuration dialog, Figure 398. Specifically, this dialog lets you 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. You can also specify whether to use local time or UTC time. To adjust these parameters, click Options, then refer to:

• Default Time Span on page 473

• Date and Time Format on page 474

• Data Provider on page 475

• Query Timeout on page 476

• Local or UTC Time on page 494

Clicking Use Defaults resets all parameters to their respective default settings.

Figure 398. Event Browser Options

3BUF001094R4101 493

Retrieving Events Section 4 Using Desktop Trends

Local or UTC Time

Click the applicable radio 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.

Retrieving EventsYou must specify 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 side), and how many records have been returned (right side).

Log Name

This pull-down list contains all message logs configured on the server to which you are currently connected (See Connecting to the Data Server on page 341).

Time Span

These fields let you 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 let you select whether or not to use the corresponding time as query criteria.

494 3BUF001094R4101

Section 4 Using Desktop Trends Viewing Trend Data Related to Events

Viewing Trend Data Related to EventsYou can 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. You may select multiple events from the same source, and you may select 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 you select a single event 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 you select more than one event from a given source, the time scope will span the earliest and latest time stamps.

3BUF001094R4101 495

SQL Browser Section 4 Using Desktop Trends

SQL BrowserThis tool lets you run ad-hoc SQL queries, Figure 399. You can save a query once you’ve run it, and then reopen the query for viewing at some time in the future. You can also delete saved queries. When you query for historical data, you can drag tag names, start times, and end times returned by the query to a Desktop Trend to display the data graphically.

Figure 399. SQL Browser

496 3BUF001094R4101

Section 4 Using Desktop Trends Opening the SQL Browser

To set up and use the SQL Browser, follow the instructions in:

• Opening the SQL Browser on page 497

• Setting Up the SQL Browser Interface on page 497

• Using the SQL Browser on page 499

Opening the SQL BrowserAccess to the SQL Browser is via the Windows task bar. To launch the SQL Browser, from the Windows task bar, choose: Start>Programs>ABB Industrial IT 800xA >Information Mgmt>Desktop Trends>Sql Browser, Figure 400.

Setting Up the SQL Browser InterfaceCertain parameters for this browser may be configured to suit your application. This is done via the SQL Browser Configuration dialog, Figure 401. Specifically, this dialog lets you 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:

• Data Provider on page 475

• Query Timeout on page 476

• Show Grid Lines in Results List on page 498

• Column Colors on page 499

Figure 400. Launching the SQL Browser

3BUF001094R4101 497

Setting Up the SQL Browser Interface Section 4 Using Desktop Trends

Show Grid Lines in Results List

This lets you choose whether or not to show grid lines to separate the records returned for the query, Figure 402.

Figure 401. SQL Browser Configuration

Figure 402. Results With and Without Grid Lines

Grid No Grid

498 3BUF001094R4101

Section 4 Using Desktop Trends Using the SQL Browser

Column Colors

If you plan to configure columns for dragging tags and time stamps to the Trend Display, you can specify different colors for the tag, start time, and end time columns to make them more distinguishable. 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 401, the box for Tag Column Color is currently selected. Double-clicking a color box displays the standard Windows color chooser dialog, Figure 403.

Using the SQL BrowserFor instructions on using the SQL Browser, see:

• Specifying and Executing Ad-hoc SQL Queries on page 500

• Managing Queries on page 501. This includes

– Saving a Query on page 503

– Opening a Saved Query on page 503

– Deleting a Saved Query on page 503

Figure 403. Windows Color Chooser Dialog

3BUF001094R4101 499

Specifying and Executing Ad-hoc SQL Queries Section 4 Using Desktop Trends

Specifying and Executing Ad-hoc SQL QueriesEnter the query in the SQL Statement window. An example query is shown in Figure 404.

An example query result is shown in Figure 405.

Figure 404. SQL Query Dialog

Figure 405. Example Query Result

For complex queries, you may need to increase the Timeout interval. Click the Options button to display the SQL Browser Configuration dialog. For details refer to Query Timeout on page 476.

500 3BUF001094R4101

Section 4 Using Desktop Trends Managing Queries

Considerations for Data Providers on Windows and HP-UX Platforms

SQL queries that you create in this browser are processed by the ADSdpDYN data provider when directed to HP-UX platforms, and the ADO data provider on Windows platforms. How to configure these data providers is described in the Information Management Configuration.

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. When you need to access such objects, use an alternative method such as the Process Values dialogs in DataDirect.

Managing QueriesThe browser lets you save query results. You can also open a saved query, or delete a saved query. These functions are available via the context (right-click) menu, Figure 406.

SQL access to numeric log data and OPC objects is supported when the ODA Server software is installed.

Figure 406. SQL Browser Context Menu

3BUF001094R4101 501

Managing Queries Section 4 Using Desktop Trends

When you invoke any one of the Query functions (Save, Open, or Delete), a dialog such as the one shown in Figure 407 is displayed. The title bar indicates the selected function (Save, Open, or Delete). For example, in Figure 407 the selected function is Open a Query. The two large buttons in the upper right part of the dialog let you toggle between the List View (left button) and Detail View (right button). An example of a detail view is shown in Figure 408.

To save, open, or delete a query, follow the instructions in:

• Saving a Query on page 503

• Opening a Saved Query on page 503

• Deleting a Saved Query on page 503

Figure 407. Dialog For Managing Queries

Figure 408. Example, Detail View

List of Saved Queries

List View Detail View

502 3BUF001094R4101

Section 4 Using Desktop Trends 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 500.

2. Right-click inside the query result pane and choose Query>Save from the context menu.

3. Enter a name to identify the query, Figure 409, 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.

Deleting a Saved Query

To delete a saved query:

1. Right-click inside the query result pane and choose Query>Delete Saved Queries from the context menu. This displays the query list with check boxes, Figure 410.

Figure 409. Naming the Query to be Saved

3BUF001094R4101 503

Dragging Tag Names and Time Stamps to the Desktop Trend Display Section 4 Using Desktop

2. Check one or more queries to delete, Figure 411, then click OK (or Apply).

Dragging Tag Names and Time Stamps to the Desktop Trend DisplayWhen you query for historical data, you can 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, you must first specify which columns from the query result will be used for tag name, trend start time, and trend end time.

The basic procedure is:

1. Select the columns. There are two methods for making this specification:

Figure 410. Delete Query View

Figure 411. Checking Queries to be Deleted

If you don’t specify a start or end time, the trend display’s default scope will be used.

504 3BUF001094R4101

Section 4 Using Desktop Trends Dragging Tag Names and Time Stamps to the Desktop Trend

– Using the Configure Columns for Drag Dialog on page 505

– Select Columns By Clicking on page 506

2. Select up to eight log names from the specified logname column. If you select more than eight, you’ll get the first seven names, plus the last name.

3. Drag the columns to the trend display.

Using the Configure Columns for Drag Dialog

This dialog is available via the SQL Browser context menu. Right-click in the browser and choose Configure Columns for Drag, Figure 412.

This dialog provides three pull-down lists for specifying the column to use as tag name, start time, and end time. For example in Figure 413, the LogName column has been selected for dragging as the tag name to the Desktop Trend display, and LocalTimeStamp is being selected for dragging as the Start Timestamp.

Figure 412. Launching the Configure Columns for Drag Dialog

Figure 413. Configure Columns for Dragging

3BUF001094R4101 505

Dragging Tag Names and Time Stamps to the Desktop Trend Display Section 4 Using Desktop

Select Columns By Clicking

As an alternative you can select a column in the query result, and then use the context menu as shown in Figure 414.

When you right-click on a column in the query result, the context menu shows the column name, for example, in Figure 414 the LocalTimeStamp column is selected. You can then use the context menu to specify that column as the tag name, start timestamp, or end timestamp for dragging.

Figure 414. Clicking Inside a Column

506 3BUF001094R4101

Section 4 Using Desktop Trends OPC Browser

OPC BrowserThe trend display and ticker provide an OPC browser to help you find OPC objects on the connected OPC DA or OPC HDA server, Figure 276. Operating procedures are basically the same whether you use it with the Trend display or Ticker:

• Changing the Data Provider on page 508

• Getting the Entire List of Available Objects on page 509

• Filtering on page 510

• Considerations for History Access on page 511

• Selecting Tags on page 513

• Copying Items on page 513

Figure 415. Example, OPC Browser

3BUF001094R4101 507

Changing the Data Provider Section 4 Using Desktop Trends

Changing the Data ProviderThe Data Provider specification determines the type of tags that you will be able to access via the browser:

• AIPHDA lets you browse the 800xA system for property logs. This supports seamless access to trend logs and history logs. It also lets you access log attributes.

• IMHDA is an alternative to the AIPHDA OPC HDA server. See Appendix C, Using the IM OPC HDA Server.

• AIPOPC lets you browse for real-time (process or softpoint) tags

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

The mode of operation for the browser differs slightly depending on whether you are using AIPHDA or IMHDA. For further information, refer to Considerations for History Access on page 511.

Figure 416. Changing the Data Provider Specification

508 3BUF001094R4101

Section 4 Using Desktop Trends Getting the Entire List of Available Objects

Getting the Entire List of Available ObjectsAs an alternative to browsing to a specific folder, you can use the Get Entire List function from the context menu. This gets all objects of the applicable type within and below the selected folder. To get the entire list, select a folder, then right-click and choose Get Entire List, Figure 417.

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 you accidentally request an excessive number of objects, you can abort the Get Entire List request by selecting Abort Get Entire List from the context menu.

Figure 417. Example, Get Entire List

Get Entire List Result

Getting Entire List of Tags UnderAC800M6ProcessValues Folder

Abort Get Entire List

3BUF001094R4101 509

Filtering Section 4 Using Desktop Trends

Filtering You can narrow the scope of objects returned by either the Get Entire List method, or normal browsing by specifying a filter. This helps you 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

Checking the Exclude Filtered Items check box retrieves all items whose names DO NOT meet the filter criteria. For example, clicking this check box with the filter text IM will get all items whose names do not include the IM text string. Figure 418 shows two filter examples.

Figure 418. Example, Filter

Basic FilterGet items with IM text string

Same Filterusing ExcludeCheck Box

510 3BUF001094R4101

Section 4 Using Desktop Trends Considerations for History Access

Considerations for History AccessWhen using the browser for History access, the contents of the left pane varies, depending on the type of OPC HDA server.

AIPHDA Access

For AIPHDA, the browser provides a directory structure similar to the Plant Explorer. The view includes all structures and directories where log aspects reside, Figure 419.

With the AIPHDA server, you can use the Seamless retrieval option when you are not sure which log in a property log hierarchy will provide the best coverage for the required 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, check the Seamless check box.

Figure 419. AIPHDA Access

3BUF001094R4101 511

Considerations for History Access Section 4 Using Desktop Trends

IMHDA Access

For IMHDA, the left pane lets you choose one of three paths or categories by which to conduct your search, Figure 420:

• EH lets you access logs that are local to the data provider to which you are connected. This is the fastest method and is recommended if you are querying a log that resides on the local server. It supports the ability to modify existing log entries, but not adding new entries.

• EH_NET lets you access logs on all servers on the network. This requires OMF access to be extended on the TCP/IP network. This is described in Information Management Installation. It supports the ability to modify existing log entries, and add new entries.

• EH_PUBL lets you access archived log data that is published. For instructions on publishing archived data, refer to Industrial IT 800xA - Information Management Configuration.

• LOGMAN is not applicable for this release.

Figure 420. IMHDA Access

512 3BUF001094R4101

Section 4 Using Desktop Trends Selecting Tags

Selecting TagsWhen you select a folder or folders, the available objects (of the applicable type) will be displayed in the middle pane. Select one or more objects in the middle pane, and then move them to the Selected Tags (right) pane by clicking the > button. You can move all objects from the middle to the Selected Tags pane by clicking the >> button. You can remove selected tags from the list using either the < or << buttons.

You can combine tags from different locations by repeating this procedure for as many folders as required.

When you are finished selecting tags, click Add Tags (for ticker), or Add Traces for (Trend display)

Copying ItemsThe Copy Item(s) function in the context menu lets you copy the selected items to the clipboard. From there you can paste the items into an external data access application such as Crystal Reports. To do this, right-click and choose Copy Item(s) as shown in Figure 421.

Figure 421. Copying Items

3BUF001094R4101 513

Copying Items Section 4 Using Desktop Trends

514 3BUF001094R4101

Section 5 Creating Reports

OverviewYou can create reports 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 lets you 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. You may also attach completed report files to Completed Report objects in the 800xA system aspect directory. This lets you browse for completed report files via the Plant Explorer, and also lets you apply version control and electronic signatures to report files.

When you output a report to a Completed Report object or report log, the report can then be archived to a removable media for permanent storage.

You can also configure web access for reports so that you may open and view the reports using a web browser.

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. Instructions for configuring report logs, and archiving reports (either via report logs or Completed Report objects) are provided in Industrial IT 800xA - Information Management Configuration.

3BUF001094R4101 515

Section 5 Creating Reports

Report Building Applications

The following four report builder options are supported:

• DataDirect - DataDirect is an add-in program for Microsoft Excel. DataDirect lets you 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 via Open Data Access (ODA). This release supports Crystal Reports versions 8.5, 9, and 10.0.

• Microsoft Excel (without DataDirect Add-in) - can access historical and real-time data from the 800xA system via 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.

Implementing Reports

The architecture for reporting in the 800xA system is illustrated in Figure 422. Crystal reports and Microsoft Excel (without DataDirect add-ins) require the Open Data Access option to access process and historical data.

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 via 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 lets you 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 PC client which does not have 800xA system software installed. If you build reports on a remote PC, 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.

516 3BUF001094R4101

Section 5 Creating Reports

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 which is described in Industrial IT 800xA System Installation.

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

Crystal Reports and other third party applications access data in the 800xA system via Open Data Access (ODA). This must be configured as described in Industrial IT 800xA - Information Management Configuration.

Figure 422. Report Services Architecture

ReportTemplate

Aspect System(File Viewer Aspect)

OR

Windows File System

Report Application

Microsoft ExcelCrystal Reports

Schedule

Report Action

Triggers

Executes

CompletedReport

Completed Report ObjectReport LogPrinterE-mailWindows File

Data Sources:

Real-timeBatchHistoryHistory Events

Output Options:

DataDirect

Generic

3BUF001094R4101 517

Example Reports Section 5 Creating Reports

Example ReportsThe Scheduler Installation includes three sets of example reports. There are three example Batch reports, eight Information Management reports, and five other miscellaneous reports. These reports are intended as examples only. You can modify them or simply use them for reference. It is recommended that you copy and rename a report template before modifying them. The templates for Batch and Information Management reports are attached to file 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, see:

• Example Batch Reports on page 518

• Example Information Management Reports on page 520

• Example Miscellaneous Reports on page 523

Example Batch Reports

The example Batch reports are described in Table 22. The parameters for these reports, which apply to both the Crystal reports and Excel reports, are described in Table 23.

Table 22. Example Batch Reports

Report (Job Description) Name Requires

Batch Report Crystal Crystal Reports

Batch Report Excel Raw Excel 2002 (part of Office XP)

Batch Report Excel Excel 2002 (part of Office XP)

518 3BUF001094R4101

Section 5 Creating Reports Example Reports

Table 23. 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 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.

Required

CampaignID Campaign ID as entered when Batch was scheduled in 800xA Batch Management.

Not Used

LotID Lot ID as entered when Batch was scheduled in 800xA Batch Management.

Not Used

ProcedurePath The unique procedure identifier of the BMA Job Scheduler Procedure block in 800xA Batch Management.

Not Used

LogicalNameList Comma separate list of Logical Names for the Batch Trends report. Do not include spaces before or after the comma(s). For example: LN1, LN2, LN3

Optional

Intervals Interval between samples for the Batch Trends report. Defaults to 10 seconds.

Optional

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 included in the Action Aspect Report Parameters definition then it is not sent to the report but it is listed in the Job Log.

3BUF001094R4101 519

Example Reports Section 5 Creating Reports

Example Information Management Reports

The example Information Management Reports are described in Table 24.

Table 24. Information Management Reports

Name Description Parameters(1)

Hourly Log 1 hour log of 60 x 1 minute values

• Tag01 - Tag20 - List of tag names• 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 minute values

• Tag01 - Tag20 - List of tag names• 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.

520 3BUF001094R4101

Section 5 Creating Reports Example Reports

Daily Log 1 day log of 24 x 1 hour values

• Tag01 - Tag20 - List of tag names• 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.

Monthly Log

31 day log of 31 x 1 day values

• Tag01 - Tag20 - List of tag names• Tag01Algorithm - Tag20Algorithm - list of algorithms to

be used for interpolation. Defaults to TimeAverage.• DescriptionAtom - Tag atom of the description, for

example: Description • EUAtom - Tag atom of the engineering units, for

example: 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.

Table 24. Information Management Reports

Name Description Parameters(1)

3BUF001094R4101 521

Example Reports Section 5 Creating Reports

Trip Log 31 values, 20 before the trip time, 10 after the trip time and 1 at the trip time.

• Tag01 - Tag20 - List of tag names• Tag01Algorithm - Tag20Algorithm - list of algorithms to

be used for interpolation. Defaults to TimeAverage.• TripTime - Trip time. Can be any valid Excel time format.

eg. 8:30:00.• DescriptionAtom - Tag atom of the description, for

example: Description • EUAtom - Tag atom of the engineering units, for

example: Unit

Snapshot-Historical

Single values for 20 tags at the specified time

• Tag01 - Tag20 - List of tag names • ReportTime - Date and time of values. Can be any valid

Excel date/time format. eg. 10/28/2003 12:00:00 PM. • DescriptionAtom - Tag atom of the description, for

example: Description • EUAtom - Tag atom of the engineering units, for

example: Unit

Snapshot-Current

Current values for 20 tags

• Tag01 - Tag20 - List of tag names • DescriptionAtom - Tag atom of the description, for

example: Description • EUAtom - Tag atom of the engineering units, for

example: Unit • ValueAtom - Tag atom of value• AlarmAtom - Tag atom of alarm state• QualityAtom - Tag atom of quality state

Alarm and Event

List of alarms and events between two times for a particular alarm and event object

• AreaObject – Alarm and/or Event object• End Time - Report end date and time, defaults to current

time.• Start Time - Report start date and time, defaults to

1 day prior to the end time.

(1) All parameters are optional

Table 24. Information Management Reports

Name Description Parameters(1)

522 3BUF001094R4101

Section 5 Creating Reports Example Reports

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\ABB 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. You can edit the queries by selecting the data area, and then right clicking and choosing Edit Queries. This starts the wizard so that you can change tag references.

Also, there are five batch reports created with Crystal Reports:

BatchReport-detailed -001.rpt BatchReport-detailed.rpt Report1CampaignsAndBatches-SelectACampaign.rpt Report1CampaignsAndBatches.rpt Report1Campaigns.rpt

Some example output files are available in: C:\Program Files\ ABB Industrial IT\Inform IT\ABB Scheduler\samples\reports\output

3BUF001094R4101 523

Example Reports Section 5 Creating Reports

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 your preferred report building package. If you are using DataDirect, all data access connections should already be established, and the report should access the requested data transparently. You may be required to make adjustments to the connected data providers. Detailed instructions for using DataDirect are provided in Section 2, DataDirect - Excel Data Access.

If you are using Crystal Reports or another third-party report building application, you will be required to connect the report to the 800xA data source via Open Data Access. An example of this is provided in Creating a Report with Crystal Reports - Example on page 579.

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

3. Configure the Action aspect to specify how the report will be executed. This is described in Defining the Report Action on page 529 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.

4. Configure the Job Description object to specify the scheduling instructions for the report. This is described in Defining the Schedule on page 552.

5. Before you run a report, read the guidelines in Before Running a Report on page 554.

Login parameters must be specified under the following circumstances:• If your Crystal Report will include queries for Oracle-based data (message

logs and/or PDL data), you must define the DataServerLogin parameter in the report schedule to connect the report to the ODBC driver for Oracle data

• For DataDirect, you must define the DataServerLogin parameter in the Report action to connect the report to the applicable data server:

524 3BUF001094R4101

Section 5 Creating Reports Example Reports

Reports that use Visual Basic macros

If you are scheduling a report that uses Visual Basic macros in a Microsoft Excel spreadsheet, you must enable macros in Excel before the report runs. If this is not done, the report will hang. To enable macros in Excel, see Enabling Macros on page 86.

Troubleshooting

If you are having trouble with a report, see Troubleshooting Reports on page 578.

Viewing Reports Over the Web

To set up viewing of reports over the Web, you must create a virtual Web directory where you will store the reports you wish to be viewed over the web, and 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 555.

Managing Completed Report Objects

The Report Preferences aspect lets you 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. See Report Preferences Aspect on page 565.

The Report Printing aspect lets you print report files attached to File Viewer aspects. See Report Printing Aspect on page 566.

If you intend to schedule and execute reports 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, see Putting the Workbook in Manual Mode on page 294.

3BUF001094R4101 525

Setting Up the Report Action and Scheduling Definition Section 5 Creating Reports

Setting Up the Report Action and Scheduling DefinitionReports are scheduled via the system scheduling function. 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 lets you pass in parameters to the report at execution time. The Report Action is added as an aspect to the Job Description object. This section describes how to create and configure these objects.

1. Start with Creating Objects and Aspects in the Scheduling Structure on page 526.

2. Continue with Defining the Report Action on page 529.

3. Set up the Schedule as described in Defining the Schedule on page 552.

Creating Objects and Aspects in the Scheduling StructureAdd 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, Figure 423.

The Report Action of the Action Aspect can also be used to schedule a History backup, refer to the section on History Database Maintenance in Industrial IT 800xA - Information Management Configuration.

Figure 423. Adding a New Job Object

526 3BUF001094R4101

Section 5 Creating Reports Creating Objects and Aspects in the Scheduling Structure

3. Add the Job object as a Job Description object, Figure 424. Assign the object a logical name.

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 in Figure 425) and choose New Aspect from the context menu.

Figure 424. New Object Dialog

Figure 425. Adding an Action Aspect

Job DescriptionSelected

ObjectName

3BUF001094R4101 527

Creating Objects and Aspects in the Scheduling Structure Section 5 Creating Reports

6. In the New Aspect dialog, select the Action aspect, Figure 426. You can use the default aspect name, or specify a new name.

7. Click Create to add the Action aspect to the job.

Continue with Defining the Report Action on page 529.

Figure 426. New Aspect Dialog

528 3BUF001094R4101

Section 5 Creating Reports Defining the Report Action

Defining the Report ActionThe Report Action specifies how the report will be executed. It specifies the report template as well as output destinations, and lets you pass in parameters to the report. Select the Action aspect from the object’s aspect list, Figure 427.

To configure the report action, use the Action aspect to perform the following:

• It is recommended that you enter a time limit, especially for large reports

• Selecting the Report Action on page 530

• Selecting the Report Template on page 530

• Output Options on page 532

Figure 427. Action Aspect Configuration View

3BUF001094R4101 529

Selecting the Report Action Section 5 Creating Reports

Selecting the Report ActionThe functionality of the Action aspect is set by specifying the type of action. For reports, select the Report Action from the Action pull-down list, Figure 428.

Selecting the Report TemplateReport 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 you can browse to, open, and manage the file as any other aspect in the aspect directory.

Use the Report Template Path section, Figure 429, to select the report to be executed by this action. To select the browsing method, click the Report Template Path button, then choose either Windows Files or File Viewer aspects from the context menu.

Then use the applicable browser dialog to find and select the report to be executed. If you select a File Viewer aspect, the file attached to the Work Document section is used.

Figure 428. Selecting the Report Action Plug-in

Figure 429. Using the Report Selection Menu

Click Here to Display Browser Menu

530 3BUF001094R4101

Section 5 Creating Reports Selecting the Report Template

Figure 430. Example, Methods for Browsing Report Files

Windows File Browser

File Viewer Aspect Browser

3BUF001094R4101 531

Output Options Section 5 Creating Reports

Output OptionsThe Output Options section, Figure 431, lets you pass parameters into the report at execution time, and lets you specify 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.

There is also an Execute File option for running executable files or scripts that are neither Crystal Reports files (.rpt), nor Excel files (.xls). Execute file cannot be used with any other output destination. See Execute File on page 551.

For the export, email, and save to history options, the output file name can be modified using parameters. This is described in Using Parameters to Modify an Output File Path on page 533.

Also for the export, email, and save to history options, when outputting the report as an HTML file, you can control the number of files which are output. This is described in Output Options for HTML Files on page 534.

Not all export formats are available in all versions of Crystal Reports. Refer to the documentation for your version of Crystal Reports to see what is available for you. Also, be sure to install ALL dlls related to export file types for the version that you install. For Crystal Reports version 8.5, you must perform a Complete installation. Version 9 requires a Custom installation to accomplish this.

Figure 431. Output Options

532 3BUF001094R4101

Section 5 Creating Reports Output Options

For details regarding each output method, refer to:

• Using Parameters to Modify an Output File Path on page 533

• Output Options for HTML Files on page 534

• Report Parameters on page 535

• Export File on page 541 (Windows file or Completed Report object)

• Printer on page 546

• Email on page 546

• Save to History on page 548

• Execute File on page 551 - This option is only available when the file that you choose to schedule is neither a Crystal Reports file (.rpt), nor an Excel file (.xls).

Using Parameters to Modify an Output File Path

Report parameters can be dynamically substituted in output file paths for reports exported to a directory, saved into a report log or sent via 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.

You may also use the following keywords (intrinsic parameters) 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 let you 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 535.

3BUF001094R4101 533

Output Options Section 5 Creating Reports

Output Options for HTML Files

For Crystal Reports

When you output a Crystal Report as an HTML file you can 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, you must use the Report Parameters section to set the following two parameters to false:

• HTMLEnableSeparatedPages = False

• HTMLHasPageNavigator = False

For further information on parameters, see Report Parameters on page 535.

For DataDirect and Microsoft Excel

When you output a DataDirect or Microsoft Excel report as an HTML file, by default all supporting files such as bullets, background textures, and graphics are stored in a separate subfolder. If you want 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.

534 3BUF001094R4101

Section 5 Creating Reports Report Parameters

Report ParametersThe Report Parameters section lets you specify parameters to send to the report before execution. The steps below describe the general procedure for adding, modifying, 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 function, Figure 432.

2. Then click Edit Parameter List. This displays the Report Parameters list, Figure 433.

3. To add a parameter to the list, click Add. This displays the Configure a Report Parameter dialog, Figure 434.

Figure 432. Specifying the logname Parameter

Figure 433. Report Parameter List

3BUF001094R4101 535

Report Parameters Section 5 Creating Reports

4. Enter the parameter name and value as shown in Figure 434, then click OK. This adds the parameter to the parameter list, Figure 435.

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 434. You can change the name or value or both. To remove a parameter from the list, select the parameter, then click Remove.

7. When you are finished adding parameters, click Close. This adds all listed parameters to the parameter list in the Report Action dialog, Figure 436.

Figure 434. Configure a Report Parameter

Figure 435. Parameter Added to the List

536 3BUF001094R4101

Section 5 Creating Reports Report Parameters

• For Crystal Reports, see:

– Parameters for Crystal Reports on page 539

– Specifying the Data Server for Queries in Crystal Reports on page 539.

• For DataDirect, see:

– Passing Parameters to an Excel Spreadsheet on page 540

– Specifying the Data Server for DataDirect on page 539.

• Parameter Substitution in an Output File Path on page 537

• Substituting Argument Values for Parameter Values on page 537

Parameter Substitution in an Output File Path

Report parameters can be dynamically substituted in output file paths for reports exported to a directory, saved into a report log or sent via e-mail. See Using Parameters to Modify an Output File Path on page 533.

Substituting Argument Values for Parameter Values

You can 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 616). 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

Figure 436. Parameter List in the Report Action

3BUF001094R4101 537

Report Parameters Section 5 Creating Reports

You may also use the following keywords (intrinsic parameters) 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 let you 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(< >). The argument value may be embedded in other text. Two examples are shown in Figure 437.

Figure 437. Substituting Arguments for Parameter Values

Embedded Example

538 3BUF001094R4101

Section 5 Creating Reports Report Parameters

Parameters for Crystal Reports

To pass a parameter to a Crystal Reports file, you must 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 579.

Specifying the Data Server for Queries in Crystal Reports

If your Crystal Report will include queries for Oracle-based data (message logs and/or PDL data), you must define the DataServerLogin parameter in the report schedule to connect the report to the ODBC driver for Oracle data:

DataServerLogin = DllName, ServerName, DatabaseName, UserID, Password

Where:

DllName = Database DLL Name from ODBC driver Properties dialog ServerName = Server from ODBC driver Properties dialog DatabaseName = Service Name from ODBC driver Login dialog UserID = history Password = history

For example: DataServerLogin = pdsodbc.dll,LocalOracle,advaEng66,history,history

Specifying the Data Server for DataDirect

You must define the DataServerLogin parameter in the Report action to connect the report to the applicable data server:

DataServerLogin = computer name,user name, password

For example: DataServerLogin = roc74,aid,aid

3BUF001094R4101 539

Report Parameters Section 5 Creating Reports

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 438 cell A1 corresponds to a parameter named batch22.

As an option, you can rename the cell in the spreadsheet to give it a more meaningful name. For example, in Figure 439, cell C2 is renamed batchid.

Figure 438. Specifying the logname Parameter

Figure 439. Renaming a Cell as batchid

Renaming Cell C2with the batchid Parameter name

540 3BUF001094R4101

Section 5 Creating Reports Export File

Export FileThe Export Paths option, Figure 440, lets you export the report output to one or more files of a specified type (Excel, Crystal Report, HTML, PDF, etc...). The completed 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 541.

• Export to Windows File on page 543.

Export to a Completed Report Object

You can export the report output as a file attached to a Completed Report object. This lets you browse for completed report files via the Plant Explorer, and also lets you apply version control and electronic signatures to report files. When you export a report to a Completed Report object, a new Completed Report object is created under the Reports branch in the Scheduling structure. A File Viewer aspect is automatically created for that object, and the report file is attached to that aspect.

You can set the maximum number of Completed Report objects to maintained in a folder. This is described in Report Preferences Aspect on page 565. In addition you can select the public 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. This is described in Report Printing Aspect on page 566.

To export the report to a Completed Report object:

1. Check the Export Paths check box.

Figure 440. Exporting Report Files

3BUF001094R4101 541

Export File Section 5 Creating Reports

2. Click Add Object Path. This displays the Configure Export to a Completed Report Object dialog, Figure 441.

The format defaults to the format of the selected report template (Selecting the Report Template on page 530). 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.

You may use the defaults as is, or change one or more definitions as required. For guidelines on formats, see Table 25 and the note that follows the table.

3. Click OK when you are done. The specification is then entered in the Export Paths list, Figure 442.

If you need to remove an export file specification 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 441. Exporting to a Completed Report Object

542 3BUF001094R4101

Section 5 Creating Reports Export File

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

The format defaults to the format of the selected report template (Selecting the Report Template on page 530). The path defaults to the root directory and the name of the selected report template.

These defaults may be used as is, or you may change the defaults as required. For guidelines on formats, see Table 25 and the note that follows the table.

3. To change the path, click the Path button to display a Windows browser, then browse to the folder where you want to store the file, Figure 444. Click OK in the browser once you’ve made your selection.

Figure 442. Object and File Names Combined in File Name Field

Figure 443. Exporting to a Windows File

3BUF001094R4101 543

Export File Section 5 Creating Reports

4. Click OK when you are finished with the export specification. The specification is then entered in the Export Paths list, Figure 445.

If you need to remove an export file specification 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.

Figure 444. Windows Browser

Figure 445. Windows Path Specification Entered

544 3BUF001094R4101

Section 5 Creating Reports Export File

Table 25. Supported Export Formats

Builder Supported Export Formats

Crystal Reports Version 8.5, or 9.x

Crystal Report (.rpt), Excel (.xls), HTML (.html), RichText (.rtf), Acrobat PDF (.pdf), XML (.xml), Word (.doc)

Microsoft Excel Excel (.xls), HTML (.html), TrueText (.txt)

• When you output a report as an HTML file you can control the number of files which are output. See Output Options for HTML Files on page 534.

• Not all export formats are available in all versions of Crystal Reports. Refer to the documentation for your version of Crystal Reports to see what is available for you.Also, regardless of the version that you install, be sure to install ALL dlls related to export file types. If you are using Crystal Reports version 8.5, you must perform a Complete installation. Version 9 requires a Custom installation to accomplish this. Consult the Crystal Reports documentation for details.

• 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 accumulation of export files. You are responsible for managing these files and periodically purging files from the export directory if necessary.

• Report parameters can be dynamically substituted in the output file name. See Using Parameters to Modify an Output File Path on page 533.

• If the file is being exported on a remote PC, 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 632.

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

3BUF001094R4101 545

Printer Section 5 Creating Reports

PrinterThe printer option provides a list of local printers available from the node where the report will run, Figure 446. If you require access to a printer which is not local, it must be exposed as local using the Add Printer wizard.

EmailThe email option lets you send the report via email through Outlook Express. Rather than send a finished report, you may send the report template (the unprocessed report), or you may simply send a notice that the report was executed.

This function uses Outlook Express. To proceed:

1. Check the Email check box. This activates the Set button, Figure 447.

2. Click the Set button to display the Email dialog, Figure 448.

3. Enter the email address.

4. Use the Attachment Format pull-down list to select the format for the report output file. The choices for finished report files are described in Table 26.

To send an unprocessed report template, select as is. To send a notification message with no attachment, select None.

Figure 446. Selecting a Printer for a Hardcopy Report

The Email option requires a POP3 e-mail server and Outlook Express to be set up. See Setting Up E-mail for Reports on page 569.

Figure 447. Example, Email Output

546 3BUF001094R4101

Section 5 Creating Reports Email

Figure 448. Email Dialog

Table 26. Supported Attachment Formats

Builder Supported Formats

Crystal Reports Version 8.5, or 9.x

Crystal Report (.rpt), Excel (.xls), HTML (.html), RichText (.rtf), Acrobat PDF (.pdf), XML (.xml), Word (.doc), None, As Is

Microsoft Excel Excel (.xls), HTML (.html), TrueText (.txt), None, As Is

When you output a report as an HTML file you can control the number of files which are output. See Output Options for HTML Files on page 534.

3BUF001094R4101 547

Save to History Section 5 Creating Reports

5. Enter the report output name in the Attachment field. This is not required to match the report name. You may include an extension; however, the extension will not determine the file format. The format must be selected via the Attachment Format list. This field is disabled if you select None for the Attachment Format.

6. Enter a subject and message if necessary.

7. Click OK when finished. The To: email address will be displayed next to the Email Set button, Figure 449.

Save to HistoryThis option lets you save the report in a report log configured via the Information Management History Server function. The report log must already be configured. This procedure is described in the section on Historizing reports in Industrial IT 800xA - Information Management Configuration.

To use this option, click the Save To History check box. This activates both the report log selector, and the Format selector, Figure 450.

To select the report log, click Set, then use the browser to select the report log, Figure 451.

Report parameters can be dynamically substituted in the output file name. See Using Parameters to Modify an Output File Path on page 533.

Figure 449. Email Feedback

Figure 450. Save To History

548 3BUF001094R4101

Section 5 Creating Reports Save to History

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 25, plus Without Processing which saves just the report template without data that would be gathered by processing the report.

As an option, you may 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 450, click to the left of .html), then enter the new name. This name will completely replace the original report output file name.

As a further option report parameters can be dynamically substituted in the output file name. See Using Parameters to Modify an Output File Path on page 533.

You can view reports stored in the report log via 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 567.

Figure 451. Selecting the Report Log

3BUF001094R4101 549

Save to History Section 5 Creating Reports

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, you must force the report to be output on one page. To do this, set the page output parameters HTMLEnableSeparatedPages and HTMLHasPageNavigator to False (see Output Options for HTML Files on page 534). If using Crystal Reports later than version 9, these options must always be set to false for saving HTML to History.

• 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 you output a DataDirect or Microsoft Excel report 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 534.

550 3BUF001094R4101

Section 5 Creating Reports Execute File

Execute FileThis option is only available when the file that you choose to schedule is neither a Crystal Reports file (.rpt), nor an Excel file (.xls), Figure 452. In this case you may 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. You cannot use the Execute File option in combination with any other output option.

Figure 452. Execute File

3BUF001094R4101 551

Defining the Schedule Section 5 Creating Reports

Defining the ScheduleReports whose actions are defined through Report Action aspects, are scheduled via 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 526.

Select the Scheduling Definition aspect for a Job description object to display its configuration view, Figure 453.

The Scheduler supports several scheduling methods, for example: cyclic, periodic, monthly, and so on. 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 454. 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 lets you 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, it is recommended that you specify a server where the report will run.

Figure 453. Scheduling Definition Configuration View

552 3BUF001094R4101

Section 5 Creating Reports Defining the Schedule

The Enabled check box must be checked in order for the scheduler to use the selected schedule type.

Use the Schedule pull-down list to select the type of schedule. This example demonstrates how to set up a periodic schedule. Other options include cyclic, weekly, and monthly scheduling, and are described in Section 6, Scheduling.

Periodic Scheduling

The Periodic plug-in, Figure 455, is displayed when you select Periodic Schedule from the Schedule pull-down list. This lets you specify a periodic interval in weeks, days, hours, minutes, or seconds. You may also specify a scheduling time-window which defines a beginning and end time for the schedule.

To specify the periodic interval, use 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 continue to run once-a-day at that time.

As an option you can 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 respective start and end times. Figure 455 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 454. Schedule Tab - Common Controls

3BUF001094R4101 553

Before Running a Report Section 5 Creating Reports

Before Running a ReportFollow 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 529).

• Outside of the scheduler, test the report by manually opening the template, executing 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 Manual 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 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 294.

Figure 455. Periodic Schedule Plug-in

554 3BUF001094R4101

Section 5 Creating Reports Viewing Reports Over the Web

Viewing Reports Over the WebTo set up viewing of reports over the Web, you must create a virtual Web directory where you will store the reports you wish to be viewed over the web, and set up the output definition for the Report action to send finished reports to that directory.

Creating A Virtual Web DirectoryTo create this directory:

1. Create a new directory in Windows Explorer, for example: C:\Reports\Web

2. In the control panel, open Administrative Tools\Internet Services Manager (Settings>Control Panel>Administrative Tools>Internet Services Manager).

3. Add a new virtual directory to the Default Web Site by right clicking on it and choosing New > Virtual Directory, Figure 456.

This launches the Virtual Directory Creation Wizard, Figure 457.

Figure 456. Adding a New Virtual Directory

3BUF001094R4101 555

Viewing Reports Over the Web Section 5 Creating Reports

4. Click Next to continue.

5. Specify an Alias name, for example: reports, Figure 458, then click Next to continue.

6. Set Directory to the directory you created in step 1, for example: C:\Reports\Web, Figure 459, then click Next.

Figure 457. Virtual Directory Creation Wizard

Figure 458. Specifying the Alias

556 3BUF001094R4101

Section 5 Creating Reports Viewing Reports Over the Web

7. In the Access Permissions dialog, make sure Read and Browse are checked,

Figure 460, then click Next.

8. Click Finish.

9. Close the Internet Services Manager.

Figure 459. Setting the Directory

Figure 460. Setting Permissions

3BUF001094R4101 557

Viewing Reports Over the Web Section 5 Creating Reports

Creating Report Output And Viewing It Over The WebIn 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 461.

After the job has successfully run, open Internet Explorer and go to http://localhost/reports (assuming you used reports as the alias name for your virtual directory). You should see a link to the report you’ve just run. Click on the report link to view the report. An example is shown in Figure 462.

Figure 461. Output Definition

Figure 462. Navigating to the Report

Link

558 3BUF001094R4101

Section 5 Creating Reports Attaching a Report Template to a File Viewer Aspect

Attaching a Report Template to a File Viewer AspectThe report files you create to be used as templates can be integrated into the aspect system by attaching the report files to File Viewer aspects. This lets you browse for report template files via the Plant Explorer, and also lets you apply version control and electronic signatures to report files.

You may add a File Viewer aspect to an existing object, or create a new object. The following procedure shows you 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 (reference Figure 463 for steps 1 & 2):

1. In the Plant Explorer, browse to the location where you want to add the File Viewer aspect, for example, the Reports branch in the Scheduling structure.

2. Right click and choose New Object from the context menu.

3. In the New Object dialog, select the Generic type object, assign the object a meaningful name, then click OK, Figure 464.

Figure 463. New Object

3BUF001094R4101 559

Attaching a Report Template to a File Viewer Aspect Section 5 Creating Reports

4. Select the new object, right click and choose New Aspect from the context

menu, Figure 465. This displays the Add New Aspect dialog.

Figure 464. Creating a Generic Object

Figure 465. New Aspect

560 3BUF001094R4101

Section 5 Creating Reports Attaching a Report Template to a File Viewer Aspect

5. Select the File Viewer aspect in this dialog, Figure 466, 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, you can either right click on the aspect and choose Config View from the context menu, or use the corresponding icon on the tool bar, Figure 467.

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

Figure 466. Adding a File Viewer Aspect

Figure 467. Opening the Config View

3BUF001094R4101 561

Attaching a Report Template to a File Viewer Aspect Section 5 Creating Reports

8. Use the File Browser dialog to select the report file, then click Open,

Figure 469.

Figure 468. Attaching the Report File to the Work Document Section

Click Attach button in Work Document section

562 3BUF001094R4101

Section 5 Creating Reports Attaching a Report Template to a File Viewer Aspect

The result is shown in Figure 470.

Figure 469. Selecting the File to Attach to the File Viewer Aspect

3BUF001094R4101 563

Attaching a Report Template to a File Viewer Aspect Section 5 Creating Reports

Figure 470. File Attached

SelectedFileAttached

564 3BUF001094R4101

Section 5 Creating Reports Report Preferences Aspect

Report Preferences AspectThe Report Preferences aspect, Figure 471, lets you 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.

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 you create subfolders, the maximum number applies to each subfolder. You can create additional instances of the Report Preferences aspect 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 471. Report Preferences Aspect

3BUF001094R4101 565

Report Printing Aspect Section 5 Creating Reports

Report Printing AspectA Report Printing aspect, Figure 472, is in every Completed Report object in the Reports branch of the Scheduling structure. This aspect lets you select the public 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 472. Report Printer Aspect

566 3BUF001094R4101

Section 5 Creating Reports View Report Logs Aspect

View Report Logs AspectThis 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 473. The fields are described in Table 27. You use this window to:

• copy (archive) data for report logs from the runtime History database to the specified archive media. See Section 8, Reading and Managing Archive Data.

• delete restored report logs that you have restored from the archive media to the restored History database. See Section 8, Reading and Managing Archive Data.

• view reports stored in a selected report log. See Viewing Reports Stored in a Report Log on page 568.

Figure 473. View Report Logs Aspect

Report Log

Reports stored inthe selected log

3BUF001094R4101 567

View Report Logs Aspect Section 5 Creating Reports

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 you want to view.

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

Table 27. 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.

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.

568 3BUF001094R4101

Section 5 Creating Reports Setting Up E-mail for Reports

Setting Up E-mail for ReportsThe email option in the Report Action plug-in (Email on page 546) lets you send reports via email through Outlook Express. This functionality requires some set-up in Windows. Specifically you must:

• set up a POP3 server. The POP3 e-mail server can be on any computer that has access to the computer where the reports will run.

• on the computer where the reports will run, set up an account on Outlook Express.

Guidelines for Setting Up the POP3 ServerContact your network administrator to install a POP3 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. This section describes the minimum requirements for any e-mail server that you use:

• Add an account that Outlook Express will use to send mail.

• Turn off outgoing mail authentication if possible. This will simplify the Outlook Express set up. If you are required to enable outgoing mail authentication, then you will be required to specify the POP3 E-mail server username and password in the Outlook Express set up. This procedure is covered in Guidelines for Outlook Express on page 570.

If the computer where you plan to set up the POP3 E-mail server is protected by a firewall, you must ensure that the firewall does not close the POP3 E-Mail port (port 110 is standard).

3BUF001094R4101 569

Setting Up E-mail for Reports Section 5 Creating Reports

Guidelines for Outlook ExpressOutlook Express is a standard component that is installed with Windows 2000/XP. This section describes how to set up Outlook Express to support e-mailing reports by adding the e-mail server account to Outlook Express. To do this:

1. Open Outlook Express.

2. From the Outlook Express menu bar, choose Tools > Accounts. This displays the Internet Accounts window, Figure 474.

3. Click Add and then choose Mail from the pop-up menu, Figure 475.

This launches the Internet Accounts Wizard.

4. Enter a display name, Figure 476. This name will be displayed in the From: field when an outgoing report is received. When you are finished, click Next.

Figure 474. Outlook Express Internet Accounts

Figure 475. Launching the Internet Accounts Wizard

570 3BUF001094R4101

Section 5 Creating Reports Setting Up E-mail for Reports

Figure 476. Display Name

3BUF001094R4101 571

Setting Up E-mail for Reports Section 5 Creating Reports

5. Enter the POP3 server e-mail address, Figure 477. This address is based on the POP3 E-mail server account name. Get the account name from the administrator that set up the account.

If the POP3 E-mail server has an authentic internet e-mail address, then enter the POP3 E-mail server account name with the applicable extension for example: Reports@us.abb.com.

If your e-mail server does not have a real address (no .com or .net extension) then simply enter the account name, for example: Reports. When you do this, Outlook Express will inform you that the e-mail address is invalid. Click Ok to acknowledge the message and continue.

When you are finished, click Next.

Figure 477. E-mail Address

572 3BUF001094R4101

Section 5 Creating Reports Setting Up E-mail for Reports

6. Enter the server address in both the Incoming and Outgoing fields, Figure 478. If the server does not have a real Internet address, enter the network name for both fields, for example: eng126. Otherwise, enter the computer address, for example: us.abb.com in both fields.

Consult the administrator that set up the POP3 E-mail server account for advice on how to specify these addresses.

When you are finished, click Next.

Figure 478. Server Address

3BUF001094R4101 573

Setting Up E-mail for Reports Section 5 Creating Reports

7. Enter the password for the account in the password field. If you do not know the password, consult the administrator that set up the account.

Make sure Remember password is checked, Figure 479. When you are finished, click Next.

8. When the wizard indicates you are finished, Figure 480, click Finish.

Figure 479. Password

574 3BUF001094R4101

Section 5 Creating Reports Setting Up E-mail for Reports

9. This adds the account, Figure 481.

10. Select the account and then click Properties.

Figure 480. Finish Prompt

Figure 481. Account Added

3BUF001094R4101 575

Setting Up E-mail for Reports Section 5 Creating Reports

11. Set the name to better describe the account, for example: Reports Account, Figure 482.

12. If your e-mail server is setup so that outgoing mail requires authentication, go to the Servers tab and check the My server requires authentication checkbox, Figure 483. Click OK.

Figure 482. Renaming the Account

576 3BUF001094R4101

Section 5 Creating Reports Setting Up E-mail for Reports

13. Close Outlook Express.

Now that your Outlook Express and POP3 E-Mail server is setup, you can start E-Mailing reports.

Figure 483. Server Authentication

3BUF001094R4101 577

Troubleshooting Reports Section 5 Creating Reports

Troubleshooting ReportsIf 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 554. The following conditions will cause a report to hang:

• Failure to enable macros in Excel - Scheduling a report that uses Visual Basic macros in a Microsoft Excel spreadsheet, you must enable macros 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, you must include those parameters in the report action.

• Failure to install Crystal Reports correctly - When running a report built with Crystal Reports, the report will fail if you did not perform a complete installation (install all possible features and components). 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

578 3BUF001094R4101

Section 5 Creating Reports Creating a Report with Crystal Reports - Example

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.

Creating a Report with Crystal Reports - ExampleThis 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. Therefore, you must already know how to use Crystal Reports to follow this tutorial. If you need further details regarding any procedures related to Crystal reports, refer to the Crystal Reports User’s Guide or on-line help.

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

Figure 484. Report Architecture and Data Flow

Report Schedule

ODBCBatch Trend View

BATCHIDTIMESTAMPDATAVALUE

Report

Report Action

TemplateCompleted

Report

BatchManagement

BatchID

3BUF001094R4101 579

Creating a Report with Crystal Reports - Example Section 5 Creating Reports

Connecting the Report to the ODA Table for Historical Data

In order for the reports you create 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 Management application.

There are several methods in Crystal reports by which you can make this connection. This procedure shows you how to use the Database Expert. To do this:

1. On the Crystal Reports menu bar, choose Database>Database Expert, Figure 485.

2. Find the BATCH_TRENDS view under ODBC>localhost, select the view, then click the right (>) arrow to add it to the selected database list, Figure 486.

Figure 485. Launching the Database Expert

580 3BUF001094R4101

Section 5 Creating Reports Creating a Report with Crystal Reports - Example

3. Click OK.

Figure 486. Selecting the BATCH_TRENDS View

3BUF001094R4101 581

Creating a Report with Crystal Reports - Example Section 5 Creating Reports

Selecting Fields from the Batch_Trends View to Include in the Report

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 connected BATCH_TRENDS view. Use the Field Explorer:

1. On the Crystal Reports menu bar, choose View>Field Explorer, Figure 487.

Reference Figure 488 for the following steps.

2. Expand the Database Fields branch.

3. Expand the BATCH_TRENDS branch.

4. Select a field, for example BATCHID, then right click and choose Insert to Report from the context menu.

5. Situate the field in the location where you want it to appear in the report.

6. Repeat steps 4 & 5 for other fields as required.

Figure 487. Launching the Field Explorer

582 3BUF001094R4101

Section 5 Creating Reports Creating a Report with Crystal Reports - Example

Adding Parameters

The report will be run for each new batch that is completed. This historical data related to each specific batch is assessed 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. A second parameter is also required to access batch-specific data in the BATCH_TREND view. This is the logical name. To create these parameters in Crystal Reports:

1. Select the Parameter Fields branch in the Field Explorer, right click, and choose New from the context menu, Figure 489.

Figure 488. Selecting Fields

Figure 489. Creating a New Parameter

3BUF001094R4101 583

Creating a Report with Crystal Reports - Example Section 5 Creating Reports

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 490. Click OK when you are done.

3. Repeat steps 1 & 2 for the second parameter (also String value type).

The report definition so far is shown in Figure 491.

Figure 490. Specifying the Parameter

584 3BUF001094R4101

Section 5 Creating Reports Creating a Report with Crystal Reports - Example

Configuring the Query to Get Historical Process Data for the Current Batch

This section shows you how use to the Record Selection Formula Editor 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, Figure 492.

Figure 491. Report So Far

3BUF001094R4101 585

Creating a Report with Crystal Reports - Example Section 5 Creating Reports

2. Enter the query as shown in Figure 493. 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.

3. Save the report.

Figure 492. Launching the Selection Formula Editor

Figure 493. Selection Formula Done

586 3BUF001094R4101

Section 5 Creating Reports Creating a Report with Crystal Reports - Example

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. See Attaching a Report Template to a File Viewer Aspect on page 559.

2. Create a Job Description object and Report Action aspect in the Scheduling structure. See Creating Objects and Aspects in the Scheduling Structure on page 526.

3. Configure the Report Action. See Defining the Report Action on page 529.

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 (you will be required to know the logicalname value before you configure the Report Action.

4. Configure the schedule. See Defining the Schedule on page 552.

3BUF001094R4101 587

Using DataDirect Section 5 Creating Reports

Using 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 illustrated in Figure 484.

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. Therefore, you must already know how to use DataDirect to follow this tutorial. If you need further details regarding any procedures related to DataDirect, refer to Section 2, DataDirect - Excel Data Access, or on-line help.

Figure 494. Report Architecture and Data Flow

Report Schedule

ADO Data ProviderBatch Trend View

BATCHIDTIMESTAMPDATAVALUE

Report

Report Action

TemplateCompletedReport

BatchManagement

BatchID

588 3BUF001094R4101

Section 5 Creating Reports Using DataDirect

Passing in batchid

The batchid must be passed in as a parameter via the Report Action. This procedure 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 495, cell C2 is renamed batchid.

Retrieving Historical Log Data for the Batch

Use the Batch Data dialog in DataDirect to access the Batch_Trends view.

1. Start DataDirect. From the Windows task bar, choose: Start>Programs> ABB Industrial IT 800xA>Operations >DataDirect, Figure 496.

Figure 495. Renaming a Cell as batchid

Figure 496. Starting DataDirect

Renaming Cell C2with the batchid Parameter name

3BUF001094R4101 589

Using DataDirect Section 5 Creating Reports

2. Open the Batch Data dialog.

3. Use the Batch Data dialog, Figure 498, 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.

Figure 497. Opening the Batch Data Dialog

Use Tool Bar Button or DataDirect Menu

590 3BUF001094R4101

Section 5 Creating Reports Using DataDirect

Figure 498. Setting Up the Batch Trend Query

3BUF001094R4101 591

Using DataDirect Section 5 Creating Reports

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. See Attaching a Report Template to a File Viewer Aspect on page 559.

2. Create a Job Description object and Report Action aspect in the Scheduling structure. See Creating Objects and Aspects in the Scheduling Structure on page 526.

3. Configure the Report Action. See Defining the Report Action on page 529.

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 (you will be required to know the logicalname value before you configure the Report Action.

You must also specify login parameters for connecting the DataDirect report to the applicable data server. To do this, define the following parameter:

DataServerLogin = computer name,user name, password

For example: DataServerLogin = roc74,aid,aid

4. Configure the schedule. See Defining the Schedule on page 552.

This concludes the tutorial for DataDirect.

592 3BUF001094R4101

Section 5 Creating Reports Using Excel Without DataDirect Add-ins

Using Excel Without DataDirect Add-insIn order for the reports you create 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 via the predefined numericlog (history) and generic_da (real-time) tables.

You can change the default set up for DATABASE1 to use the IM OPC HDA server, and/or specify a different real-time database table. Further, you can create additional ODA databases where each one specifies a different real-time database. This lets you connect your client application to a different ODA database, depending on you particular data access requirements. For instructions on configuring ODA, refer to the section on Open Data Access in Industrial IT 800xA - Information Management Configuration.

You must have Microsoft Query installed to set up this functionality. If this application is not installed, you may install it now from the Excel installation media.

Connecting the Excel Spreadsheet to the ODBC Data Source

This procedure provides guidelines for using Microsoft Query to connect the Excel spreadsheet to an ODBC driver and create a query for history data. If you need more detailed instructions for using Microsoft Query, refer to the on-line help available with Microsoft Excel.

To connect the Excel spreadsheet to an ODBC driver and create a query for history data:

1. Use the Get External Data function in Excel to create a new query. Choose Data>Get External Data>New Database Query, Figure 499.

3BUF001094R4101 593

Using Excel Without DataDirect Add-ins Section 5 Creating Reports

2. Use the Choose Data Source dialog, Figure 500, to choose the applicable ODBC data source.

Figure 499. Create New Query

Figure 500. Referencing the ODBC Driver

594 3BUF001094R4101

Section 5 Creating Reports Using Excel Without DataDirect Add-ins

3. Use the Query Wizard to select the Numeric Log table, Figure 501, and then select the columns whose data you want to access, Figure 502.

4. Use the Query Wizard to either set up parameters, or query against a specific log name. Figure 503 shows how to query against a specific log name.

Figure 501. Selecting the NUMERICLOG Table

Figure 502. Selecting Columns

3BUF001094R4101 595

Using Excel Without DataDirect Add-ins Section 5 Creating Reports

5. Finish the query.

Figure 503. Querying Against a Specific Log Name

596 3BUF001094R4101

Section 6 Scheduling

This section describes how to schedule, execute, and maintain jobs in the 800xA system. Supported jobs include reports, historical data archiving, event-driven data collection, calculations, consolidation of PDLs and message logs, and back-ups.

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

When you install the Application Scheduler on an Information Management server, the required Service Group and Service Provider objects are automatically created in the Service structure as part of the Information Management post-installation procedure. When you install the Application Scheduler to run on a node that is NOT an Information Management server, these objects must be manually created under the Scheduling Service group in the Service structure. This is described in the section on service providers in Industrial IT 800xA - Information Management Configuration.

Figure 504. Scheduling Structure with Job Descriptions and Running Jobs

3BUF001094R4101 597

Section 6 Scheduling

Action aspects are added to the Job Description object to specify the activity to be performed by the job. For example, you would add a Report Action aspect 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 you create it. To create the Job Description object and corresponding Schedule Definition aspect, see Adding a Job Description Object on page 599.

2. As an option you can 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. See Specifying Start Conditions on page 611.

3. Add and configure an action aspect. This aspect defines the function that the job will perform. For this release, five standard actions are supported: reports, archive, event-driven data collection, consolidation of PDLs and message logs, and calculations.

Actions on page 619 describes how to add an action aspect. Details for configuring a specific type of action are provided on the applicable book as indicated below:

• reports - This book, see Section 5, Creating Reports.

• archive - The section on configuring archive in Industrial IT 800xA - Information Management Configuration.

• event-driven data collection - The section on configuring process data collection in Industrial IT 800xA - Information Management Configuration.

• consolidation of PDLs and message logs - The section on configuring consolidation in Industrial IT 800xA - Information Management Configuration.

• calculations - The section on configuring calculations in Industrial IT 800xA - Information Management Configuration.

598 3BUF001094R4101

Section 6 Scheduling Adding a Job Description Object

Adding a Job Description ObjectJobs are created in the Scheduling structure. To create a job:

1. In the Plant Explorer, select the Scheduling Structure, Figure 505.

2. Right-click on Job Descriptions and choose New Object from the context menu, Figure 506.

3. Select the Job Description object type in the New Object dialog, Figure 507. Assign the object a logical name.

Figure 505. Scheduling Structure

Figure 506. Adding a New Job Object

3BUF001094R4101 599

Adding a Job Description Object Section 6 Scheduling

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

Figure 507. New Object Dialog

Job DescriptionSelected

ObjectName

600 3BUF001094R4101

Section 6 Scheduling Adding a Job Description Object

Scheduling Definition View

The Scheduling Definition view has three tabs:

• Schedule - for specifying scheduling parameters. See Defining the Schedule on page 602.

• Arguments - for specifying 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. See Arguments on page 616.

• Log - for viewing a log of messages regarding job execution when the job is running, or is finished running. See Viewing a Job Log on page 618.

Figure 508. Scheduling Definition Configuration View

3BUF001094R4101 601

Defining the Schedule Section 6 Scheduling

Defining the ScheduleThe Scheduler supports several scheduling methods, for example: cyclic, periodic, monthly, conditional, and so on. The Schedule tab lets you 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 509. 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 lets you 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 you select a specific service group to run the job.

Use the Schedule pull-down list to select the type of schedule, then refer to the applicable instructions below to learn how to use the plug-in dialog:

• To run a job at cyclic intervals specified in seconds, see Cyclic Scheduling on page 603.

• To run a job periodically at daily, hourly, minute, or second intervals, see Periodic Scheduling on page 604.

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

602 3BUF001094R4101

Section 6 Scheduling Cyclic Scheduling

• To run a job on a specified weekday during the month (for example first Monday, third Wednesday, last Sunday, or every Tuesday), see Weekly Scheduling on page 605.

• To run a job on a specific day of the month (for example 1st, 12th, 31st, or every day), see Monthly Scheduling on page 607.

• To run a job according to a list of scheduled dates and times, see Creating a Scheduling List on page 609.

• To run a job based on the evaluation of an expression, see Expression-based Scheduling on page 610.

Cyclic SchedulingThe Cyclic Schedule plug-in, Figure 510, lets you 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, if you specify the time interval as 60 seconds as shown in Figure 510, the job will run at 60-second intervals.

Figure 510. Cyclic Schedule Plug-in

3BUF001094R4101 603

Periodic Scheduling Section 6 Scheduling

Periodic SchedulingThe Periodic plug-in, Figure 511, lets you specify a periodic interval in weeks, days, hours, minutes, or seconds. You may 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 you can 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 respective start and end times.

Figure 511. Periodic Schedule Plug-in

604 3BUF001094R4101

Section 6 Scheduling Weekly Scheduling

Weekly SchedulingThe Weekly plug-in, Figure 512, lets you pick a weekday during the month (for example first Monday, third Wednesday, last Sunday, or every Tuesday). You may also specify a scheduling time-window which defines a beginning and end time for the 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 512. 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.

As an option you can 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 respective start and end times.

Figure 512. Weekly Schedule Plug-in

3BUF001094R4101 605

Weekly Scheduling Section 6 Scheduling

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

Day of week

Use this pull-down list to select the weekday (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, or Sunday), Figure 514.

Time of day

Use this control to select the time of day, Figure 515.

Figure 513. Selecting the Frequency

Figure 514. Selecting the Day of the Week

Figure 515. Selecting the Time of Day

606 3BUF001094R4101

Section 6 Scheduling Monthly Scheduling

Monthly SchedulingThe Monthly plug-in, Figure 516, lets you pick a day of the month (for example 1st, 12th, 31st, or Every Day). You may 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 lets you specify a time of day at which to run the job. The Hourly tab lets you 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.

As an option you can 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 respective start and end times.

Figure 516. Monthly Schedule Plug-in

3BUF001094R4101 607

Monthly Scheduling Section 6 Scheduling

Days

Use this list to select one or more days of the month. You can select one or more days as required by clicking the corresponding number. All selects every day of the month. Clear List clears all selections.

Daily

This lets you specify a time of day at which to run the job, Figure 517.

Hourly

This lets you specify one or more hours in the day at which to run the job, Figure 518. All selects every hour of the day. Clear List clears all selections.

Figure 517. Daily

Figure 518. Hourly

608 3BUF001094R4101

Section 6 Scheduling Creating a Scheduling List

Creating a Scheduling ListThe List plug-in, Figure 519, lets you 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. You can remove any added schedule by selecting it, and then clicking Remove.

Figure 519. List Schedule

3BUF001094R4101 609

Expression-based Scheduling Section 6 Scheduling

Expression-based SchedulingThe Expression plug-in, Figure 520, lets you schedule a job based on the evaluation of an expression. To create an expression schedule, select Expression Schedule from the Schedule pull-down list.

Enter the expression in the edit window. Any capabilities within VBScript or COM technologies can be used to manipulate data. External functions and libraries may also be used. 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’

An example is shown in Figure 520.

You can use the pull-down list in the lower right corner of the dialog, Figure 521, 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 520. Expression Schedule

Figure 521. Start When Specification

610 3BUF001094R4101

Section 6 Scheduling Specifying Start Conditions

Specifying Start ConditionsStart 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 602.

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 described in Job Hierarchies on page 623.

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. See The Expression Start Condition on page 614

• enabled/disabled switch setting - See The Yes/No Start Condition on page 615.

To add a start condition aspect:

1. Right-click on the Job object (for example DayShiftReport in Figure 522) and choose New Aspect from the context menu.

Figure 522. Adding a Schedule Aspect

3BUF001094R4101 611

Specifying Start Conditions Section 6 Scheduling

2. In the New Aspect dialog, browse to the Scheduler category and select the Start Condition aspect (path is: Scheduler>Start Condition>Start Condition), Figure 523.

You can use the default aspect name, or specify a new name.

3. Click Create to add the Start Condition aspect to the job.

4. Click on the Start Condition aspect to display the configuration view, Figure 524.

Figure 523. New Aspect Dialog

612 3BUF001094R4101

Section 6 Scheduling Specifying Start Conditions

Configuring a Start Condition

Use the Start Condition pull-down list to select the type of start condition, Figure 525.

Refer to the applicable section to learn how to configure the selected start condition:

• The Expression Start Condition on page 614

• The Yes/No Start Condition on page 615

Figure 524. Start Condition Aspect - Configuration View

Figure 525. Selecting the Type of Start Condition

3BUF001094R4101 613

The Expression Start Condition Section 6 Scheduling

The Expression Start ConditionThe Expression start condition lets you enter an expression, Figure 526. Refer to Expression-based Scheduling on page 610 for syntax guidelines.

Figure 526. Expression Start Condition

614 3BUF001094R4101

Section 6 Scheduling The Yes/No Start Condition

The Yes/No Start ConditionThe 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 527.

Figure 527. Yes/No Start Condition

3BUF001094R4101 615

Arguments Section 6 Scheduling

ArgumentsJobs whose actions support arguments can reference user-defined arguments to establish values for certain settings. For example, parameters in the Report action can reference arguments to set parameter values.

Argument lists are created on a per-job basis. This is done via the Arguments tab of the Scheduling Definition aspect of the Job Description object, Figure 528.

Arguments may also be created dynamically by external applications such as Batch Management applications. This lets the batch application dynamically specify

Figure 528. Arguments List

616 3BUF001094R4101

Section 6 Scheduling Arguments

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

To create a list of arguments manually (reference Figure 528 for steps 1 & 2):

1. In the Scheduling structure, select the Job Description object for the job whose argument list you want to edit.

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 529, then click OK.

This adds the new argument to the argument list, Figure 530.

When arguments are passed in dynamically by an application such as Batch management, the list on the Arguments tab is ignored.

Figure 529. Modify Arguments Dialog

Figure 530. Argument Added

3BUF001094R4101 617

Viewing a Job Log Section 6 Scheduling

You can remove an argument from the list by selecting the argument and then clicking Remove.

Viewing a Job LogThe 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 531. You can show the details for any line by double-clicking, or clicking on the plus sign.

The log holds the last ten instances of the job's execution plus any instances that have failed if they have not been deleted. If you need information regarding a job that has failed, you may also use the Scheduled Job aspect for the Running Job object as described in The Running Job on page 623.

Figure 531. Job Description - Log Tab

The number of status entries for SUCCESSFUL runs of a job is limited to 10. The status of failed jobs is not limited.

618 3BUF001094R4101

Section 6 Scheduling Actions

ActionsActions 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 in Figure 532) and choose New Aspect from the context menu.

2. In the New Aspect dialog, browse to the Scheduler category and select the Action aspect (path is: Scheduler>Action Aspect>Action Aspect), Figure 533.

You can use the default aspect name, or specify a new name.

Figure 532. Adding an Action Aspect

3BUF001094R4101 619

Actions Section 6 Scheduling

3. Click Create to add the Action aspect to the job.

4. Click on the Action aspect to display the corresponding view, Figure 534.

Figure 533. New Aspect Dialog

Figure 534. Action Aspect Configuration View

620 3BUF001094R4101

Section 6 Scheduling Actions

Action Aspect View

This view lets you configure an action, for example for running a report, consolidating PDLs and message logs, or event-driven historical data collection. The upper section provides the means for selecting the type of action you want to configure, Figure 535, and also contains properties which are common to all actions. These are described in Table 28. 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 plug-in does not implement or use these two fields, you will see them immediately revert back to default values whenever new values are applied.)

For details on configuring an action see:

• Defining the Report Action on page 529

See Industrial IT 800xA - Information Management Configuration for the following:

• Consolidating Message Logs and PDL data, see the Consolidation section

• Event-driven data collection, see the process data collection section.

• Scheduling calculations, see to the calculations section.

• Scheduling archive operations, see the configuring archiving section.

• Scheduling history backup, see the History Database Maintenance section.

Multiple actions may be added to an object. If you need to add multiple actions, and control the order in which they are executed, see Job Hierarchies on page 623.

Figure 535. Selecting an Action

3BUF001094R4101 621

Actions Section 6 Scheduling

Table 28. 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 lets you 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 Messages

This combo box optionally allows a system message to be generated when an action is started, finished, or both.

622 3BUF001094R4101

Section 6 Scheduling Job Hierarchies

Job HierarchiesJobs can be subdivided into steps. This lets you 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.

The Running JobThis section describes how to manage running jobs. This includes:

• Monitoring a Running Job on page 624

• Viewing Alarm and Event List on page 626

• Purging Running Job Objects on page 627

• Using the Test Action to Test a Job on page 627

3BUF001094R4101 623

Monitoring a Running Job Section 6 Scheduling

Monitoring a Running JobA Running Job object is inserted under the Running Jobs branch for any job that is currently running, Figure 536.

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 completion of each action. Each action may also generate a text log that is saved with the job. This information is available via the Scheduled Job aspect, Figure 537.

Figure 536. Running Jobs

624 3BUF001094R4101

Section 6 Scheduling Monitoring a Running Job

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 via the Job Log tab of the Scheduling aspect. See Viewing a Job Log on page 618.

Figure 537. Scheduled Job Aspect

3BUF001094R4101 625

Viewing Alarm and Event List Section 6 Scheduling

Viewing Alarm and Event ListAlarms and events for running jobs may be viewed via the Alarm and event aspect, Figure 538.

Figure 538. Alarm and Event List

626 3BUF001094R4101

Section 6 Scheduling Purging Running Job Objects

Purging Running Job ObjectsThe objects for running jobs that do not complete remain in the Running Jobs branch until you delete them. This includes jobs that fail, and jobs that are interrupted when the Scheduler is disabled for some reason. You can delete the jobs one-at-a-time by right-clicking on the object and choosing Delete from the context menu.

As an alternative, you can use the RunningJobsHandler to delete all Running Job objects, Figure 539.

Using the Test Action to Test a JobThe Test Action, Figure 540, runs the report via the interactive or workplace user, instead of the Scheduler. This will help you determine whether or not the scheduler is having problems. If you see dialogs asking for userid/password or data source, this indicates 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).

Figure 539. Deleting all Running Job Objects

Click to delete allRunning Job Objects

3BUF001094R4101 627

Security Section 6 Scheduling

Security

Operations related to Application Scheduler aspects are secured by restricting access to certain users. You can 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. If you bind a user role to an operation, then only that user type can perform the operation, and that user must be assigned the applicable 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. For further information regarding security and user management, refer to Industrial IT 800xA System Security.

You may also secure report templates and report output stored as Windows files on shared network drives. See Securing Windows Files on Shared Network Drives on page 632.

Figure 540. Test Action Function on the Action Aspect

628 3BUF001094R4101

Section 6 Scheduling Security

Permissions and user role bindings for aspects are configured in the Aspect System structure in the Plant Explorer. To do this: (reference Figure 541):

1. Go to the Aspect System structure in the Plant Explorer and select the Scheduler Aspect System.

Before you start applying any changes to the Security settings, you should have read the 800xA System Security Reference Manual, and made some experiments to verify that you understand the concepts.

3BUF001094R4101 629

Security Section 6 Scheduling

2. Expand the branch to show the four Scheduler aspect types (Action, Job Description, Scheduled Job, and Start Condition). Then further expand the branch for the aspect whose permissions you want to modify. For example, in Figure 541 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.

For each operation listed, select the appropriate permission, Figure 542. Refer to Table 29 for details.

Figure 541. Changing the Security Permissions for Application Scheduler

Figure 542. Changing the Permission for an Operation

630 3BUF001094R4101

Section 6 Scheduling Security

4. To further restrict access based on user role, click the User Role Bindings tab. For each operation listed, select the appropriate user role, Figure 543.

Table 29. Default Scheduling Aspect Permissions

Aspect Operations Required Permission

Action Modify Read

Configure None

Scheduling Definition

Modify Read Start - Run Now button

Operate None Operate

Scheduled Job

Modify Read Manage - Pause/Resume and Abort buttons

Operate None Operate

Start Condition

Modify Read

Configure None

Figure 543. Binding User Roles to Scheduler Operations

3BUF001094R4101 631

Securing Windows Files on Shared Network Drives Section 6 Scheduling

Securing Windows Files on Shared Network DrivesReport templates and report output may reside in shared network folders as Windows files. If you require the Windows files in shared network folders 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 account under which the Industrial IT services run. This is specified during system configuration. The account information is available via the 800xA Configuration Wizard. To get it, launch the configuration wizard: (Start>Programs>ABB Industrial IT 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 Explorer, or in My Computer on the remote computer, or when they use the net view command on the remote computer.

632 3BUF001094R4101

Section 7 Browsing for OPC Tags

The OPC browser, Figure 544, helps you find and select OPC objects on the connected OPC DA or OPC HDA server for real-time and historical data access. The browser may be launched from the Inform IT Process and History Values dialogs in DataDirect, the Trend or Ticker display in Desktop Trends, or it may be launched from the Windows task bar to support Open Data Access.

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 lets you 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 task bar. 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 task bar. See Launching the OPC Browser on page 634.

2. The browser connects to the server specified in the ACC Setup dialog. You can change this if necessary. See Changing the Server Connection on page 635.

3. The browser uses the AIPHDA data provider (for History log access) by default. If you want to use a different history data provider (for example, IMHDA), or the AIPOPC data provider for real-time access, see Changing the Data Provider on page 636.

4. Use the browser according to the guidelines in Navigation Methods on page 637 and Filtering on page 639. Also, for history access applications, refer to Considerations for History Access on page 641.

5. Copy tags to paste in the client application. See Copying Items on page 640.

3BUF001094R4101 633

Launching the OPC Browser Section 7 Browsing for OPC Tags

Launching the OPC Browser

When you install Open Data Access, the OPC Browser is accessible via the Windows Start menu, Figure 545: Start>Programs>ABB Industrial IT 800xA> Information Mgmt>Utilities>Information Management Browser.

Figure 544. Example, Data Browser

Figure 545. Launching the OPC Browser

634 3BUF001094R4101

Section 7 Browsing for OPC Tags Changing the Server Connection

Changing the Server ConnectionBy default, the OPC Browser connects to the server specified in the ACC Setup dialog. The connected server is indicated in the Connected To: field. You can specify a different server by clicking the Change Connection button, and then specifying the IP address or host name for the new server in the Change Connection dialog, Figure 546.

Figure 546. Changing the Server Connection

Change Connection Button

Change Connection

Connected Server Indication

Dialog

3BUF001094R4101 635

Changing the Data Provider Section 7 Browsing for OPC Tags

Changing the Data ProviderThe Data Provider specification determines the type of tags that you will be able to access via the browser:

• AIPOPC lets you browse for real-time (process or softpoint) tags

• AIPHDA connects to the 800xA OPC HDA server and lets you browse the Aspect Directory for numeric property logs. This supports seamless access to trend logs and history logs. It also lets you access log attributes.

• IMHDA connects to an alternative OPC HDA server. For further information, see Appendix C, Using the IM OPC HDA Server.

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

The mode of operation for the browser differs slightly depending on whether you are using AIPHDA or IMHDA. For further information, refer to Considerations for History Access on page 641.

Figure 547. Changing the Data Provider Specification

636 3BUF001094R4101

Section 7 Browsing for OPC Tags Navigation Methods

Navigation MethodsUse the left pane to browse the connected server’s directory structure to find the folder(s) where the data objects reside. The applicable objects within the selected folder(s) will be displayed in the right pane. The type of object displayed depends on the specified data provider (Changing the Data Provider on page 636).

Two navigation options are supported. Selecting a specific folder will show the applicable objects within that folder. As an alternative you can 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, Figure 548.

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 you accidentally request an excessive number of objects, you can abort the Get Entire List request by selecting Abort Get Entire List from the context menu.

3BUF001094R4101 637

Navigation Methods Section 7 Browsing for OPC Tags

Figure 548. Example, Get Entire List

Get Entire List Result

Getting Entire List of Tags UnderAC800M6ProcessValues Folder

Abort Get Entire List

638 3BUF001094R4101

Section 7 Browsing for OPC Tags Filtering

Filtering You can narrow the scope of items returned by the Get Entire List method by specifying a filter. This helps you 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

Checking the Exclude Filtered Items check box retrieves all items whose names DO NOT meet the filter criteria. For example, clicking this check box with the filter text IM will get all items whose names do not include the IM text string. Figure 549 shows two filter examples.

Figure 549. Example, Filter

Basic FilterGet items with IM text string

Same Filterusing ExcludeCheck Box

3BUF001094R4101 639

Copying Items Section 7 Browsing for OPC Tags

Copying ItemsThe Copy Item(s) function in the context menu lets you copy the selected items to the clipboard. From there you can paste the items into an external data access application such as Microsoft Query. To do this, right-click and choose Copy Item(s) as shown in Figure 550.

Then paste the copied item(s) in the external application, Figure 551.

Figure 550. Copying Items

640 3BUF001094R4101

Section 7 Browsing for OPC Tags Considerations for History Access

Considerations for History AccessWhen using the browser for History access, the contents of the left pane varies, depending on the type of OPC HDA server.

Figure 551. Pasting a Selected Item

3BUF001094R4101 641

Considerations for History Access Section 7 Browsing for OPC Tags

AIPHDA Access

For AIPHDA, the browser provides a directory structure similar to the Plant Explorer. The view includes all structures and directories where log aspects reside, Figure 552.

With the AIPHDA server, you can use the Seamless retrieval option when you are not sure which log in a property log hierarchy will provide the best coverage for the required 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, check the Seamless check box.

IMHDA Access

For IMHDA, the left pane lets you choose one of three paths or categories by which to conduct your search, Figure 553:

Figure 552. AIPHDA Access

642 3BUF001094R4101

Section 7 Browsing for OPC Tags Considerations for History Access

• EH lets you access logs that are local to the data provider to which you are connected. This is the fastest method and is recommended if you are querying a log that resides on the local server. It supports the ability to modify existing log entries, but not adding new entries.

• EH_NET lets you access logs on all servers on the network. This requires OMF access to be extended on the TCP/IP network. This is described in the section on Network Communications in Information Management Installation. It supports the ability to modify existing log entries, and add new entries.

• EH_PUBL lets you access archived log data that is published. For instructions on publishing archived data, refer to Publishing an Archive Volume on page 697.

• LOGMAN is not applicable for this release.

Figure 553. IMHDA Access

3BUF001094R4101 643

Considerations for History Access Section 7 Browsing for OPC Tags

644 3BUF001094R4101

Section 8 Reading and Managing Archive Data

The archive function supports permanent off-line storage for historical data collected in property (numeric), message, PDL, and report logs as well as reports stored as Completed Report objects. Archiving is configured as described in Industrial IT 800xA - 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, you must periodically remove and replace platters. For hard disks, you must ensure that archive entries are saved to a removable media (CD or DVD). When you are sure 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 formatted and initialized before you can store data on it. For MO drives, use the Windows disk formatting tool to format each new platter before you initialize 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, you must manually initialize the media.

• Manual archiving

• Publishing archive volumes for access by external applications - You can publish archive volumes to let client applications such as DataDirect access the archived data. This saves you from having to restore individual logs from the archive volumes. Publishing applies to property and message logs only.

3BUF001094R4101 645

Section 8 Reading and Managing Archive Data

• Restoring archived logs for access by external applications - To access archived log data that has not, or cannot be published, you must restore the archived logs from the archive media to the restored History database. You may also delete restored logs when you are through with them.

• Importing archive data from other 800xA systems and from earlier historian platforms - This is done using the Archive Import tool.

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

Archive Operations

Basic archive operations are organized into four categories:

• Maintaining Archive Media on page 666 describes:

Removing/Replacing Platters on page 667 Activating/Deactivating an Archive Device on page 668 Remounting a Volume on page 669 Initializing an Archive Volume on page 669 Copying Volumes on page 674 Overriding Volume Backup on page 677

• Archiving Logs Manually on page 677 describes how to perform ad-hoc archive operations for archive groups, or selected logs.

• Verifying Archive Data on page 694 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 696 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, see Importing Archive Data on page 715.

646 3BUF001094R4101

Section 8 Reading and Managing Archive Data User Interface for Managing Archive Data

User Interface for Managing Archive DataThe user interface for runtime archive operations is supported by four basic displays:

• the archive device aspect - main view - provides device- and volume-level information for an archive device. It supports remounting and initialization of volumes, as well as publishing and unpublishing of volumes. You can also open the archive volume aspect of a selected volume from this view. See Archive Device Aspect on page 648.

• 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 lets you restore archive entries from the volume to the restored database. As an option, you may select individual message or report logs within an entry to restore. This view also supports initialization of volumes, as well as publishing and unpublishing of volumes. See Archive Volume Aspect on page 651.

• the archive group aspect lists all archive groups configured in the system. It supports manual archiving on an archive group basis. You may also add, delete, and modify archive group configurations from this view. See Archive Group Aspect on page 657.

• 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. See:

– View Logs Aspect on page 660

– View Report Logs Aspect on page 661

– View Production Data Logs Aspect on page 664

3BUF001094R4101 647

Archive Device Aspect Section 8 Reading and Managing Archive Data

Archive Device AspectThe archive device aspect has two views. The config view lets you configure the archive device. This is described in Industrial IT 800xA - Information Management Configuration. The main view, Figure 554, 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 volumes, as well as publishing and unpublishing of volumes. You can also open the archive volume aspect of a selected volume from this view.

The aspect view is displayed by selecting the archive device aspect in the archive device object’s aspect list. You may 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 554, lets you display the selected view in a separate window.

The functions supported by this aspect are listed in Supported Functions on page 649.

The information provided on this aspect is described in Archive Device Information on page 650.

Figure 554. Archive Device Aspect - Main View

View

Node

ArchiveServiceObject

Selector

648 3BUF001094R4101

Section 8 Reading and Managing Archive Data Archive Device Aspect

Supported Functions

The archive functions supported by this aspect are described in Table 30. These functions are available via the context menu and Actions button, Figure 555.

Table 30. Archive Functions Supported by the Archive Device Aspect - Main View

Function Description

Opening an Archive Volume from the Archive Device Aspect.

Alternative to accessing a volume directly from the 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 669 Volumes should be remounted prior to initializing. You may also remount a volume to refresh the volume information on the archive device aspect.

Initializing an Archive Volume on page 669

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, you must manually initialize the volume.

Archiving Logs Manually on page 677 Alternative to scheduled archives.

Publishing an Archive Volume on page 697

Recommended method for making archived numeric data available for data access.

Overriding Volume Backup on page 677

There are certain situations when you may want to mark a volume as backed up, even though the volume has not been backed up.

Activating/Deactivating an Archive Device on page 668.

Device must be active to perform archive operations. MO devices must be deactivated to change platters.

Showing Volume Information on page 712.

3BUF001094R4101 649

Archive Device Aspect Section 8 Reading and Managing Archive Data

Archive Device Information

The device and volume information provided in this aspect is described in Table 31.

Figure 555. Commands Available on the Archive Device Aspect

Table 31. 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, you specify volume ID in the Initialize Volume dialog.

ContextMenu

ActionsButton

OR

650 3BUF001094R4101

Section 8 Reading and Managing Archive Data Archive Volume Aspect

Archive Volume Aspect

The Archive Volume aspect provides a user interface for managing an archive volume and provides detailed information for the volume, Figure 556. 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 lets you restore archive entries from the volume to the restored database. As an option, you may select individual logs within an entry to restore. This view also supports initialization of volumes, as well as publishing and unpublishing 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 Administration structure.

(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 Publishedand 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.

Table 31. Archive Device Aspect Main View

Field Description

3BUF001094R4101 651

Archive Volume Aspect Section 8 Reading and Managing Archive Data

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. When you select an entry 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 653.

The information provided on this aspect is described in Archive Volume Aspect Information on page 654.

Figure 556. Archive Volume Aspect

652 3BUF001094R4101

Section 8 Reading and Managing Archive Data Archive Volume Aspect

Supported Functions

The archive functions supported by this aspect are described in Table 32.

All functions are via the Actions button, Figure 557. Some may also be invoked via the context menu (Restore Archive, Restore Logs, and Platform Info).

Table 32. Archive Functions for Archive Volume Aspect

Function Description

Initializing an Archive Volume on page 669

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, you must manually initialize the volume.

Publishing an Archive Volume on page 697

Method for making archived numeric and message data available for data access.

Restoring Logs from Archive Media to Restored Database on page 701

Archived data must be restored to the runtime historical database before it can be viewed with a desktop data access tool such as DataDirect. For numeric logs, you MUST publish rather than restore.

Showing Volume Information on page 712

Showing Platform Information for a Log on page 713

Provides access to aspects of the selected object(s), for example, the Log Configuration aspect.

Verifying Signatures for a Volume on page 695

Lets you verify electronic signatures on a volume to determine whether or not the contents of the volume have been altered without authorization.

Showing Signature Information for a Volume on page 696

Lets you view the signature information for a volume

Copying Volumes on page 674 Lets you manually back up archive volumes.

3BUF001094R4101 653

Archive Volume Aspect Section 8 Reading and Managing Archive Data

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 33. The middle section lists the entries currently stored on this volume, Table 34. When you select an entry in the middle section, the logs that were archived for the selected entry are shown in the bottom section, Table 35.

Figure 557. Commands Available on the Archive Volume Aspect

Table 33. 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, you specify volume ID 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 Publishedand if the media is from HPUX, HP-UX will be shown.

654 3BUF001094R4101

Section 8 Reading and Managing Archive Data Archive Volume Aspect

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

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

Table 33. Volume Information - Top Section

Field Description

3BUF001094R4101 655

Archive Volume Aspect Section 8 Reading and Managing Archive Data

End Time End time for archived data.

Entries Number of log entries archived for this log.

Log Name Log name.

Table 35. Log Information for Selected Entry - Bottom Section

Field Description

656 3BUF001094R4101

Section 8 Reading and Managing Archive Data Archive Group Aspect

Archive Group AspectThe archive group aspect lists all archive groups configured in the system, Figure 558. Typically, you only require one such aspect; however, you may create additional archive group aspects for organizational purposes. This aspect lets you perform manual archives on a group basis. This is described in Manual Archiving for Archive Groups on page 678. In addition, you may add, delete, and modify archive group configurations. This is described in Industrial IT 800xA - Information Management Configuration.

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 you select an archive group, 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 via 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 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 via the List Group Items function.

3BUF001094R4101 657

Archive Group Aspect Section 8 Reading and Managing Archive Data

The functions supported by this aspect are described in Supported Functions.

Supported Functions

The runtime functions supported by this aspect are described in Table 36. Some functions are related to archive group configuration. These are described in Industrial IT 800xA - Information Management Configuration. All functions are available via the Action button and context menu, Figure 559.

Figure 558. Archive Group Aspect

658 3BUF001094R4101

Section 8 Reading and Managing Archive Data Archive Group Aspect

Table 36. Functions Supported by Archive Group Aspect

Function Description

Archiving Logs Manually on page 677 An alternative to scheduled archiving.

Resetting the Last Archive Time for an Archive Group on page 712

You may want to reset the last archive time to cause the next archive operation to go back farther in time, for example to account for a failed archive, or skip ahead to a later time.

Listing Group Items on page 711 Lets you determine the exact content of an archive group (items contained within the archive entries).

Figure 559. Archive Group Aspect Context Menu

3BUF001094R4101 659

View Logs Aspect Section 8 Reading and Managing Archive Data

View Logs AspectThis aspect provides access to a directory of property logs and message logs that reside in the runtime and restored databases, Figure 560. This aspect lets you:

• manually archive data for property and message logs. See Archiving Logs Manually on page 677.

• delete restored message logs from the restored History database. See Deleting Restored Logs on page 709.

The information provided in this aspect is described in Table 37.

Figure 560. View Logs Aspect

660 3BUF001094R4101

Section 8 Reading and Managing Archive Data View Report Logs Aspect

View Report Logs Aspect

This 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 561. The information provided in this aspect is described in Table 38. This aspect lets you:

• view reports stored in a selected report log. See Viewing Reports Stored in a Report Log on page 663.

• manually archive data for report logs. See Archiving Logs Manually on page 677.

• delete restored report logs from the restored History database. See Deleting Restored Logs on page 709.

Table 37. View Logs Aspect

Field Description

Service Group Indicates the node where the displayed logs reside.

Number of Logs Indicates the number of logs in the displayed list.

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.

3BUF001094R4101 661

View Report Logs Aspect Section 8 Reading and Managing Archive Data

Figure 561. View Report Logs Aspect

Table 38. 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.

Log Type Indicates the type of logs displayed REPORT is only valid type.

Number of Logs Indicates the number of logs in the displayed list.

662 3BUF001094R4101

Section 8 Reading and Managing Archive Data View Report Logs Aspect

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 you want to view.

4. In the lower pane, select the report.

5. Click View Selected Report.

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.

Table 38. View Report Logs Aspect

Field Description

3BUF001094R4101 663

View Production Data Logs Aspect Section 8 Reading and Managing Archive Data

View Production Data Logs AspectThis aspect provides access to a directory of Production Data Logs (PDLs) that reside in the runtime and restored databases, Figure 562. This aspect lets you:

• manually archive data for PDLs. See Manually Archiving PDLs on page 690.

• delete restored PDLs from the restored History database. See Deleting Restored Logs on page 709.

• delete runtime PDLs and tasks from the runtime database. See Deleting Restored PDLs and Tasks on page 710.

Figure 562. View Production Data Logs Aspect

664 3BUF001094R4101

Section 8 Reading and Managing Archive Data View Production Data Logs Aspect

This window displays the following information for PDLs and their corresponding tasks, Table 39.

Table 39. View Production Data Logs

Field Description

Service Group Indicates the node where the displayed logs reside.

Log Class Indicates whether the displayed logs are Run Time or Restored.

Log Type Indicates the type of logs displayed. PDL is only valid type.

Number of Logs Indicates the number of logs in the displayed list.

Log Name The log name is derived from the name of the root task. When you select a log from this list, the associated tasks are displayed in the Task field.

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 Time Fields

Start Time & End Time specify the time range for the Batch or Job

3BUF001094R4101 665

Maintaining Archive Media Section 8 Reading and Managing Archive Data

Maintaining Archive MediaThe 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 you configure an archive device you can specify that an alarm message be generated 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). It is recommended that you use a desktop application such as DataDirect to read these messages periodically to check the status of your archive media.

MO Media

For MO archive media, you are required to remove and replace the platter when it becomes full. The new platter must then be initialized. See:

• Removing/Replacing Platters on page 667

• Initializing an Archive Volume on page 669

Hard Disk Media

When archiving to a hard disk, it is strongly recommended that you configure the archive backup function. With archive backup, when a volume becomes full, the contents 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, you can specify that a backup copy of the archive be created at the specified location. You can also specify that both an ISO image and a shadow copy 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. How to configure archive backup is described in Industrial IT 800xA - Information Management Configuration.

Other Maintenance Operations

This section also covers:

• Activating/Deactivating an Archive Device on page 668

• Remounting a Volume on page 669

666 3BUF001094R4101

Section 8 Reading and Managing Archive Data Removing/Replacing Platters

• Copying Volumes on page 674

• Overriding Volume Backup on page 677

Removing/Replacing PlattersIf you are using MO media 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 668. If the platter still cannot be removed, power down the MO drive, then power it up and remove the platter.

Once you’ve replaced the platter, use the Windows disk formatting tool to format the new platter. This is illustrated in Figure 563. Select the NTFS file system. This procedure must be done for both sides of the platter.

Figure 563. Using the Windows Disk Formatting Tool

3BUF001094R4101 667

Activating/Deactivating an Archive Device Section 8 Reading and Managing Archive Data

Activating/Deactivating an Archive DeviceThe 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 deactivated to remove and replace a platter. To activate/deactivate an archive device, go to the Archive Device aspect main view, click Actions and choose Activate or Deactivate, Figure 564.

Figure 564. Activating an Archive Device

668 3BUF001094R4101

Section 8 Reading and Managing Archive Data Remounting a Volume

Remounting a VolumeVolumes should be remounted prior to initializing. You may also remount a volume to refresh the volume information on the archive device aspect. Remounting is performed via 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 565.

Initializing an Archive VolumeEach 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, you must manually initialize the volume.

Initialization of archive volumes may be done using the archive device aspect for the archive device whose volume you need to initialize, or you may use the archive volume aspect.

Figure 565. Remounting a Volume

For MO drives, before you initialize the archive volume, make sure the media has been formatted as described in Removing/Replacing Platters on page 667.

Or use theActions button

3BUF001094R4101 669

Initializing an Archive Volume Section 8 Reading and Managing Archive Data

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 you are initializing, or select the applicable archive volume aspect.

3. If you are using the archive volume aspect, invoke the Initialize command from the Action button or context menu, Figure 566.

Then skip steps 4 and 5 which pertain only when using the archive device aspect. Resume the procedure at Step 6.

4. If you are using the archive device aspect, select and remount the volume. This is not required when using the archive volume aspect.

You should always remount a volume BEFORE initializing it from the archive device aspect. The information in the archive device aspect is not automatically updated when you insert a new archive media, and so may not accurately indicate the current contents of the archive device. Remounting the volume will ensure that the selected 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 669).

Figure 566. Initializing a Volume From the Archive Volume Aspect

670 3BUF001094R4101

Section 8 Reading and Managing Archive Data Initializing an Archive Volume

5. If you are using the archive device aspect, once the volume has been remounted, re-select the volume, right click and choose Initialize from the context menu, Figure 567.

6. Whether you are using the archive volume aspect, or archive device aspect, invoking the Initialize command displays the Initialize Volume dialog, Figure 568.

The Volume ID and Overwrite Timeout default to the values specified for all volumes on the archive device config view. You may use this dialog to change these values if necessary. As an option, you may also enter a Volume Label. For further details regarding these initialization parameters see Table 40.

Figure 567. Initializing the Selected Volume

Figure 568. Initialize Archive Media Window

3BUF001094R4101 671

Initializing an Archive Volume Section 8 Reading and Managing Archive Data

7. Click OK to initialize the media. If you specify the initialization parameters correctly, a message indicating the initialization was successful will be displayed in the message box, and the Volume State will go to Valid, Figure 569. If one or more parameters were defined incorrectly, an error message will be displayed. If the Overwrite Timeout has not expired on the media you are initializing, you will be asked whether or not to overwrite it anyway.

Table 40. Initializing Archive Media

Field Description

Overwrite Timeout

This defaults to the Overwrite Timeout as configured in the Archive Device aspect’s 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 you are required to preserve data 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 you assign to this specific volume. The format is specified when you configure the archive device. Refer to the description of the Volume Format in the section on configuring archive in Industrial IT 800xA - Information management Configuration.

Volume ID Evaluated

When you enter a formatted string in the Volume ID field, the format characters 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.

672 3BUF001094R4101

Section 8 Reading and Managing Archive Data Initializing an Archive Volume

Figure 569. Initialize Successful Volume

3BUF001094R4101 673

Copying Volumes Section 8 Reading and Managing Archive Data

Copying VolumesArchive devices can be configured to automatically create shadow copies and/or ISO images of archive volumes when those volumes become full. This functionality is described in Industrial IT 800xA - Information Management Configuration. The Copy Volume function lets you perform these functions on-demand. This function is available on the Archive Volume aspect. Click Action and choose Copy Volume, Figure 570.

This displays the Copy Volume dialog, Figure 571. Use this dialog to specify the copy volume parameters as described in Table 41. Click OK when you are done.

Figure 570. Copy Volume

If the contents of the selected entries exceeds the specified Destination Quota, the Copy Volume dialog will re-open, and you will be required to specify another Destination Volume ID in order to continue copying entries.

Volumes backed up this way are not automatically marked as backed up. You can use the procedure in Overriding Volume Backup on page 677 to do this if necessary.

674 3BUF001094R4101

Section 8 Reading and Managing Archive Data Copying Volumes

Figure 571. Copy Volume Dialog

Table 41. Copy Volume Specification

Field Description

Source Volume ID Automatically filled in based on the volume whose aspect is selected.

Destination Volume ID

Enter the Volume ID for the new copy. This is typically the same as the Source Volume ID.

Destination Path Enter the full path to the location (drive\folder\folder...) where the copy will be created.

Destination Volume Label

This lets you specify a new volume label. The default is to use the label of the volume being copied.

Overwrite Timeout This lets you specify a new overwrite timeout. The default is to use the overwrite timeout of the volume being copied.

Include Archives This lets you specify the range of archive entries to copy.

3BUF001094R4101 675

Copying Volumes Section 8 Reading and Managing Archive Data

Destination Quota This lets you 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

Overwrite Destination

This check box lets you specify whether or not to overwrite the current 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 Signatures

This lets you specify whether or not to verify signatures. If you choose to verify signatures, the volume will not be copied if signatures are not verified.

Preserve Init Time This check box lets you specify whether or not to preserve the initialization time stamp. Checking this box will preserve the time stamp.

Table 41. Copy Volume Specification

Field Description

676 3BUF001094R4101

Section 8 Reading and Managing Archive Data Overriding Volume Backup

Overriding Volume BackupWhen 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 lets you mark a volume as backed up, whether or not the volume actually has been backed up.

To override a volume backup, go to the Archive Device aspect main view, click Actions and choose Override Volume Backup. This displays a warning message, Figure 572. Click Yes to continue or No (or Cancel) to cancel.

Archiving Logs ManuallyTypically, you configure archiving to occur periodically according to schedules configured via the Application Scheduler. You may also perform a manual (on-demand) archive. 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:

• You can perform a manual archive of an archive group. This functionality is supported by the Archive Group aspect. For details, see Manual Archiving for Archive Groups on page 678.

• You can also select logs to be archived. This functionality is provided by the view logs aspects. For property (numeric) and report logs, see Manual Archiving Property and Message Logs on an Ad-hoc Basis on page 680.

Manual archiving for PDLs is described in Manually Archiving PDLs on page 690.

Figure 572. Warning message for Overriding Volume Backup

3BUF001094R4101 677

Manual Archiving for Archive Groups Section 8 Reading and Managing Archive Data

Manual Archiving for Archive GroupsThis 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:

• Listing Group Items on page 711

• Resetting the Last Archive Time for an Archive Group on page 712

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

This displays the Manual Archive dialog, Figure 574.

Figure 573. Selecting the Archive Group

678 3BUF001094R4101

Section 8 Reading and Managing Archive Data Manual Archiving for Archive Groups

2. Specify the manual archive settings as described in Table 42.

Figure 574. Manual Archive Dialog

Table 42. 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

3BUF001094R4101 679

Manual Archiving Property and Message Logs on an Ad-hoc Basis Section 8 Reading and

Manual Archiving Property and Message Logs on an Ad-hoc BasisThis 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 680.

• Retrieving Log Information on page 682.

• Filtering the Retrieved Logs List on page 685.

• Completing the Archive Request on page 687.

Opening the View Logs Aspect

Manual archival is performed via the View Logs aspect for property/message logs, and the View Report Logs aspect for report logs.

To display the applicable aspect (reference Figure 575):

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.

680 3BUF001094R4101

Section 8 Reading and Managing Archive Data Manual Archiving Property and Message Logs on

Figure 575. View Logs Aspect

3BUF001094R4101 681

Manual Archiving Property and Message Logs on an Ad-hoc Basis Section 8 Reading and

The window is empty when you first open it. You must retrieve the log information for the logs that you want to archive. This procedure varies depending on the log type. For numeric, message, and report logs continue with this procedure as described in Retrieving Log Information. For PDLs, refer to View Production Data Logs Aspect on page 664.

Retrieving Log Information

For numeric, message, and report logs, start on the Retrieve tab, Figure 577. This tab is selected by default.

You can retrieve logs based on location (History server), or archive group. Enter the required information as described below.

Figure 576. View Logs

682 3BUF001094R4101

Section 8 Reading and Managing Archive Data Manual Archiving Property and Message Logs on

To retrieve by current location:

1. Select Current Location from the Retrieve By pull-down list.

2. When you retrieve 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 709). Published logs lets you 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.

3. Once you’ve specified the log class and type, 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.

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 577. Retrieve Tab

Figure 578. Select Archive Group Dialog

3BUF001094R4101 683

Manual Archiving Property and Message Logs on an Ad-hoc Basis Section 8 Reading and

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

The retrieved log list may be too large to manage. For example, the list in Figure 579 has 9000 logs. The Search tab lets you apply a filter to reduce the retrieved log list. This is described in Filtering the Retrieved Logs List on page 685. Apply a filter to reduce the log list if necessary, then select the logs you want to archive and complete the archive as described in Completing the Archive Request on page 687.

Figure 579. Example - Retrieved Log Information

684 3BUF001094R4101

Section 8 Reading and Managing Archive Data Manual Archiving Property and Message Logs on

Filtering the Retrieved Logs List

You can 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 43.

Table 43. 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 Match Any Condition

These radio buttons let you choose whether the search will include logs that match ANY one or more of the three conditions described above, or only those logs that match ALL three conditions.

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.

3BUF001094R4101 685

Manual Archiving Property and Message Logs on an Ad-hoc Basis Section 8 Reading and

An example search specification and result are shown in Figure 580. 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 580. Example Search Specification and Result

686 3BUF001094R4101

Section 8 Reading and Managing Archive Data Manual Archiving Property and Message Logs on

Completing the Archive Request

Complete the archive request via the Archive tab.

First select the logs that you want to archive. You can select any combination of contiguous and/or non-contiguous logs from the list. An example is shown in Figure 581.

For Report logs, select the entries (Reports) that you want to archive, Figure 582.

After selecting the logs to archive, enter required information is described in Table 44. You must specify the Archive Device and Surface (volume). As an option, you can also specify a Start & End Time, and enter a description. Click Archive when you are finished.

This completes the manual archive.

Table 44. Archive Tab

Field/Button Description

Archive Device Enter the name of the archive device where you want to copy the logs.

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, you can enter a time range for the archive. If you do not specify a time range, the entire log is archived.

Description Enter an optional description to identify this archive entry.

3BUF001094R4101 687

Manual Archiving Property and Message Logs on an Ad-hoc Basis Section 8 Reading and

Figure 581. Archive Tab - Numeric or Message Logs

688 3BUF001094R4101

Section 8 Reading and Managing Archive Data Manual Archiving Property and Message Logs on

Figure 582. Archive Tab - Report Logs

3BUF001094R4101 689

Manually Archiving PDLs Section 8 Reading and Managing Archive Data

Manually Archiving PDLsManual archival is performed via 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 583):

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.

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 lets you apply a filter to reduce the retrieved Task list. To do this, follow the guidelines in Filtering the Task List on page 692.

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 information. DO NOT click again. Doing this would put another request in the queue and delay the information retrieval process.

690 3BUF001094R4101

Section 8 Reading and Managing Archive Data Manually Archiving PDLs

Figure 583. Manual Archive

3BUF001094R4101 691

Manually Archiving PDLs Section 8 Reading and Managing Archive Data

Filtering the Task List

You can 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 584. This tab provides two Start Time fields, and two End Time fields. You can use these fields in ether of the following ways:

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

Figure 584. Filter Tasks Tab

692 3BUF001094R4101

Section 8 Reading and Managing Archive Data Manually Archiving PDLs

Completing the Archive Request

At this point you can choose to 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 585.

2. Fill in the information as described in Table 45. You must specify the Archive Device and Surface (volume). As an option, you can also enter a description.

3. Click Archive when you are finished.

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 45, then click Archive.

Figure 585. Archive PDLs Tab

Table 45. Archive Tab

Field/Button Description

Archive Device Enter the name of the archive device where you want to copy the logs.

Surface This pick list is populated with the list of surfaces corresponding to the selected archive device. The default choice is the active surface.

3BUF001094R4101 693

Verifying Archive Data Section 8 Reading and Managing Archive Data

Verifying Archive Data

The archive service uses electronic signatures in combination with machine-generated keys as a means for you to determine whether archive data has been falsified or altered without authorization. Every archive volume is marked with an encrypted electronic 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 695.

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 signatures will indicate that the signatures are valid, but the keys do not match. In this case, to verify the integrity of the volume you will require a record of the original key used when the archive was made. This record may then be compared to the key which is currently stored on the volume.

Therefore, for each archive volume you should read and record the signature information to record the public key. How to do this is described in Showing Volume Information on page 712. Use this same function to compare a recorded public key with the current public key stored on an archive volume.

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.

Table 45. Archive Tab

Field/Button Description

694 3BUF001094R4101

Section 8 Reading and Managing Archive Data Verifying Signatures for a Volume

Verifying Signatures for a VolumeThis lets you verify signatures on a selected volume, Figure 587.

1. Select the archive volume aspect.

2. Click Actions then choose Verify Signatures (or use context menu).

Figure 586. Verifying Signatures

Indicates public key on this machinedoes not match key with which archiveentry was originally stored (different machine or new operating system)

3BUF001094R4101 695

Showing Signature Information for a Volume Section 8 Reading and Managing Archive Data

Showing Signature Information for a VolumeThis function lets you view the signature information for a volume, Figure 587. To use this function:

1. Select the archive volume aspect.

2. Click Actions then choose Signature Info (or use context menu).

Making Archived Data Available to Client ApplicationsIn 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 701.

For property logs you must publish rather than restore the archive data.This is described in Publishing an Archive Volume on page 697.

Message log data stored on the published volume is also published. This lets you access the message log data via alarm/event lists configured in the 800xA System. Archive message logs must be restored if you want to access the archive data via the SQL-based tools in DataDirect, Desktop Trends, and Crystal Reports.

Figure 587. Signature Information

696 3BUF001094R4101

Section 8 Reading and Managing Archive Data Publishing an Archive Volume

Publishing an Archive VolumeYou can publish the contents of one or more archive volumes 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 property 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 lets you expose a larger amount of archive data for client applications at any one time.

This procedure may be is performed via either an archive device aspect, Figure 588, or an archive volume aspect, Figure 589.

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 588. 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 via the Action button, Figure 589.

The media database files require a certain amount of free disk space on your hard drive. You should unpublish any volumes that you are not accessing on a regular basis to limit the size of the media database.

3BUF001094R4101 697

Publishing an Archive Volume Section 8 Reading and Managing Archive Data

Completion of the publish operation is indicated by a Success message in the status window, Figure 590.

At this point the archive data are available for client applications. See Accessing Published Logs on page 700.

Figure 588. Publishing a Volume from the Archive Device Aspect

Archive entries written to the volume after publishing will not be in the media database. Access to this data would require you to unpublish and then republish the volume.

698 3BUF001094R4101

Section 8 Reading and Managing Archive Data Publishing an Archive Volume

Figure 589. Publishing from the Archive Volume Aspect

Figure 590. Success Message

3BUF001094R4101 699

Accessing Published Logs Section 8 Reading and Managing Archive Data

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 you must use the full log name, and you must use the -r suffix in place of the -o suffix to distinguish between original (runtime) and published logs.

When using the OPC Browser, if you are connected via the IMHDA data provider, the browser provides a folder specifically for browsing published logs. Guidelines for using this browser are provided in Section 7, Browsing for OPC Tags.

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, you should unpublish a volume when you are finished with it. To do this:

1. Select the volume as described in Publishing an Archive Volume on page 697.

2. Right-click and choose Unpublish Volume from the context menu.

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 if you attempt to retrieve archive data for such a log using the above syntax, the restored data will be retrieved rather than the published data.

Unpublishing a volume does not decrease the size of the media database files. If you need 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 you delete the media database files.

700 3BUF001094R4101

Section 8 Reading and Managing Archive Data Restoring Logs from Archive Media to Restored

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.

Restoring is performed via the archive volume aspect. Archive volumes are typically located in the Node Administration structure under their respective archive devices.

You can restore an entire archive entry, or you can select a subset of logs to restore from the entry. Also, the procedure for restoring an entry with Platform Objects is slightly different. See

• Restoring an Archive Entry on page 702

• Restoring Selected Logs in an Entry on page 703

• Restoring an Entry With Platform Objects on page 704

Guidelines for referencing restored logs are provided in Accessing Restored Logs on page 709.

Figure 591. Unpublishing a Volume

For property logs you must publish rather than restore the archive data. See Publishing an Archive Volume on page 697.

3BUF001094R4101 701

Restoring Logs from Archive Media to Restored Database Section 8 Reading and Managing

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 592. You may filter the entries list as described in Filtering Archive Entries on page 705.

While the restore is in progress, the message in Figure 593 is displayed. You may close this message box; however, if you do, you will not be notified when the restore is finished. It is therefore recommended that you leave this message open while the restore is in progress.

Figure 592. Restore Archive

Figure 593. Restoring Prompt

702 3BUF001094R4101

Section 8 Reading and Managing Archive Data Restoring Logs from Archive Media to Restored

Restoring Selected Logs in an Entry

To restore one or more selected logs:

1. Select an archive entry from the middle section. When you select an archive entry, the corresponding logs are displayed in the bottom section.

2. As with archive entries, you can reduce the number of logs in the list by applying a filter, or you can search the list for a specific log. See Filtering Logs on page 707.

To restore the selected logs, first select the logs, right-click and choose Restore Logs from the context menu.

Figure 594. Example, restoring Selected Logs

3BUF001094R4101 703

Restoring Logs from Archive Media to Restored Database Section 8 Reading and Managing

Restoring an Entry With Platform Objects

When restoring an entry with platform objects, you’ll be prompted to specify the location where the objects will be restored. This is illustrated in Figure 595.

Figure 595. Selecting the Location for Restoring Platform Objects

Object for restoringCompleted ReportsCreated via PlantExplorer Workplace

704 3BUF001094R4101

Section 8 Reading and Managing Archive Data Restoring Logs from Archive Media to Restored

Filtering Archive Entries

When a volume contains a very large number of entries, you can apply a filter to 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 596.

This displays the Filter Entries dialog. This dialog lets you filter the entries list based archive type (Manual or Scheduled), archive group, and archive group description.

2. Enter the filtering criteria. You may use one, two, or all three criteria. Figure 597 shows a filter for Scheduled archives for the group named IMlog1.

3. Click OK when you are done. The result for this filter is shown in Figure 598.

Reset Filter restores all archive entries to the list.

Figure 596. Set Filter for Entries List

Leading and trailing wildcard characters are present by default (but not shown). Do not enter wildcard characters in this dialog.

Set Filterfor Entries List

3BUF001094R4101 705

Restoring Logs from Archive Media to Restored Database Section 8 Reading and Managing

Figure 597. Filter/Search Archives Tab

Figure 598. Entry Filter Result

706 3BUF001094R4101

Section 8 Reading and Managing Archive Data Restoring Logs from Archive Media to Restored

Filtering Logs

When you select an archive entry, the log list initially displays all logs for the selected archive entry. You can 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 599.

This displays the Filter Logs dialog. This dialog lets you 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. You may use one or both criteria. Figure 600 show a a filter for Numeric logs whose name contains the string HSSIN.

3. Click OK when you are done. The result for this filter is shown in Figure 600.

Reset Filter restores all logs to the list.

Figure 599. Set Filter for Entries List

Leading and trailing wildcard characters are present by default (but not shown). Do not enter wildcard characters in this dialog.

Set Filterfor Log List

3BUF001094R4101 707

Restoring Logs from Archive Media to Restored Database Section 8 Reading and Managing

Figure 600. Log Filter Dialog

Figure 601. Log Filter Result

708 3BUF001094R4101

Section 8 Reading and Managing Archive Data Accessing Restored Logs

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

Deleting Restored LogsYou can delete logs from the restored portion of the History database via the View Logs (or View Report Logs) window. (To delete restored PDLs and tasks, see Deleting Restored PDLs and Tasks on page 710.)

To delete restored message, or report logs:

1. Retrieve the log information to select the specific logs that you want to delete. The basic procedure is described in Retrieving Log Information on page 682.

Restored logs must be retrieved by location. Also, for Log Class, select Restored.

2. Select the logs that you want to delete from the retrieved log list.

The retrieved log list may too large to manage.You can 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.

3BUF001094R4101 709

Deleting Restored Logs Section 8 Reading and Managing Archive Data

Deleting Restored PDLs and Tasks

When you delete a PDL, all batch, unit procedure, and phase tasks under that PDL are deleted and the object is deleted from History. When you delete a batch task, 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 you are configuring history (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. See Manually Archiving PDLs on page 690 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 confirmation 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 you want to delete. You can only select one PDL.

2. Select one or more batch tasks to delete.

3. Go to the Delete tab and click Delete Runtime Tasks. This displays a confirmation message.

4. Click on Yes to confirm or No to cancel.

710 3BUF001094R4101

Section 8 Reading and Managing Archive Data Miscellaneous Archive Operations

Miscellaneous Archive OperationsThis section covers:

• Listing Group Items on page 711

• Resetting the Last Archive Time for an Archive Group on page 712

• Showing Volume Information on page 712

• Showing Platform Information for a Log on page 713

Listing Group ItemsWhen you select an Archive Group 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 lets you determine the exact content of an archive group. An example is shown in Figure 602. 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 602. Archive Group Item List

3BUF001094R4101 711

Resetting the Last Archive Time for an Archive Group Section 8 Reading and Managing Archive

Resetting the Last Archive Time for an Archive GroupThe 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. You may want 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, or skip ahead to a later time, for example when you do not wish to archive the data collected for a certain time period.

This is done via the Archive Group aspect. Select the group, click Actions and choose Reset Last Archive Time (or use the context menu).

Showing Volume InformationThis function shows you information for a selected volume, Figure 603. 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 603. Volume Information

712 3BUF001094R4101

Section 8 Reading and Managing Archive Data Showing Platform Information for a Log

Showing Platform Information for a LogPlatform information is applicable for property (numeric) logs. This function shows you information for a selected log within an archive entry, Figure 604. This information is described in Table 46. The Platform information dialog also lists the aspects for each log. This lets you display the log configuration aspect’s view directly from this dialog. This can be used to verify that the logs have been published.

The function is available on the archive volume aspect. To use this function (reference Figure 605):

1. Select the archive volume aspect.

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

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.

Figure 604. Platform Information

Aspect Listfor selectedlog

3BUF001094R4101 713

Showing Platform Information for a Log Section 8 Reading and Managing Archive Data

Figure 605. Showing Platform Information

Table 46. 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

Select an entry

Then select one or morelogs

714 3BUF001094R4101

Section 8 Reading and Managing Archive Data Importing Archive Data

Importing Archive DataThe Archive Import tool lets you import archived historical data from earlier historian platforms, and from other 800xA systems. This lets you:

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

For a brief description of the Archive Import tool refer to the Overview on page 716. For instructions on using the tool see Step-by-Step Instructions on page 719.

You should have a good working knowledge of property log configuration, and archiving in the 800xA system before using this tool. For further information on these topics, refer to 800xA Information Management Configuration.

3BUF001094R4101 715

Overview Section 8 Reading and Managing Archive Data

OverviewThe Archive Import tool is accessible via the Config view on an Archive Volume aspect. This tool is based on an Excel workbook with embedded buttons and functions designed specifically for importing archives from other platforms, Figure 606.

The Process

You 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. Next you select one or more archive groups that have entries on the volume. This lets you limit the number of logs that will be imported in one session. Microsoft Excel limits this number to 65,000. If the volume has more that 65,000 logs, you will be required to import them in two or more sessions.

The archive import tool creates new log configuration aspects to hold the imported archive data. If your system has objects where these new log configuration aspects can be added, you may use those objects. 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.

Figure 606. Workbook for Archive Import

716 3BUF001094R4101

Section 8 Reading and Managing Archive Data Overview

The Workbook

The workbook has three sheets. The first sheet shown in Figure 606 is named Log List. The top of this sheet contains a row of command buttons arranged so that you can proceed with the import operation in stepwise fashion from left to right, Figure 607. The two rows below the buttons provide feedback for the button commands.

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 608. 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. You can modify certain parameters on this sheet if necessary, for example, log names and log template names.

Figure 607. Command Buttons and Feedback Rows

Figure 608. Log Templates Sheet

CommandButtons

FeedbackRows

Color-coded Column Headings

3BUF001094R4101 717

Overview Section 8 Reading and Managing Archive Data

The third sheet is named Messages, Figure 609. This sheet provides more detailed feedback, status and error reporting. If something unexpected happens, this sheet may tell you why. Each message is time stamped, and operations which may take time include a time duration report. This will help you to anticipate how long certain operations may take with your particular combination of archives, media and hardware.

Figure 609. Messages Sheet

718 3BUF001094R4101

Section 8 Reading and Managing Archive Data Step-by-Step Instructions

Step-by-Step InstructionsThe procedure for importing an archive involves eight basic steps. Detailed instructions 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.

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 existing objects.

6. Create log templates from which to instantiate the new log configurations.

7. Create the log configuration aspects.

8. Update the aspect reference information.

Starting the Archive Import Tool

Before you start the archive import tool, the archive data that you intend to import must reside on a readable media, and that media must have a dedicated archive volume aspect to let you 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. If you need to configure a new archive volume aspect, refer to 800xA Information Management Configuration.

When you save the Excel workbook, the file name defaults to the volume label. Do not change this name. This is how the system finds the correct file if you need to re-open it.

3BUF001094R4101 719

Step-by-Step Instructions Section 8 Reading and Managing Archive Data

To select an archive volume and start the archive import tool (Reference Figure 610):

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 610 the Archive Volume object for Drive F is selected.

2. Select the Archive Volume aspect from the object’s aspect list.

3. Use the View selector to change the view to Config View. This displays a dialog that lets you start a new workbook or open an existing workbook. Continue with this dialog as described in Generating an Aspect Reference Data Source on page 721.

Figure 610. Starting the Archive Import Tool

SelectedVolume

Archive Volume AspectSelecting theConfig View

720 3BUF001094R4101

Section 8 Reading and Managing Archive Data Step-by-Step Instructions

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 you import archive data 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 information. 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 even exist. Therefore, to successfully import archives from these systems, you must generate a new reference file that will relate the archive data to the correct objects on the target system.

Use the dialog in Figure 611 to begin this process.

The Service Group and Volume Path default to the values corresponding to the Archive Volume you selected in the previous step. Use these defaults.

To create a new Aspect Reference Data Source file, select the User Generated radio button, then click New as shown below.

Figure 611. Aspect Reference Data Source Set-up Dialog

3BUF001094R4101 721

Step-by-Step Instructions Section 8 Reading and Managing Archive Data

This opens a new workbook. The system and archive volume path specifications are already defined, Figure 612. Therefore, you are not required to use the first two command buttons corresponding to those steps. Start with the third button for Setting the Archive Group Filter.

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 performed, another entry is generated. There may be hundreds of archive entries in your directory, but typically they represent relatively few distinct groups.

You must select one or more groups (and/or manual archive instances) on the Archive Volume whose archive files will be imported. To do this, click Set Archive Group Filter, Figure 613.

Figure 612. Initial Workbook View

Figure 613. Set Archive Group Filter Button

system and archivepaths defined

722 3BUF001094R4101

Section 8 Reading and Managing Archive Data Step-by-Step Instructions

This displays the Choose Groups dialog, Figure 614.

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.

Figure 614. Set Archive Group Filter Dialog

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 that Groups Archives 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 to help you.

3BUF001094R4101 723

Step-by-Step Instructions Section 8 Reading and Managing Archive Data

Select one or more groups. Hold down the CONTROL key to select multiple groups or to deselect already selected Groups. Selecting no groups is equivalent to selecting all groups. Click OK once you’ve made your selections.

The selected Group names will be indicated in the report area under Archive Group Filter. Each name will be separated by the character (:), Figure 615. Log 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 616.

Loading Data From Archive Volume

This step loads the data for the selected archive groups. To do this, click Load Data From Archive Volume, Figure 617.

Figure 615. Set Archive Group Filter

If an archive has more than 65,000 unique logs, you will be required to perform the archive in parts, where each part is no more than 65,000 logs. This is a limitation of Excel. For further guidelines, refer to Importing an Archive With More Than 65,000 Logs on page 742.

Figure 616. Example Set Archive Group Filter Message

Figure 617. Load Data From Archive Volume Button

724 3BUF001094R4101

Section 8 Reading and Managing Archive Data Step-by-Step Instructions

This displays a progress bar and a Start button, Figure 618.

Selecting the Start button will initiate a read of Archive information which cannot be interrupted. The time to read this information 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. The progress bar will appear as shown in Figure 619

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. An example is shown in Figure 620.

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.

Figure 618. Starting the Load Data Process

Figure 619. Loading

Figure 620. Template Sheet Results

3BUF001094R4101 725

Step-by-Step Instructions Section 8 Reading and Managing Archive Data

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

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.

Once the Log rows have been created, duplicate rows are purged automatically. Duplicate rows will occur if you choose to read in the same log information more than once, or if 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.

Figure 621. Load Data Result on Log List Sheet

Logs/Templates Feedback

References template rowon Sheet 2 - Log Templates

726 3BUF001094R4101

Section 8 Reading and Managing Archive Data Step-by-Step Instructions

As a result of this operation, a message will be created on the Message sheet (sheet 3). An example is shown in Figure 622.

At this point, the workbook has rows representing archived logs on Sheet 1. You may filter these rows if desired to process only a subset of logs. The remaining buttons will operate only on the rows you leave unfiltered (visible).

Each header column on the Log List sheet already has an Excel Filter defined, Figure 623. Filtering on multiple columns, especially using the built in Custom filtering feature, is an effective way to isolate a set of log rows you wish to process identically.

After executing the Load Data From Archived Volume command, the results may be modified. For example, you can modify object names. For details, see Overriding The Defaults on page 739.

Figure 622. Example Load Archive Data From Volume Message

Figure 623. Filtering

3BUF001094R4101 727

Step-by-Step Instructions Section 8 Reading and Managing Archive Data

Creating Objects for the Archive Log Configurations

This step creates (or specifies) the objects where the log configurations will be instantiated. Just as property logs are instantiated by adding log configuration aspects to the objects whose properties are being logged, each archive log configuration must belong to an object in the system. You may choose to create new objects specifically for this purpose, or associate the log configurations with existing objects.

Generally you create new objects when you are importing the archive data for the first time. The objects you create are simply placeholders for the log configuration aspects. For details, see Creating New Objects on page 729.

If you are re-importing archive data for objects whose archive data has been previously imported, then choose to match existing objects. To do this, see Match Existing Objects on page 731.

728 3BUF001094R4101

Section 8 Reading and Managing Archive Data Step-by-Step Instructions

Creating New Objects

If you need to create dummy (placeholder) objects where the new log configurations can be instantiated, use the Create New Objects option. To create new objects, click Create New Objects, Figure 624.

This displays an Object Browser for selecting a single parent (root) object in the 800xA System, Figure 625. The default parent object is based on the volume name. You may select another object.

When you select a parent object, 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.

Figure 624. Create New Objects Button

Figure 625. Object Browser

3BUF001094R4101 729

Step-by-Step Instructions Section 8 Reading and Managing Archive Data

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 information 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. Otherwise, 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 626.

Figure 626. Example Create New Objects Message

730 3BUF001094R4101

Section 8 Reading and Managing Archive Data Step-by-Step Instructions

Match Existing Objects

If your system already has objects where the new log configurations can be instantiated, use the match Existing Objects option. To match existing objects, click Match Existing Objects, Figure 627.

This displays an Object Browser for selecting a set (one or more) of parent (root) objects in the 800xA System, Figure 628. These parent objects must have been previously created in the 800xA System.

Figure 627. Match Existing Objects Button

Figure 628. Object Browser for Matching Existing Objects

3BUF001094R4101 731

Step-by-Step Instructions Section 8 Reading and Managing Archive Data

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 you are finished adding Parent Objects.

Cancel at anytime by closing the window.

When you have completed selecting parent objects, the tool creates an internal list of all objects which 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 which 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.

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.

Typical Message Sheet entry:

In the current Archive Import Tool session, if you have previously specified a set of root objects 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.

Time Message Delta Time

4/6/20044:38:13 PM

MatchExistingObjectsMatched/Attempted/#RootObjects9000 / 9000 / 1

1m 41.7s

732 3BUF001094R4101

Section 8 Reading and Managing Archive Data Step-by-Step Instructions

Creating Archive Log Templates

This step creates the log templates from which all archive log configurations will be instantiated. To start, click Create Archive Log Templates, Figure 629.

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 630. You may select a different parent object.

Figure 629. Create Archive Log Templates Button

Figure 630. Object Browser for Creating Archive Log Templates

3BUF001094R4101 733

Step-by-Step Instructions Section 8 Reading and Managing Archive Data

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 3). An example is shown in Figure 631.

Creating Archived Logs

This step instantiates log configurations for the logs defined in the log list. To begin this process, click Create Archived Logs, Figure 632.

This displays a progress bar. Selecting Start initiates the Create Archived Logs process. Clicking on the Stop button will terminate it.

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

Figure 631. Example Create Archive Log templates Message

Figure 632. Create Archived Logs Button

734 3BUF001094R4101

Section 8 Reading and Managing Archive Data Step-by-Step Instructions

template indicated by the information (names and GUIDs) stored for that row in the workbook.

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.

A record of successes and attempts is kept in the report cell beneath the Create Archived Logs command button.

As a result of this operation, a message will be created on the Message sheet (sheet 3). An example is shown in Figure 633.

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.

To update the reference file click Create/Update New Aspect Reference File, Figure 634.

This displays a progress bar, prompting you to select the Start button to begin the process of creating or updating a new file. The file path is indicated under the Specify a New Aspect Reference Data File button.

Figure 633. Example Create Logs Message

Skip the Specify New Aspect Reference Data File step, since this information is already specified and should not be changed.

Figure 634. Specify New Aspect Reference Data File

3BUF001094R4101 735

Step-by-Step Instructions Section 8 Reading and Managing Archive Data

When you 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. When you are prompted to continue building the file, click OK, Figure 635.

The tool creates or locates the specified new AIP_INFO file. 800xA information for each Log in the workbook is written to new file, using information stored in the workbook. If an AIP_INFO file was included in the original Archive Volume, 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/Update New AIP_INFO File button, Figure 636.

When the operation is complete, acknowledge the prompt by clicking OK, Figure 637.

Figure 635. Prompt to Continue Building the File

Figure 636. Record of Successes

Figure 637. Operation Complete Message

736 3BUF001094R4101

Section 8 Reading and Managing Archive Data Step-by-Step Instructions

Once the AIP_INFO file is created, you must apply the changes by clicking Apply on the Archive volume config view, Figure 638.

When you are prompted to update the server’s version with the local copy, click Yes, Figure 639.

This will copy the new file to the correct location and set the user available flag to TRUE (represented in Archive volume information).

Figure 638. Applying the Changes

Figure 639. Updating the Server’s Version with the Local Copy

3BUF001094R4101 737

Step-by-Step Instructions Section 8 Reading and Managing Archive Data

Viewing the Imported Archive Data

To view the imported archive data, you must publish the volume. Use the Main view of the Archive Volume aspect as shown in Figure 640.

Once the volume has been published, you may view the archive data. Figure 641 illustrates using the Status tab on the log configuration aspect.

Figure 640. Publishing

Figure 641. Viewing Imported Archive Data

738 3BUF001094R4101

Section 8 Reading and Managing Archive Data Step-by-Step Instructions

Overriding The Defaults

After executing the Load Data From Archived Volume command, the results may be modified as follows (Figure 642):

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 # entries on the Log List sheet may be modified to point to user defined Log Templates on the second sheet.

If you choose to create new entries on the second sheet, you should retarget the Template Row # of any Logs on the first sheet that you wish to use the new Template.

Template Name Aggregate (Calculation)

Storage Rate Log Name

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

Do not sort or rearrange the rows on the second sheet, unless you also take care to retarget the Template Row #s of all the Logs on the first sheet that reference Templates that have new row numbers.

3BUF001094R4101 739

Step-by-Step Instructions Section 8 Reading and Managing Archive Data

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 which incorporate the line number on the worksheet of the Log as it was loaded, just to have unique Object Names.

If you have a better way to construct Object and Property Names from Archive Log Names and Data Sources, you might want to create an Excel formula and fill the Object Name and Property Name cells with it (Table 47).

Figure 642. Excel Template Row

Table 47. Excel Spreadsheet Example Columns

Object Name Property Name Data Type

H050B000J-000500 Measure Float (32-bit)

H050B000J-000500 Measure2 Float (32-bit)

H050B000J-000500 Measure2 Float (32-bit)

H050B000J-000500 Measure Float (32-bit)

740 3BUF001094R4101

Section 8 Reading and Managing Archive Data Step-by-Step Instructions

For example, if your Log Names look like:

$HSH050B000J-000500,MEASURE-1-o

Then in column F9 you could enter:

=MID(A9,4,SEARCH(",",A9,5)-4)

And in column G9 you could 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 your log names look like:

$HSpvAC1DigSec1:AC1DIGSEC1_100.VALUE:IM_4d-1-o

Then you might use:

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

These are examples the workbook already knows about, but the general idea should be clear.

H050B000J-000501 Measure Float (32-bit)

H050B000J-000501 Measure2 Float (32-bit)

H050B000J-000501 Measure2 Float (32-bit)

H050B000J-000501 Measure Float (32-bit)

Table 47. Excel Spreadsheet Example Columns (Continued)

Object Name Property Name Data Type

3BUF001094R4101 741

Importing an Archive With More Than 65,000 Logs Section 8 Reading and Managing Archive Data

4. The Data Type may be modified.

Since Data Type information is not stored in the Archive, all Data Types are defaulted as Float. You may right click on a cell in the Data Type column to access a Data Type choice list.

Leverage your Filtering and Data Fill (Fill Down) skills to get the Data Types the way you want them (Table 47).

Importing an Archive With More Than 65,000 LogsMicrosoft Excel spreadsheets have a limit of 65,000 rows. Therefore, you cannot import more than 65,000 logs in one session. To import an archive with more than 65,000 logs, break up the import into two or more sessions where each session imports no more than 65,000 logs. When you start the second and subsequent sessions, be sure to create a new workbook (by selecting User Generated and clicking New in the Config view of the Archive Volume aspect, Figure 611). When you update the Aspect Reference file (Creating/Updating New AIP INFO File on page 735), the new logs will be added to the existing logs from previous sessions.

Modifying a WorkbookTo re-open a saved workbook, select the archive volume aspect as described in Starting the Archive Import Tool on page 719, then select User Generated and click Modify in the Aspect Reference File Set-up dialog.

742 3BUF001094R4101

Section 9 Reading Message Logs

When your system is equipped with the Information Management History Server function, and you have configured the IMMSGLOG as described in the Alarm/Event Logging section in the Information Management Configuration book, all system alarm/event messages will be forwarded to the IMMSGLOG. The messages can be read via interactive dialogs in DataDirect and Desktop Trends. You can also access the data using SQL queries. This section provides guidelines for using SQL queries to read messages from this log.

Message Log TablesOPC 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 via SQL queries.

The relationship between the three Oracle tables for storing OPC message information is illustrated in Figure 643.

One MSGLOG table is created for each message log that you configure. Each message occurrence 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 described in Table 48.

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

Vendor-specific attribute names are defined in the MSGVENDORS table, Table 50. There is one such table on each Information Management server where the message

3BUF001094R4101 743

Section 9 Reading Message Logs

logs reside. The attribute names in this table are associated with their corresponding attributes in the MSGATTRS table by an Attribute ID.

Attribute names for Batch Management are described in Table 51.

Attribute names for Audit Trail messages are described in Table 52.

744 3BUF001094R4101

Section 9 Reading Message Logs

Figure 643. Relationship Between Oracle Tables for Storing OPC Message Information

IDX LOCALTIME MESSAGE ETC...

17

18

1920

MSGLOG

IDX ATTRIDVALUE ETC...

17

17

1718

MSGATTRS

19

19

1920

4

5

6

4

4

5

6

6

ATTRIDETC...

4

5

67

MSGVENDORS

ATTRNAME

3BUF001094R4101 745

Section 9 Reading Message Logs

Table 48. MSGLOG

Field Name Type Description

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.

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(255) 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 (see 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

746 3BUF001094R4101

Section 9 Reading Message Logs

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 49. MSGATTRS

Field Name Type Description

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

MONTH Number Used internally to partition Oracle tables for better performance

ATTR_ID Number Unique identifier for this vendor specific attribute (generated internally in history)

NBR_VALUE(1)

(1) Only one of these columns will contain data, depending on the data type specified in the MSGVENDORS Table

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

Table 48. MSGLOG

Field Name Type Description

3BUF001094R4101 747

Section 9 Reading Message Logs

Table 50. MSGVENDORS

Field Name Type Description

VENDOR_NAME Varchar2(32) Name of the Vendor

CATEGORY Number OPC Event Category for this Vendor

ATTR_NAME Varchar2(32) Vendor specific attribute name. See Table 51.

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 51. 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 52. Audit Trail Attribute Names

Field Name Type Description

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.

748 3BUF001094R4101

Section 9 Reading Message Logs

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

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

Table 52. Audit Trail Attribute Names

Field Name Type Description

3BUF001094R4101 749

Example Queries Section 9 Reading Message Logs

Example QueriesAny 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 you want to retrieve.

Then you can use the table name in a second query that specifies attribute names, time ranges, or any other criteria.

Query for MSGLOG Table Name for PDL Message Logs

select o.object_name,m.table_name from object_table o,log_map_table m, numeric_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.

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

750 3BUF001094R4101

Section 9 Reading Message Logs Example Queries

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

ORDER BY 3, 4

3BUF001094R4101 751

Example Queries Section 9 Reading Message Logs

752 3BUF001094R4101

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.

The following topics are covered:

• ODA for Real-time Data on page 753

• ODA for Historical Data Access on page 763

• Accessing ODA Programmatically using ADO on page 800

ODA for Real-time DataOpen 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 lets you access properties in untyped objects, or objects to which extra

ODA does not support the concept of transactions, commits, or rollbacks. The following statements specifically CANNOT be used:

BEGIN TRANSACTION COMMIT TRANSACTION ROLLBACK TRANSACTION

An OPC 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 Section 7, Browsing for OPC Tags.

3BUF001094R4101 753

ODA for Real-time Data Appendix A Using Open Data Access

aspects or properties have been added, without having to create a table definition for each such object.

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 that you have configured. Also, for security reasons, the generic_DA table is read-only; configured tables must be used in order to modify any property values.

Instructions for configuring Open Data Access are provided in the section on Open Data Access in Industrial IT 800xA - Information Management Configuration.

754 3BUF001094R4101

Appendix A Using Open Data Access Guidelines for Using Custom Database Tables

Guidelines for Using Custom Database TablesThe 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.

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, you can use "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.

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

3BUF001094R4101 755

Sample Queries for Custom Database Tables Appendix A Using Open Data Access

Sample Queries for Custom Database TablesThese 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'

SELECT value FROM ai WHERE path=’[direct]Root/MyProgram/AI1’

SELECT value FROM ai WHERE id=’{E8A75B02-E95E-4943-999D-2C4E266CE17C}’

To get one property from all objects of the type

SELECT value FROM ai

To get one property from several objects of the same type

SELECT value FROM ai 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

756 3BUF001094R4101

Appendix A Using Open Data Access Sample Queries for Custom Database Tables

To get all configured properties from one object

SELECT * FROM ai WHERE name=’ai1’

SELECT * FROM ai WHERE id=’{E8A75B02-E95E-4943-999D-2C4E266CE17C}’

To get all configured properties from all objects of the type, and sort them alphabetically

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 instances 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’

3BUF001094R4101 757

Guidelines for Using the Generic_DA Table Appendix A Using Open Data Access

Guidelines for Using the Generic_DA TableThe contents of the generic_DA table are described in Table 53. 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 53).

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], 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 value is presented as a Variant for OLE DB applications. 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 example, a real value 1.23 will appear in the three data types as 1.23, 1, and "1.23" respectively, 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 converted 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 760.

758 3BUF001094R4101

Appendix A Using Open Data Access Guidelines for Using the Generic_DA Table

Table 53. Generic_DA Table

PK(1) Field ODBC Type OLE DB Type Description

X Name SQL_VARCHAR DBTYPE_STR Name of the object.

X ID SQL_VARCHAR DBTYPE_STR ID (Guid) of the object.

X Path SQL_VARCHAR DBTYPE_STR 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 DBTYPE_STR Type of the object.

X Property SQL_VARCHAR DBTYPE_STR 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 DBTYPE_STR Description of the object (object attribute ":DESCRIPTION").

HierName SQL_VARCHAR DBTYPE_STR Hierarchical name of the object (object attribute ":HIERNAME").

Parent SQL_VARCHAR DBTYPE_STR ID of the object's parent (object attribute ":PARENT").

Domain SQL_VARCHAR DBTYPE_STR Domain of the object (object attribute ":DOMAIN").

ARD SQL_VARCHAR DBTYPE_STR Absolute Reference Designation of the object (object attribute ":ARD").

Value n/a DBTYPE_ VARIANT

Value of property as variant.

Value_Flt SQL_FLOAT DBTYPE_R8 Value of property as float.

Value_Int SQL_INTEGER DBTYPE_I4 Value of property as integer.

3BUF001094R4101 759

Sample Queries for Generic_DA Appendix A Using Open Data Access

Sample Queries for Generic_DA

General Guidelines

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

Value_Str SQL_VARCHAR DBTYPE_STR Value of property as string.

Value_Type SQL_VARCHAR DBTYPE_STR Data type of property: string "FLOAT", "INTEGER", or "VARCHAR".

Value_Qual SQL_INTEGER DBTYPE_I4 Data quality of property.

Value_Time SQL_ TIMESTAMP

DBTYPE_ DBTIMESTAMP

Time when property was last changed.

(1) Any query against this table must use one of the marked Primary Keys.

Table 53. Generic_DA Table

PK(1) Field ODBC Type OLE DB Type Description

760 3BUF001094R4101

Appendix A Using Open Data Access Sample Queries for Generic_DA

To get one property from one object

SELECT value FROM generic_da WHERE path='/My Objects/Object 1' AND property='GENERAL PROPERTIES:PROPERTY1' NOTE: This is an incomplete path.

SELECT value FROM generic_da WHERE path='[Direct]Root/My Objects/Object 1' AND property='GENERAL PROPERTIES:PROPERTY1' NOTE[direct] ensures that the path is complete)

SELECT value FROM generic_da WHERE name=' Object 1' AND property='GENERAL PROPERTIES:PROPERTY1'

SELECT value FROM generic_da WHERE id='{E8A75B02-E95E-4943-999D-2C4E266CE17C}' AND property='GENERAL PROPERTIES:PROPERTY1'

SELECT value FROM generic_da WHERE name=' Object 1' 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' AND property='GENERAL PROPERTIES:PROPERTY1'

To get value of all properties from one object

SELECT property, value FROM generic_da WHERE path='/My Objects/Object 1'

SELECT property, value FROM generic_da WHERE name=' Object 1'

SELECT property, value FROM generic_da WHERE id='{E8A75B02-E95E-4943-999D-2C4E266CE17C}'

3BUF001094R4101 761

Sample Queries for Generic_DA Appendix A Using Open Data Access

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' 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'

762 3BUF001094R4101

Appendix A Using Open Data Access ODA for Historical Data Access

ODA for Historical Data AccessCOM-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 54.

Table 54. NumericLog Table

Field String(1)

(1) Any field designated as String data must be entered in single quotes.

Description

LOGNAME X Access name or log name for the numeric log. Use the OPC browser as described in Section 7, Browsing for OPC Tags.

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.

DATAVALUE Value of data.

QUALITY Data quality code. These codes are based on OPC Data Quality constants. See Table 55.

3BUF001094R4101 763

SQL Query Structure Appendix A Using Open Data Access

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 documentation to learn how to write and execute queries in your client application. You can use the example queries in this section as the basis for queries in your own reports.

Following this section as refer to Query Guidelines on page 766, and Example Queries on page 768.

Basics

ODA supports the SELECT statement including all its clauses (INTO, FROM, WHERE, GROUP BY, HAVING, and ORDER BY).

Table 55. 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 you add 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)

764 3BUF001094R4101

Appendix A Using Open Data Access SQL Query Structure

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'

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.

SQL queries are not case-sensitive, except for text in single quotes. You can write SQL keywords (for example select) in uppercase or lowercase. The same is true for table and attribute names. Object (log) names must be entered exactly as they were configured.

3BUF001094R4101 765

Query Guidelines Appendix A Using Open Data Access

The ORDER BY Clause

The ORDER BY clause determines the order in which instances are returned. If you do not specify an order, the order is determined by an internal criterion. If you specify ORDER BY attribute, instances are returned in ascending order. You can specify that instances be returned in descending order by entering DESC after the attribute. For instance:

ORDER BY DataValue DESC

Query GuidelinesNumeric 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:

Review the guidelines in this section, and then refer to the example queries shown in:

• Basic Query for Numeric Data on page 768

• Query for Numeric Data from a Secondary Log on page 769

• Query for a Specific Time Range on page 769

• Query for Interpolative Data on page 770

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

766 3BUF001094R4101

Appendix A Using Open Data Access Specifying the Log in a Query

Specifying the Log in a QueryFor 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.

Aggregate

You can request either raw or interpolative data. 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:

The IMHDA aggregates are:

INTERPOLATIVE OPCHDA_TIMEAVERAGE OPCHDA_MINIMUM OPCHDA_MAXIMUM Raw

SELECT AGGREGATE FROM NUMERICLOG

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 aggregate lists for AIPHDA and IMHDA are subject to change. You may obtain a definitive list of aggregates currently supported on your system by executing the following query:

3BUF001094R4101 767

Example Queries Appendix A Using Open Data Access

Intervals

When the retrieval type is interpolated, the intervals variable establishes the time interval between data values. The default interpolation interval is 1 second. You can 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.

Time Range

You are not required to enter a time range in the query; however, it is recommended. If you do specify a complete time range (with start and end time), all data occurring within that time range will be returned.

If you do not specify a time range, or if you specify an open-ended time range (just start time, or just end time), 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 representing nanoseconds.

Example QueriesThe examples below are applicable for the AIPHDA server. Additional considerations for the IMHDA server are described in IMHDA Access on page 772.

Basic Query for Numeric DataThis 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.

In the following queries SQL keywords are shown in UPPERCASE for emphasis, however, they can also be written in lowercase.

768 3BUF001094R4101

Appendix A Using Open Data Access Query for Numeric Data from a Secondary Log

Query:

SELECT LogName, Timestamp, DataValue, Quality FROM NumericLog WHERE LogName = ‘TC100:MEASURE,Log1’

Query for Numeric Data from a Secondary LogWhen you query for a secondary log, it is recommended that you use the full log name when you know it. This way you are sure to access the intended log. If you use just the access name, the seamless retrieval function will select the log based on the seamless retrieval criteria as described in Criteria for Selection for Seamless Retrieval on page 53.

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 WHERE LogName = ‘TC100:MEASURE,Log3’

Query for a Specific Time RangeThis 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 WHERE LogName = ‘TC100:MEASURE,Log1’ AND Timestamp >=‘2001-02-15 13:34:00’ AND Timestamp <= ‘2001-02-15 13:37:00’

3BUF001094R4101 769

Query for Interpolative Data Appendix A Using Open Data Access

Query for Interpolative DataAn interpolation feature of the NumericLog view lets you 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 you must specify the Aggregate and Intervals in the where clause.

Query

SELECT Timestamp, DataValue FROM NumericLog WHERE LogName = ‘tc100:value,Log1’ AND Aggregate = ‘interpolative‘ AND Intervals = 60 AND Timestamp >=‘2001-02-15 8:00:00’ AND Timestamp <= ‘2001-02-15 20:00:00’

770 3BUF001094R4101

Appendix A Using Open Data Access UPDATE and INSERT Functions

UPDATE and INSERT FunctionsUpdates 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 lets you 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 774.

Insert Query Examples:

The code for good data quality is hexadecimal C0. To insert a bad data quality, use the hexadecimal code 00, or any value other than C0.

If you do not specify any data quality code, the data quality will be set to good by default.

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, C0)

Example - Bad Data Quality:

INSERT INTO NumericLog (Logname, Timestamp, DataValue, Quality) VALUES ('TC100:MEASURE,Log1', '2002-04-10 13:34:00', 123.45, 00)

Update Query Example:

UPDATE NumericLog SET DATAVALUE=123.4 WHERE Logname='TC100:MEASURE,Log1' and Timestamp='2002-04-10 13:34:00'

3BUF001094R4101 771

IMHDA Access Appendix A Using Open Data Access

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 you to use a different prefix which determines which provider is used as the data connection for accessing data. The prefixes are LOGMAN, EH_NET and EH.

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 lets you use access name. Use this method when you do not know or care 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'

These methods are only applicable for queries against the NumericLog table.

This method does not support UPDATE or INSERT statements in SQL queries.

772 3BUF001094R4101

Appendix A Using Open Data Access IMHDA Access

EH

EH communicates with the local History server only. This is the fastest method and is recommended if you are querying a log that resides on the local History server. You must use the log name in conjunction with this prefix.

Example:

'EH.$HSTC100,MEASURE-1-o'

EH_NET

EH_NET connects directly to a specified History server. This requires you to specify the node name or IP address. Use this method when you want to query a log on a specific History server. For example, you may want to use this when your system uses duplicate log names.

You must use the log name 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 UPDATE statements in SQL queries. It does not support INSERT statements.

This method supports both UPDATE and INSERT statements in SQL queries.

3BUF001094R4101 773

IMHDA Access Appendix A Using Open Data Access

Using UPDATE and INSERT with the IMHDA Server

When using the IMHDA server, Insert statements require you to use the EH_NET provider. See EH_NET on page 773.

Update statements are supported by both EH_NET and EH providers.

Insert Query Examples:

The code for good data quality is hexadecimal C0. To insert a bad data quality, use the hexadecimal code 00, or any value other than C0.

If you do not specify any data quality code, the data quality will be set to good by default.

Examples - Good Data Quality:

INSERT INTO NumericLog (Logname, Timestamp, DataValue) VALUES ('EH_NET.eng130.$HSTC100,MEASURE-1-o', '2002-04-10 13:34:00', 123.45)

INSERT INTO NumericLog (Logname, Timestamp, DataValue, Quality) VALUES ('EH_NET.eng130.$HSTC100,MEASURE-1-o', '2002-04-10 13:34:00', 123.45, C0)

Example - Bad Data Quality:

INSERT INTO NumericLog (Logname, Timestamp, DataValue, Quality) VALUES ('EH_NET.eng130.$HSTC100,MEASURE-1-o', '2002-04-10 13:34:00', 123.45, 00)

Update Query Example:

UPDATE NumericLog SET DATAVALUE=123.4 WHERE Logname='EH.$HSTC100,MEASURE-1-o' and Timestamp='2002-04-10 13:34:00'

774 3BUF001094R4101

Appendix A Using Open Data Access ODA for Profile Data Access

ODA for Profile Data AccessHistory profiles are used to monitor critical quality measurements in flat-sheet manufacturing 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 56 - ProfileLog Table - This table supports access to the profile data which is common to all data boxes for a given scan array.

• Table 57 - 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 56. ProfileLog Table

Field String(1) Description

LOGNAME X Log name for the profile log (full log name required).

TIMESTAMP Timestamp in local time. Must conform to ANSI SQL 92 spec.

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.

3BUF001094R4101 775

ODA for Profile Data Access Appendix A Using Open Data Access

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 ValueBitset = 63 (decimal) indicates all values present Bitset = 0 indicates no values present

(1) Any field designated as String data must be entered in single quotes.

Table 57. ProfileLogData Table

Field String(1)

(1) Any field designated as String data must be entered in single quotes.

Description

LOGNAME X Log name for the profile log (full log name required)

TIMESTAMP Timestamp in local time. Must conform to ANSI SQL 92 spec.

DATABOX The index of the Data Values.

DATAVALUE Value of Data.

QUALITY Data quality code. See Table 55.

Table 56. ProfileLog Table

Field String(1) Description

776 3BUF001094R4101

Appendix A Using Open Data Access Profile Historian Example

Profile Historian ExampleWhen 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.

Comparing Data Box Indices for AC450 and QCS

Queries

This query returns the valid range of indices for data boxes, as well as other information 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

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.

System FirstBox LastBox Description

AC450 45 565 These indices are correctly aligned.

QCS 46 566 These indices are offset by one.

3BUF001094R4101 777

Connecting Client Applications to an ODA Database Appendix A Using Open Data Access

Connecting Client Applications to an ODA DatabaseThe following tutorials demonstrate how to connect a client application to an ODA database and access data:

• Using Crystal Reports on page 778

• Using Excel Without DataDirect Add-ins on page 790

Using Crystal ReportsIn order for the reports you create with Crystal Reports 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 supports access via the predefined numericlog (history) and generic_da (real-time) tables.

You can change the default set up for DATABASE1 and/or create additional ODA databases. For instructions on configuring ODA, refer to the section on Open Data Access in the section on Open Data Access in Industrial IT 800xA - Information Management Configuration.

The reports may be connected to a selected ODA database either via an OBDC data source, or the ABBOpenDataAccess OLE DB provider. It is generally easier to use an ODBC data source. This method is demonstrated in this section.

You must establish this connection for each new report that you create, or if you want 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 you are creating a new report, or opening an existing one. The only difference is how you access the Data Explorer.

778 3BUF001094R4101

Appendix A Using Open Data Access Using Crystal Reports

Accessing the Data Explorer

When you create a new report in Crystal Reports, you can either create the new report as a blank report, or use the Report Expert.

If you are using the Report Expert, the first dialog you encounter is shown in Figure 644. Click the Database button in this dialog to launch the Data Explorer. Then refer to Using the Data Explorer to Connect to an ODA Database on page 780.

If you choose to create the new report as a blank report, the Data Explorer is launched directly upon making that selection.

Figure 644. Launching Data Explorer Via Report Expert

Click to LaunchData Explorer

3BUF001094R4101 779

Using Crystal Reports Appendix A Using Open Data Access

Using the Data Explorer to Connect to an ODA Database

The Data Explorer lets you 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 645:

1. Click the +/- button next to ODBC. This shows the available ODBC data sources, including DATABASE1.

2. Click the +/- button next to DATABASE1 or a different ODA database that you have configured. This shows the available Schemas (virtual database tables) in the selected database.

3. Select one or more schemas that you want the report to access:

a. Select a schema, then click Add. This adds the schema to the Tables available for report list in the Report Expert, Figure 646.

b. Repeat step 3a for as many schemas as required, then click Close.

Figure 645. Data Explorer - ODBC Access

780 3BUF001094R4101

Appendix A Using Open Data Access Using Crystal Reports

Figure 646. Adding a Table

3BUF001094R4101 781

Using Crystal Reports Appendix A Using Open Data Access

Using the Data Explorer to Connect to an Oracle Table, View, or Synonym

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 as described in the Industrial IT 800xA - Information Management Installation. In this example, the name of the ODBC driver is LocalOracle.

Use the Data Explorer to connect the subreport to LocalOracle. To do this:

1. Click the +/- button next to ODBC, Figure 647.

This shows all ODBC drivers available on this PC.

Figure 647. Data Explorer

782 3BUF001094R4101

Appendix A Using Open Data Access Using Crystal Reports

2. Select the ODBC driver that supports the ADO data provider for Oracle access. In this example, this driver is named Localhost. Right-click on the selected driver and choose Properties from the context menu, Figure 648.

3. Record the entries for Database DLL Name and Server shown in the Properties box, Figure 649. You’ll need to specify the Database DLL Name and Server when you define the DataServerLogin parameter in the report action. Click OK to close the box when you are finished.

Figure 648. Showing the Properties for the ODBC Driver

Figure 649. Properties Box

3BUF001094R4101 783

Using Crystal Reports Appendix A Using Open Data Access

4. Click the + symbol next to the ODBC driver (in this case LocalOracle), Figure 650.

This displays a dialog for logging on to the driver, Figure 651. The Service Name and User Name default to the correct entries.

Figure 650. Showing the Tables Under the ODBC Driver

Figure 651. Login Dialog

Click Here

784 3BUF001094R4101

Appendix A Using Open Data Access Using Crystal Reports

5. Record the Service Name. This is required in addition to the Database DLL Name and Server when you define the DataServerLogin parameter in the report action.

6. Enter history in the Password field and click OK.

This displays the selected driver’s associated tables, views, and synonyms according to the specified viewing options. You can filter this list to simplify your search for the applicable synonym.

7. Click the Options button to display the Options dialog.

8. Uncheck all Show options except Synonyms, Figure 652. As an option you can also specify a like string for a more specific filter (for example %PDL%). Click OK when you are finished.

Figure 652. Selecting Synonyms as the Only Show Option

3BUF001094R4101 785

Using Crystal Reports Appendix A Using Open Data Access

9. To apply these new explorer options, you must 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.

10. Scroll to and select the HISTORY.PDL_TASK_VIEW, Figure 653, then click Add.

This adds the selected synonym to the list of tables (views and synonyms) available for the report, Figure 654.

Figure 653. Selecting the PDL task View

786 3BUF001094R4101

Appendix A Using Open Data Access Using Crystal Reports

Figure 654. Tables Available for Report

3BUF001094R4101 787

Using Crystal Reports Appendix A Using Open Data Access

11. Select the attributes from the PDL_VARIABLE_VIEW that you want to include in the subreport, for example: VARIABLENAME, VARIABLEVALUE, and FVARIABLETIME. Figure 655 show the selections being made via the Standard Report Expert.

For further information regarding PDL access, see Appendix B, PDL for Batch Management.

Figure 655. Selecting Attributes from the PDL_VARIABLE_VIEW

788 3BUF001094R4101

Appendix A Using Open Data Access Using Crystal Reports

12. Use the Create Parameter Field function to add a parameter field for vartaskid, Figure 656. Add this parameter as a number value.

13. Use the Select Expert to set the TASKID field (from PDL_VARIABLE_VIEW) equal to the vartaskid parameter, Figure 657. This directs the query retrieve batch variable data for the task in the PDL_VARIABLE_VIEW whose ID is equal to the vartaskid parameter (specified via batchid in the report action parameter list.

Figure 656. Adding the vartaskid Parameter

Figure 657. Setting TASKID Equal to the vartaskid Parameter

3BUF001094R4101 789

Using Excel Without DataDirect Add-ins Appendix A Using Open Data Access

Using Excel Without DataDirect Add-insIn order for the reports you create with Microsoft Excel to access data from 800xA system aspect objects, 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 via the predefined numericlog (history) and generic_da (real-time) tables.

You can change the default set up for DATABASE1 to use the IM OPC HDA server, and/or specify a different real-time database table. Further, you can create additional ODA databases where each one specifies a different real-time database. This lets you connect your client application to a different ODA database, depending on you particular data access requirements. For instructions on configuring ODA, refer to the section on Open Data Access in Information Management Configuration.

You must have Microsoft Query installed to set up this functionality. If this application is not installed, you may install it now from the Excel installation media.

Connecting the Excel Spreadsheet to the ODBC Data Source

This procedure provides guidelines for using Microsoft Query to connect the Excel spreadsheet to an ODBC driver and create a query for history data. If you need more detailed instructions for using Microsoft Query, refer to the on-line help available with Microsoft Excel.

To connect the Excel spreadsheet to an ODBC driver and create a query for history data:

1. Use the Get External Data function in Excel to create a new query. Choose Data>Get External Data>New Database Query, Figure 658.

790 3BUF001094R4101

Appendix A Using Open Data Access Using Excel Without DataDirect Add-ins

2. Use the Choose Data Source dialog, Figure 659, to choose the applicable ODBC data source.

Figure 658. Create New Query

Figure 659. Referencing the ODBC Driver

3BUF001094R4101 791

Using Excel Without DataDirect Add-ins Appendix A Using Open Data Access

3. Use the Query Wizard to select the Numeric Log table, Figure 660, and then select the columns whose data you want to access, Figure 661.

4. Use the Query Wizard to either set up parameters, or query against a specific log name. Figure 662 shows how to query against a specific log name.

Figure 660. Selecting the NUMERICLOG Table

Figure 661. Selecting Columns

792 3BUF001094R4101

Appendix A Using Open Data Access Using Excel Without DataDirect Add-ins

5. Finish the query.

Figure 662. Querying Against a Specific Log Name

3BUF001094R4101 793

Using OLE DB Appendix A Using Open Data Access

Using OLE DB1. Click the +/- button next to OLE DB and select the Make New Connection

option under OLE DB, Figure 663.

2. Click the +/- button next to More Data Sources, Figure 664.

Figure 663. Making a New Connection

Figure 664. More Data Sources

Click Here to Start

794 3BUF001094R4101

Appendix A Using Open Data Access Using OLE DB

This shows additional database options, including OLE DB.

3. Click the +/- button next to OLE DB and select the Make New Connection option under OLE DB, Figure 665.

4. Click Add. This displays the Data Link Properties dialog.

5. Select ABBOpenDataAccess OLE DB Provider, Figure 666, then click Next.

Figure 665. Making a New Connection

3BUF001094R4101 795

Using OLE DB Appendix A Using Open Data Access

This displays the dialog for specifying the ABBOpenDataAcess OLE DB Provider data link properties.

Figure 666. Adding the ABB Open Data Access OLE DB Provider Data Link

796 3BUF001094R4101

Appendix A Using Open Data Access Using OLE DB

6. Enter the name of the ODA database in the Data Source field, for example: DATABASE1.

Also make sure the Blank password option is checked and the User name field is blank, Figure 667. The remaining properties may be left blank, or at their default values.

7. Click OK when you are finished. This inserts the selected database in the Data Explorer.

8. Click the +/- button next to the added database, for example: DATABASE1. This shows the available Schemas (virtual database tables).

Figure 667. Specifying Data Link Properties

You may use the Test Connection button to test the connection before confirming your entries.

3BUF001094R4101 797

Using OLE DB Appendix A Using Open Data Access

9. To connect the report to one or more schemas for the selected database:

a. Select a schema, then click Add. This adds the schema to the tables available for report list in the Report Expert, Figure 669.

b. Repeat step 9a for as many schemas as required, then click Close.

Figure 668. New Schema in Data Explorer Navigator

798 3BUF001094R4101

Appendix A Using Open Data Access Using OLE DB

Figure 669. Adding Tables

3BUF001094R4101 799

Accessing ODA Programmatically using ADO Appendix A Using Open Data Access

Accessing ODA Programmatically using ADOAs an alternative to using a desktop application such as Crystal Reports or Microsoft Excel, you can also connect to ODA databases 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.

The Provider is set to ABBOpenDataAccess. The Data Source is set to the ODA database name, in this case: Database1.

Private Sub Execute_Click() Dim socket As New ADODB.Connection Dim i As Long Dim Query As String

On Error Resume Next

lvData.ListItems.Clear socket.ConnectionString = "Provider=ABBOpenDataAccess;Persist Security " + _ "Info=False;Data Source=Database1" ' Set up the mode (initialize) socket.Mode = adModeRead ' Open the database socket.Open , , , adOpenUnspecified If Err.Number = 0 Then Set rs = New Recordset ' This is the query. It sets up the query to get data from the specified log. Query = "SELECT * FROM numericlog WHERE logname='" + LogName.Text + "'"

ODA does not support record-level locking of data, nor does it support transaction handling such as Commits and Rollbacks.

800 3BUF001094R4101

Appendix A Using Open Data Access Accessing ODA Programmatically using ADO

' Initialize rs.CursorLocation = adUseClient rs.CacheSize = 1000' Perform the query rs.Open Query, socket, adOpenForwardOnly, adLockOptimistic, adCmdText

' Check to make sure that the query worked. If not, we have to close the connection. If Not rs Is Nothing Then If rs.RecordCount > 0 Then formPopup.SetMax rs.RecordCount i = 0 ' Go through each record and print the data. While Not rs.EOF i = i + 1 formPopup.SetPos i Set nextLog = lvData.ListItems.Add(, , CStr(i)) nextLog.SubItems(1) = CStr(rs("DATAVALUE").Value) nextLog.SubItems(2) = CStr(rs("INTERVALS").Value) nextLog.SubItems(3) = CStr(rs("QUALITY").Value) nextLog.SubItems(5) = CStr(rs("AGGREGATE").Value) nextLog.SubItems(4) = CStr(rs("TIMESTAMP").Value) rs.MoveNext Wend End If End If End If socket.CloseEnd Sub

Private Sub Exit_Click() Unload MeEnd Sub

3BUF001094R4101 801

Accessing ODA Programmatically using ADO Appendix A Using Open Data Access

802 3BUF001094R4101

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 Information Management History Server function. PDLs are History logs that store production 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.

This section provides guidelines and reference information for accessing PDL and OPC message data for Batch Management.

Configuration Requirements for Batch ManagementBatch 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 history data. How to do this is described in Establishing History Associations in Batch Management on page 804

• send variable/tag data to be stored with the tasks.

• send batch procedures to the PDL.

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

3BUF001094R4101 803

Establishing History Associations in Batch Management Appendix B PDL for Batch Management

Establishing History Associations in Batch ManagementHistorical 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 associations 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 670. This lets you 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.

804 3BUF001094R4101

Appendix B PDL for Batch Management Establishing History Associations in Batch Management

Figure 670. Implementing a History Association in Batch Management

Action to Start History Data Collection

Action to Stop History Data Collection

3BUF001094R4101 805

Establishing History Associations in Batch Management Appendix B PDL for Batch Management

Guidelines for configuring BMAs to support this functionality are provided below and illustrated in Figure 671 and Figure 672. Details regarding the configuration of a Data Collection BMA are provided in the section on Collecting Data from an RDP in Industrial IT 800xA - Batch Management Configuration.

Figure 671 illustrates the procedure for creating a Data Collection BMA to start history collection. A second BMA is required to stop history collection.

If you do not know the exact name of the history log, use the Information Management OPC Browser to locate the log and copy the log name. You can then paste the name in the BMA editor. This is illustrated in Figure 672. Use the same name for Logical Name and OPC Item. Enclose both entries with double-quotation marks.

The Information Management OPC Browser is launched via the Windows task bar. Choose Start>Programs>ABB Industrial IT 800xA>Information Mgmt> Utilities>Information Management Browser. For further information on using this browser, refer to Section 7, Browsing for OPC Tags.

Figure 671. Configuring Data Collection BMAs for History Association

806 3BUF001094R4101

Appendix B PDL for Batch Management Setting Up Storage of Batch Procedures in PDL

Setting Up Storage of Batch Procedures in PDL

Batch procedures are periodically deleted from on-line storage on the Batch Management application server. These procedures can be stored in PDLs on the Information Management node for long-term storage. This enables you to retrieve the batch procedures and view the PFCs, even after they have been deleted from on-line 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

Figure 672. Obtaining Log Name via the Information Management OPC Browser

3BUF001094R4101 807

Setting Up Storage of Batch Procedures in PDL Appendix B PDL for Batch 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

You may use an existing directory to share as HS_CLIENT_DATA; however, it is recommended that you create a new one specifically for this purpose. Whether you use an existing directory, or create a new one, 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 (reference Figure 673):

1. Select the directory, right-click, and then choose Sharing... from the context menu. This displays the directory’s Properties dialog, open to the Sharing tab.

2. Click the Share this folder radio button, and enter HS_CLIENT_DATA in the Share Name field. Click OK when you are finished.

Figure 673. Sharing a Directory As HS_CLIENT_DATA

808 3BUF001094R4101

Appendix B PDL for Batch Management Accessing PDL Data

Accessing PDL DataThis section provides example queries for typical PDL retrieval applications. Tables which list all PDL attributes included in PDL views for use in batch reports are provided in PDL Tables and Views on page 817. Guidelines for accessing archived data are provided in Accessing Archived Data on page 816.

PDLs can be read via:

• DataDirect - DataDirect is an add-in for Microsoft® Excel. DataDirect supports PDL access via SQL queries, and via a PDL browser dialog.

• Display Services - Display Services let you 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 810

• How to Get taskid if it is Unknown on page 811

• How To Query for the Entire Campaign Hierarchy on page 811

• How to Exclude Parts of the Hierarchy on page 812

• Joining Task Views on page 813

• Retrieve Variable Data for a Specific Batch Occurrence on page 814

• Accessing Archived Data on page 816

3BUF001094R4101 809

Querying for a Specific Task Type in the Task Hierarchy Appendix B PDL for Batch Management

Querying for a Specific Task Type in the Task HierarchyWhen a Campaign is run, one PDL is produced for that campaign. The PDL is represented as a hierarchy that has multiple levels and branches to accommodate the various tasks, Figure 674. Each task is assigned a unique task ID according to the order in which it was created.

You can write a query to access one or more tasks on one or more levels. Since only campaigns and batches exist at fixed levels, you should generally use task type 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

Figure 674. PDL Hierarchy

10

11

13 14 15

12

LEVELNUMBER TASK TYPE TASKID

0

1

2-15

Campaign

Batch

Procedure or Phase

810 3BUF001094R4101

Appendix B PDL for Batch Management How to Get taskid if it is Unknown

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 FROM history.pdl_task_view WHERE type = Batch_Phase START WITH taskid = 16 CONNECT BY PRIOR taskid = parentid

The type specifies the kind of task to query (campaign, batch, unit procedure, operation, 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.

How to Get taskid if it is UnknownFor the START WITH clause, if you do not know the taskid of the starting task, you can 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)

How To Query for the Entire Campaign HierarchyTo query the entire campaign hierarchy, use the following query:

SELECT taskname, fstarttime FROM history.pdl_task_view 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.

3BUF001094R4101 811

How to Exclude Parts of the Hierarchy Appendix B PDL for Batch Management

How to Exclude Parts of the HierarchyYou can 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.

You can use the CONNECT BY clause to exclude a branch (a task and its descendants). For example:

CONNECT BY prior taskid = parentid AND taskid !=19

This query excludes the branch with the unit task whose taskid = 19 and the phase task whose taskid = 20.

812 3BUF001094R4101

Appendix B PDL for Batch Management Joining Task Views

Joining Task ViewsJoining task views is a method for retrieving data for different task levels. For instance, you can write a query 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. You can not do this using the view name; therefore, you must use aliases to identify the view.

The aliases are specified in the FROM clause by simply entering them after their respective view names. These aliases are used in the other clauses to specify the appropriate 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 675.

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 AND c.taskid = b.parentid

Figure 675. Example, Join history.pdl_task_view to Itself

history.pdl_task_view

taskid

SELECT Campaign Data

history.pdl_task_view

parentid

Batch Data

3BUF001094R4101 813

Retrieve Variable Data for a Specific Batch Occurrence Appendix B PDL for Batch Management

Retrieve Variable Data for a Specific Batch OccurrenceThis 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 58 and Table 59 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 via their respective views. If you want to read the variable values for occurrence 3 of the spicy batch, you must 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 via 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 676.

Table 58. Example, Task View

TASKNAME OCCURRENCE TASKID

spicy 1 12

spicy 2 13

light 1 14

light 2 15

spicy 3 16

Table 59. Example, Variable View

VARIABLENAME OCCURRENCE(1) TASKID VARIABLEVALUE

tomato 1 12 75.00

onion 1 12 5.00

814 3BUF001094R4101

Appendix B PDL for Batch Management Retrieve Variable Data for a Specific Batch Occurrence

garlic 1 12 1.25

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 59 are at occurrence 1.

Figure 676. Query with Join

Table 59. Example, Variable View

VARIABLENAME OCCURRENCE(1) TASKID VARIABLEVALUE

SELECT history.pdl_task_view.taskname, history.pdl_task_view.occurrence, history.pdl_task_view.taskid, variablevalue, variablenameFROM history.pdl_taskview, history.pdl_variable_viewWHERE history.pdl_task_view.taskname = ‘spicey’AND history.pdl_task_view.occurrence = 3

3BUF001094R4101 815

Accessing Archived Data Appendix B PDL for Batch Management

Accessing Archived DataArchived PDL data can be restored from the archive media, and then be accessed by external applications such as Display Services and User API. The procedure is essentially the same as for accessing runtime data. The only difference is that you must reference the restored table names or view names in your queries. The restored table and view names are listed in PDL Tables and Views on page 817. Instructions for restoring archived data are provided in Making Archived Data Available to Client Applications on page 696.

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

816 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

PDL Tables and ViewsThis section describes the tables and views where PDL data are stored. There are 12 views designed specifically for Batch Management applications:

• Batch_Header - Table 60

• Batch_Equipment - Table 61

• Batch_Vars_MatchedPairs - Table 62

• Batch_Variables - Table 63

• Batch_Procedures - Table 64

• Batch_ProcessEvents - Table 65

• Batch_AuditEvents - Table 66

• Batch_CommentEvents - Table 67

• Batch_Events - Table 68

• Batch_BatchMgrEvents - Table 69

• Batch_SystemEvents - Table 70

• Batch_Trend - Table 71

These seven tables and four consolidated view are also available:

• TASK (Table 73)

• TASK_VARIABLES (Table 74)

• TASK_VARIABLES_OCCURRENCES (Table 75)

• RESOURCE_ASSOCIATIONS

• RESOURCE_TRANSACTIONS

• HISTORY_ASSOCIATIONS (Table 76)

• HISTORY_ASSOC_OCC_START (Table 77)

• HISTORY_ASSOC_OCC_END (Table 78)

• MODIFICATIONS_ATTRIBUTES (Table 79)

• pdl_task_view (Table 80)

3BUF001094R4101 817

PDL Tables and Views Appendix B PDL for Batch Management

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 you do not have to apply algorithms to the raw data to get formatted date and time. For instance, STARTTIME 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 81)

This view is a combination of the TASK_VARIABLES and TASK_VARIABLES_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 RESOURCE_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 82)

This view is a combination of the HISTORY_ASSOCIATIONS, HISTORY_ASSOC_OCC_START, HISTORY_ASSOC_OCC_END, and TMODIFICATIONS_ATTRIBUTES tables. Attributes that are not currently used are not included in this view, and date/time attributes are re-formatted.

818 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

Table 60. Batch_Header

Attribute Data Type Description

BatchID Character (40) 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

3BUF001094R4101 819

PDL Tables and Views Appendix B PDL for Batch Management

Table 61. Batch_Equipment

Attribute Data Type Description

BatchID Character (90) Batch ID of the batch

ProcedurePath Character (90) 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

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

820 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

Table 62. Batch_Vars_MatchedPair

Attribute Data Type Description

BatchID Character (40) Batch ID of the batch

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

3BUF001094R4101 821

PDL Tables and Views Appendix B PDL for Batch Management

Table 63. Batch_Variables

Attribute Data Type Description

BatchID Character (40) Batch ID of the batch

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.

Day Date Date the variable was recorded

Time Character (9) Time the variable was recorded

VariableValue Character (255) Value of the variable

822 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

Table 64. Batch_Procedures

Attribute Data Type Description

BatchID Character (40) Batch ID of the batch

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 procedure name.

StartDate Date Date the procedure started

StartTime Character (9) Time the procedure started

EndDate Date Date the procedure ended

EndTime Character (9) Time the procedure ended

3BUF001094R4101 823

PDL Tables and Views Appendix B PDL for Batch Management

Table 65. Batch_ProcessEvents

Attribute Data Type Description

Name Character (40) Batch name

LocalTime Date Time message occurred

EventCategory Character (4000) Message event category

Message Character (4000) Event text

CampaignID Character (40) Campaign ID of the batch

BatchID Character (40) Batch ID of the batch

LotID Character (40) Lot ID of the batch

ProcedurePath Character (40) Procedure path of the active block, campaign ID for level 0, or batch ID for level 1

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 (40) Event condition

SubCondition Character (40) Event subcondition

LongMessage Character (40) 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 (40) User-configured event data

824 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

Table 66. Batch_AuditEvents

Attribute Data Type Description

Name Character (40) Batch name

LocalTime Date Time event occurred

EventCategory Character (4000) Event category

Message Character (4000) Event text

CampaignID Character (40) Campaign ID of the batch

BatchID Character (40) Batch ID of the batch

LotID Character (40) Lot ID of the batch

ProcedurePath Character (40) Procedure path of the active block, campaign ID for level 0, or batch ID for level 1

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

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

CategoryName Character (40) Name of the original event category

NodeName Character (40) Name of the node where the event originated

SourceName Character (40) Name of the source of the event

3BUF001094R4101 825

PDL Tables and Views Appendix B PDL for Batch Management

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

MessageDescription Character (40) Event description

NewUser Character (40) New user during logover

OldUser Character (40) Old user during logover

XMLData Character (40) User- defined event data

Table 66. Batch_AuditEvents (Continued)

Attribute Data Type Description

826 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

Table 67. Batch_CommentEvents

Attribute Data Type Description

Name Character (40) Batch name

LocalTime Date Time event occurred

EventCategory Character (4000) Event category

Message Character (4000) Event text

CampaignID Character (40) Campaign ID of the batch

BatchID Character (40) Batch ID of the batch

LotID Character (40) Lot ID of the batch

ProcedurePath Character (40) Procedure path of the active block, campaign ID for level 0, or batch ID for level 1

UserAccount Character (40) Logged-on user

UserFullName Character (40) Full name of the logged-on user

UserFirstAccount Character (40) First authenticator

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

CategoryName Character (40) Name of the original event category

NodeName Character (40) Name of the node where the event originated

3BUF001094R4101 827

PDL Tables and Views Appendix B PDL for Batch Management

Table 68. Batch_Events

Attribute Data Type Description

Name Character (40) Batch name

LocalTime Date Time event occurred

EventCategory Character (4000) Event category

Message Character (4000) Event text

CampaignID Character (40) Campaign ID of the batch

BatchID Character (40) Batch ID of the batch

LotID Character (40) Lot ID of the batch

ProcedurePath Character (40) Procedure path of the active block, campaign ID for level 0, or batch ID for level 1

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

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

CategoryName Character (40) Name of the original event category

NodeName Character (40) Name of the node where the event originated

SourceName Character (40) Name of the source of the event

828 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

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 (40) Event long message

MessageDescription Character (40) Event description

Priority Character (40) Event priority

Section Character (40) Event section

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

EventCode Character (40) Event code

XMLData Character (40) User- defined event data

Table 68. Batch_Events (Continued)

Attribute Data Type Description

3BUF001094R4101 829

PDL Tables and Views Appendix B PDL for Batch Management

Table 69. Batch_BatchMgrEvents

Attribute Data Type Description

Name Character (40) Batch name

LocalTime Date Time event occurred

EventCategory Character (4000) Event category

Message Character (4000) Event text

CampaignID Character (40) Campaign ID of the batch

BatchID Character (40) Batch ID of the batch

LotID Character (40) Lot ID of the batch

ProcedurePath Character (40) Procedure path of the active block, campaign ID for level 0, or batch ID for level 1

CategoryName Character (40) Name of the original event category

Table 70. Batch_SystemEvents

Attribute Data Type Description

BatchID Character (40) Batch ID of the batch

MsgDate Date Date of system event

MsgTime Character (9) Time of system event

EventCategory Character (4000) Event category

Message Character (4000) Event text

Attr1 - Attr40 Character (40) Additional event attributes

830 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

Table 71. Batch_Trend

Attribute Data Type Description

Aggregate Character (40) 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.

BatchID Character (40) Name of the batch.

DataValue Number Data value.

Intervals Number Time in seconds between interpolated data points. Default value = 1 second.

LogicalName Character (40) User name for log.

Quallity Number Data quality code.

LogName Character (40) History log name.

TimeStamp Date Sample time stamp

Improving Performance: You may improve the performance of queries on the Batch_Trends view by following the guidelines in Improving the Performance of the Batch_Trend View on page 231.

3BUF001094R4101 831

PDL Tables and Views Appendix B PDL for Batch Management

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

Table 72. 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

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

832 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

Table 73. TASK Log Attributes

Attribute Data Type Data Source[] = optional Description

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. Example: 2

TASKID Number Not Null

System System-generated identifier. Example: 1110000110

PARENTID Number [Application] Taskid of the task that started this task. Supplied by application at time of task log creation. Example: 0

LEVELNUMBER Number Application PDL task level number (0 through 15):0 = Campaign 1 = Batch 2-15 = Procedure or Phase

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.

3BUF001094R4101 833

PDL Tables and Views Appendix B PDL for Batch Management

ARCHIVESTATUS Number(1) Not used in this release.

CREATOR Character(32) [Application] User-defined identifier of process that created the task.Not used in this release.

CREATIONTIME Date System or [Application]

Time stamp generated when task was created. Time is given as local time with resolution to the second. Use application supplied time unless 0 passed in.

CREATIONTIMEUTC Number System or [Application]

Creation time as Universal Time Coordinate (UTC) - Number of seconds since January 1, 1970.

CREATIONTIMEMSEC Number System Number of milliseconds into the second that creation time occurred.

STARTTIME Date System or [Application]

Time stamp generated when task started Time is given as local time with resolution to the second. Use application supplied time unless 0 passed in.

STARTTIMEUTC Number System or [Application]

Start time as Universal Time Coordinate (UTC) in seconds since January 1, 1970.

STARTTIMEMSEC Number System Number of milliseconds into the second that start time occurred.

ENDTIME Date System or [Application]

Time stamp generated when task is ended. Time is given as local time with resolution to the second. Use application supplied time unless 0 passed in.

Table 73. TASK Log Attributes

Attribute Data Type Data Source[] = optional Description

834 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

ENDTIMEUTC Number System or [Application]

End time as Universal Time Coordinate (UTC) in seconds since January 1, 1970.

ENDTIMEMSEC Number System or [Application]

Number of milliseconds into the second 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

Table 73. TASK Log Attributes

Attribute Data Type Data Source[] = optional Description

3BUF001094R4101 835

PDL Tables and Views Appendix B PDL for Batch Management

Table 74. TASK_VARIABLES Log Attributes

Attribute Data Type Data Source[] = optional Description

NAME Character (32) Not Null

Application User-defined name for variable or parameter as declared in Batch Management. Used in combination with Occurrence in query for retrieval of variable data.Example: ReactorTemp

TASKID Number Not Null

Application Task identifier for associated task.

TYPE Character (1) System Not used in this release.

CREATIONTIME Date/Time System/[Application]

Time stamp generated when request to 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.

CREATIONTIMEUTC Number System or [Application]

Creation time as Universal Time Coordinate (UTC) - Number of seconds since January 1, 1970.

CREATIONTIMEMSEC Number System Number of milliseconds into the second that creation time occurred.

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.

836 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

UserParameter1 Number Batch Management uses 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.

UserParameter2 Character(32) 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.

Table 74. TASK_VARIABLES Log Attributes

Attribute Data Type Data Source[] = optional Description

3BUF001094R4101 837

PDL Tables and Views Appendix B PDL for Batch Management

Table 75. TASK_VARIABLES_OCCURRENCES Log Attributes

Attribute Data Type Data Source[] = optional Description

NAME Character (32) Not Null

Application User-defined name for TagkeyData or parameter as declared in Batch Management. Used in combination with Occurrence in query for retrieval of variable data.Example: ReactorTemp

OCCURRENCE Number Not Null

System or [Application]

Occurrence of this variable within the task. Example: 2

TASKID Number Not Null

Application Task identifier for associated task.

VARIABLEVALUE Number Not Null

Application Initial value of the variable from a Batch 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 [Application]

Time stamp at time of variable entry 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 [Application]

Variable time as Universal Time Coordinate (UTC) - Number of seconds since January 1, 1970.

VARIABLETIMEMSEC Number System Number of milliseconds into the second that variable time occurred.

838 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

RESULTVALUE Number Not Null

Application The Procedure or Phase [parameter name].out for Batch Management matched parameter pairs.

RESULTTIME Date/Time The timestamp at time of variable entry for Procedure or Phase [parameter name].out for Batch Management matched parameter pairs.

RESULTTIMEUTC Number System or [Application]

Result time as Universal Time Coordinate (UTC) - Number of seconds since January 1, 1970.

RESULTTIMEMSEC Number System Number of milliseconds into the second that result time occurred.

APPLICATION OCCURRENCE

Number Application User-defined 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 75. TASK_VARIABLES_OCCURRENCES Log Attributes

Attribute Data Type Data Source[] = optional Description

3BUF001094R4101 839

PDL Tables and Views Appendix B PDL for Batch Management

Table 76. HISTORY_ASSOCIATIONS Log Attributes

Attribute Data Type Data Source[] = optional Description

NAME Character (32) Not Null

Application Batch Management BMA Data Collection Logical NameExample: Temperature

TASKID Number Not Null

Application System generated identifier. Example: 1 110 000 110

LOGTYPE Character (1) Application N = Numeric Log M = Message Log G = Generic - used by Operations

STORAGEINTERVAL Number [Application]/System

Recording rate of process object in seconds.Example: 10 (sec)

DATASOURCE Data source for history log as defined in Composite log window in History.Example: [object path]objectname:property

CAPACITY Number [Application]/ System

Not used in this release.

LOGNAME Character (32) Application/ System

Identifies the specific logname of the objectExample:[object path]objectname:property,logname

840 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

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 failureN = Do not notify in event of failureNot 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/ [Application]

Time stamp generated at time when History association was created. Time is given as local time with resolution to the second. PDL computes time stamp if application passes 0.

CREATIONTIMEUTC Number System or [Application]

Creation time as Universal Time Coordinate (UTC) - Number of seconds since January 1, 1970.

CREATIONTIMEMSEC Number System Number of milliseconds into the second that creation time occurred.

STATUS Character (10) [Application] Not used in this release.

USERPARAMETER1 Number [Application] Not used in this release.

USERPARAMETER2 Character (32) [Application] Not used in this release.

USERNAME Character (32) Application Not used in this release.

Table 76. HISTORY_ASSOCIATIONS Log Attributes

Attribute Data Type Data Source[] = optional Description

3BUF001094R4101 841

PDL Tables and Views Appendix B PDL for Batch Management

USERCOMMENT Character(255) [Application] Not used in this release.

ARCHIVESTATUS Number System Indicates if this log has been saved to archive media.

Table 77. HISTORY_ASSOC_OCC_START Log Attributes

Attribute Data Type Data Source[] = optional Description

NAME Character (32)

Application Batch Management BMA Data Collection Logical NameExample: Temperature

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

TIMEPERIODSTART Date/Time System Time stamp generated at time of start association. Time is given as local time with resolution to the second.

TIMEPERIODSTARTUTC Number System or [Application]

Time period start time as Universal Time Coordinate (UTC) - Number of seconds since January 1, 1970.

TIMEPERIODSTARTMSEC Number System Number of milliseconds into the second that time period start time occurred.

ENTRYTIME Date/Time System Same as TIMEPERIODSTART.

Table 76. HISTORY_ASSOCIATIONS Log Attributes

Attribute Data Type Data Source[] = optional Description

842 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

ENTRYTIMEUTC Number System or [Application]

Same as TIMEPERIODSTARTUTC

ENTRYTIMEMSEC Number System Same as TIMEPERIODSTARTMSEC

USERNAME 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 78. HISTORY_ASSOC_OCC_END Log Attributes

Attribute Data Type Data Source[] = optional Description

NAME Character (32) Application Batch Management BMA Data Collection Logical NameExample: Temperature

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

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.

Table 77. HISTORY_ASSOC_OCC_START Log Attributes

Attribute Data Type Data Source[] = optional Description

3BUF001094R4101 843

PDL Tables and Views Appendix B PDL for Batch Management

TIMEPERIODENDUTC Number System or [Application]

Time period end time as Universal Time Coordinate (UTC) - Number of seconds since January 1, 1970.

TIMEPERIODENDMSEC Number System Number of milliseconds 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.

USERNAME 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 79. MODIFICATIONS_ATTRIBUTES Log Attributes

Attribute Data Type Data Source[] = optional Description

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 CHANGEDRECORD

Character(64) System/[Application]

Not used in this release.

VARIABLETIME Date System/[Application]

Original time (before modification).

Table 78. HISTORY_ASSOC_OCC_END Log Attributes

Attribute Data Type Data Source[] = optional Description

844 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

VARIABLETIMEUTC Number System/[Application]

Time as Universal Time Coordinate (UTC) - Number of seconds since January 1, 1970

VARIABLETIMEMSEC Number System/[Application]

Number of milliseconds into the second that variable time occurred.

RESOURCETYPE Character(15) System/[Application]

Resource type for resource association.

RESOURCEVERSION Character(32) System/[Application]

Resource version for resource association.

MODIFYTIME Date/Time System/[Application]

Time stamp generated at time of modify operation. PDL generates time stamp if application passes 0. Time is given in local time with resolution to the second.

MODIFYTIMEUTC Number System or [Application]

Modify time as Universal Time Coordinate (UTC) - Number of seconds since January 1, 1970.

ITEMOCCURRENCE Number [Application] Occurrence number of item being updatedExample: 3

OLDVALUE Character(255) Application Previous ValueExample: 4.00

NEWVALUE Character(255) Application Updated ValueExample: 3.56

USERNAME 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 79. MODIFICATIONS_ATTRIBUTES Log Attributes

Attribute Data Type Data Source[] = optional Description

3BUF001094R4101 845

PDL Tables and Views Appendix B PDL for Batch Management

Table 80. pdl_task_view Attributes

Attribute Data Type Data Source[] = optional Description

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 NumberNot Null

System System-generated identifier.Example: 14

PARENTID Number [Application] Supplied by application at time of task log creation.Example: 1 110 001 113

LEVELNUMBER Number Application PDL task level number (0 through 15)0 = Campaign 1 = Batch 2-15 = Procedure or Phase

FCREATIONTIME Character (75) System or [Application]

Formatted time stamp generated when task was created. Use application supplied time unless 0 passed in.Example: 25-AUG-2000 14:45:00

846 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

FSTARTTIME Character (75) System or [Application]

Same as FCREATIONTIME.

FENDTIME Character (75) System or [Application]

Formatted time stamp generated when 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 81. pdl_variable_view Attributes

Attribute Data Type Data Source[] = optional Description

VARIABLENAME Character (32) Not Null

Application User-defined name for variable or parameter (as declared in Batch Management). Used in combination with Occurrence in query for retrieval of variable data.

TASKID Number Not Null

Application Task identifier for associated task.

TASKTYPE Character (19) Application See TASKTYPE in Table 80.

OCCURRENCE Number Not Null

System or [Application]

Occurrence of this variable within the task. Example: 2

APPLICATION OCCURRENCE

Number Application User-defined occurrence.

Table 80. pdl_task_view Attributes

Attribute Data Type Data Source[] = optional Description

3BUF001094R4101 847

PDL Tables and Views Appendix B PDL for Batch Management

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 [Application]

Formatted time stamp generated when the request to create this variable was made. Currently, this time stamp comes from Batch Management. Use application supplied time unless 0 passed in.Example: 25-FEB-2001 14:45:00

FVARIABLETIME Character (20) System or [Application]

Formatted time stamp at time of variable 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 Not Null

Application Updated value of the variable when another request comes in to record to the same variable and occurrence via Batch Management.

FRESULTTIME Character (20) Application Formatted time stamp at time of at time of variable entry operation.

Table 81. pdl_variable_view Attributes

Attribute Data Type Data Source[] = optional Description

848 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

TASKNAME Character (40) Application User-defined name for task. TASKNAME is used in combination with OCCURRENCE in query for retrieval of task data.

LEVELNUMBER Number Application PDL task level number (0 through 15)0 = Campaign 1 = Batch 2-15 = Procedure or Phase

PARENTID Number [Application] Supplied by application at time of task log creation.Example: 1 110 001 113

Table 82. pdl_history_view Attributes

Attribute Data Type Data Source[] = optional Description

ASSOCIATIONNAME Character (32) Not Null

Application Batch Management BMA Data Collection Logical NameExample: TemperatureRefer the Note at the end of this table.

OCCURRENCE Number Not Null

System Occurrence of this history association usage within the task.

TASKID Number Not Null

Application Task identifier for associated task.

OWNERID Number Application Batch task ID

OWNERNAME Character(40) Not used in this release.

DATASOURCE Character(64) Not used in this release.

Table 81. pdl_variable_view Attributes

Attribute Data Type Data Source[] = optional Description

3BUF001094R4101 849

PDL Tables and Views Appendix B PDL for Batch Management

STORAGEINTERVAL Character(6) Not used in this release.

CAPACITY Number Not used in this release.

LOGNAME Character (1023)

Example: [object path]objectname:property

PARENTID Number [Application] Supplied by application at time of task log creation.Example: 1 110 001 113

LEVELNUMBER Number Application PDL task level number (0 through 15)0 = Campaign 1 = Batch 2-15 = Procedure or Phase

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/[Application]

Formatted time stamp generated at time 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.

Table 82. pdl_history_view Attributes

Attribute Data Type Data Source[] = optional Description

850 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

You will be required to enforce unique trend AssociationNames (BMA Data Collect Logical Names) within a batch. 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 that you intended.

Table 83. pdl_resource_view Attributes

Attribute Data Type Data Source[] = optional Description

RESOURCENAME Character (32)Not Null

Application Name of Batch Management Equipment

TASKID Number Application Task identifier for associated task.

OCCURRENCE NUMBER

Number Indicates the transaction occurrence of the Resource used by a Batch.Example:Batch Management Acquire = 1 Batch Management Release = 2

TASKNAME Character(40) User-defined name for task. TASKNAME is used in combination with OCCURRENCE in query for retrieval of 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

3BUF001094R4101 851

PDL Tables and Views Appendix B PDL for Batch Management

LEVELNUMBER Number(2) PDL task level number (0 through 15)0 = Campaign 1 = Batch 2-15 = Procedure or Phase

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) Not Null

[Application] Not used in this release

VERSION Character (32) Not Null

[Application] Not used in this release

ACTUALVALUE Number Not Null

Application Not used in this release

FENTRYTIME Date/(System&Normalized)

System or [Application]

Formatted time stamp at time of acquire or release. Example: 25-AUG-2003 14:45:00

Table 83. pdl_resource_view Attributes

Attribute Data Type Data Source[] = optional Description

852 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

Table 84. RESOURCE_ASSOCIATIONS Attributes

Attribute Data Type Data Source[] = optional Description

TASKID Number Not Null

Application Task to associate resource with.

NAME

TYPE Character (15) Not Null

[Application] Not used in this release

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 [Application]

Time stamp generated when task was created. Time is given as local time with resolution to the second. Use application supplied time unless 0 passed in.

CREATIONTIMEUTC Number System or [Application]

Creation time as Universal Time Coordinate (UTC) - Number of seconds since January 1, 1970.

CREATIONTIMEMSEC Number System Number of milliseconds into the second that creation time occurred.

VERSION System Not used in this release.

USERPARAMETER1 Number [Application] Not used in this release.

USERPARAMETER2 Character (32) [Application] Not used in this release.

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

3BUF001094R4101 853

PDL Tables and Views Appendix B PDL for Batch Management

Table 85. RESOURCE_TRANSACTIONS Attributes

Attribute Data Type Data Source[] = optional Description

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 Not Null

System Occurrence of this resource usage in the task. Example: 2

TASKID Number Not Null

Application Task to associate resource with.

ACTUALVALUE [Application] Not used in this release.

SAMPLETIME Date/Time System/[Application]

Not used in this release.

SAMPLETIMEUTC Number System or [Application]

Not used in this release.

SAMPLETIMEMSEC Number System Not used in this release.

ENTRYTIME Date/Time System/ [Application]

Same as CREATIONTIME.

ENTRYTIMEUTC Number System or [Application]

Same as CREATIONTIMEUTC.

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.

854 3BUF001094R4101

Appendix B PDL for Batch Management PDL Tables and Views

USERNAME 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 85. RESOURCE_TRANSACTIONS Attributes

Attribute Data Type Data Source[] = optional Description

3BUF001094R4101 855

PDL Tables and Views Appendix B PDL for Batch Management

856 3BUF001094R4101

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 you use the 800xA OPC HDA server 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 as described in Data Provider Architecture on page 65.

Accessing History Servers in Other Aspect Systems

The 800xA OPC HDA server provides access to history servers in the same Aspect System where the OPC HDA server resides. If you need to access history servers from more than one Aspect System, or to access a history server in a different Aspect System, use the IM OPC HDA server.

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 you browse for history objects, the browser lets you choose one of three paths or categories by which to conduct your search, Figure 677:

• EH lets you access logs that are local to the data provider to which you are connected. This is the fastest method and is recommended if you are querying a

3BUF001094R4101 857

Appendix C Using the IM OPC HDA Server

log that resides on the local server. It supports the ability to modify existing log entries, but not adding new entries.

858 3BUF001094R4101

Appendix C Using the IM OPC HDA Server

• EH_NET lets you access logs on all servers on the network. This requires OMF access to be extended on the TCP/IP network. This is described in the section on Network Communications in Information Management Installation. It supports the ability to modify existing log entries, and add new entries.

• EH_PUBL lets you access archived log data that is published. For instructions on publishing archived data, refer to Publishing an Archive Volume on page 697.

• LOGMAN is not applicable for this release.

Syntax for Log Name References

There is a different syntax for referencing log names in data queries for the two OPC HDA servers. See Property Log Naming Conventions on page 50.

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

Figure 677. IMHDA Access

3BUF001094R4101 859

Appendix C Using the IM OPC HDA Server

860 3BUF001094R4101

Appendix D Terminology

The following is a list of terms related to the 800xA system. The list contains terms and abbreviations that are unique to ABB or have a usage or definition that is different from standard industry usage.

Table 86. 800xA System Terminology

Term Description

ActiveX Microsoft standard for user interface components, based on definition of software interfaces.

Aspect An aspect is a description of some properties of a real world entity. The properties described could be mechanical layout, how the object is controlled, a live video image, name of the object etc. In the Aspect Integrator Platform is an aspect residing in an aspect object. Some examples of aspects are circuit diagram, process display and control logic.

Aspect Category A specialization of an aspect type. For example, the aspect type Graphic Display includes the categories Overview, Group and Object Display.

Aspect Integrator Platform

A collection of software that forms the basis for an Industrial IT System, and provides the development and execution environment for Industrial IT Compliant applications. The Aspect Integrator Platform includes the Aspect Framework.

Aspect Objects A computer representation of a real world entity like a pump, a valve, an order or a virtual object like a service. This computer representation is implemented by the Aspect Integrator Platform. An aspect object works like an information container for it’s aspects.

3BUF001094R4101 861

Appendix D Terminology

Aspect Object Type

An aspect object type defines certain characteristics that are shared between several aspect object instances, such as a basic set of common aspects. This makes it possible to create and efficiently re-use standardized solutions to frequently recurring problems. For example, rather than building an aspect object from scratch for every valve in a plant, you can define a set of valve types, and then create all valve objects of these instances.

Aspect Server A server that runs the central functions of the aspect object architecture, such as Aspect Directory, Structure and Name Server, Cross Referencing, File Set Distribution, etc. The Aspect Server is normally used as Windows domain controller for the control and client/server networks.

Aspect System A software system, which implements one or several aspect types by providing one or several aspect system objects.

Client Client is the part of the software that supply data to a subscriber.

Client/Server Network

A client/server network is used for communication between servers, and between workplaces and servers.

COM Microsoft’s Common Object Model that is used for exchanging information within the Windows 2000 system.

Connectivity Product

Connectivity components, up-loader, supporting aspect systems (e.g for the configuration), and graphical elements, faceplates, aspect object types, etc., bundled together to provide the integration of a certain type of devices into the Industrial IT system.

Connectivity Server

A server that provides access to controllers and other sources for real-time data, historical data, and alarm and event data. A Connectivity Server runs services related to OPC/DA, APC/AE, OPC/HAD and SysMag.

Faceplate A faceplate is an aspect that provides a graphical representation of a certain aspect object, with presentation of certain properties related to the object, and mechanism for operator interaction such as on/off, increase/decrease, etc. aspect object types often include several faceplate aspects, providing different presentation and interaction possibilities.

Table 86. 800xA System Terminology

Term Description

862 3BUF001094R4101

Appendix D Terminology

Graphic Display A graphic display is an aspect that provides a visual presentation. It consists of static graphics representing for example tanks, pipes etc., and graphic elements that present dynamic information. Graphic displays are often used to present the state of a process or a part of a process, but are useful in any context where dynamic graphical information is needed.

Industrial IT Industrial IT is the umbrella concept for ABB’s vision for enterprise automation.

Industrial IT System

A computer system that implements (part of) the Industrial IT vision. Aspect Integrator Platform is an example of such a system.

Node A computer communicating on a network e.g. the Internet, Plant, Control or IO network. Each node typically has a unique node address with a format depending on the network it is connected to.

OMF ABB proprietary software that supports creation of and access to History and Process objects in the ABB OCS. For detailed information regarding OMF objects, refer to the AdvaInform Object Types Reference Manual.

OPC An application programming interface defined by the standardization group OPC Foundation. The standard defines how to access large amounts of real-time data between applications. The OPC standard interface is used between automation/control applications, field systems/devices and business/office application.

Plant Explorer An application that is used to create, delete and organize aspect objects and aspects within the Aspect Integrator Platform. The plant explorer organizes the aspect objects in structures according to functionality, location etc.You can also use it to browse and search the structures of the plant.

Process Portal A Product containing functionality for efficient control and supervision of an automated process. Key functions are presentation of process graphics, process dialogs and presentation of alarms and trends.

Permission A permission groups a set of operations that require the same authority. For each operation defined for an aspect, the aspect category specifies the permission needed to use that interface.

Process Object A process concept/equipment e.g. valve, motor, conveyor or tank.

Table 86. 800xA System Terminology

Term Description

3BUF001094R4101 863

Appendix D Terminology

Product Family A range of products within a Product Suite, forming a scalable offering. Examples: a range of controllers, a family of I/O Products.

Product Suite Product with similar functionality are kept together in a suite. Suite names have a superscripted IT-suffix. Examples: Operate IT, Control IT, Integrate IT etc. Property A data field on an aspect of an aspect object that can be accessed through OPC using the standard Aspect

Object reference syntax.

A data field on an ActiveX control accessible from the Visual Basic editor.

Security Security controls a user’s authority to perform different operations on aspect objects, depending on several parameters: • The user’s credentials, as provided by Windows • The node where the user is logged in. This makes it possible to give a user different authority depending on where he/she is located, e.g. close to the process equipment, in a control room, or at home accessing the system through Internet. • The operation the user wants to perform the operation on.

Server A node that runs one or several Afw Services. It is the part of the software that supply data to a subscriber.

Structure A hierarchical tree organization of aspect objects. Each structure is used to define a certain kind of relation between aspect object. The functional structure defines how a function can be divided into sub functions, the location structure defines how different objects are located within each other. The control structure defines how functions are executed by tasks, controllers etc. An aspect object can be located in several structures, for example both in a functional structure and in a location structure.

System Application

A software package that provides functionality in the Industrial IT System. System applications cooperate according to rules defined by the Industrial IT architecture, using mechanism provided by the Aspect Integrator Platform. They are normally bundled into System Products. To participate in aspect object operations, and thus be an integrated part of an Industrial IT system, a system application must present itself as an aspect system. When there is no risk for confusion with user application, the term application may be used instead of system application.

Table 86. 800xA System Terminology

Term Description

864 3BUF001094R4101

Appendix D Terminology

System Extension

A system Extension consists of one or more applications that are bundled as an extension to one or several existing System Product(s). A System extension can only be installed if (one of) the corresponding System Product(s) has been installed previously.

System Product A system product consists of applications bundled together with relevant parts of the Aspect Integrator Platform. It is complete from installation point-of-view, and requires only Windows 2000. Several System Products can be installed on the same physical node.

Uploader An upload is used to import a configuration from devices, to read in and build a set of aspect objects from information present in the devices.

User application A configuration of software and hardware components that applies to a specific problem, e.g. a specific process control problem. A user application consists of a set of simple and composite Aspect Object instances, with parameter values and other configuration data for the aspects, e.g control logic, process graphics, alarm and event specifications, reports etc.

View An Aspect can have several ways to be presented depending on the task performed, like viewing or configuration. Each presentation form is called a view.

Workplace 1. User interactive functions that are combined for a particular use, e.g, Operator Workplace. 2. A node that runs one or several workplace applications.

Table 86. 800xA System Terminology

Term Description

3BUF001094R4101 865

Appendix D Terminology

866 3BUF001094R4101

INDEX

AABBArray 332ABBGetAttributes 326ABBGetAttributeValue 326ABBGetHistory 319ABBGetObj 303ABBSql 330about button 96ACC Setup 341access name 52Active Zoom 348, 351ActiveX Control 348add-ins 79, 88alarms/events

Industrial IT dialog 198aliases 286, 289Archive

Initialize Media 669Location 664Log Class 568, 662Log Name 568, 663Log Type 662Number of Logs 568, 662Status 568, 663

archivedelete restored logs 709device delay 651initialize media 669publishing 696

archivingmanual (on demand) 677restoring archived logs 696, 701

Area Zoom 382Aspect 861

Category 861

Objects 861Server 862System 862

attribute 410attributes text file 285, 344audit trail 63auto create 281autofit columns 265

BBackward Scope 383batch 488batch to batch 488bulk data export 172bulk format interval 180

Ccalculation 154, 176cell reference 223Citrix 44Client 862client 809color 360, 419COM 862communication settings

channel 273port 273timeout 273

completed report object 525Connectivity Server 862copying tags 413Crystal Reports 42, 516

Ddata

3BUF001094R4101 867

Index

serverconnection 341name 341

data delimiter 423data format 262, 416 to 417data provider 412

name 69trend display 355

data providers 65, 67, 274referencing in client applications 69

data quality 265, 764data server 341data type 356data update rate 361DataDirect 516daylight saving 56daylight saving/standard time transitions 56debug file 273, 278deleting tags 414delimiter 423disable functions 274, 278display server status 71Documentation, On-line 35drag and drop 437drilling 238, 482

Eemail 546, 569enabling macros 88export a file 461export report output 541

completed report object 541Windows file 543

export to file 541

Ffile setup 279font 420format 261FROM 765

functionreadable name 271

function calls 291

Ggeneric_DA 758

Hheaders 262, 264help 95historical values

function call 319history association 804history log calculation 265history object text file 285history update 62history values

Industrial IT dialog 150Inform IT dialog 167

horizontal list 263host 101, 334

Iimport a file 450Industrial IT alarms & events 198Infoarea, Table View 351Information Manager 364insert function 104, 148, 196insert history entries 62Interpolated 356interpolation 56

Llast history value 48limit check 411limits file 346log

name 52restoring archived logs 696, 701

log name 50

868 3BUF001094R4101

Index

long format 264

Mmacros 335menu bar 84message log

batch name 212filtering criteria 211log name 212, 494property,event texts 212search 212sequence name 212tag name 212time range 494type 212unit name 212

message log dialog 202message log options 283message log text file 281, 286modify history entries 62

NNode 863number of values

history 156, 180SQL 251TCL unit array 254

numericlog 763

Oobject name 265object status 186, 189, 314, 323object text file 285object type 129, 410object type text file 285ODA

PDL access 782ODA database 778, 780On-line Documentation 35on-line help 96

OPC 863browser 256, 507Get Entire List 257, 509, 637objects 256, 507

OPC Browserticker 403

OPC browser 633OPC HDA Browser

trend display 378, 403OPC message log 743Open Data Access 753opening trend display 395options 261ORACLE_SID 77ORDER BY 766orientation 261output options 532

Pparameters 535password 101, 334, 342PDL

delete 710dialog 232, 466history 247, 486message 246, 485modify variable 244output results 240resource 245, 484search criteria 234, 477search results 237, 481task type 234, 477variable 244, 483

pdloptions 268

permissions 628pick list 343Plant Explore 863plug icon 108port 277

3BUF001094R4101 869

Index

printing 546printing trend display 396Process Object 863Process Portal A 863process value

function call 303, 326process values

Industrial IT dialog 110Industrial ITdialog 111Inform IT dialog 122, 124

production data 64, 216, 219publish 697published logs access 643, 700, 859

RRaw 356report builder 42, 516reports

test action 627resample 154, 176restore defaults 262restoring archived logs 696, 701retrieval type 153, 171retrieving last history value 48ruler 381Ruler Time 381Ruler Value 381

Ssave settings 101saving trend display 394Scope 383scope 383Seamless retrieval 53seamless retrieval 53, 642Search Criteria is Case Sensitive 272search results 237, 481security 628SELECT 765Server 864

sqlfunction call 330

sql queryad-hoc 250

SQL*Plus 77start cell 103Start Time, MOD Trend 384start-up 94Status, MOD Trend Trace 381Structure 864subscription type 411System Extension 865

TTable View (Info Area) 351tag

adding to ticker file 402configuration 402

tag configuration 402tag explorer 445

operation 459set up 446start-up 446

tag group 446 to 447tag limits refresh 442tag name 409task type 234, 477tcl unit array

ad-hoc 254function call 332

text file 285, 343attributes 285, 344changing selection 280configuring new files 345history object 285object 285, 343object type 285, 343

this client 44ticker 397

browse OPC DA 403

870 3BUF001094R4101

Index

changing defaults 421clear 436configuring ticker files 398error indication 433operation 432start-up 398

ticker fileappearance 415display 432saving 434selecting for display 432

Time Offset 388time out 277, 476time stamp 266time stamp format 266Time Zoom 382tnsname 77toolbar 84trace

enable 367properties 366

Trace Type 386Trend Area, MOD 350trend display

browse OPC HDA 378copy/paste 391description 350launching from tag explorer 464launching from ticker 443operation 376save Html file 394scope 372set-up 353start-up 349

troubleshooting 559

Uuninstalling 93update function references 90update history values

Industrial IT dialog 161update process values

Industrial IT dialog 117updating function references 88upgrade Excel 93user interface 84user name 100, 334username 342UTC time 494

VValue Scale 351value scale 351Value Zoom 382values 254, 331 to 332VBA macro 335version information 442vertical list 263View 865volume 650Volume ID 672Volume label 672volume state 651

WWHERE 765work off-line

tag explorer 446ticker 399

Workplace 865write access 273, 277write history data 62write history values

Industrial IT dialog 161write process values

Industrial IT dialog 117

ZZoom

Active 348, 351

3BUF001094R4101 871

Index

Area 382Time 382Value 382

zoom 351, 383

872 3BUF001094R4101

3BUF001094R4101. Printed in Sweden May 2005 Copyright © 2005 by ABB. All Rights Reserved ® Registered Trademark of ABB. ™ Trademark of ABB.

Automation Technology ProductsMannheim, Germanywww.abb.de/controlsystems

Automation Technology Products Wickliffe, Ohio, USAwww.abb.com/controlsystems

Automation Technology ProductsVästerås, Swedenwww.abb.com/controlsystems

http://www.abb.com