pi-based historian with controlst* software suite

GEH-6744B

PI-based Historian withControlST* Software SuiteSystem Guide

For public disclosure

These instructions do not purport to cover all details or variations in equipment, nor to provide for every possiblecontingency to be met during installation, operation, and maintenance. The information is supplied for informationalpurposes only, and GE makes no warranty as to the accuracy of the information included herein. Changes, modifications,and/or improvements to equipment and specifications are made periodically and these changes may or may not be reflectedherein. It is understood that GE may make changes, modifications, or improvements to the equipment referenced herein or tothe document itself at any time. This document is intended for trained personnel familiar with the GE products referencedherein.

GE may have patents or pending patent applications covering subject matter in this document. The furnishing of thisdocument does not provide any license whatsoever to any of these patents.

This document is approved for public disclosure.

GE provides the following document and the information included therein as is and without warranty of any kind, expressedor implied, including but not limited to any implied statutory warranty of merchantability or fitness for particular purpose.

For further assistance or technical information, contact the nearest GE Sales or Service Office, or an authorized GE SalesRepresentative.

Revised: Jul 2014Issued: Jun 2009

Copyright© 2009 – 2014 General Electric Company, All rights reserved.___________________________________* Indicates a trademark of General Electric Company and/or its subsidiaries.All other trademarks are the property of their respective owners.

We would appreciate your feedback about our documentation.Please send comments or suggestions to [email protected]

For public disclosure

mailto:[email protected]

Contents1 Chapter 1 Overview.......................................................................................................................... 51.1 Data Collection and Storage.......................................................................................................................71.2 PI-based Applications...............................................................................................................................81.3 Related Documents ..................................................................................................................................91.4 Acronyms and Abbreviations .....................................................................................................................9

2 Chapter 2 Installation .................................................................................................................... 112.1 PI-based Application Installation .............................................................................................................. 112.1.1 Installing PI-based Application .......................................................................................................... 112.1.2 Installing the PISMTSetup CD .......................................................................................................... 152.1.3 Installing the PI OPC Interface .......................................................................................................... 182.1.4 Installing the PI Enterprise Data Access .............................................................................................. 202.1.5 Installing the PI Combo.................................................................................................................... 222.1.6 Installing OPC Historical Data Access (HDA) ...................................................................................... 252.1.7 Configuring the DCOM Default Users ................................................................................................ 26

2.2 Installing Historian Reports ..................................................................................................................... 28

3 Chapter 3 Configuration ............................................................................................................... 293.1 Setting Excel Options ............................................................................................................................. 293.2 Setting PI ProcessBook Options ............................................................................................................... 333.3 Time Synchronization Configuration ......................................................................................................... 353.4 Historian Archives ................................................................................................................................. 363.4.1 Data Compression ........................................................................................................................... 373.4.2 PI Point Database............................................................................................................................ 373.4.3 Adding Archives............................................................................................................................. 39

3.5 WorkstationST Historian ......................................................................................................................... 413.5.1 Configuring Historian ...................................................................................................................... 413.5.2 Configuring Variables for Data Collection............................................................................................ 453.5.3 Configuring Historian Reports ........................................................................................................... 503.5.4 Configuring Continuous Data Storage ................................................................................................. 613.5.5 Archive Backup Management............................................................................................................ 63

3.6 Backup of Historical Data ....................................................................................................................... 663.6.1 PI Backup Procedure ....................................................................................................................... 663.6.2 Storing PI Archives ......................................................................................................................... 683.6.3 Restoring Offline PI Archives............................................................................................................ 68

3.7 Historian Report Configuration ................................................................................................................ 693.8 Variable Aliasing ................................................................................................................................... 693.9 Upgrading an Existing Historian System for Variable Aliasing ....................................................................... 72

4 Chapter 4 User Guide .................................................................................................................... 734.1 PI-based Server Tags .............................................................................................................................. 734.1.1 Importing Tags ............................................................................................................................... 73

4.2 Deleting or Renaming a Variable from the PI-based Historian ........................................................................ 764.3 PI ProcessBook ..................................................................................................................................... 794.3.1 Creating and Configuring Preferences ................................................................................................. 794.3.2 Creating a ProcessBook Entry ........................................................................................................... 86

GEH-6744B System Guide 3For public disclosure

4.3.3 Tag Search..................................................................................................................................... 894.3.4 Sample Trend ................................................................................................................................. 92

4.4 Working with ToolboxST Trender ............................................................................................................. 94

5 Chapter 5 Troubleshooting.......................................................................................................... 995.1 Verifying Data Flow............................................................................................................................... 995.1.1 Report Configuration Errors .............................................................................................................1045.1.2 Automatic Report Generation Errors ..................................................................................................104

Index.......................................................................................................................................................105

4 GEH-6744BFor public disclosure

1 Chapter 1 OverviewThe PI-based Historian is a data archival system, based on OSIsoft™ PI client-servertechnology. It provides data collection and storage of power distribution and auxiliaryprocess data for display in the WorkstationST* application. It can be configured forturbine-related data and balance of plant (BOP) process data.

The Mark* VIe and Mark VI controllers use the Ethernet Global Data (EGD) unit datahighway (UDH) as the communications network between individual turbine unitcontrollers and system operator components, as well as Human-machine Interfaces(HMI).

Note On a Historian computer, the default drive E:\docs contains customerdocumentation.

The Historian system comes with a standard upgradable original equipment manufacturer(OEM) license, which is required for a functional Historian. The OEM server has limitedconnections. There are six interface licenses, which can be used to collect and place datain the Historian system. The normal interface is an OLE for Process Control Data Access(OPC® DA) client to the WorkstationST OPC DA server installed on the same computeras the OSI® PI application. The system can be connected to six different OPC DA servers,including six power blocks with independent OPC DA servers.

There is a 10-client connection limit on the OEM software license. A client connection isrequired any time a PI ProcessBook® or PI DataLink® connects to the Historian. If morethan 10 client connections are required, there is an upgrade to a 25-client connection.

The OSIsoft OPC DA/HDA server is also supplied with the OEM PI-based server. Thelicense is based on the number of client connections to OPC DA/HDA server of two, 10,or 25 connections. With the OPC DA/HDA server, the ToolboxST* Trender can retrievehistorical data from the OSI PI server and the WorkstationST Recorder through theWorkstationST application installed on the Historian computer. The OPC HDAconnection only retrieves the data. Two connections can support multiple Trenders. Thisfeature is available in WorkstationST version 3.2 and above.

The PI ProcessBook application displays trends of the historical data, which can betimed-based or cross plots of two tags. Graphic screens can also be created using theHistorical tags. The PI DataLink allows the use of historical data in third-partyapplications such as Microsoft Excel®.

Chapter 1 Overview GEH-6744B System Guide 5For public disclosure

System Data Flow from Controllers to the Historian

The WorkstationST application allows the local computer to obtain data from allconsumed EGD devices through the OPC DA server. The local computer, through theWorkstationST application and the EGD configuration server, automatically receivesupdates for any configuration change to EGD variables. The OPC DA server providescommunication between the HMI and Mark VIe components, as well as theCIMPLICITY* application, ToolboxST Trender, and PI-based applications. The PI-basedOPC interface receives its data from the WorkstationST OPC DA server, and passes it tothe PI-based server. The PI-based server compresses the data, based on user-definedcompression settings, and stores it in the PI-based archives.


