Flow Computer Tags
Like a Station tag, each Flow Computer tag will create many I/O tags that count towards your license limit. The number will vary according to configuration.
This tag provides a complete interface to a flow computer (EFM device) for logged data, process data, alarms and events. The Flow Computer tag is the basic building block of the Oil & Gas Solutions approach to EFM devices. It allows a complete field I/O device (flow computer) to be defined as a single tag structure. This Flow Computer tag will automatically generate child tags to perform the necessary device communication, data reading and logging for compliance data, as well as providing a way to define the device-specific I/O tags used for process monitoring and control functions.
There are many configuration options that control which child tags start and how those child tags operate. Flow Computer Overview and Design describes the details of creating a Flow Computer tag. This topic describe each of the child tags of the Flow Computer tag. Note that the majority of these tags will be created and configured automatically by the Flow Computer tag as child tags and do not need manual configuration.
One Flow Computer tag is required for each field I/O device (RTU).
Flow Computer Overview and Design
Flow Computer properties ID tab
In a Flow Computer tag, the Name + Description parameters are used to identify the location of the well.
The Area + Alarm Notification Area parameters are used for grouping, filtering, and roster control
Name & Description
Together, these parameters define a unique identifier for the equipment. In some jurisdictions, the description is typically set to the LSD Legal Subdivision address. or UWI Unique Well Identifier coordinates, but you are free to use whatever value makes sense for your system.
If using UWI coordinates, note the application property, UWISeparatorCharacters, which specifies that the following characters are to be removed from input UWI strings: - _ : / \
Area & Alarm Notification Area
The area parameter is used to group similar tags together, such as all wells within a given region. An Alarm Notification Area can be defined so that separate rosters can be defined within one region, or so that wells from several fields can use one roster.
The Alarm Notification Area property is inherited by several of the Polling Driver children of this tag and then by any I/O or alarms below those. Child tags that are not expected to generate alarms will inherit the Area property.
If no Alarm Notification Area property is defined, all child tags will default to the Area property.
Flow Computer properties I/O tab
Options within this tab vary depending on the selected Device Type. Several parameters are common to most device types and are described here first:
Configuration Address Override File,
Read Address Override File,
Write Address Override File,
CFX Mapping Override File
Not available for all device types.
Not all values read by the flow computer are represented by tags. Some configuration information, such as the gas composition, orifice, or pipe detail, is read by the Meter Run tag and saved as a single configuration record.
The addresses used to read and write this information are usually standard for a given device type, but if you need to change them you may do so by providing a new mapping CSV file to override the standard version. See CSV Override Files for Flow Computers.
The CFX Mapping Override can be used to customize the Well ID when running a CFX report. The default value, the meter run tag's name, is typically very long. With this parameter you can define the meter ID that is used in the CFX report. This is also used as part of the file path where the generated CFX report can be found.
Device Clock Time Zone
Select the time zone that the device uses in order to convert the time-stamped data from the device into UTC for storage in the VTScada historian. Regardless of the time zone selected with this option, the driver assumes that the device does NOT adjust its clock for daylight savings time (DST).
Defaults to the server's time zone, but may be set to use the device's clock if that is configured for UTC, otherwise any time zone where the device is located.
Station Address (This and station address mode are not used for all types)
The station address of the Modicon programmable logic controller. By default, the PLC Address field is set to 1.
An expression may be used to provide the address if needed. This may be required on a network where the address varies depending on the workstation where the tag is running.
Note that, to create a valid expression for an address that contains non-numeric characters, you must enclose the address in quotation marks. e.g. "31.0.0.0" See: Modbus Plus PLC Addressing.
Station Address Mode
Use to limit the range of allowed addresses. Select according to your hardware.
Should only be adjusted if the Flow Computer/POC has been configured to use one of the specific addressing modes.
Standard Address ... 1 - 255 according to Modbus Protocol. Extended addressing ranges are not supported.
Lufkin ELAM Address ... 1 - 2295
TeleBUS Extended Address ... 1 - 65534
Device Type
Device types are grouped by common options for configuration. Expand the type matching your system for relevant detail.
Station ID
The ID assigned to the Totalflow device.
Security Code
A four-digit number used to access to Totalflow device (if device security is enabled).
Read Events Using the New Events Code
Select this box to cause the alarm and events to be interpreted using the ABB Totalflow driver’s NEWEVENT code in the address, rather than the standard EVENT code.
Local Address
Local address of the RTU (1 – 127).
Delete Audit Log on Read
When selected, the audit log (also known as the alarm and event log) is cleared from the RTU every time it is read. This may result in more efficient audit log reads when the log is full.
Bristol Network Tag
This identifies the Bristol Network tag that is to be used by all of the flow computer’s Bristol drivers. As a general rule, there should be one Bristol Network tag for each Port tag in the system that is used by Bristol drivers.
Bristol Master RTU
The RTU that is a level above the current flow computer RTU in the Bristol BSAP network hierarchy. This is only relevant for Bristol RTUs that are not in direct communication with the VTScada server but are instead in communication with an intermediary Bristol RTU on a higher level in the network
Override Files
Because Bristol RTUs do not all use a single industry-standard flow computer program, Bristol Flow Computer tags in VTScada make extensive use of address override files.
By default, files for one type of ControlWave program are selected (sample address: @GV.RUN1_PIPE_DIAM). Files for another type of ControlWave program (sample address: @GV.WELL1_PIPE_DIAM) and for an example 3305 program (sample address: A03.PIPE.DIAM) are included with the Oil & Gas Solutions Layer installation. These files can be found below the Oil & Gas Solutions VTScada directory, (C:\VTScada\O&G Solutions\CSV_Overrides). Ensure that you select the set of files with the correct set of addresses for your RTU’s program. If none is a match, choose a set to use as a template for creating your own custom files that work with your custom program. See CSV Override Files for Flow Computers.
Also, note that not all Bristol flow computer programs necessarily use the same history files. Be sure to check the History Logs tab of the Flow Computer tag configuration to ensure that the addresses are correct.
All device types in this group use the following Enron Modbus configuration options. Address override files may be used.
Protocol Options
Selects between RTU and Open Modbus/TCP versions of the base Modbus protocol messaging format. Note that this selection is independent of the communication medium chosen so that Modbus RTU packets can be sent and received on TCP/IP and UDP/IP links as well as on direct serial links.
Modbus Address
The device’s Enron Modbus address. This is a numeric value in the range of 1 to 254 and will need to match the setting of your device. For SCADAPack RealFlo devices, the Enron Modbus device address is typically the Standard Modbus address +1.
User ID and User PIN
These must match one of the users that has been configured within the TeleBUS device. If users have not been configured then the defaults can be used: 1 for the ID and 1 for the PIN.
PLC Address
The PLC address, sometimes called the Modbus address, that uniquely identifies the device. This must match the address setting in the device.
Confirm Attempts
After sending a command to the RTU, VTScada will then poll the reply registers until they confirm receipt of the command (see Section 15 TeleBUS Driver Tags for more information). The Confirm Attempts parameter controls the maximum number of times the reply register will be polled before VTScada gives up and assumes that the command will not be completed.
Confirm Delay
After sending a command to the RTU, VTScada will then poll the reply registers until they confirm receipt of the command (see Section 15 TeleBUS Driver Tags for more information). The Confirm Delay parameter controls the wait time between each of these polls of the reply register. A shorter delay may result in faster polls, while a longer delay will minimize bandwidth by requiring fewer polls.
Calculation Method
The RealFlo implementation of the TeleBUS protocol requires knowledge of the calculation method (AGA-3, AGA-7, etc.). Choose the method that matches the one used by your RTU.
Protocol Options
This determines the protocol used by the TeleBUS driver’s lower level Modbus driver.
All Device Types in this group use the following ROC configuration options. Address override files cannot be used.
Station ID
The ID assigned to the ROC Device.
Host ID
The ID assigned to the VTScada application.
Station Group
The group assigned to the ROC Device.
Host Group
The group assigned to the VTScada application.
Flow Computer properties Communications tab
The Communication tab sets up a number of settings common to all field I/O devices that are used by the Flow Computer tag and child tags.
Port
Select the communication port used by the field I/O device driver. For most SCADA protocols (including Enron Modbus and ROC) multiple devices may share a single port to create multi-drop communication links. The port type selected here may be any of the standard VTScada port types:
- Direct connected serial port
- Dial up modem connected serial port
- TCP/IP networked port
- UDP/IP networked port
Time-Out Limit
The length of time, in seconds, that the driver will wait for a reply from the device when in query response mode.
Retries
The number of communication attempts that will be made by this driver if there is no reply to the initial message. An error will be declared after this number has been exceeded.
Process Data Hold
Select this option to have the process I/O tags hold their last read value in the event of a communication failure with the field I/O device.
Disable All Polling
If selected, all polling for this flow computer will be disabled, regardless of the data read settings or the process I/O scan interval settings.
Polling Group
Sets the polling group in all of the subordinate polling drivers. See the Polling Driver section in the standard VTScada help documentation for more details.
Read Configuration Data
Select the frequency and timing for when configuration data will be read. Options for timing vary according to the selected frequency of re
Read Daily Logged Data
Select the frequency and timing for when daily logged data will be read. Options for timing vary according to the selected frequency of reads.
Read Hourly Logged Data
Select the frequency and timing for when hourly logged data will be read. Options for timing vary according to the selected frequency of reads.
Read Alarms and Events
Select the frequency and timing for when alarm and event data will be read. Options for timing vary according to the selected frequency of reads.
ads.
Process I/O Scan Interval
Sets the poll interval (in seconds) for the process I/O data read from the field I/O devices.
This rate can be overridden by the manual polling and fast polling schemes used on some of the graphics displays.
Communications Statistics Reset Schedule
The Flow Computer tag tracks several communications statistics for its child drivers (good polls, last error code, etc.). This parameter determines how often those statistics are reset to zero.
Auto-Synchronize RTU Clock
Sets the schedule at which VTScada will attempt to synchronize the device’s internal clock to match the server’s clock. Note that this will account for the device’s time zone, as set in the Device Clock Time Zone parameter on the Communication tab. (Automatic synchronization may not be available for all device types.)
Clock Sync Deadband
The amount by which the RTU clock must differ from the server’s clock before VTScada will attempt to set the RTU’s clock.
To avoid conflicts if a clock is changed over the threshold of a contract hour, there is logic built in so that the clock will never be automatically set back over the threshold of an hour. For example, if the RTU clock is off by five minutes it will not be corrected from 11:03 to 10:58, but rather VTScada will wait and correct it from 11:06 to 11:01. For this reason, if the RTU clock is off by an hour or more it will not be automatically synchronized and should be explicitly reset through another method.
Flow Computer properties Flow Meters tab
Enable between one and eleven Meter Run Tags in the Flow Computer tag. For each meter run that is enabled, a number of child tags are started in the Flow Computer to gather and display information for that meter run. The settings for this tab are:
Enable
If selected, the appropriate Meter Run tag and its child tags will be created.
Description (not labeled)
Sets the description of the created Meter Run tag. Each tag's name will default to Meter N, where N is a number from 1 to 11.
Flow Computer properties History Logs tab
Configure the tags that are created automatically underneath the ‘Daily’ and ‘Hourly’ context tags within each of the Meter Run Tags created using the previous tab.
While a large selection of different history tags can be created from this user interface, some devices (such as the ROC RTUs) allow just about anything to be configured as history and as such have no defaults. Any tags that are created manually underneath the ‘Daily’ or ‘Hourly’ context tags will work alongside any that are created using this interface.
Some device software packages, such as the RealFlo or TFlo, have default sets of history tags. To make configuration of these devices easier, you are able to set the history addresses to the defaults for a particular calculation type. Note that choosing one of these defaults will override all other address changes.
Show Meter Run
Choose the Meter Run Tag to edit. All addresses shown will pertain to this meter run.
Show History Period
Select either the hourly or the daily history addresses for configuration.
Start with defaults for calculation type
Choose between AGA American Gas Association 3 (1985), AGA-3 (1992), or AGA-7.
AGA-7 is selected by default. Changing this parameter will reset all history addresses to their defaults.
History Addresses
Entering an address for a particular value will cause a child analog status tag to be automatically created in the ‘Daily’ or ‘Hourly’ context that uses this address. The tags for any values which are left blank will not be created.
Note the scroll bar to the right of the list of history addresses. It is not possible to show all of them on the screen at once.
Units
The units entered here will be passed down to the child Analog Status tags.
Flow Computer properties Meter Displays tab
Use when you prefer to represent one or more meter runs with your own graphics on the Flow Computer display page. The custom tab label and custom tab page will be used instead of the standard “Process” tab.
Parameterized pages can be used for these displays and will be passed the corresponding meter tag object as the first parameter when calling the page. This allows a single page to be used for multiple meters that have a common configuration.
The most common use of this feature is to display process values graphically. Refer Flow Computer Displays for more details on the standard display for the Flow Computer tag.
Meter X Custom Tab Label
(Where X ranges from 1 to 11) Text describing the custom page for each meter that has a custom page. You are advised to make the label as brief as possible while remaining descriptive.
Meter X Custom Tab Page
Select the page to use for meters. Parameterized pages are recommended, where the parameter specifies which meter is to be shown. Meter selection is based on which of the X custom pages you are configuring.
Flow Computer properties Lab Imports tab
Gas composition lab results can be automatically imported into VTScada and written out to the flow computers. The three settings (File Type, File Name and Unique ID Key) are used to match the entries in those lab results files to this flow computer’s Meter Run tags. (Importing Multiple Gas Well Lab Results Files).
Show Meter Run:
Select from each of the configured flow meters.
File Type
The file type is a droplist of all of the currently supported lab results formats. When a file is found whose name matches what a meter run is looking for, VTScada will then analyze it based on the format chosen in this parameter. May be any of:
-
AGAT
-
Cygnet
-
MaxxLink Common
-
OAS Chart
-
PVR
-
PVR FDC
Lab Results File Name
The file name is the first criterion used to link a meter run tag with its proper lab result during an import. When a file is detected in the source directory, VTScada tries to match its file name to the file name specified in each meter run. To allow for some variance in the lab file names (e.g. some files may have a date stamp as part of their name) the meter run’s string need only match part of the actual file name. If, for example, the actual file name is “OAS Chart System 06082017.csv”, entering “OAS Chart System” or simply “OAS” in the meter run’s string would be enough to trigger a match. This matching is not case sensitive.
Unique ID Key
The lab report files frequently contain more than one meter run’s worth of data. For this reason, each file type has one of its columns designated as a unique ID or key field. In order for the gas composition results to be uploaded to the flow computer, the value in this unique ID key field must exactly match the Unique ID Key value that was used when configuring the meter runs in the Flow Computer tag (see the table below for more information on the unique ID key fields for the various lab result formats). Any entries in the lab results that do not match one of the meter runs in the system are simply ignored.
File Type | Unique ID Key Column Number | Unique ID Key Column Name |
---|---|---|
AGAT | 3 | Sample Point Name |
Cygnet | 3 | ProTrend_MeterCode |
MaxxLink Common | (Row) 16 | Tag ID |
Netflow | 2 | Meter Code |
OAS Chart | 2 | Meter ID |
ProChart | 3 | Sample Point |
PVR | 3 | Sample Point |
PVR FDC | 5 | ProTrend Meter Code |
Flow Computer properties: CFX Setup tab
"CFX" is "Common File Exchange". This is a proprietary file format owned by Flow-Cal which is used to report on the production of gas wells.
VTScada uses the parameters on this tab only when writing a CFX Hourly Report or a CFX Daily Report. The parameters are written directly into the appropriate section of the CFX file.
Flow Computer properties Misc. tab
The Misc. tab is used to configure how the Flow Computer will appear on standard VTScada map displays. If left blank, the default values provide access to a set of standard displays described in Flow Computer Displays.
Latitude
Set the latitude for the Flow Computer in decimal degrees. If not defined, the Flow Computer will not appear on map displays. For this setting, positive numbers define locations east of the prime meridian and negative numbers define locations west of the prime meridian. To set a specific location on a map directly, use the standard VTScada “Update Site Location” tool.
Longitude
Set the longitude for the Flow Computer in decimal degrees. If not defined, the Flow Computer will not appear on map displays. For this setting, positive numbers define locations north of the equator and negative numbers define locations south of the equator. To set a specific location on a map directly, use the standard VTScada “Update Site Location” tool.
Custom Tab Label
Allows you to define a tab label on the built-in standard display for displaying the Custom Page Tab.
Page to Display in Custom Tab
Set the page to display on the built-in standard display that is specific to this Flow Computer. This can be a parameterized page and will be handed the tag value of the Flow Computer tag as its first parameter. Used this way, a single page can be used for multiple Flow Computers on their standard display.
Standard Site Dialog Override
If a page is selected for this parameter, that page will be shown instead of the standard flow computer site details page when a Flow Computer tag is clicked on the site list or the slippy map.
Hide Gas Configuration Tab
Selecting this box will hide the configuration tab on the standard flow computer site details page. As an example, it is appropriate to select this box for flow computers measuring liquids.
Security Privilege - Write Configuration Data to RTU
Set the security privilege required to write configuration changes to the field I/O device. If not selected, no security privilege is required for this action.
Security Privilege – Polling
Set the security privilege required to perform a demand poll of the RTU.
Historian
Selects the historian tag to use in conjunction with the data logging of all child tags. In most cases this can be left as the default, “System Historian”. See standard VTScada documentation for more details.
Display as List of Meters
When selected, the flow computer will appear on the sites page and slippy maps as a list of individual meter runs rather than as a single unified flow computer.
Custom Meter Displays Override Site Dialogs
When selected, clicking on the meter run on the sites page or slippy map will bring up the custom page selected on the Meter Displays tab rather than the standard site dialog with that page as one of the tabs. This setting is applicable only when the Display as List of Meters option is selected.
Flow Computer properties PVR Report tab
The PVR Process Volume Report Report Tab is used to assign a PVR Report Definition and one or more PVR Report Entity tags to each
meter in the Flow Computer.
The tools within this tab create the link between a Process Volume Report and the data collected by Flow Meters within your Flow Computer.
You must create the PVR Report Definition tag and configure its PVR Report Entity tags before configuring this tab.
Contract Hour
Sets the contract hour for the PVR Report. It is used by all meters in a Flow Computer. This field expects the contract hour to be in the form of a single number. (For example, enter 8 and not 8:00:00).
PVR Report Definition
Sets the PVR Report Definition tag used to create the report See: PVR Report Definition Tags
Entity
Sets the PVR Report Entity to include in the Flow Computer PVR Report. See: PVR Report Entity Tag
The following widgets are available to display information about your Flow Computer tags: