train view archival data viewers

U

GLOBAL

SUPPLIERS

OF

TURBINE

AND

COMPRESSOR

CONTROL

SYSTEMS

A/D

RAM

PID

ID

F

UM5521 Archival Data Viewersuser manual

TrainToolsArchival Data ViewersArchive Reporter, Exporter,

and Viewer Programs

Publication UM5521 (1.0.0)Product Version: 3.1System Release: 5.1

April 2005

4725 121st Street

Des Moines, Iowa 50323, U.S.A.

Phone: (515) 270-0857

Fax: (515) 270-1331

Web: www.cccglobal.com

http://www.cccglobal.com

http://www.cccglobal.com

http://www.cccglobal.com/products.asp

© 2003-2005, Compressor Controls Corporation. All rights reserved.

This manual is for the use of Compressor Controls Corporation and is not to be reproduced without written permission.

Air Miser, Guardian, Recycle Trip, Reliant, Safety On, SureLink, TTC, Total Train Control, TrainTools, TrainView, TrainWare, Vanguard, Vantage, WOIS, and the TTC and impeller logos are registered trade-marks; and COMMAND, TrainPanel, and the Series 5 logo are trademarks of Compressor Controls Corporation. Other company and product names used herein are trademarks or registered trademarks of their respective holders.

The control methods and products discussed in this manual may be covered by one or more of the following patents, which have been granted to Compressor Controls Corporation by the United States Patent and Trademark Office:

4,949,276 5,347,467 5,508,943 5,609,4655,622,042 5,699,267 5,743,715 5,752,3785,879,133 5,908,462 5,951,240 5,967,7426,116,258 6,217,288 6,317,655 6,332,3366,494,672 6,503,048

Many of these methods have also been patented in other countries, and additional patent applications are pending.

The purpose of this manual is only to describe the configuration and use of the described products. It is not sufficiently detailed to enable outside parties to duplicate or simulate their operation.

The completeness and accuracy of this document is not guaranteed, and nothing herein should be construed as a warranty or guarantee, expressed or implied, regarding the use or applicability of the described products. CCC reserves the right to alter the designs or specifications of its products at any time and without notice.

TrainTools Archival Data Viewers

3

Document ScopeThe TrainTools TrainView and Archival Data Utility programs can provide a human-machine interface (HMI) for any process controlled by devices with OPC or Modbus interfaces.

The installation of the TrainTools Software Package and creation of user accounts are discussed in the TrainTools Getting Started [UM5500] manual.

This manual tells how to use the Archive Reporter, Exporter, and Viewer programs to review recorded data on PCs that do not need access to the archival database:

Chapter 1 introduces the TrainTools data archiving system and archival data utility programs.

Chapter 2 tells how to generate archival data reports using the Archive Reporter and Reporter Agent programs.

Chapter 3 tells how to view and print archival data reports using the Archive Reporter program.

Chapter 4 tells how to export archived OPC and AE data using the Archive Exporter program, and describes the resulting files.

Chapter 5 tells how to replay exported data using the Archive Viewer program.

The Archival Data Report Engineering manual [UM5533] tells how to specify the layout and content of such reports and the intervals at which they should be auto-matically displayed, printed, and/or saved.

The TrainView Program operator manual [UM5522] tells how to operate typical TrainView workstations.

UM5521 (1.0.0)

4

Contents

Documentation Conventions

April 2005

The document title appears in the header of each odd-numbered page, while the chapter or appendix title appears in the header of even-numbered pages. Odd-page footers list the document number and revision level [UM5521 (1.0.0)], while even-page footers provide the publication date (April 2005).

Acronyms are defined in the sections of this manual that discuss the corresponding subjects, by placing them in parentheses following the spelled-out terms they represent. As an example, a three-letter acronym (TLA) is a way to represent a three-word subject by com-bining and capitalizing the initial letters of those three words. Most are also listed under Symbols and Acronyms on page 7.

Cross-references to other documents specify a section and chapter, while cross-references between chapters of this document specify a page number. References that do not specify a location are internal to the chapter in which they appear. In computerized versions of this manual, all such references are hot-linked to their target locations and appear in green. Entries in the tables of contents, illustration and table lists, and index are also hot-linked but are not green.

Attention may be drawn to information of special importance by using this text styling or one of the following structures:

Note: Notes contain important information that needs to be emphasized.

Caution: Cautions contain instructions that, if not followed, could lead to irre-versible damage to equipment or loss of data.

Warning! Warnings contain instructions that, if not followed, could lead to personal injury.

The appearance of this electrical hazard warning symbol on CCC equipment or the word Warning appearing in this manual indicates dangerously-high voltages are present inside its enclosure. To reduce the risk of fire or electrical shock, do not open the enclo-sure or attempt to access areas where you are not instructed to do so. Refer all servicing to qualified service personnel.

The appearance of this user caution symbol on CCC equipment or the word Caution appearing in this manual indicates damage to the equipment or injury to the operator could occur if operational proce-dures are not followed. To reduce such risks, follow all procedures or steps as instructed.


5

Table of ContentsDocument Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Documentation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Table of Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5List of Figures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Symbols and Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Archival Data System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Archival Data Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Replaying Archival Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Chapter 2 Generating Process Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Report Generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Reporter Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 3 Viewing Process Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Report Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Viewing Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Scrolling the Current Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Magnifying the Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Viewing Multiple Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Selecting a Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Finding Specific Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Splitting the Viewing Window . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Printing Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Saving Copies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20On-Line Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Program Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Chapter 4 Exporting Archived Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Archive Exporter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

File Compression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Time Range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24File Format and Content. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Exporting Data to Third-Party Programs . . . . . . . . . . . . . . . . . . . . . . 27CSV and XML Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Extracting Zipped Data Sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

UM5521 (1.0.0)

6

Contents

Chapter 5 Replaying Archived Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29Archive Viewer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

Alternate Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30Opening Saved Data Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31On-Line Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32Program Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

Trends Picture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33Printing a Trend Graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36Pen Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37Picture Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

Events Picture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43Printing an Events List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46Invoking the Archive Exporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

List of FiguresFigure 1-1 Archival Data Utility Programs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9Figure 1-2 TrainTools Archival Data Programs. . . . . . . . . . . . . . . . . . . . . . . . . . .10Figure 1-3 Data Flow for Standard TrainView Pictures. . . . . . . . . . . . . . . . . . . . .12

Figure 3-1 Archival Data Report Viewing Window . . . . . . . . . . . . . . . . . . . . . . . .17Figure 3-2 Report Viewer Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

Figure 4-1 Main Window of Archive Exporter Program. . . . . . . . . . . . . . . . . . . . .21

Figure 5-1 Main Window of Archive Viewer Program . . . . . . . . . . . . . . . . . . . . . .29Figure 5-2 Archive Viewer On-Line Help Window. . . . . . . . . . . . . . . . . . . . . . . . .32Figure 5-3 Trends Picture Showing Trend Control Shortcut Menu . . . . . . . . . . . .33Figure 5-4 Events Picture Showing Event Control Shortcut Menu . . . . . . . . . . . .43

April 2005


7

Symbols and AcronymsADaM Archival Data Manager

AE Alarm and Event

ArcCom Archival Communication

CCC Compressor Controls Corporation

CSV Comma Separated Variable (file format)

HMI Human-Machine Interface

HTML HyperText Markup Language (file format)

OLE Object Linking and Embedding

OPC OLE for Process Control

PC Personal Computer

PDF Portable Document Format (file format)

RDF Report Data Format (data file format)

RTF Rich Text Format (file format)

TIF Tagged Image File (bitmap image file format)

TV TrainView program

XLS eXceL Spreadsheet (file format)