1.1 Data Collection and StorageThe Historian communicates on a plant data highway (PDH) and a unit data highway(UDH). Supervisory data is exchanged between Historian and operator stations,engineering workstations, and printers on the Information Network in redundant ornon-redundant configurations. Data is sent from components on the UDH using EGDprotocol to the OPC DA server on WorkstationST computers. The PI-based OPC interfaceconnects the PI-based System to the WorkstationST OPC DA server. The PI-based OPCinterface does not need to be installed on the same computer as the PI-based application.

Note Further setup is required to configure the WorkstationST application and PI-basedapplications if the PI-based OPC interface and the PI-based server are on separatecomputers.

The PI-based Historian OPC interface samples data from control systems on the controlnetwork once per second. Data values and time stamps originate in the controller. Foralarms, events, and sequence of events (SOE), data is received on an exception basis.Since time synchronization is essential for determining the root cause of an event, the datacan be synchronized to ±1 ms time accuracy between a controller and local time server or±2 ms time coherence between control systems.

The PI-based application stores data in a series of archives. As each archive fills, the datarolls over to the next archive until all archives are full. The oldest archive is thenoverwritten. Exception data is stored by the alarm server in files matching the exceptiondata type: alarm, event, SOE, holds, or diagnostics.

The actual amount of data storage available in the archives depends on the data exceptionand compression settings. Tighter deadbands produce increased data storage and looserdeadbands have less data storage.


1.2 PI-based ApplicationsThe PI System Management Tool (SMT) allows you to connect to multiple PI-basedservers and manage much of the PI-based application. If multiple collectors are used,various plug-ins are used to run the system. Using the SMT application, you can verifythe validity of the archives, check disk space for archived variables, run PI-based systembackups, connect to multiple servers, and check other issues within the PI-basedapplication.

PI ProcessBook displays real-time and historical data. Users can create custom screensand write scripts to automate displays and trends with Microsoft Visual Basic, which isintegrated into PI ProcessBook. OSIsoft also offers other software tools for data analysis.PI ProcessBook is licensed to run on the Historian system. A second license is included torun PI ProcessBook on an HMI. Additional PI ProcessBook licenses can be purchased asneeded.

PI ProcessBook can trend any variable stored in the PI-based server. It is fullyconfigurable and can auto-range the scales or set fixed indexes. For accurate read outs,the trend cursor displays the exact value of all variables trended at a given time. The PIProcessBook can be set up to mimic strip chart recorders, analyze the performance ofparticular parameters over time, or help troubleshoot root causes of a turbine fault.

PI DataLink provides a connection between the PI system and Microsoft Excel to createreports and perform complex data analysis in a familiar environment. Through Excel, youcan import, export, and manipulate data from different PI-based servers.


1.3 Related Documents• GEH-6422, Turbine Historian System Guide

• GEI-100628, WorkstationST Historian

• GEI-100752, Historian Report Configuration

• GEI-100753, Historian Report Post-installation Instruction Guide

• GEA-S1218, Mark VIe ICS - Historian Fact Sheet

• GEA-S1230, ControlST Embedded Short-term Historian Fact Sheet

• GHT-200027, How to Analyze Historical Alarm Data Using the WorkstationSTAlarm Viewer - Offline Mode

1.4 Acronyms and AbbreviationsBOP balance of plant

EGD Ethernet Global Data

EMT Ethernet Global Data Management Tool

HMI Human-machine Interface

OEM Original Equipment Manufacturer

PDH plant data highway

SOE sequence of events

UDH unit data highway


Notes


2 Chapter 2 Installation2.1 PI-based Application Installation

Attention

The PI-based application is typically pre-installed on theHistorian system.

2.1.1 Installing PI-based ApplicationThe CDs required for installing the PI-based application (in the order below) are asfollows:

1. OEM-GE-HST-MASTER Timeout CD

2. PISMT Setup CD

3. PI OPC interface CD

4. PI Enterprise Data Access CD

5. PI Combo CD

6. PI OPC Historical Data Access (HDA)

7. PI SDK CD

Chapter 2 Installation GEH-6744B System Guide 11For public disclosure

2.1.1.1 Installing the OEM-GE-HST-MASTER Timeout

�� To install the OEM-GE-HST-MASTER Timeout.exe

1. Place the OEM-GE-HST-MASTER Timeout CD in the CD-ROM drive. Locate thedocs folder and copy all files, then paste the files in E:\Docs.


2. When theWinZip Self-Extractor dialog box displays, click the Unzip button.

3. Click OK. The PI Server Setup wizard displays.

4. When the installation is complete, click OK.


2.1.2 Installing the PISMTSetup CD�� To install the PISMTSetup.exe

1. When theWinZip Self-Extractor dialog box displays, click Unzip to display thePI System Management Tools Setup wizard.


2. When the installation is complete, restart your computer.


Note If the temporary license expiration date does not display, contact the nearest GESales or Service office of an authorized GE Sales representative.


2.1.3 Installing the PI OPC Interface�� To install the PI OPC Interface.exe

1. Place the PI OPC interface CD in the CD-ROM drive. Locate the NTI folder andrun the Setup.exe file.

2. Locate C:\Pi\adm and run the pisrvstop.bat file. A command prompt allows youto stop the applications.

3. When the batch file is finished, click Retry. If some processes are still running, openthe Task manager and end the applications.

4. From theWelcome wizard, click the Next button.


5. Restart the computer.


2.1.4 Installing the PI Enterprise Data Access�� To install the PI Enterprise Data Access

1. Place the PI Enterprise Data Access CD in the CD-ROM drive.

2. When theWinZip Self-Extractor dialog box displays, click the Unzip button.

3. When the next two screens display, click Next and Finish.

4. From the CD, locate the PIODBC folder and run the PIODBC_1.2.0_.exe file. The PIODBC – Installation Folder dialog box displays.


5. Keep the default destination folder and click Next.


2.1.5 Installing the PI Combo�� To install the PI combo

1. Place the PI combo CD in the CD_ROM drive.

2. From theWinZip Self-Extractor dialog box, click the Unzip button.


3. Click OK in all screens until the installation is complete.

4. From theWinZip Self-Extractor dialog box, click the Unzip button.


5. Click OK in all wizards until the installation is complete, then restart the computer.


2.1.6 Installing OPC Historical Data Access (HDA)The OPC HDA application allows other computers on your network to access thearchives. This software is required so that the ToolboxST Trender can retrieve historicaldata from the PI server.

�� To install the OPC HDA application

1. Place the PI OPC HDA CD in the CD-ROM drive and run the OSIOPC_1_2_6_0_.exe file.

2. When the installation is finished, restart the computer.

�� To configure the OPC HDA server to run as a service

1. From the Start menu, select Run.

2. Enter cmd in the text box and press Enter. The command prompt window displays.

3. From the command prompt, enter C:\program files\PIPC\PI_OSIOPC and pressEnter.

4. From the command prompt, enter PI_OSIHDA.exe /regserver and press Enter.

Note This procedure registers both the OPC HDA server and the OPC DA server. TheOPC DA server must be unregistered to continue.

�� To unregister the OPC DA server

1. From the command prompt, enter C:\program files\PIPC\PI_OSIOPC and pressEnter.

2. From the command prompt, enter PI_OSIOPC.exe /unregserver and pressEnter.


2.1.7 Configuring the DCOM Default Users�� To configure the DCOM default users

1. From the Component Services dialog box, right-clickMy Computer and selectProperties. TheMy Computer Properties dialog box displays.


2. From the My Computer Properties dialog box, Launch Permissions area,click the Edit Default button. The Launch Permission dialog box displays.

3. FromMy Computer Properties, click the Edit Limits button to enable allpermissions. Click OK and restart the computer.


2.2 Installing Historian ReportsHistorian Reports allows you to generate periodic and real-time reports using thehistorical data.

