GE Fanuc Automation CIMPLICITY HMI. Historical Data Analyzer. CIMPLICITY Monitoring and Control Products. Operation Manual

Transcription

1 GE Fanuc Automation CIMPLICITY Monitoring and Control Products CIMPLICITY HMI Historical Data Analyzer Operation Manual GFK-1379C December 2000

2 Following is a list of documentation icons: GFL-005 Warning notices are used to emphasize that hazardous voltages, currents, temperatures, or other conditions that could cause personal injury exist in the equipment or may be associated with its use. Caution provides information when careful attention must be taken in order to avoid damaging results. Important flags important information. To do calls attention to a procedure. Note calls attention to information that is especially significant to understanding and operating the equipment or software. Tip provides a suggestion. Guide provides additional directions for selected topics. This document is based on information available at the time of publication. While efforts have been made to be accurate, the information contained herein does not purport to cover all details or variations in hardware or software, not to provide for every possible contingency in connection with installation, operation, or maintenance. Features may be described herein which are not present in all hardware and software systems. GE Fanuc Automation assumes no obligation of notice to holders of this document with respect to changes subsequently made. GE Fanuc Automation makes no representation of warranty, expressed, implied, or statutory with respect to, and assumes no responsibility for the accuracy, completeness, sufficiency, or usefulness of the information contained herein. No warranties of merchantability or fitness for purpose shall apply. CIMPLICITY is a registered trademark of GE Fanuc Automation North America, Inc. Windows, Windows NT, and Windows 98 are registered trademarks of Microsoft Corporation This manual was produced using Doc-To-Help, by WexTech Systems, Inc. Copyright 2000 GE Fanuc Automation North America, Inc. All rights reserved

3 Preface Contents of this Manual This manual is composed of the sections described below. Chapter 1. Introduction: Describes the CIMPLICITY Base System functionality, and the features of the Historical Data Analyzer. Chapter 2. Using the Data Analyzer Configuration Process : Shows you how to use the Historical Data Analyzer configuration process to manage the sets, tables and fields used by the Historical Data Analyzer. Chapter 3. Using the HDA Viewer/Editor: Shows you how to insert a CIMPLICITY HDA Viewer control into a CimEdit screen and documents the actions users can take in CimView. Appendix A. HDA Example: Shows you a sample group table and the HDA tables that analyze its data. Appendix B. Special Configuration: Discusses the HDA global parameters. Related Publications For more information, refer to these publications: CIMPLICITY HMI Base System User Manual (GFK-1180) GFK-1379C iii

4

5 Contents Introduction 1-1 About the Historical Data Analyzer About the Historical Data Analyzer Subsystems Historical Data Analyzer Data Flow HDA Functions User Functions Historical Data Analyzer Calculation Types Block Calculations Running Calculations Moving Calculations Other Calculations Historical Data Analyzer Special Features Filling Gaps at Startup Performing Setpoints to CIMPLICITY Points Saving Original Value of User Modified Values Using the Data Analyzer Configuration Process 2-1 HDA Configuration Hierarchy HDA Sets HDA Tables HDA Fields Getting Started About the Historical Data Analyzer Window Moving Between the Tree and Grid Panes Historical Data Analyzer Configuration Menu Options Historical Data Analyzer Windows Pop-up Menus Historical Data Analyzer Configuration Toolbar Buttons Historical Data Analyzer Configuration Shortcut Keys Adding a New Set Adding a Table to a Set Logging Conditions Maintenance Events Maintenance Actions Adding a Field to a Set and Table Working with Tables and Fields Displaying Set Properties Displaying Table Properties Displaying Field Properties Displaying Tables in the Grid Displaying Fields in the Grid Modifying a Field's Logging Criteria for a Table Defining Logging Setpoint Control Editing Group Table Configuration GFK-1379C v

6 Using the HDA Viewer/Editor 3-1 About the HDA Viewer/Editor Inserting the HDA Viewer/Editor Object in CimEdit Configuring HDA-Viewer/Editor Properties Date Filter Data Source Database Date/Time Format HDA-Viewer/Editor Actions in CimView Modifying Data Refreshing Data Recalculating Data Command Line Recalculation Tool Appendix A - HDA Example 1-1 About the HDA Example... A-1 Group Table Source File... A-1 HDA1 Analysis Table... A-2 HDA2 Analysis Table... A-3 HDA3 Analysis Table... A-4 Appendix B - Special Configuration 2-1 About Special Configuration... B-1 Global Parameters for HDA... B-1 DARP_LVV_USECURRENT... B-1 DARP_STARTUP_INTERVAL... B-2 HDA_PTDL_OFFSET... B-2 Modifying the Global Parameters File... B-3 Index i vi CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

7 Introduction About the Historical Data Analyzer The CIMPLICITY Historical Data Analyzer option provides a more powerful examination of CIMPLICITY data through enhanced database logging functions, historical data viewing, and data summarization, modification and recalculation. All summarizations are calculated using data from any Database Logger Group or Historical Data Analyzer database table. Using the Historical Data Analyzer, you can summarize data over configured time intervals. You can then load these summarizations into Historical Data Analyzer database tables. You can also send the summarization value to a CIMPLICITY point. The Historical Data Analyzer Viewer Editor lets you embed an OLE Control in a CimView screen. This OLE Control contains data from any Database Logger Group or Historical Analyzer database table. Also, you may edit the data and update the database with the modified value. You may also provide comments to further document the data. Finally, you may initiate a recalculation, which will recalculate all data dependent on the modified values. About the Historical Data Analyzer Subsystems The CIMPLICITY Historical Data Analyzer option consists of the following subsystems: Data Analyzer Resident Process (DA-RP) Data Analyzer Configuration Process (HDA Logger) Data Viewer/Editor Process Data Recalculation Process (DA-RC) The Data Analyzer Resident Process performs all the enhanced data logging functions. The Data Analyzer Configuration Process lets you configure the Historical Data Analyzer database tables. Each HDA database field is an entity whose value is derived from an expression that includes Database Logger Group table fields and other HDA fields. GFK-1379C 1-1