XML eXtended Markup Language (file format)

UM5521 (1.0.0)

8

Contents

April 2005


9


Chapter 1 OverviewThis chapter introduces the TrainTools data archiving system and archival data utility programs.

Figure 1-1 Archival Data Utility Programs

Introduction Most TrainTools HMI systems include an archiving function that records the alarms and events and online process data displayed by TrainView Events and Trends pictures. The archival data utility programs extract, save, display, and print data recorded during specified intervals or critical events:

• The Archive Reporter creates, displays, and prints tabulated OPC data reports, and can save them to files for viewing on other workstations or using third-party programs.

• The Archive Exporter program saves AE messages and OPC data to files that can be replayed by the Archive Viewer or opened using various third-party programs.

This manual describes and tells how to use those three programs:

• For an overview of the purpose and capability of each of those programs, read the rest of this chapter.

• If you want to generate predefined archival data reports, use the Run mode of the Archive Reporter program (read Chapter 2).

• If you want to view archival reports saved to reporter data format (RDF) files, use the default View mode of the Archive Reporter program (read Chapter 3).

• If you want to create files that can be replayed by the Archive Viewer, use the Archive Exporter program (read Chapter 4).

• If you want to export data to third party programs, you can use either the Archive Exporter or Archive Reporter (see page 27).

• If you want to review exported data using Trends and Events pictures identical to those of the TrainView program, use the Archive Viewer program (read Chapter 5).

Third-Party Programs

ArchiveViewer

ADaM Files

Report Files

ArchivalDatabase CSV Files

ArchiveReporter

ArchiveExporter

UM5521 (1.0.0)

10

Chapter 1: Overview

Figure 1-2 TrainTools Archival Data Programs

Archival DataSystem

As illustrated in Figure 1-2, the TrainTools data archiving system consists of several interlinked data communication programs:

• The Archival Data Manager (ADaM) records and shares data at the direction of various TrainTools run-time client programs. In particular, the ArcCom program gathers data from various OPC and AE servers and directs ADaM to record it. The PC Commu-nication Engineering manual [UM5532] tells how to specify the data that will be recorded and how long it will be retained.

• The Archive Reporter creates, displays, and prints tabulated and summarized archival data reports, and can save them to files for viewing on other workstations or using other programs. The Reporter Agent automatically invokes the Archive Reporter to execute reporting actions at regular intervals or in response to specified critical events.

This manual tells how to use those programs to generate and view previously-defined reports, as summarized on page 11. The Archival Data Report Engineering manual [UM5533] tells how to define reports and schedule their automatic generation.

• The TrainView program uses Events pictures to list alarm and event messages and Trends pictures to display the variation of process variables over time.

• The Archive Exporter program (which can be invoked from the TrainView program) extracts data recorded during specified time periods and saves it to files that can be reviewed using Archive Viewer Events and Trends pictures or analyzed using various third-party programs. Exporting data also preserves it beyond the configured time at which the Archival Data Manager purges it from its database.

This manual tells how to use those programs to export and review archival data, as summarized on page 12.

Archival DataManager

Third-Party Programs

Archive ViewerPictures

Reporter Agent

Data Files

Report Files

TrainTools

Servers

ArchivalDatabase

AE Servers

OPC/DA

ArcCom

ArchiveReporter

ArchiveExporter

TrainViewPictures

April 2005


11

Archival DataReports

The purpose of the TrainTools archival data reporting system is to provide tabulated and summarized reports of process conditions, at regular intervals and/or in response to critical process changes:

• Each report is generated by an instance of the Archive Reporter program’s Run mode, which is invoked by the Reporter Agent program to print, display, and/or save that report to Windows or UNIX file system locations (see Chapter 2 of this manual).

For example, a report could be saved to a file server HTML or PDF file for viewing via a company intranet. In addition, notices of its generation (and an optional copy of any generated file) can be emailed to specified recipients.

• Reporting actions are specified and scheduled using the Project Builder program (see Chapter 3 of UM5533). The layout file for each report is created using the Archive Reporter’s Edit mode, which is invoked from the Project Builder (see Chapter 4 of the Archival Data Report Engineering manual [UM5533]).

• The program used to open a report file depends on its format:

• RDF (Report Data Format) files can be viewed, printed, and saved to other supported formats using the Archive Reporter program’s View mode (see Chapter 3 of this manual).

• XLS files can be opened and analyzed using Microsoft Excel or a compatible spreadsheet program.

• PDF files can be viewed and printed using the Adobe Acrobat Reader or most other programs capable of opening Portable Document Format files.

• HTML files can be viewed using a web browser or other pro-gram capable of opening HyperText Markup Language files.

• RTF files can be opened by most word processors and other programs capable of importing Rich Text Format files.

• TXT files can be opened by any text editor or other program capable of opening unformatted text files.

• TIF files can be opened using almost any paint program, or imported into documents by any program capable of display-ing Tagged Image Format bitmap files.

One-time reports can be configured and run by invoking the Archive Reporter from the Project Builder program. Alternately, such reports can be created by using a data analysis or reporting program to manipulate files saved by the Archive Exporter.

UM5521 (1.0.0)

12

Chapter 1: Overview

Figure 1-3 Data Flow for Standard TrainView Pictures

ReplayingArchival Data

As discussed in Chapter 2 of UM5522, the TrainView program uses two types of TV Pictures to display process and control system data as it is recorded in the archival database:

• Trends Pictures display the time-varying behavior of OPC data items representing various process conditions.

• Events Pictures display chronological lists of abnormal condi-tions (alarms) and control system transitions (events).

Either can be scrolled back to visually analyze previously-recorded data, and can invoke the Archive Exporter (see Chapter 4) to save portions of that data to files that can be reviewed on any PC:

• Data saved to ADaM native files can be opened only by the Archive Viewer (see Chapter 5), whose user interface consists primarily of a Trends and an Events Picture virtually identical to those in the TrainView operator interface. They can thus be used to replay and visually analyze the exported data. This Events Picture can also invoke the Archive Exporter to extract data sets from any accessible archival database.

• Data saved to comma separated variable (CSV) files can also be replayed using the Archive Viewer, using formatting informa-tion saved in extended markup language (XML) files. The data in those CSV and XML Files (see page 28) can also be:

• formatted into reports using a database program (such as Microsoft Access), or

• analyzed by a spreadsheet program (like Microsoft Excel).

Archived data can also be saved to Excel worksheets using the Archive Reporter program, as discussed on page 27.

CSV & XMLData Files

Archival DataManager TrainView

ArchiveExporter

Third-PartyPrograms

TrendsPicture

EventsPicture

Archive

TrendsPicture

EventsPicture

ViewerADaM Native

Data Files

April 2005


13


Chapter 2 Generating Process ReportsThis chapter tells how to generate archival data reports using the Archive Reporter and Reporter Agent programs.

ReportGenerator

The Report Generator, which has no user interface, is actually an instance of the Archive Reporter program’s Run mode that simply generates a specified report within its program memory, executes specified reporting actions, and then quits:

• Each Print action prints the report to a specified printer using default printer settings specified in the layout file.

• Each Save action saves the report to a specified location in your PC’s network file system, using a specified naming convention and file format, and optionally deletes the oldest such file.

• Each FTP action saves the report to a specified directory of a Unix file server, using a specified naming convention, format, user name and password.

• Each Email action sends a message with a predefined subject to a specified recipient, optionally attaching a report file created using a specified naming convention and format.

• Each View action displays the report by switching the program to its View mode, from which it can be manually printed or saved to one or more files (see Chapter 3).

