TOP Server Configuration Guide: EFM Exporter Plug-In

Transcription

1 TOP Server 5.19 Configuration Guide: EFM Exporter Plug-In

2 Page 2 of 25 Table of Contents Introduction 3 Channel Setup 3 Device Setup Error! Bookmark not defined. Further Information Error! Bookmark not defined.

3 Page 3 of 25 Introduction The TOP Server EFM Exporter Plug-In allows polling of EFM records from meters configured under EFM Capable drivers. This document is intended to provide an easy to use reference guide on how to configuring EFM Data polling using the TOP Server EFM Exporter Plug-In. It is not intended to be a comprehensive manual on EFM Capable drivers or the EFM Exporter Plug-In; the help file should be referenced for any additional information if needed. This document will describe how to set up a Poll Group, how to add meters and exporters to that group, and describe the settings that will be encountered particularly in what situations they should be changed from the default values. Adding a Poll Group 1. In order to access the EFM Exporter Plug-In, the TOP Server view should be changed from Channels/Devices to EFM Exporter 2. Click to add a new Poll Group

4 Page 4 of Give the Poll Group a user configurable name this will be how the Poll Group appears in the EFM Exporter Plug-In Tree view and configure the polling behavior: a. On Demand Polling Only When this option is checked TOP Server will not automatically poll the meters, and will wait for a client application to write to the _Poll System tag available at the Poll Group Level. b. Poll Rate Specifies the interval (in Minutes, Hours, or Days) at which EFM Polls for this group will be executed. c. Base Start Time Specifies the time (24 hour format) at which polling should begin. d. Poll On Start When checked an EFM Poll will be triggered as soon as the EFM Exporter is started. This includes server restarts, service starts/stops, new projects being loaded to the runtime, or the EFM Exporter Plug-In being edited. Unless the EFM Pointer file was deleted this will not re-poll all EFM data, only data since the last poll.

5 Page 5 of 25 Adding a Meter to the Poll Group 1. Once the Poll group is set up, click OK to create it. Right click on the Poll Group to now add meters to it meters can be added individually, or multiple at once. Right clicking on Gas Meters will show a list of available Gas Meters in the TOP Server configuration, where Right clicking on Liquid Meters will show available Liquid Meters. 2. Select the desired EFM Meter(s) from the Meter Browser and click Apply to add them to the Poll Group.

6 Page 6 of 25 Adding an Exporter to the Poll Group Once meters have been added to the desired Poll Group, exporters can be configured for the meters in the group. Poll groups are not limited to a single exporter, so the same EFM data can be stored in multiple ways, without requiring additional EFM polls. Exporters are added to Liquid and Gas meter groups separately; Right Click on the appropriate meter group and specify what type of exporter should be added: Flow-Cal Exporter Flow-Cal Transaction Queue Exporter CSV Exporter PGAS Exporter Database Exporter Flow-Cal Exporter (Gas & Liquid) 1. After adding the Flow-Cal exporter, specify the properties of the generated.cfx File: a. Name: A user defined name this will be how the exporter appears in the EFM Plug-In configuration.

7 Page 7 of 25 b. History Type: Specify the type of history records that will be exported. The available options will differ depending on the type of meter that was selected: i. Type 1 (Gas Basic): Basic flow information for meters without online chromatographs (e.g. gas volume percentages) ii. Type 2 (Gas NX19/G1/G2): Data for NX19, Gross 1, and Gross 2 calculation methods. (AGA and industry standard methods for calculating flow) iii. Type 3 (Gas Analysis): Data for analysis values using AGA8-Detail calculations. iv. Type 4 (Gas Exotic): Data for exotic analysis values that are not typically used or available. v. Type 11 (Liquid Basic): Basic Liquid flow information without composition data. vi. Type 12 (Liquid Detail): Detailed liquid flow information that is required for most standards. vii. Type 13 (Liquid - Analysis): Detailed liquid flow and analysis information. c. CFX File Version: Specifies the CFX File Version to be used when exporting data. This parameter is fixed at Version 5 for Gas Meters and Version 7 for Liquid Meters. d. History Interval: Specifies the EFM data set that will be polled from the device.