�� To install the Historian Reports

Select the His to r ian Repo r tscheck box and click Ins tal l .

Attention

When the installation is complete, the post-installationprocedures must be performed. Refer to GEI-100753,Historian Report Post-installation Instruction Guide.


3 Chapter 3 Configuration3.1 Setting Excel Options

�� To install Excel

♦ From the Start menu, select All Programs,Microsoft Office, andMicrosoftOffice Excel 2007.

Chapter 3 Configuration GEH-6744B System Guide 29For public disclosure

3.2 Setting PI ProcessBook Options�� To set the PI ProcessBook options

♦ From the Start menu, select All Programs, PI System, and ProcessBook. ThePI ProcessBook screen displays.


3.3 Time Synchronization Configuration�� To synchronize time between the HMI and the Historian

1. From the Start menu, select Control Panel and Date and Time. Click the TimeZone tab.

2. Verify that all system computers are set to the correct time zone and local time.

3. Verify that all configured HMI times are set in the .tcw file (refer to GHT-200021,How to Configure Time Synchronization in the ToolboxST Application).

4. On the Historian, locate C:\PI\Dat and rename localhost.tz to localhost.tzold.Changing the file name and restarting the PI server recreates the PI time zone file.

Note This is only required when the time zone of the local Historian is changed.


3.4 Historian ArchivesArchives are created as fixed length files and initially contain no data. They are locatedon the history disk in the pi_arch directory, typically D:\PI_ARCH on the computer withHistorian installed. The archives are named PIARCH.nnn, where nnn equals a three-digitnumber that increments for each new archive. The typical archive size is 128 MB. PIarchives use roughly 75% of the history disk. The total number of available archivesdepends on the size of the history disk.

All new archives must beregistered with the PI-basedsystem.

Refer to the PI-based Server System Management Guide, Chapter 3 for more information.

On a computer with the Historian system installed, this document is located by default at

E:\Docs\PiServerSystemManagementGuide.pdf

�� To view a list of registered archives

1. From the Command Prompt, enter cd /d c:\pi\adm and press Enter.

2. Enter piartool –al >c:\temp\piarclist.txt and press Enter.

3. Enter notepad c:\temp\piarclist.txt and press Enter.

When the Historian system isinitially installed, all availablearchives are registered bydefault. To view a list ofarchives, run the piartoolprogram, with the parameter –al. The piartool program islocated in the C:\PI\ADMdirectory.

The list of registered archives displays in Notepad in reverse chronological order with theprimary archive listed first. Each archive listed has the associated Start Time and EndTime. The archive with a valid Start Time (such as 5-Nov-98 05:37:48) and the valueCurrent Time for the End Time, is the primary archive and should be the first archivelisted. An archive with a valid Start Time and a valid End Time was previously theprimary archive. Archives with the value Current Time for the Start and End Times havenot had data written to them and are therefore currently empty.

Applications residing on the Historian system are the interface between the controllersand the PI-based system, and are responsible for adding data to the PI-based system. ThePI-based system shifts from the current primary archive to the next available archive(making it the new primary archive) when an archive reaches its size limit. This nextavailable archive is either an empty archive or the oldest used archive (if an empty one isnot available). The PI-based system uses these archives in a circular queue. All data in theregistered archives is available to PI-based and GE clients.


3.4.1 Data CompressionThe PI-based system has a real-time database controlled by the PI Snapshot subsystem,and a Historian archives controlled by the PI-based data archive subsystem. Theapplication programs that write data to the PI-based system are configured to readcontroller variables from the OPC DA server once per second. Each variable value iscompared to the previous value written to the PI system for that variable. If the value haschanged by the variable’s exception deviation (EXCDEV), that variable’s value is writtento the PI Snapshot database. The PI Snapshot database saves every variable that is passedto it in the Snapshot.

Whenever a variable is passed into the PI Snapshot, the PI-based data archive subsystemdetermines if that value should be saved in the archive or discarded. The filter betweenthe application and the PI Snapshot is based on the exception deviation (EXCDEV) value,which is used as a deadband.

Historical filtering determineswhether a variable value isarchived or discarded.

The filter between the PI Snapshot and the PI-based data archive is based on the slope ofthe value, or the first-time derivative of the value. PI uses the compression deviation(COMPDEV) in a swinging door compression algorithm to determine the current slope ofthe value. If the previous value written falls outside that slope, it is saved in the PI-baseddata archive subsystem. This greatly reduces the number of samples saved because itfilters on the derivative of the value, not on the value itself.

The exception deviation is a deadband on the value, but the compression deviation is adeadband on the slope. More precisely, the value of COMPDEVequals the furthestdistance away from the projected slope available without saving another value (therebyprojecting a new slope).

3.4.2 PI Point DatabaseThe PI Point Database defines and configures the variables that it maintains. Thisdatabase can be created either by running an interactive tool or by using a batchprocessor. The batch processor (PICONFIG) is distributed as part of the normal PIdistribution.

3.4.2.1 Naming ConventionsIn the Historian, a unit name and a variable uniquely identify values. This scheme allowsunit definitions to be duplicated easily by only changing the unit name. The design of thedatabase requires that each tag name be unique. In the old standard for the PI-basedapplication, two or four letters unit names were recommended, with a colon separating theunit name from the point name. The variable is a simple string. The Historian uses theunit’s controller name concatenated with a period and the variable name to uniquelyidentify each tag, for example T1.TNH is the tag name for unit T1 speed point.

Note The PI-based server does not accept a backslash in the variable name. A backslashis replaced with an underscore when the variable is configured in the PI-basedapplication.


3.4.2.2 ASCII Variable Definition File – PICONFIG.DIFThe PICONFIG.DIF file, which is used as the input to the PICONFIG program, is aninstance of a generic table modification data file, and contains instructions for thePICONFIG program. It lists the current table and the format of input data being used.When building a Historian in the WorkstationST application, your PICONFIG.DIF file isautomatically updated and imported to the system.

3.4.2.3 Importing the Data File

Attention

The WorkstationST Historian automatically creates thisfile and imports it into the PI-based configuration utilitywhenever a change is made to the Historianconfiguration.

Note The following procedures are not required unless specified by a technician.

The PI-based server must be running to import the PI-based configuration input file. Thefile is treated as input to the PICONFIG program. The file can be imported through theWorkstationST application or by using one of the following methods:

• Command line interactive

• Command line with input redirected

• Command line with input and output redirected

�� To run command line interactive

1. From the Windows Command Prompt, enter cd /d c:\pi\adm and press Enter.

2. Enter piconfig and press Enter. Piconfig runs and a piconfig prompt displays.

3. Enter the command@INPUT f:\piconfig.dif and press Enter.

4. Enter the command@EXIT and press Enter.

�� To run Piconfig with input redirected

1. From the Command Prompt, enter cd /d c:\pi\adm and press Enter.

2. Enter PICONFIG <f:\piconfig.dif and press Enter. The Piconfig application runsusing f:\piconfig.dif as the standard input.

3. If the PICONFIG.DIF file does not have an@EXIT command at the end, enter@EXIT, and exit the program.


�� To run command line with input and output redirected

1. From the Command Prompt, enter cd /d c:\pi\adm.

2. Enter PICONFIG <f:\piconfig.dif >f:\piconfig.log and press Enter. The Piconfigprogram runs using f:\piconfig.dif as standard input, and f:\piconfig.log as standardoutput.

Note The output from the Piconfig program (status and error messages) is redirected tothe log file.

3. If the PICONFIG.DIF file does not have an@EXIT command at the end, enter@EXIT and exit the program.

3.4.3 Adding Archives�� To add archives