These actions are defined by one of a specified project’s Reporter Database Branches (see Chapter 3 of UM5533), which is identified by arguments to the command that invokes this program. Those commands are usually issued by the Reporter Agent (see page 15) process, at scheduled intervals or in response to critical events, or by TrainView and Script Engine scripts, in response to operator actions or specified process conditions.

Such commands can also be interactively entered via the dialog displayed by the Start menu’s Run command, or triggered via other interface elements (such as a toolbar icon) set up as described in Appendix B of the TrainTools Getting Started user guide [UM5500]. Each such command must include the following arguments:

-c:run invokes the report generation mode

-p: the absolute path to the project folder

-i: the ID of the Report project database element whose Layout property defines the path to the layout file

-a: specifies the name (e-Mail, FTP, Print, Save, or View) of the desired reporting action’s project database element

-t: a FileTime variable specifying the start time

UM5521 (1.0.0)

14

Chapter 2: Generating Process Reports

If the “-a” argument is omitted, every action defined in the specified Report branch will be executed. If the “-t” argument is omitted, which is usually is, it defaults to the current time minus the report duration.

For example:

reporter -c:run -p:C:\TrainTools\Projects\MyProject -i:1936 -a:Print

would print the archival data report defined by the Print action of Report element number 1936 from the project database in the folder C:\TrainTools\Projects\MyProject, but would not display or save it.

The required Report element ID number can be displayed in the Project Builder program’s status bar by selecting only that element from its Project Tree.

If the TrainTools program folder has not been added to your PC’s PATH environment variable, each such command would have to begin with the full path to its program’s executable file.

Note: A report file is created on the host PC only if an invoked action was explicitly configured to do so.

April 2005


15

Reporter Agent The Reporter Agent is a background process that automatically initiates report actions as defined in a specified project database Reporter branch. It can be configured to do so:

• in response to specified critical events, or

• at one or more specified

• times each day,

• times of specified days of the week, or

• times each hour of every day.

This program must be run on a PC with access to both the project and archival databases, because its operation is configured by the first and it extracts information from the second.

Its only user interface is an icon ( ) that appears in the system tray at the right end of the Windows Taskbar. Right-clicking on that icon displays a shortcut menu (shown at left) from which you can view the program’s About dialog or shut down this program to stop the automatic generation of reports.

The following procedure will configure the desired PC to automati-cally start this program when a certain user logs into Windows:

Step 1: Create a shortcut to the Reporter Agent’s executable file (\Program Files\Compressor Controls\TrainTools\repa.exe) within the \Start Menu\Programs\Startup folders of that user’s Documents and Settings folder.

Step 2: Right-click on that shortcut, select the Properties command, and click on the Shortcut tab of the resulting dialog:

Step 3: Move the cursor to the right edge of the Target field, click the left mouse button, then press the End key to position the text cursor at the very end of the specified executable file path.

UM5521 (1.0.0)

16

Chapter 2: Generating Process Reports

Step 4: Add the following command line arguments:

-p: the absolute path to the project folder for the engineering project that defines the desired reporting actions

-i: the project database ID of the Report element whose child elements define those actions

No spaces are allowed between any argument keyword and its value. For example:…repa.exe” -p:C:\TrainTools\Projects\MyProject –i:123

would initiate the automatic generation of all reports defined by Reporter element number 123 from the project database in the folder C:\TrainTools\Projects\MyProject.

Step 5: Click the OK button to save the specified command line within that shortcut file and close its Properties dialog.

This program will abort and display the following error message if the shortcut used to invoke it does not specify an accessible project whose project database includes the specified Reporter element or if you try to start it by double-clicking its executable file:

It accesses the project database to determine what reports to run and when only when it is first started. Thus, any changes you make to the specified Reporter branch of that database while the Reporter Agent program is running will not take effect until that program is shut down and restarted.

April 2005

TrainTools Archival Data Viewers 17


Chapter 3 Viewing Process ReportsThis chapter tells how to view and print archival data reports using the Archive Reporter program.

Figure 3-1 Archival Data Report Viewing Window

Report Viewer The Report Viewer, which is actually an instance of the Archive Reporter program running in its View mode, displays and can print or export reporter data format (RDF) reports to other types of files. No access to the project or archival database or report layout files are needed.

Launching this program from the Windows graphical user interface (by selecting Programs -> TrainTools -> Archive Reporter from the Start menu, for example) opens an empty Report Viewer window. Any accessible report can then be opened using the File -> Open… command to display the following file selection dialog:

Once a report has been opened, the only way to close it is to open a different one or close the program using the File -> Exit command.

Menu BarToolbar

Report Viewing Area

UM5521 (1.0.0)

18 Chapter 3: Viewing Process Reports

Figure 3-2 Report Viewer Toolbar

Viewing Reports Each report is initially displayed with the upper-left corner of its first page visible at 100 percent magnification. The scroll bars and tool-bar buttons can then be used to display other pages, change the displayed area or magnification of the current page, switch between single or multiple page view, or search for specified text within the reported data.

Scrolling theCurrent Page

You can view different portions of the current page by dragging either scroll button; left-clicking in a scroll bar to scroll by one screen width or height; right-clicking in either scroll bar to display a scrolling menu; or dragging any spot in the viewable area of the report to a different screen position (as indicated by the hand shape of the mouse cursor when it is within the report area).

Magnifying theWindow

The Zoom Percentage tool indicates the magnification at which the current page is being displayed. You can change that setting by clicking on it to select from a list of standard magnifications, click on the Zoom In or Zoom Out tool to select the next higher or lower of those standard magnifications, or type the desired magnification (in percent) into the Current Zoom field and press the Return key.

Viewing MultiplePages

Clicking on the Multiple Pages tool displays a small grid of six page icons. Moving the cursor over one of these selects a rectangular group of them, at which point clicking again would display a group of sequential report pages arranged in the same pattern (for example, you can display two rows of three pages). Clicking the Single Page tool will then restore the full-size display of only the current page. You can also toggle between the single and last-specified multiple page views by double-clicking within the viewable area of the report.

Selecting a Page The Current Page field indicates which page is being displayed and the number of pages in the report. You can display the previous or next page by clicking the corresponding arrow tool. You can also display a specific page by typing the page number in the Current Page field and pressing the Return key. You can also display a dif-ferent page by double-clicking on the report to switch to the multiple-page view, then double-clicking on the desired page.

You can sequentially return to previously viewed pages by clicking on the Move Backward arrow tool. If you have, you can reverse that process by clicking on the Move Forward arrow tool.

April 2005


Finding SpecificData

You can search for specific data values within the report by clicking on the Find tool to display the following dialog:

Type the text string you want to search for in the Find what field and click on the Find Next button (or press the Return key). You can specify case-sensitive, whole-word-only, and/or forward or reverse searching by clicking on the corresponding options.

Splitting theViewing Window

If you drag down the horizontal splitter control located at the top of the vertical scroll bar (as shown to the left), the report viewing area will be split into two windows that have independent rulers, scroll bars, and magnifications:

The upper window initially displays the page you were viewing, while the lower displays the upper-left corner of the first page. The toolbar buttons initially apply to the upper window, but either can be activated by clicking within its viewing area.

You can close the upper window by dragging the splitter control back to the top of the viewing area, or close the lower window by dragging that control to the bottom of the viewing area.

UM5521 (1.0.0)

20 Chapter 3: Viewing Process Reports

Printing Reports You can print the displayed report by clicking on the Print tool, which will display a standard Windows printing dialog.

Although this program does not provide a Page Setup command, the Print dialog for most printers will provide ways to override the report’s default printer settings, which are defined in the layout file from which it was generated.