8 Page 8 of 25 e. File Path: Specifies the file path where the.cfx file will be stored. Network drives are not supported when the TOP Server is running as a service. TOP Server must have write access to the specified directory. Supports the use of wildcards; a complete list of which can be found in the EFM Exporter Plug-in help file f. File Name: Specifies the name of the file. It does not require the.cfx extension, and supports wildcards. Flow-Cal Transaction Queue (Gas Only) 2. After selecting to create a Flow-Cal Transaction Queue exporter, specify the settings which TOP Server will use to insert the EFM data directly into the Flow-Cal transaction queue database. a. Name: A user configurable name of the exporter. This will be how the exporter appears in the TOP server EFM Exporter view. b. History Interval: Specifies the type of EFM History data that will be retrieved from each meter. While a single exporter can only support one History Interval (Hourly or Daily) a second exporter can use the same DSN to store the second data interval to the same database. c. DSN: Specifies the existing database connection object (a prerequisite for the Flow-Cal Transaction Queue Exporter), allows creation of a new one via the Configure DSN button. A system Administrator should be contacted for the proper DSN configuration.

9 Page 9 of 25 d. User name: Specifies the user account to be used for the DSN connection. e. Password: Specifies the password for the corresponding user name, if required by the database. CSV Exporter (Gas Only)

10 Page 10 of After adding a CSV Exporter, specify the format of the data to be stored in the CSV file. General Tab i. Name: Specifies the name of the exporter. This will be how the CSV exporter appears in the TOP server EFM Exporter Plug-In view. ii. EFM General: Enables/Disables which EFM types should be output to the CSV File. iii. EFM History: Specifies which EFM History Records will be polled. The default value (both checked) will output both Hourly and Daily EFM Data to separate CSV files. iv. Time Basis: Specifies the EFM Time record format that will be used when storing EFM records in the CSV file. 1. Device Time: EFM time records will respect the default device time format. 2. UTC: EFM time records will be in UTC Format 3. Local System: EFM time records will follow the local system time when stored in the CSV file. v. Time Format: Specifies the format template to be used when storing EFM time records in the CSV file. vi. Character Encoding: Specifies whether the EFM records will be written to the CSV file in ANSI or UTF-8 character encoding. vii. Delimiter: Specifies the delimiter to be used when storing EFM Records in the CSV file this has no impact on EFM polls or interpreting incoming records.

11 Page 11 of 25 Config Tab i. Column Name/EFM Attribute Mapping: Shows the EFM Configuration Attributes that will be written to the CSV file, with their default column headings. The order that the Attribute/Column appears in the table view will correspond to the order in which the attributes will be written to the CSV file. ii. Up/Down Button: Can be used to re-order existing Attribute/Column mappings. iii. Add/Edit/Delete Button: Can be used to add a new attribute/column mapping, or edit an existing one. iv. Import/Export Button: Imports an existing Attribute/Column mapping, or exports the current configuration to a file. v. File Path: Specifies the path where the CSV file will be created to store the Configuration EFM Records. This value is user configurable and supports the use of Wildcards.

12 Page 12 of 25 vi. File name: Specifies the name of the CSV file that will be created. This value is user configurable, and defaults to Config.CSV Alarms Tab i. Column Name/EFM Attribute Mapping: Shows the EFM Alarms Attributes that will be written to the CSV file, with their default column headings. The order that the Attribute/Column appears in the table view will correspond to the order in which the attributes will be written to the CSV file. ii. Up/Down Button: Can be used to re-order existing Attribute/Column mappings. iii. Add/Edit/Delete Button: Can be used to add a new attribute/column mapping, or edit an existing one. iv. Import/Export Button: Imports an existing Attribute/Column mapping, or exports the current configuration to a file. v. File Path: Specifies the path where the CSV file will be created to store the Alarm EFM Records. This value is user configurable and supports the use of Wildcards.