♦ From the Start menu, select All Programs, PI System, and ManagementTools. The PI System Management Tools dialog displays.


3.5 WorkstationST HistorianThe WorkstationST Historian is a feature of the WorkstationST application that allowsyou to configure supported third-party Historians to collect long-term data from thesystem components. The third-party Historian’s OPC® client is configured to read thedata from the WorkstationST OPC Data Access (DA) server. The collected data isaccessible through the ToolboxST Trender as well as the third-party Historian’s dataaccess applications. The WorkstationST Historian supports the GE Intelligent PlatformsProficy-based Historian and the OSIsoft PI System* products. This feature allows you to:

• Configure storage of all data available through the WorkstationST OPC DA server

• Automatically configure variables with a defined Historian Deadband

• Override pre-configured variables

• Add non-configured variables

• Configure Historian reports

• Configure Archive Backup Management

3.5.1 Configuring HistorianRefer to GEH-6706, ToolboxSTUser Guide for WorkstationSTApplication, the chaptersSystem Configuration andWorkstationST ComponentEditor for information oncreating and editingcomponents.

AWorkstationST component is required for the computer that has the third-partyHistorian software installed. The WorkstationST Historian is configured through theHistorian tab on the WorkstationST component. Variables that have a Historian Deadbandand valid EGD page defined are automatically configured for data collection for eachconsumed device. For Mark Vand local WorkstationST variables, only the HistorianDeadband must be defined. Refer to GEH-6700, ToolboxST User Guide for Mark VIeControl, the chapterMark VIe Component Editor for information on configuringvariables.

Note At least one WorkstationST component must be configured as the EGD ConfigServer for the system.


�� To enable the Historian feature

♦ From ToolboxST System Editor, double-click the WorkstationST component.

From the General tab, select Features.

Select His to r ian and set the Enab led column to True.

Select OPC DA Server and set the Enab led column to True.

The His to r ian and OPC DA Servertabs display.


�� To configure the HistorianConsumed devices and theirHistorian variables are addedto the Consumed Device Liston the Historian tab.

1. From the OPC DA Server tab, select OPC DA Server and change theMaximumClient Rate to a value that divides evenly into 1000 (for example, 250) but is lessthan 1000 ms.


Note Refer to GEH-6706, ToolboxST User Guide for WorkstationST Application, thechapterWorking Online With WorkstationST for information on creating measurementsystems.

2. From the toolbar, click Build.

3. Click the Download button to download the application to the WorkstationSTruntime. TheWorkstation Download Wizard displays.

Note Refer to GEH-6706, ToolboxST User Guide for WorkstationST Application, thechapterWorking Online With WorkstationST for information on using the WorkstationSTDownload Wizard.


Downloading the workstation configures the third-party Historian and restarts datacollection using the new configuration. Data configured for a collection can be viewed byselecting a component from the Consumed Device list in the Historian tab Tree View.

Data configured for acollection can be viewed byselecting a component from theConsumed Device list in theHistorian tab Tree View.

Once the Historian is downloaded, further downloads are only required if configurationchanges are made on the Historian Workstation (for example, add a variable for collectionon the Historian tab, modify a parameter on the OPC DA Server tab, or add a new Featuresuch as Alarm Server). When a variable in a ToolboxST component that the Historianconsumes has its Historian Deadband defined and the component is saved (the componentdoes not need to be downloaded), the Historian Feature in WorkstationST runtime isnotified of the change. The variable is configured in the third-party Historian, and datacollection is enabled.

3.5.2 Configuring Variables for Data CollectionAvariable is configured for collection if its Historian Deadband property is defined andits EGD Page property is assigned. For Boolean variables, the deadband property must bechanged from Not Logged to Logged on Change. When the data value for a Booleanvariable changes, the data value is stored by the Historian. For variables with numericdata types, the deadband property must be changed from Not Logged to a non-negativenumber. When the data value for a numeric data type variable changes by the definedHistorian deadband, the value is written to the Historian. The Historian’s archivealgorithm determines when a value is stored.

If a variable’s Format Specification property is defined, the Format SpecificationEngineering Min and Engineering Max are used to configure the Historian’s display andengineering limits, and are used when converting data from one measurement system toanother. The Format Specification Units and Precision properties are used to configure theHistorian’s engineering units and precision properties.

Note Defining the variable’s Display Low Limit, Display High Limit, Units, and/orPrecision overrides the Format Specification Engineering Min, Engineering Max, Units,and Precision properties at configuration time.


3.5.2.1 Component ConfigurationWhen a device is added as a consumed device, all historian variables from that device areconfigured in the target historian upon a successful build and download. The defaultbehavior is to use the component's configuration of historian variables. However, thisbehavior can be modified if the user wants to ignore the default configuration and selectthe variables to store in the target historian.

�� To ignore the default configuration for a device


3.5.2.2 Modifying Data CollectionModifications to variable properties should be done where the variable is defined (forexample, at the User Block, Program or Task Definition in a Library). If that is notpossible, variable properties related to data collection can be modified under theConsumed Device List on the Historian tab.

�� To modify the data collection of a variable

♦ After modifying the configuration, click the Build and Download buttons.

Note If you delete information from any field that can be edited for a variable markedOverridden, the value of the field reverts to its original value.


Historian Variable Properties

ConfigurationCategory

Description

Overrides Displays the list of properties that are overridden on the variable

Source Represents the current configuration owner

Component configured for long-term data storage in the device

Overridden configured for long-term data storage in the device but modified locally

UserDefined not configured for long-term data storage in the device but added and

configured locally

Format Category Description

Display High Limit Used to calculate Percent of Range. If a Format Spec is specified and this property is not specified,the Format Spec Engineering Max is used.

Display Low Limit Used to calculate Percent of Range. If a Format Spec is specified and this property is not specified,the Format Spec Engineering Low is used.

Format Spec Assigned to a variable. These are system-owned specifications unique for each measurementsystem and grouped into sets. Properties of the Format Spec that can be used by the Historian areEngineering Min, Engineering Max, Precision, and Units.

Precision The number of digits to display to the right of the decimal point. If a Format Spec has been specifiedand this is not specified, the Format Spec Precision is used. If neither is specified, 0 is used.

Units The variable’s engineering units. If a Format Spec has been specified and this is not specified, theFormat Spec Units is used. If neither is specified, it is left blank.

General Category Description

Alias Customer-assigned variable name

Description Variable description

Device Device to which this variable belongs

Name Variable fully qualified name

Second Language Description of the variable in a second language

Type Variable data type

Logging Category Description

Continuous DataStorage

Controls whether this variable is configured as part of the Continuous Data Storage option

Historian Deadband Used in conjunction with the Historian Deadband Definition, to determine by how much a value mustchange before it is written to the Historian

Historian DeadbandDefinition

Defines the deadband value as either engineering units or percent of range

Include Controls whether the variable is configured for data collection in the Historian


3.5.2.3 Adding Variables

�� To add a variable(s) not configured for a Consumed Device

1. From the Historian tab, right-click the Consumed Device List or on a consumeddevice and select Add Variable to display the Select a Variable dialog box.

2. Select the variable(s) and click OK to return to theWorkstationST ComponentEditor. The variable(s) is added to the Summary View.

3. From the Property Editor, select Historian Deadband and enter the appropriatevalue for the variable.

Note If the Historian Deadband Definition is set to Percent of Range, either the FormatSpecification or the Display Low Limit and Display High Limit must be defined.

4. Override or define the Units, Precision, and Display Low/High Limitsproperties if the variable does not have a format specification defined.

5. After adding or modifying the variables, click the Build and Download buttons.