Saving Copies To save a copy of the open report to any supported type of file:

Step 1: Select the File -> Save As… command to display a standard Windows Save As dialog:

Step 2: Navigate to the drive and folder to which you want to save the new report file.

Step 3: Select the desired file format from the Save as type field (see page 11).

Step 4: Type the desired File name (do not include the filename extension, which will be automatically added based on the selected file type) and then click on the Save button.

On-Line Help Selecting Help -> Contents or pressing the F1 key displays this pro-gram’s online help file, which briefly describes its toolbar buttons.

Program Version Selecting the Help -> About Reporter command displays an About dialog that identifies the installed version of this program and the TrainTools and Total Train Control releases it was included in. Click-ing on that dialog’s Version Info button displays a list of all installed TrainTools programs and other components.

April 2005



Chapter 4 Exporting Archived DataThis chapter tells how to export archived OPC and AE data using the Archive Exporter program, and describes the resulting files. It also discusses the relative merits of using the Archive Exporter or the Archive Reporter to extract recorded data (see page 27).

Figure 4-1 Main Window of Archive Exporter Program

ArchiveExporter

The Archive Exporter program saves all data recorded during a specified period of time (usually one encompassing a critical event) to files that can be moved to and reviewed on computers with no access to the project and archival databases, using either the Train-Tools Archive Viewer (see Chapter 5) or third-party spreadsheet and database programs. This allows such data to be analyzed and formatted into reports, and preserves it beyond the time at which the Archival Data Manager purges it from its database.

The specified data is always saved to a folder within the source project’s Export folder, from which it can be copied or moved to any desired location. The automatically-generated name of that folder indicates the data’s start time (YYMMDD_HHMM representing the YearMonthDay_HourMinute) and duration.

This program can be launched from the Windows user interface, but is more often invoked from the shortcut menu of a TrainView Events or Trends Picture. In that case, the data’s source is automatically selected and its time range is set from within the TV picture (see Exporting Data from an Events Picture and Exporting Data from a Trends Picture in Chapter 2 of UM5522), so the exporter program only needs to display its main window (Figure 4-1).

That window looks like a dialog that indicates and lists any critical events in the specified time range, displays the path to the folder the

UM5521 (1.0.0)

22 Chapter 4: Exporting Archived Data

data will be saved to, and allows you to type a Comment that will be displayed by the Archive Viewer’s file open dialog (see page 31).

Click on the Save button to export the specified data in the default ADaM native format, or on the Advanced button to view and option-ally change any data export option (clicking on that dialog’s Back button returns you to the main window). Messages and bar graphs narrating the export process will then appear in the Status Bar at the bottom of the main window. When the message “Export Completed Successfully” appears, you can close the program by clicking the Cancel button or save another set of data (if using revision 3.0.2.2 or later, otherwise you must close and restart the exporter program to successfully export additional sets of data).

When this program is launched from the Windows user interface or invoked from the Events Picture of the Archive Viewer, three dialogs are displayed before the main window appears, from which the data’s source and time period must be specified:

Step 1: Specify the desired archival database by double-clicking on its parent TrainTools project in the first dialog:

The projects within your PC’s default Projects Folder are listed by default, but you can display those in other directories (on the same or a different computer) by clicking on that field’s Browse button ( ), selecting the desired projects folder in the resulting folder selection dialog, and clicking on its OK button.

Step 2: The second dialog will then appear, from which you must specify the start time and date for the exported data:

April 2005


The Time Range section indicates the period for which archived data is available, expressed relative to the time zone selected for the archival PC (as indicated by the Time Presentation field). You can select any date within that range from the Select Date calendar (today is circled and initially selected), and any time by selecting the hour, minute, or seconds portion of the suggested Select Time field and typing a new value or using the arrows to ramp it. That date and time are indicated in the menu at the top of the dialog, which might also list previously specified times.

Click the OK button to accept your specified “From” date and time (which can be changed later, see Time Range on page 24).

Step 3: The identical third dialog will then appear, from which you must specify the end time and date for the exported data. Click its OK button to accept your specified “To” date and time.

The program’s main window will then appear, from which you can optionally view and change the export parameters and then save the specified data as previously described.

File Compression The Advanced dialog’s General tab allows you to specify whether the exported files should be compressed into a Zip file that can but need not be segmented into multiple files of a specified size:

A compressed data set (which is the default) requires less disk space and is easier to copy, but opens somewhat slower from the Archive Viewer.

The Split Zip into Multiple Files option is useful if the data set needs to be transferred via small portable drives (floppies or USB thumb drives, for example) or emailed via a system that limits the size of included files. However, you must use the techniques discussed under Extracting Zipped Data Sets on page 28 to make the data in such zip files available to third-party programs.

UM5521 (1.0.0)


Time Range The Advanced dialog’s Time Range tab allows you to change the beginning and end times for the exported data and their time zone:

You can change the time range by clicking on:

• either the From or To button to set the corresponding time using the selection dialog shown on page 22, or

• the Select Critical Event button to display the following dialog:

Double-clicking on any entry will then set the start and end times equal to those of the corresponding archived critical event.

You can select any of three potentially-different time zones from the Time Presentation menu:

Archive Original : time zone of the archival PCPC Local : time zone of the extracting PC

Universal (GMT): zero-meridian (Greenwich, England) time zone

This setting affects only the time ranges displayed and file names generated by this program. All exported data will be time-stamped relative to UTC/GMT no matter which option is chosen.

April 2005


File Formatand Content

The Advanced dialog’s Content tab allows you to specify whether the exported data should be saved in database or text files:

• The default ADaM Native Format saves all data recorded during the specified time range to a database that can be opened only by the Archive Viewer (see page 29).

• The Text Format exports some of that data to comma separated variable files (see below and CSV and XML Files on page 28).

If the Text Format option is selected, some data can be omitted from the exported files by:

• Clicking the Specify Tags button to display this dialog, from which any listed OPC data groups and items can be deselected:

Unless a large percentage of the listed data items are omitted, opening the resulting Text Format files with the Archive Viewer will take much longer than opening an ADaM Native database.

• Clicking the Specify Filters button to display the following dialog, which can be used to define the criteria specified fields of each

UM5521 (1.0.0)


alarm or event message (see Events Picture on page 43) must satisfy to be included in the exported messages file:

• Each event’s Type can be required to equal or not equal the keyword ALARM or EVENT.

• Each message’s Group or Priority can be required to be equal to, not equal to, less than, greater than, less than or equal to (not more than), or greater than or equal to (not less than) a specified integer value.

• Each event’s State can be required to be ON or OFF. Each alarm’s State can be required to be CLEAR, ACTIVE, ACKN, UNACKN, DISABLED, or ENABLED.

• Each alarm or event’s primary language Message, Source, or Dest(ination) or secondary language Message2, Source2, or Dest2 field can be required to be equal or not equal to; to be alphanumerically before, after, not before, or not after; or to start with, end with, or include a specified text string.

• Each message’s unused Value field should not be used as a basis for filtering.

Within each criterion, all keywords and text string values are case-insensitive; all spaces, tabs, and newlines are insignifi-cant; and the comparison operators are represented as:

You can also require a field’s value to be within a specified range by typing a criterion of the form: value operator field oper-ator value [for example: 1 <= Priority < 5]. The two operators can only be any combination of less than and less than or equal to, or of greater than and greater than or equal to, as no other combination would make sense [for example, it would make no sense to specify 1 = Priority > 5).