13 Page 13 of 25 vi. File name: Specifies the name of the CSV file that will be created. This value is user configurable, and defaults to Alarms.CSV Events Tab i. Column Name/EFM Attribute Mapping: Shows the EFM Events Attributes that will be written to the CSV file, with their default column headings. The order that the Attribute/Column appears in the table view will correspond to the order in which the attributes will be written to the CSV file. ii. Up/Down Button: Can be used to re-order existing Attribute/Column mappings. iii. Add/Edit/Delete Button: Can be used to add a new attribute/column mapping, or edit an existing one. iv. Import/Export Button: Imports an existing Attribute/Column mapping, or exports the current configuration to a file. v. File Path: Specifies the path where the CSV file will be created to store the Events EFM Records. This value is user configurable and supports the use of Wildcards.

14 Page 14 of 25 vi. File name: Specifies the name of the CSV file that will be created. This value is user configurable, and defaults to Events.CSV History Tab i. Column Name/EFM Attribute Mapping: Shows the EFM History Attributes that will be written to the CSV file, with their default column headings. The order that the Attribute/Column appears in the table view will correspond to the order in which the attributes will be written to the CSV file. ii. Up/Down Button: Can be used to re-order existing Attribute/Column mappings. iii. Add/Edit/Delete Button: Can be used to add a new attribute/column mapping, or edit an existing one.

15 Page 15 of 25 iv. Import/Export Button: Imports an existing Attribute/Column mapping, or exports the current configuration to a file. v. Enable Hourly History Output: Enables/Disables polling of Hourly History Records vi. Hourly File Path: Specifies where the CSV file will be created to store the Hourly History records. This value is user configurable and supports the use of Wildcards. vii. File Name: Specifies the name of the CSV file that will be created for the Hourly History records. This value is user configurable, and defaults to HourlyHistory.CSV viii. Enable Daily History Output: Enables/Disables polling of Daily History Records ix. Daily File Path: Specifies where the CSV file will be created to store the Daily History records. This value is user configurable and supports the use of Wildcards. x. File Name: Specifies the name of the CSV file that will be created for the Hourly History records. This value is user configurable, and defaults to DailyHistory.CSV

16 Page 16 of 25 PGAS Exporter (Gas Only) 4. After adding a PGAS Exporter, specify where the PGAS file will be created. a. Name: A user configurable name for the Exporter. This will be how the PGAS exporter will appear in the TOP Server EFM Exporter Plug-In view. b. Record Time Format: Specifies what time stamp will be used when recording EFM Records. i. Device Time: EFM time records will respect the default device time format. ii. UTC: EFM Time records will be in UTC Format. iii. Local System: EFM time records will follow the local system time when recorded. c. File Path: Specifies where the PGAS Exporter should export records to. This value is user configurable and supports the use of Wildcards. d. File name: Specifies the name of the PGAS Records file. This value is user configurable and supports the use of Wildcards. e. Enable Analytics (.ANA): Enables/Disables whether PGAS Analytics data should be exported, and how often.

17 Page 17 of 25 f. Enable Volume (.VOL): Enables/Disables whether PGAS Volume data should be exported, and how often.

18 Page 18 of 25 Database Exporter (Gas Only) 5. After adding a Database Exporter the connection to the Database must be configured, as well which tables the EFM records should be exported to: General Tab a. Name: A user defined name for the Database Exporter. This will be how the exporter will appear in the TOP Server EFM Exporter Plug-In view b. Description: An optional description of the database exporter. This value may be included in the export. c. EFM General: Enables/Disables which EFM types should be recorded in the database d. EFM History: Specifies which EFM History Records will be polled. The default value (both checked) will output both Hourly and Daily EFM Data to separate tables in the Database. e. Time Basis: Specifies the EFM Time record format that will be used when storing EFM records in the database. 1. Device Time: EFM time records will respect the default device time format. 2. UTC: EFM time records will be in UTC Format 3. Local System: EFM time records will be recorded in the database using the local system time. f. DSN: Browses for an existing database DSN. If the desired DSN does not yet exist, it must be created before any data will be exported to the database. g. User Name: Specifies the user name that the EFM exporter will use when authenticating with the database.