8 The Data Viewer/Editor lets you substitute and/or examine logged data and associate comments with logged data entries. The Data Recalculation Process re-evaluates logged data values in the event of a data substitution or data recovery. Historical Data Analyzer Data Flow The following picture shows you the interactions between the various CIMPLICITY HMI functions that make up the CIMPLICITY Historical Data Analyzer option. 1-2 CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

9 HDA Functions CIMPLICITY software does the following: Database Logger logs CIMPLICITY points in Database Logger Group tables. Based on the configuration of Group tables in the Database Logger, CIMPLICITY point values are logged to Group tables in a database. HDA processes data from Database Logger Group table data Based on the configuration of HDA tables in the HDA Logger, the values stored in Database Logger Group tables are used by the HDA Resident Process to derive HDA data, which is stored in HDA tables in a database. HDA processes data from other HDA tables HDA can also use the values of one HDA table to derive the values of another HDA table. HDA sets CIMPLICITY setpoints based on HDA field values HDA can set the value of a CIMPLICITY point to the value of an HDA field as it is being logged to the database. User Functions In the HDA Configuration process, you can specify configuration requirements for HDA. This includes information on CIMPLICITY setpoints, HDA field calculations and whether Group and HDA table fields are enabled for user changes. In the Viewer/Editor process, users can: View data in HDA and Database Logger Group tables. You can insert HDA Viewer Editor OLE Controls in CimView screens to let users view the specified rows of data in HDA or Database Logger Group tables. Modify values in HDA or Database Logger Group tables. While in CimView, a user may modify values that are already stored in Database Logger Group or HDA tables. While modifying the value, the user may associate a comment with the modified value to describe the modification Issue a recalculation request for HDA data. If Database Logger Group or HDA tables have been modified, you may want to perform a recalculation to regenerate HDA data. The HDA Recalculation Process determines the new values for an HDA table (or tables) over a specified time period and updates the database with the new values. GFK-1379C Introduction 1-3

10 Historical Data Analyzer Calculation Types An HDA table contains rows of data that are logged at a configured interval. Each row of data contains fields that have their own calculation type. Along with the calculation type, each field uses the values of source fields and flag fields to derive the value for that field at a given time. The source and flag fields can be part of Group tables or other HDA tables. The calculation types are detailed below. Examples of the block, moving, and running calculations appear in Appendix A, "HDA Example". Block Calculations Fields with block calculations evaluate multiple occurrences of a source field and flag field over a block period of time, with one value being logged as the block calculation. For block calculations, you need to understand these concepts: Source field - the Group or HDA table field being used as input to the HDA calculation. Flag field - an optional field that is used to tell HDA to ignore invalid readings. Block Period - the log interval of the HDA table with the block calculation field. Sampling Interval - all logged values of the source field and flag field within the past block period are used as part of the block calculation. Reset Interval - once the block calculation is logged, all statistics are reset in order to begin calculating the value for the next block period. BAV - Block Average For a BAV field, HDA logs the average of a source field over the block period. For example, if you want a block average every 5 minutes, HDA logs the average of all values of the source field over the prior 5 minutes. The value of a source field is ignored (evaluate to NULL) at a given time if any of the following conditions are true: The source field is currently NULL The flag field, if configured, is currently NULL The flag field, if configured, currently evaluates to 0 A value of NULL will be logged as the value for an HDA field if the source field evaluates to NULL for the entire interval associated with the HDA field. BMX - Block Maximum Block Maximum calculations are similar to Block Average calculations. Instead of averaging a source field over the block period, HDA determines the maximum value of the source field over the block period. You can configure flag fields to ignore inappropriate source field values. 1-4 CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

11 BMN - Block Minimum Block Minimum calculations are similar to Block Average calculations. Instead of averaging a source field over the block period, HDA determines the minimum value of the source field over the block period. You can configure flag fields to ignore inappropriate source field values. BT - Block Total Block Total calculations are similar to Block Average calculations. Instead of averaging a source field over the block period, HDA determines the accumulated value of a source field over the block period. You can configure flag fields to ignore inappropriate source field values. Running Calculations Fields with running calculations evaluate multiple occurrences of a source field and flag field over a block period of time, with a configured number of intermediate results being logged as the running calculation. Running calculations behave the same way as block calculations, with the exception that intermediate results are also logged. For running calculations, you need to understand these concepts: Source field - the Group or HDA table field being used as input to the HDA calculation. Flag field - an optional field that is used to tell HDA to ignore invalid readings. Log Interval - the log interval of the HDA table with the running calculation field. At each log interval, the current value of the running calculation is logged. Block Period - the log interval of the HDA table times the number of samples to be logged. If a running calculation is logged every 2 minutes with a sample count of 3, the block period is 6 minutes. Sampling Interval - all logged values of the source field and flag field within the past block period are used as part of the running calculation Reset Interval - all statistics are reset at the end of each block period RBA Running Block Average For a Running Average, HDA logs the average of the source field over a block period. The current average is logged at each log interval. Once the number of samples has been logged over a block period, statistics are reset in order to begin calculating the Running Average for the next block period. The value of a source field is ignored (evaluate to NULL) at a given time if any of the following conditions are true: The source field is currently NULL The flag field, if configured, is currently NULL The flag field, if configured, currently evaluates to 0 A value of NULL is logged as the value for an HDA field if the source field evaluates to NULL for the entire interval associated with the HDA field. GFK-1379C Introduction 1-5