3.5.2.4 Deleting User-defined Variables

Note Only a user-defined variable can be deleted from the Summary View of theWorkstationST Historian tab. It is removed from the configuration, and after the nextBuild and Download, the data for the variable is no longer stored. However, deleting thevariable from the Historian tab does not delete it in the Historian System, so previouslystored data for the variable remains.

�� To delete a user-defined variable

1. From theWorkstationST Component Editor, select the Historian tab.

2. From the Summary View, right-click the user-defined variable you want to deleteand select Delete Selected Row(s).

3.5.3 Configuring Historian ReportsGE Historian Reports is anoption when the ControlSTsoftware suite is installed.

The report configuration tools allows you to produce periodic reports using the archiveddata in the Historian system.

Reports are scheduled to run each hour using the Windows® Task Scheduler. A report canalso be run interactively, using the Historian’s web browser. A configuration file, reports.dat, is used as the source for all report definitions. Each defined report references a tagfile that contains a list of variables to use in the report. The reports.dat and *.tag files areconfigured on the WorkstationST Historian tab, and created after a download has beencompleted.


3.5.3.1 Variable ListAvariable list contains the Historian variables used in a report. Several reports canreference a variable list. In the WorkstationST runtime, the Historian feature uses thedefined variable lists to create the tag files, <variable_list_name>.tag.

�� To add a variable listA variable list is limited to 65variables.

1. From the Historian tab Tree View, expand Report Configuration, right-clickVariable Lists, and select Add Variable List. The Add a Variable List dialogbox displays.

Note The variable list name must be a valid file name but cannot have any spaces.Invalid characters are: /\”<>|:*?; and <space>.

2. Enter the Name and select OK.

�� To add a variable to a variable list

♦ Select the variable(s) and click OK. The variable(s) is added to the Summary View.


�� To modify a variable list


3.5.3.2 Defining Default Report PropertiesDefault values can be assigned to a subset of the report properties. With the exception ofShift Start Times, these properties can be overridden on an individual report. If aproperty’s default value is changed, each report that has not overridden that property isautomatically updated with the new value.


Report Properties Defaults

Section Default Description

Cover Page Image/Picture File name of the image to display on the cover page next to the Name.

Image Alignment Used to align the image relative to the Name.

Image Height Image height in pixels. To display image using default height, enter zero.

Image Width Image width in pixels. To display image using default width, enter zero.

Name Name to display on the cover page.

Data Data Columns / Page Number of variables to display on one page. To display all variables onone page enter zero.

Data Time Interval Number of time slices to divide the report period into. Combined with DataTime Interval Units to create the time_step in reports.dat.

Data Time Interval Units Time units to apply to the Data Time Interval. Combined with Data TimeInterval to create the time_step in reports.dat.

Data Values Type of data values to display: Average, Interpolated, Maximum,Minimum, Standard Deviation, or Total.

Generation Print On Creation Controls whether the report is sent to the web browser’s defined printerwhen the report is automatically generated.

Shift Start Times Start time for each shift. Used as boundaries for the shift report.

Retention Storage Time Number of days to store the report before deleting it. To disable automaticdeletion enter zero.

Style Lines / Page Number of lines displayed in the report before inserting a page break. Theminimum value is 10.

Style Sheet Filename of the cascading style sheet to use with reports.


3.5.3.3 Configuring a GroupA group organizes reports. Group names and report names within a group must be unique.The group name is combined with the report title (for example <group name> - <reportname>).

�� To add a group

1. From the Historian tab Tree View, expand Report Configuration, right-clickReports, and select Add Group. The Add a Group dialog box displays.

Note The group name must be a valid file name. Invalid characters are: /\”<>|:*?;.

2. Enter the Name and click OK.

�� To edit a group


3.5.3.4 Configuring a ReportEach report definition is added as a separate report to the reports.dat file. With theexception of Shift Start Times, report default properties can be overridden on anindividual report.

�� To add a report

1. From the Historian tab Tree View, expand Report Configuration, right-click theReports item, or right-click a group under Reports, and select Add Report. TheAdd a Report dialog box displays.

Note The report name must be a valid file name. Invalid characters are: /\”<>|:*?;.

2. Enter the Name and click OK.

�� To edit a report


3.5.3.5 Defining Report PropertiesThe properties that typically differ from one report to another are found at the top of thereport form. An example of report properties is as follows.


Report Properties

Property Description

Title The name of the report displayed at the top of each page and on the Reports web page.

Variable List The name of the list of Historian variables to use in the report. Variable lists are defined underVariable Lists in the tree view.

Frequency / Units How often the report is automatically generated and saved to disk. To disable the report from beingautomatically generated, enter zero for the frequency.Frequency Units: Hours, Days, Months, Shift, DailyIf Frequency Units is Shift or Daily the reports.dat frequency parameter is ignored and the typeparameter is used. Shift and Daily reports are automatically generated and saved to disk.

Data Time Interval /Units

The number of time slices to divide the report period into. One row of data is displayed for each timeslice.Data Time Interval Units: Days, Hours, Minutes, Seconds

Data Values The type of data values to display: Average, Interpolated, Maximum, Minimum, Standard Deviation,Total

Storage Time The number of days to store the report before deleting it. To disable automatic deletion, enter zero.

Send To Printer Controls whether the report is sent to the web browser’s defined printer when the report isautomatically generated.

Event-based When selected, it enables configuration of the report as an event report.

Condition #1 For the time period that the report is run, search for each trigger condition ANDed with an optionallevel condition. If True, generate a report using the Before Event and After Event times as reportboundaries.

Condition #1 -Trigger Search for this event / SOE variable in the alarm history to transition from False to True (+) or Trueto False (-). This transition is called the trigger edge.

The button starts the variable browser and displays all the defined event and SOEvariables from the consumed devices.Adding a variable name to the Trigger enables the Level properties and Condition #2 properties.

Condition #1 - Level Lookup the value of this Boolean variable at the time of the event transition to determine its state:True (1) or False (0).

The button starts the variable browser and displays all the Historian Boolean variables fromthe consumed devices.



Condition #2 The Trigger and optionally the Level can be configured. The result of Condition #2 is ORed withCondition #1 to generate a report.

Condition #2 -Trigger

Search for this event / SOE variable in the alarm history to transition from False to True (+) or Trueto False (-).

Condition #2 - Level Lookup the value of this Boolean variable at the time of the event transition to determine its state:True (1) or False (0).

Time Range - BeforeEvent

The time boundary before the event to start the report.

Time Range - AfterEvent

The time boundary after the event to stop the report.

Data Columns / Page The number of variables to display on one page. If the Reports default value is zero, All Variables isselected, unless overridden.

Lines / Page The number of lines displayed in the report before inserting a page break. The minimum value is 10.

Style Sheet The filename of the cascading style sheet to use with reports.

Name The name to display on the cover page.

Image / Picture The filename of the image to display on the cover page next to the Name.

Image Height Image height in pixels. To display using default height, enter zero.

Image Width Image width in pixels. To display using default width, enter zero.

Image Alignment Used to align the image relative to the Name.


3.5.3.6 Importing ReportsWhen upgrading from a Control Systems Solutions (toolbox) Historian to a ControlSTHistorian, the existing reports configuration must be imported into the Historian’sWorkstationST component through an Import wizard.

Note When the Historian feature runs, it creates the backup folder E:\Site\Reports\Original (if it does not exist) and copies the existing reports.dat file and all tag files tothis folder when it is created. This ensures that the original files are not accidentlyoverwritten before an import can take place. If you are upgrading and the E:\Site\Reports\Original folder exists, select this as the source folder.