The value a text field is compared to must be enclosed in quota-tion marks [for example: Source = “UIC 1”]. Any quotation marks within that string must be preceded by a backslash [for example: “He said \”Hi\”.”], as must any literal backslash [for example, the

= or == : equal to< : less than> : more than

<> or != : not equal to<= : less than or equal to>= : more than or equal to

April 2005


folder path C:\TrainTools must be specified as “C:\\TrainTools”]. Consecutive digits are treated and compared as numbers [for example, the test “UIC 2” < “UIC 10” is TRUE because 2 is numerically less than 10]. The following inclusion operators can also be applied to text fields:

INFIX(field, “string”) :field includes specified string

PREFIX(field, “string”) :field begins with specified string

SUFFIX(field, “string”) :field ends with specified string

To require that two or more criteria must all be met, separate them using AND operators [for example: Type = Alarm AND State = Active AND Priority < 5]. To require that only one of them must be satisfied, separate them using OR operators [for example: Type = EVENT OR State = Active]. If the expression has both AND and OR operators, parentheses must be used to dictate their evaluation order [for example: (Type = EVENT AND State = ON) OR State = Active].

You can specify that a parenthetical test must fail by preceding it with the NOT operator [for example: NOT (Source = ”UIC 1”) would exclude messages whose source was UIC 1].

The validity of the filtering expression can be evaluated at any time by clicking the Check Syntax button. However, this check will not flag syntactically correct yet impossible criteria, such as (3 < Group < 2) or (State = Active AND State = Clear).

The Trend and Event Control Configuration fields at the bottom of the Content tab list all Trends Picture pen group and Events Picture text color definition files defined in the source project, which the Archive Viewer can use to format its Trends Picture (see page 37 and page 44). Any not needed can be omitted by unchecking them.

Exporting Datato Third-Party

Programs

If you want to export data to Microsoft Excel or another third-party program, you can use either the Archive Exporter or Reporter:

• The Archive Exporter can export OPC and AE data for any time period encompassed by the archival database (as described in this chapter), but cannot downsample that information. If a given variable was recorded every 10 milliseconds, the exported file will include all of those values.

• The Archive Reporter can export downsampled OPC data to a spreadsheet or text file, but that process (see Chapter 2 of the Archival Data Report Engineering manual [UM5533]) is cumber-some and it is difficult to specify a reporting period that does not extend up to the time at which the report is generated.

UM5521 (1.0.0)


CSV and XMLFiles

The Text Format option (see File Format and Content on page 25) exports the data set to the following comma separated variable (CSV), extended markup language (XML), and plain text files.

add.csv : each text line conveys the values of the analog and discrete data items listed in its header line at a date and time specified in its first two fields

message.csv : each text line conveys all fields of an alarm or event message (see page 43), in the order indicated in its comma-separated header line

filter.txt : filter expression used to select those messagesarchive.xml : conveys the time zone of the archival PC and a list of

exported data items and their rangessummary.xml :conveys the time range and other information dis-

played in the Archive Viewer’s Open and Information dialogs (see page 31)

TVEvent##.xml :conveys one set of Events Picture text and back-ground colors (see page 44)

TVTrend##.xml :conveys one set of Trends Picture pen groups and their formatting properties (see page 37)

Extracting ZippedData Sets

CSV data files saved to unsegmented zip archives can be extracted using any decompression utility (WinZip, for example). Extracting such data from multipart zip files is a little more difficult, because Archive Exporter program uses a non-standard convention for set-ting their filename extensions (for historical reasons):

• The standard employed by most compression utilities names the first segment of a multi-part zip archive X.z01, the last X.zip, and any between them X.z02, X.z03, and so on.

• The naming convention employed by TrainTools programs, which predates the standard, names the first segment X.zip and the following segments X.z02, X.zo3, and so on.

When extracting the files from a multipart Archive Exporter zip file, try using your compression utility’s File -> Open command to open the last segment. Or, change each segment’s filename extension to conform to the more common standard. For example, assume the data set was saved to four files named X.zip, X.z02, X.z03, and X.z04, where X is something like 050210_0500+6hours. To unzip them, open X.z04 or change the name of X.zip to X.z01 and then change the name of X.z04 to X.zip.

Files renamed in this manner cannot be opened using the Archive Viewer program, but the folders you extract from them can.

In addition, any zipped data set can be opened using the Archive Viewer, whose View -> Message CSV or Analog/Discrete CSV File command can then be used to open either file using the NotePad accessory program (see page 30)

April 2005



Chapter 5 Replaying Archived DataThis chapter tells how to replay exported data using the Archive Viewer program.

Figure 5-1 Main Window of Archive Viewer Program

Archive Viewer The Archive Viewer program displays the AE messages and OPC online data within the ADaM Native or CSV and XML files saved by the Archive Exporter (see Chapter 4), without requiring any access to either the project or archival database files.

This program’s user interface is shown in Figure 5-1:

• Various actions can be initiated by selecting commands from the menus that drop down from the Menu Bar. Positioning the cursor over one of these will usually display a brief description of it in the Status Bar, which can be alternately hidden or displayed by the View -> Status Bar command.

• The Toolbar provides iconic buttons for some menu commands. It can be hidden or displayed by the View -> Toolbar command.

• The Trends Picture (see page 33) displays the time-varying behavior of recorded process conditions.

• The Events Picture (see page 43) displays a chronological list of abnormal conditions (alarms) and transitions (events).

Both pictures have shortcut menus whose commands manipulate their displays, and the Trends Picture also has its own tool bar. The Events Picture’s Export command invokes the Archive Exporter.

ToolbarMenu Bar

Events

Trends

Splitter

Picture

Picture

Status Bar

UM5521 (1.0.0)

30 Chapter 5: Replaying Archived Data

The main window can be resized using basic Windows techniques, while the relative heights of the Trends and Events Pictures can be changed by dragging the splitter between them.

The two pictures can be independently scrolled to display data from different time periods. Clicking on the Trender --> Events Sync tool ( ) then scrolls the lower picture to list events recorded during the time frame of the plotted data. Conversely, selecting an event and then clicking the Events --> Trender Sync tool ( ) scrolls the trend graph to display process data coinciding with that event.

If the open data set includes any critical events, both pictures can be scrolled to display data and messages from the corresponding time period by selecting one of those events from the dialog displayed by the View -> Critical Events command or its tool ( ):

Provided the data was exported using the Text Format option (see File Format and Content on page 25), the raw OPC or AE data can be displayed in a Windows NotePad window by selecting the View -> Analog/Discrete CSV File or Message CSV File command.

To close this program, select the File -> Exit command.

AlternateLanguage

A few element’s of this program’s user interface can be displayed in either of two languages, provided their corresponding properties were defined in the source project:

• Selecting the Options -> Primary Language command displays the pen labels defined by the pens’ Label properties and the messages defined by the alarms and events’ Text, Source, and Destination attributes.

• Selecting the Options -> Secondary Language command dis-plays the pen labels defined by the pens’ Label SL properties and the messages defined by the alarms and events’ Text SL, Source SL, and Destination SL attributes.

• Clicking on the Language tool ( ) alternates between the pri-mary and secondary language character strings.

April 2005


Opening SavedData Sets

Any accessible data set created by the Archive Exporter can be opened by selecting the File -> Open command or clicking its tool ( ), which displays the following dialog (which is also displayed when this program is first launched):

Select either Zip Files or Directories from the Files of Type menu, depending on whether or not the exported files were compressed to a Zip archive (see File Format and Content on page 25), then navi-gate to and open the desired data set’s folder:

• If you specified Zip Files and there is one in the folder, click on its file name to select it and display its summary information.

• If you specified Directories and the folder contains ADaM Native or CSV and XML files, its summary information should appear.

Click the Open button to display the data from the open folder or selected zip file.