12 RT - Running Total Running Total calculations are similar to Running Average calculations. Instead of averaging the source field over a block period, HDA determines the accumulated value of a source field over a block period. You can configure flag fields to ignore inappropriate source field values. Moving Calculations Fields with moving calculations evaluate multiple occurrences of a source field and flag field over a moving period of time. At each log interval, the most recent N samples of the source field and flag fields are used as part of the moving calculation. For moving calculations, you need to understand these concepts: Source field - the Group or HDA table field being used as input to the HDA calculation. Flag field - an optional field that is used to tell HDA to ignore invalid readings. Log Interval - the Log Interval of the HDA table with the moving calculation field. At each log interval, the current value of the moving calculation is logged. Sampling Interval - the Sampling Interval determines when a new calculation is derived and thus logged. The source and flag fields must be configured to be logged at the same rate as the HDA field that has the moving calculation. That is, the log interval of the table containing the source and flag fields must be equal to the log interval of the table containing the moving calculation. Moving Period moving calculations always evaluate the last N samples of the source and flag fields. As a new sample is evaluated, the oldest sample is no longer part of the current calculation. If a moving calculation has a Log Interval of 2 minutes and a sample count of 3, the moving calculation is logged every 2 minutes, each time using the last 6 minutes of data to derive the value of the field. MAV - Moving Average For a Moving Average field, HDA logs the average of the most recent N samples of the source field. The value of a source field will be ignored (evaluate to NULL) at a given time if any of the following conditions are true: The source field is currently NULL The flag field, if configured, is currently NULL The flag field, if configured, currently evaluates to 0 Disregarded values are still considered as samples, but do not become part of the Moving Average. For example, consider a Moving Average field configured to be logged every 2 minutes with a sample count of 3. If one of the samples of the source field is to be ignored, then the Moving Average represents the average of the two accepted samples over the 6 minute Moving Period. A value of NULL will be logged as the value for an HDA field if the source field evaluates to NULL for the entire Moving Period associated with the HDA field. 1-6 CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

13 ROC - Rate of Change For a rate of change field, HDA logs the difference of the value of the most recent sample of the source field with the value of the source field N samples ago. You can configure flag fields to ignore inappropriate source field values. If the current value of the source field is to be ignored, or if the value of the source field N samples ago is to be ignored, the current rate of change value is logged as a NULL. Other Calculations HDA also supports several other unique calculation types. They include Equation, Last Valid Value, Maintenance Mode Flag Counter and No Calculation. EQU - Equation For equation calculations, you need to understand these concepts: Source field - the Group or HDA table field being used as input to the HDA calculation. Log Interval - the log interval of the HDA table with the EQU field. At each log interval, the current value of the EQU field is logged. A field with an EQU calculation type is configured with a standard CIMPLICITY expression that contains a source table and field. When HDA logs an EQU field, it logs the value of the configured expression, using the current value of the source table and field. LVV - Last Valid Value For last valid value calculations, you need to understand these concepts: Source field - the Group or HDA table field being used as input to the HDA calculation. Flag field - a field that is used to tell HDA to ignore invalid readings. Log Interval - the log interval of the HDA table with the LVV field. Sampling Interval - the log interval of the tables containing the source and flag fields. The Sampling Interval must be equal to the Log Interval. A field with an LVV calculation type depends on the value of a source field and the value of a flag field. At each log interval, HDA logs the most recent value of the source field where the corresponding flag field has a value of 1. MMC - Maintenance Mode Flag Counter For maintenance mode flag counter calculations, you need to understand these concepts: Flag field - a field that is used to tell HDA to ignore invalid readings. Block Period - the log interval of the HDA table with the MMC field. Sampling Interval - the interval at which a flag field will be evaluated. The Sampling Interval will be equal to the Block Period divided by the Sample Count. GFK-1379C Introduction 1-7

14 Time Interval - the length of time that the value of the flag field must be 1 for the MMC value to evaluate to 1. Reset Interval all statistics are reset at the end of each block period. Maintenance Mode Flag Counters are used to determine if a value is valid over an acceptable time period. For a Maintenance Mode Flag Counter field, HDA logs 1 if the flag field evaluated to 1 for a duration of time that equals or exceeds the configured time interval within a block period. Otherwise, the MMC field evaluates to 0. NC - No Calculation For no calculation calculations, you need to understand this concept: Log Interval - the log interval of the HDA table with the NC field. A field with an NC calculation type will not require any calculation. A text field will be created for the corresponding HDA table. Therefore, at each log interval, a blank text field exists that you can use to insert a comment for a given row of data. This field is not to be confused with the Comment field used by the Viewer/Editor when a user modifies table values. The Viewer/Editor Comment field only exists in the HDA_ORIG_VALUE table, and is used primarily for viewing when you are modifying fields in the Viewer/Editor. 1-8 CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

15 Historical Data Analyzer Special Features HDA logs values to the database based on the Calculation Type of an HDA field and the values of Source or Flag fields. The following are some other important features of the HDA option. Filling Gaps at Startup The Data Analyzer Resident Process fills the gap of data created when the process was most recently shut down. At startup, the process determines the most recent record for each HDA table and processes all of the records that would have been logged during this interval. The maximum limit for filling a gap is 24 hours. If the database was down, you should wait until the Database Logger completes Store and Forward before you start the Data Analyzer Resident Process. Performing Setpoints to CIMPLICITY Points You can associate an HDA Table field with a CIMPLICITY Point ID. While the project is running, the Point ID is updated with the field's value at each logging interval. You can also associate a validity field and a default field with the setpoint. The validity field and default field can belong to any HDA or Database Logger Group table. If the validity field evaluates to 1, the current value of the HDA field is used for the setpoint value. If the validity field evaluates to 0, the CIMPLICITY point will be set with the value of a default field. Saving Original Value of User Modified Values In the HDA Configuration process, you can set Edit permission for individual fields in Database Logger Group tables and HDA tables. You can then use the Viewer/Editor Modify Data dialog box to modify the values in these fields. When you modify a value, the original value is saved off to a separate database table called HDA_ORIG_VALUE. All comments that you supply are also logged directly to the HDA_ORIG_VALUE table. Each Original Value record contains the following fields: Timestamp Table ID Field ID Original value Comment GFK-1379C Introduction 1-9