19 Page 19 of 25 h. Password: Specifies the password associated with the specified user name that the EFM exporter will use when authenticating with the database. i. Login: Timeout: Determines how long the TOP Server will wait for a response when attempting to connect to the specified DSN. Config Tab i. Column Name/EFM Attribute Mapping: Shows the EFM Configuration Attributes that will be recorded in the database table, with their default column headings. The order that the Attribute/Column appears in the table view will correspond to the order in which the columns will be created in the table. ii. Add/Edit/Delete Button: Can be used to add a new attribute/column mapping, edit an existing one, or delete a mapping that is no longer needed. iii. Import/Export Button: Imports an existing Attribute/Column mapping, or exports the current configuration to a file.

20 Page 20 of 25 iv. Reset: Clears the current column mappings. Reset is only available when the exporter is set to log to an existing table in the database. v. Table Selection: Specifies the table name that the Configuration EFM records will be logged to, and whether this is an existing table or one that will need to be created. Alarms Tab i. Column Name/EFM Attribute Mapping: Shows the EFM Alarm Attributes that will be recorded in the database table, with their default column headings. The order that the Attribute/Column appears in the table view will correspond to the order in which the columns will be created in the table. ii. Add/Edit/Delete Button: Can be used to add a new attribute/column mapping, edit an existing one, or delete a mapping that is no longer needed. iii. Import/Export Button: Imports an existing Attribute/Column mapping, or exports the current configuration to a file.

21 Page 21 of 25 iv. Reset: Clears the current column mappings. Reset is only available when the exporter is set to log to an existing table in the database. v. Table Selection: Specifies the table name that the Alarm EFM records will be logged to, and whether this is an existing table or one that will need to be created. Events Tab i. Column Name/EFM Attribute Mapping: Shows the EFM Events Attributes that will be recorded in the database table, with their default column headings. The order that the Attribute/Column appears in the table view will correspond to the order in which the columns will be created in the table. ii. Add/Edit/Delete Button: Can be used to add a new attribute/column mapping, edit an existing one, or delete a mapping that is no longer needed. iii. Import/Export Button: Imports an existing Attribute/Column mapping, or exports the current configuration to a file.

22 Page 22 of 25 iv. Reset: Clears the current column mappings. Reset is only available when the exporter is set to log to an existing table in the database. v. Table Selection: Specifies the table name that the Event EFM records will be logged to, and whether this is an existing table or one that will need to be created. Hourly History Tab i. Column Name/EFM Attribute Mapping: Shows the EFM Hourly History Attributes that will be recorded in the database table, with their default column headings. The order that the Attribute/Column appears in the table view will correspond to the order in which the columns will be created in the table. ii. Add/Edit/Delete Button: Can be used to add a new attribute/column mapping, edit an existing one, or delete a mapping that is no longer needed. iii. Import/Export Button: Imports an existing Attribute/Column mapping, or exports the current configuration to a file.

23 Page 23 of 25 iv. Reset: Clears the current column mappings. Reset is only available when the exporter is set to log to an existing table in the database. v. Table Selection: Specifies the table name that the Hourly History EFM records will be logged to, and whether this is an existing table or one that will need to be created. Daily History Tab i. Column Name/EFM Attribute Mapping: Shows the EFM Daily History Attributes that will be recorded in the database table, with their default column headings. The order that the Attribute/Column appears in the table view will correspond to the order in which the columns will be created in the table. ii. Add/Edit/Delete Button: Can be used to add a new attribute/column mapping, edit an existing one, or delete a mapping that is no longer needed. iii. Import/Export Button: Imports an existing Attribute/Column mapping, or exports the current configuration to a file.

24 Page 24 of 25 iv. Reset: Clears the current column mappings. Reset is only available when the exporter is set to log to an existing table in the database. v. Table Selection: Specifies the table name that the Daily History EFM records will be logged to, and whether this is an existing table or one that will need to be created. Conclusion This guide is intended as a quick-reference guide on how to set up the TOP Server EFM Exporter Plug-In to record EFM Data from EFM capable drivers. For further information on any topic the TOP Server help file and protocol documentation should be referenced. For additional help please contact the Software Toolbox Support team at: support@softwaretoolbox.com Phone: +1 (704)

25 Page 25 of 25