The summary information includes the time range of the data set, the date and time it was exported, and any comment specified at that time (see page 21). The Archive Exporter does not currently provide Project and Customer information.

After a data set has been opened, the information can be viewed by selecting the View -> Information command or clicking its tool ( ), which displays it in a window similar to that below:

UM5521 (1.0.0)


Figure 5-2 Archive Viewer On-Line Help Window

On-Line Help The following commands open this program’s on-line help window:

• Selecting Help -> Contents, pressing the F1 key, or clicking the Help tool ( ) displays an outline of the help file in the left pane. Double-clicking on an entry displays the corresponding help page in the right pane.

• Selecting Help -> Search displays the search window shown to the left in the left pane. Typing one or more words in the words to search for field and clicking the List Topics button displays a list of matching help file pages. Double-clicking a topic displays the corresponding page of the help file in the right pane.

Once the help window is open, you can switch modes by clicking on the tabs at the top of the left pane.

Program Version Selecting the Help -> About ArcView command displays an About dialog that identifies the installed version of this program and the TrainTools and Total Train Control releases it was included in. Click-ing on that dialog’s Version Info button displays a list of all installed TrainTools programs and other components.

April 2005


Figure 5-3 Trends Picture Showing Trend Control Shortcut Menu

Trends Picture Each Trends Picture displays a Trend Graph that plots the time-varying behavior of the recorded OPC variables in a selected Pen Group, and the following optional elements:

• a Legend that allows you to select from a list of available Pen Groups and identifies and lists the current value of the variable plotted by each of its Pens,

• a Status Bar that identifies the period during which the displayed data was recorded, and

• a Toolbar whose icons invoke shortcut menu commands, which configure and manipulate the picture’s operation.

The legend can be alternately displayed or hidden by selecting the Show Legend command or clicking its tool ( ), which will appear pushed-in when the legend is visible. Its width can be modified by dragging its right edge. The toolbar and status bar can be hidden via the corresponding picture settings (see page 41).

The width of the graph represents the period of time during which the visible data was recorded, which is referred to as the Current Interval. The sampling times of the oldest and newest plotted data are shown in the first and fourth panes of the status bar, while the second displays their difference (2.0 minutes in Figure 5-3). The length of the current interval can be changed by selecting the Time Window command or clicking its tool ( ) to display this dialog:

You can choose one of the six predefined intervals ranging from ten

Pen Group

Toolbar

Legend

Status BarStart Time End TimeTime Span

UM5521 (1.0.0)


seconds to one hour, or click the Custom option and select the inter-val’s units and type its magnitude (no more than an hour).

Each variable has a configured range, within which its values are plotted relative to a customizable portion of the graph’s height (see page 40). Clicking a legend entry selects the corresponding pen and displays a grid of vertical and horizontal lines whose spacing is a property of that pen or its parent group:

• Each horizontal grid line is labeled (on the left) with the corre-sponding value of the selected variable.

• Each vertical grid line is labeled (at the top) with the correspond-ing data sampling time.

Selecting a pen also positions the brackets ( ) in the vertical scroll bar to indicate its variable’s range, which can be changed by drag-ging those brackets to new positions. Double-clicking a variable’s entry in the legend hides and redisplays the corresponding pen. The range brackets can be hidden and redisplayed via the correspond-ing picture setting (see page 41).

Any critical events triggered during the displayed interval are indi-cated by vertical dotted lines. Clicking the yellow caution rectangle near the top of any such line displays a brief summary of that event:

When the newest data is visible at its default resolution, the Play tool ( ) will appear pushed-in. Any of the following actions will cause the Pause tool ( ) to appear pushed in instead, and display a vertical midline through the middle of the graph and the correspond-ing sample time in the second pane of the status bar:

• Selecting the Zoom Out command or clicking its tool ( ), which will display twice as much data by halving the resolution.

• Selecting the Zoom In command or clicking its tool ( ), which will display half as much data by doubling the resolution.

• Zooming in on any portion of the graph by double-clicking a position corresponding to its starting time (a dashed vertical line will appear) and then double-clicking at its ending time.

• Selecting the Back command or clicking its tool ( ), which will display data recorded one sixth of a sampling period earlier.

• Selecting the Page Back command or clicking its tool ( ), which will display data recorded a full sampling period earlier.

April 2005


• Selecting the Forward command or clicking its tool ( ), which will display data recorded one sixth of a sampling period later.

• Selecting the Page Forward command or clicking its tool ( ), which will display data recorded a full sampling period later.

• Selecting the Goto command or clicking its tool ( ), either of which will display the following dialog for specifying the current interval’s end time:

The Time Range section indicates the period for which archived data is available. You can select any date within that range from the Select Date calendar (today is circled and initially selected), and any time of day by selecting the hour, minute, or seconds portion of the suggested Select Time and either typing a new value or using that field’s arrows to ramp the suggested time. That specified date and time are indicated first in the menu at the top of the dialog, which will also list any previously gone to. Click the OK button to scroll to and select the alarm or event posted nearest to the specified time.

• Selecting the Critical Events command or clicking its tool ( ), then double-clicking the desired event in the resulting dialog to center the graph about that event’s trigger time:

After using any command that scrolls or zooms the graph, selecting the Play command or clicking its tool ( ) will remove the midline, restore the configured time window, and redisplay the newest data. Selecting the Pause command or clicking its tool ( ) has no effect other than to display the midline and its label.

UM5521 (1.0.0)


Printing a TrendGraph

You can print the displayed graph by selecting the Print command or clicking its tool ( ) to display the print preview window:

The data curves can be printed in their configured pen colors or all in black by clicking either the Color Mode ( ) or Black and White Mode tool ( ). You can also toggle the ratio of the graph’s width and height between those of the original graph or the paper’s print-able area by clicking the Preserve Screen Ratio tool ( ).

Clicking the Page Setup tool ( ) displays the dialog for setting the print out’s paper size, orientation, and margins:

You can reposition the preview window by dragging its title bar. If you vary its size (by dragging its lower-right corner or its bottom or right edge), its scale is adjusted accordingly. Clicking the Zoom In tool ( ) halves that scale to show less of the page in more detail,

April 2005


while clicking the Zoom Out tool ( ) doubles the scale to show more of the page in less detail.

Each curve is labelled at several locations horizontally, as set by the sliding Label Separation tool, and the labels of adjacent curves are offset. The scale of each curve is indicated by a table along the left edge, which provides the value of each variable corresponding to each horizontal grid line. This is shown by the following enlarged and rotated lower portion of our sample preview:

When satisfied with the previewed graph, click its Print tool ( ) to display the standard Windows Print dialog.

Pen Settings The Trends Picture’s pen groups and their pens (plotted variables) are specified by selecting a configuration from the Trend menu, which lists all Trend format files in the data set (see page 25). The pen groups defined by that file can then be added to, deleted, or modified from the Pens Settings dialog, which can be displayed by selecting the Pens command or clicking its tool ( ):

• Selecting a pen group from the Group menu displays a list of its pens and their properties. Clicking the Add Pen button adds a new row to that pens table, with its Label field set to New Pen. The listed pen properties can be edited, as discussed below.

UM5521 (1.0.0)


• Clicking the Edit Group button (or right-clicking on the selected group in the legend and selecting the Properties shortcut com-mand) will display the properties dialog for the selected group:

• Clicking the Add Group button displays the same dialog, with New Group as the suggested Label. Typing and selecting the desired property values and clicking the OK button adds the specified pen group.

• Clicking the Delete Group button displays a confirmation dialog asking if you are sure you want to delete the selected group. If you click its Yes button, that pen group will be unavailable until the Trends Picture is restarted.