16 The following rules apply to the table and its records: Once an original value is saved for a table, subsequent modifications of the field for that same time will not affect the contents of the original value. The Comment field, however, is modifiable. Each change of the Comment field overwrites a prior comment for the field and time. The HDA_ORIG_VALUE table contains only the original value of fields that you modify in the Viewer/Editor dialog box. If does not contain original values for fields that were modified during a recalculation. There is only one HDA_ORIG_VALUE table for a database. You configure the purging criteria for the HDA_VALUE_TABLE in the Historical Data Analyzer Configuration process CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

17 Using the Data Analyzer Configuration Process HDA Configuration Hierarchy In order to understand how to configure HDA data, you need to understand the requirements for and relationships between: HDA Sets HDA sets HDA tables HDA fields You may configure an HDA set at any time. The sole purpose of HDA sets is to define the time of day in which calculations begin for all HDA tables and fields belonging to that HDA set. For example, you may want to determine a daily average beginning at midnight, and determine a daily average beginning at 2AM. To accomplish this, you must configure two HDA sets one with a synchronization time of 0, and the other with a synchronization time of 2. If you do not need to make a distinction like the above example, you only need one HDA set for your entire implementation. A synchronization time of 0 (meaning that midnight resets calculations for the next set of daily statistics) is the most common configuration. HDA Tables An HDA table belongs to one and only one HDA set. Therefore, you must have the intended HDA set configured before you can create an HDA table. You must assign a unique name to each HDA table in your project. In addition, you cannot use the same name for a Database Logger table and an HDA table. GFK-1379C 2-1

18 Each HDA table represents a separate table in a database. The HDA table determines the interval that its fields are logged to the database. That is, all HDA fields that are configured for an HDA table will be logged to the same database table with the same logging frequency. HDA Fields You must have the intended HDA table and set configured before you can create an HDA field. Before you configure your first HDA field that uses a source field or flag field, you must have at least one Database Logger Group table configured with at least one field belonging to that Group table. Each HDA field represents a separate calculation that you want to capture. The calculation you configure is characterized by the source field and/or flag field, calculation type, and log interval of the corresponding HDA table. An HDA field may belong to one or more HDA tables, and may also belong to one or more HDA sets. Getting Started To configure the Historical Data Analyzer, select the Historical Data Analyzer icon from your project's Configuration menu. The Historical Data Analyzer Configuration window opens. The following is an example of the HDA Configuration screen with HDA Sets, Tables, and Fields already configured. 2-2 CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

19 You can use the Menu functions, Toolbar buttons and shortcut keys to: Create new sets, tables, and fields for Historical Data Analysis. Modify the properties of existing sets, tables, and fields for Historical Data Analysis. Delete HDA sets, tables, and fields. Restart the HDA processes with the new configuration. Edit Group table configuration. Control the display of the Toolbar and Status bar. Expand and collapse the tree. Access Help. About the Historical Data Analyzer Window The Historical Data Analyzer window is divided into two panes. The left-hand pane, also called the Tree pane, displays the Historical Data Analyzer tree with its sets, tables and fields. The right-hand pane is called the Grid pane. The Grid can be used to help you easily compare the fields configured for two or more tables. You can also use the Grid to organize your tables and fields and easily modify the logging criteria for an HDA field with respect to an HDA table. Moving Between the Tree and Grid Panes To change focus between the two panes, you can do either of the following: Move the mouse cursor to the pane you want to work in and click mouse button 1 once. Press Tab to change the focus between the panes. Historical Data Analyzer Configuration Menu Options You can use the menu options to create new, modify existing, or delete existing sets, tables and fields, edit Group table configuration, toggle the Toolbar and Status bar display, restart configuration, expand or collapse the configuration tree, and access Help. The File Menu When you select the File menu, the following drop-down list is displayed: GFK-1379C Using the Data Analyzer Configuration Process 2-3

20 The File menu functions are: New Creates a new set, table, or field. Properties Opens the Properties dialog box for the selected set, table, or field. Delete Deletes the currently selected item. Exit Exits the Historical Data Analyzer Configuration function. The Edit Menu When you select the Edit menu, the following drop-down list is displayed: The Edit menu functions are: Group Table Configuration Original Value Table Opens the Group Table Configuration dialog box. Defines purging for the HDA_ORIG_VALUE table in the Database Logger, similar to the purging conditions in the Table Property dialog box for HDA tables. The View Menu When you select the View menu, the following drop-down list is displayed: The View menu functions are: Toolbar Enables/disables the display of the Toolbar. Status Bar Enables/disables the display of the Status bar. The Tools Menu When you select the Tools menu, the following drop-down list is displayed: The Tools menu functions are: Restart Restarts the Historical Data Analyzer Resident Process and Recalculation Process and copies all HDA configuration from the master directory to the data directory. The two HDA processes will use the latest configuration once they have been restarted. 2-4 CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

21 The Tree Menu When you select the Tree menu, the following drop-down list is displayed: The Tree menu functions help you manipulate the HDA sets, tables, and fields in the Tree Pane area of the configuration screen: Expand Collapse Xfer All Fields Expands the selected set, table or field. Collapses the selected set, table or field Transfers all fields in the set to the Grid in order to compare the configuration of multiple tables and fields in the Grid. In order to transfer all fields to the Grid, you must first have at least one table residing in the Grid. Once you have selected any field in the set, select Xfer All Fields to transfer all fields to the Grid. Please see Displaying Tables in the Grid and Displaying Fields in the Grid later in this chapter for more information on working with the Grid. The Help Menu When you select the Help menu, the following drop-down list is displayed: The Help menu functions are: About CfgDa... Displays the current version number for the Historical Data Analyzer configuration program. Historical Data Analyzer Windows Pop-up Menus If you select an item from the tree in the Historical Data Analyzer main window, then click the right mouse button, the window pop-up menu is displayed. The window pop-up menu functions are: Delete Properties Deletes the selected Set ID, Table ID or Field ID from the tree. Opens the Properties dialog box for the selected object. If you select a Set ID, Table or Field the Set Properties dialog box opens. If you select a Table ID, the Table Properties dialog box opens. If you select a Field ID, the Field Properties dialog box opens. GFK-1379C Using the Data Analyzer Configuration Process 2-5

