3000 - 6000 E Firmware and Software User Guide
3000 - 6000 E Firmware and Software User Guide
3000 - 6000 E Firmware and Software User Guide
January 2016
Revision A
Page 1 of 39
USER GUIDE
Document Revisions
Page 2 of 39
USER GUIDE
Table of Contents
1 Introduction.............................................................................................................................5
1.1 Purpose...............................................................................................................................5
1.2 Applicable Firmware Revisions...........................................................................................5
2 Security....................................................................................................................................5
2.1 Security Prior to Introduction of Enhancements................................................................5
2.2 Modbus Passwords.............................................................................................................6
2.3 Security after Introduction of Enhancements.....................................................................7
2.4 New OMNI Front Panel Password Maintenance screen...................................................10
2.5 Permissions Tab................................................................................................................11
2.6 Access Type.......................................................................................................................11
2.7 Read Only..........................................................................................................................12
2.8 Operations........................................................................................................................12
2.9 Configurations...................................................................................................................12
2.10 Custom..............................................................................................................................13
2.11 Administrator Functions...................................................................................................14
2.12 Port Security.....................................................................................................................15
3 Checksum Lists.......................................................................................................................18
6 Audit......................................................................................................................................20
6.1 Audit Log...........................................................................................................................21
6.2 Audit Variable Statements................................................................................................21
6.3 Audit GC Components......................................................................................................22
7 Products.................................................................................................................................23
7.1 Import / Export Products..................................................................................................23
7.2 Additional Products..........................................................................................................24
7.3 Numeric Product IDs.........................................................................................................25
8. Proving...................................................................................................................................25
8.1 Final Meter Factor............................................................................................................25
9 Virtual Inputs..........................................................................................................................27
9.1 Validation Thresholds.......................................................................................................28
9.2 Signal Type........................................................................................................................30
9.3 Input Type.........................................................................................................................30
9.4 Alarm Limits......................................................................................................................31
9.5 Virtual Input Value............................................................................................................32
9.6 Override Code...................................................................................................................33
9.7 Virtual Inputs Application Examples.................................................................................34
Page 3 of 39
USER GUIDE
Page 4 of 39
USER GUIDE
1 Introduction
1.1 Purpose
2 Security
The purpose of the security enhancements is to improve the security features of the Omni
3000/6000 flow computer.
Front Panel
The following 6-character alphanumeric password levels are available via the
front panel keypad in versions of firmware prior to the enhancements:
The Privileged level password must be entered at the front panel in order to edit the Level 1, 1A,
and 2 passwords.
Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.
Page 5 of 39
USER GUIDE
The OMNI will time out after one (1 hour) of inactivity after a valid password has been entered
and the password will have to be entered again to gain continued access.
There is also a setting from the front panel Password Menu to allow application of the program
lockout switch position (i.e., enable/disable program changes) to each of the Serial and Ethernet
communication ports.
The following 8-character alphanumeric password levels are available for each
of the independent Serial and Ethernet communication ports:
If the Privileged level password is entered at the front panel, the user may
assign/modify the Level A password for each Serial/Ethernet communication
port. The Level B and C passwords can only be assigned or modified using
OMNICOM, while online with the flow computer, from any OMNICOM screen.
OMNICOM needs to be connected to each port where you wish to assign a Level
B or Level C password.
The Omni flow computer will time out after 2 minutes of inactivity on the
communication port and the password will have to be entered again to regain
access.
User Security
With the introduction of the enhancements, OMNICOM will always prompt for a
password when attempting to connect to the flow computer. See Figure 1.
The default factory Administrator logon password is OMNI and can be entered in
uppercase or lowercase. When the long horizontal green status bar turns red after
entering the valid Administrator password, it indicates OMNICOM is now online with the
flow computer.
To access the OMNICOM Security menu, connect to an OMNI, and either click on the
“key” icon on the Ribbon menu or use the Toolbar menu to select Actions, then
Security. See Figure 2.
One Administrator and sixteen Users (1-16) are available for configuration.
Independent usernames and passwords for the Administrator and each User can be
configured. A blank password in the configuration is considered an “inactive” User. The
Administrator password cannot be blank.
2.3.2 Password
The factory default Administrator password is OMNI. For the Users, all factory
default passwords are blank, meaning they are disabled. The Administrator
password can be changed by entering an alpha-numeric password up to 6
characters long. The Administrator password cannot be blank.
The password configured here will be the password for the Administrator level
logons from OMNICOM as well as full access from the flow computer front
panel. The configured User passwords will also be used to provide access via
OMNICOM as well as front panel access. The passwords configured here are
limited to the characters that can be entered from the flow computer front
panel keypad.
Note: The Administrator can see all passwords from the security configuration
screen in OMNICOM. If the Administrator has selected the option to allow users
to change their password, the non-Administrator Users will see asterisks for their
particular password and will not have access to other user’s information.
2.3.3 User ID
This is a 16-character alpha-numeric User ID for identification and auditing. The
first four characters are always the User ID “Uxx-“ (where xx represents 00 for
Administrator or 01 through 16 for Users) and therefore only up to the last 12 of
the 16 alpha-numeric characters can be entered.
For non-Administrator Users, select the access level this User will have when
entering data at the front panel or when using WINPANEL. The following
selections are available:
None (default)
Level 2
Level 1A
Level 1
Privileged
Note: Refer to the “Front Panel” section earlier in this document under “Security
Prior to Introduction of Enhancements” for details of the type of access
permitted by each front panel access level.
Only the Administrator can access the front panel password menu.
The Permissions tab allows configuration of each individual User’s Access Type
to the Operations functions and the Configuration settings. See Figure 4.
Full Access
Selecting the “Full Access” option automatically provides access to all
Operations functions and Configuration areas and the thus all Operations and
Configuration settings are selected and disabled.
With the “Read Only” selection, the following permissions will not be
allowed.
2.8 Operations
For Read Only access type, the following Operations items can be
enabled or disabled for an individual User.
Retrieve Reports
Retrieve Archives
Batch Control
Prove Control
Test Communications
2.9 Configuration
General Setup
OMNI I/O
Communications Ports
Meter Runs
Station
Prover
Products
PID Control
Boolean and Variable Statements
Checksum Lists and Audit Configuration
K-Factors, Meter Factors, and Density Correction Factors
2.10 Custom
2.10.1 Operations
For Custom access type, the following Operations items can be
enabled or disabled for an individual User.
Retrieve Reports
Retrieve Archives
Archive Maintenance
Batch Control
Prove Control
Work online with individual Templates
Test Communications
2.10.2 Configuration
General Setup
OMNI I/O
Communications Ports
Meter Runs
Station
Prover
Products
PID Control
Boolean and Variable Statements
Checksum Lists and Audit Configuration
K-Factors, Meter Factors, and Density Correction
Factors
2.11.2 Import
The Administrator can connect to an OMNI flow computer and import a
saved encrypted security settings file from the PC hard disk into
OMNICOM, then transfer the security settings to the flow computer.
The Administrator will be asked if they wish to override the
Administrator settings that are currently in the OMNI. (The
Administrator settings include the Administrator’s user information, the
“allow users to change password” setting, and the port security
settings.) The default is “No”, so that only the User settings will be
overwritten.
2.11.3 Export
The Administrator can read the security settings from an OMNI into
OMNICOM and then export the security settings to an encrypted file on
the PC hard disk.
There are eight (8) password entries configurable for each port. However, It is
important to note that only with Ethernet ports can there be more than one user
connected simultaneously.
The following settings are available for each password entry. See Figure 6.
Port ID
Audit ID
ASCII Password
Integer Password
Time Out (seconds)
Port Security Level
Note: For serial ports on a peer-to-peer Master Omni flow computer or Slave Omni flow
computer, disable security on that port to ensure proper communications.
2.12.2 Port ID
For every physical port’s security configuration, there are 8 Port IDs pre-
assigned with the format “PXY-“where “X” is the port number 1-6 and
“Y” is the password entry 1-8. For example, physical port 1 is
automatically pre-assigned Port IDs P11-P18 and physical port 6 is
automatically pre-assigned P61–P68.
3 Checksum Lists
To enable fast remote auditing or for Change Management purposes, Four (4), user-
configurable lists of Modbus registers for creating checksums have been introduced.
The contents of each register in the individual checksum lists are summed to produce a
unique number or checksum. The Checksum Lists allow the flow computer to determine
when any register specified in a checksum list has changed value.
The flow computer generates and records independent alarms for each of the four lists
to indicate a change has occurred in the value of at least one of the configured registers
in the list. The user would then examine the Audit Report and Alarm Reports to identify
the change and take further appropriate actions. The checksum lists can easily be
configured from the OMNICOM “Configure/Checksum Lists” menu. See Figure 7.
The user enters up to 100 configuration registers for each of the four checksum lists.
The flow computer ignores real time variables that usually change constantly (e.g 7101
for Meter 1 Gross Flow Rate). For ease of use, the user should use the Database
Browser feature of OMNICOM to enable simple additions to this feature.
The five new checksums can be viewed from the front panel of the flow computer on
the same screen that contains the checksum of the firmware installed in the flow
computer, by pressing STATUS DISPLAY and scrolling to the bottom of the screen.
The following Modbus database registers in Table 1 are associated with the checksum
lists feature and may be read remotely using OMNI’s standard Modbus read commands.
The “Configuration List Entry” registers in the above Error! Reference source not found.
(e.g. 23300-23399), contain the Modbus register addresses of the registers specified in the
checksum list, not the values contained in the specified registers.
The additional 64 Boolean statements range from statement 11025 through 11088 and
begin as the 65th statement after statement 1088 in the OmniCom configuration screen.
The additional 64 Variable statements range from statement 27025 through 27088 and
begin as the 65th statement after statement 7088 in the OmniCom configuration screen.
See Figure 8.
The following Table 2 is a list of the Modbus registers associated with the pre-existing
and new Boolean and Variable statements after the enhancements.
The circular Historical Alarm Report has been expanded from storing 500 alarms to
storing 1000 alarms.
6 Audit
In previous versions of firmware where only the last 150 events are recorded,
the Audit Log could be retrieved as a text file or alternately as a comma-
separated file from archive 712. With the enhanced firmware, the Audit Log can
still be retrieved as a text file but archive 712 is no longer available and the
comma-separated file must now be retrieved from archive 713.
6.2 Audit Variable Statements
A new configuration option has been introduced, to record in the Audit Log
when changes are made to any configuration register by the result of user-
programmable custom Variable Statements. “Program Statement” will appear
in the Audit Log as the Source of change. The user should then review the
Program Statements and take any necessary actions. See Figure 9.
Select “Audit On” to audit configuration changes made by the Variable Statements.
The user has the option to Record or Not Record changes in the live or override
gas composition. See Figure 10.
Audit OFF
Audit both live and override GC components (default)
Audit override GC components
Audit live GC components
If a Gas Chromatograph is not configured in the Equipment List tab, only the following
options are available for selection:
Audit OFF
Audit override GC components
Similarly, if a user disables the GC in the Equipment List while the audit override selection
is “Audit both live and override GC components” or “Audit live GC components”,
OmniCom will automatically change the selection to “Audit override GC components”.
You may change the selection to Audit OFF if you wish.
7 Products
After starting OMNICOM and ensuring the appropriate configuration file has
been opened, access the Import/Export Product feature by right-clicking on any
product in the Configuration Tree or on any of the individual Product
configuration screens. See Figure 12.
When saving exported files, the default extension is "*. oXXprd", where XX is the
application version (20 or 24). However, the user may enter any extension.
Files may be imported only when offline but may be exported while online or
offline.
The configuration settings for ALL products will be exported. In the case of an
import, use caution, as ALL products will be overwritten with the contents of the
imported file.
Some polling systems cannot read ASCII string type Modbus registers from flow
computers that identify the configured products. Therefore, a 32-bit Integer
configuration register for each of the 32 products has been introduced in
versions 20.75.10 and 24.76.10 firmware so that in addition to, or instead of the
existing 8-character ASCII string, a meaningful number can be configured to
identify each product. The identifier can be from 1 to 7 digits wide with values
ranging from 1 to 9999999. The addresses are specified in Table 3.
PRODUCT IDs
Products ASCII String Registers New 32-Bit Integer Registers
1 – 16 4820 - 4835 15156 - 15171
17 – 32 4720 - 4735 15383 - 15398
Table 3. Product ID Addresses
8 Proving
A new option for calculating the Final Meter Factor on the prove sequence
report is introduced in firmware versions 22.75.10 and 26.75.10
The “Run Repeatability Based On” selections are still available as “Counts” or
“Meter Factor” and have not changed.
A new configuration setting titled “Final Meter Factor” has been introduced that
becomes available only when “Run Repeatability Based On” is configured as
“Meter Factor” instead of “Counts”. See Figure 14. There are two options
selectable for the Final Meter Factor. They are:
GSVp/GSVm
Average of Intermediate Meter Factors
GSVp/GSVm
Uses the Meter Factor method for run repeatability
comparisons by calculating an Intermediate Meter Factor
for each prove run. Calculates the Final Meter Factor with
the GSVp/GSVm method instead of using the average of the
Intermediate Meter Factors.
9 Virtual Inputs
Virtual Input channels 90-98 can be configured from OMNICOM under the Process I/O
section of the OMNI I/O node of the Configure tree. See Figure 15.
The Modbus registers that hold these user-specified configuration settings are:
17134 = Validation Threshold Low %
17135 = Validation Threshold High %
The Low and High Validation engineering values displayed in the Virtual Inputs
configuration screen are Read-Only and are automatically calculated by the flow
computer. See Figure 17.
9.1.2.1 Validation Threshold Low. This value is calculated using the low
percentage setting entered in the OMNICOM Factors and Constants
menu. It is used with the Low Alarm Limit and High Alarm Limit span
configured under the individual Virtual Input channel to calculate a Low
9.1.2.2 Validation Threshold High: This value is calculated using the high
percentage setting entered in the OMNICOM Factors and Constants
menu. It is used with the Low Alarm Limit and High Alarm Limit span
configured under the individual Virtual Input channel to calculate a High
Validation Threshold engineering value. When using an engineering
value above the calculated high threshold, a Transducer Fail High alarm
is raised, resulting in the flow computer using the override strategy
configured for the Virtual Input channel.
Unassigned
Temperature
Pressure
DP
Density/Gravity
Auxiliary Input
For Gas Applications, these additional items are available. See Figure 19.
N2
CO2
HV
SG as 4-20 mA
Register Description
7690 Input Value of Virtual Input #90
7691 Input Value of Virtual Input #91
7692 Input Value of Virtual Input #92
7693 Input Value of Virtual Input #93
7694 Input Value of Virtual Input #94
7695 Input Value of Virtual Input #95
7696 Input Value of Virtual Input #96
7697 Input Value of Virtual Input #97
7698 Input Value of Virtual Input #98
Table 4. Virtual Input Addresses
OMNICOM displays the register number next to the Tag ID on the Virtual Input
screen. See Figure 20.
The Override strategy for Remote Input channel 99 has not changed and
effectively still uses the Override value always written to it.
Never Use
Always Use
Use if validation threshold exceeded
Use last hour’s average if validation threshold exceeded
Note: The “moving” 60 minutes may not necessarily be the same as the
Weighted Average from the top of one hour to the top of the next hour.
Modbus register 7165 can be configured with an override value the flow
computer will always use or a value can be written to it via a remote Modbus
write or using a user-programmable Custom Variable statement to transfer the
value from a live input channel (e.g. Auxiliary Input 1 value stored in register
7809). The custom
7025: 7165=7809
Remark: M1Temp
The Virtual Input channel Alarm Limits settings are used to generate the M1
Temperature Lo Alarm or M1 Temperature High Alarm. However, if the live
temperature value being received by the Virtual Input channel from Auxiliary
Input #1 falls outside the Virtual Input channel operating alarm limits settings,
no override strategy is available in the firmware prior to the enhancements.
The Validation Thresholds Low and High values automatically calculated by the
flow computer will be -20.0 DegF and 120.0 DegF respectively.
When the value being written to Virtual Input 98 to Modbus register 7698 falls
to 0.0 DegF the flow computer will raise a Temperature Low Alarm and if it
continues to fall to -20.0 DegF the flow computer will raise a M1 Temperature
Transducer Fail Low alarm and will begin to use the override value of 75.0 DegF
much in the same way the strategy for a non-Virtual input channel can be
configured.
Conversely, when the value being written to Virtual Input 98 to Modbus register
7698 reaches a value of 100 DegF the flow computer will raise a M1
Temperature High alarm and if it continues to rise and reaches 120 DegF, the
flow computer will raise a M1 Temperature Transducer Fail High alarm and will
begin to use the override value of 75.0 DegF per the Override strategy that is
configured.
Note: If you do not see this selection in OMNICOM, you should upgrade to OMNICOM
version 1.55 or newer, which can be installed from the USB key attached to the device at
shipment.
The top left portion of the Browser screen, under the section “Database Information”
displays the Application version of the Modbus database that is currently being viewed.
To view a Modbus database for a different application version, you must open or create
a configuration file associated with the particular application you want to view. See
Figure 22.
A varied selection of “Data Type” search filters can be applied after specifying a “Find”
keyword. See Figure 23.
If the “Clear Filters” button is pressed, it will default to “All Data Types” as the Data Type
filter.
Secondary filters can also be applied. They are:
Meter 1
Meter 2
Meter 3
Meter 4
Station
System
Press the Search button to execute the search. Once the search is complete, the results
are sorted by register address. They can be resorted in a different order by clicking on
any of the column headers (e.g. Data Type).
The Browser can be invoked from configuration screens that accept Modbus register
addresses, such as Digital I/O or Analog Output configuration screens. To invoke, click
on the configuration entry field, then click on the ellipse (button with 3 dots) located to
the right of the setting to invoke the Browser. You may also right-click and select
Browser from the pop-up menu to invoke the Browser.
Once in the Browser, double-click on the register you want to put in the configuration
entry or highlight the register and press the 'Select' button.
To select multiple registers to put into a configuration list, such as the Archive
Configuration or Custom Packets, double-click on the Modbus register you wish to start
with. Select multiple registers from the Browser by holding the CTRL button and clicking
on the registers. Once all the registers are selected, press the 'Select' button. The
registers selected will be placed sequentially in the list beginning with the starting point
register.