Each pen group has the following properties:

• Label and Label SL define the primary and secondary language names the Group menu displays for that group.

• Ordinal specifies the group’s position in the pen group menu. Groups with equal Ordinal properties are sorted in the order they were added.

• Time Axis Spacing Method and Value define its vertical grid:

• If the None option is picked, no vertical gridlines are shown.

• If the Fixed Number option is picked, Value sets the number of equally-spaced vertical gridlines that will be shown.

• If the Pixel Interval option is picked, Value specifies the spac-ing between vertical gridlines in screen pixels.

• If the Time Interval option is picked, Value specifies the spac-ing between vertical gridlines in hours:minutes:seconds.

• Spacing Method, Value, and Extend Grid specify default Scale Axis gridlines for its pens (see page 40).

Pen properties can be set via the fields in the Pen Settings dialog’s pens table. To facilitate such editing, the width of that dialog can be increased (by dragging its right edge) and the pen properties table (except for its Label column) can be horizontally scrolled. Right-clicking on almost any property value converts it to an editable field.

April 2005


Clicking on an Archive Tag or Color field displays a dialog button ( ) that will to display the corresponding dialog (see below).

Alternately, each pen’s properties can be set by right-clicking on its entry in the legend and selecting the Properties shortcut command to display this dialog:

Each pen has the following properties:

• Label and Label SL define the primary and secondary language names the legend displays for that pen.

• Enabled specifies whether that pen’s line will be plotted within the trend graph. This property can also be toggled on and off by double-clicking on a pen entry in the legend.

• Color is selected from the following dialog:

Clicking the Define Custom Colors button displays a standard Windows color selection dialog.

UM5521 (1.0.0)


• Archive Tag specifies the pen’s OPC data item, which is picked from an expandable hierarchy of the data set’s OPC variables that is displayed by this dialog:

• EU and default Min and Max specify the engineering units and transmitter range of the corresponding variable.

• Display Min and Max specify the range of values that will be plotted, and Bracket Low and High (which can also be set by dragging the controls to the right of the graph when the pen is selected) specify the portion of the vertical axis that range will be mapped to. Extend Grid specifies whether or not the vertical gridlines will extend above and below those brackets.

If Low and High are set to 0 and 50, for example, values less than or equal to Min are plotted at the bottom of the graph and values equal to or greater than Max are plotted halfway up.

• Precision sets the number of decimal digits the legend will include when displaying that variable’s value.

• Spacing or HGrid Method and Value specify the horizontal grid-lines that will be displayed when the pen is selected:

• If the None option is picked, no horizontal gridlines are drawn.• If the Fixed Number option is selected, Value sets the number

of equally-spaced horizontal gridlines that will be shown. • If the Pixel Interval option is selected, Value specifies the hor-

izontal gridline spacing in screen pixels.• If the EU Interval option is selected, Value specifies the hori-

zontal gridline spacing relative to Display Min and Max.• If the Use Group’s Setting option is picked, the parent pen

group’s Scale Axis Spacing Method and Value properties specify which of the above methods is used.

• Ordinal specifies the pen’s legend position. Pens with equal Ordinal properties appear in the order they were added.

April 2005


Picture Properties The appearance and operation of the Trends Picture are configured by options listed in its tabbed properties dialog, which is displayed by selecting the Properties command.

Settings The Settings tabs of the property dialog has three sections:

• The Appearance options specify whether various portions of that picture should be shown or hidden:

Toolbar : provides same functionality as shortcut menu

Statusbar : indicates when displayed data was recorded, as do the vertical gridline labels

Brackets : indicate range of selected pen variable, as do the horizontal gridlines

Legend : key to the plotted variables and their pen colors

The Show Legend property can also be toggled on and off by selecting the Show Legend shortcut command or clicking its tool ( ), which will appear pushed-in when the legend is visible.

• The selected Time Presentation option specifies the time zone the timestamps of the recorded data should be converted to:

• Universal(GMT)—the time along the zero-meridian (which passes through Greenwich, England)

• PC Local—the time at the Archive Viewer PC’s location

• Archive Original—the time at the archival PC’s location

• The Language section can be used to override the program’s language setting (see Alternate Language on page 30):

• It normally indicates that setting (primary or secondary).

• Clicking the other option changes this picture’s language with-out changing that of the program. Subsequently clicking the Same as Client’s option or changing the program’s language setting resynchronizes them.

Clicking the Pen Settings button invokes the pen settings dialog (see page 37).

UM5521 (1.0.0)


Font The text font used by the Trends Picture can be viewed or changed via the Font tab:

Select the desired type face from the Font menu, select or type in the desired type size, and check or uncheck any desired stylizations (Bold, Italic, Underline, and Strikeout). The Sample Text field will display the name of the typeface using those specified options.

Color The basic color scheme for the Trends Picture can be viewed or changed via the Color tab:

The box next to each listed color property shows its assigned color, which can be changed by selecting a different one from the Color Palette (which in turn can be selected from the Color Set menu) or by clicking the Edit Custom Color button to display the standard Windows color specification dialog:

• BackColor sets its background color.

• GridColor sets the color of the vertical (time access) gridlines and their labels.

The horizontal (scale axis) gridlines are labeled using the color of the selected pen.

April 2005


Figure 5-4 Events Picture Showing Event Control Shortcut Menu

Events Picture The Events Picture presents a list of all alarm and event messages recorded in the open data set (oldest at the top). The following infor-mation is provided for each such message:

• Character string pairs that identify the Event or alarm condition (such as an input failure or shutdown), its Source (such as the tag for a failed transmitter or surging compressor), and its Desti-nation (such as the field terminals a failed input is connected to), each expressed in either of two languages.

• An word indicating the alarm or event’s integer State:

0 : Clear (alarms) or Event(-)1 : Active (alarms) or Event(+)2 : Ackn (acknowledged)3 : Unackn (unacknowledged)4 : Disabled5 : Enabled

• The Time at which that State changed.

The shortcut menu’s Milliseconds command specifies whether this time is reported to the nearest millisecond or second, its Time Only command specifies whether it includes the date.

• An integer Priority indicating the seriousness of the alarm or event. Our priority conventions are:

0 : hardware alarms1 : shut-down/trip alarms2 : all other standard application alarms4 : all standard application events

• An integer Group that might have been used to associate and filter groups of alarms or events.

UM5521 (1.0.0)


Each message’s text and background colors depend on its priority, and are specified by selecting a configuration from the Event menu, which lists all Event formats in the data set (see page 25).

The width of each field can be changed by dragging the ruling line along the right edge of its heading. If the program’s window is not wide enough to display the full width of all fields, a horizontal scroll bar will appear along its lower edge.

If all of the messages in the open data set cannot be displayed, a vertical scroll bar will appear along the right edge of the picture. You can then scroll the list using that scroll bar, or by pressing the PgUp, PgDn, Home, or End key:

• If the Auto Scrolling shortcut command is toggled off, the portion of the list you scroll to will continue to be displayed until that command is toggled back on.

• Otherwise, scrolling away from the newest entries will toggle the Pause command on for sixty seconds, after which the picture will automatically scroll down to the bottom of the list. Toggling Pause off immediately redisplays the newest events.

Clicking on any message selects it, after which pressing the up or down arrow key will select the next or previous one and scroll the list if needed to display it. Pressing either key when no event is selected selects the last or first displayed event, respectively:

• Selecting the Copy command copies the fields of the selected event to the Windows clipboard as a tab-delineated text line.

• Clicking the Events --> Trender Sync tool ( ) scrolls the Trends Picture to display process data coinciding with the selected event.