22 Historical Data Analyzer Configuration Toolbar Buttons The Toolbar buttons available to you are: New Set Creates a new set. New Table New Field Properties Delete Restart About Creates a new table. Creates a new field. Opens the Properties dialog box for the selected set, table, or field. Deletes the currently selected item. Restarts the Historical Data Analyzer Resident Process and Recalculation Process and copies all HDA Configuration from the master directory to the data directory. The two HDA processes will use the latest configuration once they have been restarted. Displays the About Historical Data Analyzer Configuration dialog box. Historical Data Analyzer Configuration Shortcut Keys You can use the following shortcut keys to initiate commonly used functions: Ctrl+N Creates a new set, table or field. Tab Changes focus between the Tree and Grid panes. Insert Inserts the currently selected table or field into the Grid pane. Ctrl+Page Opens the Field Table Relation dialog box for the currently selected field in the Grid pane. 2-6 CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

23 Adding a New Set To add a new set to the Historical Data Analyzer configuration, do one of the following: Select New, and then select Set from the File menu. Press the New Set button on the Toolbar. Press Ctrl+N. The New Set dialog box opens. To create the new set: 1. Enter the name of the new HDA set in the Set ID field. 2. Enter the synchronization time for the set in the Synch time field. This is the time of day that the calculations begin for all HDA tables and fields belonging to this set. 3. Select OK. If you do not want to create a set, select Cancel. Once you create a set, you can add HDA tables and fields. GFK-1379C Using the Data Analyzer Configuration Process 2-7

24 Adding a Table to a Set To add an HDA table to the set, do one of the following: Select New, and then select Table from the File menu. Press the New Table button on the Toolbar. Press Ctrl+N. The New Table dialog box opens. To create a new table: 1. Enter the name of the table in the Table ID field. 2. Select OK. Each new table that you create is added to the end of the Table branch for the set. After you select OK, the New Table dialog box displays the Logging Conditions, Maintenance Events and Maintenance Actions property pages for the table you just created. If you do not want to create a table, select Cancel. 2-8 CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

25 Logging Conditions The Logging Conditions property page for a Historical Data Analyzer table displays the current logging interval for the table. The default logging interval is 1 minute. To select a new interval: 1. Enter the interval value you want. 2. Select the interval units from the drop-down list. You can select MINUTES, HOURS, or DAYS GFK-1379C Using the Data Analyzer Configuration Process 2-9

26 Maintenance Events The Maintenance Events property page for a Historical Data Analyzer table displays the current maintenance events for the table. Maintenance actions occur when any of the events you configure on this property sheet occur. You can select: Triggered Maintenance Timed/Gated Maintenance Triggered Maintenance Events You can select either of the following triggered maintenance events: Disk space low Maintenance actions will be executed when disk space on the drive you select falls below the threshold you specify. The disk is checked for this condition at an interval that you specify in the Database Logger in the Logging Properties dialog box. Logging count Maintenance actions will be executed when the number of records logged to the table reaches a multiple of this number. Timed/Gated Maintenance Events You can select any of the following timed/gated maintenance events: Periodic Maintenance actions are executed at the time interval specified in these fields. Enter a value, then select the interval. Valid intervals are DAYS, HOURS, and MINUTES. Synchronized Maintenance actions are executed at the time of day specified in these fields. Enter the time in HH:MM format using a 12 hour clock, then enter AM or PM CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

27 Maintenance Actions The Maintenance Actions property page for a Historical Data Analyzer table displays the current maintenance actions for the table. Every maintenance action for a table will be performed whenever any of its maintenance events occurs. You can select: Export actions Purge actions Command actions Export Actions Export actions let you export data from the table to a CSV (Comma Separated Value) format file when a maintenance event occurs. You can choose to export one of the following: All All records in the table are exported. By count The last (most current) <n> records in the table are exported. By time Purge Actions Data entered in the table for the last <n> days, hours or minutes is exported. Purge actions let you delete data from the table when a maintenance event occurs. When you choose to delete records, you can also select the number of records you want to retain in the table. You can retain records: By count Delete all but the last (most recent) <n> records. By time Delete all but the records entered in the table for the last <n> days, hours, or minutes. GFK-1379C Using the Data Analyzer Configuration Process 2-11

28 In addition, you can choose to save the data to be purged from the table to a CSV (Comma Separated Value) format file before removing it from the table. Command Actions Command actions let you perform more complicated actions when maintenance events occur. You can select one or both of these actions: Execute SQL command Run program If you want to execute a SQL command when a maintenance event occurs, enter the SQL command in this field. If you want to run a program when a maintenance event occurs, enter the program pathname in this field. You may also include any command-line arguments supported by the program CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

29 Adding a Field to a Set and Table To add a new field to a set and table, do one of the following: Select New, and then select Field from the File menu. Press the New Field button on the Toolbar. Press Ctrl+N. In each case, you will be adding a field to the set that your cursor is currently on or under. The New Field dialog box opens. You must select a Table ID, edit permissions, a data type and a calculation type. Once you select the calculation type, additional fields are enabled for input. Enter information in all the fields for the calculation type you choose. After you have entered all the required information, select OK to create the field. If you do not want to create a field, select Cancel. Field ID Enter the name of the field. Table ID Select a Table in this Historical Data Analyzer Set where you want to use this field. A field must be associated with at least one table. Edit Permissions A feature of HDA is that users can edit logged data via the HDA Viewer Editor. This setting controls whether the user can or cannot edit this field. If you do not want users to edit this field, select No. Otherwise, select Yes. GFK-1379C Using the Data Analyzer Configuration Process 2-13