As a result of the import, reports and variable lists are created. Any existing report orvariable list is overwritten. If a report in the reports.dat file is associated with a tag filethat does not exist, the report is created, a warning is issued, and an empty variable list iscreated. When creating a variable list, each variable from the tag file is added to the list. Ifthe variable does not exist in the system, the variable’s device is not consumed by theHistorian. If the variable is not defined as a Historian variable, an error is generated.

�� To import existing reports

♦ From the Historian tab Tree View, right-click Report Configuration, and selectImport Reports. The Import Existing Reports wizard displays.


3.5.4 Configuring Continuous Data StorageThe Continuous Data Storage option allows you to specify a subset of variables to bestored at a defined update rate whether or not the variable’s data value has changed.

Attention

Enabling this option and adding variables to it candrastically reduce the capacity of the Historian as thisoption overrides the compression algorithm of thethird-party Historian.

Note If the Historian does not require this data, it is recommended that you create a LiveData Collection in the Recorder feature, add the required variables, and set the RecorderDeadband to 0 for analog variables and to Log Continuous for Boolean variables.

�� To enable Continuous Data Storage


�� To add a variable to Continuous Data Storage

1. From the Tree View, select Consumed Device List or the consumed device. Inthe Summary View select the variable that you want to configure for this option.

2. After configuring the variables for this option, click Build and Download.


3.5.5 Archive Backup ManagementThe Archive Backup Management option allows you to specify configuration parametersfor the HistorianArchiveBackupManager application.

The supported third-party Historian products use fixed-length archives to store data. A setnumber of archive files are created during factory setup. When these archives are filled,the third-party Historian software reuses the oldest, writeable archive.

The HistorianArchiveBackupManager application runs the third-party Historian's backuputility, backing up the Number of Archives specified to the Archive Backup Path, startingwith the current archive. Once the backup is complete, the amount of disk space used byall files under the Archive Backup Path is calculated. If greater than the Maximum DiskSpace, the oldest archives are deleted until the disk space used falls below the limit.

Note This feature is disabled if the Maximum Disk Space parameter is set to zero.

It then checks the amount of free disk space on the Archive Backup Path drive. If lessthan that specified in the Desired Free Space, the oldest archives are deleted until the freedisk space is above the limit unless the Minimum Disk Space limit is reached. It does notallow the amount of disk space used by all files under the Archive Backup Path to fallbelow the Minimum Disk Space.


�� To configure Archive Backup Management properties

♦ After adding or modifying the variables, click the Build and Download buttons toenable the changes in the Historian.

For the backups to occur, the HistorianArchiveBackupManager application must bescheduled to run. Only schedule the HistorianArchiveBackupManager application to runnightly. Do not schedule the third-party Historian backup utilities to run. TheHistorianArchiveBackupManager application runs the third-party Historian backuputility.


Archive Backup Management Properties


Archive Backup Path The location where the backup files are saved.

Desired Free Space Amount of disk space in gigabytes to keep free on the archive backup disk drive. If theamount of free disk space drops below this value, the oldest archives in the ArchiveBackup Path are deleted until the total bytes are more than this value.

Maximum Disk Space The maximum size in gigabytes the archive backups are allowed to use. If the total size ofall archive backups exceeds this value, the oldest backed-up archive files are deleteduntil the total bytes used is less than this value. A value if 0 disables this feature.

Minimum Disk Space The minimum size in gigabytes of archive backup files to keep on the backup disk. Thisvalue overrides the Desired Freed Space value.

Number of Archives The number of archives to back up each time the backup application runs.

�� To enable backups at regular intervals

♦ Open a Command Prompt and run the following command:

AT 03:15 /EVERY:M,T,W,Th,F,S,Su “C:\Program Files\GE

Energy\WorkstationST Features\

HistorianArchiveBackupManager.exe”

Note If Windows 7 is used as the operating system, the Program Files part of thecommand is \Program Files (x86)\

The Task Scheduler is now configured to run HistorianArchiveBackupManager.exe everyday at 03:15 AM. It uses the Archive Backup Management parameters configured on theHistorian tab and downloaded to the Historian workstation.

�� To view or edit the task in the Task Scheduler