The fields of all visible messages can be copied to the clipboard as tab-delineated text lines by selecting the Copy Page command (you can first resize and scroll the window to display only the messages you want to copy).

You can scroll to the event posted closest to a specified time using the Go To command, which displays this dialog:

April 2005


The Time Range section indicates the period for which archived data is available. You can select any date within that range from the Select Date calendar (today is circled and initially selected), and any time of day by selecting the hour, minute, or seconds portion of the suggested Select Time and either typing a new value or using that field’s arrows to ramp the suggested time. That specified date and time are indicated first in the menu at the top of the dialog, which will also list any previously gone to. Click the OK button to scroll to and select the most nearly matching alarm or event.

If the open data set includes any critical events, the portion of the events list corresponding to any one of them can be displayed by:

Step 1: Selecting the Critical Events command to display a dialog listing the available critical event records:

Step 2: Selecting the desired event and clicking the OK button.

You can locate alarms and events that meet specified criteria by selecting the Find shortcut command to display this dialog:

Click the box for each desired criterion and then type or select:

• all or part of the Source, Message, and/or Destination text you want to find, according to the Match Case, Match Whole Text, and Language options you specify;

• the desired alarm State; and

• the desired integer Priority or Group value.

Each time you click the Find Next button, the control will select the next or previous table row (depending on the specified Direction)

UM5521 (1.0.0)


that matches the specified criteria. Once those search criteria have been defined, you can also search for matching events by selecting the Find Next command.

Printing anEvents List

You can print a specified range of the listed events by:

Step 1: Selecting the Page Setup shortcut command to display the dialog for setting the paper size, orientation, and margins:

Step 2: Selecting the first of the desired events and selecting the Print or Export From shortcut command.

Step 3: Selecting the last of the desired events and selecting the Print or Export To shortcut command.

Step 4: Selecting the Print shortcut menu command to display the Windows Print dialog.

Invoking theArchive Exporter

You can invoke the Archive Exporter (see Chapter 4) to extract data sets from any archival database your PC has access to by selecting the Event’s Picture’s Export shortcut command.

April 2005



IndexA Alarm and Event Message Fields . . . . . . . . . . . . . . . . . . . . . . . 43

ArcCom Program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Archival Data Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Archival Data ReportsEmailing Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Engineering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Exporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20File Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Generating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–16Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13, 20Saving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Viewing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13, 18–19

Archival Data System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Archive ExporterCompressing Exported Files . . . . . . . . . . . . . . . . . . . . . . . . . 23Filtering Exported AE Messages. . . . . . . . . . . . . . . . . . . . . . 25General Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21–23Invoking From Archive Viewer . . . . . . . . . . . . . . . . . . . . . . . 46Invoking from TrainView . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Invoking from Windows GUI . . . . . . . . . . . . . . . . . . . . . . 21–23Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Selecting OPC Data Items . . . . . . . . . . . . . . . . . . . . . . . . . . 25Specifying File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Specifying Time Range . . . . . . . . . . . . . . . . . . . . . . . . . . 22, 24Time Presentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Archive ReporterEdit Mode (Report Layout Editor) . . . . . . . . . . . . . . . . . . . . . 11Program Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Run Mode (Report Generator) . . . . . . . . . . . . . . . . . . . . 13–14View Mode (Report Viewer) . . . . . . . . . . . . . . . . . . . . . . 17–20see also: Report Viewer

Archive ViewerAlternate Language. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Events Picture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43–46General Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29–30Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Opening Data Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Program Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Trends Picture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33–42see also: Events Picture, Trends Picture

UM5521 (1.0.0)

48 Index

C Critical Event Reports — see: Archival Data ReportsCritical Events

Automatic Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13, 15Events Picture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Trends Picture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34, 35Viewing in Archive Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . 30

E Emailing Archival Data Reports . . . . . . . . . . . . . . . . . . . . . . . . 13

Engineering Archival Data Reports. . . . . . . . . . . . . . . . . . . . . . 11

Events PictureFinding Specific Information . . . . . . . . . . . . . . . . . . . . . . . . . 45General Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43–46Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Scrolling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Exported Data SetsCompressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23, 28CSV and XML Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28File Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Opening with Archive Viewer . . . . . . . . . . . . . . . . . . . . . . . . 31Saving. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21–27Specifying Time Range . . . . . . . . . . . . . . . . . . . . . . . . . 22, 24Summary Information . . . . . . . . . . . . . . . . . . . . . . . . . . . 21, 31Viewing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29–46Zip Archives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23, 28see also: Archive Exporter

Exporting Archival Data Reports. . . . . . . . . . . . . . . . . . . . . 13, 20

F File Compression — see: Zipped Data SetsFile Formats

Archival Data Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Exported Data Sets . . . . . . . . . . . . . . . . . . . . . . . . . 12, 25, 28

Finding Specific DataArchival Report Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Events Picture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

G Generating Archival Reports. . . . . . . . . . . . . . . . . . . . . . . . 13–16

L Language SettingArchive Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Trends Picture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

O Online HelpArchive Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Report Viewer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Operating Report, Automated — see: Archival Data Reports

April 2005


P PrintingArchival Data Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . 13, 20Events List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Trend Graphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Program VersionArchive Reporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Archive Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Project Builder Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

R Report Generator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–14

Report ViewerExporting Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Finding Specific Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19General Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Printing Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Viewing Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18–19

Reporter Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–16

S Saving Archival Data Reports . . . . . . . . . . . . . . . . . . . . . . . 13, 20

Shift Reports, Automated — see: Archival Data Reports

T Time PresentationArchive Exporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Trends Picture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

TrainView Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10, 12

Trends PictureAlternate Language. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Font and Colors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42General Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33–35Hiding Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Modifying Pen Settings . . . . . . . . . . . . . . . . . . . . . . . . . . 37–40Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Time Presentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

V Viewing Archival Data . . . . . . . . . . . . . . . . . . . . . . . . . . 12, 29–46

Viewing Archival Data Reports . . . . . . . . . . . . . . . . . . . 13, 18–19

Z Zipped Data SetsCreating. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Extracting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

UM5521 (1.0.0)

50 Index

April 2005

U

October 2000 FM73 (2.0)

FM73

Please help us evaluate the quality of this publication by completing and returning this survey. If you have comments concerning a specific page, please include a copy of that page with your comments marked on it.

Yes No

1. Was the document organized in a logical manner? ❒ ❒

2. Was the information clear and easy to understand? ❒ ❒

3. Was there enough information? ❒ ❒

4. Were the illustrations clear and easy to understand? ❒ ❒

5. Were there enough illustrations? ❒ ❒

6. Was the cross-referencing of information adequate? ❒ ❒

7. Could you find what you were looking for in a reasonable period of time? ❒ ❒

8. Did you find the Table of Contents to be useful? ❒ ❒

9. Did you find the Index to be useful? ❒ ❒

How would you rate the overall usability of this document?

❒ Excellent ❒ Good ❒ Average ❒ Fair ❒ Poor

Name

Title

Dept.

Company

Street

City

State Zip

Phone

Document Evaluation FormPublication Title: TrainTools Archive Reporter Program User Manual

Publication No.: UM5521 (1.0.0) Publication Date: April 2005

a

COMPRESSOR CONTROLS CORPORATION

Technical Documentation Department4725 121st StreetDes Moines, Iowa 50323-9906

Fold Along Dotted Line

BUSINESS REPLY MAILFIRST CLASS MAIL PERMIT NO. 7515 DES MOINES, IOWA

POSTAGE WILL BE PAID BY ADDRESSEE

Please Fasten Here With Tape — Do Not Staple

NO POSTAGENECESSARY

IF MAILEDIN THE

UNITED STATES