30 Data Type Select the data type for the field. You can select one of the following: DIGITAL Boolean data DINT Four-byte signed integer INT Two-byte signed integer REAL Eight-byte real SINT One-byte signed integer TEXT Text UDINT Four-byte unsigned integer UINT Two-byte unsigned integer USINT One-byte unsigned integer Calculation Type Select the calculation type for the field. You can select one of the following (See Historical Data Analyzer Calculation Types in Chapter 1 for a complete description of these calculation types): BAV Block Average BMN Block Minimum BMX Block Maximum BT Block Total EQU Equation LVV Last Valid Value MAV Moving Average MMC Maintenance Mode Flag Counter NC No Calculation RBA Running Block Average ROC Rate of Change RT Running Total The calculation type that you select activates other fields in this dialog box where you must enter information. Description Enter an optional description for the field CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

31 Source Table Select the Historical Data Analyzer table or Database Logger Group table where the source data for this field resides. If you select a Database Logger Group table as a Source table, be sure it is configured with at least one of the following options selected in the table property of the Group table: Periodic Select this option if table is to be logged with a time interval of SECONDS, MINUTES, HOURS, or DAYS. On Point value update Select this option if the table is to be logged when a point value is changed. (Tables with this configuration can only be used as source tables for Block and Running calculations) Note In order to see a new Database Logger Group table, exit out of the HDA Configuration window to get access to the new table. Source Field Select the field in the Source table where the source data resides. Flag Table (optional for Running, Moving, and Block calculations) Select the Historical Data Analyzer table or Database Logger Group table where the Flag Field resides. If you select a Database Logger Group table as a Flag table, be sure the Periodic option is selected in the table property of the Group table: Note In order to see a new Database Logger Group table, exit out of the HDA Configuration window to get access to the new table. Flag Field (optional for Running, Moving, and Block calculations) Select the field in the Flag table where the Flag field resides. The Flag field must be a Boolean type point. While it is set to 1, the source data is declared valid, and while it is set to 0, the source data is declared invalid. Sample Count This field is required for the MMC, MAV, RBA, and RT calculation types. Enter the number of samples to be included in the calculation. GFK-1379C Using the Data Analyzer Configuration Process 2-15

32 Time Interval This field is required for the MMC calculation type. Enter the number of consecutive minutes that the MMC field must be valid within the sample count for the MMC flag to be set to TRUE for the logging interval. Expression This field is required for the EQU calculation type. Enter the expression you want to calculate. For an expression to be valid, database fields must have the form: '<table>.<field>_val0' An example of a valid expression is: 'G1.A_VAL0'+1 Working with Tables and Fields The value of the HDA field with this expression will equal one 1 plus the current value of field A in table G1. Once you have defined a set and its tables and fields, you can: Display and modify set, table and field properties. Display the tables in the Grid. Display fields in the Grid. Specify the tables to which the fields will be logged. Specify the type of logging and define logging setpoints as required. Displaying Set Properties To display the set properties, select the Set ID in the tree, then do one of the following: Click the right mouse button to display the Windows pop-up menu, then select Properties. Select Properties from the File menu. The Set Properties dialog box opens. You can use this dialog box to change the Synch time for the set. To close the dialog box and save the new Synch time, select OK. Otherwise, select Cancel to close the dialog box without saving your changes CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

33 Displaying Table Properties To display a table's properties, select the Table ID in the tree, then do one of the following: Click the right mouse button to display the Windows pop-up menu, then select Properties. Select Properties from the File menu. The Table Properties dialog box opens. You can use this dialog box to change the Logging Conditions (see page 2-9), Maintenance Events (see page 2-10), and Maintenance Actions (see page 2-11) for the table. To close the dialog box and save your changes, select OK. Otherwise, select Cancel to close the dialog box without saving your changes. GFK-1379C Using the Data Analyzer Configuration Process 2-17

34 Displaying Field Properties To display a field's properties, select the Field in the tree, and then do one of the following: Click the right mouse button to display the Windows pop-up menu, then select Properties. Select Properties from the File menu. The Field Properties dialog box opens. Because a field's properties are defined uniquely for each table in which the field is inserted, the initial Field Properties screen only shows the Field ID. To display more information, go to the Table ID field and select the table for which you want to view the field's properties. For more information on the fields in this dialog box, see Adding a Field to a Set on page Make any changes necessary, then select OK to close the dialog box and save your changes. Otherwise, select Cancel to close the dialog box without saving your changes CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

35 Displaying Tables in the Grid You cannot display field information in The Grid can be used to help you easily compare the fields configured for two or the grid until you do this. more tables. In addition, the Grid can be used to organize your tables and fields and easily modify the logging criteria for an HDA field with respect to an HDA table. To display the column headings for the set's tables in the Grid, you can do one of the following in the tree: Double-click on each table you want to display. Select the tables you want to display, and then press the Insert key. You can display a maximum of ten (10) tables at the same time in the Grid. When you select the first table, the title bar in the Grid will change to display Fields in the first column, followed by the first Table ID in the second column. To delete a table's column from the Grid: 1. Click on the table's button in the header bar of the Grid. A dialog box opens and asks Remove table from the current view?. 2. Select OK to remove the tables from the grid. Otherwise, select Cancel to cancel the request without deleting the column. Once you have tables and fields in the Grid, you must clear the Grid in order to add more tables. To clear the Grid, select any set in the Tree. Displaying Fields in the Grid After you display column headings for the set's tables in the Grid, you can display field information. To display field information in the Grid, you can do one of the following in the tree: Double-click on the field name in the tree. Select the fields you want to display, and then press the Insert key. The field name displays in the Fields column of the Grid, followed by the field's logging criteria for every table in the Grid. The logging criteria can be one of the following: Logged the field that is in the first column of the current row is logged to the table that is in the first row of the current column Logged/Set the field that is in the first column of the current row is logged to the table that is in the first row of the current column, and a CIMPLICITY point is set with the current value of the field each time it is logged to the database. Not Logged the field that is in the first column of the current row is not logged to the table that is in the first row of the current column Once you display this information, you can change the field's status for each of the tables. GFK-1379C Using the Data Analyzer Configuration Process 2-19