1. From the Control Panel, double-click Scheduled Tasks (The task is named at#where # is a number.)

2. Right-click on the name and select Properties to view the task's details.

3. Right-click on the name and select Rename. Rename the task to HistorianArchive Backup Management.

Attention

The customer should maintain a regular schedule ofarchiving the backed up archives to an offline storagemedium.


3.6 Backup of Historical DataThe supported third-party Historian products use fixed-length archives to store data. A setnumber of archive files are created during factory setup. When these archives are filled,the third-party Historian software reuses the oldest, writeable archive.

Each third-party Historian provides a procedure for backing up archives and configurationinformation. A description of these procedures is provided.

Note The behavior of the third-party backup procedures may be changed by thethird-party software supplier without notice, but is accurate at this time. Refer to thethird-party supplier’s documentation for detailed information regarding the backupprocedures.

3.6.1 PI Backup ProcedureThe file supplied with the PI-based Server for backing up archives and archiveconfiguration information is pibackup.bat. It is located in the PI-based install directoryunder the \adm folder (typically C:\PI\ADM\PIBACKUP.bat). The pibackup.bat filebacks up the current archive, additional archives (if specified), site-specific configurationfiles, as well as log files to the specified backup directory. On Mondays, it performs a fullbackup of these files. On all other days, it performs an incremental backup; only files thathave changed are backed up. The backup procedure does not delete any previouslybacked-up files. As data is accumulated and the current archive shifts to the next archive,the older archive remains in the backup directory.

The pibackup.bat file can be run interactively from a Command Prompt or can bescheduled to run at regular intervals using the Task Scheduler.

Note For detailed information on backing up a PI-based Server, refer to the PI ServerSystem Management Guide.

Note Do not schedule pibackup.bat to run if the Historian Archive Backup Manager isscheduled to run.


�� To enable backups at regular intervals

1. Create a backup directory (such as E:\backup).

2. Open a Command Prompt and change directory to C:\PI\ADM and run thefollowing command:

pibackup.bat e:\backup –install

The Task Scheduler is now configured to run pibackup.bat every day at 03:15 AM,backing up the current archive and the two previous archives, as well as configurationinformation, to E:\backup.

Note To view the pibackup online Help, which includes the default parameter values forpibackup.bat, enter the following command at the Command Prompt: pibackup.bat ?

�� To view or edit the task in the Task Scheduler

1. From the Control Panel, double-click Scheduled Tasks.

Note On Windows XP®, Windows® Server 2003, and Windows Vista®, the task is namedPI Server Backup. On Windows 2000, the task is named at# where # is a number.

2. Right-click the name and select Properties.

3. If the task name is at#, right-click the name and select Rename. Rename the task toPI Server Backup.


3.6.2 Storing PI Archives

Note Store archives and configuration information that are backed up nightly to DVD,CD, or tape.

Attention

If the backup directory used by pibackup.bat is not on aseparate disk that is sized to hold all archives andconfiguration information, move the older archives to anoffline storage medium.

3.6.3 Restoring Offline PI ArchivesWhen required data is no longer available online, restore the necessary archives to atemporary directory. Use PI System Management Tools (PI-SMT) to register the archive.

�� To register an archive using PI-SMT

1. From the Start menu, select All Programs, PI System, and PI SystemManagement Tools. The PI-SMT tool displays.

2. From Collectives and Servers, verify that the local PI Server is selected.

3. From System Management Plug-Ins, expand the Operation item and selectArchives.

4. From the Summary View, right-click and select Display Unregistered Archive.

5. Browse and select the archive you want to register and click Open.

6. From the PI-SMT tool, right-click the archive and select Register This Archive.

7. From the PI-SMT tool, right-click the archive and selectMake Non-shiftable.

Attention

To prevent temporarily restored archives frombecoming the primary archive, make temporarilyrestored archives non-shiftable.

The data from the archive is now available for querying.

Note You can register any archive as long as the time range of the data in the archivedoes not overlap the time range of an archive already registered. The archive names donot have to be different since PI uses the full path of the archive when it registers thearchive.


3.7 Historian Report ConfigurationRefer to GEI-100752, Historian Report Configuration Instruction Guide.

3.8 Variable AliasingAliases cannot be overriddenon the Historian Feature tab.

The Variable Aliasing option allows you to specify an alternate name for a variable (forexample, the alias for the gas turbine speed variable, TNH, is specified as SPEED orVELOCIDAD). Aliases are defined where the variable is defined, and must be uniquethroughout the system.

Note Existing variables in the PI-based Historian cannot be renamed.

�� To enable variable aliasing

From the Tree View , double-click a component (such as G1).

The Componen t Ed ito rdisplays.


Note Each system component can enable alias prefixes. This adds the component nameto the beginning of each alias name (for example, G1.Speed).

�� To create a variable alias

To use defined aliases instead of the variable name in the Historian system, the Use AliasName property must be enabled in the Historian WorkstationST component. If a variablealias is not defined, the variable name creates the variable in the Historian system.


�� To use defined aliases

Note Setting the Enable Alias Prefix property to True on the Historian WorkstationSTonly applies the component name prefix to variables defined in the HistorianWorkstationST (for example, client-driven variables defined on the OPC DA Server tab).


3.9 Upgrading an Existing Historian System for VariableAliasing

To maintain continuity of data history when upgrading an existing variable to use an alias,use the PI System Management Tool to rename the original variable (refer to the sectionDeleting or Renaming a Variable from the PI-based Historian). This must be done beforesetting the Enable Alias Prefix property to True and performing a Build and Download tothe Historian WorkstationST component. If the original variable is not renamed, a newvariable with the alias is created.

Attention

Deleting a variable from the Historian system removesall access to the data for that variable.


4 Chapter 4 User Guide4.1 PI-based Server TagsTags and their parameters canbe viewed in Microsoft Excel.

Server tags are the PI-based equivalent of ToolboxST variables. Whenever a HistorianWorkstationST is built and downloaded, the tag configuration in the PI-based server isupdated. The ToolboxST application converts its variable names that are configured forarchiving in PI and updates the PI-based system. Once these tag names are created, thePI-based application uses the PI OPC DA client to connect to the WorkstationST OPCDA server to obtain the variable values. The variable names in the ToolboxST applicationand the tag names in the PI-based application should be identical with the exception ofbackslashes replaced by underscores. The application InstrumentTag parameter for the PItags must be identical to the variable name in the ToolboxST application.

4.1.1 Importing Tags�� To import tags

From the Windows Start menu, open Microsoft Excel.

Chapter 4 User Guide GEH-6744B System Guide 73For public disclosure

The following dialog box displays any errors that occurred during the import.

The following is a sample import.


4.2 Deleting or Renaming a Variable from the PI-basedHistorian

�� To delete or rename a variable from the PI-based Historian

1. From the Start menu, select Programs, PI System, and PI SystemManagement Tools. The PI System Management Tools displays.


2. From the Tools menu, select Tag search... The Tag Search dialog box displays .


3. Select the variable(s) and click OK. The variables display in the PI SystemManagement Tools dialog box.

If you selected Delete PI Point, the Delete PI Point Confirmation dialog boxdisplays.

If you selected Rename PI Point, the Rename PI Point dialog box displays.


4.3 PI ProcessBookPI ProcessBook is a graphical interface used to display analog and digital data stored inthe PI-based server. It can be accessed from the administrator, maintenance, and operatoruser accounts.

PI ProcessBook is licensed torun on the Historian and oneadditional computer.

PI ProcessBook opens a list of PI ProcessBook entries (predefined displays) on thedefault PI ProcessBook screen. Each PI ProcessBook entry is configured for retrieval anddisplay of variables from the Historian archives. Multiple trends may be defined for asingle PI ProcessBook entry. Each trend can display up to eight variables. The time rangefor each trend can be modified. Trends can simultaneously display historical and real-timedata. Additional trends can be added to a PI ProcessBook entry, or new PI ProcessBookentries can be added to the PI ProcessBook.

4.3.1 Creating and Configuring Preferences�� To create a PI ProcessBook

1. From the Start menu, select All Programs, PI System, and PI ProcessBook.

2. From the File menu, select New. The New dialog box displays.

3. From the File menu, select Save As to save the PI ProcessBook.


The default settings are storedin either the directory C:\ or C:\Program Files under \PIPC\DAT\PROCBOOK.INI. It isrecommended to make abackup copy of this file.

PI ProcessBook has default settings for color, font, start, trend, and each element of atrend.

�� To configure ProcessBook preferences


4.3.1.1 Color Tab

�� To change the color

♦ From the ProcessBook Preferences dialog box and the Color tab, click theChoose Colors… button. The Color dialog box displays.


4.3.1.2 Book TabThe Book tab defines the fonts that display in the PI ProcessBook titles.

In the Book View Mode, ProcessBook entries are listed on pages in chapters. Each level 1ProcessBook entry displays as a separate chapter with its own tab. Level 2 and 3 entriesare listed on the pages of that chapter with each level indented beneath the previous level.

In Book View Mode, only thefirst three font levels are used(levels 4 through 10 use theLevel 3 font).

In the Outline View Mode, entries display in typical outline form with all level 1 entriesas separate items in a list (not as separate chapters).

�� To change the font(s)


4.3.1.3 Start Tab

�� To configure Start settings

Author is the name or initials of the person creating the ProcessBook (optional).

ProcessBook is the path and file name for the ProcessBook that displays when the PIProcessBook client is run.

Symbol Library specifies the default symbol library used by all ProcessBooks.

Preserve Aspect Ratio determines that display elements change size in proportion tothe window size.

Run Mode Bias changes the cursor from Build Mode to Run Mode after drawing a newsymbol.

Create Backup Files creates continuous backup files.

Time determines the time format for trends and values. This property only affects howthe time value displays. Either format can still be used for entering a date.


4.3.1.4 Trend TabThe Trend tab defines settings for new ProcessBook trends.

�� To configure trend settings

Autoscale, if selected, automatically adjusts the trend scale.

Plot Titles, if selected, displays plot titles.

Vertical Scale Inside Axis, if selected, displays the tag’s scale on the inside of theaxis.

Grids, if selected, displays grids.

Multiple Scales, if selected, lists each tag’s scales on the trend.

Markers, if selected, displays a marker at each saved variable.

Style includes Full time stamp, Partial time stamp, or Relative time stamp.

Start includes *-1 Hour, *-4 Hour, *-8 Hour, *-1 Day, or *-7 Day. A custom time canalso be entered. (In the PI system, when referencing time, the asterisk (*) means now. Astart time of *-1 Hour means that the Trender is always one hour behind the current time)

End includes *, *-1 Hour, *-4 Hour, *-8 Hour, *-1 Day, and *-7 Day. A custom timecan also be entered.


Set the following properties.

Plot Element includes:

Pen 1, 2, 3, 4, 5, 6, 7, 8

Marker Type

Color

Line Style

Line Weight


4.3.2 Creating a ProcessBook EntryThere are five types of entries: Display, Linked Display, Linked ProcessBook, Text, andOperating System command. The entries can be arranged in hierarchical form byassigning different levels to the entries. An example of entry organization is to assignlevel 1 entries as text entries that describe the level 2 entries that follow.

�� To create a new ProcessBook entry

♦ Click File, then New. The New dialog box displays.


�� To add a display entry under the Text Entry

1. From the File menu, select New. The New dialog box displays.

2. From Type, select ProcessBook Entry, and click OK. The DefineProcessBook Entry dialog box displays.

3. Click File, then Save. The empty PI ProcessBook display is saved.


4.3.3 Tag SearchThe Tag Search tool is used to search for tags configured in the PI ProcessBook.

�� To search for tags

Use * as the tag mask to search for all configured variables in PI.

Use G3.* to search for variables configured for unit G3 only.

Use *.TNH to search for all speed tags.

The search results display below.

Note The Tag search can be used to highlight multiple tags to add to a trend.


�� To define a Trend


♦ On the display, click and drag a box large enough to contain the trend. The TrendDefinition dialog box displays.

Set the following properties:

Max andMin determine high and low plot values. The two options for each as follows:

Autorange causes the limit to vary over time as the tag value changes.

Database uses the value defined in the PI database (Zero and Span) for that tag as theplot limit.

If multiple tags are used and Single Scale is selected, the trend’s plotting limits are thehighest Max: and the lowest Min: from all the tags. IfMultiple Scales is selected, eachtag’s high plot and low plot display.

�� To review trend attributes

1. Click the General tab.

2. Click the New Plot button to open a new Define Trend dialog box for creatingmultiple trends.

3. Click the Delete Plot button to delete the current dialog box, if more than one isopen.

4. Click the Delete Tag button to delete highlighted tags.


4.3.4 Sample TrendThe following example is a trend definition called MWATTS that plots the tag DWATTfrom each of four units. Since the End: time is * and the Start: time is *- 8 Hour, thetrend continually displays data for the G1.DWATT tag from the previous hour.

�� To add tags


4.4 Working with ToolboxST Trender

Attention

The ToolboxST Trender can interface to the PI-basedserver if the PI-based OPC HDA server is installed onthe Historian.

The ToolboxST Trender graphically displays live and historical data. ATrender can beconfigured to read I/O values from the PI-based archives, the Recorder, the OPC DAserver, or directly from a component. After installing the PI-based OPC DA/HDA server,Trender functions as a Historical display. Trender accesses the PI-based archives throughthe Historian to look at historical data.

Refer to GEH-6700, Chapter 9,Trender.

�� To open a Trender

1. From the Start menu, select GE ControlST, ToolboxST, and Trender. ATrender window displays.

2. When theWelcome wizard displays, click Next.


Notes


5 Chapter 5 Troubleshooting5.1 Verifying Data Flow

Data flows from the data source (for example, a controller) to the OPC DA server andthrough the PI-based OPC interface to the PI-based server.

�� To verify data flow to the OPC DA server

1. From the Start menu, select All Programs, GE ControlST, ToolboxST, andToolboxST to display the System Editor.

2. From the Tree View, double-click the Historian WorkstationST item to displaythe Component Editor.

3. If the values display green (healthy), verify that the PI-based OPC interface isrunning and that data is being received by the PI-based server.

4. If the values display red or black (unhealthy), refer to GEH-6706, ToolboxST UserGuide for WorkstationST, the chapterWorking Online with WorkstationST.

Chapter 5 Troubleshooting GEH-6744B System Guide 99For public disclosure

�� To verify PI OPC operation

1. From the Start menu, select All Programs, PI System, and PI_OPCClient todisplay the PI_OPCClient.


2. If the correct values are not displayed, refer to GEI-100621, WorkstationST OPC DAServer.

3. If the correct values display, open PI System Management Tools.


�� To verify that data is received

1. From the Start menu, select All Programs, PI System, and PI SystemManagement Tools to display the PI System Management Tools screen.

2. Click Refresh to update the values. If the values display correctly, ControlST isintegrated with the PI-based Historian software.


5.1.1 Report Configuration ErrorsReport errors display when the report is run from the web browser. Report errorsinvolving the way the report displays are controlled by the file E:\site\reports\defaultstyle.css. This file specifies font types, sizes, colors, and the default background colors.Background image files referenced in the defaultstyle.css file are located in the E:\site\reports\images directory. Correct logos are specified in the reports.dat file, with the logoimage file located in E:\site\reports\images.

Other report configuration errors, such as incorrect start and stop times, report frequency,or event triggers display when the report is run with an incorrect time period. To correctthese errors and adjust the report parameters as needed in the E:\site\reports\reports.datfile to produce the correct data.

When incorrect variable names display in the tag file, the following message displays inthe report.

Error executing query: OLE exception from "Microsoft OLE DB Provider for ODBCDrivers": [OSI][PI DBC][PI]Tag

< G1.AFPAF > not found Win32::OLE(0.15) error 0x80004005: "Unspecified error" inMETHOD/PROPERTYGET

"Execute" SELECT tag, descriptor, engunits, pointtype FROM pipoint WHERE tag ='G1.DWATT' or tag =

'G1.AFPAF' or tag = 'G1.MVARHR' or tag = 'G1.MWATTHR'

This is typically a copy of the SQL command the script is trying to execute to get thedata, along with the returned error message. Careful examination of the error messageindicates the source of the problem (in this case G1.AFPAF was not found – point nameshould have been G1.AFPAP).

5.1.2 Automatic Report Generation ErrorsAutomatic report generation errors are usually related to scheduler problems. Verify thatthe chain.pl task is scheduled to run every hour. The tasks currently scheduled can beverified on a Windows NT system by opening a command window, and entering ‘at’. Ona Windows 2000 or later system, the scheduled tasks can be monitored by selecting Start,Programs, Accessories, System Tools, Scheduled Tasks. Additional information abouteach task displays in the scheduled task folder (when task last run, completedsuccessfully, and so forth). Once the task is scheduled, actions are logged to E:\site\reports\LOG\rpt.log each time the task runs. Any problems encountered, as well assuccessful completion messages, are logged to this file.


IndexAAcronyms and Abbreviations 9Adding Archives 39Adding Variables 49Archive Backup Management 63

BBackup of Historical Data 66

CConfiguration 29Historian Report 69Time Synchronization 35

Configuring a Group 55Configuring a Report 56Configuring Continuous Data Storage 61Configuring Historian 41Configuring Historian Reports 50Configuring the DCOM Default Users 26Configuring Variables for Data Collection 45

DData Collection and Storage 7Data Compression 37Defining Default Report Properties 53Defining Report Properties 57Deleting User-defined Variables 50

EErrorsAutomatic Report Generation 104Report Configuration 104

HHistorian Archives 36

IImporting Reports 60Installation 11Installing Historian Reports 28Installing OPC Historical Data Access (HDA) 25Installing PI-based Application 11Installing the OEM-GE-HST-MASTER Timeout 12Installing the PI Combo 22Installing the PI OPC Interface 18Installing the PI-based Enterprise Data Access 20Installing the PISMTSetup CD 15

MModifying Data Collection 47

NNaming Conventions 37

OOverview 5

PPI Backup Procedure 66PI Point Database 37PI-based Application Installation 11

RRelated Documents 9Restoring Offline PI Archives 68

SStoring PI Archives 68

TToolboxST TrenderWorking with 94

Troubleshooting 99

UUpgrading an Existing Historian System forVariable Aliasing 72User Guide 73

VVariable List 51

GEH-6744B Index 105For public disclosure

Notes

106For public disclosure

1501 Roanoke Blvd.

Salem, VA 24153 USAFor public disclosure