36 Modifying a Field's Logging Criteria for a Table To modify a field's logging criteria for a table, do one of the following in the Grid: Double click on the field's row in the Grid. Select the field, then press Ctrl+Page Up. The Field Table Relation dialog box opens. For each table displayed in this dialog box, you can select Logged, Not Logged, or Logged/Set. If the table was set to Not Logged, and you select Logged, the Field Properties dialog box opens. If the table was set to Not Logged and you select Logged/Set, the Field Properties dialog box opens. When you complete your entries in that dialog box, the Setpoint dialog box opens. If the table was set to Logged and you select Logged/Set, the Setpoint dialog box opens CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

37 Defining Logging Setpoint Control To define setpoint control for a field in a table, select Logged/Set in the Field Table Relation dialog box. The Setpoint dialog box opens. Enter information in the following fields: Setpoint Enter the name of a CIMPLICITY Point ID that will be set to the field value when the field is logged. Validity flag table Enter the name of the Historical Data Analyzer table or Database Logger Group table that contains the validity flag field. This may be left blank if you do not wish to use a Validity flag field. Validity flag field Enter the name of the field that determines the validity of the calculated value. If the value in this field is 1, the CIMPLICITY Point ID is set to the value of the HDA field being logged. If the value in this field is 0 or NULL, the CIMPLICITY Point ID is set to the value of the Default field if a Default field exists. If you have no need for this field, you may choose to leave the Validity flag blank. The CIMPLICITY Point ID will always be set to the value of the HDA field being logged. Default table Enter the name of the Historical Data Analyzer table or Database Logger Group table that contains the Default field. This may be left blank if you do not wish to use a Default field. Default field Enter the name of the field that contains the default value for the setpoint. If the Validity flag field evaluates to 0 or NULL, the CIMPLICITY Point ID is set with the value of the Default field. If you have no need for this field, you may choose to leave the Default field blank. The CIMPLICITY Point ID will always be set to the value of the HDA field being logged, unless the Validity flag is configured and has a value of 0 or NULL, in which case no Setpoint will be made. After you have entered all the required information, select OK to create the setpoint. If you do not want to create a setpoint, select Cancel. GFK-1379C Using the Data Analyzer Configuration Process 2-21

38 Editing Group Table Configuration Fields in Database Logger Group tables cannot be modified in the HDA Viewer/Editor unless you modify their Edit permission. Use the Group Table Configuration dialog box to do this. To open the Group Table Configuration dialog box, select Group Table Configuration from the Edit menu. To change the Edit permission for a field: 1. Enter the Database Logger Group table in the Group table field. You can use the drop-down list button to the right of the field to select the table you want. 2. Enter the Group table field whose permissions you want to change in the Field field. You can use the drop-down list button to the right of the field to select the one you want. 3. Select YES in the Edit permission field if you want the field to be available for editing in the HDA Viewer/Editor. Select NO if you do not want the field to be available for editing. By default, all Group table fields have an Edit permission of NO CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

39 Using the HDA Viewer/Editor About the HDA Viewer/Editor The HDA-Viewer/Editor is an OLE object that you can include in CimEdit screens. These screens can than be viewed by users in CimView. In CimView, users can use the Viewer/Editor to view Database Logger Group tables or HDA tables, modify the information in the tables, and request recalculations of historical data based on their modifications. Inserting the HDA Viewer/Editor Object in CimEdit To create an HDA Viewer/Editor control on a screen in CimEdit: 1. Select the OLE Object tool. 2. Move the mouse pointer to select the position of the upper left corner of the Viewer/Editor, and click the left mouse button to fix it. The Insert Object dialog box opens: GFK-1379C 3-1

40 3. Select HDA-Viewer Editor Control from the list. 4. Select OK. A new HDA Viewer/Editor object will be placed in your CimEdit screen. The object looks like this: Once the Viewer/Editor is in the CimEdit screen, you may do one of the following: Resize the Viewer/Editor or move it using the borders. Display the HDA-Viewer/Editor Control Properties dialog box and configure the Viewer/Editor. 3-2 CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

41 Configuring HDA-Viewer/Editor Properties After you create an HDA-Viewer/Editor on your CimEdit screen, you can display and change its properties. To access the HDA-Viewer/Editor Control Properties dialog box, you can do one of the following: Double-click in the header or footer sections of the control. (Double clicking in the middle section is reserved for selecting one or more rows of data for a modify or recalculation) Select the Viewer/Editor, then select HDA-Viewer Editor Control Object from the Edit menu. This will show a cascading menu. Select Properties from the cascading menu. If you do any of the following, you will display the Object Properties dialog box for the object in CimEdit: Select Properties on the Edit menu. Click the Properties toolbar button on the Format toolbar. The information about an HDA-Viewer/Editor control includes: Date Filter Defines the start and end times that are used when selecting data from the database. Data Source Defines the database that you will be working with to view and modify HDA and Database Logger Group table data. Database Defines the project that contains the HDA configuration that you wish to work with. Also defines the table and fields to be displayed. Date/Time Format Defines the format for the timestamp field displayed on the Viewer Editor in CimView. GFK-1379C Using the HDA Viewer/Editor 3-3

42 Date Filter The Date Filter properties define the starting and ending times for the data display in CimView. When you fill in the date and time fields, the following rules apply when the Viewer/Editor displays initially in CimView: If you leave all fields blank, data for the current date, starting at midnight and ending at the current time is displayed. When the data is displayed in CimView, the Start date/time and End date/time fields will display "Not selected" If you enter a Start date and End date and leave the Start time and End time fields blank, data is retrieved starting at midnight of the Start date and ending at midnight of the End date. If you leave the Start date and Start time fields blank, and enter an End date and End time, data for the day specified in the End date is retrieved starting at midnight and ending at the End time. When the data is displayed in CimView, the Start date/time fields will display "Not selected". If you enter a Start date and Start time and leave the End date and End time fields blank, data for the day specified in the Start date is retrieved starting at the Start time and ending at midnight. When the data is displayed in CimView, the End date/time fields will display "Not selected". If you enter a Start date, Start time, End date and End time, all data for the time period you specified is retrieved. 3-4 CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

43 Data Source The Data Source properties define the database that contains the HDA and Database Logger Group tables that will be displayed. Select the data source to receive logged data. This field displays a current list of ODBC data sources. In general, it consists of a list of one or more Microsoft Access or SQL Servers. ODBC Data Source If you are on a CIMPLICITY HMI Server, select the data source that you have configured for Point Logging. To determine this: 1. Open a Database Logger screen. 2. Select Edit from the main menu. 3. Select Logging Properties. 4. From the Logging Properties dialog, select the Point Logging tab. The data source that is configured on this screen should be used for HDA as well. If you are on a CIMPLICITY HMI Viewer, follow the steps described above to determine the Point Logging data source on the Server that you intend to connect with. On the Viewer, you must create an ODBC data source that maps to the same database that the ODBC data source described above maps to on the Server. Please refer to the Managing Database Logging section in the CIMPLICITY HMI Base System User s Manual (GFK-1180) for instructions on how to add a Data Source. Database User Enter the username needed to connect to the selected database driver. This field is required if you are connecting to a SQL Server. GFK-1379C Using the HDA Viewer/Editor 3-5

44 Password Enter the password needed to connect to the selected database driver. This field is required if you are connecting to an SQL Server. Database Project Table Fields The Database properties define the Database Logger table and fields initially displayed by the Viewer/Editor. Select a project that you wish to work with. This field displays the current project (if on a Server node), and a list of all projects that broadcast data. The HDA Viewer Editor receives the HDA configuration from the Data Analyzer Recalculation Process. For this reason, the process DA_RC must be running when configuring this screen. The project that you specify determines the tables you will be able to select from, the tables and fields that you will be able to perform a recalculation on, and the fields that you will be able to modify. Enter the table that you want to display in the Viewer Editor. This field displays a list of all Database Logger Group and HDA tables for the specified project. Once you select the table, its fields are displayed in the Fields available list box. You can use the Add, Remove, Add All, and Remove All buttons to move fields between the two list boxes. Select fields from the Fields available list that you wish to display. Fields in the Fields available list are alphabetically sorted. Fields in the Fields to be displayed list are displayed in the order you select them. The selection order is also the order in which the fields are displayed in the Viewer/Editor. 3-6 CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

45 Date/Time Format You will be able to view all fields for the selected table, even if the field is not configured in your current project. This will enable you to easily compare values for fields from different projects that are logged to the same table. Displaying Fields To display a field: 1. Select the field name in the Fields available list box. 2. Select Add->. The field name will move from the Fields available list box to the Fields to be displayed list box. To display all fields, select Add All->. All field names will move from the Fields available list box to the Fields to be displayed list box. Removing Fields from the Display To remove a field from display: 1. Select the field name in the Fields to be displayed list box. 2. Select <-Remove. The field name will move from the Fields to be displayed list box to the Fields available list box. To remove all fields, select <-Remove All. All field names will move from the Fields to be displayed list box to the Fields available list box. The Date/Time Format properties define how the timestamp data for the table will be displayed. To configure the timestamp display, select the date and time format you want from the lists. A sample is displayed for each format you select. GFK-1379C Using the HDA Viewer/Editor 3-7

46 HDA-Viewer/Editor Actions in CimView When you display a CimView screen that contains an HDA-Viewer/Editor control object, the control displays HDA or Database Logger Group Table data. The display looks like this: You can do the following in the HDA-Viewer/Editor control object in CimView: Display the HDA-Viewer/Editor Control Properties dialog box and change the display properties Modify data in the table. Refresh data in the table. Send a request to the HDA Recalculation Process to recalculate HDA points based on modified data. 3-8 CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C

47 Modifying Data To display the Modify Field Data dialog box: 1. Select the range of rows for which you want to modify data. You can select a single row or use the Shift and Ctrl keys to select a range of rows. 2. Press the Modify button in the control. The Modify Field Data dialog box opens. 3. Use the drop-down list to the right of the Field to be modified to select the field you want to modify. All fields for the current table will be displayed provided they match the following criteria: the field is configured for the current table in the current project the Edit Permission is set to Yes for the field. 4. Enter the new value for the field in the New value field. Note that if the field is already modified, its original value is displayed in the Original value field. Also if you are modifying a single value, its current value is displayed in the Current value field. If you are modifying a range of rows, the Original value and Current value fields are blank unless all fields that you selected have the same original and current values. 5. If you want to make the data in the selected fields unavailable to the Historical Data Analyzer, check the Data marked unavailable check box. 6. If you want to enter a comment for the data, use the Comments field. 7. Select OK to update the display. Note The Viewer/Editor stores the original values for all data that you modify in the HDA_ORIG_VALUE table in the database. GFK-1379C Using the HDA Viewer/Editor 3-9

48 Refreshing Data Recalculating Data Press the Refresh button to refresh the data currently being displayed. The list of records is recreated after checking for the existence of the table and all its columns. Press the Recalc button to display the Recalculate Data dialog box. Use the Recalculate Data dialog box to request a recalculation of Historical Data Analyzer fields based on modifications you have made to the current table. If you select a field, all Historical Data Analyzer tables that reference the field are recalculated. You will only be able to issue a recalculation for fields that exist for the current table in the current project. If you select the entire table, all fields of the table you select and all HDA fields that reference fields in the table you select will be recalculated. After you select OK, the Data Analyzer Recalculation process recalculates all data over the specified interval. Once the Recalculation process has successfully received your request, you may resume working with the Viewer/Editor. The Recalculation process may take a few minutes to complete your request since it will have to go back and recreate all data over the specified interval CIMPLICITY HMI Historical Data Analyzer Operation Manual-December 2000 GFK-1379C