75% found this document useful (4 votes)
695 views668 pages

OmniCom Help

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
75% found this document useful (4 votes)
695 views668 pages

OmniCom Help

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 668

OMNICOM 3000/6000

Help
Omni Flow Computers, Inc.
Last Modified September 28, 2018

The OMNICOM Help describes how to configure and operate the OMNI
3000/6000 flow computer using the OMNICOM software. You will find topics
about dialogs and settings that may not apply to your metering application and
may not appear within OMNICOM. This is because the software automatically
enables only those dialogs and settings that apply to your particular applic-
ation, based upon your configured selections.

Command Line Switches


-TB Enable Terminal Block Diagram
-idleXXX Idle Poll - where XXX is a 16-bit integer value representing a time
in seconds where, if connected via TCP/IP, OMNICOM makes a read of a gen-
eric register to keep the connection alive
OMNICOM

Note: In the configuration screens you may:


Press ALT-M on a field to display the Modbus Register Number used in the
OMNI.
Press ALT-L on an edit field to display the range of the entry.

Topics
Getting Started 5
HowTo 6
Configuration 13
Report Template Editor 465
Operate 477
Diagnostics 518
Security 541
Menus 550
Standard Interface 614
Troubleshooting 628
Apply Bar 641
Database Browser 642
Print Lists 644
Edit Serial Passwords 645
Password 647
OMNICOM Logo Bar 648
Communication LEDs 649
Index 650
OMNICOM: OMNICOM

3
OMNICOM: OMNICOM

Below are links to the main topic categories of Configuring the OMNI. Click on a link to go to that cat-
egory.

General Setup
OMNI I/O
Ports
Meter Runs
Station
Prover
Products
Fluid Products
Gas Chromatograph

Below are links to the Action items:

Configuration
Report Template Editor
Operate
Diagnostics
Troubleshooting

4
OMNICOM: Getting Started

Getting Started
When you first go into the program, a new file is automatically opened for you using the File Applic-
ation and Version last used. The default is version 20.75 with the latest revision.

If you would like to create a new configuration file for a different application, select File New.

If you would like to open an existing configuration file, select File Open.

5
HowTo

How To Configure Sites 7


Topics How To Configure Units 8
How To Configure Communications Parameters 9
How To Configure Modem Settings 10
How To Edit Serial Passwords 11
How To Make a Connection 12
OMNICOM: How To Configure Sites

How To Configure Sites


From the Edit menu, select Sites.
The Setup Sites Screen is displayed. For more information see the help for the Setup Sites Screen.

To enter a new site:


Press Add Site
or click your right mouse button and select Add Site from the short cut menu.

The Setup Communications Screen is displayed. For more information see the help for the Setup
Communications Screen.

7
OMNICOM: How To Configure Units

How To Configure Units


From the Edit menu, select Sites.
The Setup Sites Screen is displayed. For more information see the help for the Setup Sites Screen.

To edit an existing site,


double click on a site in the list
or click once on a site in the list and press Edit Site
or click the right mouse button on a site in the list and select Edit Site from the shortcut
menu.

If there are no sites listed,


press Add Site
or click the right mouse button and select Add Site from the short cut menu.

The Setup Communications Screen is displayed. For more information see the help for the Setup
Communications Screen.

From the Setup Communications Screen, to edit a unit:


double click on a unit in the list
or click once on a unit in the list and press Edit Unit
or click the right mouse button on a unit in the list and select Edit Unit from the shortcut
menu.

If there are no units listed,


press Add Unit
or click the right mouse button and select Add Unit from the short cut menu.

The Setup Unit Screen is displayed. For more information see the help for the Setup Unit Screen.

8
OMNICOM: How To Configure Communications Parameters

How To Configure Communications Parameters


From the Edit menu, select Sites.
The Setup Sites Screen is displayed. For more information see the help for the Setup Sites Screen.

To edit an existing site,


double click on a site in the list
or click once on a site in the list and press Edit Site
or click the right mouse button on a site in the list and select Edit Site from the shortcut
menu.

If there are no sites listed,


press Add Site
or click the right mouse button and select Add Site from the short cut menu.

The Setup Communications Screen is displayed. For more information see the help for the Setup
Communications Screen.

9
OMNICOM: How To Configure Modem Settings

How To Configure Modem Settings


From the Edit menu, select Sites.
The Setup Sites Screen is displayed. For more information see the help for the Setup Sites Screen.

To edit an existing site,


double click on a site in the list
or click once on a site in the list and press Edit Site
or click the right mouse button on a site in the list and select Edit Site from the shortcut
menu.

If there are no sites listed,


press Add Site
or click the right mouse button and select Add Site from the short cut menu.

The Setup Communications Screen is displayed. For more information see the help for the Setup
Communications Screen.
If you are adding a site:
Select a media type of Modem or Satellite.
Press Modem Settings.
Follow the instructions for the Setup Modem Screen.

Note: If you do not see the "Modem Settings" button, be sure you have selected a media type of
"Modem" or "Satellite".

10
OMNICOM: How To Edit Serial Passwords

How To Edit Serial Passwords


For firmware versions prior to XX.75.10, please see the help for Edit Serial Passwords.

For firmware versions XX.75.10 and higher, please see the help for Port Security.

11
OMNICOM: How To Make a Connection

How To Make a Connection


From the Online menu, select Connect.

The Connection Screen is displayed.

To connect:
double click on a site in the list
or select a site and press Connect.

For more information, see the help for the Connect Screen.

12
Configuration

General Setup 15
Topics OMNI I/O 49
Ports 108
Meter Run 134
Station 207
Prover 227
Products 262
Fluid Products 349
PID Control 388
Statements 399
Custom Packets 418
Batch 448
Gas Chromatograph 413
Allen-Bradley PLC 437
Peer to Peer 456
Front Panel Counters 395
User Displays 397
Archives 433
Checksum Lists 435
Audit 436
Local Printer 442
Report Setup 443
Premium Billing 461
Blank Page 463
Configuration Print 464
OMNICOM: Configuration

This menu is used to specify what physical I/O will be connected to the target flow computer and to
what I/O points.

IMPORTANT: You are advised to complete all entries in these sections before proceeding. Only
transducer points that have been assigned to physical I/O points will be available for further con-
figuration. Based upon your selections, OMNICOM makes available only those options that apply to
your metering system configuration.

14
OMNICOM: General Setup

General Setup
The OMNI General Setup tabbed dialogs are for entering and selecting core OMNI settings. You
must enter these settings first before you can proceed with the OMNI configuration. Based upon
your selections, OMNICOM makes available only those options that apply to your metering system
configuration.

Topics
The items listed below are links to topics within the General Setup category. Click on a link to go to
that topic.

Setup
System Date (Online only)
System Time (Online only)
Equipment List
Factors and Constants
Totalizers
Decimal Resolution

Factors and Constants


Factors and Constants (Firmware Version 20)
Factors and Constants (Firmware Version 21)
Factors and Constants (Firmware Version 22)
Factors and Constants (Firmware Version 23)
Factors and Constants (Firmware Version 24)
Factors and Constants (Firmware Version 26)
Factors and Constants (Firmware Version 27)

15
OMNICOM: Setup

Setup
The Setup dialog within the OMNI General Setup category is for entering OMNI identification inform-
ation. You can also select how dates are entered and displayed, and if and when you want OMNI
firmware to adjust for daylight savings time. Once you enter the information and/or make your selec-
tions, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Setup dialog. Click on a set-
ting for more information.

OMNI Identification

ID: Enter the required information that identifies your OMNI up to 8 alphanumeric characters.

Location: Enter the location of your OMNI using up to 38 alphanumeric characters.

Company Name: Enter a the name of your company. You may use up to 38 alphanumeric
characters.

Date Format

Select the date format you want to use for the display and reports.

Note: The date format may not be changed when the archive is running. The archive records are
stored with a date and time stamp according to the date format. If you would like to change the date
format, stop the archive, make your date format change, and start the archive running again. To stop
and start the archive use the Archive Maintenance screen.

Daylight Savings

Select this option if you want the OMNI to automatically adjust for daylight savings time. When select-
ing daylight savings time, you must enter the starting and ending dates for daylight savings in the
fields provided. The current dates are displayed in the edit box. A calendar drop down is provided for
easy date selection.

If the dates are invalid, a message is displayed and the Apply button is automatically enabled. Press
Apply to correct the dates.

To disable daylight savings, enter a date of 01/01/11 in the calendar drop down. On apply,
OMNICOM sends a date of "00/00/00" to the OMNI and essentially disables the option in the firm-
ware. (A blank date is considered a valid date and the daylight savings option is also disabled in the
firmware.)

Daylight Savings Start Date: Enter the date that 'Daylight Savings Time' starts. At 2:00 AM
on this date the flow computer will automatically adjust the clock +1 hour (from 2:00 AM to

16
OMNICOM: Setup

3:00 AM).

Daylight Savings End Date: Enter the date that 'Daylight Savings Time' ends. At 2:00 AM
on this date the flow computer will automatically adjust the clock -1 hour (from 2:00 AM to 1:00
AM).

Note: These daylight savings dates must be manually entered each year. The OMNI does not auto-
matically reset them.

Note: If an external device is synchronizing the time in the flow computer, these settings should not
be used as they are not needed and may in some cases interfere with the time synchronization by
the external device. The time should only be synchronized once or twice per day at non-critical times
such as 03:20:00 or 22:20:00 as it is not advised to change time at the top of the hour when critical
events are taking place in the flow computer.

Default Screen Display (available with firmware versions 20.74.30, 22.74.30,


23.74.30, 24.74.19, 26.74.10, and 27.74.21 and higher)

Status Screen Default checkbox - check the box if you would like the OMNI to default to the
Status Screen on power up. If the box is not checked, the OMNI will default to the last display it was
on before the power went down. (The default is not checked.)

Note: If you are on a configuration or diagnostics screen when the power goes down, the OMNI
defaults to the Status Screen regardless of this setting.

OMNI Type

The user may change the OMNI Type (3000 or 6000) in the file only while offline. Online this field is
disabled and the setting from the OMNI is used.

Note: this setting is not transferred with the file so the user may wish to ensure that the setting in the
OMNI matches the setting in the file.

17
OMNICOM: System Date

System Date
Enter the date using the date format in the OMNI:

MM/DD/YY
DD/MM/YY

18
OMNICOM: System Time

System Time
Enter the time using HH:MM:SS format.

19
OMNICOM: Equipment List

Equipment List
The Equipment List dialog within the OMNI General Setup category is for indicating the process
instruments, peripherals, and inputs used in your OMNI system. Once you enter the information
and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are the descriptions of each setting option within the Equipment List dialog.
Click on a setting for more information.

Meter Run

Check the meter run box to enable a meter run configuration. Select the transducer types connected
to the OMNI for each meter run. Each entry selected will enable the setup for that transducer in
OMNICOM.

Station

Check the station box to enable a station configuration. Select the transducer types connected to the
OMNI for the station (if any). Each entry selected will enable the setup for that transducer in
OMNICOM.

Prover (firmware versions 20, 22, 24, and 26)

Select this option if you will be doing flowmeter proving. If selected, this setting enables the Prover
setup within OMNICOM.

Switch Bar Temperature is used with provers such as the Enraf Calibron provers. (Available with
firmware versions 20.74.30, 22.74.30, 24.74.30, and 26.74.30 and higher.)

Plenum Pressure is used with provers such as the Emerson\Brooks compact provers.

Peripherals

Select the peripherals you are going to use with OMNICOM and your OMNI. If selected, these set-
tings enable the Local Printer and Allen Bradley PLC setup within OMNICOM.

Note: Remember to configure each on their respective Ports in order to enable their entries in the
configuration tree (right hand pane).

Inputs

Select this option if you are going to use Auxiliary Inputs. If selected, this setting enables the Auxiliary
Input setup within OMNICOM.

Note: Remote Inputs are always selected.

20
OMNICOM: Equipment List

Quality (firmware versions 23 and 27)

Check the box if the OMNI is to communicate with a Gas Chromatograph (or two).

Note: Remember to set up the communications type in the Serial Port 3 configuration in order to see
the Gas Chromatograph entry in the configuration tree.

Options (firmware versions 23 and 27)

Check this box if you wish to enable the proving configuration entry in the configuration tree.

21
OMNICOM: Factors and Constants

Factors and Constants

Topics
Factors and Constants (Firmware Version 20)
Factors and Constants (Firmware Version 21)
Factors and Constants (Firmware Version 22)
Factors and Constants (Firmware Version 23)
Factors and Constants (Firmware Version 24)
Factors and Constants (Firmware Version 26)
Factors and Constants (Firmware Version 27)

22
OMNICOM: Factors and Constants (Firmware Version 20)

Factors and Constants (Firmware Version 20)


The Factors and Constants dialog within the OMNI General Setup category is for entering applic-
ation specific conversion factors and constants. Once you enter the information and/or make your
selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Factors and Constants dia-
log. Click on a setting for more information.

Alarms

Alarm Deadband %: Nuisance alarms can occur when input variables spend any amount of
time near the high or low alarm setpoints. These nuisance alarms can swamp the alarm log
with useless alarms leaving no room for real alarms. This entry sets a percentage limit based
on the "high alarm" entry. A variable must return within the high/low alarm limits by more than
this amount before the alarm is cleared. The default is zero.

For Example: High limit is 100 degF, Low limit is 20 degF, Alarm deadband is set to 2
percent.

A transducer input which exceeds 100 degF will set the 'high alarm'. The transducer sig-
nal must drop below 98 degF (calculated as 100.0 * 0.02 = 2.0 degF therefore 100.0
degF – 2.0 degF = 98.0 degF) before the high alarm will clear.

A transducer input which falls below 20 degF will set the ‘low alarm’. The transducer sig-
nal must rise above 22 degF (calculated as 100.0 * 0.02 = 2.0 degF therefore 20.0 degF
+ 2.0 degF = 22.0 degF) before the low alarm will clear. Note that this deadband value,
in engineering units, is also calculated using the High Alarm Limit setting, not the Low
Alarm Limit setting.

Nuisance Alarm Timer (sec): Nuisance alarms can occur if input variables are toggling in
and out of alarm. These nuisance alarms can swamp the alarm log with useless alarms leav-
ing no room for real alarms. When an alarm occurs, it is recorded immediately in the alarm log
and the Nuisance Alarm Timer is started. If the same alarm occurs again while the timer is act-
ive, it will not be recorded in the log. Enter '0' seconds if you would like to record the alarm
every time it occurs. The default is zero.

Constants

Flow Rate Average Factor: The flow averaging factor is the number of calculation cycles
used to smooth the calculated and displayed flow rates. A number from 1 to 99 will be accep-
ted (a calculation cycle is 500 ms). The default value is zero.

23
OMNICOM: Factors and Constants (Firmware Version 20)

Weight of Water at 60 degF: The weight of a barrel of water at 60 degF and 14.696 PSIA.
Used to convert specific gravity units to density units for calculating mass. (From GPA 2145-
92: 8.3372 lbs/Gal = 350.162 lbs/BBL.) NOTE:this is the true weight of water, NOT the con-
version factor used to convert g/cc to lb/BBL sometimes given as 350.507. The default value is
350.161 lb/BBL.

Conditions

Atmospheric Pressure: This is used to convert flowing pressure readings to absolute pres-
sure units. If the pressure sensor provides pressure in absolute instead of gauge, the Atmo-
spheric Pressure should be set to zero so that no conversion takes place. The default is
14.696 PSIA.

Conversion Factors (available with firmware versions 20.74.22 and higher)

g/cc to lb/ft3: Flowing density measured by most pulse type online densitometers provide
grams/cc density units while the Anhydrous Ammonia in version 20.74.22+ firmware require
density to be measured using lb/ft3. Enter the conversion factor needed to convert grams/cc
to lb/ft3. The default is 62.42797.

Transmitter Fail Setpoints (available with firmware versions 20.75.02 and higher)

Transmitter Fail Low: a global setting for all transmitters used to discern the difference
between a 4-20mA transmitter failure on the low end versus a process variable saturation.
The default value is -3.00%. A reasonable range is -8% to 0% which gives values of 2.72mA
to 4mA.

Transmitter Fail High: a global setting for all transmitters used to discern the difference
between a 4-20mA transmitter failure on the high end versus a process variable saturation.
The default value is 110.00%. A reasonable range is 100% to 112% which gives values of
20mA to 21.92mA.

Validation Threshold (available for 20.75.10 and higher)

Validation Threshold Low: a global setting for all virtual inputs that when used with the val-
idation threshold override strategy, will raise a transducer fail low alarm and will cause the
OMNI to use the configured override value for the stream variable if the virtual input value is
less than the threshold low percentage of alarm span applied to the low alarm value for the
stream variable. The default is 20%.

Example: Meter Run 2 Temperature is assigned to Virtual Input 98 and the validation
threshold low is set for 20%. If the override strategy is set to 'Validation Threshold' and the Vir-
tual Input 98 value is more than 20% lower than the Meter Run 2 Temperature Alarm Low
value, a transducer fail low alarm will be raised and the override value for Meter Run 2 Tem-
perature will be used.)

Validation Threshold High: a global setting for all virtual inputs that when used with the val-
idation threshold override strategy, will raise a transducer fail high alarm and will cause the

24
OMNICOM: Factors and Constants (Firmware Version 20)

OMNI to use the configured override value for the stream variable if the virtual input value is
greater than the threshold high percentage of alarm span applied to the high alarm value for
the stream variable. The default is 20%.

Example: Meter Run 2 Temperature is assigned to Virtual Input 98 and the validation
threshold high is set for 20%. If the override strategy is set to 'Validation Threshold' and the Vir-
tual Input 98 value is more than 20% of alarm span higher than the Meter Run 2 Temperature
Alarm High value, a transducer fail high alarm will be raised and the override value for Meter
Run 2 Temperature will be used.)

25
OMNICOM: Factors and Constants (Firmware Version 21)

Factors and Constants (Firmware Version 21)


The Factors and Constants dialog within the OMNI General Setup category is for entering applic-
ation specific conversion factors and constants. Once you enter the information and/or make your
selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Factors and Constants dia-
log. Click on a setting for more information.

Alarms

Alarm Deadband %: Nuisance alarms can occur when input variables spend any amount of
time near the high or low alarm setpoints. These nuisance alarms can swamp the alarm log
with useless alarms leaving no room for real alarms. This entry sets a percentage limit based
on the "high alarm" entry. A variable must return within the high/low alarm limits by more than
this amount before the alarm is cleared. The default is zero.

For Example: High limit is 100 degF, Low limit is 20 degF, Alarm deadband is set to 2
percent.

A transducer input which exceeds 100 degF will set the 'high alarm'. The transducer sig-
nal must drop below 98 degF (calculated as 100.0 * 0.02 = 2.0 degF therefore 100.0
degF – 2.0 degF = 98.0 degF) before the high alarm will clear.

A transducer input which falls below 20 degF will set the ‘low alarm’. The transducer sig-
nal must rise above 22 degF (calculated as 100.0 * 0.02 = 2.0 degF therefore 20.0 degF
+ 2.0 degF = 22.0 degF) before the low alarm will clear. Note that this deadband value,
in engineering units, is also calculated using the High Alarm Limit setting, not the Low
Alarm Limit setting.

Nuisance Alarm Timer (sec): Nuisance alarms can occur if input variables are toggling in
and out of alarm. These nuisance alarms can swamp the alarm log with useless alarms leav-
ing no room for real alarms. When an alarm occurs, it is recorded immediately in the alarm log
and the Nuisance Alarm Timer is started. If the same alarm occurs again while the timer is act-
ive, it will not be recorded in the log. Enter '0' seconds if you would like to record the alarm
every time it occurs. The default is zero.

Constants

Weight of Water at 60 degF: The weight of a barrel of water at 60 degF and 14.696 PSIA.
Used to convert specific gravity units to density units for calculating mass. (From GPA 2145-
92 = 8.3372 Lbs/Gal. = 350.162 Lbs/BBL). NOTE: this is the true weight of water, NOT the
conversion factor used to convert g/cc to lb/BBL sometimes given as 350.507. (Default =
350.161 lb/BBL).

26
OMNICOM: Factors and Constants (Firmware Version 21)

Conditions

Atmospheric Pressure: This is used to convert flowing pressure readings to absolute pres-
sure units. If the pressure sensor provides pressure in absolute instead of gauge the Atmo-
spheric Pressure should be set to zero so that no conversion takes place. (Default value is
14.696 PSIA.)

Flow Averaging Method

Two methods are available. BOTH methods do not modify the averaged variable if there is no flow
taking place.

'Time Weighted' averages are:


Average = (sum all sample values taken every 500ms) / number of 500ms samples

'Flow Weighted' averages are:


Average = (sum of all (sample values x flow increment)) / total flow

Conversion Factors

ft3 to BBLs (Cubic Feet to Barrels Conversion): AGA 3-92 equations provide flowing volume
in actual and standard cubic feet. For liquid applications, the flow computer displays volumes
using gross and net barrels. Enter the conversion factor needed to convert cubic feet to bar-
rels. (Default value is 5.614555)

g/cc to lb/ft3: Flowing density measured by most pulse type online densitometers provide
grams/cc density units while the AGA 3-92 equations require density to be measured using
lb/ft3. Enter the conversion factor needed to convert grams/cc to lb/ft3. (Default value is
62.42797).

27
OMNICOM: Factors and Constants (Firmware Version 22)

Factors and Constants (Firmware Version 22)


The Factors and Constants dialog within the OMNI General Setup category is for entering applic-
ation specific conversion factors and constants. Once you enter the information and/or make your
selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Factors and Constants dia-
log. Click on a setting for more information.

Constants

Flow Rate Average Factor:The flow averaging factor is the number of calculation cycles
used to smooth the calculated and displayed flow rates. A number from 1 to 99 will be accep-
ted (a calculation cycle is 500 ms). The default value is zero.

Weight of Water at 60 degF: The weight of a barrel of water at 60 degF and 14.696 PSIA.
Used to convert specific gravity units to density units for calculating mass. (From GPA 2145-
92 = 8.3372 lbs/Gal. = 350.162 lbs/BBL). NOTE: this is the true weight of water, NOT the con-
version factor used to convert g/cc to lb/BBL sometimes given as 350.507. The default value is
350.161 lb/BBL).

Conditions

Atmospheric Pressure: This is used to convert flowing pressure readings to absolute pres-
sure units. If the pressure sensor provides pressure in absolute instead of gauge, the Atmo-
spheric Pressure should be set to zero so that no conversion takes place. The default value is
14.696 PSIA.

Transmitter Fail Setpoints (available with firmware versions 22.75.03 and higher)

Transmitter Fail Low: a global setting for all transmitters used to discern the difference
between a 4-20mA transmitter failure on the low end versus a process variable saturation.
The default value is -3.00%. A reasonable range is -8% to 0% which gives values of 2.72mA
to 4mA.

Transmitter Fail High: a global setting for all transmitters used to discern the difference
between a 4-20mA transmitter failure on the high end versus a process variable saturation.
The default value is 110.00%. A reasonable range is 100% to 112% which gives values of
20mA to 21.92mA.

Validation Threshold (available for 22.75.10 and higher)

Validation Threshold Low: a global setting for all virtual inputs that when used with the val-
idation threshold override strategy, will raise a transducer fail low alarm and will cause the

28
OMNICOM: Factors and Constants (Firmware Version 22)

OMNI to use the configured override value for the stream variable if the virtual input value is
less than the threshold low percentage of alarm span applied to the low alarm value for the
stream variable. The default is 20%.

Example: Meter Run 2 Temperature is assigned to Virtual Input 98 and the validation
threshold low is set for 20%. If the override strategy is set to 'Validation Threshold' and the Vir-
tual Input 98 value is more than 20% lower than the Meter Run 2 Temperature Alarm Low
value, a transducer fail low alarm will be raised and the override value for Meter Run 2 Tem-
perature will be used.)

Validation Threshold High: a global setting for all virtual inputs that when used with the val-
idation threshold override strategy, will raise a transducer fail high alarm and will cause the
OMNI to use the configured override value for the stream variable if the virtual input value is
greater than the threshold high percentage of alarm span applied to the high alarm value for
the stream variable. The default is 20%.

Example: Meter Run 2 Temperature is assigned to Virtual Input 98 and the validation
threshold high is set for 20%. If the override strategy is set to 'Validation Threshold' and the Vir-
tual Input 98 value is more than 20% of alarm span higher than the Meter Run 2 Temperature
Alarm High value, a transducer fail high alarm will be raised and the override value for Meter
Run 2 Temperature will be used.)

29
OMNICOM: Factors and Constants (Firmware Version 23)

Factors and Constants (Firmware Version 23)


The Factors and Constants dialog within the OMNI General Setup category is for entering applic-
ation specific conversion factors and constants. Once you enter the information and/or make your
selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Factors and Constants dia-
log. Click on a setting for more information.

Alarms

Alarm Deadband %: Nuisance alarms can occur when input variables spend any amount of
time near the high or low alarm setpoints. These nuisance alarms can swamp the alarm log
with useless alarms leaving no room for real alarms. This entry sets a percentage limit based
on the "high alarm" entry. A variable must return within the high/low alarm limits by more than
this amount before the alarm is cleared. The default is zero.

For Example: High limit is 100 degF, Low limit is 20 degF, Alarm deadband is set to 2
percent.

A transducer input which exceeds 100 degF will set the 'high alarm'. The transducer sig-
nal must drop below 98 degF (calculated as 100.0 * 0.02 = 2.0 degF therefore 100.0
degF – 2.0 degF = 98.0 degF) before the high alarm will clear.

A transducer input which falls below 20 degF will set the ‘low alarm’. The transducer sig-
nal must rise above 22 degF (calculated as 100.0 * 0.02 = 2.0 degF therefore 20.0 degF
+ 2.0 degF = 22.0 degF) before the low alarm will clear. Note that this deadband value,
in engineering units, is also calculated using the High Alarm Limit setting, not the Low
Alarm Limit setting.

Nuisance Alarm Timer (sec): Nuisance alarms can occur if input variables are toggling in
and out of alarm. These nuisance alarms can swamp the alarm log with useless alarms leav-
ing no room for real alarms. When an alarm occurs, it is recorded immediately in the alarm log
and the Nuisance Alarm Timer is started. If the same alarm occurs again while the timer is act-
ive, it will not be recorded in the log. Enter '0' seconds if you would like to record the alarm
every time it occurs. The default is zero.

Constants

Flow Rate Average Factor: The flow averaging factor is the number of calculation cycles
used to smooth the calculated and displayed flow rates. A number from 1 to 99 will be accep-
ted (a calculation cycle is 500 ms). The default value is zero.

30
OMNICOM: Factors and Constants (Firmware Version 23)

Density of Dry Air: This entry is needed only for natural gas measurement where AGA-8 will
NOT be used to calculate 'density at base conditions'. See the 'SG' entry in the 'Fluid Data and
Analysis' screen. Entering zero forces the flow computer to use AGA-8 to calculate 'density at
base conditions'. Net flow is calculated by dividing mass flow rate by 'density at base con-
ditions'. The default is 0.0763210 lb/ft3.

Molecular Weight of Air: This entry is needed only for natural gas measurement where the
Redlich-Kwong method is selected. The default is 28.9626.

Conditions

Atmospheric Pressure: This is used to convert flowing pressure readings to absolute pres-
sure units. If the pressure sensor provides pressure in absolute instead of gauge the Atmo-
spheric Pressure should be set to zero so that no conversion takes place. The default is
14.696 PSIA.

Base Pressure: Enter the contract base pressure in absolute units. The default is 14.73
PSIA.

The Density of Dry Air (lb/ft3) entry is required only when you wish bypass AGA-8’s or AGA-
10’s calculated base density, and calculate base density using the fluid SG override entry, or
the value provided by an online GC. Base density is then equal to:

Base Density of Gas = Density of Dry Air at base conditions x SG at base conditions

When the above calculation is used, the Net volume is a function of the density at flowing tem-
perature and pressure as calculated by AGA-8 or AGA-10, and by the density at base tem-
perature and pressure as calculated above.

The Net volume will not be affected by changing entries of Base Temperature and Pressure in
the flow computer configuration as these values only affect the AGA-8 or AGA-10 calculated
base density value and this is not being used in this case to calculate Net volume.

Base Temperature: Enter the contract base temperature in degF. The default is 60 degF.

Flow Averaging Method

Two methods are available. BOTH methods do not modify the averaged variable if there is no flow
taking place.

Time Weighted averages are:


Average = (sum all sample values taken every 500ms) / number of 500ms samples

Flow Weighted averages are:


Average = (sum of all (sample values x flow increment)) / total flow

Conversion Factors

31
OMNICOM: Factors and Constants (Firmware Version 23)

ft3 to Gallons (Cubic Feet to Gallons Conversion): AGA 3-92 equations provide flowing
volume in actual and standard cubic feet. For gas applications, if water is selected as the fluid
type, the flow computer displays volumes using gross and net gallons. Enter the conversion
factor needed to convert cubic feet to gallons. The default is 7.480556. Note: if a zero is
entered, the OMNI will set to the default value automatically when used.

kg/m3 to lb/ft3: Enter the multiplier needed to convert most pulse type flowing densitometer
readings from kg/m3 to lb/ft3. The default is 0.062428. Note: if a zero is entered, the OMNI will
set to the default value automatically when used.

Mj/m3 to Btu/cf:(available with firmware versions 23.74.13 and higher) If heating value
method ISO 6976 is selected, the calculations are made in metric units.The flow computer dis-
plays heating value in BTU/cf. Enter the multiplier needed to convert Mj/m3 to BTU/cf. The
default is 26.83919. Note: if a zero is entered, the OMNI will set to the default value auto-
matically when used.

Transmitter Fail Setpoints (available with firmware versions 23.75.02 and higher)

Transmitter Fail Low: a global setting for all transmitters used to discern the difference
between a 4-20mA transmitter failure on the low end versus a process variable saturation.
The default value is -3.00%. A reasonable range is -8% to 0% which gives values of 2.72mA
to 4mA.

Transmitter Fail High: a global setting for all transmitters used to discern the difference
between a 4-20mA transmitter failure on the high end versus a process variable saturation.
The default value is 110.00%. A reasonable range is 100% to 112% which gives values of
20mA to 21.92mA.

Validation Threshold (available for 23.75.10 and higher)

Validation Threshold Low: a global setting for all virtual inputs that when used with the val-
idation threshold override strategy, will raise a transducer fail low alarm and will cause the
OMNI to use the configured override value for the stream variable if the virtual input value is
less than the threshold low percentage of alarm span applied to the low alarm value for the
stream variable. The default is 20%.

Example: Meter Run 2 Temperature is assigned to Virtual Input 98 and the validation
threshold low is set for 20%. If the override strategy is set to 'Validation Threshold' and the Vir-
tual Input 98 value is more than 20% lower than the Meter Run 2 Temperature Alarm Low
value, a transducer fail low alarm will be raised and the override value for Meter Run 2 Tem-
perature will be used.)

Validation Threshold High: a global setting for all virtual inputs that when used with the val-
idation threshold override strategy, will raise a transducer fail high alarm and will cause the
OMNI to use the configured override value for the stream variable if the virtual input value is
greater than the threshold high percentage of alarm span applied to the high alarm value for
the stream variable. The default is 20%.

32
OMNICOM: Factors and Constants (Firmware Version 23)

Example: Meter Run 2 Temperature is assigned to Virtual Input 98 and the validation
threshold high is set for 20%. If the override strategy is set to 'Validation Threshold' and the Vir-
tual Input 98 value is more than 20% of alarm span higher than the Meter Run 2 Temperature
Alarm High value, a transducer fail high alarm will be raised and the override value for Meter
Run 2 Temperature will be used.)

33
OMNICOM: Factors and Constants (Firmware Version 24)

Factors and Constants (Firmware Version 24)


The Factors and Constants dialog within the OMNI General Setup category is for entering applic-
ation specific conversion factors and constants. Once you enter the information and/or make your
selections press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Factors and Constants dia-
log. Click on a setting for more information.

Alarms

Alarm Deadband %: Nuisance alarms can occur when input variables spend any amount of
time near the high or low alarm setpoints. These nuisance alarms can swamp the alarm log
with useless alarms leaving no room for real alarms. This entry sets a percentage limit based
on the "high alarm" entry. A variable must return within the high/low alarm limits by more than
this amount before the alarm is cleared. The default is zero.

For Example: High limit is 100 degF, Low limit is 20 degF, Alarm deadband is set to 2
percent.

A transducer input which exceeds 100 degF will set the 'high alarm'. The transducer sig-
nal must drop below 98 degF (calculated as 100.0 * 0.02 = 2.0 degF therefore 100.0
degF – 2.0 degF = 98.0 degF) before the high alarm will clear.

A transducer input which falls below 20 degF will set the ‘low alarm’. The transducer sig-
nal must rise above 22 degF (calculated as 100.0 * 0.02 = 2.0 degF therefore 20.0 degF
+ 2.0 degF = 22.0 degF) before the low alarm will clear. Note that this deadband value,
in engineering units, is also calculated using the High Alarm Limit setting, not the Low
Alarm Limit setting.

Nuisance Alarm Timer (sec): Nuisance alarms can occur if input variables are toggling in
and out of alarm. These nuisance alarms can swamp the alarm log with useless alarms leav-
ing no room for real alarms. When an alarm occurs, it is recorded immediately in the alarm log
and the Nuisance Alarm Timer is started. If the same alarm occurs again while the timer is act-
ive, it will not be recorded in the log. Enter '0' seconds if you would like to record the alarm
every time it occurs. The default is zero.

Constants

Flow Rate Average Factor: The flow averaging factor is the number of calculation cycles
used to smooth the calculated and displayed flow rates. A number from 1 to 99 will be accep-
ted (a calculation cycle is 500 ms). The default value is zero.

34
OMNICOM: Factors and Constants (Firmware Version 24)

Weight of Water at 15 degC: The weight of a kilogram of water at 15 degC and 101.325
kPa absolute. It is used to convert from specific gravity units to density (kg/m3) for calculating
mass. The default value is 999.1 kg/m3.

Volume Units

You may select cubic meters or litres for volume units. The default value is m3.

Note: when volume units are set to litres, mass units become kilograms.

Pressure Units

Select which units you would like to use, KiloPascals, Bar, or Kilogram per square centimeter.
The default unit is kPa.

If the unit selection changes, a warning is displayed regarding changing any configured pressures
throughout the system. If you acknowledge the warning, you will have the opportunity to default the
Atmospheric Pressure to the value in the new units.

Conditions

Atmospheric Pressure: This is used to convert flowing pressure readings to absolute pres-
sure units. If the pressure sensor provides pressure in absolute instead of gauge the Atmo-
spheric Pressure should be set to zero so that no conversion takes place. The default value is
101.325 kPa (abs).

Transmitter Fail Setpoints (available with firmware versions 24.75.02 and higher)

Transmitter Fail Low: a global setting for all transmittersused to discern the difference
between a 4-20mA transmitter failure on the low end versus a process variable saturation.
The default value is -3.00%. A reasonable range is -8% to 0% which gives values of 2.72mA
to 4mA.

Transmitter Fail High: a global setting for all transmittersused to discern the difference
between a 4-20mA transmitter failure on the high end versus a process variable saturation.
The default value is 110.00%. A reasonable range is 100% to 112% which gives values of
20mA to 21.92mA.

Validation Threshold (available for 24.75.10 and higher)

Validation Threshold Low: a global setting for all virtual inputs that when used with the val-
idation threshold override strategy, will raise a transducer fail low alarm and will cause the
OMNI to use the configured override value for the stream variable if the virtual input value is
less than the threshold low percentage of alarm span applied to the low alarm value for the
stream variable. The default is 20%.

Example: Meter Run 2 Temperature is assigned to Virtual Input 98 and the validation
threshold low is set for 20%. If the override strategy is set to 'Validation Threshold' and the Vir-
tual Input 98 value is more than 20% lower than the Meter Run 2 Temperature Alarm Low

35
OMNICOM: Factors and Constants (Firmware Version 24)

value, a transducer fail low alarm will be raised and the override value for Meter Run 2 Tem-
perature will be used.)

Validation Threshold High: a global setting for all virtual inputs that when used with the val-
idation threshold override strategy, will raise a transducer fail high alarm and will cause the
OMNI to use the configured override value for the stream variable if the virtual input value is
greater than the threshold high percentage of alarm span applied to the high alarm value for
the stream variable. The default is 20%.

Example: Meter Run 2 Temperature is assigned to Virtual Input 98 and the validation
threshold high is set for 20%. If the override strategy is set to 'Validation Threshold' and the Vir-
tual Input 98 value is more than 20% of alarm span higher than the Meter Run 2 Temperature
Alarm High value, a transducer fail high alarm will be raised and the override value for Meter
Run 2 Temperature will be used.)

36
OMNICOM: Factors and Constants (Firmware Version 26)

Factors and Constants (Firmware Version 26)


The Factors and Constants dialog within the OMNI General Setup category is for entering applic-
ation specific conversion factors and constants. Once you enter the information and/or make your
selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Factors and Constants dia-
log. Click on a setting for more information.

Constants

Flow Rate Average Factor: The flow averaging factor is the number of calculation cycles
used to smooth the calculated and displayed flow rates. A number from 1 to 99 will be accep-
ted (a calculation cycle is 500 ms). The default value is zero.

Weight of Water at 15 degC: The weight of a kilogram of water at 15 degC and 101.325
kPa absolute. It is used to convert from specific gravity units to density (kg/m3) for calculating
mass. The default value is 999.1 kg/m3.

Volume Units

The selections are cubic meters or litres for volume units. The default value is m3.

Note: when volume units are set to litres, mass units become kilograms.

Pressure Units

The selections are KiloPascals, Bar, or Kilogram per square centimeter. The default unit is
kPa.

If the unit selection changes, a warning is displayed regarding changing any configured pressures
throughout the system. If you acknowledge the warning, you will have the opportunity to default the
Atmospheric Pressure to the value in the new units.

Conditions

Atmospheric Pressure: This is used to convert flowing pressure readings to absolute pres-
sure units. If the pressure sensor provides pressure in absolute instead of gauge the Atmo-
spheric Pressure should be set to zero so that no conversion takes place. The default value is
101.325 kPa (abs).

Transmitter Fail Setpoints (available with firmware versions 26.75.02 and higher)

37
OMNICOM: Factors and Constants (Firmware Version 26)

Transmitter Fail Low: a global setting for all transmittersused to discern the difference
between a 4-20mA transmitter failure on the low end versus a process variable saturation.
The default value is -3.00%. A reasonable range is -8% to 0% which gives values of 2.72mA
to 4mA.

Transmitter Fail High: a global setting for all transmittersused to discern the difference
between a 4-20mA transmitter failure on the high end versus a process variable saturation.
The default value is 110.00%. A reasonable range is 100% to 112% which gives values of
20mA to 21.92mA.

Validation Threshold (available for 26.75.10 and higher)

Validation Threshold Low: a global setting for all virtual inputs that when used with the val-
idation threshold override strategy, will raise a transducer fail low alarm and will cause the
OMNI to use the configured override value for the stream variable if the virtual input value is
less than the threshold low percentage of alarm span applied to the low alarm value for the
stream variable. The default is 20%.

Example: Meter Run 2 Temperature is assigned to Virtual Input 98 and the validation
threshold low is set for 20%. If the override strategy is set to 'Validation Threshold' and the Vir-
tual Input 98 value is more than 20% lower than the Meter Run 2 Temperature Alarm Low
value, a transducer fail low alarm will be raised and the override value for Meter Run 2 Tem-
perature will be used.)

Validation Threshold High: a global setting for all virtual inputs that when used with the val-
idation threshold override strategy, will raise a transducer fail high alarm and will cause the
OMNI to use the configured override value for the stream variable if the virtual input value is
greater than the threshold high percentage of alarm span applied to the high alarm value for
the stream variable. The default is 20%.

Example: Meter Run 2 Temperature is assigned to Virtual Input 98 and the validation
threshold high is set for 20%. If the override strategy is set to 'Validation Threshold' and the Vir-
tual Input 98 value is more than 20% of alarm span higher than the Meter Run 2 Temperature
Alarm High value, a transducer fail high alarm will be raised and the override value for Meter
Run 2 Temperature will be used.)

38
OMNICOM: Factors and Constants (Firmware Version 27)

Factors and Constants (Firmware Version 27)


The Factors and Constants dialog within the OMNI General Setup category is for entering applic-
ation specific conversion factors and constants. Once you enter the information and/or make your
selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Factors and Constants dia-
log. Click on a setting for more information.

Alarms

Alarm Deadband %: Nuisance alarms can occur when input variables spend any amount of
time near the high or low alarm setpoints. These nuisance alarms can swamp the alarm log
with useless alarms leaving no room for real alarms. This entry sets a percentage limit based
on the "high alarm" entry. A variable must return within the high/low alarm limits by more than
this amount before the alarm is cleared. The default is zero.

For Example: High limit is 100 degF, Low limit is 20 degF, Alarm deadband is set to 2
percent.

A transducer input which exceeds 100 degF will set the 'high alarm'. The transducer sig-
nal must drop below 98 degF (calculated as 100.0 * 0.02 = 2.0 degF therefore 100.0
degF – 2.0 degF = 98.0 degF) before the high alarm will clear.

A transducer input which falls below 20 degF will set the ‘low alarm’. The transducer sig-
nal must rise above 22 degF (calculated as 100.0 * 0.02 = 2.0 degF therefore 20.0 degF
+ 2.0 degF = 22.0 degF) before the low alarm will clear. Note that this deadband value,
in engineering units, is also calculated using the High Alarm Limit setting, not the Low
Alarm Limit setting.

Nuisance Alarm Timer (sec): Nuisance alarms can occur if input variables are toggling in
and out of alarm. These nuisance alarms can swamp the alarm log with useless alarms leav-
ing no room for real alarms. When an alarm occurs, it is recorded immediately in the alarm log
and the Nuisance Alarm Timer is started. If the same alarm occurs again while the timer is act-
ive, it will not be recorded in the log. Enter '0' seconds if you would like to record the alarm
every time it occurs. The default is zero.

Constants

Flow Rate Average Factor: The flow averaging factor is the number of calculation cycles
used to smooth the calculated and displayed flow rates. A number from 1 to 99 will be accep-
ted (a calculation cycle is 500 ms). The default value is zero.

39
OMNICOM: Factors and Constants (Firmware Version 27)

Density of Dry Air: This entry is needed only for natural gas measurement where AGA-8
will NOT be used to calculate 'density at base conditions'. See the 'SG' entry in the 'Fluid Data
and Analysis' screen. Entering zero forces the flow computer to use AGA-8 to calculate 'dens-
ity at base conditions'. Net flow is calculated by dividing mass flow rate by 'density at base con-
ditions'. The default is 1.225410 kg/m3.

Molecular Weight of Air: This entry is needed only for natural gas measurement where the
Redlich-Kwong method is selected. The default is 28.9626.

Conditions

Atmospheric Pressure: This is used to convert flowing pressure readings to absolute pres-
sure units. If the pressure sensor provides pressure in absolute instead of gauge the Atmo-
spheric Pressure should be set to zero so that no conversion takes place. The default is
101.325 kPa.

Base Pressure: Enter the contract base pressure in absolute units. The default is 101.56
kPa. (Note: for firmware v27.74.19 and higher this field was moved to the Fluid Products
Setup screen.)

The Density of Dry Air (kg/m3) is required only when you wish bypass AGA-8’s or AGA-10’s
calculated base density, and calculate base density using the fluid SG override entry, or the
value provided by an online GC. Base density is then equal to:

Base Density of Gas = Density of Dry Air at base conditions x SG at base conditions

When the above calculation is used, the Net volume is a function of the density at flowing tem-
perature and pressure as calculated by AGA-8 or AGA-10, and by the density at base tem-
perature and pressure as calculated above.

The Net volume will not be affected by changing entries of Base Temperature and Pressure in
the flow computer configuration as these values only affect the AGA-8 or AGA-10 calculated
base density value and this is not being used in this case to calculate Net volume.

Base Temperature: Enter the contract base temperature in degrees C. The default is 15.0
degC. (Note: for firmware v27.74.19 and higher this field was moved to the Fluid Products
Setup screen.)

Flow Averaging Method

Two methods are available. Neither method modify the averaged variable if there is no flow taking
place.

'Time Weighted' averages are:


Average = sum all sample values taken every 500ms / number of 500ms samples

'Flow Weighted' averages are:


Average = sum of all (sample values x flow increment) / total flow

40
OMNICOM: Factors and Constants (Firmware Version 27)

Pressure Units

Select which units you would like to use, KiloPascals, Bar, or Kilogram per square centimeter.
The default unit is kPa.

If the unit selection changes, a warning is displayed regarding changing any configured pressures
throughout the system. If you acknowledge the warning, you will have the opportunity to default the
Atmospheric Pressure to the value in the new units.

DP Units

The selections are KiloPascals or Millibar. The default is kPa.

Energy Units (available with firmware versions 27.74.21 and higher)

The selections are Gigajoules or Kilowatt hours. The default is Gj.

Transmitter Fail Setpoints (available with firmware versions 27.75.06 and higher)

Transmitter Fail Low: a global setting for all transmittersused to discern the difference
between a 4-20mA transmitter failure on the low end versus a process variable saturation.
The default value is -3.00%. A reasonable range is -8% to 0% which gives values of 2.72mA
to 4mA.

Transmitter Fail High: a global setting for all transmittersused to discern the difference
between a 4-20mA transmitter failure on the high end versus a process variable saturation.
The default value is 110.00%. A reasonable range is 100% to 112% which gives values of
20mA to 21.92mA.

Validation Threshold (available for 27.75.10 and higher)

Validation Threshold Low: a global setting for all virtual inputs that when used with the val-
idation threshold override strategy, will raise a transducer fail low alarm and will cause the
OMNI to use the configured override value for the stream variable if the virtual input value is
less than the threshold low percentage of alarm span applied to the low alarm value for the
stream variable. The default is 20%.

Example: Meter Run 2 Temperature is assigned to Virtual Input 98 and the validation
threshold low is set for 20%. If the override strategy is set to 'Validation Threshold' and the Vir-
tual Input 98 value is more than 20% lower than the Meter Run 2 Temperature Alarm Low
value, a transducer fail low alarm will be raised and the override value for Meter Run 2 Tem-
perature will be used.)

Validation Threshold High: a global setting for all virtual inputs that when used with the val-
idation threshold override strategy, will raise a transducer fail high alarm and will cause the
OMNI to use the configured override value for the stream variable if the virtual input value is
greater than the threshold high percentage of alarm span applied to the high alarm value for
the stream variable. The default is 20%.

41
OMNICOM: Factors and Constants (Firmware Version 27)

Example: Meter Run 2 Temperature is assigned to Virtual Input 98 and the validation
threshold high is set for 20%. If the override strategy is set to 'Validation Threshold' and the Vir-
tual Input 98 value is more than 20% of alarm span higher than the Meter Run 2 Temperature
Alarm High value, a transducer fail high alarm will be raised and the override value for Meter
Run 2 Temperature will be used.)

42
OMNICOM: Totalizers

Totalizers
The Totalizers dialog within the OMNI General Setup category is for viewing the settings of the
OMNI totalizers. Note: These are READ ONLY settings that cannot be changed via OMNICOM con-
figuration. They can only be configured via the front panel of the OMNI when resetting the totalizers.

Settings
The items listed below are descriptions of each setting option within the Totalizers dialog. Click on a
setting for more information.

Roll All Totalizers

When you select 'Reset All Totals' in the 'Password Maintenance' menu from the flow computer
front panel, you are given the opportunity to select the totalizer rollover significant digits. Totalizers
within the flow computer can be rolled at 8 or 9 significant digits.

For example:

Totalizer Decimal Places 9 Digits 8 Digits


0 999999999 99999999
1 99999999.9 9999999.9
2 9999999.99 999999.99
3 999999.999 99999.999

Totalizer Decimal Places

When you select 'Reset All Totals' in the 'Password Maintenance' menu from the flow computer
front panel, you are given the opportunity to set the totalizing resolution. Valid decimal place settings
are:
0 = XX
1 = X.X
2 = X.XX
3 = X.XXX

For example, a total of 1000 would look like:


0 = 1000
1 = 1000.0
2 = 1000.00
3 = 1000.000

Note: For purposes of accuracy, totals are stored as 32-bit integers with an implied decimal place.
(e.g. 1000.000 would be stored as 1000000.)

Note: Totalizer decimal places are now available with firmware v22.74.06+.

43
OMNICOM: Totalizers

API 12.2.2 Recommended Liquid Totalizer Discrimination Levels for Batching:

Totalizer Bbl gal m3 Litre


Gross (IV) 2 2 3 1
Net (GSV) 2 2 3 1
Net (NSV) 2 2 3 1

44
OMNICOM: Decimal Resolution

Decimal Resolution
The Decimal Resolution dialog within the OMNI General Setup category is for selecting the various
decimal resolutions associated with the Batch and Prove reports. Once you enter the information
and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Decimal Resolution dialog.
Click on a setting for more information.

Batch Report Decimal Places

Correction Factors (4, 5, or 6): This entry determines the resolution (number of decimal
places) for the following correction factors: CTL, CPL, and CTPL.

To comply with API standard MPMS 12.2.2 in general, select 4 decimal places for
correction factors.

Selecting 4 decimal places causes the flow computer to perform the normal API internal round-
ing and truncating rules with the last round being to 4 decimal places. Selecting 5 decimal
places causes the flow computer to perform the normal API internal rounding and truncating
rules with the exception of the last round which is to 5 places. Selecting 6 decimal places
causes the flow computer to perform no internal rounding and truncating and rounds the final
result to 6 places.

Meter Factor (4, 5, 6): Enter the number of decimal places required for the Meter Factor on
the Batch Report. The default is 4 decimal places. (Added for firmware version 26.74.30 and
higher.)

To comply with API standard MPMS 12.2.2 in general, select 4 decimal places for
meter factor.

Prove Report Decimal Places

Correction Factors (4, 5, or 6): Select the number of decimal places for the following cor-
rection factors: CTLM, CTLP, CPLM, CPLP, CTSP, CPSP and CCF which appear on the
Prove report. The default is 4 decimal places for application 26.

To comply with API standard MPMS 12.2.3 in general, select 5 decimal places for
correction factors.

Selecting 4 decimal places causes the flow computer to perform the normal API internal round-
ing and truncating rules with the last round being to 4 decimal places. Selecting 5 decimal
places causes the flow computer to perform the normal API internal rounding and truncating
rules with the exception of the last round which is to 5 places. Selecting 6 decimal places

45
OMNICOM: Decimal Resolution

causes the flow computer to perform no internal rounding and truncating and rounds the final
result to 6 places.

Meter Factors (4, 5, 6): Enter the number of decimal places required for the Meter Factor on
the Prove Report. The default is 4 decimal places. (Added for firmware version 26.74.30 and
higher.)

To comply with API standard MPMS 12.2.3 in general, select 4 decimal places for
prove meter factor result.

API 12.2.2 and 12.2.3 Rounding Rules

Check the box if you would like the OMNI to use the following API 12.2.2 rounding rules for the Batch
Report and API 12.2.3 for the Prove Report:

When a number is rounded to a specific number of decimals, it shall always be rounded off in one
step to the number of figures that are to be recorded, and shall not be rounded in two or more steps
of successive rounding. The rounding procedure shall be in accordance with the following:

When a figure to the right of the last place to be retained is five (5) or greater, the figure in the
last place to be retained should be increased by one (1).

If the figure to the right of the last place to be retained is less than five (5), the figure in the last
place to be retained should be unchanged.

46
OMNICOM: Decimal Resolution

Decimal Resolution
The Decimal Resolution dialog within the OMNI General Setup category is for selecting the various
decimal resolutions associated with the Batch and Prove reports. Once you enter the information
and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Decimal Resolution dialog.
Click on a setting for more information.

Batch Report Decimal Places

Correction Factors (4, 5, or 6): This entry determines the resolution (number of decimal
places) for the following correction factors: CTL, CPL, and CTPL.

To comply with API standard MPMS 12.2.2 in general, select 4 decimal places for
correction factors.

Selecting 4 decimal places causes the flow computer to perform the normal API internal round-
ing and truncating rules with the last round being to 4 decimal places. Selecting 5 decimal
places causes the flow computer to perform the normal API internal rounding and truncating
rules with the exception of the last round which is to 5 places. Selecting 6 decimal places
causes the flow computer to perform no internal rounding and truncating and rounds the final
result to 6 places.

Meter Factor (4, 5, 6): Enter the number of decimal places required for the Meter Factor on
the Batch Report. The default is 4 decimal places. (Added for firmware versions 22.74.30 and
26.74.30 and higher.)

To comply with API standard MPMS 12.2.2 in general, select 4 decimal places for
meter factor.

Prove Report Decimal Places

Correction Factors (4, 5, or 6): Select the number of decimal places for the following cor-
rection factors: CTLM, CTLP, CPLM, CPLP, CTSP, CPSP and CCF which appear on the
Prove report. The default is 5 decimal places for applications 20 and 24 and 4 decimal places
for applications 22 and 26.

To comply with API standard MPMS 12.2.3 in general, select 5 decimal places for
correction factors.

Selecting 4 decimal places causes the flow computer to perform the normal API internal round-
ing and truncating rules with the last round being to 4 decimal places. Selecting 5 decimal
places causes the flow computer to perform the normal API internal rounding and truncating

47
OMNICOM: Decimal Resolution

rules with the exception of the last round which is to 5 places. Selecting 6 decimal places
causes the flow computer to perform no internal rounding and truncating and rounds the final
result to 6 places.

Meter Factors (4, 5, 6): Enter the number of decimal places required for the Meter Factor on
the Prove Report. The default is 4 decimal places. (Added for firmware versions 22.74.30 and
26.74.30 and higher.)

To comply with API standard MPMS 12.2.3 in general, select 4 decimal places for
prove meter factor result.

48
OMNICOM: OMNI I/O

OMNI I/O
Below are the areas used within the OMNI I/O. Click on a link to go to that topic.

Modules and Module Bits (available with firmware versions 20.75.01, 22.75.02, 23.75.01, 24.75.01,
26.75.01, and 27.75.03 and higher)
Digital I/O
Process I/O
Current Assignments
Auxiliary Inputs

49
OMNICOM: Modules

Modules
The Modules dialog allows the user to specify the number and type of I/O Modules and the I/O Alloc-
ations associated with the selected modules.

Settings
Number of Modules Installed

Select the number and the type of Modules installed within the OMNI.

I/O Allocations

The I/O allocation information is updated based on the number of modules installed.

Ethernet Allocations

The Ethernet Allocations area allows the user to specify whether the modules installed are Serial (S)
or Serial/Ethernet (SE).

If SE is selected, OMNICOM will present the user with options to configure the ports on the module
to be used as serial or Ethernet ports. They may also configure if the SE Module firmware is v1.50
and higher (enables SE Module configuration via OMNICOM and network printing.)

50
OMNICOM: Module Bits

Module Bits
The Modules dialog allows the user to specify which modules are installed in the OMNI and displays
the associated I/O allocated to each module type. This version of the Modules screen is available
with firmware versions 20.75.01, 22.75.02, 23.75.01, 24.75.01, 26.75.01, and 27.75.03 and higher.

On screen entry, the user is informed if a 'Check Modules' is required at the OMNI unit. Note that
OMNICOM uses the modules installed in the 'S-Ware' column of the OMNI Status display.

On Apply, a check modules is performed and any allocated I/O points associated with the modules
that changed can be auto-unassigned if the user wishes.

Settings
Modules Installed

Select the modules installed in the OMNI by checking the box next to the label (A-2, E-4, etc...). As
you select a module, the total count of that module type is shown.

The Serial modules (S) and the Serial/Ethernet Modules (SE) use the same address so if you have
an S-1 module selected, the SE-1 module is disabled. Similarly, if you select SE-1 first, the S-1 mod-
ule is disabled.

The HART modules (HT and HM) use the same address so if you have an HT-1 module selected,
the HM-1 module is disabled. Similarly, if you select HM-1 first, the HT-1 module is disabled.

Note: The HART modules (HT and HM) and Honeywell modules (H and HV) are mutually exclusive
meaning you can't have both types of modules installed in the OMNI at the same time.

I/O Allocations

The I/O allocation information is updated based on the number of modules installed.

The process input allocations (1-24) are assigned in this module order:
A, B, C, E/D, E, H, HV, and SV.

The HART input allocations (25-88) are assigned in this module order:
HT and HM

The analog output allocations (1-12 for applications 20/24 and 22/26 and 1-18 for 21 and 23/27) are
assigned in this module order:
A, B, C, E/D, E, HT or H, HM or HV, and SV.

Port Allocations

The port allocations show the port numbers assigned to the modules and whether they are a serial
port or an Ethernet port.

51
OMNICOM: Module Bits

S-1 - Ports 1 and 2 are serial.


S-2 - Ports 3 and 4 are serial.
S-3 - Ports 5 and 6 are serial.

SE-1 - Ports 1 and 2 - the user can select which port is serial and which port is Ethernet.
SE-2 - Ports 3 and 4 - the user can select which port is serial and which port is Ethernet.
SE-3 - Ports 5 and 6 - the user can select which port is serial and which port is Ethernet.

If an SE module is selected, the user may also configure if the SE Module firmware is v1.50 and
higher (enables SE Module configuration via OMNICOM and network printing provided the OMNI
firmware supports it.)

52
OMNICOM: Digital Channels

Digital Channels
Each digital I/O module has 12 channels. The OMNI 3000 has 12 physical digital I/O points, the
OMNI 6000 has either 12 or 24 depending on the number of installed modules.

Use the Database Browser to assist in selecting the assignment.

Digital I/O points can be assigned as:

Status or Command Inputs


Accumulator or Pulse Outputs
Control Outputs

The I/O type is determined by the flow computer by the four digit variable assignment number that
you enter.

53
OMNICOM: Status or Command Inputs

Status or Command Inputs


Remarks

16 character string used to describe the function of this I/O point.

Point Number Function


1700 (reserves the I/O point as a general purpose input
to be used in a boolean statement or used as a detector switch Dummy variable
input).
1701 Prove Seal OK
1702 Station End Batch
1703 End Batch Meter 1
1704 " " " 2
1705 " " " 3
1706 " " " 4
Station Product Change
1707 (Edge Triggered Commands)
Strobe
1708 Request Prove Meter 1
1709 " " " 2
1710 " " " 3
1711 " " " 4
Station Alarm Acknow-
1712 (Use 1732-35 for meter run alarms)
ledge
1713 (Power fail is set at power up) Reset Power Fail Flag
Request Trial Prove
1714 (Single run prove)
Meter 1
1715 " " " Meter 2
1716 " " " Meter 3
1717 (Edge Triggered Commands) " " " Meter 4
1718 Abort Prove in Progress
Request Local Snap-
1719
shot Report
1720 Request Snapshot to
(Sends to the Modbus report buffer to be polled for later) Modbus
Request Alarms to Mod-
1721 (Sends to the Modbus report buffer to be polled for later)
bus
1722 (Controls the startup/shutdown ramps. See 2nd Stage PID PID 1 Startup Per-
Permissives below) missive
1723 " 2 " "
1724 " 3 " "

54
OMNICOM: Status or Command Inputs

1725 " 4 " "


1726 (Activate to start prove sequence) Prove Start Permissive
Prover Piston Not Up-
1731 (Must be false to launch piston)
Stream
Acknowledge Meter 1
1732 (Edge triggered - Use 1712 to acknowledge station alarms)
Alarms
1733 " " 2 "
1734 " " 3 "
1735 " " 4 "
1736 (Active to disable meter run flow. Usually used in Bi Directional
flow applications where forward and reverse meter runs use the Disable Meter Run 1
same meter)
1737 " " " 2
1738 " " " 3
1739 " " " 4
Remote UP Arrow Func-
1741 (Provides ability to scroll display via digital I/O points)
tion
1742 " DOWN " "
1743 (The status of these bits are checked to see what product is
selected to run when the Change Product Strobes are activated. Product Selection Bit 0
See 1707 & 1747-50)
1744 " " Bit 1
1745 " " Bit 2
1746 " " Bit 3
1747 (Edge triggered - Causes current batch to be ended and the Product Change Strobe
next batch to start using the product selected in 1743-1746 above) Run 1
1748 " " " Run 2
1749 " " " Run 3
1750 " " " Run 4
Freeze All Analog
1751 (Can be used to facilitate calibration)
Inputs
2nd Stage 1 PID Per-
1752 (Used to provide two stage shutdown of PID control)
missive
" " 2 PID Per-
1753
missive
" " 3 PID Per-
1754
missive
" " 4 PID Per-
1755
missive
Change Orifice Plate
1756 (Holds current mass flow rate while active)
Meter 1
1757 " " " " 2
1758 " " " " 3
1759 " " " " 4

55
OMNICOM: Status or Command Inputs

Freeze Temperature,
1760 (Edge triggered. Causes variables to be snapshot and saved.) Pressure, Dens-
ity/Gravity & Totals

56
OMNICOM: Accumulator or Pulse Outputs

Accumulator or Pulse Outputs


***NOTE: If the assignment is changed, the pulse width and the pulse/unit are automatically cleared
in the OMNI.***

Assignment - please see below for valid assignments.

Remarks

16 character string used to describe the function of this I/O point.

Pulse Width

Enter the width of the ON and OFF time of the pulse to be output

Pulse width is measured in 10 ms ticks. A pulse width of zero is 10 ms. A pulse width of 5 ticks would
provide a 60 ms ON time and a minimum 60 ms OFF time.

The maximum frequency that can be output is 50 Hertz when configuring the Pulse Width to 0 (i.e.,
10 ms On and 10 ms Off) and with the Pulses/Unit configured as 1.

Any pulses remaining beyond the maximum output rate of 50 Hz will continue to accumulate in the
buffer and continue to be output at the configured rate until the buffer is empty.

The maximum pulse width setting is 99999 which is approximately 16.7 minutes ON and 16.7
minutes OFF for each pulse that is output.

Pulse/Unit

Specifies the number of pulses that should occur for each unit measured by the flow computer. Enter
the number of pulses per unit volume, mass or energy unit.

The unit is the 'displayed' unit ie: BBL, Tonnes, KLB, Gj

Examples:

You wish to output in 0.1 BBL increments and the displayed units are BBL. Pulses/unit
needed = 1/0.1 = 10.0 pulses per BBL.

You wish to output in 100 kg increments and the displayed units are Tonnes (1000 kg per
Tonne). Pulses/unit needed = 1000/100 = 10.0 counts per Tonne.

You wish to output in 10 gallon increments and the displayed units are Barrels (42 gallons per
Barrel) - Pulses/unit needed = 42/10 = 4.2 counts per Barrel.

You wish to output in 10 Barrel increments and the displayed units are Barrels - Pulses/unit
needed = 1/10 = 0.1 counts per Barrel.

57
OMNICOM: Accumulator or Pulse Outputs

Valid Assignments Are:

Meter Run (substitute the meter run number for 'n')


1n01 = Gross Flow
1n02 = Net Flow
1n03 = Mass Flow
1n04 = *Energy Flow

Station
1801 = Positive Gross Flow
1802 = Positive Net Flow
1803 = Positive Mass Flow
1804 = *Positive Energy Flow
1805 = Negative Gross Flow
1806 = Negative Net Flow
1807 = Negative Mass Flow
1808 = *Negative Energy Flow

*Note: Not applicable to some applications.

User Programmable Accumulators points 7089 through 7099 can be assigned to pulse physical I/O
points by assigning the points to Booleans 1089 through 1099.

58
OMNICOM: Control Outputs

Control Outputs
I/O points can be assigned to echo the state of other I/O points.

Assignment - please see below for valid assignments.

Remarks

16 character string used to describe the function of this I/O point.

Delay On

You can delay activating an output point in increments of 100ms ticks.

Example: You assign a point to represent 'any station alarm' (point 1816). To avoid alarming on
momentary alarms you may decide to delay activating the output for 5 seconds (delay ON = 50
ticks).

Delays of up to 16 minutes 40 seconds (9999 x 100ms ticks) can be programmed.

Delay Off

Once a digital output is activated it can be held on for some minimum time period measured in 100ms
tick increments.

Example: You assign an output to 'any station alarm' (point 1816) and program a 'time OFF' delay of
100. This ensures that the output will be energized for at least 10 seconds (100 x 100ms ticks).

Delays of up to 16 minutes and 40 seconds (9999 x 100ms ticks) can be programmed.

Example:

You have a limit switch connected to physical I/O point #2 which is assigned the function 1700
(dummy input that does nothing in the flow computer).
Assign I/O point #3 equal to 2.
I/O point #3 will now follow the signal on I/O point #2.
By entering delay ON and delay OFF values you can now provide a delayed and/or stretched
version of the original limit switch signal.

Valid output assignments are:

Scratchpad Variables Points 1501 through 1699


Boolean Points 1025 through 1088 and 11025 through 11088 (These are the results of the
128 Boolean expressions)

Meter Run Alarms/Status Points

59
OMNICOM: Control Outputs

Replace 'n' with meter run number.

Point Function
1n05 Meter Is Active
1n06 Meter Is Being Proved
1n07 Any Alarm This Run
1n08 Batch End Acknowledge Toggle
1n09 Auto Prove Problem
1n10 Batch Preset Reached Flag
1n11 Batch Preset Warning Flag
1n12 Batch End Pulse
1n13 Calculation out of Range
1n14 Using Density Pressure Override
1n16 Using Temp. Override
1n17 Using Pressure Override
1n18 Using Gravity/Density Override
1n19 Using Density Temperature Override
1n20 Flow Rate Low Low Alarm
1n21 Flow Rate Low Alarm
1n22 Flow Rate High Alarm
1n23 Flow Rate High High Alarm
1n24 Temperature Transducer Failed Low
1n25 Temperature Low Alarm
1n26 Temperature High Alarm
1n27 Temperature Transducer Failed High
1n28 Pressure Transducer Failed Low
1n29 Pressure Low Alarm
1n30 Pressure High Alarm
1n31 Pressure Transducer Failed High
1n32 Gravity/Density Transducer Failed Low
1n33 Gravity/Density Low Alarm
1n34 Gravity/Density High Alarm
1n35 Gravity/Density Transducer Failed High
1n36 Density Temperature Transducer Failed Low
1n37 Density Temperature Low Alarm
1n38 Density Temperature High Alarm
1n39 Density Temperature Transducer Failed High
1n44 Density Pressure Transducer Failed Lo
1n45 Density Pressure Low Alarm
1n46 Density Pressure High Alarm
1n47 Density Pressure Transducer Failed Hi
1n48 Pulse Comparator Error

60
OMNICOM: Control Outputs

1n49 'A' Channel Has Failed


1n50 'B' Channel Has Failed
1n51 Partial Failure A or B

Station Alarms/Status Points

Point Function
1809 Flow Rate Low Low Alarm
1810 Flow Rate Low Alarm
1811 Flow Rate High Alarm
1812 Flow Rate High High Alarm
1813 Gravity Rate Of Change
1814 Delayed Rate Of Change
1816 Any Station Alarm
1817 Station Batch End Acknowledgement
1818 Batch Preset Warning Flag
1819 Batch Preset Reached Flag
1820 Active Product ID Bit 1
1821 Active Product ID Bit 2
1822 Active Product ID Bit 3
1823 Active Product ID Bit 4
1824 Run Switching Flag 1
1825 Run Switching Flag 2
1826 Run Switching Flag 3
1827 Freeze Command Accepted Flag
1828 Contract Day Start Pulse
1829 Power Failed Flag
1830 Print Buffer Full Flag
1831 Hour Start Pulse
1832 Week Start Pulse
1833 Month Start Pulse
1834 Year Start Pulse
1835 Batch End Pulse
1836 Snapshot Printed Pulse
1837 EPROM Error Detected
1838 Peer/Peer Active Flag

Prover Alarm/Status Points

Point Function
1901 Left Pressure Low Alarm
1902 Left Pressure High Alarm

61
OMNICOM: Control Outputs

1903 Right Pressure Low Alarm


1904 Right Pressure High Alarm
1905 Left Temperature Low Alarm
1906 Left Temperature High Alarm
1907 Right Temperature Low Alarm
1908 Right Temperature High Alarm
1909 Temperature Unstable
1910 Temperature Diff. Meter to Prover
1911 Prove Successful
1912 Prove Aborted
1913 Sphere In Flight Forward
1914 Sphere In Flight Reverse
1915 Overtravel Forward Direction
1916 Overtravel Reverse Direction
1917 Launch Forward
1918 Launch Reverse
1919 Count Deviation Exceeded
1920 Bad Seal Detected
1921 Unstable Flow Rate
1922 No Prove Permissive
1923 MF Not Implemented
1924 Trying to Prove an Inactive Meter
1925 Plenum Charge Command
1926 Plenum Vent Command
1927 Compact Prover /Run
1928 Prove Complete Pulse
1929 Left Temperature Override In Use
1930 Right Temperature Override In Use
1931 Left Pressure Override In Use
1932 Right Pressure Override In Use

62
OMNICOM: Digital IO Module

Digital IO Module
Each digital I/O module has 12 channels. Each channel can be assigned as either an input or an out-
put. The module has 12 connections to the back panel terminal strips (refer to the Terminal Block Dia-
gram).

Inputs
Inputs greater than + 5 volts with respect to DC return terminal will be sensed as being active. Inputs
less than +2 volts with respect to DC return terminal will be sensed as being in-active.

Warning - Applied input voltages must not exceed the voltage at the +DC terminals or the
protection diode will conduct and blow the fuse.

Outputs
Output switches are Darlington transistors which provide a positive DC voltage out equal to the
voltage on the +DC terminals less 1 volt. Connect the load between the I/O terminal and the DC
return terminal. Limit the total load current to 500 mA per module and 100 mA maximum per indi-
vidual channel.

63
OMNICOM: Process I/O

Process I/O
The Process I/O area allows the user to configure individual process inputs and analog outputs for
each individual module installed within the OMNI.

Below are the areas used within the Process I/O. Click on a link to go to that topic.

A Combo Modules
B Combo Modules
C Combo Modules
E/D Combo Modules
E Combo Modules
HT Combo Modules (available with firmware versions 20.75.01, 22.75.02, 23.75.01, 24.75.01,
26.75.01, 27.75.03 and higher)
HM Combo Modules (available with firmware versions 20.75.01, 22.75.02, 23.75.01, 24.75.01,
26.75.01, 27.75.03 and higher)
H Combo Modules
HV Combo Modules
SV Combo Modules

Process Inputs
HART Network Setup (available with firmware version 20.75.01, 22.75.02, 23.75.01, 24.75.01,
26.75.01, and 27.75.04 and higher)
HART Inputs (available with firmware versions 20.75.01, 22.75.02, 23.75.01, 24.75.01, 26.75.01,
and 27.75.03 and higher)
Virtual Inputs (available with firmware versions 20.74.30, 22.74.30, 23.74.30, 24.74.19, 26.74.10,
and 27.74.21 and higher)
Analog Outputs

64
OMNICOM: Process Inputs

Process Inputs
These entries are used to assign a physical input to each transducer. Duplicate I/O assignments can
be made when a transducer is shared (for example forward and reverse flow). Once you enter the
information and/or make your selections, press the [Apply] button to set. Note: Nothing is written to
the OMNI unless the input has been assigned.

HART Inputs (available with firmware versions 20.75.01, 22.75.02, 23.75.01, 24.75.01, 26.75.01,
27.75.03 and higher)
Virtual Inputs (available with firmware versions 20.74.30, 22.74.30, 23.74.30, 24.74.19, 26.74.10,
and 27.74.21 and higher)

Settings
The items listed below are the descriptions of each setting option within the Analog Input dialog.
Click on a setting for more information.

Note: Density/Gravity units for non-pulse type densitometers/gravitometers for Alarm Limits, Input
Scaling and Override values are not available until the process input is assigned to a meter, station,
or prover densitometer and the type is selected.

Tag ID

An 8-character ASCII string which identifies each transducer. The tag appears in the LCD display
before the value of the variable. Note: This field is not used if a '99' has been assigned as I/O.

Signal Type

Select a signal that will be received on this input.

Note: Some configuration settings also require certain jumpers to be set for the input channel.
Please refer to the Process IO help for the module specifics.

RTD DIN

When using RTD probes which follow the DIN curve and have an alpha of 0.00385.

RTD American

When using RTD probes which follow the American curve and have an alpha of
0.00392

Analog Input (1-5v/4-20mA)/Honeywell DE Protocol

When using a transducer that provides a linear 1-5 Volts output or when using a trans-
ducer that provides a linear 4-20mA output.

65
OMNICOM: Process Inputs

Flow Pulse

Digital metering devices such as ultrasonic flowmeters allow you to communicate with
the OMNI with serial and/or flow pulse signals. If you would like flow pulse signals, you
must also assign a pulse I/O point and enter the active threshold frequency.

Density Pulse

Digital metering devices such as Thermo Scientific (Sarasota), Micro Motion


(Solartron), and Ametek (UGC) Densitometers allow you to communicate with the
OMNI with serial and/or density pulse signals.

For gas applications, the Density Pulse selection may also be used to configure a Micro
Motion (Solartron) 3096/3098 Gravitometer digital pulse (frequency) input for SG.

Input Type

Allows you to select the type of input that is coming into the OMNI.
The choices are:
Unassigned
Temperature
Pressure
DP
Flow Meter
Density/Gravity
PID Setpoint
Auxiliary Input

and for Gas Applications:


N2
CO2
HV
SG

This input type can be configured in one of two ways:


4-20mA input - Select the signal type as ‘Analog Input’ and the input type as ‘SG – 4-
20mA’.

Micro Motion (Solartron) 3096/3098 Gravitometer digital pulse (frequency)


input – Select the signal type as a ‘Density Pulse’ (4th input on a ‘B’ Module or the 3rd
or 4th input on an ‘E/D’ Module) and the input type as ‘SG – Micro Motion (Solartron)’.

Alarm Limits

Low Alarm Limit:


Enter the measurement value in engineering units below which the Low Alarm of the process
variable activates.

66
OMNICOM: Process Inputs

High Alarm Limit:


Enter the measurement value in engineering units above which the High Alarm of the process
variable activates.

Input Scaling

Input at Zero Scale:


This entry is used to determine the Input at Zero Scale (4 mA or 1V).

Input at Full Scale:


This entry is used to determine the Input at Full Scale (20 mA or 5V).

Damping Code

Honeywell damping codes are used with Honyewell digital transmitters connected to 'H' and 'HV'
modules and Rosemount damping codes are used with Rosemount digital transmitters connected to
'SV' modules.

The process variable (i.e. temperature/pressure) is filtered by the transmitter before being sent to
the flow computer. The time constant used depends on this entry.

The following is a chart showing the damping code values:

Honeywell Honeywell
Damping Code Rosemount
(Temperature Inputs) (other inputs)
0 0.00 0.00 0.108
1 0.30 0.16 0.216
2 0.70 0.32 0.432
3 1.50 0.48 0.864
4 3.10 1.00 1.728
5 6.30 2.00 3.456
6 12.7 4.00 6.912
7 25.5 8.00 13.824
8 51.1 16.00 27.648
9 102.3 32.00 N/A

Override

Select the type of manual override strategy you wish to use. You must also enter the override value
in engineering units for the computer to use when an override strategy is selected.

Assignments

A list of all the variables that this process input has been assigned to represent. A process input used
to measure temperature, for example, could be assigned to represent the temperature at the meter
run, densitometer, and the prover.

67
OMNICOM: Process Inputs

SV Port Number

The SV Port number is only displayed when the SV's port protocol is configured for a Rosemount
3095FB multivariable transmitter (see the help for SV Setup). Enter the port number of the SV mod-
ule that the meter is connected to.

Port numbers 1 and 2 are on the SV-1 combo module.


Port numbers 3 and 4 are on the SV-2 combo module.

SV ports can be connected to multiple 3095FB multivariables as long as each 3095FB has its own
unique Modbus ID.

Modbus ID

Each Rosemount 3096FB multivariable transmitter connected to a SV combo module port must
have a unique Modbus ID.
Enter the unique Modbus ID of the 3095FB transmitter which will be providing this meter run's DP,
temperature and pressure.

68
OMNICOM: Analog Outputs

Analog Outputs
The Analog Output dialog within the Input/Output Calibration subcategory is for entering the con-
figuration of each of your 4-20 mA analog outputs. There is a dialog for each analog output. This
involves assigning a variable and specifying the zero and full scale range in engineering units. Once
you enter the information and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are links to descriptions of each setting option within the Analog Output dia-
log. Click on a setting for more information.

Assign

Enter the four digit number which specifies what database variable will be output via this analog out-
put. Use the Database Browser to assist in selecting the assignment.

Meter Run Variables

Replace 'n' with the meter run number in the table below:

Point Liquid Pulse Type Liquid Orifice Gas Turbine/Orifice


7n01 Gross Flow Rate Gross Flow Rate Gross Flow Rate
7n02 Net Flow Rate Net Flow Rate Net Flow Rate
7n03
Mass Flow Rate Mass Flow Rate Mass Flow Rate
7n04 Net Standard Flow Net Standard Flow
Energy Flow Rate
Rate Rate
7n05
Meter Temperature Meter Temperature Meter Temperature
7n06
Meter Pressure Meter Pressure Meter Pressure
7n07 Meter Dens Cal- Meter Dens Cal- Meter Dens Cal-
culated culated culated
7n08
Unfactored Density Unfactored Density Unfactored Density
7n09
Flowing Density Flowing Density Flowing Density
7n10 Density Temperature
Density Temperature Density Temperature
7n11
Density Pressure Density Pressure Density Pressure
7n12
Flowing API Gravity Flowing API Gravity Orifice Diameter

69
OMNICOM: Analog Outputs

7n13
API @ Reference API @ Reference Flow Coefficient C
7n14
Flowing SG Flowing SG Expansion Factor Y
7n15
SG or Density @ Ref SG or Density @ Ref Velocity Factor Ev.
7n16
Current VCF Factor Differential Pressure Differential Pressure
7n17
Current CPL Factor Orifice Coefficient; Pipe Diameter
7n18 Batch FWA Tem- Batch Average Tem- Batch Average Tem-
perature perature perature
7n19 Batch FWA Pressure Batch Average Pres- Batch Average Pres-
sure sure
7n20 Batch FWA Dens Batch Average Dens Batch Average Dens
Flowing Flowing Flowing
7n21 Batch FWA Den. Batch Average Den. Batch Average Den.
Temp. Temp. Temp.
7n22 Batch FWA Den. Batch Average Den. Batch Average Den.
Press. Press. Press.
7n23 Batch FWA API Flow- Batch Average API Average Flow Coef-
ing Flowing ficient
7n24 Batch FWA API @ Batch Average API @
Average Y Factor
Ref. Ref.
7n25 Batch FWA SG Flow- Batch Average SG
Average Velocity Fact
ing Flowing
7n26 Batch FWA SG/Dens Batch Average Average Orifice Dia-
@ Ref. SG/Dens @ Ref. meter
7n27 Average Differential
Batch FWA VCF Expansion Factor Y
Pressure
7n28 Daily Average Velocity
Batch FWA CPL Velocity Factor Ev
Factor Ev
7n29 Daily FWA Tem- Daily Average Tem- Daily Average Tem-
perature perature perature
7n30 Daily Average Pres- Daily Average Pres-
Daily FWA Pressure
sure sure
7n31 Daily FWA Flowing Daily Average Flowing Daily Average Flowing
Density Density Density
7n32 Daily FWA Density Daily Average Density Daily Average Density
Temperature Temperature Temperature
7n33 Daily FWA Density Daily Average Density Daily Average Density
Pressure Pressure Pressure
7n34 Daily FWA API Flow- Daily Average API Daily Average Orifice
ing Flowing Coefficient
7n35 Daily FWA API @ Daily Average API @ Daily Average Y

70
OMNICOM: Analog Outputs

Ref. Ref. Factor


7n36 Daily FWA SG Flow- Daily Average SG Daily Average Orifice
ing Flowing Diameter
7n37 Daily FWA SG/Dens Daily Average Daily Average Dif-
@ Ref. SG/Dens @ Ref. ferential Pressure
7n38 Daily Average Dif- Current Reference
Daily FWA VCF
ferential Pressure Density
7n39
Daily FWA CPL Pipe Diameter Actual Viscosity
7n40 Current Meter K- Actual Isentropic
Orifice Diameter
Factor Expansion Factor
7n41
Batch FWA K-Factor Entered Viscosity AGA-8 SG Entry
7n42 Entered Isentropic
Daily FWA K-Factor AGA-8 HV Entry
Exponent
7n43 Current Density Cor- Current Density Cor-
Entered Viscosity
rection Factor rection Factor

Station Variables

Point Liquid Turbine /PD Liquid Orifice Gas Turbine/Orifice


7801 Gross Flow Rate Gross Flow Rate Gross Flow Rate
7802 Net Flow Rate Net Flow Rate Net Flow Rate
7803 Mass Flow Rate Mass Flow Rate Mass Flow Rate
7804 N/A N/A Energy Flow Rate
7805 Density Density Density
7806 Temperature Temperature Temperature
7807 Pressure Pressure Pressure

Prover Variables

Point Description
15123 Prove Run in Progress
15124 Proving Meter Run Number
15125 Prove Counts
5963 Actual Meter Factor - Current Prove
7903 Prover Temperature
7906 Prover Pressure
7907 Plenum Pressure

PID Variables

MR1 MR2 MR3 MR4 Description

71
OMNICOM: Analog Outputs

7601 7606 7611 7616 Primary Variable Local Set Point


7602 7607 7612 7617 Set Point Being Used
7603 7608 7613 7618 Primary Variable Remote Set Point
7604 7609 7614 7619 Control Output %
7605 7610 7615 7620 Secondary Variable Set Point

Scaled Process Output Variables 0-100%

Point Analog Output Number


7001 Analog Output 1
7002 Analog Output 2
7003 Analog Output 3
7004 Analog Output 4
7005 Analog Output 5
7006 Analog Output 6
7007 Analog Output 7
7008 Analog Output 8
7009 Analog Output 9
7010 Analog Output 10
7011 Analog Output 11
7012 Analog Output 12
7013 Analog Output 13
7014 Analog Output 14
7015 Analog Output 15
7016 Analog Output 16
7017 Analog Output 17
7018 Analog Output 18

Results of User Variable Statements

Point Programmable Variable Number


7025 Programmable Variable 1
7026 Programmable Variable 2
7027 Programmable Variable 3
7028 Programmable Variable 4
7029 Programmable Variable 5
7030 Programmable Variable 6
7031 Programmable Variable 7
7032 Programmable Variable 8
7033 Programmable Variable 9
7034 Programmable Variable 10
7035 Programmable Variable 11

72
OMNICOM: Analog Outputs

7036 Programmable Variable 12


7037 Programmable Variable 13
7038 Programmable Variable 14
7039 Programmable Variable 15
7040 Programmable Variable 16
7041 Programmable Variable 17
7042 Programmable Variable 18
7043 Programmable Variable 19
7044 Programmable Variable 20
7045 Programmable Variable 21
7046 Programmable Variable 22
7047 Programmable Variable 23
7048 Programmable Variable 24
7049 Programmable Variable 25
7050 Programmable Variable 26
7051 Programmable Variable 27
7052 Programmable Variable 28
7053 Programmable Variable 29
7054 Programmable Variable 30
7055 Programmable Variable 31
7056 Programmable Variable 32
7057 Programmable Variable 33
7058 Programmable Variable 34
7059 Programmable Variable 35
7060 Programmable Variable 36
7061 Programmable Variable 37
7062 Programmable Variable 38
7063 Programmable Variable 39
7064 Programmable Variable 40
7065 Programmable Variable 41
7066 Programmable Variable 42
7067 Programmable Variable 43
7068 Programmable Variable 44
7069 Programmable Variable 45
7070 Programmable Variable 46
7071 Programmable Variable 47
7072 Programmable Variable 48
7073 Programmable Variable 49
7074 Programmable Variable 50
7075 Programmable Variable 51
7076 Programmable Variable 52
7077 Programmable Variable 53

73
OMNICOM: Analog Outputs

7078 Programmable Variable 54


7079 Programmable Variable 55
7080 Programmable Variable 56
7081 Programmable Variable 57
7082 Programmable Variable 58
7083 Programmable Variable 59
7084 Programmable Variable 60
7085 Programmable Variable 61
7086 Programmable Variable 62
7087 Programmable Variable 63
7088 Programmable Variable 64
27025 Programmable Variable 65
27026 Programmable Variable 66
27027 Programmable Variable 67
27028 Programmable Variable 68
27029 Programmable Variable 69
27030 Programmable Variable 70
27031 Programmable Variable 71
27032 Programmable Variable 72
27033 Programmable Variable 73
27034 Programmable Variable 74
27035 Programmable Variable 75
27036 Programmable Variable 76
27037 Programmable Variable 77
27038 Programmable Variable 78
27039 Programmable Variable 79
27040 Programmable Variable 80
27041 Programmable Variable 81
27042 Programmable Variable 82
27043 Programmable Variable 83
27044 Programmable Variable 84
27045 Programmable Variable 85
27046 Programmable Variable 86
27047 Programmable Variable 87
27048 Programmable Variable 88
27049 Programmable Variable 89
27050 Programmable Variable 90
27051 Programmable Variable 91
27052 Programmable Variable 92
27053 Programmable Variable 93
27054 Programmable Variable 94
27055 Programmable Variable 95

74
OMNICOM: Analog Outputs

27056 Programmable Variable 96


27057 Programmable Variable 97
27058 Programmable Variable 98
27059 Programmable Variable 99
27060 Programmable Variable 100
27061 Programmable Variable 101
27062 Programmable Variable 102
27063 Programmable Variable 103
27064 Programmable Variable 104
27065 Programmable Variable 105
27066 Programmable Variable 106
27067 Programmable Variable 107
27068 Programmable Variable 108
27069 Programmable Variable 109
27070 Programmable Variable 110
27071 Programmable Variable 111
27072 Programmable Variable 112
27073 Programmable Variable 113
27074 Programmable Variable 114
27075 Programmable Variable 115
27076 Programmable Variable 116
27077 Programmable Variable 117
27078 Programmable Variable 118
27079 Programmable Variable 119
27080 Programmable Variable 120
27081 Programmable Variable 121
27082 Programmable Variable 122
27083 Programmable Variable 123
27084 Programmable Variable 124
27085 Programmable Variable 125
27086 Programmable Variable 126
27087 Programmable Variable 127
27088 Programmable Variable 128

Scratch Pad Variables

3501-3599 Short Integers


5501-5599 Long Integers
7501-7599 IEEE Floats

Miscellaneous Variables

7624 - Equilibrium Pressure Meter Run 1


7625 - Equilibrium Pressure Meter Run 2

75
OMNICOM: Analog Outputs

7626 - Equilibrium Pressure Meter Run 3


7627 - Equilibrium Pressure Meter Run 4

Remarks

Enter any comments or remarks about this analog output (up to 16 characters).

Value @ 4mA

Enter the engineering value of the variable stored at the assigned database index that would cause a
4mA output.

Value @ 20mA

Enter the engineering value of the variable stored at the assigned database index that would cause a
20mA output.

76
OMNICOM: HART Inputs

HART Inputs
HART inputs are available with firmware versions 20.75.01, 22.75.02, 23.75.01, 24.75.01, 26.75.01,
and 27.75.03 and higher.

These entries are used to assign a physical input to each transducer. HART Inputs range from 25-
88. Duplicate I/O assignments can be made when a transducer is shared. Once you enter the inform-
ation and/or make your selections, press the [Apply] button to set. Note: Nothing is written to the
OMNI unless the input has been assigned.

Settings
The items listed below are the descriptions of each setting option within the HART Input dialog. Click
on a setting for more information.

Tag ID

An 8 character ASCII string which identifies each transducer. The tag appears in the LCD display
before the value of the variable.

For firmware version 27.75.03 only - the tag is automatically entered in upper case letters and
must match the HART short tag that was entered in the HART device. This field is used for com-
munication to the HART device. Note: for firmware versions 27.75.04 and higher, this tag is no
longer used for HART communications.

The following are valid characters for the HART tag:

Character Hex Code Description


SP 0x20 Space
! 0x21 Exclamation Point
" 0x22 Double Quotes
# 0x23 Number Sign
$ 0x24 Dollar Sign
% 0x25 Percent Sign
& 0x26 Ampersand
' 0x27 Single Quote
( 0x28 Open Parenthesis
) 0x29 Close Parenthesis
* 0x2A Asterisk
+ 0x2B Plus Sign
, 0x2C Comma
- 0x2D Hyphen
. 0x2E Period

77
OMNICOM: HART Inputs

/ 0x2F Forward Slash


0 to 9 0x30-0x39 Numbers
: 0x3A Colon
; 0x3B Semi-colon
< 0x3C Less Than Sign
= 0x3D Equal Sign
> 0x3E Greater Than Sign
? 0x3F Question Mark
@ 0x40 At Sign
A to Z 0x41-0x5A Upper Case Letters
[ 0x5B Open Bracket
] 0x5D Close Bracket
^ 0x5E Carat
_ 0x5F Underline

Note: The question mark is an acceptable character but it may not be the only character as that is the
fill character for unused characters. A tag name of all question marks is considered undefined in the
HART protocol.

Network Type

The HART network type is displayed as:


Point-To-Point
Multivariable (XX) - where 'XX' is the variable the input represents (i.e. PV, SV, TV, QV for the
four inputs on the network respectively)
Multidrop - Poll ID X - where 'X' is the fixed poll ID that represents the input number on the net-
work (i.e. 1, 2, 3, 4)

Signal Type

The signal type is always "HART Input".

Input Type

Allows you to select the type of input that is coming into the OMNI.

The choices are:


Unassigned
Temperature
Pressure
DP
Auxiliary Input

Alarm Limits

78
OMNICOM: HART Inputs

Low Alarm Limit:


Enter the measurement value in engineering units below which the Low Alarm of the process
variable activates. Measurement signal inputs approximately 5% or more below this value will
activate the device's Fail Low Alarm.

High Alarm Limit:


Enter the measurement value in engineering units above which the High Alarm of the process
variable activates. Measurement signal inputs approximately 5% or more above this value will
activate the device's Fail High Alarm.

Input Scaling

(Available with firmware versions 23.75.01 and 27.75.04 and higher for DP types only)

Input at Zero Scale:


This entry is used to determine the Input at Zero Scale (4 mA or 1V).

Input at Full Scale:


This entry is used to determine the Input at Full Scale (20 mA or 5V).

Override

Select the type of manual override strategy you wish to use. You must also enter the override value
in engineering units for the computer to use when an override strategy is selected.

Assignments

The assignments are a list of all the variables that this HART input has been assigned to represent.
A HART input used to measure temperature, for example, could be assigned to represent the tem-
perature at the meter run and/or at the densitometer.

The Current Assignments item on the tree now has a tab for "HART Inputs" and displays the type
and assignments.

On all I/O drop downs where the user is selecting a HART input, the list will show:
Unassigned
Process Inputs for the I/O type
HART Inputs for the I/O type
Remote Input 99
Virtual Inputs for the I/O type

The Configuration Print includes the details of the HART Inputs as well as the current assignments
and they are listed after the Process Inputs.

Conversion of HART device units to OMNI units


OMNI strongly recommends to configure your HART device to match the units in the flow computer
to prevent unnecessary unit conversions in the flow computer. The following table shows the units

79
OMNICOM: HART Inputs

supported by each application. If more than one unit is supported, the units are configurable in the
Factors and Systems Constants screen.

OMNI Units DP Temperature Pressure


Application in H2O@60 degF kPa mBar degF degC PSIG kPa Bar kg/cm2
20 X X
21 X X X
22 X X
23 X X X
24 X X X X
26 X X X X
27 X X X X X X

Click on a topic to see the conversion table used in the flow computer.

DP

Conversion Factors
HARTUnit Code Description
in H2O@60 degF kPa mBar
1 in H2O@68 degF 0.999179 0.2486491 2.486491
2 in Hg@0 degC 13.60795 3.386387 33.86387
3 ft H2O@68 degF 11.99014 2.983789 29.83789
4 mm H2O@68 degF 0.039338 0.009789 0.09789
5 mm Hg@0 degC 0.535746 0.1333224 1.333224
6 PSI 27.70610 6.894759 68.94759
7 Bar 401.8429 100.0 1000.0
8 millibar 0.401843 0.1 1.0
9 g/cm2 0.394073 0.0980665 0.980665
10 kg/cm2 394.0733 98.06652 980.6652
11 Pa 0.004018 0.001 0.01
12 kPa 4.018429 1.0 10.0
13 Torr 0.535746 0.1333224 1.333224
14 atm 407.1673 101.325 1013.25
145 in H2O@60 degF 1.0 0.248853 2.48853
237 MPa 4018.429 1000.0 10000.0
238 in H2O@4C 1.000942 0.249088 2.49088
239 mm H2O@4C 0.039407 0.009807 0.09807

Temperature

HART Unit Conversion Factors


Description
Code degF degC

80
OMNICOM: HART Inputs

32 degC (degC x 1.8) + 32.0 1.0


33 degF 1.0 (degF - 32.0) / 1.8
((Rankine - 459.67) - 32.0) /
34 Rankine Rankine - 459.67
1.8
((Kelvin - 273.15) x 1.8) +
35 Kelvin Kelvin - 273.15
32.0

Pressure

HARTUnit Conversion Factors


Description
Code PSIG kPa mBar kg/cm2
1 in H2O@68F 0.036063 0.2486491 2.486491 0.002535515
2 in Hg@0 degC 0.491154 3.386387 33.86387 0.03453153
3 ft H2O@68 degF 0.432762 2.983789 29.83789 0.03042618
mm H2O@68
4 0.001420 0.009789 0.09789 0.0000998234
degF
5 mm Hg@0 degC 0.019337 0.1333224 1.333224 0.001359507
6 PSI 1.0 6.894759 68.94759 0.07030698
7 Bar 14.50377 100.0 1000.0 1.019716
8 millibar 0.014504 0.1 1.0 0.001019716
9 g/cm2 0.014223 0.0980665 0.980665 0.001
10 kg/cm2 14.22334 98.0665 980.665 1.0
11 Pa 0.000145 0.001 0.01 0.00001019716
12 kPa 0.145038 1.0 10.0 0.01019716
13 Torr 0.019337 0.1333224 1.333224 0.00135951
14 atm 14.69594 101.325 1013.25 1.033227
in H2O@60
145 0.036093 0.248853 2.48853 0.002537599
degF
237 MPa 145.0377 1000.0 10000.0 10.19716
238 in H2O@4C 0.036127 0.249088 2.49088 0.002539988
239 mm H2O@4C 0.001422 0.009807 0.09807 0.000099996

81
OMNICOM: HART Network Setup

HART Network Setup


Select the connection type for the network:

Point-To-Point

There is only one HART device on this connection with one configurable input.

Multivariable

There is only one HART device connected with up to four configurable inputs for PV, SV, TV, and
QV respectively.

Multidrop

There can be up to four multidropped HART devices with fixed poll IDs 1-4 respectively. Each device
has a corresponding configurable HART input.

82
OMNICOM: Virtual Inputs

Virtual Inputs
Virtual Inputs can be used as dummy inputs when there is no physical input but a value is input to sim-
ulate a measurement. They are available with firmware versions 20.74.30, 22.74.30, 23.74.30,
24.74.19, 26.74.10, and 27.74.21 and higher.

A "Virtual Inputs" tree item is available under the "Process Inputs" heading.

Clicking on the "Virtual Inputs" item brings up tabs for inputs 98 - 90 (in that order). The Modbus
register for the Virtual Value for that input is shown.

The following items may be configured:

Tag ID

An 8-character ASCII string which identifies each transducer. The tag appears in the LCD display
before the value of the variable.

Input Type

Allows you to select the type of input that is coming into the OMNI.
The choices are:

Unassigned
Temperature
Pressure
DP
Density/Gravity
Auxiliary Input

and for Gas Applications these additional items:


N2
CO2
HV
SG as 4-20mA

Alarm Limits

Low Alarm Limit:


Enter the measurement value in engineering units below which the Low Alarm of the process
variable activates. Measurement signal inputs approximately 5% or more below this value will
activate the device's Fail Low Alarm.

High Alarm Limit:


Enter the measurement value in engineering units above which the High Alarm of the process
variable activates. Measurement signal inputs approximately 5% or more above this value will
activate the device's Fail High Alarm.

83
OMNICOM: Virtual Inputs

Validation Thresholds:
The low and high validation values will be displayed based on the span of the alarm limits and
the validation threshold percents entered in the Factors and Systems Constants screen.

Override Code (available with firmware versions 20.75.10, 22.75.10, 23.75.10,


24.75.10, 26.75.10, and 27.75.10 and higher)

For Firmware versions prior to 20.75.10, 22.75.10, 23.75.10, 24.75.10, 26.75.10, and 27.75.10, the
Override Code is set to "Never use" and all selections are disabled.

For firmware versions 20.75.10, 22.75.10, 23.75.10, 24.75.10, 26.75.10, and 27.75.10 and higher,
select from the following override codes:
Always use
Never use
Use if validation threshold exceeded
Use last hour's average if validation threshold exceeded

See the Factors and Systems Contants screen to set the validation thresholds.

Override

Enter an override value for the virtual input.

Assignments

A list of all the variables that this process input has been assigned to represent. A process input used
to measure temperature, for example, could be assigned to represent the temperature at the meter
run and meter run densitometer.

The Current Assignments item on the tree has a tab for "Virtual Inputs" and displays the type and
assignments for 98 - 90.

On all I/O drop downs where the user is selecting a process input that allows Virtual Inputs, the list
will show:
Unassigned
Process Inputs for the I/O type
Remote Input 99
Virtual Inputs for the I/O type where the Virtual Inputs are listed from 98 - 90 for all inputs that
match the selection type (i.e. temp, pres, etc).

The Configuration Print includes the details of the Virtual Inputs as well as the current assignments
and they are listed after the Remote Input 99.

Modbus Registers
The Virtual Values are stored in engineering units in Modbus registers 7690-7698 for Virtual
Inputs 90-98 respectively.

84
OMNICOM: Virtual Inputs

The validation threshold percentages can be found in 17134 for low and 17135 for high.

85
OMNICOM: SV Module Setup

SV Module Setup
The SV combo module provides a total of 2 RS-485 serial ports to connect to compatible mul-
tivariable transmitters. Select the protocol for each port on the module.

Setup Options
The protocols supported are:
Rosemount 3095FB DP
Instromet Ultrasonic
FMC MPU 1200
Daniel Ultrasonic
FLOWSIC 600 Ultrasonic

86
OMNICOM: A Combo Modules

A Combo Modules
Each 'A' type combo module accepts a total of 4 input channels and provides two 4-20 mA output
channels. Each combo module is associated with 12 connections on the back panel terminals (refer
to the Terminal Block Diagram).

Configuration Options
Each input channel is configured as a 1-5 volt DC voltage input (1 megohm input impedance).
By inserting mini jumpers, 250 ohm shunt resistors can be installed, converting each input
channel to 4-20 mA.
Input channels 1 and 2 of each 'A' type combo module can be converted to four wire RTD by
moving mini jumpers to change each input into a 0 to 0.5 volt DC voltage input and using one
of the built in excitation current sources.
Input channels 3 and 4 of each module can be converted to accept voltage pulse signals
(pulse type meters) by moving sets of mini jumpers from the 'A'(analog) to the 'P'(pulse) pos-
ition. Input four also has a set of AC/DC coupling select jumpers.

Settings
The items listed below are the descriptions of each setting option within the I/O dialogs. Click on a set-
ting for more information.

Process Inputs
Analog Outputs

87
OMNICOM: B Combo Modules

B Combo Modules
One 'B' type combo module must be used for each digital densitometer connected. Each module
accepts a total of 4 input channels and provides one 4-20 mA output channel. Channel # 4 is
ALWAYS a densitometer (refer to the Terminal Block Diagram).

Configuration Options
Each input channel is configured as a 1-5 volt DC voltage input ( 1 meg ohm input imped-
ance). By inserting mini jumpers, 250 ohm shunt resistors can be installed converting each
input channel to 4-20 mA.
Input channels 1 and 2 of each 'B' type combo module can be converted to four wire RTD by
moving mini jumpers to change each input into a 0 to 0.5 volt DC voltage input and using one
of the built in excitation current sources.
Input channels 3 and 4 of each module can be converted to accept voltage pulse signals (tur-
bine and PD flow meters) by moving sets of mini jumpers from the 'A'(analog) to the 'P'(pulse)
position.
The fourth channel is dedicated for use with a digital densitometer and also has an AC/DC
coupling select jumper set.

Settings
The items listed below are the descriptions of each setting option within the I/O dialogs. Click on a set-
ting for more information.

Process Inputs
Analog Outputs

88
OMNICOM: C Combo Modules

C Combo Modules
One 'C' type combo module must be used for each flow meter to be proved using a compact prover.
Each module accepts a total of 4 input channels with channel four always dedicated to a turbine or
PD flow meter. Each combo module is associated with 12 connections on the back panel terminals
(refer to the Terminal Block Diagram).

Configuration Options
Each input channel is configured as a 1-5 volt DC voltage input ( 1 meg ohm input imped-
ance). By inserting mini jumpers, 250 ohm shunt resistors can be installed, converting each
input channel to 4-20 mA.
Input channels 1 and 2 of each 'C' type combo module can be converted to four wire RTD by
moving mini jumpers to change each input into a 0 to 0.5 volt DC voltage input and using one
of the built in excitation current sources.
Input channels 3 and 4 of each 'C' type combo module can be converted to accept voltage
pulse signals (turbine and PD flow meters) by moving a set of mini jumpers from the 'A'(ana-
log) to the 'P'(pulse) position.
The fourth channel also has an AC/DC coupling select jumper.
On this module input channel #4 is ALWAYS a turbine or PD flow meter.

Settings
The items listed below are the descriptions of each setting option within the I/O dialogs. Click on a set-
ting for more information.

Process Inputs
Analog Outputs

89
OMNICOM: E/D Combo Modules

E/D Combo Modules


Each module accepts a total of 4 input channels with channels three and four always dedicated to fre-
quency type densitometers producing pulses. Each combo module is associated with 12 con-
nections on the back panel terminals (refer to the Terminal Block Diagram).

This module is actually a standard E type module with the

Configuration Options
Channels 1 and 2 are configured as 1-5 volt DC voltage input ( 1 meg ohm input impedance).
By inserting mini jumpers, 250 ohm shunt resistors can be installed, converting each input
channel to 4-20
Input channels 1 and 2 of each 'E/D' type combo module can be converted to four wire RTD
by moving mini jumpers to change each input into a 0 to 0.5 volt DC voltage input and using
one of the built in excitation current sources.
Input channels 3 and 4 of each 'E/D' type combo module are always used to accept voltage
pulse signals from frequency type densitometers such as Micro Motion (Solartron),
The OMNI measures the periodic time between pulses to determine the flowing density. Mini
jumpers are used to select AC or DC coupling of the input pulse signal.
Select AC coupling for Micro Motion (Solartron) densitometers which usually provide a 3 to 5
volt peak to peak signal which rides on a 18
Another set of mini jumpers on the card allow the trigger threshold of each pulse input to be
set at +1 volt or +3.5 volts.

Settings
The items listed below are the descriptions of each setting option within the I/O dialogs. Click on a set-
ting for more information.

Process Inputs
Analog Outputs

90
OMNICOM: E Combo Modules

E Combo Modules
Each module accepts a total of 4 input channels with channels three and four always dedicated to tur-
bine or PD flow meter pulses. Each combo module is associated with 12 connections on the back
panel terminals (refer to the Terminal Block Diagram).

Configuration Options
Channels 1 and 2 are configured as 1-5 volt DC voltage input ( 1 meg ohm input impedance).
By inserting mini jumpers, 250 ohm shunt resistors can be installed, converting each input
channel to 4-20 mA.
Input channels 1 and 2 of each 'E' type combo module can be converted to four wire RTD by
moving mini jumpers to change each input into a 0 to 0.5 volt DC voltage input and using one
of the built in excitation current sources.
Input channels 3 and 4 of each 'E' type combo module are always used to accept voltage
pulse signals from turbine or PD flow meters. You may choose to configure the computer to
recognize each pulse signal as an independent flowmeter or as a dual set of pulse trains from
one flowmeter.
One 'E' type combo module is required for every flowmeter that you wish to perform dual
pulse error checking on.
Either pulse train can be proved using the double chronometry timing method (pulse inter-
polation).

Settings
The items listed below are the descriptions of each setting option within the I/O dialogs. Click on a set-
ting for more information.

Process Inputs
Analog Outputs

91
OMNICOM: HT Combo Modules

HT Combo Modules
Each 'HT' type combo module provides a total of four (4) HART point-to-point inputs and provides
two (2) 4-20 mA analog output channels. Each combo module is associated with 12 connections on
the back panel terminals (refer to the Terminal Block Diagram).

Configuration Options
Each input accepts serialized data from a HART transmitter using the HART protocol.
The input types supported are Temperature, Pressure, DP, or Auxiliary Input.

Settings
The items listed below are the descriptions of each setting option within the I/O dialogs. Click on a set-
ting for more information.

HART Inputs
Analog Outputs

92
OMNICOM: HM Combo Modules

HM Combo Modules
Each 'HM' type combo module provides a total of four (4) HART networks each with up to four (4)
HART inputs and provides two 4-20 mA analog output channels. Each combo module is associated
with 12 connections on the back panel terminals (refer to the Terminal Block Diagram).

Configuration Options
Each network accepts serialized data from a HART transmitter using the HART protocol.
Each network can be configured for point-to-point (one (1) input), multidropped (up to four (4)
inputs), or multivariable (four (4) inputs designated as DP, Temperature, and Pressure and
user defined).
The input types supported are Temperature, Pressure, DP, or Auxiliary Input.

Settings
The items listed below are the descriptions of each setting option within the I/O dialogs. Click on a set-
ting for more information.

HART Network Setup


HART Inputs
Analog Outputs

93
OMNICOM: H Combo Modules

H Combo Modules
Each 'H' type combo module provides a total of 4 Honeywell digital input channels and provides two
4-20 mA analog output channels. Each combo module is associated with 12 connections on the
back panel terminals (refer to the Terminal Block Diagram).

Configuration Options
Each input channel accepts serialized data from a Honeywell smart transmitter using the
Honeywell DE (digital enhanced) protocol.
The flow computer automatically configures the Honeywell transducer by switching it to the
digital DE mode and transmitting the required data base to the field device. The handheld con-
figurator is not required in most cases.
All inputs can be input type Temperature, Pressure, or DP.

Settings
The items listed below are the descriptions of each setting option within the I/O dialogs. Click on a set-
ting for more information.

Process Inputs
Analog Outputs

94
OMNICOM: HV Combo Modules

HV Combo Modules
The 'HV' type combo module provides a total of 4 Honeywell SMV-3000 multivariable transmitter
interface channels and provides two 4-20 mA analog output channels. There can be only one 'HV'
module. The 'HV' combo module is associated with 12 connections on the back panel terminals
(refer to the Terminal Block Diagram).

Configuration Options
Each input channel accepts serialized data from a Honeywell SMV-3000 multivariable trans-
mitter using the Honeywell DE (digital enhanced) protocol.
The flow computer automatically configures the Honeywell transducer by switching it to the
digital DE mode and transmitting the required data base to the field device. The handheld con-
figurator is not required in most cases.
Inputs 1-4 are input type DP.
Inputs 5-8 are input type Temperature.
Inputs 9-12 are input type Pressure.

Settings
The items listed below are the descriptions of each setting option within the I/O dialogs. Click on a set-
ting for more information.

Process Inputs
Analog Outputs

95
OMNICOM: SV Combo Modules

SV Combo Modules
The 'SV' type combo module provides a total of 2 RS-485 serial ports to connect to compatible mul-
tivariable transmitters and provides six 4-20 mA analog output channels. There can be up to 2 'SV'
modules. The 'SV' combo module is associated with 12 connections on the back panel terminals
(refer to the Terminal Block Diagram).

Configuration Options
Each input channel accepts serialized data from any compatible multivariable transmitter
using various protocols.
All inputs are signal type Analog.
All inputs can be input type DP, Temperature, and Pressure.
All inputs require a port number (1-4).
Meter types can be Rosemount 3095FB DP, Instromet Ultrasonic, FMC MPU 1200, Daniel
Ultrasonic, or FLOWSIC 600 Ultrasonic.
Rosemount 3095FB DP, Daniel Ultrasonic, and FLOWSIC 600 also require a Modbus ID.
If a Rosemount 3095FB DP meter type is assigned an input type of DP, the two inputs imme-
diately following are automatically assigned to input types Temperature and Pressure respect-
ively. You may only make Port and Modbus ID selections for the input type DP.

Settings
The items listed below are the descriptions of each setting option within the I/O dialogs. Click on a set-
ting for more information.

Process Inputs
Analog Outputs

96
OMNICOM: Current Assignments

Current Assignments
Shows a summary list, showing the physical I/O point assignments.

Process Inputs
HART Inputs
Remote Inputs
Virtual Inputs
Analog Outputs
Digital I/O
I/O Summary
Terminal Block Diagram

97
OMNICOM: Process Input Assignments

Process Input Assignments


Shows all configured physical inputs (1 - 24) in pages of 12 and lists each one's assignments.

Point numbers in red are invalid I/O assignments - the I/O type doesn't match the assignment type.
Check the list to ensure you have not assigned a physical I/O point to more than one transducer type.
(e.g. A point cannot be assigned to a temperature and pressure transmitter at the same time).

98
OMNICOM: HART Input Assignments

HART Input Assignments


Shows all configured HART inputs (25 - 88) in pages of 16 and lists each one's assignments.

Point numbers in red are invalid I/O assignments - the I/O type doesn't match the assignment type.
Check the list to ensure you have not assigned a physical I/O point to more than one transducer type.
(e.g. A point cannot be assigned to a temperature and pressure transmitter at the same time).

99
OMNICOM: Virtual Input Assignments

Virtual Input Assignments


Shows all inputs assigned to I/O points 98 - 90.

100
OMNICOM: Remote Inputs

Remote Inputs
Shows all inputs assigned to I/O point 99.

101
OMNICOM: Analog Output Assignments

Analog Output Assignments


Shows all analog outputs and corresponding assignment and remark.

102
OMNICOM: Digital Input Assignments

Digital Input Assignments


Shows all configured digital inputs (1 - 24) in pages of 12 and the corresponding assignment, type,
and remark.

103
OMNICOM: I/O Summary

I/O Summary
The I/O Summary dialog displays the meter, station, and prover I/O configuration (if any). The I/O
number, tag, and description are provided.

104
OMNICOM: Terminal Block Diagram

Terminal Block Diagram


The terminal block diagram dialog uses the configuration of the Modules and the I/O to show the sug-
gested module placement and terminal descriptions. A picture of the back panel is also shown.

Note: To make the Terminal Block Diagram tab appear when the Current Assignments tree item is
selected, add the following command line switch: '-TB'. You will have to exit OMNICOM and re-
enter it in order for the switch to take effect.

Settings
Card Cage

Select the card cage type of your OMNI. A 3000 has only 4 terminal blocks and is about 6 inches
long. A 6000 has 10 terminal blocks and is over a foot long.

Extended Back Panel

If the board has an extended back panel, check the box to see the extended terminal labels.

AC Power

Select 12 or 24 volts. This setting is for informational purposes only and does not affect the operation
of the OMNI.

Save

This will save the terminal diagram report to a file under the Reports folder. Note: there is no DOS
extension for this report so it is saved using the Date/Time and ".txt" extension.

Print

Press Print to print the terminal diagram to a printer. The back panel diagram is printed if the printer
is capable.

105
OMNICOM: Auxiliary Inputs

Auxiliary Inputs
The Auxiliary Inputs category is for entering the configuration, Setup, and Alarm Limits to the phys-
ical input channel that the auxiliary input is connected. Auxiliary inputs can be used to input BS&W,
viscosity and other miscellaneous type variables. Once you enter the information and/or make your
selections, press the [Apply] button to set.

Settings
The items listed below are links to descriptions of each setting option within the Configuration dialog.
Click on a link to go to that setting's description.

Configuration

I/O Point: Enter the number of the I/O point to be used for the auxiliary input.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable.

Type: (1) When using Rtd probes which follow the DIN curve and have an alpha of 0.00385.
(2) When using Rtd probes which follow the American curve and have an alpha of 0.00392.
(3) When using a smart transmitter connected to an 'H', 'HV' or 'SV' combo module or when
using a transducer that provides a linear 4-20mA output.

Setup

Override Code: This entry determines the strategy to be used regarding the 'Pressure Over-
ride Value'.

Override Value: This is the temperature value that will be substituted for the transducer value
depending on the 'Override Code' selection.

Zero Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 4 milliamperes
or 1 volt.

Full Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 20 milliamperes
or 5 volts.

Alarm Limits

Low: The low alarm activates when the temperature at the densitometer drops below this
value.

High: The low alarm activates when the temperature at the densitometer rises above this
value.

106
OMNICOM: Auxiliary Inputs

107
OMNICOM: Ports

Ports
The OMNI 3000 is limited to one dual serial I/O module. The OMNI 6000 can accept up to three
serial I/O modules. Each Serial I/O module has two RS-232/RS-485 ports. All the ports are Modbus-
compatible slaves. For more information, see the link for Serial Modules below.

The SE Module provides two communication channels. Each SE Module has two ports. The first
physical channel is an RS-232/RS-485 serial port and the second physical channel is a 10BaseT Eth-
ernet port. The user may select via a switch which port number is the serial and which port number is
the Ethernet port. For more information, see the link for SE Modules below.

Port 1 can be configured for a Local Printer or Modbus.


Port 2 can be used for as a Modbus master for redundant flow computer applications and com-
municating with slave devices (Peer to Peer).
Port 3 can be used for connection to a Gas Chromatograph.
Port 4 can be used for connection to an Allen-Bradley PLC.

Topics
The items listed below are links to topics covering the OMNI Port configurations. Click on a link to go
to that topic.

Protocol
Hardware Setup
Timing
Ethernet Setup
Ethernet Configuration (available with firmware versions 20.74.30, 21.75.10, 22.74.30, 23.74.30,
24.74.19, 26.74.10, and 27.74.21 and higher)
Serial Modules
SE Modules

108
OMNICOM: Protocol

Protocol
Enter the type of protocol to be used on this port. Once you enter the information and/or make your
selections, press the [Apply] button to set.

Settings
The items listed below are the settings covering each dialog within the Protocol Setup. Click on the
setting for more information.

Protocol Type

Valid selections are RTU, ASCII, or RTU using a modem connection. Mixed protocols are not
allowed on a communication link. All devices must use the same protocol type.

The RTU protocol is preferred as it is twice the speed of the ASCII.

Selecting 'Modbus RTU Modem' provides RTU protocol with relaxed timing which may be needed
when communicating via smart modems. These modems have been found to insert inter-character
delays which cause a premature end of message to be detected by the flow computer. (Always use
the normal RTU setting with all modems with the Windows version of OMNICOM.)

For the RTU types there is also a Modicon Compatible protocol. For example "Modbus RTU
Modicon Compatible".

Note that for Modicon Compatible units, OMNICOM automatically subtracts one from the register
number and formats the protocol to conform with 16-bit integers. If float data types are used, the float
bytes are swapped from ‘aa bb cc dd’ to ‘cc dd aa bb’.

CRC Detection Enabled (or Error Check Enabled)

Many protocols use either a CRC, LRC, or BCC error check to ensure that data received is not cor-
rupted. Note: For proper operation of the OMNI communications, this field must be
enabled (checked).

The flow computer can be configured temporarily to ignore the error checking on incoming mes-
sages. This allows software developers an easy means of debugging communication software. Be
sure to re-enable the error checking when finished.

'Error Check Enabled' is displayed for this field for the Allen-Bradley protocols.

Special Settings for Port 1 (Local Printer)

Serial Port 1 can be configured as a dedicated Local Printer port or a Modbus port. Selecting Mod-
bus eliminates the ability to print reports locally. Reports are still sent to the historical storage area
(last 8 batch, daily, and prove) and can be printed via a network printer or retrieved using
OMNICOM.

109
OMNICOM: Protocol

Special Settings for Port 3 (Gas Chromatograph)

If you have a Gas Chromatograph checked in the Equipment List, Serial Port 3 will have additional
protocol selections available:

HCl-A
Danalyzer RTU
Danalyzer ASCII

Note: if connecting to a Danalyzer RTU via RS-485, echo should be off.

Note: OMNI’s testing policy is to re-test GC communication protocols after flow computer firmware
changes have been made. This has not been possible with the Applied Automation HCI-A protocol
because ABB, the company that acquired the Applied Automation GC product line, no longer sup-
ports the HCI-A protocol. OMNI therefore cannot guarantee proper operation of HCI-A protocol.

Special Settings for Port 4 (Allen-Bradley PLC)

If you have Allen-Bradley PLC checked in the Equipment List, Serial Port 4 will have additional pro-
tocol selections available:

Allen-Bradley Full Duplex (CRC)


Allen-Bradley Half Duplex (CRC)

Allen-Bradley Full Duplex (BCC)


Allen-Bradley Half Duplex (BCC)

110
OMNICOM: Hardware Setup

Hardware Setup
Use this menu to setup the serial I/O ports. Parameters include: Baud Rate, Data Bits, Stop Bits and
Parity settings.

WARNING: Changing the parameters for the port you are connected to will cause communications
with the flow computer to be lost.

Once you enter the information and / or make your selections, press the [Apply] button to set.

Settings
The items listed below are the settings covering each dialog within the Hardware Setup. Click on the
setting for more information.

Baud Rate

Valid Baud Rates Are: 300, 600, 1200, 2400, 4800, 9600, *19200, and *38400.

*NOTE: Serial ports 1 and 2 use common circuitry in the flow computer, as do serial ports 3 and 4
and 5 and 6. Because of this it is not possible to select both 38400 and 19200 on common ports.

For Example: The flow computer will reject an entry of 19200 on a port if the matching port has
already been configured for 38400. Likewise, entries of 38400 will be rejected if the matching port
has been configured for 19200.

Parity

Valid choices of parity bit are: Even, Odd or None. Parity selection is non critical as long as both ends
of the link are setup the same way.

Data Bits

Valid Data Bits settings for ports connected to printers are 7 or 8. Certain communication protocols
such as 'Modbus RTU' transmit and receive 8 bit bytes and must be setup for 8 data bits.

Stop Bits

Valid stop bit settings are 1 or 2.

Modbus ID (or Node ID)

The OMNI's Modbus ID or address. It is also referred to as 'Node ID' for the Allen-Bradley protocol.
Note: this field is not displayed for Serial Port 1 if Serial Port 1 is defined as a printer as it is not used.

Click on the up arrow to increase the number and the down arrow to decrease the number. You may
also enter in a number directly. The ID can range from 1 to 247. The default value is 1.

111
OMNICOM: Hardware Setup

112
OMNICOM: Timing

Timing
This is the amount of delay (0, 50,100 or 150ms) that occurs between the RTS (Tx Key) signal going
active and data being transmitted. The delay is needed by the receiving device to allow the radio or
modem to acquire a lock on the carrier.

IMPORTANT: This must be set to 0 when the port is used for printing.

113
OMNICOM: Ethernet Setup

Ethernet Setup
Depending on the model and firmware revision, OMNI Flow Computers can support up to two SE
Modules. Each SE Module provides two channels, which give a total of six communication channels.
Once you enter the information and/or make your selections, press the [Apply] button to set.

For more information on setting up the SE module reference Technical Bulletin TB020101, this can
be found on the OMNI Flow web site.

Settings
The items listed below are the settings covering each dialog within the Ethernet Setup. Click on the
setting for more information.

Modbus ID

Enter the Modbus ID of the OMNI that is connected to the Ethernet port.

Modicon Compatible

(available with firmware versions 20.74.20, 22.74.30, 23.74.19, 24.74.17, 26.74.10 and 27.74.18
and higher)

Note that for Modicon Compatible units, OMNICOM automatically subtracts one from the register
number and formats the protocol to conform with 16-bit integers. If float data types are used, the float
bytes are swapped from ‘aa bb cc dd’ to ‘cc dd aa bb'.

114
OMNICOM: Ethernet Configuration

Ethernet Configuration
SE Module Configuration via OMNICOM and Network Printing is available with OMNI firmware ver-
sions 20.74.30, 21.75.10, 22.74.30, 23.74.30, 24.74.19, 26.74.10, and 27.74.21 and higher using
OMNI SE Module firmware v1.50 and higher. Note that the network printing configuration is not avail-
able via the front panel. Network Utility supports configuration of the SE Module firmware prior to
v1.50 (back to v1.22) however does not include the Network Printing configuration. To enable offline
configuration of the Ethernet module, check the "SE Firmware v1.50 and higher" checkbox in the
Ethernet Allocations group of the Modules configuration.

Depending on the model and firmware revision, OMNI Flow Computers can support up to two SE
Modules. Each SE Module provides two channels, which give a total of four communication chan-
nels - two Ethernet and Two Serial. Each Ethernet channel can support eight connections. For more
information on setting up the SE module reference Technical Bulletin TB-020101, this can be found
on the OMNI Flow web site.

The SE Module configuration settings are always read from the OMNI when the entire configuration
is received. If OMNICOM is using an Ethernet port on an SE Module, the SE Module settings for that
port are not written to when transmitting a configuration file to the flow computer - only the settings
for the serial or Ethernet ports not being used by OMNICOM are written to.

Settings
Below are the tabs used within the Ethernet Configuration. Click on a link to go to that topic.

Ethernet
Host
Repeater
Security
Advanced
Printing
Logging

Import/Export Ethernet Configurations


Ethernet Configuration files can be imported or exported if the Advanced User command line switch
"-AU" is enabled. If you need help adding a command line switch, please speak with your IT rep-
resentative.

After the command line switch is enabled, access the import/export feature by right-clicking on the
tree item or selecting via the File Menu. Files are defaulted to the extension: "*.oXXEthN where

115
OMNICOM: Ethernet

Ethernet
The Ethernet page contains TCP/IP destination endpoints that are referred to as “ports” and are
entered as decimal numbers.

Once you enter the information and/or make your selections, press the [Apply] button to write to the
OMNI. The OMNI writes the new configuration to the SE Module.

Note: The IP Address type entries contain four segments of numbers (i.e 200.100.101.32). Each
segment takes up to three digits representing an 8-bit integer ranging from 0-255. If three digits are
entered in a segment, the cursor automatically goes to the next segment. If less than three digits are
entered, press the down/up arrow to move to the right/left segments of the entry. When the changes
are complete, click on another field or press TAB to enable the Apply button.

Settings
The items listed below are descriptions of each setting option within the Ethernet dialog. Click on a
setting for more information.

IP Address

All devices on a network require a unique IP address. This is the static IP address used for all net-
work connections to the SE Module and is the same as the one configured in the OMNI for the Eth-
ernet port. The IP address is entered in dotted decimal notation. The default is 10.0.0.1.

Netmask

IP addresses contain a Network Identifier (netid), a Subnet Identifier (subnetid), and a Host Identifier
(hostid). Subnet masks or Netmasks identify the portion of the address occupied by the netid and the
subnetid. The Netmask is entered in dotted decimal notation and is the same as the one configured
in the OMNI for the Ethernet port. The default is 255.0.0.0.

Gateway

If a gateway exists for accessing other subnets, it can be entered here. The Gateway is entered in
dotted decimal notation and is the same as the one configured in the OMNI for the Ethernet port. The
default is 0.0.0.0 or disabled.

Encapsulated Modbus Port

The TCP/IP port number used to communicate with the flow computer using standard Modbus
encapsulated by TCP/IP. It may be changed to meet any special needs of your network. Entering 0
for the port number will disable Modbus connections. This port number must be different from the
Modbus/TCP port number. The default is 6000.

Modbus/TCP Port

116
OMNICOM: Ethernet

The TCP/IP port number used to communicate with the flow computer using Modbus over TCP. The
default is the standard Modbus/TCP port of 502. It may be changed to meet any special needs of
your network. Entering 0 for the port number will disable Modbus/TCP connections. This port num-
ber must be different from the Encap. Modbus port number.

Telnet Port

The port number used for Telnet connections. The default is the standard Telnet port of 23. It may be
changed to meet any special needs of your network. Entering 0 for the Telnet port will disable Telnet
connections.

Note: Network Utility v1.07 and higher will detect the configured Telnet port and use that for the con-
nection. If you are using any other Telnet program and the port is set to zero, configuration changes
can only be made through the SE Module's onboard serial port.

Ethernet ID

A 15 character ID that can be used to name or describe the SE Module in an OMNI.

Message Timeout

This is the time in milliseconds that the SE Module will wait for a complete message on the TCP con-
nection. It should be long enough to account for any network delays but shorter than the retry time
out in any application software used for communications. The default is 1000 milliseconds (1
second).

Inactivity Timeout

This is the time in minutes that a connection to the Encapsulated Modbus and Modbus/TCP ports
can remain idle before being disconnected. The default is 15 minutes. Entering 0 will disable the
Inactivity Timeout.

Note: This setting does not apply to the time out for idle Telnet connections, which is fixed at 5
minutes.

117
OMNICOM: Host

Host
The Host refers to the flow computer in which the SE Module is installed. These parameters should
match the configuration parameters in the OMNI for the port the Ethernet channel occupies.

Once you enter the information and/or make your selections, press the [Apply] button to write to the
OMNI. The OMNI writes the new configuration to the SE Module.

Settings
The items listed below are descriptions of each setting option within the Host dialog. Click on a set-
ting for more information.

Modbus ID

The Modbus ID of the Host serial port. It is used to determine if messages are sent to the Host or
sent out the Repeater port. It is the Modbus ID in the OMNI configured for the Ethernet port. The
default is 1. It can be changed to any valid Modbus ID (1-247). This address will not be accessible on
the Repeater port.

Modicon Compatible

(available with firmware versions 20.74.20, 22.74.30, 23.74.19, 24.74.17, 26.74.10, and 27.74.18
and higher)

Check the box if the Modbus communications are using Modicon compatible format. It is the Modbus
Compatible setting in the OMNI configured for the Ethernet port.

Note that for Modicon Compatible units, OMNICOM automatically subtracts one from the register
number and formats the protocol to conform with 16-bit integers before transmitting to the OMNI. If
float data types are used, the float bytes are swapped from ‘aa bb cc dd’ to ‘cc dd aa bb'.

Note that if Modicon is selected, it applies to all of the connections for that IP address.

Note: ASCII protocol with Modicon Compatibility is not supported.

Initial Delay

This is the time in milliseconds that the SE Module waits for a response from the OMNI before con-
sidering it a no response and then accepting the next incoming transaction. The default is 200 ms
and that is the recommended setting.

Char Delay

This is the time in milliseconds that the SE Module waits between characters (after the first character
has been received) sent from the OMNI before considering it a no response and then accepting the
next incoming transaction. The default is 20ms and that is the recommended setting.

118
OMNICOM: Host

119
OMNICOM: Repeater

Repeater
The Repeater port is used to ‘extend’ the Ethernet connections to other OMNI Flow Computers or
compatible Modbus devices using a 2-wire multi-dropped RS-485 connection. Any transaction that
is destined for a Modbus ID that does not match the Host flow computer configuration is routed out
the Repeater port.

Once you enter the information and / or make your selections, press the [Apply] button to write to
the OMNI. The OMNI writes the new configuration to the SE Module.

Settings
The items listed below are descriptions of each setting option within the Repeater dialog. Click on a
setting for more information.

Protocol

This is the protocol used over the Repeater Port. It can be set to Modbus RTU, Modbus ASCII or
Modbus Mixed. It does not determine what protocol is used over TCP/IP. The messages will be con-
verted if required. When set to Modbus Mixed, the messages are sent as received with no
RTU/ASCII conversion. The default is Modbus RTU.

Initial Delay

This is the time in milliseconds that will be waited for a response before freeing the repeater port for
other connections. The default is 200 ms.

Char Delay

This is the time in milliseconds that will be waited between characters after the receipt of the first
character on the Repeater Port before freeing it for other connections. The default is 20ms.

Baud Rate

The baud rate used by the repeater port. The choices are 9600, 19200, 38400 and 57600. It should
be set as high as possible. The default is 38400.

Data Bits

The Repeater port can be selected for 7 or 8 data bits. The default is 8.

Stop Bits

The Stop Bits can be selected for 1 or 2. If 2 stop Bits are selected the Parity will be set to None. The
default is 1.

120
OMNICOM: Repeater

Parity

The parity may be selected to be None, Even or Odd. Even and Odd Parity can be used only with 1
Stop Bit. The default is “None”.

121
OMNICOM: Security

Security
This dialog allows parameter changes that determine who has access via the network.

Once you enter the information and/or make your selections, press the [Apply] button to write to the
OMNI. The OMNI writes the new configuration to the SE Module.

Settings
The items listed below are descriptions of each setting option within the Security dialog. Click on a
setting for more information.

Serial Password

If a password is entered here, it will be required when using the SE Module's on-board serial DB-9
connector configuration port. It may be cleared by leaving the password entry blank. If cleared, no
passwords will be required. The default password is "omni" (lower case).

Note: The passwords are case sensitive. If you have forgotten your password, contact OMNI tech-
nical support for the procedure to recover it.

Telnet Password

This is the Password required when performing remote configuration of this module using Telnet.
The password can be cleared by leaving the entry blank. If cleared, no password will be required.
The default password is "omni" (lower case). The passwords are case sensitive.

Note: To disable Telnet access set the Telnet port to 0 (zero) instead of the standard default of 23 on
the Ethernet page.

TCP/IP Password

This is a password required for any connection to the Encapsulated Modbus or Modbus/TCP port
numbers. An OMNI “Password Needed” exception code (05) will be returned for any transaction
until the password is accepted. If cleared, no password will be required. The password is cleared by
default.

If this password is set, it needs to be written to Modbus address 4850 before further communications
are allowed. Alternatively, serial port passwords level A, B, or C may be used. See the OMNI Tech-
nical Bulletin TB960701, pages 5 and 6, for details on using the Serial Port passwords. Note that
"serial port" passwords in the OMNI apply to "Ethernet ports" as well.

Note: Do not use the TCP/IP password simultaneously with serial port passwords on an Ethernet
port!

Respond to Ping

122
OMNICOM: Security

Responses to ICMP Echo Requests or Pings can be enabled or disabled for added security. The
default value is Enabled.

IP Filter & Filter Mask

Connections to the Encapsulated Modbus and Modbus/TCP ports can be limited to an individual IP
address or a range of IP addresses. The mask determines which bits are significant when testing the
address. If the IP Filter is set to 0.0.0.0, it will be disabled.

MAC Addresses

Media Access Control (MAC) addresses provide the highest level of security. Connections to the
Encapsulated Modbus and Modbus/TCP ports can be limited to a list of hardware Ethernet
addresses. This limits access to a particular machine. If they are set to zeros they will be disabled.

123
OMNICOM: Advanced

Advanced
The Advanced page allows parameter changes that determine how data is sent over the network.

Once you enter the information and/or make your selections, press the [Apply] button to write to the
OMNI. The OMNI writes the new configuration to the SE Module.

Settings
The items listed below are descriptions of each setting option within the Advanced dialog. Click on a
setting for more information.

*** Warning: Use Caution when changing these parameters! ***

Retransmit Minimum

This field may be useful for VSAT communications. A time in milliseconds that represents a lower
boundary for a retransmit time out. The default is 10ms.

Note: Beware of reducing this, since modern hosts try to ack only every second segment. If the time
out is too small, the SE module will unnecessarily retransmit if it doesn’t get the ack for the first of the
two segments (especially on a fast LAN, where the RTT measurement will tempt you to set a small
time out).

Retransmit Maximum

This field may be useful for VSAT communications. A time in milliseconds that represents an overall
upper boundary for the retransmit time out. The default is 10000 ms.

Nagle Algorithm

Nagle's algorithm is a means of improving the efficiency of TCP/IP networks by reducing the number
of packets that need to be sent over the network. The default is Enabled.

Socket Close Timeout

The amount of time the host waits before closing the socket connection after the client device has
stopped responding during active communication, i.e. power loss. The value ranges from 10 to 240
seconds with the default at 120 seconds.

124
OMNICOM: Printing

Printing
The Printing page allows you to set up the printers used for network printing and assign which
reports go to which printers. Two printers are available for network printing on each SE Module.

Network Printing is available with OMNI firmware versions 20.74.30, 21.75.10, 22.74.30, 23.74.30,
24.74.19, 26.74.10, and 27.74.21 and higher and OMNI SE Module firmware v1.50 and higher.
Note: OMNI's Network Utility program does not support the configuration of the Printing con-
figuration.

Note: This is not the setup for the serial printer. To set up the serial printer go to the Local Printer dia-
log.

The OMNI SE firmware follows the LPD (Line Printer Daemon) protocol outlined in RFC 1179. The
OMNI SE uses ports 721 through 731 and communicates to the printers using the configured IP
address and port 515.

For OMNI SE firmware v1.56 and higher, the host name is the Ethernet ID configured in the Eth-
ernet screen. The print queue name is configurable in this screen and is described below.

Note: For OMNI SE firmware v1.55 and lower, the host name is fixed as "OMNISE" and the queue
name is fixed at "LPT1".

Once you enter the information and/or make your selections, press the [Apply] button to write to the
OMNI. The OMNI writes the new configuration to the SE Module.

Settings
The items listed below are descriptions of each setting option within the Printing dialog. Click on a set-
ting for more information.

IP Address

All devices on a network require a unique IP address. This is the static IP address used for the net-
work printer connection to the SE Module. The IP address is entered in dotted decimal notation. The
default is 0.0.0.0 or not used.

Print Queue Name

(valid for SE module firmware v1.56 and higher)

Enter a 16-byte ASCII character name for the print queue. If the name is blank, the Ethernet firm-
ware uses "LPT1" as the default.

The queue names are case sensitive and may contain any of the ASCII characters listed in the table
below:

125
OMNICOM: Printing

Character Hex Code Description


! 21 Exclamation Point
# 23 Number Sign
$ 24 Dollar Sign
% 25 Percent Sign
& 26 Ampersand
' 27 Apostrophe
( 28 Open Parenthesis
) 29 Close Parenthesis
- 2D Hyphen
0123456789 30-39 Numbers
@ 40 At Sign
ABCDEFGHIJKLMNOPQRSTUVWXYZ 41-5A Upper Case Letters
^ 5E Carat
_ 5F Underscore
` 60 Accent
abcdefghijklmnopqrstuvwxyz 61-7A Lower Case Letters
{ 7B Open Brace
} 7D Close Brace
~ 7E Tilde

Printer Timeout

(valid for SE Module firmware v1.57 and higher)

A printer response timeout can be configured for each network printer. This may be helpful when net-
work printing over satellite links or if a printer needs warm up time after being in sleep mode. The
timeout ranges from 5 to 300 seconds (5 minutes). The default is 10 seconds.

Note: There is a 5 second timeout when attempting to establish the initial socket connection. If a
printer port is busy, the SE module attempts to connect via each of the ports 721-731 in turn begin-
ning with the one it left off of until it either finds an open port or the list is exhausted. For busy systems
with many OMNI's printing to the same printer, there may be up to a 50 second delay before the
report is printed.

Printer Type

Printer Type: Select the type of network printer. If you select something other than "Cus-
tom", a default condensed and normal mode string for that printer type will be displayed.

Printer Condensed/ Normal Mode String: These entries are meaningful only when using
the default report templates stored in EPROM. Some of these reports are more than 80 char-
acters wide under certain circumstances (four meter runs + station). The flow computer will
send an ASCII escape string to switch the printer to condensed character mode (approx-
imately 16+ characters per inch) or to normal (approximately 10 characters per inch). Enter

126
OMNICOM: Printing

the data as hexadecimal characters (groups of two characters, enter '0F' not just 'F') with up
to 16 sets of characters.

Printers Condensed Mode String Normal Mode String


HP LaserJet 1B266B3253 1B266B3053

Report Printer Assignment

Assign a network printer for each of the reports in the list by checking the box under the printer
where you want the report to be printed. It can be printed to more than one printer or not be sent to
any network printer.

Note: All reports are sent to the local serial printer if one is configured. See the help for Local Printer.

127
OMNICOM: Logging

Logging
The Logging page is used to enable the logging of system information and alerts called the "Syslog".
The syslog protocol provides a transport for the transmission of event notification messages across
networks to event message collectors, or syslog servers, using UDP via port 514. The OMNI SE
firmware follows the syslog protocol outlined in RFC 3164. For examples of Syslog notification mes-
sages sent by the OMNI SE Module, click here .

Once you enter the information and/or make your selections, press the [Apply] button to write to the
OMNI. The OMNI writes the new configuration to the SE Module.

Settings
The items listed below are descriptions of each setting option within the Logging dialog. Click on a
setting for more information.

Syslog IP

The IP Address of the syslog event message collector or syslog server. If an IP address is entered,
the Syslog is enabled and events are transmitted via UDP to that IP address using the standard Sys-
log port 514. The default is disabled.

Note: It is recommended to use a static IP address for the syslog server instead of using an IP
Address obtained using DHCP.

128
OMNICOM: SysLog Examples

SysLog Examples
Examples of Syslog notification messages sent by the OMNI SE Module:

<181>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Ethernet card restart


<181>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Network up
<181>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Ethernet board reset - IP:
192.168.157.216
<181>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Ethernet board reset - Serial
<180>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Ethernet Flash download - IP:
192.168.157.216
<181>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Ethernet set to factory defaults - IP:
192.168.157.216
<181>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Ethernet set to factory defaults – Serial
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Ethernet configuration change - IP:
192.168.157.216
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Ethernet configuration change - Serial
<180>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Serial password changed - IP:
192.168.157.216
<180>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Serial password changed - Serial
<180>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Telnet password changed - IP:
192.168.157.216
<180>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Telnet password changed - Serial
<180>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: TCP password changed - IP:
192.168.157.216
<180>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: TCP password changed - Serial
<180>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Invalid Serial password attempts
<180>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Invalid Telnet password attempts - IP:
192.168.157.216
<180>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Invalid TCP password attempts - IP:
192.168.157.216 Port: 502
<181>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Lost password sequence entered -
Serial
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Ping request - IP: 192.168.157.216
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Syslog enabled - IP: 192.168.157.216
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Syslog enabled - Serial
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Syslog disabled - IP: 192.168.157.216
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Syslog disabled - Serial
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Debug on - IP: 192.168.157.216
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Debug on - Serial
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Debug off - IP: 192.168.157.216
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Debug off - Serial
<181>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: IP address change - IP:
192.168.157.14, New IP: 192.168.157.17
<181>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: IP address change – Serial, New IP:
192.168.157.17

129
OMNICOM: SysLog Examples

<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Port blocked - IP: 192.168.157.216


Port: 502
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: IP filter rejection- IP: 192.168.157.216
Port: 502
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: MAC filter rejection- IP:
192.168.157.216 Port: 502
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Modbus timeout - IP: 192.168.157.216
Port: 502
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Modbus exception - IP:
192.168.157.216 Port: 502 Code: 05
<182>Jan 20 10:46:03 192.168.157.14 OMNISE[6C159D]: Printer 1 IP address change – Flow
Computer, New Printer IP: 192.168.157.200

130
OMNICOM: Serial I/O Module Types 686005 & 686205

Serial I/O Module Types 686005 & 686205


Older 686005 per I/O module have two independent opto isolated RS-232 ports. The new 686205
also provides two optically isolated ports but each port can be jumpered for RS-485 as well as RS-
232. Max baud rate is 38400.

RS-485 CONNECTIONS TO THE 686205 SERIAL MODULE

Although the ports can operate at RS-232 voltage live, the outputs float when not sending data. This
ability to float the output when not sending allows multiple OMNI flow computers to be multi dropped
to one system printer or Modbus master using a RS-232 connection. The figure below shows the
RS-232 connections.

View RS-232 Connections

RS-485 CONNECTIONS TO THE 686205 SERIAL MODULE


RS-485 connections can be 2-Wire or 4-Wire configurations. The 2-Wire mode allows all devices on
a data link to talk to each other as "Peers" (no fixed master or slave). The 4-Wire mode allows des-
ignated "masters" to talk to designated "slaves". In this mode masters cannot talk to other masters
and slaves cannot talk to other slaves.

131
OMNICOM: Serial I/O Module Types 686005 & 686205

The diagrams below show the 2-Wire connections on Ports 1 & 2, and the 4-Wire connections on
ports 3 & 4. Note that each port can be independently jumpered to be RS-232-C, RS-485 2-Wire or
RS-485 4-Wire.

View RS-485 Connections

132
OMNICOM: SE Modules

SE Modules
The OMNI SE Module provides one RS-232/RS-485 port, one 10BaseT Ethernet port, one 2-wire
RS-485 Repeater port and one RS-232 Configuration Port. Address selection for Serial Module 1
(S1), Serial Module 2 (S2) or Serial Module 3 (S3) is provided along with the ability to swap the
Serial and Ethernet channels.

The RS-232/RS-485 Serial port is hardware identical to one half the OMNI RS-232-C / RS-485
Serial I/O Module model 68-6205-B and maintains the same I/O connector pinout and specifications.
It can be configured for RS-232, 4-wire RS-485 or 2-wire RS-485 communications. The signals
always occupy contacts 1 through 6 of the backpanel terminal strip (see OMNI Technical Bulletin
TB-020101 for additional information).

Connections
The connections for the RS-232/RS-485 serial port always occupy contacts 1 through 6 of the appro-
priate OMNI backpanel terminal strip (refer to the Terminal Block Diagram). This is regardless of it
being selected as port A or port B.

The Ethernet (10BaseT) and repeater ports always use terminals 7 through12 of the OMNI back-
panel (refer to the Terminal Block Diagram). A 10BaseT Ethernet cable is provided for connection to
the backpanel. One end is terminated for attaching to the 3000/6000 terminal blocks and the other
end has an RJ45 jack. Care should be taken on the terminal end to keep the + and - wires for TX and
RX twisted together as close to the terminal contacts as possible.

133
OMNICOM: Meter Run

Meter Run
The OMNI has the capacity of four meter runs. OMNICOM provides independent settings for the
meter run. The meter run setup category within OMNICOM provides a series of tabbed dialogs for
entering and selecting the corresponding OMNI configuration settings. These dialogs are accessed
from the OMNICOM navigation tree.

Note: Firmware versions 20/24 support Pulse Type and Coriolis Mass Pulse meters and Firmware
Versions 22/26 support Pulse Type. The flowmeter type is hard coded in the OMNI firmware for
those applications so there is no Flowmeter Type selection screen.

For firmware versions 20/24, if you are using a Coriolis flowmeter that is outputting volumetric pulses
instead of mass pulses, do not enable the "Select Mass Pulses" setting in the Meter Setup Screen. If
you are using a Coriolis flowmeter that is outputting mass pulses, enable the "Select Mass Pulses"
setting.

Firmware versions 22/26 do not support flowmeters that output mass pulses. Refer to the K-Factor
Pulses per Unit setting help for details on specifying the K-Factor in the correct units.

Topics
The items listed below are links to topics covering each subcategory within the Meter Run category.
Click on a link to go to that topic.

Flowmeter Type (only for Firmware Versions 21, 23, and 27)
Meter Run Setup
Meter Run Temperature
Meter Run Pressure
Density / Gravity

134
OMNICOM: Flowmeter Setup

Flowmeter Setup
Within OMNICOM you can select the flowmeter type and select signal configuration settings for the
flowmeter you selected within the Meter Run Configuration/Meter Type dialog tab. Based upon this
selection, OMNICOM makes available only those dialogs that apply to your flowmeter. Note: This
screen is only available for Orifice type applications.

Note: In version 23/27 firmware, when selecting the Meter Type as Coriolis, the OMNI always
assumes the pulses being output by the Coriolis meter are mass pulses and not volumetric pulses.
If the Coriolis flowmeter is configured to output volumetric pulses instead of mass pulses, it should be
configured as a Turbine Meter in the OMNI instead of a Coriolis meter.

Topics
The items listed below are the flowmeter types that can be selected. Click on a link to go to that topic.

DP Type
DP Device
V-Cone

Note: the V-Cone setting is only for firmware versions 23.75.02 and 27.75.02 and lower. For firm-
ware versions 23.75.10 and 27.75.03 and higher, please select DP Device on this page and select
V-Cone under the DP Device Type in the Physical Meter Setup page)

The V-Cone calculation is based on documentation Lit 24509-54 Rev. 3.0/10-02 by McCrometer,
Inc.

Pulse type
Pulse Type
Coriolis Mass Pulse (available with firmware versions 23.74.19 and 27.74.18 and higher)
Equimeter AAT

Multivariable
Rosemount 3095FB DP (only available with SV Modules)
Honeywell SMV3000 DP (only available with HV Modules)

Ultrasonic (only available with Sv Modules)


Instromet Ultrasonic
FMC MPU 1200
Daniel Ultrasonic
FLOWSIC 600 Ultrasonic (available with firmware versions 23.74.20 and 27.74.19 and higher)

135
OMNICOM: Flowmeter Setup

Configuration Selection Chart


Firmware Versions 23/27:

Meter Type Selection


DP Device 0
Pulse Type 1
Rosemount 3095FB DP 2
Honeywell SMV3000 DP 3
Instromet Ultrasonic 4
V-Cone (not available with firmware versions 23.75.10 and 27.75.03 and higher) 5
FMC MPU 1200 6
Equimeter ATT 7
Daniel Ultrasonic 8
Coriolis Mass Pulse 9
FLOWSIC 600 Ultrasonic 10

Firmware Version 21:

Meter Type Selection


DP Device 0
Rosemount 3095FB DP 1
Honeywell SMV3000 DP 2

136
OMNICOM: DP Device

DP Device
The "Physical Meter Run - DP Device" is for entering the specific Primary Element data for any dif-
ferential pressure device.

Additionally you can select the pressure tapping used and the measurement standard to be applied.

Once you enter the information and/or make your selections, press the [Apply] button to set.

Pipe Inside Diameter

Enter the diameter of the meter tube pipe at the reference temperature. The actual diameter of the
meter tube used in the equations is calculated continuously based on the flowing temperature of the
fluid.

For firmware versions 21 and 23, enter the value in inches.


For firmware version 27, enter the value in mm.

Pipe Reference Temperature

Enter the temperature that corresponds to the temperature of the metering tube when the orifice dia-
meter was measured.

For firmware versions 21 and 23, enter the value in degrees F.


For firmware version 27, enter the value in degC.

Pipe Expansion Coefficients

The meter tube diameter will expand and contract depending upon the temperature and thermal
expansion coefficient for the type of pipe material. The API 14.3(AGA 3):1992 equations require the
linear coefficient of expansion.

Firmware Versions 21 and 23

Plate Type Temperature Range (degF) Coefficient


Mild steel plate -100 to 300 6.20 x E-6
304/316 Stainless steel -100 to 300 9.25 x E-6
Monel -7 to 154 7.95 x E-6

Firmware Version 27

Plate Type Temperature Range (degC) Coefficient


Mild steel plate -73.3 to 148.9 1.116 x E-5
304/316 Stainless steel -73.3 to 148.9 1.665 x E-5
Monel -21.6 to 67.8 1.431 x E-5

137
OMNICOM: DP Device

DP Device Inside Diameter

Enter the diameter of the orifice bore at the orifice plate reference temperature. The actual diameter
of the orifice bore is calculated continuously based on the flowing temperature of the fluid.

For firmware versions 21 and 23, enter the value in inches.


For firmware version 27, enter the value in mm.

DP Device Reference Temperature

Enter the temperature in that corresponds to the temperature of the orifice plate when the bore was
measured.

For firmware versions 21 and 23, enter the value in degrees F.


For firmware version 27, enter the value in degC.

DP Device Expansion Coefficients

The orifice bore diameter will expand and contract depending upon the temperature and thermal
expansion coefficient for the type of plate material. The API 14.3(AGA 3):1992 equations require the
linear coefficient of expansion.

Firmware Versions 21 and 23

Plate Type Temperature Range (degF) Coefficient


Mild steel plate -100 to 300 6.20 x E-6
304/316 Stainless steel -100 to 300 9.25 x E-6
Monel -7 to 154 7.95 x E-6

Firmware Version 27

Plate Type Temperature Range (degC) Coefficient


Mild steel plate -73.3 to 148.9 1.116 x E-5
304/316 Stainless steel -73.3 to 148.9 1.665 x E-5
Monel -21.6 to 67.8 1.431 x E-5

DP Device Type

The flow computer must be informed as to where the differential pressure taps are located on the ori-
fice metering tube or if a specific DP device type is installed.

When Flange Taps is selected, you must also select the API 14.3/(AGA-3):1992 option or the API
14.3/(AGA-3):2012 option.

138
OMNICOM: DP Device

When the Flowmeter type is chosen as Orifice DP, and the DP Device Types are selected as Pipe
Taps, Corner Taps, D and D/2, ASME Flow Nozzle or Venturi, the OMNI uses the ASME MFC-3M
1989 standard for its calculations.

The V-Cone calculation is based on documentation Lit 24509-54 Rev. 3.0/10-02 by McCrometer,
Inc.

Note: The V-Cone DP device type selection was added with firmware version 23.75.10 and
27.75.03. For firmware versions 23.75.02 and 27.75.02 and lower, configure a V-Cone meter type in
the Flowmeter Setup Screen.

Pressure Transmitter is located Downstream

The static pressure of the flowing fluid can be obtained from either the upstream or downstream pres-
sure tap. Check the box if the pressure transmitter is located downstream. The default is to use the
upstream pressure tap.

Venturi Pressure Loss %

This setting is required if the user selects one of the Venturi plate taps for an orifice meter.

The equation to calculate flow through a Venturi tube assembly requires that the pressure drop
across the Venturi versus the pressure drop across a straight pipe section fitted in place of the Ven-
turi is known.

Firmware Versions 23 and 27


Temperature Probe is located Upstream

This entry should always be checked when the temperature of the fluid is measured upstream of the
orifice. At high differential pressures across the orifice, a significant cooling of the fluid can take place
as it decompresses. If temperature is measured downstream of the orifice, you may correct for this
effect by not checking the box. The default selection is the probe is located upstream.

As the orifice equations use the upstream temperature as the flowing temperature, the OMNI cal-
culates the temperature upstream of the orifice if the temperature probe is located downstream:

For firmware versions 23.75.02 and higher, an Upstream Temperature Correction method
selection is displayed.

For firmware versions 23.75.01 and lower, the isentropic correction method is used.

See the help under 'Flow Calculation' on this page for a description of 'Correcting Downstream
Temperature to Upstream Temperature'.

Flow Calculation

139
OMNICOM: DP Device

Flow Calculation
Select one of the following flow calculations:

ISO 5167:1991 (available with firmware version 27 only)


ISO 5167:1998 (available with firmware version 27 only)
ISO 5167:2003 (available with firmware versions 27.74.11 and higher)
API 14.3(AGA-3):1992 (available with firmware versions 23.75.02 and 27.75.06 and higher
when an orifice flange device type is selected)
API 14.3(AGA-3):2012 (available with firmware versions 23.75.02 and 27.75.06 and higher
when an orifice flange device type is selected) Note: The algorithm was implemented in 2010
and approved by the American Gas Association in September 2012.

Correcting Downstream Density to Upstream Density


When a densitometer is installed, it is customary to install this downstream of the orifice to avoid
upstream flow disturbances. As ISO 5167 requires density at the upstream face of the orifice, it is
necessary to correct density measured downstream of the orifice to the upstream location.

Isentropic - the flow computer software uses the ideal gas law and thermodynamic constant
(k3) to calculate the upstream corrected density (D1) using:

D1 = Dm x (P1 / P2) ^ k3
where:
D1 = Upstream density (at P1) (lb/ft3 or kg/m3)
Dm = Measured density from the densitometer (at P2) (lb/ft3 or kg/m3)
P1 = Upstream pressure (absolute)
P2 = Downstream pressure (absolute)
k3 = Thermodynamic constant

For firmware versions 23.75.02 and higher, this equation may be selected for any of the
API 14.3(AGA-3) flow calculations.
For firmware versions 27.75.06 and higher, this equation may be selected for any of the
ISO 5167 or API 14.3(AGA-3) flow calculations.
For firmware versions 27.75.05 and lower, ISO 5167:1991 and ISO 5167:1998 assume
that the flow through the orifice is isentropic and reversible. When either of these ISO
selections are made, the flow computer uses the isentropic equation to correct the dens-
ity.

Isenthalpic - The flow computer uses the following equation by Dr M Reader-Harris (TUV)

D1 = Dm x P1 x T3 x Z(P2,T3) / (P2 x T1 x Z(P1,T1))


where:
D1 = Upstream density (at P1,T1) (lb/ft3 or kg/m3)
Dm = Measured density (at P2,T3) from the densitometer (lb/ft3 or kg/m3)
P1 = Upstream pressure (absolute)
P2 = Pressure at the downstream tapping (absolute)
T1 = Upstream temperature (Kelvin)
T3 = Measured temperature at the downstream recovery point (Kelvin)

140
OMNICOM: DP Device

Z(P1,T1) = AGA-8 compressibility at P1, T1


Z(P2,T3) = AGA-8 compressibility at P2, T3

This calculation method requires two AGA-8 ‘Z’ calculations - one at conditions (P1,T1)
and another at (P2,T3).

For firmware versions 23.75.02 and higher, this equation may be selected for any of the
API 14.3(AGA-3) flow calculations.
For firmware versions 27.75.06 and higher, this equation may be selected for any of the
ISO 5167 or API 14.3(AGA-3) flow calculations.
For firmware versions 27.75.05 and lower, ISO 5167:2003 assumes that the flow
through the orifice is isenthalpic. When this ISO selection is made, the flow computer
uses the isenthalpic equation to correct the density.

Correcting Downstream Temperature to Upstream Temperature


When a temperature well is installed, it is customary to install this downstream of the orifice to avoid
upstream flow disturbances. As ISO 5167 and AGA equations require temperature at the upstream
face of the orifice, it is necessary to correct temperature measured downstream of the orifice to the
upstream location.

The following selections are available:

Isentropic Correction (available for all flow calculations with firmware versions 23.75.02
and 27.75.06 and higher and is the only selection available for ISO 5167:1991 and ISO
5167:1998 with firmware versions 23.75.01 and 27.75.05 and lower) - this method assumes
that the flow through the orifice is isentropic and reversible. The flow computer uses the ideal
gas law and isentropic exponent (k) to calculate the upstream corrected temperature (T1)
using:

T1 = T3 x (P1 / P2) ^ ( (k - 1) / k)

where
P2 = P1 - Ploss

Ploss = SQRT(1 - Beta ^ 4) – C x Beta ^ 2


------------------------------------------------- x DP
SQRT(1 - Beta ^ 4) + C x Beta ^ 2

where
C = discharge coefficient
Beta = Orifice Diameter / Pipe Diameter
k = specific heat ratio
T3 = Downstream temperature (Kelvin)
P1 = Upstream Pressure (Bar)
DP = Differential Pressure (Bar)

Simplified Joule-Thomson Isenthalpic Correction (available for all flow calculations with
firmware versions 23.75.02 and 27.75.06 and higher and only available for ISO 5167:2003

141
OMNICOM: DP Device

with firmware versions 27.74.11 through 27.75.05 ) It was late 2008 before ISO published ISO
9464:2008 (Guidelines for the use of ISO 5167:2003) which provided a ‘Simplified Joule-
Thomson Equation’ suitable for use with pipeline quality natural gas. It calculates the
upstream temperature as shown below:

T1 = T3 + Dt
Dt = u x w
u = 0.35 - 0.00142 x T3 + (0.231 - 0.00294 x T3 + 0.0000136 x T3 ^ 2) x (0.998 +
0.00041 x P1 - 0.0001115 x P1 ^ 2 + 0.0000003 x P1 ^ 3)
where:
Dt = Change in temperature (degC)
u = Joule-Thomson coefficient (K/bar) (typically around 0.4 to 0.5 K/bar)
P1 = Upstream pressure (barA) (range 1 to 200 barA)
w = Permanent pressure loss (bar) (equation given in ISO 5167:2003)
T1 = Upstream temperature (degC)
T3 = Downstream measured temperature of the gas (degC) (range 0 to
100 degC)

Joule-Thomson Isenthalpic Correction - (available for all flow calculations with firmware
versions 27.75.06 and higher and only available for ISO 5167:2003 with firmware versions
27.74.11 through 27.75.05 ) ISO 5167:2003 introduced the use of the Joule-Thomson coef-
ficient to calculate the upstream temperature when temperature is measured downstream of
the orifice.

Enter suitable positive override values for parameters 'Cmp’ and ‘dZ/dT’. These two
parameters are described in ISO 5167:2003. Note that parameter ‘  d  Z/dT’ is required
by ISO 5167:2003 to be at constant pressure. Note: These parameters are not required
for NIST14 products.

AGA-10 estimation of 'Cmp’ and ‘dZ/dT’ (requires the product selected for the meter to
have AGA-10 selected in the Fluid Products Setup screen)

Firmware versions older than 27.75.06 require entering negative override values
for parameters ‘ dZ/dT’ and ‘Cmp’ to cause the flow computer to estimate these
values using AGA-10.

Firmware versions 27.75.06 and higher provide a 'Joule-Thomson Isenthalpic


Correction using AGA-10' selection.

The value of dZ/dT calculated by AGA-10 is at constant density, not constant


pressure. This causes the correction for downstream temperature to upstream
temperature to be understated slightly. This method, while only an estimate, may
be preferable than manually entering the value or using the Simplified Joule-
Thompson Isenthalpic correction for gases that are not transmission quality nat-
ural gas.

142
OMNICOM: Pulse Type

Pulse Type
The "Flowmeter – Pulse Type" tabbed dialogs are for entering and selecting pulse signal flow trans-
mitter settings.

These dialogs are available in OMNICOM for gas applications if you select 'Pulse Type' as the flow-
meter type in the Meter Type tab of the Meter Run Configuration.

In firmware versions 20/24 and 22/26, the meter type is hard coded in the firmware to Pulse Type.
For firmware versions 20/24, if you are using a Coriolis Mass Pulse flowmeter that is outputting volu-
metric pulses instead of mass pulses, do not enable the "Select Mass Pulses" setting in the Meter
Setup Screen. If you are using a Coriolis Mass Pulse flowmeter that is outputting mass pulses,
enable the "Select Mass Pulses" setting. Firmware versions 22/26 do not support flowmeters that
output mass pulses.
Note: Refer to the K-Factor Pulses per Unit setting help for details on specifying the K-Factor in the
correct units.

In firmware versions 23/27, if you are using a Coriolis Mass Pulse flowmeter that is outputting volu-
metric pulses instead of mass pulses, select the Flowmeter Type as 'Pulse Type'. If you are using a
Coriolis Mass Pulse flowmeter that is outputting mass pulses, select the Flowmeter Type as 'Coriolis
Mass Pulse'.
Note: Refer to the K-Factor Pulses per Unit setting help file for details on specifying the K-Factor in
the correct units.

Settings
The items listed below are the links covering how to setup the K-factor Curve for the Pulse Signal
meter and Viscosity Linearization. Click on a link for more information.

K-Factor Curve
Viscosity Linearization (firmware versions 20 and 24)

143
OMNICOM: Coriolis Meter

Coriolis Meter
The 'Flowmeter – Coriolis Mass Pulse' tabbed dialogs are for entering and selecting pulse signal
flow transmitter settings. These dialogs are available in OMNICOM only if you select 'Coriolis Meter'
as the flowmeter type in the Meter Type tab of the Meter Run Configuration.

The 'Coriolis Mass Pulse' meter selection is available with firmware versions 23.74.19 and 27.74.18
and higher.

In 23/27 firmware versions, when selecting the meter type as 'Coriolis Mass Pulse', the OMNI
always assumes the pulses being output by the Coriolis meter are mass pulses and not volumetric
pulses.

If the Coriolis flowmeter is configured to output volumetric pulses instead of mass pulses, it should be
configured as a 'Pulse Type' Meter in the OMNI instead of a 'Coriolis Mass Pulse' meter.

Note: Remember that when specifying the K-Factor, to specify it in the appropriate units. It should
be representative of mass or volumetric units to correspond with the type of pulses being output by
the flowmeter. (See Help under K-Factor entry for more details)

Note: If communicating via a serial port to the Coriolis Mass Pulse flowmeter in order to retrieve vari-
able data such as density and temperature, use the OMNI's peer-to-peer feature to retrieve the data.
Refer to OMNI Technical Bulletin TB980401 on "Peer-to-Peer Basics" for additional details.

Settings
The item listed below is the links covering how to setup the K-Factor Curve for the Pulse Signal
meter. Click on the link for more information.

K-Factor Curve

144
OMNICOM: Equimeter Auto-Adjust Turbine Meter

Equimeter Auto-Adjust Turbine Meter


The "Flowmeter – Equimeter AAT" tabbed dialogs is for configuring the Equimeter AAT settings.
These dialogs are available in OMNICOM only if you select 'Equimeter AAT' as the flowmeter type in
the Meter Type tab of the Meter Run Configuration.

Settings
The items listed below are descriptions of each setting option within the Equimeter ATT dialog. Click
on a setting for more information.

Pulse Factors

Main Rotor - The Main Rotor (MR) factor value (Pulses/MCF or /m3) can be found on the
meter factor badge or on the factory calibration documents.

Sensing Rotor - The Sensing Rotor (SR) factor value (Pulses/MCF or /m3) can be found on
the meter factor badge or on the factory calibration documents.

Mechanical Output - The Mechanical Output (MO) factor value (Pulses/MCF or /m3) can be
found on the factory calibration curve for the meter. This value is determined mathematically
from the mechanical output of the meter, change gears, internal gearing, and blades on the
pulsar wheel.

Setup

A-Bar % - the Average Relative Adjustment (A) value (%) can be found on the meter factor
badge or on the factory calibration documents. The purpose of the Adjusted volume cal-
culation is to provide a measurement registration that is adjusted back to original factory cal-
ibration accuracy, compensating for meter changes or for abnormal flow conditions. These
field or operating Delta_A values can be compared with those at factory calibration.

BTSF - Blade Tip Sensor Factor (BTSF) for meter.

Alarm Band

The logic and algorithms in this section compare error conditions and Delta_A values to limits that
are fixed or operator selected:

Alarm Band High Limit (%) - Delta_A above normal limits.

Alarm Band Low Limit (%) - Delta_A values below normal limits.

Warning Band

145
OMNICOM: Equimeter Auto-Adjust Turbine Meter

The logic and algorithms in this section compare error conditions and Delta_A values to limits that
are fixed or operator selected:

Warning Band High Limit (%) - Delta_A values above operating limits.

Warning Band Low Limit (%) - Delta_A values below operating limits.

Adjust Selection

Auto Adjust Set (Set1) - The adjusted volume calculation is done every 500ms using pulses read
from the Main and Sensing rotors. In addition to the adjusted volume equation, algorithms are
included that provide corrections to the volume totalization for condition of Leakage flow, Resonant
No-Net flow, Severe flow pulsation or Non-Steady flow.

Set1 = 0: Enable the auto adjust volume calculation, self-checking, flags and alarms.

Set1 = 1: Enable the auto adjust volume calculation, self-checking, disable flags and disable
alarms.

Set1 = 2: Enable the auto adjust volume calculation, disable self-checking, disable flags and
disable alarms.

Set1 = 3: Disable the auto adjust volume calculation, self-checking, flags and alarms.

Un-Adjust Selection

Un-Adj Set (Set2) - This section shows how the "Mechanical" or Un-Adjusted volume is properly
calculated using the pulses from the Main rotor only. This volume is to be used in the measurement
totalization when pulses from the Sensing rotor are unavailable or when the gas flow rate is below
the minimum for the Adjusted output.

Set2 = 0: Enable the UN-Adjusted volume calculation.

Set2 = 1: Disable the UN-Adjusted volume calculation.

146
OMNICOM: Rosemount 3095FB DP Meter

Rosemount 3095FB DP Meter


The "Physical - Rosemount 3095FB DP" is for entering the specific Primary Element data for any Dif-
ferential Pressure Device. Additionally you can select the pressure tapping used and the meas-
urement standard to be applied within the Meter Run Setup. Once you enter the information and/or
make your selections, press the [Apply] button to set.

For more information see the DP Device help.

147
OMNICOM: Honeywell SMV3000 DP Meter

Honeywell SMV3000 DP Meter


The Physical - Honeywell SMV3000 DP Meter is for entering the specific Primary Element data for
any Differential Pressure Device. Additionally you can select the pressure tapping used and the
measurement standard to be applied within the Meter Run Setup. Once you enter the information
and/or make your selections, press the [Apply] button to set.

For more information see the DP Device help.

148
OMNICOM: Instromet Ultrasonic Meter

Instromet Ultrasonic Meter


The "Flowmeter – Instromet Ultrasonic" tabbed dialogs are for configuring Instromet Q-Sonic Ultra-
sonic Gas Flowmeter settings. These dialogs are available in OMNICOM only if you select 'Instromet
Ultrasonic' as the flowmeter type in the Meter Type tab of the >Meter Run Configuration.

Note: In order to communicate properly to the OMNI, the baud rate of the Instromet Meter should be
set to 4800 baud.

Note: Pulse Fidelity checking was added for Instromet Meters in firmware versions 23.74.20 and
27.74.20 and higher.

Settings
The following is a description of the fields:

SV Port

The OMNI Flow Computer can accept two SV combo modules. Two ports are available with each
module up to four ports. Only the ports configured for Instromet Ultrasonic on the SV Port Setup
screen are listed.

Primary Measurement Source

(available with firmware versions 23.74.20 and 27.74.20 and higher)

Serial or Pulse: This setting instructs the OMNI to use either the SV serial communications data or
the pulse input channel as the primary means of calculating flow.

Serial - Select Serial Data as primary flow. The SV serial communications data will be the
primary and the pulse input channel, if assigned, will be used as a backup means of flow cal-
culations by the flow computer. This is the default setting.

Pulse - Select the Pulse Input as primary flow. The flow pulses received from the flowmeter
will be the primary and the SV serial communications data will be used as a backup means of
flow calculations by the flow computer.

Flow Direction

Forward or Reverse: Q-Sonic flowmeters allow for bidirectional fluid flow measurement. Setup the
flow computer to totalize either forward (default) or reverse flow on any meter run with an ultrasonic
meter.

Alarm Limits

Maximum Flow Deviation:The actual user entered flow used by the flow computer to total-
ize depends upon several factors:

149
OMNICOM: Instromet Ultrasonic Meter

1. Firmware 23.74.20 and 27.74.20 and higher:


1. (1) If a pulse signal is the primary measurement source and is available,
the flow computer will use it for calculations as long as the calculated flow
rate is within this flow rate deviation percentage of the flow transmitted seri-
ally by the Q-Sonic.
2. (2) If a pulse signal is the primary measurement source and not available
or failed, the flow computer will use the corrected linear gas velocity trans-
mitted by the Q-Sonic and calculate flow based on the temperature com-
pensated area of the meter tube. The flow rate calculated by this method
must also be within this flow rate deviation percentage of the flow trans-
mitted serially by the Q-Sonic.
3. Summarizing, the flow computer first tries to use the pulse signal if it is the
primary measurement source, then the transmitted gas velocity value and
finally the transmitted flow rate.

2. Firmware 23.74.19 and 27.74.19 and lower:


1. (1) If a pulse signal is available, the flow computer will use it for calculations
as long as the calculated flow rate is within this flow rate deviation per-
centage of the flow transmitted serially by the Q-Sonic.
2. (2) If a pulse signal is not available or failed, the flow computer will use the
corrected linear gas velocity transmitted by the Q-Sonic and calculate flow
based on the temperature compensated area of the meter tube. The flow
rate calculated by this method must also be within this flow rate deviation
percentage of the flow transmitted serially by the Q-Sonic.
3. Summarizing, the flow computer first tries to use the pulse signal, then the
transmitted gas velocity value and finally the transmitted flow rate.

Minimum Automatic Gain Control (AGC) Ratio: The flow computer calculates the AGC
ratio for each ultrasonic path in both path directions. An alarm will occur if the AGC ratio of any
path drops below this ratio. Reasonable entries are 1.5 to 2.

Minimum Performance: or Minimum Percent Sample Ratio - this entry checks the ratio of
good received data pulses verses total transmitted pulses for each ultrasonic path in both dir-
ections. A ratio below this setting will cause an alarm. Reasonable entries are 50% to 70%.

Velocity of Sound (VOS) Deviation: In some configurations, the flow computer can verify
that the average VOS calculated for all paths agrees with the VOS of each individual path.
This entry is the maximum percent that any one path VOS varies from the average VOS of all
the paths.

AGA-10 VOS Deviation: (Available with firmware versions 23.74.11 and 27.74.11 and
higher. This entry is only enabled if AGA-10 is selected for the fluid product for the
meter. AGA-10 can be selected in the Fluid Setup screen.) The maximum percent that the
VOS (Velocity of Sound) of any individual path can vary from the AGA-10 calculated VOS of
all the paths.

Gas Velocity

150
OMNICOM: Instromet Ultrasonic Meter

Some gas movement can occur even when an ultrasonic meter is blocked-in. This is caused by con-
vection currents within the meter tube. Enter a minimum gas velocity, in feet per second (firmware
version 23) or meters per second (firmware version 27), below which you do not want to totalize.
Consult with Instromet to determine this value.

The item listed below is the links covering how to setup the K-Factor Curve for the Ultrasonic Instro-
met meter. Click on the link for more information.

K-Factor Curve

151
OMNICOM: FMC MPU 1200 Meter

FMC MPU 1200 Meter


The "Flowmeter – FMC 1200 MPU" tabbed dialog is for configuring the FMC Kongsberg MPU 1200
Ultrasonic Gas Flowmeter settings. These dialogs are available in OMNICOM only if you select
'FMC MPU 1200' as the flowmeter type in the Meter Type tab of the Meter Run Configuration.

Settings
The following is a description of the fields:

SV Port

The OMNI Flow Computer can accept two SV combo modules. Two ports are available with each
module up to four ports. Only the ports configured for FMC MPU 1200 on the SV Port Setup screen
is listed.

Primary Measurement Source

(available with firmware versions 23.75.02 and 27.75.06 and higher)

Serial or Pulse: This setting instructs the OMNI to use either the SV serial communications data or
the pulse input channel as the primary means of calculating flow.

Serial - Select Serial Data as primary flow. The SV serial communications data will be the
primary and the pulse input channel, if assigned, will be used as a backup means of flow cal-
culations by the flow computer. This is the default setting.

Pulse - Select the Pulse Input as primary flow. The flow pulses received from the flowmeter
will be the primary and the SV serial communications data will be used as a backup means of
flow calculations by the flow computer.

Flow Direction

Forward or Reverse: MPU 1200 flowmeters allow for bidirectional fluid flow measurement. For
pulse frequency signals, setup the flow computer to totalize either forward (default) or reverse flow
on any meter run with an ultrasonic meter.

Series

(available with firmware versions 23.74.30 and 27.74.20 and higher)

Series A or Series B: Select the series of MPU 1200 you are connecting to the OMNI. The MPU
1200 Series A flow meter should be set to a 64-bit database type whereas the Series B database is
fixed as a 32-bit database type.

Please see the MPU 1200 Technical Bulletin for details on the Series A and Series B MPU 1200.

152
OMNICOM: FMC MPU 1200 Meter

Alarm Limits

Maximum Gain: The flow computer monitors the maximum gain value for each ultrasonic
path in both directions. An alarm occurs if the gain of any path rises above this value.

Minimum Burst Percent: The ratio of valid ultrasonic pulses received versus total pulses
transmitted for each ultrasonic path in both directions. A ratio below this setting will cause an
alarm.

VOS Deviation: The maximum percent that the VOS (Velocity of Sound) of any individual
path can vary from the average VOS of all the paths. An alarm occurs if the percent of devi-
ation of one or more paths exceeds this value.

AGA-10 VOS Deviation: (Available with firmware versions 23.74.11 and 27.74.11 and
higher. This entry is only enabled if AGA-10 is selected for the fluid product for the
meter. AGA-10 can be selected in the Fluid Setup screen.) The maximum percent that the
VOS (Velocity of Sound) of any individual path can vary from the AGA-10 calculated VOS of
all the paths. An alarm occurs if the percent of deviation of one or more paths exceeds this
value.

Flow Deviation: The percent deviation between the calculated flow from the pulse input chan-
nel compared to the MPU 1200 flow data received via the OMNI SV serial port. The OMNI
raises the pulse suspect alarm if the flow deviation percentage exceeds this limit.

Maximum Down Time: Enter the maximum allowable MPU downtime in minutes. If the com-
munication downtime between the OMNI and the MPU is less than this value, the OMNI will
adjust its internal totalizers to match the most recent MPU 1200 totalizer value.

The item listed below is the link covering how to setup the K-Factor Curve for the Ultrasonic FMC
Kongsberg Meter. Click on the link for more information.

K-Factor Curve

153
OMNICOM: Daniel Ultrasonic Meter

Daniel Ultrasonic Meter


The "Flowmeter – Daniel Ultrasonic" tabbed dialogs are for configuring Daniel Instruments Senior
Sonic Ultrasonic Gas Flowmeter settings. These dialogs are available in OMNICOM only if you
select 'Daniel Ultrasonic' as the flowmeter type in the Meter Type tab of the Meter Run Con-
figuration.

Settings
Setup

SV Port: The OMNI Flow Computer can accept two SV combo modules. Two ports are avail-
able with each module up to four ports. Only the ports configured for the Daniel Ultrasonic
on the SV Port Setup screen are listed.

SV Modbus ID: This is the Modbus ID of the Daniel Ultrasonic flowmeter communications
port.

Retry Count: The number of SV serial port communications retries the OMNI will attempt
with the flowmeter after a communications failure before actually raising a communications fail
alarm.

Retry Timer: (Available only for firmware versions 23.74.11 and 27.74.18 and higher.) The
amount of time between SV serial port communications retries.

Primary Measurement Source

Serial or Pulse: This setting instructs the OMNI to use either the SV serial communications data or
the pulse input channel as the primary means of calculating flow.

Serial - Select Serial Data as primary flow. The SV serial communications data will be the
primary and the pulse input channel, if assigned, will be used as a backup means of flow cal-
culations by the flow computer. This is the default setting.

Pulse - Select the Pulse Input as primary flow. The flow pulses received from the flowmeter
will be the primary and the SV serial communications data will be used as a backup means of
flow calculations by the flow computer.

Flow Direction

Forward or Reverse: SeinorSonic flowmeters allow for bidirectional fluid flow measurement. For
pulse frequency signals, setup the flow computer to totalize either forward (default) or reverse flow
on any meter run with an ultrasonic meter.

Alarm Limits

154
OMNICOM: Daniel Ultrasonic Meter

VOS Deviation: The maximum percent that the VOS (Velocity of Sound) of any individual
path can vary from the average VOS of all the paths. An alarm occurs if the percent of devi-
ation of one or more paths exceeds this value.

AGA-10 VOS Deviation: (Available with firmware versions 23.74.11 and 27.74.11 and
higher. This entry is only enabled if AGA-10 is selected for the fluid product for the meter. The
AGA-10 selection is available in the Fluid Setup screen.) The maximum percent that the VOS
(Velocity of Sound) of any individual path can vary from the AGA-10 calculated VOS of all the
paths. An alarm occurs if the percent of deviation of one or more paths exceeds this value.

Flow Minutes: The time interval can be set for comparing the flow pulses input flow with the
SV communications serial link flow. If the flow deviation exceeds the Flow Deviation setting
(see next setting) when this comparison is made, the OMNI will switch from the primary (flow
pulses or SV serial link) to the backup source (SV serial link or flow pulses) for calculating
flow. (Note: Daniel recommends a minimum of 60 minutes for this setting due to the fluc-
tuating flow pulse frequency output by the flowmeter.)

Flow Deviation: Only valid if a flow pulse I/O point is assigned. The allowable percent devi-
ation between the calculated flow from the pulse input channel compared to the SeniorSonic
flow data received via the OMNI SV serial port. The OMNI raises the pulse suspect alarm if
the flow deviation percentage exceeds this limit. (Note: See the Flow Minutes setting pre-
vious.)

Maximum Down Time: Enter the maximum allowable flowmeter downtime in minutes. If
communication downtime between the OMNI and the SeniorSonic is greater than this value,
the OMNI will not adjust its internal totalizers to match the most recent SeniorSonic totalizer
value. Depending upon how much time the communication link and pulses were inoperative
and the amount of flow that occurred during this downtime, when communication is re-estab-
lished within the time specified in this setting, the OMNI may have to add a significant amount
of flow to its totalizers. (Default = 15 minutes)

The item listed below is the links covering how to setup the K-Factor Curve for the Daniel Ultrasonic
Meter. Click on the link for more information.

K-Factor Curve

155
OMNICOM: FLOWSIC 600 Ultrasonic

FLOWSIC 600 Ultrasonic


The FLOWSIC 600 meter connects to an OMNI serial port at 9600 baud, no parity, 8 bits with 1 stop
bit. The protocol is Modbus ASCII.

It is only available in OMNICOM only if you select 'FLOWSIC 600 Ultrasonic' as the flowmeter type in
the Meter Type tab of the Meter Run Configuration. The FLOWSIC 600 selection is available
with firmware versions 23.74.20 and 27.74.19 and up.

Note: OMNI firmware 23.74.20+ and 27.74.20+ and higher support the FLOWSIC 600 with v1.0 or
v2.0 (i.e. one serial port or two serial ports respectively on the FLOWSIC) whereas 27.74.19 only
supports v1.0 of the FLOWSIC hardware.

Settings
Setup

SV Port: The OMNI Flow Computer can accept two SV combo modules. Two ports are avail-
able with each module up to four ports. Only the ports configured for the FLOWSIC 600 Ultra-
sonic on the SV Port Setup screen is listed.

SV Modbus ID: This is the Modbus ID of the FLOWSIC 600 Ultrasonic flowmeter com-
munications port.

Retry Count: The number of SV serial port communications consecutive retries the OMNI
will attempt with the flowmeter (when the flowmeter does not respond) before the OMNI
raises a communications fail alarm.

Retry Timer: The number of seconds the OMNI should wait for a response from the flow-
meter before the OMNI attempts a communications retry. The flowmeter response times can
vary depending on the tasks being performed at the time the data is requested. If the specified
number of retries has been exhausted without a response from the flowmeter, the OMNI will
raise a communications failure alarm.

Primary Measurement Source

Serial or Pulse: This setting instructs the OMNI to use either the SV serial communications data or
the pulse input channel as the primary means of calculating flow.

Serial - Select Serial Data as primary flow. The SV serial communications data will be the
primary and the pulse input channel, if assigned, will be used as a backup means of flow cal-
culations by the flow computer. This is the default setting.

Pulse - Select the Pulse Input as primary flow. The flow pulses received from the flowmeter
will be the primary and the SV serial communications data will be used as a backup means of
flow calculations by the flow computer.

156
OMNICOM: FLOWSIC 600 Ultrasonic

Flow Direction

Flow Direction: FLOWSIC 600 flowmeters allow for bidirectional fluid flow measurement.

Forward or Reverse: For pulse frequency signals, setup the flow computer to totalize either
forward (default) or reverse flow on any meter run with an ultrasonic meter. Note: if you would
like the OMNI to measure flow in both directions, you should set up two meter runs in the
OMNI, one configured for forward flow and the other configured for reverse flow.

Digital Input No.: Configure the digital input number in the OMNI that determines the flow
direction from the FLOWSIC. This input signal is used for purposes of flow pulses totalizing
only and not for totalizing with respect to the serial port data. The OMNI will use this status sig-
nal if there is a fail over from the serial communications link to the pulses OR if the pulses are
specified as the primary means of measurement. We allow digital inputs 1-24. If the digital
input is high, that indicates forward flow. If the digital input is low, that indicates reverse flow. If
the signal indicates a direction that is different than what is configured for the setting, the
OMNI will not totalize flow for the respective meter run and will set flag 2n67 to indicate a flow
direction mismatch.

Measurement Status

Digital Input No.: For pulse frequency signals, configure a digital input that determines the meas-
urement status from the FLOWSIC. This input signal is used for purposes of flow pulses totalizing
only and not for totalizing with respect to the serial port data. The OMNI will use this status signal if
there is a fail over from the serial communications link to the pulses OR if the pulses are specified as
the primary means of measurement. We allow digital inputs #1-24 to be used. If the digital input is
low (0), the flowmeter is in "measurement mode" and the measurement status is OK. If the digital
input is high (1), the flow meter is in "configuration mode" and the measurement status indicates a
malfunction and the pulses are ignored by the OMNI.

Alarm Limits

VOS Deviation: In instances where the serial data is being used as the means of totalizing,
the flow computer can verify that the average VOS (Velocity of Sound) calculated for all the
paths conforms to the VOS of each individual path. This setting is the maximum percent that
the VOS of any individual path can vary from the average VOS of all the paths. An alarm
occurs if the percent of deviation of one or more paths exceeds this value.

AGA-10 VOS Deviation: Only valid if AGA-10 is enabled in the OMNI. (This entry is only
enabled if AGA-10 is selected for the fluid product for the meter. The AGA-10 selection is avail-
able in the Fluid Setup screen.) The maximum percent that the VOS (Velocity of Sound) of
any individual path can vary from the AGA-10 calculated VOS of all the paths. An alarm
occurs if the percent of deviation of one or more paths exceeds this value.

Flow Minutes: Only valid if a flow pulse I/O point is assigned. The time interval can be set for
comparing the flow pulses input flow with the SV communications serial link flow. If the flow
deviation exceeds the Flow Deviation setting (see next setting) when this comparison is

157
OMNICOM: FLOWSIC 600 Ultrasonic

made, the OMNI switches from the primary (flow pulses or SV serial link) to the backup source
(SV serial link or flow pulses) for calculating flow. (Default = 60 minutes Note: It is recom-
mended a minimum of 60 minutes be specified for this setting due to the fluctuating flow pulse
frequency).

Flow Deviation: Only valid if a flow pulse I/O point is assigned. The allowable percent devi-
ation between the calculated flow from the pulse input channel compared to the FLOWSIC
flow data received via the OMNI SV serial port. The OMNI raises the pulse suspect alarm if
the flow deviation percentage exceeds this limit and switches to the SV serial port as the
primary means of totalizing. (Note: See the Flow Minutes setting previous.)

Maximum Down Time: Enter the maximum allowable flowmeter downtime in minutes. If
communication downtime between the OMNI and the FLOWSIC is greater than this value,
the OMNI will not adjust its internal totalizers to match the most recent FLOWSIC totalizer
value when serial communications are re-established. Depending upon how much time the
communication link and pulses were inoperative and the amount of flow that occurred during
this downtime, when communication is re-established within the time specified in this setting,
the OMNI may have to add a significant amount of flow to its totalizers. (Default = 15 minutes)

Temperature and Pressure Options

(available with firmware versions 23.74.30 and 27.74.30 and higher)

The FLOWSIC UFM has the option to connect to temperature and pressure transmitters using a
Hart interface. The OMNI provides a method to configure whether to use the transmitters at the
OMNI or at the UFM. The following are the options:
0 = OMNI writes the temperature and pressure to the UFM
1 = OMNI reads the temperature and pressure from the UFM.
2 = OMNI reads the temperature from the UFM and writes the pressure to the UFM.
3 = OMNI writes the temperature to the UFM and reads the pressure from the UFM.

The item listed below is the link covering how to setup the K-Factor Curve for the flowmeter. Click
on the link for more information.

K-Factor Curve

158
OMNICOM: V-Cone Meter

V-Cone Meter
The "Physical Meter Run - DP Device" is for entering the specific Primary Element data. Once you
enter the information and/or make your selections, press the [Apply] button to set.

For more information see the DP Device help.

The V-Cone calculation is based on documentation Lit 24509-54 Rev. 3.0/10-02 by McCrometer,
Inc.

Note that for firmware versions 27.75.03 and higher, V-Cone is no longer offered in the Flowmeter
Setup Screen. Instead, select a DP Device meter type and then select V-Cone via the DP Device
Types selection in the Physical Meter Setup screen.

159
OMNICOM: Physical Meter Run

Physical Meter Run

Topics
The items listed below are the flowmeter types that have a corresponding physical meter run tree
entry. Click on a link to go to that topic.

DP Device
Instromet Ultrasonic
V-Cone

160
OMNICOM: Instromet Ultrasonic Meter - Physical Meter Run

Instromet Ultrasonic Meter - Physical Meter Run


The "Physical Meter Run - Instromet Ultrasonic" tabbed dialog is for entering the specific Primary
Element data.

Flow Tube Inside Diameter

Enter the diameter of the ultrasonic flowmeter tube. This diameter is then corrected for expansion
due to temperature, and used together with the 'corrected gas velocity' through the meter to cal-
culate flow rate.

Enter the diameter in inches (firmware 23) or mm (firmware 27)

Flow Tube Reference Temperature

Enter the temperature that the ultrasonic meter tube was measured at.

This should be entered as degF (firmware 23) or degC (firmware 27).

Flow Tube Expansion Coefficient

The ultrasonic meter tube will expand and contract with temperature. The flow computer requires
the linear expansion coefficient of thermal expansion for the meter tube material in order to correct
the tube meter tube area.

Applications 23

Plate Type Temperature Range (degF) Coefficient


Mild steel plate -100 to 300 6.20 x E-6
304/316 Stainless steel -100 to 300 9.25 x E-6
Monel -7 to 154 7.95 x E-6

Applications 27

Plate Type Temperature Range (degC) Coefficient


Mild steel plate -73.3 to 148.9 1.116 x E-5
304/316 Stainless steel -73.3 to 148.9 1.665 x E-5
Monel -21.6 to 67.8 1.431 x E-5

161
OMNICOM: V-Cone Flow Coefficients

V-Cone Flow Coefficients


Reynolds Number

The V-Cone meter may have been supplied with a calibration chart which correlates Reynolds Num-
ber versus Flowmeter Flow Coefficient Cf.

Enter up to 20 values of Reynolds Number as supplied. If a calibration chart was not supplied, enter
the single Reynolds Number value supplied into the first entry field and ensure that all remaining
Reynolds Number fields (2-20) are zero.

Flow Coefficient

The V-Cone meter may have been supplied with a calibration chart which correlates Reynolds Num-
ber versus Flowmeter Flow Coefficient Cf.

Enter up to 20 values of Flow Coefficient Cf as supplied. If a calibration chart was not supplied, enter
the single Flow Coefficient value supplied into the first entry field and ensure that all remaining Flow
Coefficient Cf fields (2-20) are zero.

162
OMNICOM: Meter Run Setup

Meter Run Setup


The Meter Run Setup dialogs are for entering and selecting core meter run application settings. You
must enter these settings first before you can proceed with the setup of the meter run. Based upon
your selections, OMNICOM makes available only those options that apply to your meter run con-
figuration. Select from the list below for you application.

Meter Setup (Firmware Versions 20 and 24)


Meter Setup (Firmware Versions 21)
Meter Setup (Firmware Versions 22 and 26)
Meter Setup (Firmware Versions 23 and 27)

Click on the link below for more information on the DP Setup tab:

DP Setup (Orifice Applications)

163
OMNICOM: Meter Run Setup (Firmware Versions 20 and 24)

Meter Run Setup (Firmware Versions 20 and 24)


The Meter Run Setup dialogs are for entering and selecting core meter run application settings. You
must enter these settings first before you can proceed with the setup of the meter run. Based upon
your selections, OMNICOM makes available only those options that apply to your meter run con-
figuration. Once you enter the information and/or make your selections, press the [Apply] button to
set.

Settings
The items listed below are the settings covering each dialog within the Flowmeter subcategory of
Meter Run setup. Click on the setting for more information.

Flow I/O Point

Select the physical input channel used to input the flow pulses from the turbine or PD meter
for this meter run.

Flow pulses can only be connected to the 3rd channel of A, B, C, and E combo modules, and
the 4th channel of A, C and E combo modules.

Tag

Informational display only - the 8 character ASCII character string which identifies each trans-
ducer. The tag appears in the LCD display before the value of the variable. See the Process
Inputs section for configuration of the tag field.

Note: This field is not useable if a '99' has been assigned as I/O.

Alarms

Enable Alarms When Meter Inactive: Check the box if you require the alarms for the meter
to be triggered even when the meter is not active.

Active Frequency: Flowmeter pulse frequencies equal to or above this threshold will set the
'meter (n) active' flag bit (Modbus point 1n05).By using any boolean statement you can use
this flag bit to enable and disable totalizing by controlling the 'disable meter run' flags (1736,
1737, 1738 & 1739):

1030: 1736 = /1105 Turn off Meter 1 flow if not greater than the active frequency.

Note: When the meter is inactive, the batch status is in a "Batch Suspended" state however
the flow computer continues to totalize unless the totalizers have been disabled as described
above.

Note: When active frequency is set to zero, the meter active flag will always be set to one.

164
OMNICOM: Meter Run Setup (Firmware Versions 20 and 24)

Pulse Fidelity

Enable Checking - Check the box if you want the OMNI to perform API chapter 5, section 5
'Level A' pulse fidelity and security checking on this meter run. This can only be achieved with
a flowmeter device which is fitted with two pick-offs which produce pulse trains signals which
are not coincident. The pulse trains must be connected to channels 3 and 4 of an 'E Type
Combo Module'. The OMNI will continuously compare both pulse trains and alarm any dif-
ferences of phase or frequency between the pulse trains. Totalizing will be unaffected by a fail-
ure of either pulse train and simultaneous transients and noise pulses will be rejected with an
85% certainty.

Error Check Threshold - To eliminate spurious alarms and error count accumulations, the
dual pulse error checking functions will be disabled until either pulse train exceed this many
pulses per second.

For example: Entering 50 for this threshold means that the dual pulse error checking will be
enabled when either the A or the B channel of the flowmeter pick-offs are providing more than
50 pulses per second.

Note: If the input of both the A and the B channels fall below the error check threshold, the
comparitor alarm is cleared.

Max Error Counts Per Batch - Enter the maximum number of error pulses allowed in one
transaction.
The pulse comparator error checking alarms are activated once this count threshold is
exceeded.

Max Good Pulses - (available with 20.74.30 and 24.74.30) - The Dual Error Alarm will be
reset following the receipt of this number of good pulses. The upper limit for this field is
999,999,999.

Note: Entering a zero in this field will disable the max good pulse functionality including clear-
ing of the comparator alarm, good pulse count, and error pulse count. They will be cleared,
however, at batch end regardless of this setting.

The alarm points are:

Description Modbus Point


Comparator Error Detected 1n48
A Channel Failed 1n49
B Channel Failed 1n50
A and B Channels not equal 1n51

Note: Substitute meter run number for 'n' in point number.

Batch

165
OMNICOM: Meter Run Setup (Firmware Versions 20 and 24)

Batch Preset Warning - Enter the volume at which the OMNI provides a Batch Preset Warning
status. Note: specify Tons for Anhydrous Ammonia measurement (v20.74.22+).

The batch preset counters are activated whenever a non zero number is entered for batch
size on the batch sequence stack (see discussion of batching features in the Operators
Manual chapter 4).

The 'Batch Preset Reached' flag (Modbus point 1n10) will be activated whenever the batch
preset counter counts down to zero.

The 'Batch Warning' flag (Modbus point 1n11) will be activated when the batch preset counter
is less than this entry.

Volume

Select Mass Pulses: Check the box if the flowmeter you are using for this run produces
pulses based on mass. i.e. pulses per mass unit. A Coriolis mass meter usually provides this
type of output signal.

Use Meter Factor in Net and Mass Calculations: Check the box to apply the meter factor
in the net and mass flow equations. If the box is not checked, the meter factor is ignored in the
equations but still appears on the reports.

Meter Temperature Compensated: In some cases the flowmeter may be fitted with a mech-
anical or electrical temperature compensator. If the box is checked, the OMNI sets the tem-
perature correction factor (VCF) to 1.0000 in all equations. Do not check the box if the meter
provides gross uncompensated pulses.

BS&W: Select which Auxiliary Input is to be used to input BS&W % for this meter run. The
flow computer will use this input to determine net standard volume (BS&W corrected volume).
Select 'NONE' if no correction is required.

Prove

Auto Prove Enable: Enabling ‘auto prove’ causes the flowmeter to be automatically proved
on flow rate changes, after a meter has been out of service, and if a specified amount of flow
has occurred since the last prove sequence for that meter. The ‘Auto Prove Enable’ is auto-
matically cancelled if a meter fails an automatic prove on 10 consecutive attempts or if the
Meter Factor is not implemented after two complete consecutive prove sequences. (See the
prover help for Auto Prove Setup.)(Note: Auto prove is not available for master meter type
provers.)

Use Upstream Prover Volume: (enabled only for Pulse Interpolation Unidirectional
Pipe/Compact prover types) Certain models of compact provers such as the Emerson/Brooks
prover have different water draw volumes depending on whether the flowmeter is upstream
or downstream of the prover. The design of the compact prover results in an upstream prover
volume and a downstream prover volume. Check the box to select the upstream volume as
the volume to be used during a prove. Leave the entry blank to select the downstream volume

166
OMNICOM: Meter Run Setup (Firmware Versions 20 and 24)

as the volume to be used during a prove.Note: This entry has no meaning when you are using
a normal full sized prover with one water draw volume

Meter Information

Enter meter identification information in the corresponding fields indicated below. These entries usu-
ally appear on the Prove Report and are all 8 character alphanumeric strings.

Meter ID: A string which identifies the flowmeter. Usually appears on reports (Modbus
register 4n14 where n is the meter run number).

Model: Enter the brand name or model of the meter.

Size: Enter the size of the meter.

S/N: Enter the serial number of the meter. 

Flow

Note: specify Tons/Hr for Anhydrous Ammonia measurement. Mass FS is not used with Anhydrous
Ammonia (v20.74.22+).

Gross Full Scale: Two 16-bit integer variables representing meter run gross and net flow
rate are included in the data base at 3n42 and 3n40 where n is the meter run number. These
variables are scaled using this entry and stored as percentages of full scale with a resolution of
0.1% (ie: 0 to 1000 = 0% to 100.0%).

Mass Full Scale: A 16-bit integer variable representing meter run mass flow rate is included
in the data base at 3n44 where n is the meter run number. This variable is scaled using this
entry and stored as a percentage of full scale with a resolution of 0.1% (ie: 0 to 1000 = 0% to
100.0%).

Flow Low Limit: The Low alarm (Modbus point 1n21) will activate when meter run (n) flow
rate drops below this value. The Low Low alarm (Modbus point 1n20) activates when the flow
rate drops 5% below this value.Note: If mass pulses is selected, the limits should be entered in
mass units.

Flow High Limit: The High alarm (Modbus point 1n22) will activate when meter run (n) flow
rate exceeds this value. The High High alarm (Modbus point 1n23) activates when the flow
rate rises 5% above this value.Note: If mass pulses is selected, the limits should be entered in
mass units.

NIST14/Water

Use Live Density: (Available with firmware versions 24.74.17 and higher) Check the box if
you would like to use the live density for the NIST14 or water calculations. This setting only
applies if the product running at the meter had the NIST14 or water measurement algorithm
selected and a densitometer was configured for the meter.

167
OMNICOM: Meter Run Setup (Firmware Versions 20 and 24)

Disable NIST14 Flowing Density Calculation: (Available with firmware versions 24.74.18
and higher.) Checking the box will speed up the NIST14 calculations because if you are using
a live densitometer there is no need to calculate the flowing density in the OMNI. This setting
only applies if the product running at the meter has the NIST14 measurement algorithm selec-
ted and a densitometer is configured for the meter. This checkbox is only available if the "Use
Live Density" box is checked.

168
OMNICOM: Meter Run Setup (Firmware Version 21)

Meter Run Setup (Firmware Version 21)


The Meter Run Setup dialogs are for entering and selecting core meter run application settings. You
must enter these settings first before you can proceed with the setup of the meter run. Based upon
your selections, OMNICOM makes available only those options that apply to your meter run con-
figuration. Once you enter the information and/or make your selections, press the [Apply] button to
set.

Settings
The items listed below are the settings covering each dialog within the Flowmeter subcategory of
Meter Run setup. Click on the setting for more information.

DP I/O Point

Enter the I/O point used to input the signal from the differential pressure signal for this meter
run.

In the case of stacked DP installations, enter the I/O point to be used for the low range cell.

When the device type is a Honeywell SMV-3000 transmitter, entering an I/O point in this field
will cause the OMNI to automatically assign I/O points for the meter run temperature and pres-
sure variables. The assigned I/O points cannot be changed by the user.

Duplicate I/O assignments can be made when a transducer is shared between meter runs (for-
ward and reverse flow for example).

DP High Range I/O Point

Enter the I/O point used to input the signal from the high range differential pressure signal for
this meter run.

Select 'Unassigned' if stacked DP transmitters are not used.

Duplicate I/O assignments can be made when a transducer is shared between meter runs (for-
ward and reverse flow for example).

Tag

Informational display only - the 8 character ASCII character string which identifies each trans-
ducer. The tag appears in the LCD display before the value of the variable. See the Process
Inputs section for configuration of the tag field.

Note: This field is not used if a '99' has been assigned as I/O.

Alarms

169
OMNICOM: Meter Run Setup (Firmware Version 21)

Enable Alarms When Meter Inactive: Check the box if you require the alarms for the meter
to be triggered even when the meter is not active.

Low Flow Cutoff

Differential pressure signals lower than this value will not be totalized.

Constants

Viscosity - Enter the viscosity of the measured fluid in centipoise units at flowing temperature
and pressure. You may enter any minus number to instruct the flow computer to attempt to cal-
culate the flowing viscosity using the appropriate equation of state.

Isentropic Exponent - Enter the isentropic exponent of the fluid at flowing temperature and
pressure. The number is a ratio and has no units of measure. Enter zero to set the AGA 3-92
Y factor to 1.0.Enter any minus number to instruct the flow computer to attempt to calculate
the value using the appropriate equation of state.

Batch

Batch Preset Warning - Enter the volume at which the OMNI provides a Batch Preset Warning
status.

The batch preset counters are activated whenever a non zero number is entered for batch
size on the batch sequence stack (see discussion of batching features in the Operators
Manual chapter 4).

The 'Batch Preset Reached' flag (Modbus point 1n10) will be activated whenever the batch
preset counter counts down to zero.

The 'Batch Warning' flag (Modbus point 1n11) will be activated when the batch preset counter
is less than this entry.

Volume

%S&W as Aux 'n': Select which Auxiliary Input is to be used to input %S&W for this meter
run. The flow computer will use this input to determine net standard volume (%S&W corrected
volume). Select 'NONE' if no correction is required.

Meter Information

Meter ID: An 8 character alphanumeric string which identifies the flowmeter. Usually appears
on reports (Modbus registers 4n14 where n is the meter run number).

Meter Factor: The meter factor is a multiplier close to 1.0000 included to correct for small
changes in flow meter characteristics. Net and mass flows are dependent on this number.
Meter factors are determined by proving the flowmeter against some known standard volume
or standard rate.

170
OMNICOM: Meter Run Setup (Firmware Version 21)

Flow

Gross Full Scale: Two 16-bit integer variables representing meter run gross and net flow
rate are included in the data base at 3n42 and 3n40 where n is the meter run number. These
variables are scaled using this entry and stored as percentages of full scale with a resolution of
0.1% (ie: 0 to 1000 = 0% to 100.0%).

Mass Full Scale: A 16-bit integer variable representing meter run mass flow rate is included
in the data base at 3n44 where n is the meter run number. This variable is scaled using this
entry and stored as a percentage of full scale with a resolution of 0.1% (ie: 0 to 1000 = 0% to
100.0%).

Flow Low Limit: The Low alarm (Modbus point 1n21) will activate when meter run (n) flow
rate drops below this value. The Low Low alarm (Modbus point 1n20) activates when the flow
rate drops 5% below this value.

Flow High Limit: The High alarm (Modbus point 1n22) will activate when meter run (n) flow
rate exceeds this value. The High High alarm (Modbus point 1n23) activates when the flow
rate rises 5% above this value.

Click on the link below for more information on the DP Setup tab:

DP Setup

171
OMNICOM: Meter Run Setup (Firmware Versions 22 and 26)

Meter Run Setup (Firmware Versions 22 and 26)


The Meter Run Setup dialogs are for entering and selecting core meter run application settings. You
must enter these settings first before you can proceed with the setup of the meter run. Based upon
your selections, OMNICOM makes available only those options that apply to your meter run con-
figuration. Once you enter the information and/or make your selections, press the [Apply] button to
set.

Settings
The items listed below are the settings covering each dialog within the Flowmeter subcategory of
Meter Run setup. Click on the setting for more information.

Flow I/O Point

Select the physical input channel used to input the flow pulses from the turbine or PD meter
for this meter run.

Flow pulses can only be connected to the 3rd channel of A, B, C, and E combo modules, and
the 4th channel of A, C and E combo modules.

Tag

Informational display only - the 8 character ASCII character string which identifies each trans-
ducer. The tag appears in the LCD display before the value of the variable. See the Process
Inputs section for configuration of the tag field.

Note: This field is not useable if a '99' has been assigned as I/O.

Alarms

Active Frequency: Flowmeter pulse frequencies equal to or above this threshold will set the
'meter (n) active' flag bit (Modbus point 1n05).By using any boolean statement you can use
this flag bit to enable and disable totalizing by controlling the 'disable meter run' flags (1736,
1737, 1738 & 1739):

1030: 1736 = /1105 Turn off Meter 1 flow if not greater than the active frequency.

Note: When the meter is inactive, the batch status is in a "Batch Suspended" state however
the flow computer continues to totalize unless the totalizers have been disabled as described
above.

Note: When active frequency is set to zero, the meter active flag will always be set to one.

Pulse Fidelity

172
OMNICOM: Meter Run Setup (Firmware Versions 22 and 26)

Enable Checking - Check the box if you want the OMNI to perform API chapter 5, section 5
'Level A' pulse fidelity and security checking on this meter run. This can only be achieved with
a flowmeter device which is fitted with two pick-offs which produce pulse trains signals which
are not coincident. The pulse trains must be connected to channels 3 and 4 of an 'E Type
Combo Module'. The OMNI will continuously compare both pulse trains and alarm any dif-
ferences of phase or frequency between the pulse trains. Totalizing will be unaffected by a fail-
ure of either pulse train and simultaneous transients and noise pulses will be rejected with an
85% certainty.

Error Check Threshold - To eliminate spurious alarms and error count accumulations, the
dual pulse error checking functions will be disabled until either pulse train exceed this many
pulses per second.

For example: Entering 50 for this threshold means that the dual pulse error checking will be enabled
when either the A or the B channel of the flowmeter pick-offs are providing more than 50 pulses per
second.

Note: If the input of both the A and the B channels fall below the error check threshold, the
comparitor alarm is cleared.

Max Error Counts Per Batch - Enter the maximum number of error pulses allowed in one
transaction.

The pulse comparator error checking alarms are activated once this count threshold is exceeded.

Max Good Pulses - (available with 22.74.30 and 26.74.10) - The Dual Error Alarm will be
reset following the receipt of this number of good pulses. The upper limit for this field is
999,999,999.

Note: Entering a zero in this field will disable the max good pulse functionality including clear-
ing of the comparator alarm, good pulse count, and error pulse count. They will be cleared,
however, at batch end regardless of this setting.

The alarm points are:

Description Modbus Point


Comparator Error Detected 1n48
A Channel Failed 1n49
B Channel Failed 1n50
A and B Channels not equal 1n51

Note: Substitute meter run number for 'n' in point number.

Batch

Batch Preset Warning - Enter the volume at which the OMNI provides a Batch Preset Warning
status.

173
OMNICOM: Meter Run Setup (Firmware Versions 22 and 26)

The batch preset counters are activated whenever a non zero number is entered for batch
size on the batch sequence stack (see discussion of batching features in the Operators
Manual chapter 4).

The 'Batch Preset Reached' flag (Modbus point 1n10) will be activated whenever the batch
preset counter counts down to zero.

The 'Batch Warning' flag (Modbus point 1n11) will be activated when the batch preset counter
is less than this entry.

Volume

Use Meter Factor in Net and Mass Calculations: Check the box to apply the meter factor
in the net and mass flow equations. If the box is not checked, the meter factor is ignored in the
equations but still appears on the reports.

Meter Temperature Compensated: In some cases the flowmeter may be fitted with a mech-
anical or electrical temperature compensator. If the box is checked, the OMNI sets the tem-
perature correction factor (VCF) to 1.0000 in all equations. Do not check the box if the meter
provides gross uncompensated pulses.

BS&W: Select which Auxiliary Input is to be used to input BS&W % for this meter run. The
flow computer will use this input to determine net standard volume (BS&W corrected volume).
Select 'NONE' if no correction is required.

Prove

Auto Prove Enable: Enabling ‘auto prove’ causes the flowmeter to be automatically proved
on flow rate changes, after a meter has been out of service, and if a specified amount of flow
has occurred since the last prove sequence for that meter. The ‘Auto Prove Enable’ is auto-
matically cancelled if a meter fails an automatic prove on 10 consecutive attempts or if the
Meter Factor is not implemented after two complete consecutive prove sequences. (See the
prover help for Auto Prove Setup.)(Note: Auto prove is not available for master meter type
provers.)

Use Upstream Prover Volume: (enabled only for Pulse Interpolation Unidirectional
Pipe/Compact prover types) Certain models of compact provers such as the Emerson/Brooks
prover have different water draw volumes depending on whether the flowmeter is upstream
or downstream of the prover. The design of the compact prover results in an upstream prover
volume and a downstream prover volume. Check the box to select the upstream volume as
the volume to be used during a prove. Leave the entry blank to select the downstream volume
as the volume to be used during a prove.Note: This entry has no meaning when you are using
a normal full sized prover with one water draw volume.

Base Flow Rate: The flow computer lifts or lowers the meter factor curve based on the meter
factor obtained at the latest official flowmeter proving. The meter factors are normalized to the
prove base flow rate for validation/comparison and historical archival purposes.

174
OMNICOM: Meter Run Setup (Firmware Versions 22 and 26)

Meter Manufacturer: The manufacturer of the prover meter. You may use up to 8 alpha-
numerical characters.

Meter Information

Enter meter identification information in the corresponding fields indicated below. These entries usu-
ally appear on the Prove Report and are all 8 character alphanumeric strings.

Meter ID: A string which identifies the flowmeter. Usually appears on reports (Modbus
register 4n14 where n is the meter run number).

Model: Enter the brand name or model of the meter.

Size: Enter the size of the meter.

S/N: Enter the serial number of the meter.

Flow

Gross Full Scale: Two 16-bit integer variables representing meter run gross and net flow
rate are included in the data base at 3n42 and 3n40 where n is the meter run number. These
variables are scaled using this entry and stored as percentages of full scale with a resolution of
0.1% (ie: 0 to 1000 = 0% to 100.0%).

Mass Full Scale: A 16-bit integer variable representing meter run mass flow rate is included
in the data base at 3n44 where n is the meter run number. This variable is scaled using this
entry and stored as a percentage of full scale with a resolution of 0.1% (ie: 0 to 1000 = 0% to
100.0%).

Flow Low Limit: The Low alarm (Modbus point 1n21) will activate when meter run (n) flow
rate drops below this value. The Low Low alarm (Modbus point 1n20) activates when the flow
rate drops 5% below this value.

Flow High Limit: The High alarm (Modbus point 1n22) will activate when meter run (n) flow
rate exceeds this value. The High High alarm (Modbus point 1n23) activates when the flow
rate rises 5% above this value.

175
OMNICOM: Meter Run Setup (Firmware Versions 23 and 27)

Meter Run Setup (Firmware Versions 23 and 27)


The Meter Run Setup dialogs are for entering and selecting core meter run application settings. You
must enter these settings first before you can proceed with the setup of the meter run. Based upon
your selections, OMNICOM makes available only those options that apply to your meter run con-
figuration. Once you enter the information and/or make your selections, press the [Apply] button to
set.

Settings
The items listed below are the settings covering each dialog within the Flowmeter subcategory of
Meter Run setup. Click on the setting for more information.

Pulse Type Flow Meters


Flow I/O Point

Select the physical input channel used to input the flow pulses from the turbine or PD meter
for this meter run.

Flow pulses can only be connected to the 3rd channel of A, B, C, and E combo modules, and
the 4th channel of A, C and E combo modules.

When communicating with an Instromet Q-Sonic via an SV Combo module, this entry may be
left blank. If an I/O point is assigned for the pulse signal from the Q-Sonic, the flow computer
uses this pulse signal as the primary flow signal and only uses the SV data as backup.

Low Flow Cutoff

The low flow cutoff value can be based on the following:

Frequency: Flowmeter pulse frequencies equal to or above the Active Frequency threshold
will set the 'meter (n) active' flag bit (Modbus point 1n05). By using any boolean statement you
can use this flag bit to enable and disable totalizing by controlling the 'disable meter run' flags
(1736, 1737, 1738 & 1739):

1030: 1736 = /1105 Turn off Meter 1 flow if not greater than the active frequency.

Note: When the meter is inactive, the batch status is in a "Batch Suspended" state however
the flow computer continues to totalize unless the totalizers have been disabled as described
above.

Note: When active frequency is set to zero, the meter active flag will always be set to one.

Net Flow Rate - (available with 23.75.02 and 27.75.06 and higher) Net flow rates lower than
the Low Flow Cutoff value will not be totalized.

176
OMNICOM: Meter Run Setup (Firmware Versions 23 and 27)

Mass Flow Rate - (available with 23.75.02 and 27.75.06 and higher) Mass flow rates lower
than the Low Flow Cutoff value will not be totalized.

Pulse Fidelity

Enable Checking - Check the box if you want the OMNI to perform API chapter 5, section 5
'Level A' pulse fidelity and security checking on this meter run. This can only be achieved with
a flowmeter device which is fitted with two pick-offs which produce pulse trains signals which
are not coincident. The pulse trains must be connected to channels 3 and 4 of an 'E Type
Combo Module'. The OMNI will continuously compare both pulse trains and alarm any dif-
ferences of phase or frequency between the pulse trains. Totalizing will be unaffected by a fail-
ure of either pulse train and simultaneous transients and noise pulses will be rejected with an
85% certainty.

Error Check Threshold - To eliminate spurious alarms and error count accumulations, the
dual pulse error checking functions will be disabled until either pulse train exceed this many
pulses per second.

For example: Entering 50 for this threshold means that the dual pulse error checking will be
enabled when either the A or the B channel of the flowmeter pick-offs are providing more than
50 pulses per second.

Note: If the input of both the A and the B channels fall below the error check threshold, the
comparitor alarm is cleared.

Max Error Counts Per Batch - Enter the maximum number of error pulses allowed in one
transaction.
The pulse comparator error checking alarms are activated once this count threshold is
exceeded.

Max Good Pulses - (available with 23.74.30 and all versions of 27) - The Dual Error Alarm
will be reset following the receipt of this number of good pulses. The upper limit for this field is
999,999,999.

Note: Entering a zero in this field will disable the max good pulse functionality including clear-
ing of the comparator alarm, good pulse count, and error pulse count. They will be cleared,
however, at batch end regardless of this setting.

The alarm points are:

Description Modbus Point


Comparator Error Detected 1n48
A Channel Failed 1n49
B Channel Failed 1n50
A and B Channels not equal 1n51

Note: Substitute meter run number for 'n' in point number.

177
OMNICOM: Meter Run Setup (Firmware Versions 23 and 27)

DP Devices
DP Low I/O Point

Enter the I/O point used to input the signal from the low range differential pressure signal for
this meter run.

Duplicate I/O assignments can be made when a transducer is shared between meter runs (for-
ward and reverse flow for example).

For firmware versions 23.75.01 and 27.75.04 and higher:


If stacked DP transmitters are used and the high I/O point needs to be changed, first
unassign the low and the mid points before changing the high point. Then re-assign the
low and mid points.
Enter 'Unassigned' if stacked DP transmitters are not used.

For firmware versions 23.75.00 and 27.75.03 and lower, if stacked DP transmitters are used
and the low I/O point needs to be changed, first unassign the mid and the high points before
changing the low point. Then re-assign the mid and the high points.

For firmware versions 23.75.01 and 27.75.02 and higher, enter the Rosemount or Honeywell
multivariable transmitter DP I/O point in the DP High Range field. Analog DP only can be
entered in the DP low range for Rosemount or Honeywell multivariable meters.

For firmware versions 23.75.00 and 27.75.01 and lower, when the device type is a Honeywell
SMV-3000 transmitter or a Rosemount 3095 FB transmitter, entering an I/O point in this field
will cause the OMNI to automatically assign I/O points for the meter run temperature and pres-
sure variables. The auto-assigned I/O points cannot be changed by the user.

Note: For firmware versions 23.75.01 and 27.75.04 and higher, the DP high I/O point's alarm
limits and override are used for the meter. If the high point is unassigned or invalid, and there
is a valid low point, the DP low I/O point's alarms and override are used. If the high and low
point are unassigned or invalid but there is a valid mid point, the DP mid I/O point's alarms and
override are used.

DP Mid Range

Enter the I/O point used to input the signal from the mid range differential pressure signal for
this meter run.

Enter 'Unassigned' if stacked DP transmitters are not used.

Duplicate I/O assignments can be made when a transducer is shared between meter runs (for-
ward and reverse flow for example).

For firmware versions 23.75.01 and 27.75.02 and higher, stacked DPs are availabe for mul-
tivariable meters. Analog DP only can be entered in the DP mid range for multivariable
meters.

178
OMNICOM: Meter Run Setup (Firmware Versions 23 and 27)

Note: Enter Rosemount or Honeywell multivariable transmitter DP I/O points in the DP High Range
field.

Note: For firmware versions 23.75.01 and 27.75.04 and higher, the DP high I/O point's alarm
limits and override are used for the meter. If the high point is unassigned or invalid, and there
is a valid low point, the DP low I/O point's alarms and override are used. If the high and low
point are unassigned or invalid but there is a valid mid point, the DP mid I/O point's alarms and
override are used.

DP High Range

Enter the I/O point used to input the signal from the high range differential pressure signal for
this meter run.

Duplicate I/O assignments can be made when a transducer is shared between meter runs (for-
ward and reverse flow for example).

For firmware versions 23.75.01 and 27.75.04 and higher, if stacked DP transmitters are used
and the high I/O point needs to be changed, first unassign the low and the mid points before
changing the high point. Then re-assign the low and mid points.

For firmware versions 23.75.00 and 27.75.03 and lower:


If stacked DP transmitters are used and the low I/O point needs to be changed, first
unassign the mid and the high points before changing the low point. Then re-assign the
mid and the high points.
Enter 'Unassigned' if stacked DP transmitters are not used.

For firmware versions 23.75.01 and 27.75.02 and higher, Rosemount or Honeywell mul-
tivariable transmitter DP I/O points are input in this entry. When the device type is a Rose-
mount 3095 FB transmitter or a Honeywell SMV-3000 transmitter, entering an I/O point in this
field will cause the OMNI to automatically assign I/O points for the meter run temperature and
pressure variables. The assigned I/O points cannot be changed by the user.

Note: For firmware versions 23.75.01 and 27.75.04 and higher, the DP high I/O point's alarm
limits and override are used for the meter. If the high point is unassigned or invalid, and there
is a valid low point, the DP low I/O point's alarms and override are used. If the high and low
point are unassigned or invalid but there is a valid mid point, the DP mid I/O point's alarms and
override are used.

Low Flow Cutoff

The low flow cutoff value can be based on the following:

DP - Differential pressure signals lower than this value will not be totalized. This is the default
selection.

Net Flow Rate - (available with 23.75.02 and 27.75.06 and higher) Net flow rates lower than
this value will not be totalized.

179
OMNICOM: Meter Run Setup (Firmware Versions 23 and 27)

Mass Flow Rate - (available with 23.75.02 and 27.75.06 and higher) Mass flow rates lower
than this value will not be totalized.

DP Setup

Common Settings
Tag

Tag: Informational display only - the 8 character ASCII character string which identifies each
transducer. The tag appears in the LCD display before the value of the variable. See the Pro-
cess Inputs section for configuration of the tag field.

Note: This field is not usable if the Remote I/O '99' has been assigned as I/O.

Alarms

Enable Alarms When Meter Inactive:Check the box if you require the alarms for the meter
to be triggered even when the meter is not active.

Meter Information

Enter meter identification information in the corresponding fields indicated below. All of these entries
are all 8 character alphanumeric strings except for the meter factor entry.

Meter ID: A string which identifies the flowmeter. Usually appears on reports (Modbus
register 4n14 where n is the meter run number).

Model: Enter the brand name or model of the meter.

Size: Enter the size of the meter.

S/N: Enter the serial number of the meter.

Meter Factor: The meter factor is a multiplier close to 1.0000 included to correct for small
changes in flow meter characteristics. Net and mass flows are dependent on this number.
Meter factors are determined by proving the flowmeter against some known standard volume
or standard rate.

Flow

Gross Full Scale: Two 16-bit integer variables representing meter run gross and net flow
rate are included in the data base at 3n42 and 3n40 where n is the meter run number. These
variables are scaled using this entry and stored as percentages of full scale with a resolution of
0.1% (ie: 0 to 1000 = 0% to 100.0%).

Mass Full Scale: A 16-bit integer variable representing meter run mass flow rate is included
in the data base at 3n44 where n is the meter run number. This variable is scaled using this

180
OMNICOM: Meter Run Setup (Firmware Versions 23 and 27)

entry and stored as a percentage of full scale with a resolution of 0.1% (ie: 0 to 1000 = 0% to
100.0%).

Flow Low Limit: The Low alarm (Modbus point 1n21) will activate when meter run (n) flow
rate drops below this value. The Low Low alarm (Modbus point 1n20) activates when the flow
rate drops 5% below this value.

Flow High Limit: The High alarm (Modbus point 1n22) will activate when meter run (n) flow
rate exceeds this value. The High High alarm (Modbus point 1n23) activates when the flow
rate rises 5% above this value.

Limit Units: Select the units for the Low and High Alarm Limit values. The choices are Mass
or Net Volume. The default is Mass units. (Available with firmware versions 23.75.01 and
27.75.01 and higher.)

Flow Stream

Select Product: The flow computer is capable of processing up to four meter streams each
with independent fluids and or analysis data. Select which set of product and analysis data
should be used for this metering run. Product and analysis data can be common to any num-
ber of metering runs.

GC Stream: In many cases a gas chromatograph or gas analyzer will be shared between sev-
eral meter runs or flow streams. When data is transmitted to the flow computer the analyzer
will identify which flow stream the analysis data pertains to. Enter the number of the flow
stream that this meter run should match before using the analysis data. Note: there may only
be one GC stream per fluid product. For firmware versions 23.74.30 and 27.74.30 and higher,
the GC Stream selection has moved to the Fluid Product Setup screen.

Krohne VOS: (Firmware version 27 only) - only for turbine meters and the product selected is
configured for Krohne Ethylene. Select which Auxiliary Input is to be used to input the velocity
of sound (VOS) for this meter run.

Density

The Density group will only be shown if there is a valid density I/O point assigned for the meter.

Transducer Density:

For firmware versions 23.75.01 and lower, check the box if you have a densitometer
transducer measuring flowing density on this metering run and you wish to use this
density value to calculate mass and volume flow rate. Not checking the box will cause
the flow computer to use the appropriate equation of state.

For firmware versions 27.75.05 and lower, select an upstream or downstream trans-
ducer if you have a densitometer transducer measuring flowing density on this metering
run and you wish to use this density value to calculate mass and volume flow rate.
Selecting 'Transducer Density Not Used' will cause the flow computer to use the appro-

181
OMNICOM: Meter Run Setup (Firmware Versions 23 and 27)

priate equation of state. (Note: if a downstream transducer is selected for a pulse type
meter, the firmware treats it as an upstream transducer.)

For firmware version 23.75.02 and 27.75.06 and higher, for DP devices that are not V-
Cone, that have Natural Gas selected for the product for the meter with a 1994 or 1992
AGA-8 density method selected, there is an isentropic and isenthalpic correction selec-
tion for downstream transducer density. Please refer to the DP Device Help under
'Flow Calculations' for more information on how this selection is used in the flow cal-
culations.

k3 Thermodynamic Constant: (Available with firmware versions 23.75.02 and higher and
firmware version 27)If a downstream transducer density is selected, the thermodynamic con-
stant, k3, can be entered. It is used to correct downstream flowing density to upstream con-
ditions.

For compressible fluids k3 is equal to the reciprocal of isentropic exponent (1/k)

For incompressible fluids k3 is equal to 1.0

Disable NIST14 Flowing Density Calculation: (Available with firmware versions 23.74.20
and 27.74.19 and higher.) Checking the box will speed up the NIST14 calculations because if
you are using a live densitometer there is no need to calculate the flowing density in the OMNI.
This checkbox is only available if the product running at the meter has the NIST14 meas-
urement algorithm selected and if a transducer density is used.

182
OMNICOM: DP Setup

DP Setup
The DP Setup screen is shown for DP Devices (Orifice and V-Cone) and Rosemount and Honey-
well multivariable meters. You may view the settings for the DP I/O Points as well as set the Low
Flow Cutoff and DP Switchover points.

DP Switchover

Use High DP Above - The flow computer will automatically switch over to the signal from the
mid or high range DP transmitter when the signal from the low range transmitter exceeds this
percent of its range. The switch over will not occur if the mid or high range transmitter has
failed or is not installed.

Use Low DP Below - The flow computer will automatically switch over to the signal from the
low range DP transmitter when the signal from the mid or high range transmitter falls below
this percent of its range. The switch over will not occur if the mid or high range transmitter has
failed or is not installed.

Display Only Fields

Process Inputs
Low, Mid, and High I/O Points
Tag
Input Scaling
Damping Code (for H, HV, and SV inputs)

HART Inputs
Low, Mid, and High I/O Points
Tag
Input Scaling

Virtual Inputs
Low, Mid, and High I/O Points
Tag

Miscellaneous Meter Items


Alarm Limits
Override Code
Override Value

183
OMNICOM: Meter Run Temperature

Meter Run Temperature


The Setup dialog within the Meter Run Temperature category is for entering and selecting the tem-
perature transmitter scaling values and override strategy settings for the meter. These dialogs are
available in OMNICOM only if you select 'Temperature' as meter run equipment in the Equipment
List dialog tab of the OMNI General Setup. Once you enter the information and/or make your selec-
tions, press the [Apply] button to set.

Note: The majority of this information is view only, to edit these settings you must go to the OMNI I/O
and modify the Process I/O settings of the individual I/O modules.

Settings
The items listed below are descriptions of each setting option within the Meter Run Temperature dia-
log. Click on a setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the temperature signal for this
meter run.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Type: (1) When using Rtd probes which follow the DIN curve and have an alpha of 0.00385.
(2) When using Rtd probes which follow the American curve and have an alpha of 0.00392.
(3) When using a smart transmitter connected to an 'H', 'HV' or 'SV' combo module or when
using a transducer that provides a linear 4-20mA output.

Setup

Override Code:This entry determines the strategy to be used regarding the 'Temperature
Override Value'.

Override Value: This is the temperature value that will be substituted for the transducer value
depending on the 'Override Code' selection.

Zero Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 4 milliamperes
or 1 volt.

Full Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 20 mil-
liamperes or 5 volts.

184
OMNICOM: Meter Run Temperature

Alarm Limits

Low: The low alarm activates when the temperature drops below this value.

High: The high alarm activates when the temperature rises above this value.

185
OMNICOM: Meter Run Pressure

Meter Run Pressure


The Setup dialog within the Meter Run Pressure category is for entering and selecting the Pressure
transmitter scaling values and override strategy settings for the meter. These dialogs are available in
OMNICOM only if you select 'Pressure' as meter run equipment in the Equipment List dialog tab of
the OMNI General Setup. Once you enter the information and/or make your selections, press the
[Apply] button to set.

Note: The majority of this information is view only, to edit these settings you must go to the OMNI I/O
and modify the Process I/O settings of the individual I/O modules.

Settings
The items listed below are descriptions of each setting option within the Meter Run Pressure dialog.
Click on a setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the pressure signal for this
meter run.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Setup

Override Code:This entry determines the strategy to be used regarding the 'Pressure Over-
ride Value'.

Override Value: This is the pressure value that will be substituted for the transducer value
depending on the 'Override Code' selection.

Zero Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 4 milliamperes
or 1 volt.

Full Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 20 mil-
liamperes or 5 volts.

Alarm Limits

Low: The low alarm activates when the pressure drops below this value.

High: The high alarm activates when the pressure rises above this value.

186
OMNICOM: Meter Run Pressure

187
OMNICOM: Viscosity Linearization

Viscosity Linearization
The Viscosity Linearization dialog is for entering and selecting the variables used to measure the res-
istance of the product to flow. Once you enter the information and/or make your selections, press the
[Apply] button to set.

Settings
The items listed below are links to descriptions of each setting option within the Viscosity Lin-
earization dialog. Click on a link to go to that setting's description.

Viscosity Source

Select 'None' if flow/viscosity linearizing is not a requirement. If a live viscosity transducer signal is
available select which Auxiliary input will be used to input the signal. Select 'Use Modbus' if the vis-
cosity value is to be written to the database via serial comm link.

Helical or PD meter

The algorithm used to linearize the flow meter for flow and viscosity effects is different depending on
whether the flowmeter is a helical turbine type or PD meter type.

Use LCF in Gross(IV)

Click on the box to have the flow computer include the 'linearization correction factor' (LCF) in the cal-
culation of gross indicated volume.

If checked, Gross = (flowmeter pulses/flowmeter K-factor) x LCF

If not checked, Gross = flowmeter pulses/flowmeter K-Factor

Linearization Coefficients

Enter the polynomial coefficients or equation coefficients that will be used in the linearizing
algorithms used to calculate the 'LCF' factor for the Helical Turbine or PD meter.

For Helical Turbine Meters:


LCF = a + b/x + c/x^2 + d/x^3 + e/x^4 + f/x^5 + g/x^6

For PD Meters:
LCF = a + (x^c)/b

Where x = Flowrate Q / Viscosity µ = (BBL/hr) / centistokes

188
OMNICOM: K-Factor

K-Factor
The K-Factor dialog is for entering the meter K-Factor. Once you enter the information, press the
[Apply] button to set.

Turbine, positive displacement, and Coriolis flowmeters produce pulses proportional to the flow. The
K-Factor is the quantity of pulses per unit the meter produces. The OMNI uses this setting when cal-
culating the flow rate and totals.

Settings
The items listed below are links to descriptions of each setting option within the K-Factor dialog.
Click on a link to go to that setting's description.

K-Factor Pulses per Unit

Enter the number of pulses per unit the flowmeter produces in the following units:

Liquid applications with flowmeters outputting Volumetric pulses:


U.S. = pulses/barrel (Note: units are pulses/gallon for Anhydrous Ammonia applic-
ations 20.74.22+).
Metric = pulses/m3 or Pulses/liter depending on volume unit configuration selection.

Liquid applications with flowmeters outputting Mass pulses:


U.S. = pulses/lb
Metric = pulses/kg

189
OMNICOM: K-Factors With Curve

K-Factors With Curve


The K-Factor dialog is for entering up to 12 K-Factor values and corresponding frequencies. Once
you enter the information, press the [Apply] button to set.

Turbine, positive displacement, ultrasonic, and Coriolis flowmeters produce pulses proportional to
the flow. The K-Factor is the quantity of pulses per unit the meter produces. The OMNI uses these
settings when calculating the flow rate and totals. The OMNI will continuously monitor the flowmeter
pulse frequency and calculate flow based upon the interpolated K-Factor derived from the entered
K-Factor values.

Use only the first K-Factor if your metering system does not require flowmeter linearization.

Settings
The items listed below are links to descriptions of each setting option within the K-Factor dialog.
Click on a link to go to that setting's description.

K-Factor Pulses per Unit

Enter the number of pulses per unit the flowmeter produces in the following units:

Liquid applications with flowmeters outputting Volumetric pulses:


U.S. = pulses/barrel (Note: units are pulses/gallon for Anhydrous Ammonia applic-
ations 20.74.22+).
Metric = pulses/m3 or Pulses/liter depending on configuration setting selection.

Liquid applications with flowmeters outputting Mass pulses:


U.S. = pulses/lb
Metric = pulses/kg

Gas applications with flowmeters outputting Volumetric pulses:


U.S. = pulses/MCF (thousand cubic feet) (Note: units are pulses/gallon for water)
Metric = pulses/m3 (Note: units are pulses/L for water)

Gas applications with flowmeters outputting Mass pulses:


U.S. = pulses/lb
Metric = pulses/kg

K-Factors for Specific Frequencies

Enter the value of each K-Factor and its associated frequency to use in determining the K-Factor
curve. You can define up to 12 K-Factors with which to build the curve. Note: If you do not wish to
use a K-Factor curve, enter a single K-Factor in the table in the first entry.

190
OMNICOM: K-Factors With Curve

Note: The K-Factor Frequencies are in floating point format for firmware versions 23.75.01 and
27.75.00 and higher. The floating point Modbus registers are 19n01-19n12 (where n = 1-4 for M1-
M4).
For all other firmware versions the frequencies are in 16-bit integer format and are stored in Modbus
registers 3n22-3n33 (where n = 1-4 for M1-M4).

NMi K-Factor (app 27 only)

Nederlands Meetinstituut (NMi) safeguards the traceability of measuring instruments to primary


measuring standards and is the institute for testing and certifying measuring instruments. Dutch law
requires that the flow computer display certain critical parameters as listed below:

Parameter Description
Gross Volume (accumulated flow that occurs when there is no accountable
V[units]
alarm)
Net Volume (accumulated flow that occurs when there is no accountable
Vn[units]
alarm)
Gross Error Volume (accumulated flow that occurs while an accountable
V.e[units]
alarm exists)
Net Error Volume (accumulated flow that occurs while an accountable alarm
Vn.e[units]
exists)
P[units] Pressure
t[units] Temperature
d(=S.G.) Specific Gravity
Hs[units] Heating Value
%CO2 Mole percent Carbon Dioxide
%H2 Mole percent Hydrogen
C Compressibility
Z  Z Factor
KF
NMi K-Factor
(pulses/units)

To view this NMi display group at the OMNI front panel, press:
Product, Analysis Meter ‘n’ or Analysis, Product, Meter ‘n’

These displays are only accessible when there is a positive value in the NMi K-Factor field. This
factor is used in the calculation of the NMi totalizers listed above. The function of these totalizers is
controlled by the NMi accountable alarm flag. The NMi Accountable Alarm flags error conditions
that affect the calculated flow. These errors are:

Transducer failure (pressure, temperature, density, density temperature, density pressure, or


differential pressure)
Dual pulse failure alarm (A channel fail, B channel Fail, A/B channel partial failure, or com-
parator error detected).

On the incidence of an accountable alarm, the flow computer stops incrementing the NMi totalizers
(V and Vn) and starts incrementing the NMi error totalizers (V.e and Vn.e). When the error condition

191
OMNICOM: K-Factors With Curve

is rectified, the accountable alarm is automatically cleared and the flow computer stops incrementing
the NMi error totalizers (V.e and Vn.e) and resumes incrementing the NMi totalizers (V and Vn). The
NMi totalizers are non-resettable (other than by “Reset All Totals” in the Password menu in the
OMNI)..

Note: To disable the NMi displays and accountable alarm function, enter a zero value for
the NMi K-Factor.

Modbus Addresses

Modbus Address Description


1n59 Meter ‘n’ NMi Gross Pulses
1n60 Meter ‘n’ NMi Net Pulses
1n61 Meter ‘n’ NMi Gross Error Pulses
1n62 Meter ’n’ NMi Net Error Pulses
1n63 Meter ‘n’ Accountable Alarm Status
2729 Command to Reset Meter 1 Accountable Alarm
2730 Command to Reset Meter 2 Accountable Alarm
2731 Command to Reset Meter 3 Accountable Alarm
2732 Command to Reset Meter 4 Accountable Alarm
5n86 Meter ‘n’ NMi Gross Total
5n87 Meter ‘n’ NMi Net Total
5n88 Meter ‘n’ NMi Gross Error
5n89 Meter ‘n’ NMi Net Error
5n91 Meter 'n' NMi current good pulses
17519 Meter 1 NMi K factor
17619 Meter 2 NMi K factor
17719 Meter 3 NMi K factor
17819 Meter 4 NMi K factor

192
OMNICOM: Density/Gravity

Density/Gravity
OMNICOM provides independent settings for the meter run such as setting alarm limits and trans-
ducer overrides to be used in the event of a transducer failure when using a densitometer. You can
set zero and span values for analog transducers as well as enter the calibration coefficients for digital
densitometers. These dialogs are accessed from the OMNICOM navigation tree.

Topics
The items listed below are links to topics covering each subcategory within the Density/Gravity cat-
egory. Click on a link to go to that topic.

Configuration
Setup
Pressure
Temperature
Meter Run Density Micro Motion (Solartron) Gas
Meter Run Density Micro Motion (Solartron) Liquid
Meter Run Density Thermo Scientific (Sarasota)
Meter Run Density Ametek (UGC)

193
OMNICOM: Density/Gravity Configuration

Density/Gravity Configuration
OMNICOM provides independent settings for the meter run such as configuration and signal type of
the Densitometer / Gravitometer. Once you enter the information and/or make your selections,
press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Meter Density/Gravity dia-
log. Click on a setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the Density signal for this
meter run.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Density / Gravity Type

No Type Selected: No densitometer is selected and raw input will be used

4-20 API Linear: When output is a 4-20mA signal linear with API gravity units.

4-20 SG Linear: When output is a 4-20mA signal linear with SG units. (Many API devices are
actually designed to drive non-linear chart recorders. These are usually linear with SG units)

4-20 Density Linear: When output is a 4-20mA signal linear with g/cc density units

Micro Motion (Solartron) Pulse: When using a Micro Motion (Solartron) digital pulse type
densitometer.

Thermo Scientific (Sarasota) Pulse: When using a Thermo Scientific (Sarasota) digital
pulse type densitometer.

Ametek (UGC) Pulse: When using a Ametek (UGC) digital pulse type densitometer.

Source

Specify if the density transducer signal represents density at flowing temperature and pressure or
density at reference temperature and pressure.

Note: This setting is no longer configurable via OMNICOM and front panel in firmware versions
20.75.04, 22.75.05, 24.75.04 and 26.75.03 and higher.

194
OMNICOM: Density/Gravity Configuration

195
OMNICOM: Density/Gravity Setup

Density/Gravity Setup
The Setup dialog within the Meter Density/Gravity category is for entering and selecting the Dens-
ity/Gravity transmitter scaling values and override strategy settings for the meter. These dialogs are
available in OMNICOM only if you select 'Density/Gravity' as meter run equipment in the Equipment
List dialog tab of the OMNI General Setup. Once you enter the information and/or make your selec-
tions, press the [Apply] button to set.

Note: The majority of this information is view only, to edit these settings you must go to the OMNI I/O
and modify the Process I/O settings of the individual I/O modules.

Settings
The items listed below are descriptions of each setting option within the Meter Run Density/Gravity
dialog. Click on a setting for more information.

Alarm Limits

Low:The low alarm activates when the density/gravity at the densitometer or gravitometer
drops below this value.

High: The high alarm activates when the density/gravity at the densitometer or gravitometer
rises above this value.

Setup

Override Code: This entry determines the strategy to be used regarding the 'Density/Gravity
Override Value'. Important: Each specific product can be configured to use an override grav-
ity whenever that product is run. In this case the (0)- Never use (1)- Always use(2)- Use over-
ride on transmitter fail (3)- On transmitter fail use last hours average (4)- On Transmitter fail
use station transmitter. (5)- On transmitter fail use product override

Override Value: This is the density/gravity value that will be substituted for the transducer
value depending on the 'Override Code' selection. Note: Each product setup can specify an
override to be used whenever that product is run.. The override in the product setup area over-
rides any transducer override.

Zero Scale: This entry is used to determine the Input at Zero Scale (4 mA or 1V)

Full Scale: This entry is used to determine the Input at Full Scale (20 mA or 5 V).

Density Correction Factors

The densitometer factor is used to correct for minor calibration shifts of the densitometer. This factor
is determined by checking the density reading versus the actual density measured using a pycno-
meter.

196
OMNICOM: Density/Gravity Setup

For liquid application firmware you may enter an 'A' and 'B' correction factor for each densitometer.
The actual factor used depends on a selection in the product setup area.

Note: for firmware versions 20.74.30, 22.74.30, 24.74.19 and 26.74.10, the Meter run densitometer
and Station densitometer DCFs can be configured for each product in the Product Screen.

197
OMNICOM: Meter Run Density - Micro Motion (Solartron) Liquid

Meter Run Density - Micro Motion (Solartron)


Liquid
The Micro Motion (Solartron) / Liquid dialog is for entering the various Micro Motion (Solartron) liquid
densitometer constants. This dialog is available only if you select 'Micro Motion (Solartron) Dens-
ity Pulse' as the signal type in the Meter Density dialog. Once you enter the information and/or
make your selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Micro Motion (Solartron) /
Liquid dialog. Click on the setting for more information.

Micro Motion (Solartron) Liquid Densitometer Constants

Densitometer calibration constants are supplied on a calibration certificate supplied by the dens-
itometer manufacturer.

For English applications:


Enter the constants in g/cc, degF, and psig.

For Metric applications:


CAUTION: The calibration certificates are usually based on kg/m3, degC and bar.

The OMNI requires that they be expressed in terms of degC and what ever pressure unit has been
selected K0, K1, K2, K18, K19 can be entered as supplied on the calibration sheet.

When kPA pressure unit are used:


K20A and K21A must be divided by 100 to convert the bar based calibration to kPa based
units.
K20B and K21B must be divided by 10000 to convert the bar based calibration to kPa based
units.

198
OMNICOM: Meter Run Density - Micro Motion (Solartron) Gas
Pulse

Meter Run Density - Micro Motion (Solartron) Gas


Pulse
The Micro Motion (Solartron) / Gas dialog is for entering the various Micro Motion (Solartron) gas
densitometer constants. This dialog is available only if you select 'Micro Motion (Solartron) Dens-
ity Pulse' as the signal type in the Meter Density dialog. Once you enter the information and/or
make your selections, press the [Apply] button to set.

Settings
The items listed below are links to descriptions of each setting option within the Micro Motion
(Solartron) / Gas dialog. Click on the setting for more information.

Micro Motion (Solartron) Gas Densitometer Factors

These factors are provided by the densitometer manufacturer on the original calibration doc-
umentation.

Enter the numbers in terms of kg/m3 and degC (this is the way they are documented, no con-
versions are usually needed).

K0, K1 and K2 together with the periodic time of vibration in micro seconds (T) provide an indicated
density.

Indicated Density Di = K0 + (K1 x T) + K2(T x T)

K18 and K19 together with the measured temperature are used to correct the indicated density (Di)
for flowing temperature (t) effects.

Temperature Corrected Density Dt = Di(1 + K18(t - 20)) + K19(t - 20)

K3, K4 and the Cal Gas Constant are used to correct for the difference in the velocity of sound of the
measured and calibration fluid.

Actual Density Da = Dt (1 + (K3 / (Dt + K4)) x (Cal Gas Constant - (G / (t + 273))))

where
Di = Indicated raw density (kg/m3)
T = Period of densitometer pulses in micro seconds.
Dt = Temperature compensated density (kg/m3)
t = Temperature of fluid (degC)
Da = Actual density of fluid at flowing conditions corrected for velocity of sound effects.
G = SG at reference conditions / Ratio of Specific Heats
SG @ ref = Reference Density / Density of Air

199
OMNICOM: Meter Run Density - Micro Motion (Solartron) Gas
Pulse

If the Ratio of Specific Heats is negative this will cause the flow computer to calculate the value using
AGA 10 if it is selected in the Fluid Products Setup screen.

Note: for firmware versions prior to 23.74.17 and 27.74.16, the Cal Gas Constant was named K5.

200
OMNICOM: Meter Run Density - Thermo Scientific (Sarasota)
Pulse

Meter Run Density - Thermo Scientific (Sarasota)


Pulse
The Thermo Scientific (Sarasota) dialog is for entering the various Thermo Scientific (Sarasota)
densitometer constants. This dialog is available only if you select 'Thermo Scientific (Sarasota)
Density Pulse' as the signal type in the Meter Density dialog. Once you enter the information and/or
make your selections, press the [Apply] button to set.

Settings
The item listed below is a description of the setting option within the Thermo Scientific (Sarasota)
Densitometer subcategory dialog. Click on the setting for more information.

Thermo Scientific (Sarasota) Densitometer Constants

Enter the densitometer calibration constants supplied by the manufacturer.

For English Liquid applications:


Enter the calibration constants based on g/cc, degF and PSIG.

For application 23:


Constants must be entered in terms of Lb/Ft3, degF and PSI.

For Metric applications:


Enter the calibration constants based on kg/m3, degC and pressure units which match the selected
pressure unit of the flow computer (see 'Factor Setup' menu).

201
OMNICOM: Meter Run Density - Ametek (UGC) Pulse

Meter Run Density - Ametek (UGC) Pulse


The Ametek (UGC) dialog is for entering the various Ametek (UGC) densitometer constants. This
dialog is available only if you select 'Ametek (UGC) Density Pulse' as the signal type in the Meter
Density dialog. Once you enter the information and/or make your selections, press the [Apply] but-
ton to set.

Settings
The items listed below are links to descriptions of each setting option within the Ametek (UGC) dia-
log. Click on a link to go to that setting's description.

Ametek (UGC) Densitometer Constants

Enter the densitometer calibration constants supplied by the manufacturer.

For English Liquid applications:


Enter the constants based on g/cc, degF and PSIG.

For Application 23:


Constants must be entered in terms of Lb/Ft3, degF and PSI.

For Metric Applications:


Enter the constants based on kg/m3, degC and pressure units which match the pressure unit selec-
ted in the 'Factor Setup' menu.

202
OMNICOM: Density/Gravity Temperature

Density/Gravity Temperature
OMNICOM provides independent settings for the meter run such as setting alarm limits and trans-
ducer overrides to be used in the event of a transducer failure when using a densitometer. You can
set zero and span values for analog transducers as well as enter the calibration coefficients for digital
densitometers. Once you enter the information and/or make your selections, press the [Apply] but-
ton to set.

Note: The majority of this information is view only, to edit these settings you must go to the OMNI I/O
and modify the Process I/O settings of the individual I/O modules.

Settings
The items listed below are descriptions of each setting option within the Meter Density/Gravity Tem-
perature dialog. Click on a setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the Density Temperature sig-
nal for this meter run.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Type: Select (1) When using Rtd probes which follow the DIN curve and have an alpha of
0.00385. Select (2) When using Rtd probes which follow the American curve and have an
alpha of 0.00392. Select (3) When using a smart transmitter connected to an 'H', 'HV' or 'SV'
combo module or when using a transducer that provides a linear 4-20mA output.

Setup

Override Code: This entry determines the strategy to be used regarding the 'Density Tem-
perature Override Value'.

Override Value: This is the temperature value that will be substituted for the transducer value
depending on the 'Override Code' selection.

Zero Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 4 milliamperes
or 1 volt.

Full Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 20 mil-
liamperes or 5 volts.

203
OMNICOM: Density/Gravity Temperature

Alarm Limits

Low: The low alarm activates when the temperature at the densitometer drops below this
value.

High: The high alarm activates when the temperature at the densitometer rises above this
value.

204
OMNICOM: Density/Gravity Pressure

Density/Gravity Pressure
OMNICOM provides independent settings for the meter run such as setting alarm limits and trans-
ducer overrides to be used in the event of a transducer failure when using a densitometer. You can
set zero and span values for analog transducers as well as enter the calibration coefficients for digital
densitometers. Once you enter the information and/or make your selections, press the [Apply] but-
ton to set.

Note: The majority of this information is view only, to edit these settings you must go to the OMNI I/O
and modify the Process I/O settings of the individual I/O modules.

Settings
The items listed below are descriptions of each setting option within the Meter Density/Gravity Pres-
sure dialog. Click on a setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the Density Pressure signal for
this meter run.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Setup

Override Code:This entry determines the strategy to be used regarding the 'Denisty Pres-
sure Override Value'.

Override Value: This is the pressure value that will be substituted for the transducer value
depending on the 'Override Code' selection.

Zero Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 4 milliamperes
or 1 volt.

Full Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 20 mil-
liamperes or 5 volts.

Alarm Limits

Low: The low alarm activates when the pressure at the densitometer drops below this value.

High: The high alarm activates when the pressure at the densitometer rises above this value.

205
OMNICOM: Density/Gravity Pressure

206
OMNICOM: Station

Station
The Meter Station Setup is for entering alarm limits for the station flow rate and for setting the flow
threshold rates used to switch meter runs automatically. For liquids, enter product interface detector
parameters.

For liquid applications using a Common Batch Stack (selected in the Batch Setup screen), the Sta-
tion is used in the Operate section to enter the products to the Batch Stack list and for ending the
batch. For this reason, the Station must be configured in the Station Setup screen in the "Station
Totals and Flows" field. Note that for applications with just one meter run you must enter "1+1-1" in
that field in order to end batches for the station.

Topics
Below are the areas used to configure the Meter Station Setup. Click on a link to go to that topic.

Station Setup
Interface Switching
Run Switching
Density/Gravity Settings

207
OMNICOM: Station Setup

Station Setup

Settings
The items listed below are descriptions of each setting option within the Meter Station Setup. Click
on a setting for more information.

Station Information

Station Totals and Flows : Select which meter runs will be included in the 'Station' totalizers
and flow rates. Meter data can be added or subtracted eg. 1+2+3-4 means that the totals from
meter runs 1, 2 and 3 would be added together with the total from meter run 4 subtracted.

Note: For liquid applications using a Common Batch Stack (selected in the Batch Setup
screen), the Station is used in the Operate section to enter the products to the Batch Stack list
and for ending the batch. For this reason, the Station must be configured.

The flow computer allows you to define multiple meter runs as part of a station even when you
do not have Common Batch Stack enabled. This is allowed for the purpose of using the sta-
tion batch end command 1702 or 2755, either via Modbus write or user programmable custom
Boolean/Variable statements, if there is a need to simultaneously end all the independent
batches of the meter runs configured in the station definition. The batch end commands for the
individual meter runs (1703 – 1706 or 2751 – 2754), can still be used to end an individual
meter run batch without ending the batches on the other meter runs.

If not using Common Batch Stack (i.e., Independent Batch Stack), you will not have a “station”
batch stack but will instead be presented with individual meter run batch stacks – one stack for
each of the meter runs configured in the flow computer.

For applications with just one meter run where you desire station totals and flow rates in addi-
tion to the meter run totals and flow rates, you may enter '1+' or '1-' in this field if you wish to
end the batch using the station batch end command instead of using the Meter 1 batch end
command.

The rules for entering the station totals and flows field are as follows:
It must have alternating meter run numbers and operators
Leading operators are only allowed when there is more than one meter run.
Trailing operators are only allowed if there is only one meter run

ID: Eight character alphanumeric string used to identify the meter station. Usually appears on
all the reports.

Flow

Note: specify Tons/Hr for Anhydrous Ammonia measurement. Mass FS is not used with Anhydrous
Ammonia (v20.74.22+).

208
OMNICOM: Station Setup

Gross Flow Rate Full Scale: Two 16-bit integer variables representing station gross and
net flow rate are included in the data base at 3802 and 3804. These variables are scaled using
this entry and stored as percentages of full scale with a resolution of 0.1% (ie: 0 to 1000 = 0%
to 100.0%).

Mass Flow Rate Full Scale: A 16-bit integer variable representing station mass flow rate is
included in the data base at 3806. This variable is scaled using this entry and stored as a per-
centage of full scale with a resolution of 0.1% (ie: 0 to 1000 = 0% to 100.0%).

Flow Low Limit: The station Low Flow Alarm (Modbus point # 1810) will activate when the
flow drops below this value. Flows 5% below this setting activate the Low Low Alarm ( Mod-
bus point #1809).Note: For applications 20/24, if mass pulses is selected, the limits should be
entered in mass units.

Flow High Limit: The station High Flow Alarm (Modbus point #1811) will activate when flow
exceeds this value. Flow 5% greater that this value activates the station flow High High Alarm
(Modbus point #1812).Note: For applications 20/24, if mass pulses is selected, the limits
should be entered in mass units.

Limit Units: Select the units for the Low and High Alarm Limit values. The choices are Mass
or Net Volume. The default is Mass units. (Available with firmware versions 27.75.01 and
higher.)

Batch Preset Warning

Batch Preset Warning for the Station is only available if Common Batch Stack is selected in the
Batch Screen. Enter the volume at which the OMNI provides a Batch Preset Warning status. Note:
specify Tons for Anhydrous Ammonia measurement (v20.74.22+).

The batch preset counters are activated whenever a non zero number is entered for batch
size on the batch sequence stack (see discussion of batching features in the operators manual
chapter 4).

The 'Batch Preset Reached' flag (Modbus point number 1819) will be activated whenever the
batch preset counter counts down to zero.

The 'Batch Warning' flag (Modbus point number 1818) will be activated when the batch preset
counter is less than this entry.

209
OMNICOM: Run Switching

Run Switching

Settings
The items listed below are descriptions of each setting option within the Meter Station Run Switching
dialog. Click on a setting for more information.

Threshold

Enter the flow rates thresholds. Note: specify Tons/Hr for Anhydrous Ammonia measurement
(v20.74.22+).

The OMNI has three boolean flags which are set and reset depending on the station flow rate.

Run switching flag #1 = Modbus point #1824


Run switching flag #2 = Modbus point #1825
Run Switching flag #3 = Modbus point #1826

Each of these flags has a set of flow rate thresholds, low and high. Each flag is set when the station
flow rate crosses the high threshold for that flag. It is reset when the flow rate falls below the low
threshold for that flag.

See the OMNI manual chapter 6 for more information on how to include these flags in boolean state-
ments to automatically switch meter runs depending on flow rates.

Mode

In multi meter run systems the flow computer can be configured to automatically open and close
meter run block valves depending upon orifice differential pressure or turbine flow rate.

Select 'Auto' if you have a multi run system and wish to have the flow computer control the
MOV block valves.
Select 'Manual' if you wish to operate the valves via the keypad of the flow computer manually
or via a Modbus link.
Ignore this entry if you do not have MOVs which are controlled by the flow computer.

Time

This is the amount of time in seconds that the flow computer allows for each meter run block valve to
open and flow rate to be established. If, after this amount of time differential pressure or flow rate has
not been detected, the meter run block valve will be given the 'close' command and the meter run
alarmed as being out of service. The flow computer will not attempt to open a meter run which is out
of service until it is placed back in service, either via the flow computer key-pad or via a Modbus com-
mand.

Threshold %DP

210
OMNICOM: Run Switching

Low %DP - A meter run will be closed when the differential pressure across the orifice fall
below this threshold percentage of its maximum range. Orifice runs are closed starting from
the highest meter run number to the lowest. The last meter run is always left open but may be
closed via manual command.

High %DP - A meter run will be opened when the differential pressure across the orifice of
the last run opened exceeds this percentage of its maximum range. Meter runs are opened in
order from lowest to highest skipping any meter runs which may not be in service. Runs
placed back in service will automatically be utilized when the flow computer wraps around' i.e.
opens the highest numbered meter run and then starts looking for any runs that may have be
out of service previously.

Units

For Firmware version of 23.73 and above, this configuration item determines what units are used for
the thresholds. Below this version the thresholds are always gross flow rate (KLbs/Hr).

211
OMNICOM: Interface Detection

Interface Detection

Settings
The items listed below are descriptions of each setting option within the Meter Station Interface
Detection dialog. Click on a setting for more information.

Gravity

Rate of Change : Used to detect product changes in the pipeline. Modbus point #1813 will
be activated when the flowing gravity or density measured by the station densitometer
exceeds a preset 'rate of change per NBBLs or Cubic Meters'(see following entries).
Determine gravity or density rate of change as follows:
Gravity Change / Approximate size of interface for U.S. Units applications or
Density Change / Approximate size of interface for Metric Units applications:

Example: Product changes from Propane (0.505 SG or 505.00 kg/m3) to Butane (0.585 SG
or 585.00 kg/m3).
The interface size is 12 NBBLs or Cubic Meters.
Gravity change is 0.585 - 0.505 = .080 SG
Density change is 585 - 505 = 80 kg/m3 for Metric applications
Gravity rate of change is .080 / 12 = 0.0067
Density rate of change is 80 / 12 = 6.67 kg/m3 for Metric applications

To ensure that the product change is detected, enter 0.0065 (or 6.5 for Metric application).

Note:
For flow computers with U.S. units firmware, regardless of whether the density units
coming from the live densitometer are in API, SG, or Density units, this entry needs to
be specified in SG units.
For flow computers with Metric units firmware, the entered value for this setting should
always be specified in density units (i.e., kg/m3).

Sample Time: This entry is used in conjunction with the previous entry to detect changes of
product in the pipeline. False triggering of the product interface detection flag can be elim-
inated by ensuring that any density change must exist for at least this many seconds.
Determine the minimum amount of time in seconds that it takes for a product change to be
complete and set this timer to approximately one quarter to one third of that time.

Line Pack Delay

In many cases the station densitometer that detects the product interfaces is installed many net
BBLs (cubic meters for Metric units flow computers) in advance of the metering skid to provide prior
warning of a product change. Enter the number of NBBLs or cubic meters between the station dens-
itometer and the metering skid here. Delayed point #1814 will be activated this many net barrels or
cubic meters after the interface detected flag (Modbus point #1813) is activated.

212
OMNICOM: Interface Detection

Note: specify Tons for Anhydrous Ammonia measurement (v20.74.22+).

213
OMNICOM: Trapil Alarms and Training

Trapil Alarms and Training


This page is displayed for firmware revisions 24.74.18 and higher when the Trapil Functions are
enabled:
Enable the Trapil functions in OMNICOM with the command line switch '-Trapil'. If you need
help adding a command line switch, please speak with your IT representative.
Enable the Trapil functions in the OMNI in the Password menu by setting the 'Trapil Function'
to 'Y'.

Hydraulic Alarm Sampling


Sample Volume

Determines the size of the comparison sample. It has three decimal places of resolution. Default is
4.000 m3.

Sample Interval

Determines the number of samples between Hydraulic Alarm checks. Valid intervals are 1 through
16. Default = 8.

Hydraulic Alarm Threshold

When checking for Hydraulic Alarms, absolute sample deltas equal or greater than this threshold
value will be seen as a Hydraulic Alarm. It has three decimal places of resolution. Default is 0.100
m3.

Heavy Alarm Threshold

When checking for Heavy Hydraulic Alarms, a consecutive number of Sample Deltas equal or
greater than this threshold value will be flagged as a Heavy Hydraulic Alarm. It has three decimal
places of resolution. Default is 0.400 m3.

Consecutive Heavy Count

Determines the number of consecutive samples that must exceed the Heavy Hydraulic Alarm
Threshold. Valid values are 1 through 16. Default = 8.

Training
Sample Period

The time period in which training samples will be taken. This value is configurable and ranges from
20 seconds to 600 seconds. Default = 180 seconds.

214
OMNICOM: Trapil Alarms and Training

Sample Count

The number of ‘Training Samples’ required. This value is configurable and ranges from 10 to 60
samples. Default = 30.

Training Constant

Configuration constant. Default = 2.

215
OMNICOM: Density/Gravity

Density/Gravity
The station densitometer or gravitometer depending on the application is used to calculate the mass
of liquid in the prover during a mass proving run. (ie. Coriolis meter proving) Digital densitometers
can be corrected for temperature and pressure effects using the station pressure and temperature
points.

Topics
Below are the areas used to configure the OMNI Prover Density/Gravity Setup. Click on a link to go
to that topic.

Configuration
Setup
Pressure
Temperature
Micro Motion (Solartron)
Thermo Scientific (Sarasota)
Ametek (UGC)

216
OMNICOM: Density/Gravity Configuration

Density/Gravity Configuration
OMNICOM provides independent settings for the station, such as configuration and signal type of
the Densitometer / Gravitometer. Once you enter the information and/or make your selections,
press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Meter Density/Gravity dia-
log. lick on the setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the Density signal for the sta-
tion..

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Density/Gravity Type

Select the type of signal used with the densitometer or gravitometer connected to your OMNI. Avail-
able options are:

No Type Selected: No densitometer is selected and raw input will be used

4-20 API Linear: When output is a 4-20mA signal linear with API gravity units.

4-20 SG Linear: When output is a 4-20mA signal linear with SG units. (Many API devices are
actually designed to drive non-linear chart recorders. These are usually linear with SG units)

4-20 Density Linear: When output is a 4-20mA signal linear with g/cc density units

Micro Motion (Solartron) Pulse: When using a Micro Motion (Solartron) digital pulse type
densitometer.

Thermo Scientific (Sarasota) Pulse: When using a Thermo Scientific (Sarasota) digital
pulse type densitometer.

Ametek (UGC) Pulse: When using a Ametek (UGC) digital pulse type densitometer.

217
OMNICOM: Density/Gravity Setup

Density/Gravity Setup
The Density/Gravity setup is for entering and selecting the Density / Gravity transmitter scaling val-
ues and override strategy settings for the prover. These dialogs are available in OMNICOM only if
you select 'density/gravity' as prover equipment in the Equipment List dialog tab of the OMNI Gen-
eral Setup. Once you enter the information and/or make your selections, press the [Apply] button to
set.

Settings
The items listed below are descriptions of each setting option within the Meter Run Density/Gravity
dialog. Click on a setting for more information.

Alarm Limits

Low: The low alarm activates when the density/gravity at the densitometer or gravitometer
drops below this value.

High: The high alarm activates when the density/gravity at the densitometer or gravitometer
rises above this value.

Setup

Override Code: This entry determines the strategy to be used regarding the 'Density/Gravity
Override Value'. Important: Each specific product can be configured to use an override
whenever that product is run:
(0)- Never use
(1)- Always use
(2)- Use override on transmitter fail
(3)- On transmitter fail use last hours average
(4)- On Transmitter fail use station transmitter.
(5)- On transmitter fail use product override

Override Value: This is the density/gravity value that will be substituted for the transducer
value depending on the 'Override Code' selection. Note: Each product setup can specify an
override to be used whenever that product is run.. The override in the product setup area over-
rides any transducer override.

Zero Scale: This entry is used to determine the Input at Zero Scale (4 mA or 1V)

Full Scale: This entry is used to determine the Input at Full Scale (20 mA or 5 V).

Density Correction Factor

The densitometer factor is used to correct for minor calibration shifts of the densitometer. This factor
is determined by checking the density reading versus the actual density measured using a pycno-
meter.

218
OMNICOM: Density/Gravity Setup

For liquid application firmware you may enter a correction factor for each densitometer. The actual
factor used depends on a selection in the product setup area.

Note: for firmware versions 20.74.30, 22.74.30, 24.74.19 and 26.74.10, the Meter run densitometer
and Station densitometer DCFs can be configured for each product in the Product Screen.

219
OMNICOM: Station Density - Micro Motion (Solartron) Liquid

Station Density - Micro Motion (Solartron) Liquid


The Micro Motion (Solartron) / Liquid dialog is for entering the various Micro Motion (Solartron) liquid
densitometer constants. This dialog is available only if you select 'Micro Motion (Solartron) Dens-
ity Pulse' as the signal type in the Station Density Configuration dialog. Once you enter the inform-
ation and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Micro Motion (Solartron) /
Liquid dialog. Click on the setting for more information.

Micro Motion (Solartron) Liquid Densitometer Constants

Densitometer calibration constants are supplied on a calibration certificate supplied by the dens-
itometer manufacturer.

For English Applications:


They are usually based on SI or metric units. You must ensure that the constants entered are based
on g/cc, degF, and PSIG.

For Metric applications:


CAUTION: The calibration certificates are usually based on kg/m3, degC and Bar.

The OMNI requires that they be expressed in terms of degC and what ever pressure unit has been
selected K0, K1, K2, K18, K19 can be entered as supplied on the calibration sheet.

When kPA pressure unit are used:


K20A and K21A must be divided by 100 to convert the Bar based calibration to kPa based
units.
K20B and K21B must be divided by 10000 to convert the Bar based calibration to kPa based
units.

220
OMNICOM: Station Density - Thermo Scientific (Sarasota) Pulse

Station Density - Thermo Scientific (Sarasota)


Pulse
The Thermo Scientific (Sarasota) dialog is for entering the various Thermo Scientific (Sarasota)
densitometer constants. This dialog is available only if you select 'Thermo Scientific (Sarasota)
Density Pulse' as the signal type in the Station Density Configuration dialog. Once you enter the
information and/or make your selections, press the [Apply] button to set.

Settings
The item listed below is a description of the setting option within the Thermo Scientific (Sarasota)
Densitometer subcategory dialog. Click on the setting for more information.

Thermo Scientific (Sarasota) Densitometer Constants

Enter the densitometer calibration constants supplied by the


manufacturer.

For English Liquid applications:


Enter the calibration constants based on g/cc, degF and PSIG.

For application 23:


Constants must be entered in terms of Lb/Ft3, degF and PSI.

For Metric applications:


Enter the calibration constants based on kg/m3, degC and pressure units which match the selected
pressure unit of the flow computer (see 'Factor Setup' menu).

221
OMNICOM: Station Density - Ametek (UGC) Pulse

Station Density - Ametek (UGC) Pulse


The Ametek (UGC) dialog within the Station Densitometer subcategory is for entering the various
Ametek (UGC) densitometer constants. This dialog is available only if you select 'Ametek (UGC)
Density Pulse' as the signal type in the Station Density Configuration dialog. Once you enter the
information and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are links to descriptions of each setting option within the Ametek (UGC) dia-
log. Click on a link to go to that setting's description.

Ametek (UGC) Densitometer Constants

Enter the densitometer calibration constants supplied by the


manufacturer.

For English Liquid applications:


Enter the constants based on g/cc, degF and PSIG.

For Application 23:


Constants must be entered in terms of Lb/Ft3, degF and PSI.

For Metric Applications:


Enter the constants based on kg/m3, degC and pressure units which match the pressure unit selec-
ted in the 'Factor Setup' menu.

222
OMNICOM: Density/Gravity Temperature

Density/Gravity Temperature
OMNICOM provides independent settings for the station such as setting alarm limits and transducer
overrides to be used in the event of a transducer failure when using a densitometer. You can set
zero and span values for analog transducers as well as enter the calibration coefficients for digital
densitometers. Once you enter the information and/or make your selections, press the [Apply] but-
ton to set.

Note: The majority of this information is view only, to edit these settings you must go to the OMNI I/O
and modify the Process I/O settings of the individual I/O modules.

Settings
The items listed below are descriptions of each setting option within the Meter Density/Gravity Tem-
perature dialog. Click on a setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the Density Temperature sig-
nal for the station.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Type:
(1) When using Rtd probes which follow the DIN curve and have an alpha of 0.00385.
(2) When using Rtd probes which follow the American curve and have an alpha of
0.00392.
(3) When using a smart transmitter connected to an 'H', 'HV' or 'SV' combo module or
when using a transducer that provides a linear 4-20mA output.

Setup

Override Code: This entry determines the strategy to be used regarding the 'Density Tem-
perature Override Value'.

Override Value: This is the temperature value that will be substituted for the transducer value
depending on the 'Override Code' selection.

Zero Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 4 milliamperes
or 1 volt.

Full Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 20 mil-
liamperes or 5 volts.

223
OMNICOM: Density/Gravity Temperature

Alarm Limits

Low: The low alarm activates when the temperature at the densitometer drops below this
value.

High: The high alarm activates when the temperature at the densitometer rises above this
value.

224
OMNICOM: Density/Gravity Pressure

Density/Gravity Pressure
OMNICOM provides independent settings for the station such as setting alarm limits and transducer
overrides to be used in the event of a transducer failure when using a densitometer. You can set
zero and span values for analog transducers as well as enter the calibration coefficients for digital
densitometers. Once you enter the information and/or make your selections, press the [Apply] but-
ton to set.

Note: The majority of this information is view only, to edit these settings you must go to the OMNI I/O
and modify the Process I/O settings of the individual I/O modules.

Settings
The items listed below are descriptions of each setting option within the Density/Gravity Pressure dia-
log. Click on a setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the Density Pressure signal
for the station.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Setup

Override Code:This entry determines the strategy to be used regarding the 'Density Pres-
sure Override Value'.

Override Value: This is the pressure value that will be substituted for the transducer value
depending on the 'Override Code' selection.

Zero Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 4 milliamperes
or 1 volt.

Full Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 20 mil-
liamperes or 5 volts.

Alarm Limits

Low: The low alarm activates when the pressure at the densitometer drops below this value.

High: The high alarm activates when the pressure at the densitometer rises above this value.

225
OMNICOM: Density/Gravity Pressure

226
OMNICOM: Prover

Prover
Provers are used to determine the accuracy of a liquid or a gas meter. The procedure can be
applied to both liquid and gas applications. Enter the parameters needed for automatic meter prov-
ing such as number of runs, water draw volume and allowable count deviation. OMNICOM makes
available only those dialogs that apply to your meter run configuration.

Topics
The items listed below are links to topics covering each dialog within the Prover setup. Click on a link
to go to that topic.

Configuration
Inlet/Outlet Pressure
Inlet/Outlet Temperature
Switch Bar Temperature (Available with firmware versions 20.74.30, 22.74.30, 24.74.30, and
26.74.30 and higher)
Plenum Pressure
Density/Gravity

227
OMNICOM: Prover Configuration

Prover Configuration
Enter the parameters needed for automatic meter proving such as number of runs, water draw
volume and allowable count deviation. OMNICOM makes available only those dialogs that apply to
your meter run configuration.

Topics
The items listed below are links to topics covering each dialog within the Prover setup. Click on a link
to go to that topic.

Prover Type
Prover Characteristics
Prover Volume/Mass
Operational Setup
Auto Prove Setup (firmware versions 20 and 24 only)
Prover Setup (firmware versions 22 and 26 only)

228
OMNICOM: Prover Type

Prover Type
The Prover Type dialog is for selecting the type of prover in use. Once you enter the information
and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are the settings covering each dialog within the Prover Type Setup.

Prover Type (Liquid Applications Only)

Select a CONVENTIONAL Unidirectional or CONVENTIONAL Bi-directional prover if more


than 10, 000 pulses are accumulated between detectors.

Select a PULSE INTERPOLATION Unidirectional Pipe/Compact or PULSE


INTERPOLATION Bi-directional prover if less than 10, 000 pulses are accumulated between
detectors. These provers are only available with flow computers that have double chro-
nometry boards (Module C or E) installed. Connect the detector switch signals to terminal 7 of
the C or E Module. If more than one C or E Module is installed, all C or E Modules terminal 7's
must be connected together.

Select PULSE INTERPOLATION Unidirectional Pipe/Compact if you are using an Emer-


son/Brooks compact prover.

Select 'Master Meter' to compare meter run 1, 2 or 3 against the master meter which is
always meter run 4.

Two-Series Bi-directional Pipe provers are only available with firmware versions 20, 22, and
26. A custom prover report template is required as the default template in the OMNI does not
apply to this prover type.

Master Meter Prover Type (Gas Applications Only)

Mass
Gross

229
OMNICOM: Prover Characteristics

Prover Characteristics

Settings
Below are the settings used to configure the Prover Characteristics Screen:

Prover Internal Diameter

Enter the inside diameter measurement of the prover tube in inches for English Applications and in
centimeters for Metric Applications. It is used to calculate the CPSP correction factor which corrects
for expansion effects of the prover tube due to pressure.

Prover Wall Thickness

Enter the wall thickness of the prover tube in inches for English Applications and in centimeters for
Metric Applications. This entry is used to calculate the CPSP correction factor which corrects for
expansion of the prover tube due to pressure.

Modulus of Elasticity (Pressure)

This entry is used to calculate the Correction Factor for Pressure on Steel (CPSP). The flow com-
puter uses this entry to calculate a corrected prover volume.

Mild Carbon Steel


304/316 Stainless Steel
Other

Pressure Units
Type of Steel
PSI kPa Bar kg/cm2
Mild Steel 3.0E7 2.07E8 2.07E6 2.11E6
Stainless Steel 2.8E7 to 2.9E7 1.93E8 to 2.0E8 1.93E6 to 2.0E6 1.97E6 to 2.04E6

Thermal Expansion

When a ‘Conventional Pipe’ prover type is selected, enter the ‘Cubical Coefficient of Thermal Expan-
sion’ for the prover pipe material. Conventional pipe provers will have the detector switches mounted
on the prover pipe.

Prover Material Cubical Expansion / degF Cubical Expansion / degC


Mild Carbon Steel 0.0000186 0.0000335
304 Stainless Steel 0.0000288 0.0000518
316 Stainless Steel 0.0000265 0.0000477
17-4PH Stainless Steel 0.0000180 0.0000324

230
OMNICOM: Prover Characteristics

When a ‘Pulse Interpolation’ prover type is selected enter the ‘Area Coefficient of Thermal Expan-
sion’ for the prover barrel or tube material.

Examples of prover types that use ‘Pulse Interpolation’ are the SYNCROTRAK, by Enraf/Calibron,
and the Emerson/Brooks SVP prover. These SVPs (Small Volume Provers) have optical detector
switches that are not mounted on the prover barrel/tube.

Pulse interpolation is also used by ‘Reduced Volume’ conventional pipe provers that have the
detector switches mounted on the prover pipe. Do not enter the cubical expansion factor as this is
determined indirectly by applying the Area and Linear expansion factors separately.

Prover Material Area Expansion / degF Area Expansion / degC


Mild Carbon Steel 0.0000124 0.0000223
304 Stainless Steel 0.0000192 0.0000346
316 Stainless Steel 0.0000177 0.0000318
17-4PH Stainless Steel 0.0000120 0.0000216

Linear Coefficient

Linear Thermal Coefficient of Switch Rod Component

This entry is required only when a ‘Pulse Interpolation’ prover type is selected. Enter the linear tem-
perature coefficient of thermal expansion for the material that any detector switch rod components
affecting the water draw volume of the prover. For ‘Reduced Volume’ conventional pipe provers, this
would be the prover pipe material that the detectors are mounted on.

Prover Material Linear Expansion / degF Linear Expansion / degC


Mild Carbon Steel 0.0000062 0.0000112
304 Stainless Steel 0.0000096 0.0000173
316 Stainless Steel 0.0000088 0.0000159
17-4PH Stainless Steel 0.0000060 0.0000108
Invar Rod 0.0000008 0.0000014

231
OMNICOM: Prover Volume/Mass

Prover Volume/Mass

Settings
Below are the settings used to configure the Prover Volume/Mass Screen:

Base Conditions

Base Temperature:Enter the base temperature or the temperature at which the water
drawn volume was corrected to. It is used to calculate the Correction Factor for Temperature
on Steel (CTSP). It is usually 60.0 degF for English applications or 20.0 degC for Metric applic-
ations.

Base Pressure (gauge): Enter the base pressure in gauge units at which the base volume of
the prover was determined (usually, zero).

Volume/Mass

Enter the water draw of the prover at base temperature and pressure in volume or mass units,
depending on whether your application requires volumetric or mass proving. This is the 'round
trip' volume or mass for bidirectional provers.

For pulse interpolation unidirectional pipe/compact provers enter the upstream and down-
stream water draw volumes at base temperature and pressure.

When using the 'Master Meter' method, enter the minimum volume or mass units that must
flow through the master meter (meter run 4) for each prove run.

Use the following units:


For U.S. units applications with flow meters that output volumetric pulses:
Applications 20 and 22 firmware = BBLS (specify LBS for Anhydrous Ammonia meas-
urement v20.74.22+)
Application 23 firmware = enter gross volume in MCF

For U.S. units applications with flowmeters that output mass pulses:
For Non-Master Meter Proving:
Application 20 firmware = BBLS
For Master Meter Proving:
Application 20 firmware = KLbs
Application 23 firmware = Lbs

For Metric units applications with flowmeters that output volumetric pulses:
Applications 24 and 26 firmware = the configured volume units (m3 or L)
Application 27 firmware = enter gross volume in m3

For Metric units applications with flowmeters that output mass pulses:

232
OMNICOM: Prover Volume/Mass

For Non-Master Meter Proving:


Application 24 firmware = the configured volume units (m3 or L)
For Master Meter Proving:
Application 24 firmware = Tonnes or kg (in kg if the configured volume units are L)
Application 27 firmware = kg

Overtravel

The flow computer uses this entry to ensure that the sphere is ready to be launched after each
prove run. To calculate, estimate the volume that the sphere displaces between the 2nd
detector switch and when it arrives in the Ready-To-Launch position and multiply it by 1.25.
(See the Volume/Mass category for units to use for your application.)

For an Emerson/Brooks compact prover, set the overtravel to zero to minimize the prove
sequence time.

233
OMNICOM: Prover Operational Setup

Prover Operational Setup

Settings
Below are the settings used to configure the Operational Setup Screen:

Prover Run Setup

Number of Runs to Average: The number of consecutive runs required to be considered a


complete prove sequence. Allowable number is 1 to 10. Per API standards, the minimum num-
ber of consecutive runs required to be considered a complete prove sequence is two.
However, the flow computer allows a minimum of one run for a quick prove sequence test that
will allow the auto-implementation of the Meter Factor. The Trial Prove function does not test
the Meter Factor auto-implementation feature.

Maximum number of Runs: Maximum number of runs that will be attempted to achieve a
complete prove sequence. Allowable entry 2 to 99.

Number of Passes per Run: This entry applies to pulse interpolation unidirectional pipe/-
compact and pulse interpolation bi-directional provers only. Enter the number of single passes
that will be averaged to make each run when using the pulse interpolation method. Valid
entries are 1 through 25 for unidirectional and 1 through 10 for bi-directional.

Inactivity Timer (Seconds):Enter the time in seconds before a prove is aborted due to
prover inactivity. Note: the inactivity timer is running while the flow computer is checking for
temperature and flow rate stability. Ensure that the value entered is sufficient to allow for
stable conditions to be reached. Additionally, make sure that you allow enough time for the
sphere to travel between the detector switches at the lowest flow rate expected. When using
the 'Master Meter' prove method, allow enough time for the amount of flow to pass through
the master meter at the lowest expected flow rate. If the inactivity time is exceeded, the flow
computer aborts the prove operation, sets a prove fail flag, and prints a Prove Abort report.

Run Repeatability Based On

Run repeatability can be calculated using run counts or run calculated meter factor.

For applications 20 and 24, if 'LCF in Gross' is selected, run repeatability can be calculated as
run counts times LCF (See Viscosity Linearization screen).

For applications 22 and 26 you may select whether you want the repeatability based on [(Max-
Min/Avg] or [(Max-Min)/Min]. All the other applications are based on [(Max-Min)/Min].

For liquid applications using master meter provers, the repeatability is based on meter factor.
For applications 20 and 24, the repeatability selection is not shown.

Enter for the Run Repeatability calculation based on:

234
OMNICOM: Prover Operational Setup

Counts: Run counts repeatability is a more stringent test but may be difficult to achieve due to
changing temperature and pressures during the prove sequence.

Meter Factor: Calculating repeatability based upon the calculated meter factor takes into
account variations in temperature and pressure and may be easier to achieve.

Maximum Deviation: This is the acceptable % deviation between the high and low prove run
counts or run meter factor based on the mid point. Deviation = 100 (High - Low )/Low *Note:
The deviation is calculated by comparing meter counts or meter factor depending on the fol-
lowing entry. Deviation is always calculated using the meter factor when the 'Master Meter'
prove method is selected.

Stability Check

Stability Sample Time:Enter the stability check sample time in seconds used to calculate the
rate of change of the temperature and flow rate at the prover. The prove sequence will not
start until the temperature and flow rate are stable.

Allowable Temperature Change during Sample time: Enter the amount of temperature
change allowed during the stability sample time. The change in temperature per sample
period must be less than this value for temperature to be considered stable enough to start a
prove.

Allowable Flow rate Change during Sample Time: Enter the flow rate change allowed
during the stability sample time. The change in flow rate per sample period must be less than
this value before the flow rate is considered stable enough to start a prove.Note: For Anhyd-
rous Ammonia applications 20.74.22+, the flow rate units are Tons/Hr.

Flow Rate changes that occur while a prove sequence is in progress also causes poor run
repeatability. For this reason, the flow computer continues to monitor flow rate stability during
each prove run. The maximum amount of change in flow rate between prove runs must not
exceed this entry.

Density Stability Time: This entry only applies when mass proving is required and a prover
densitometer is configured. Enter the number of seconds delay required to allow the prover
density signal to stabilize after launching the prover ball or piston. Certain types of compact
provers cause a momentary pressure pulse each time the prover piston is launched. This can
momentarily cause inaccurate densitometer readings.The flow computer will wait this many
seconds AFTER the launch command before beginning to sample the density, then stops
sampling when the second detector signal is received. These sampled densities are used to
calculate a FWA density for each run. NOTE: For some small volume provers that have very
short run times (sometimes less than one second), you may be required to enter a value of
zero so the flow computer can begin sampling immediately after sending the launch command
so it has an opportunity to take density samples before the second detector signal arrives.

Allowable Temperature Deviation between Meter and Prover: Enter the maximum tem-
perature difference that may exist between the meter temperature and prover temperature for
the prove sequence to continue after the temperature and flow rate have stabilized. The

235
OMNICOM: Prover Operational Setup

temperature at the meter and at the prover must be less than this limit or the prove sequence
will be aborted and a Prove Abort report is printed.

Meter Factor Calculation Resolution

Auto Implement Meter Factor Immediately:Check the box to automatically implement the
new meter factor at the end of the prove and store it in the product file.

Apply Meter Factor Retroactively:If you selected to 'Auto Implement the Meter Factor';
check here to retroactively apply the Meter Factor from the beginning of the batch. The old
meter factor will be back calculated out of current batch and daily totals and the batch and
daily totals will be recalculated using the new meter factor.

Leave this entry blank to apply the meter factor only to the remaining portion of the batch and
not recalculate the entire batch. In this case, the meter factor reported for the batch will be the
weighted average of the previous and new meter factors.

Manual Implement MF Time Limit (minutes): The number of minutes to allow the operator
to accept or reject the meter factor after a complete prove sequence. (app 22 and 26)

Final Meter Factor Selection(available with firmware versions 22.75.10 and 26.75.10):
Select how the final meter factor is calculated:

Final MF = GSVp / GSVm (default and automatically selected when repeatability is


based on Counts)
Final MF = Average of Intermediate Meter Factors (only available if repeatability is
based on MF)

Meter Factor Acceptability Criteria

Acceptable if meter factor is within the percentage (%) of the in use meter factor. (app 20, 23,
24 and 27)

Acceptable meter factor deviation percentage (%) from meter factor curve. (app 22 and 26)

Acceptable meter factor deviation percentage (%) from historical averages. (app 22 and 26)

Prove Reports

Archive All Reports (Y/N): If set to 'Y', all prover reports (Official, Unofficial, and Aborted)
should go into the buffers used to store the last 8 historical prove reports. (Available with firm-
ware versions 20.74.18, 22.74.00, 23.74.19, 24.74.16, 26.74.00, and 27.74.18)

Print Prove Passes (Y/N): If set to 'Y' when using a pulse interpolation type prover, the data
from each prove pass is sent to the printer.

Unidirectional Reports (Y/N): If set to 'Y', only the Total Counts column is shown on the
prove report. Otherwise R-L, L-R and Total Counts are shown. (Available with firmware ver-
sions 22.74.00 and 26.74.00)

236
OMNICOM: Prover Operational Setup

Number of MFs in Historical Average (1-10): Number of previous meter factors to include
in historical averages. (firmware versions 22 and 26 only)

237
OMNICOM: Prover Setup

Prover Setup

Settings
Information about the prover is input on this screen and printed on the Prove Report. This screen is
available with firmware versions 22.74.05 and 26.74.02 and higher.

Prover Tag Number

Enter a tag number using up to 8 alphanumeric characters.

Prover Manufacturer

Enter the manufacturer of the prover using up to 8 alphanumeric characters.

Prover Material

Enter the material of the prover using up to 8 alphanumeric characters.

Prover Serial Number

Enter the serial number using up to 8 alphanumeric characters.

238
OMNICOM: Prover Auto Prove Setup (Firmware Versions 20 and
24)

Prover Auto Prove Setup (Firmware Versions 20


and 24)
Enabling ‘auto prove’ (see the proving group under the Meter Run Setup configuration) causes the
flowmeter to be automatically proved on flow rate changes, after a meter has been out of service,
and if a specified amount of flow has occurred since the last prove sequence for that meter. The
‘auto prove enable’ is automatically cancelled if a meter fails an automatic prove on 10 consecutive
attempts or if the Meter Factor is not implemented after two complete consecutive prove sequences.

Note: When using the Auto Prove feature, the “Auto Implement Meter Factor immediately” feature
should also be enabled in the Prover Operational Setup tab. If the “Auto Implement Meter Factor
immediately” feature is not enabled after a complete prove sequence, the OMNI will automatically
enable it.

Note: If a Meter Factor is not auto implemented for any reason (i.e. did not meet the acceptance cri-
teria) after two consecutive auto prove sequences, the OMNI will automatically disable Auto Proving
in the configuration for that meter run. The second auto prove attempt occurs immediately if
triggered by a ‘Flow Rate change’. However, if triggered by a meter run ‘Start-up’, or ‘Maximum
Flow between Proves’ event, the second auto prove won’t occur until triggered by another ‘Start-up’
or ‘Maximum Flow between Proves’ event.

Note: Auto Proving is not available for master meter proving.>

Settings
Below are the settings used to configure the Auto Prove Setup Screen:

StartUp

Auto Prove at startup after meter has been down more than: Enter the meter shut-in
period in hours. If a meter is shut-in for more than this amount of time, the meter will be
flagged to be automatically proved when flow resumes. An auto prove is triggered after the
volume specified in the startup flow entry has flowed through the meter.

Minimum amount of flow after startup before auto prove is attempted: The minimum
amount of flow that must occur before an auto prove is attempted, after a meter has been
shut-in for more than the period specified in the meter down period entry. Note: for Anhydrous
Ammonia applications v20.74.22+ enter the volume in Tons.

Flow Rate Change Between Proves

Flow Rate Change Threshold (%): The 'flow rate percent change' flag will be set if the cur-
rent flow rate differs from the last meter proving flow rate by more than this percent.

239
OMNICOM: Prover Auto Prove Setup (Firmware Versions 20 and
24)

Note: In OMNI firmware v24.74.19+, the OMNI flow computer discards the Pending Auto
Prove flag (1n15) when flow rate goes to zero or when the flowmeter goes inactive on ramp
down conditions.

Minimum Flow Rate Change: The minimum flow change flag will be set if the current flow
rate differs from the last meter proving flow rate by more than this amount. This entry elim-
inates unnecessary proves that would occur at low flow rates where the percentage change
threshold would be a very small flow rate change. Note: for Anhydrous Ammonia applications
v20.74.22+ enter the flow rate in Tons/hr.

Flow Stable Period (minutes): A request for an automatic prove sequence will be made if
the 'Flow Rate Percent Change' flag AND the 'Minimum Flow Rate Change' flag are set and
remain set for the time period in minutes specified in this entry. A setting of zero disables this
feature.

Maximum Flow Between Proves

Auto prove flow meter at least every: The flow computer may be setup to implement an
auto prove based on the quantity that has flowed through the meter since the last prove. This
entry is used to specify the maximum volume that can occur before a meter will be flagged for
an auto prove sequence if the flow remains stable and the meter is not shut-in.

240
OMNICOM: Inlet/Outlet Pressure

Inlet/Outlet Pressure
OMNICOM provides independent settings for the prover such as setting alarm limits and transducer
overrides to be used in the event of a transducer failure. You can set zero and span values for analog
transducers as well as enter the calibration coefficients. Once you enter the information and/or make
your selections, press the [Apply] button to set.

Note: The majority of this information is view only, to edit these settings you must go to the OMNI I/O
and modify the Process I/O settings of the individual I/O modules.

Settings
The items listed below are descriptions of each setting option within the Prover Inlet/Outlet Pressure
dialog. Click on a setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the inlet or outlet pressure sig-
nal for the prover.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Setup

Override Code:This entry determines the strategy to be used regarding the "Pressure Over-
ride Value'.

Override Value: This is the pressure value that will be substituted for the transducer value
depending on the 'Override Code' selection.

Zero Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 4 milliamperes
or 1 volt.

Full Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 20 mil-
liamperes or 5 volts.

Alarm Limits

Low: The low alarm activates when the pressure drops below this value.

High: The high alarm activates when the pressure rises above this value.

241
OMNICOM: Plenum Pressure

Plenum Pressure
Plenum Pressure is used with the Emerson/Brooks Compact Provers.

OMNICOM provides independent settings for the Plenum Pressure of the prover such as setting
alarm limits and transducer overrides to be used in the event of a transducer failure. You can set
zero and span values for analog transducers as well as enter the calibration coefficients. Once you
enter the information and/or make your selections, press the [Apply] button to set.

Note:The majority of this information is view only, to edit these settings you must go to the OMNI I/O
and modify the Process I/O settings of the individual I/O modules.

Settings
The items listed below are descriptions of each setting option within the Prover Plenum Pressure dia-
log. Click on a setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the Plenum Pressure signal
for the prover. Note: the Remote Input and Virtual Inputs are allowed however there are no
alarm limits to generate validation thresholds against.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Setup

Zero Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 4 milliamperes
or 1 volt.

Full Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 20 mil-
liamperes or 5 volts.

242
OMNICOM: Inlet/Outlet Temperature

Inlet/Outlet Temperature
OMNICOM provides independent settings for the prover such as setting alarm limits and transducer
overrides to be used in the event of a transducer failure. You can set zero and span values for analog
transducers as well as enter the calibration coefficients. Once you enter the information and/or make
your selections, press the [Apply] button to set.

Note: The majority of this information is view only, to edit these settings you must go to the OMNI I/O
and modify the Process I/O settings of the individual I/O modules.

Settings
The items listed below are descriptions of each setting option within the Prover Inlet/Outlet Tem-
perature dialog. Click on a setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the Inlet/Outlet Temperature
signal for the prover.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Type: (1) When using Rtd probes which follow the DIN curve and have an alpha of 0.00385.
(2) When using Rtd probes which follow the American curve and have an alpha of 0.00392.
(3) When using a smart transmitter connected to an 'H', 'HV' or 'SV' combo module or when
using a transducer that provides a linear 4-20mA output.

Setup

Override Code: This entry determines the strategy to be used regarding the "Temperature
Override Value'.

Override Value: This is the temperature value that will be substituted for the transducer
value depending on the 'Override Code' selection.

Zero Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 4 milliamperes
or 1 volt.

Full Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 20 mil-
liamperes or 5 volts.

Alarm Limits

243
OMNICOM: Inlet/Outlet Temperature

Low: The low alarm activates when the temperature drops below this value.

High: The high alarm activates when the temperature rises above this value.

244
OMNICOM: Plenum Pressure Setup

Plenum Pressure Setup


The Plenum Pressure Setup is for entering and selecting constant values and deadband percent set-
tings for the Prover. Once you enter the information and/or make your selections, press the [Apply]
button to set.

Settings
Below are the settings used to setup the Plenum Pressure of the Prover. Click on the setting for
more information.

Plenum Pressure Constant

Emerson/Brooks compact provers use a nitrogen pressured plenum to close the displacer poppet
valve when the launch command is given. Insufficient or excessive plenum pressure can cause inac-
curate prove measurements and therefore must be regulated.

The Plenum Pressure needed for correct operation of the Emerson/Brooks compact prover is a func-
tion of the prover line pressure and plenum constant.

The plenum constant depends on the size of the Emerson/Brooks compact prover:

Prover Size Plenum Constant


8 inch 3.5
12 inch Mini 3.2
12 inch Standard 3.2
18 inch 5.0
24 inch 5.88
34 inch 3.92
40 inch 4.45

The Plenum Pressure is calculated as follows using the user-entered Plenum Constant:

Calculated Plenum Pressure = (Prover Pressure / Plenum Constant) + Pressure Constant

Example 1 (psig units liquid applications):


(300.0 / 3.2) + 60 = 153.8 psig
where:
300.0 is the prover pressure in psig
3.2 is the user-entered Plenum Constant for a 12-inch prover
60 is the Pressure Constant in psig

Example 2 (kPa units liquid applications):


(2068.427 / 3.2) + 413.68542 = 1060.069 kPa
where:

245
OMNICOM: Plenum Pressure Setup

2068.427 is the prover pressure in kPa


3.2 is the user-entered Plenum Constant for a 12-inch prover
413.68542 is the Pressure Constant in kPa

Example 3 (bar units liquid applications):


(20.7 / 3.2) + 4.1368542 = 10.6 bar
where:
20.7 is the prover pressure in bar
3.2 is the user-entered Plenum Constant for a 12-inch prover
4.1368542 is the Pressure Constant in bar

Example 4 (kg/cm2 units liquid applications):


(21.092 / 3.2) + 4.2184173 = 10.80967 kg/cm2
where:
21.092 is the prover pressure in kg/cm2
3.2 is the user-entered Plenum Constant for a 12-inch prover
4.2184173 is the Pressure Constant in kg/cm2

Plenum Deadband %

The Emerson/Brooks compact prover requires that the plenum chamber pressure be maintained
within certain limits. The flow computer calculates the correct plenum pressure at the beginning of
each prove sequence and will charge or vent nitrogen until the measured plenum pressure is within
the specified deadband %. Until this is correct, the prove sequence will not continue.

Ensure that you allow sufficient time in the Inactivity Timer entry to accommodate the time required
to stabilize the plenum pressure.

The flow computer compares the calculated Plenum Pressure to the actual Plenum Pressure read-
ing. The following formula is used to determine if the result is within the user-entered allowable dead-
band percent:

Calculated Plenum Pressure - Actual Plenum Pressure


---------------------------------------------------------------------- x 100% = X
Calculated Plenum Pressure

If the result (absolute value of X) is not within the deadband percent, the flow computer will
use the vent and charge commands to bring the actual plenum pressure reading within tol-
erance before sending the command to launch the piston.

When the result is less than (<) the user-entered Deadband %, then the Plenum Pressure
adjustment stops and the piston launches.

When the result is greater than or equal to (>=) the user-entered Deadband % and the Cal-
culated Plenum Pressure is greater than (>) the Actual Plenum Pressure,
Charge command (1925) = 1
Vent command (1926) = 0

When the result is greater than or equal to (>=) the user-entered Deadband % and the Cal-
culated Plenum Pressure is less than (<) the Actual Plenum Pressure,

246
OMNICOM: Plenum Pressure Setup

Charge command (1925) = 0


Vent command (1926) = 1

Related Modbus Registers:


1925 - Plenum Charge Required
1926 - Plenum Vent Required
7907 - Prover Plenum Pressure
7911 - Calculated Plenum Pressure

247
OMNICOM: Switch Bar Temperature

Switch Bar Temperature


The Switch Bar Temperature is an input used to compensate the temperature of the detector switch
bar on pulse interpolation unidirectional pipe/compact provers such as Enraf's Calibron. The tem-
perature value read goes into the OMNI's Ambient temperature variable (register 7917). (Available
with firmware versions 20.74.30, 22.74.30, 24.74.30, and 26.74.30 and higher.)

OMNICOM provides independent settings for the prover such as setting alarm limits and transducer
overrides to be used in the event of a transducer failure. You can set zero and span values for analog
transducers as well as enter the calibration coefficients. Once you enter the information and/or make
your selections, press the [Apply] button to set.

Note: The majority of this information is view only, to edit these settings you must go to the OMNI
I/O and modify the Process I/O settings of the individual I/O modules.

Settings
The items listed below are descriptions of each setting option within the Prover Switch Bar Tem-
perature dialog. Click on a setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the Switch Bar Temperature
signal for the prover.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Type: (1) When using Rtd probes which follow the DIN curve and have an alpha of 0.00385.
(2) When using Rtd probes which follow the American curve and have an alpha of 0.00392.
(3) When using a smart transmitter connected to an 'H' combo module or when using a trans-
ducer that provides a linear 4-20mA output.

Setup

Override Code: This entry determines the strategy to be used regarding the "Temperature
Override Value'.

Override Value: This is the temperature value that will be substituted for the transducer
value depending on the 'Override Code' selection.

Zero Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 4 milliamperes
or 1 volt.

248
OMNICOM: Switch Bar Temperature

Full Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 20 mil-
liamperes or 5 volts.

Alarm Limits

Low: The low alarm activates when the temperature drops below this value.

High: The high alarm activates when the temperature rises above this value.

249
OMNICOM: Density/Gravity

Density/Gravity
The prover densitometer or gravitometer depending on the application is used to calculate the mass
of liquid in the prover during a mass proving run. (ie. Coriolis meter proving) Digital densitometers
can be corrected for temperature and pressure effects using the station pressure and temperature
points.

Topics
Below are the areas used to configure the OMNI Prover Density/Gravity Setup. Click on a link to go
to that topic.

Configuration
Setup
Pressure
Temperature
Micro Motion (Solartron)
Thermo Scientific (Sarasota)
Ametek (UGC)

250
OMNICOM: Density/Gravity Configuration

Density/Gravity Configuration
OMNICOM provides independent settings for the Prover, such as configuration and signal type of
the Densitometer / Gravitometer. Once you enter the information and/or make your selections,
press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Prover Density/Gravity dia-
log. lick on the setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the Density signal for the
prover.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Density/Gravity Type

Select the type of signal used with the densitometer or gravitometer connected to your OMNI. Avail-
able options are:

No Type Selected: No densitometer is selected and raw input will be used

4-20 API Linear: When output is a 4-20mA signal linear with API gravity units.

4-20 SG Linear: When output is a 4-20mA signal linear with SG units. (Many API devices are
actually designed to drive non-linear chart recorders. These are usually linear with SG units)

4-20 Density Linear: When output is a 4-20mA signal linear with g/cc density units

Micro Motion (Solartron) Pulse: When using a Micro Motion (Solartron) digital pulse type
densitometer.

Thermo Scientific (Sarasota) Pulse: When using a Thermo Scientific (Sarasota) digital
pulse type densitometer.

Ametek (UGC) Pulse: When using a Ametek (UGC) digital pulse type densitometer.

251
OMNICOM: Density/Gravity Setup

Density/Gravity Setup
The Density/Gravity setup is for entering and selecting the Density / Gravity transmitter scaling val-
ues and override strategy settings for the prover. These dialogs are available in OMNICOM only if
you select 'density/gravity' as prover equipment in the Equipment List dialog tab of the OMNI Gen-
eral Setup. Once you enter the information and/or make your selections, press the [Apply] button to
set.

Settings
The items listed below are descriptions of each setting option within the Meter Run Density/Gravity
dialog. Click on a setting for more information.

Alarm Limits

Low: The low alarm activates when the density/gravity at the densitometer or gravitometer
drops below this value.

High: The high alarm activates when the density/gravity or gravitometer rises above this
value.

Setup

Override Code: This entry determines the strategy to be used regarding the 'Density/Gravity
Override Value'. Important: Each specific product can be configured to use an override
whenever that product is run. In this case the (0)- Never use (1)- Always use (2)- Use override
on transmitter fail (3)- On transmitter fail use last hours average (4)- On Transmitter fail use
station transmitter. (5)- On transmitter fail use product override

Override Value: This is the density/gravity value that will be substituted for the transducer
value depending on the 'Override Code' selection. Note: Each product setup can specify an
override to be used whenever that product is run.. The override in the product setup area over-
rides any transducer override.

Zero Scale: This entry is used to determine the Input at Zero Scale (4 mA or 1V)

Full Scale: This entry is used to determine the Input at Full Scale (20 mA or 5 V).

Density Correction Factors

The densitometer factor is used to correct for minor calibration shifts of the densitometer. This factor
is determined by checking the density reading versus the actual density measured using a pycno-
meter.

For liquid application firmware you may enter an 'A' and 'B' correction factor for each densitometer.
The actual factor used depends on a selection in the product setup area.

252
OMNICOM: Density/Gravity Setup

253
OMNICOM: Prover Density - Micro Motion (Solartron) Liquid

Prover Density - Micro Motion (Solartron) Liquid


The Micro Motion (Solartron) / Liquid dialog is for entering the various Micro Motion (Solartron) liquid
densitometer constants. This dialog is available only if you select 'Micro Motion (Solartron) Dens-
ity Pulse' as the signal type in the Prover Density Configuration dialog. Once you enter the inform-
ation and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Micro Motion (Solartron) /
Liquid dialog. Click on the setting for more information.

Micro Motion (Solartron) Liquid Densitometer Constants

Densitometer calibration constants are supplied on a calibration


certificate supplied by the densitometer manufacturer.

For English Applications:


They are usually based on SI or metric units. You must ensure that
the constants entered are based on g/cc, degF, and PSIG.

For Metric applications:


CAUTION: The calibration certificates are usually based on kg/m3, degC and Bar.

The OMNI requires that they be expressed in terms of degC and what ever pressure unit has been
selected K0, K1, K2, K18, K19 can be entered as supplied on the calibration sheet.

When kPA pressure unit are used:


K20A and K21A must be divided by 100 to convert the bar based calibration to kPa
based units.
K20B and K21B must be divided by 10000 to convert the bar based calibration to kPa
based units.

Micro Motion (Solartron) CALIBRATION CERTIFICATE CONSTANTS CONVERSION

Constant Certificate Value (Metric) Conversion Formula U.S. Value

Constant Certificate Value (Metric) Conversion Formula U.S. Value


K0 -1.26779E+03 K0 / 1000 -1.26779E+00
K1 -2.85487E-01 K1 / 1000 -2.85487E-04
K2 1.29347E-03 K2 / 1000 1.29347E-06
K18 -2.09900E-05 K18 / 1.8 -1.16611E-05
K19 3.80900E-04 (K19 / 1.8) / 1000 2.11611E-07
K20A 1.18100E-05 K20A / 14.504 8.14258E-07
K20B -1.00700E-06 K20B / (14.504 x 14.504) -4.78689E-09

254
OMNICOM: Prover Density - Micro Motion (Solartron) Liquid

K21A 1.70300E-02 (K21A / 14.504) / 1000 1.17416E-06


K21B -1.45300E-03 (K21B / (14.504 x 14.504)) / 1000 -6.90701E-09

Formulas convert kg/m3 to g/cc using degF and psig.

255
OMNICOM: Prover Density - Thermo Scientific (Sarasota) Pulse

Prover Density - Thermo Scientific (Sarasota)


Pulse
The Thermo Scientific (Sarasota) dialog is for entering the various Thermo Scientific (Sarasota)
densitometer constants. This dialog is available only if you select 'Thermo Scientific (Sarasota) Dens-
ity Pulse' as the signal type in the Prover Density Configuration dialog. Once you enter the inform-
ation and/or make your selections, press the [Apply] button to set.

Settings
The item listed below is a description of the setting option within the Thermo Scientific (Sarasota)
Densitometer subcategory dialog. Click on the setting for more information.

Thermo Scientific (Sarasota) Densitometer Constants

Enter the densitometer calibration constants supplied by the


manufacturer.

For English Liquid applications:


Enter the calibration constants based on g/cc, degF and PSIG.

For application 23:


Constants must be entered in terms of Lb/Ft3, degF and PSI.

For Metric applications:


Enter the calibration constants based on kg/m3, degC and pressure units which match the selected
pressure unit of the flow computer (see 'Factor Setup' menu).

256
OMNICOM: Prover Density - Ametek (UGC) Pulse

Prover Density - Ametek (UGC) Pulse


The Ametek (UGC) dialog within the is for entering the various Ametek (UGC) densitometer con-
stants. This dialog is available only if you select 'Ametek (UGC) Density Pulse' as the signal type in
the Prover Density Configuration dialog. Once you enter the information and/or make your selec-
tions, press the [Apply] button to set.

Settings
The items listed below are links to descriptions of each setting option within the Ametek (UGC) dia-
log. Click on a link to go to that setting's description.

Ametek (UGC) Densitometer Constants

Enter the densitometer calibration constants supplied by the


manufacturer.

For English Liquid applications:


Enter the constants based on g/cc, degF and PSIG.

For Application 23:


Constants must be entered in terms of Lb/Ft3, degF and PSI.

For Metric Applications:


Enter the constants based on kg/m3, degC and pressure units which match the pressure unit selec-
ted in the 'Factor Setup' menu.

257
OMNICOM: Density/Gravity Temperature

Density/Gravity Temperature
OMNICOM provides independent settings for the prover such as setting alarm limits and transducer
overrides to be used in the event of a transducer failure when using a densitometer. You can set
zero and span values for analog transducers as well as enter the calibration coefficients for digital
densitometers. Once you enter the information and/or make your selections, press the [Apply] but-
ton to set.

Note: The majority of this information is view only, to edit these settings you must go to the OMNI
I/O and modify the Process /O settings of the individual I/O modules.

Settings
The items listed below are descriptions of each setting option within the Meter Density/Gravity Tem-
perature dialog. Click on a setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the Density Temperature sig-
nal for the prover.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Type: (1) When using Rtd probes which follow the DIN curve and have an alpha of 0.00385.
(2) When using Rtd probes which follow the American curve and have an alpha of 0.00392.
(3)When using a smart transmitter connected to an 'H', 'HV' or 'SV' combo module or when
using a transducer that provides a linear 4-20mA output.

Setup

Override Code:This entry determines the strategy to be used regarding the 'Density Tem-
perature Override Value'.

Override Value: This is the temperature value that will be substituted for the transducer
value depending on the 'Override Code' selection.

Zero Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 4 milliamperes
or 1 volt.

Full Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 20 mil-
liamperes or 5 volts.

258
OMNICOM: Density/Gravity Temperature

Alarm Limits

Low: The low alarm activates when the temperature at the densitometer drops below this
value.

High: The high alarm activates when the temperature at the densitometer rises above this
value.

259
OMNICOM: Density/Gravity Pressure

Density/Gravity Pressure
OMNICOM provides independent settings for the prover such as setting alarm limits and transducer
overrides to be used in the event of a transducer failure when using a densitometer. You can set
zero and span values for analog transducers as well as enter the calibration coefficients for digital
densitometers. Once you enter the information and/or make your selections, press the [Apply] but-
ton to set.

Note: The majority of this information is view only, to edit these settings you must go to the OMNI I/O
and modify the Process I/O settings of the individual I/O modules.

Settings
The items listed below are descriptions of each setting option within the Meter Density/Gravity Pres-
sure dialog. Click on a setting for more information.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the Density Pressure signal for
the prover.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Setup

Override Code: This entry determines the strategy to be used regarding the 'Density Pres-
sure Override Value'.

Override Value: This is the pressure value that will be substituted for the transducer value
depending on the 'Override Code' selection.

Zero Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 4 milliamperes
or 1 volt.

Full Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 20 mil-
liamperes or 5 volts.

Alarm Limits

Low: The low alarm activates when the pressure at the densitometer drops below this value.

High: The high alarm activates when the pressure at the densitometer rises above this value.

260
OMNICOM: Density/Gravity Pressure

261
OMNICOM: Products

Products
In the Products dialogs you can enter and select various meter run configuration settings for up to 32
products (see note). OMNICOM makes available only those dialogs that apply to your meter run con-
figuration.

*Note: The number of products increased from 16 to 32 for firmware versions 20.75.10 and 24.75.10
and higher.

Product
Firmware Versions 20 and 21
Measurement Algorithm
Setup
Firmware Version 22
Measurement Algorithm
Setup
Meter Factor Curve
Firmware Version 24
Measurement Algorithm
Setup
Firmware Version 26
Measurement Algorithm
Setup
Meter Factor Curve

Import/Export Products
Product Configuration files can be imported or exported for Applications 20 and 24 if the Advanced
User command line switch "-AU" is enabled. If you need help adding a command line switch, please
speak with your IT representative.

After the command line switch is enabled, access the import/export feature by right-clicking on a
product in the Configuration Tree or on the Product Screen in configuration. Files are defaulted to
the extension: "*. oXXprd" where XX is the application (20, 24), however the user may enter any
extension.

Files may be imported only when offline and may be exported while online or offline.

262
OMNICOM: Product

Product
The Product dialog is for entering product/customer name and selecting the corresponding Meter
and density correction factors. Once you enter the information and/or make your selections, press
the [Apply] button to set.

Settings
The items listed below are the settings covering each dialog within the Product dialog. Click on the
setting for more information.

Product Name

Eight character ASCII string which describes product name.

Numeric Product Name (available with firmware version 20.75.10 and 24.75.10 and
higher)

32-bit integer which describes product name.

Meter Factors (only applies to applications 20 and 24)

This is the meter factor to be used by this flowmeter whenever this product is flowing. This factor will
be automatically updated whenever a meter factor is changed due to a manual entry or an automatic
implementation after a successful prove sequence. Only meters configured with a valid I/O point are
enabled.

Density Factor to use when running this Product

The calibration of some densitometer devices varies with the product. Select which of the two dens-
itometer correction factors A or B that you wish to be applied when running this product. (Note: the
DCFs are entered in the Meter Run Density Setup screen and the Station Density Setup Screen.)

In firmware versions 20.74.30, 22.74.30, 24.74.19 and 26.74.10, an additional option is available to
enter the Meter run densitometer and Station densitometer DCFs for each product for applications
where each product would require a unique DCF. The DCFs are enabled for meters that have a
density type densitometer assigned.

Import/Export Products
Product Configuration files can be imported or exported for Applications 20 and 24 if the Advanced
User command line switch "-AU" is enabled. If you need help adding a command line switch, please
speak with your IT representative.

263
OMNICOM: Product

After the command line switch is enabled, access the import/export feature by right-clicking on a
product in the Configuration Tree or on the Product Screen in configuration. Files are defaulted to
the extension: "*. oXXprd" where XX is the application (20, 24), however the user may enter any
extension.

Files may be imported only when offline and may be exported while online or offline.

Note: the Product Meter Factors are 32-bit integers with an implied decimal place that is configured
in the General Setup Decimal Resolution (Meter Factor on Batch Report). If the decimal resolution
changes between importing and exporting, the meter factors will have to be corrected for each
product.

264
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

Measurement Algorithm (Firmware Versions 20


and 21)
Select the calculation standards to use when running this product. Selecting a standard auto-
matically causes the flow computer to use the appropriate companion standards to calculate density
or specific gravity (SG) at reference conditions.

i.e.selecting Table 24A causes the flow computer to use Table 23A to calculate reference relative
density at 60 degF. API MPMS Chapter 11.2.1 is used in this case to calculate the pressure com-
pressibility factor 'F' which is used to calculate the pressure correction factor 'CPL'.

Once you enter the information and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are the settings covering each dialog within the Measurement Algorithm Tab.
Click on the setting for more information.

API MPMS Chapter 11.1 (1980 edition)


Table 23A/24A (Table Select = 0)

Table 23A Generalized Crude Oils & JP-4 Aviation Fuel

Table 23A converts observed relative density at observed temperature to relative density at base
conditions (SG at 60 degF). The range of the algorithm is:

Relative Density (SG) Temperature, degF


0.6110 to 0.7795 0 to 200
0.7800 to 0.8250 0 to 250
0.8255 to 1.076 0 to 300

The relative density at base conditions (SG60) will be left at the last calculated value if the input
observed relative density (SG), or observed temperature is out of range of the algorithm.

The API table limits for 23A are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 24A Generalized Crude Oils & JP-4 Aviation Fuel

Table 24A calculates the correction for temperature on the liquid 'CTL' based on relative density at
base conditions (SG60) and observed temperature.
The Range of the application is:

265
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

Relative Density (SG) Temperature, degF


0.6110 to 0.7795 0 to 200
0.7795 to 0.8250 0 to 250
0.8250 to 1.076 0 to 300

If the relative density at base conditions (SG60) or the observed temperature is out of range, the
'CTL' correction factor will be left at the last calculated value. 'CTL' defaults to 1.0000 at program
startup.

Table 23B/24B (Table Select = 1)

Table 23B Refined Products

Table 23B converts 'observed relative density' (SG) at 'observed temperature' to 'relative density at
base conditions' (SG60F).
The range of the algorithm is:

Relative Density Temperature, degF


0.6535 to 0.7795 0 to 200
0.7800 to 0.8250 0 to 250
0.8255 to 1.0760 0 to 300

Product Name Relative Density Range


Gasolines and Napthens 0.6535 to 0.7790
Jet Fuels, Kerosenes and Solvents 0.7795 to 0.8395
Diesel, Heating Oil and Fuel Oils 0.8400 to 1.076

The relative density at base conditions (SG60) will be left at the last calculated value if the input
observed relative density (SG), or observed temperature is out of range of the algorithm.

The API table limits for 23B are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 24B Refined Products

Table 24B calculates the correction for temperature on the liquid 'CTL' based on relative density at
base conditions (SG60) and observed temperature.
The Range of the application is:

Relative Density Temperature, degF


0.6535 to 0.7795 0 to 200
0.7800 to 0.8250 0 to 250
0.8255 to 1.0760 0 to 300

266
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

If the relative density at base conditions (SG60) or the observed temperature is out of range, the
'CTL' correction factor will left at the last calculated value. 'CTL' defaults to 1.0000 at program star-
tup.

Table 24C (Table Select = 2)

Special Applications
The range of the algorithm is:

Alpha Temperature, degF


530 to 930
(1860) 0 to 200
x10 -6
510 to 530 x10-6 0 to 250
(135)
0 to 300
270 to 510 x10-6

Values in red are extensions to the original algorithm limits.

If the Alpha Factor or Temperature is out of range, the Volume Correction Factor (CTL) will be left at
the last calculated value. The CTL value is initialized to 1.0000 at program startup.

Crude Oil Historical Tables (API 2540/ASTM D1250 1952 edition)


Table 23/24 (Table Select = 12)

The crude oil section of the historical 1952 tables is supported:

Table 23:

Relative Density (SG) Temperature, degF


0.600 to 1.095 0 to 300

Table 24:

Relative Density Temperature, degF


0.600 to 1.1 0 to 300

If the relative density or temperature is out of range the last known good value for Specific Gravity
@60 or CTL is used.

Table 5/6 (Table Select = 36, Available with firmware versions 20.75.03 and higher)

The crude oil section of the historical 1952 tables is supported:

267
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

API Gravity @60 degF Temperature, degF


0 to 300 0.0 to-100.0

Table 5

ASTM D 1250 (1952) Table 5 calculates the values of API gravity at 60 degF corresponding to API
gravities observed with a glass hydrometer at temperatures other than 60 degF if a negative API
gravity override is entered.

The firmware shall use the last known good value for API at 60 degF when one of the following con-
dition occurs:
API gravity is less than 0.0.
API gravity is greater than 100.0.
Density/Gravity temperature is less than 0.0 degF.
Density/Gravity temperature is greater than 250.0 degF for API gravity between 0 and 29.
Density/Gravity temperature is greater than 200.0 degF for API gravity between 29.01 and
49.
Density/Gravity temperature is greater than 150.0 degF for API gravity between 49.01 and
100.

If there is no value in Table 5 for the API or the observed temperature, a calc out of range alarm is
raised and the last known good value for API at 60 degF is used.

Table 6

ASTM D 1250 (1952) Table 6 is used to calculate the factors for converting oil volumes observed at
temperatures other than 60 degF to the corresponding volumes at 60 degF for values of API gravity
at 60 degF in the range of 0 to 100 if a positive API override is entered or API at 60 degF is calculated
using Table 5.

The firmware shall set the calculation out of range alarm when one of the following condition occurs:
API gravity at 60 degF is less than 0.0.
API gravity at 60 degF is greater than 100.0.
Meter temperature is less than 0.0 degF.
Meter temperature is greater than 300.0 degF for API gravity at 60 degF between 0 and 19.
Meter temperature is greater than 250.0 degF for API gravity at 60 degF between 19.01 and
29.
Meter temperature is greater than 200.0 degF for API gravity at 60 degF between 29.01 and
39.
Meter temperature is greater than 150.0 degF for API gravity at 60 degF between 39.01 and
100.

The Volume Correction Factor (VCF) is left at the last calculated value if one of the above alarm con-
ditions occurs.

API 11.2.1 is used to calculate the F Factor and then calculate the CPL (pressure correction factor).
The equilibrium pressure is set to zero.

268
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

Note: API 11.2.1 and API 11.2.2 have limits when calculating the F Factor used in the CPL cal-
culation:

API 11.2.1

Relative Density (SG) Temperature, degF


-20 to 350 for Application 20
1.076 to 0.638
-20 to 200 for Application 21

Values in red are extensions to the original algorithm limit of 200 degF.

Note: The flow computer generates a calculation out of range alarm when the temperature exceeds
350 degF for Application 20.

API 11.2.2

Relative Density (SG) Temperature, degF


0.637 to 0.350 -50 to 140

If the temperature or relative density is out of range of the algorithm the 'F' factor will be left at the last
known good value calculated.

Note: If the relative density is between 0.638 and 0.637, the F Factor is calculated using linear inter-
polation between API 11.2.1 and API 11.2.2.

LPGs and NGLs


GPA TP16 (Table Select = 3)

TP16 - Live Density/Gravity

Note: TP16 is obsolete and has been replaced with API 11.2.4,23E/24E. It may still be appropriate
to use this algorithm if existing contracts mandate its use.

When flowing density or gravity is provided, the relative density at base temperature (SG60) is
determined using historical table 23 or algorithm 23A depending upon the following limits.

Table 23

Relative Density (SG) Temperature, degF


0.425 to 0.6535 -50 to 140

Table 23A

Relative Density Temperature, degF


0.6535 to 0.700 -50 to 140

269
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

Table details: Specific Gravity Increment is .005

Temperature Increment is 1.0 degF

Specific Gravity is rounded to .xxxx


Temperature is rounded to xxx.x

Note: If the Relative Density or temperature is out of Table Range, the relative density at base
(SG60) is set to the table edge value. If the lookup table produces a zero value, the relative density
(SG60) is left at the last known good value. If the density or temperature is between table bound-
aries, an interpolation between the tables is made.

TP16 - Fixed Gravity at Base

The CTL factor is determined by a table lookup of historical table 24 or algorithm 24A depending
upon the following limits:

Table 24

Relative Density (SG) Temperature, degF


0.500 to 0.650 -50 to 140

Table 24A

Relative Density (SG) Temperature, degF


0.655 to 0.700 -50 to 140

Table details: Relative Density Increment is .005**


Temperature Increment is 1.0 degF

** TP16 adds an additional column to the historical table 24 at SG 0.507 by interpolation of table 24.
This was done to accommodate 507 Propane.

Input: Specific Gravity @60 is rounded to .xxxx


Temperature is rounded to xxx.x

Output: VCF (volume correction factor) (also known as CTL)

Note: If the relative density (SG60) or temperature is out of Table Range, the CTL value will be set
to the table edge value.

Pressure Compensation

Pressure correction factor CPL is calculated as follows:

CPL = 1 / ( 1- [ P - Pe] x F )

270
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

The compressibility factor 'F' is calculated by either API 11.2.1 or API 11.2.2 depending upon rel-
ative density at base temperature (SG60).

API 11.2.1

Relative Density (SG) Temperature, degF


-20 to 350 for Application 20
1.076 to 0.638
-20 to 200 for Application 21

Values in red are extensions to the original algorithm limit of 200 degF.

Note: The flow computer generates a calculation out of range alarm when the temperature exceeds
350 degF for Application 20.

API 11.2.2

Relative Density Temperature, degF


0.637 to 0.350 -50 to 140

If the temperature or relative density is out of range of the algorithm the 'F' factor will be left at the last
known good value calculated.

Note: If the relative density is between 0.638 and 0.637, the F Factor is calculated using linear inter-
polation between API 11.2.1 and API 11.2.2.

Equilibrium Pressure Pe

Is calculated using API 11.2.5(GPA TP15 extended) equilibrium pressure correlation.

API 11.2.5

Relative Density Temperature, degF


0.676 to 0.350 -50 to 140~

The upper limit of 140 degF cannot be reached when product relative densities at 60 degF are below
0.430. Refer to API 11.2.5 to estimate the upper temperature limit.

API 11.2.4,23E/24E(GPA TP27) (Table Select = 15)

This standard supersedes the 1988 GPA TP16 standard and consists of the following fluid types:

Ethane/Ethylene - 68 mole% Ethane/32 mole% Ethylene


Ethane
Ethane/Propane - 65 mole % Ethane/35 mole % Propane
Ethane/Propane - 35 mole % Ethane/65 mole % Propane
Propane
iso-Butane
normal-Butane

271
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

iso-Pentane
normal-Pentane
iso-Hexane
normal-Hexane
normal-Heptane

Table 23E - Convert Relative Density at observed temperature and pressure to relative
density (SG60) at base temperature and pressure conditions

The range of table 23E is:

Relative Density Temperature, degF


0.2100 to 0.7400 -50.0 to 200.0

The relative density at base conditions (SG60) is set to 0.00 and the 'Calc out of Range' error flag is
raised if the observed Relative Density or temperature is out of range.

Table 24E - Calculate the CTL correction factor given relative density at base conditions
(SG60) and observed temperature

The algorithm limits are:

Relative Density at Base (SG60) Temperature, degF


0.3500 to 0.6880 -50.0 to 200.0

The 'Calc out of Range' error flag is raised and the CTL factor is left at the last known good value if
either the relative density at base conditions (SG60) or the observed temperature is out of limits. The
CTL is initialized at 1.0000 at program startup.

Pressure Compensation

Pressure correction factor CPL is calculated as follows:

CPL = 1 / ( 1- [ P - Pe]xF )

The compressibility factor 'F' is calculated by either API 11.2.1 or API 11.2.2 depending upon rel-
ative density at base temperature (SG60)

API 11.2.1

Relative Density Temperature, degF


-20 to 350 for Application 20
1.076 to 0.638
-20 to 200 for Application 21

Values in red are extensions to the original algorithm limit of 200 degF.

Note: The flow computer generates a calculation out of range alarm when the temperature exceeds
350 degF for Application 20.

272
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

API 11.2.2

Relative Density Temperature, degF


0.637 to 0.350 -50 to 140

If the temperature or relative density is out of range of the algorithm the 'F' factor will be left at the last
known good value calculated.

Note: If the relative density is between 0.638 and 0.637, the F Factor is calculated using linear inter-
polation between API 11.2.1 and API 11.2.2.

Equilibrium Pressure Pe

Is calculated using API 11.2.5(GPA TP15 extended) equilibrium pressure correlation.

API 11.2.5

Relative Density Temperature, degF


0.676 to 0.350 -50 to 140~

NGL (Table Select = 40, Available with firmware versions 20.74.14 and higher and
only for Products 1 and 2)

This algorithm is used to measure NGLs, and Crude Oils spiked with significant quantities of NGL. It
is based on API's Table 23A and 24A Crude Oil algorithm with manual entries of coefficients K0 and
K1 (see 'Product Setup' tab). The lower relative density (SG) limits of Table 23A and 24A are also
extended to accommodate the lower relative density NGL components.

'Table 23A Modified' - NGLs and NGL Spiked Crude Oil

Table 23A converts observed Relative Density at observed temperature to relative density at base
conditions (SG at 60 degF). The range of the algorithm is:

Relative Density Temperature, degF


0.6110 to 0.7795 0 to 200
0.7800 to 0.8250 0 to 250
0.8255 to 1.076 0 to 300

If the 'observed relative density' is out of range, the 'relative density at base conditions'
remains at the last calculated value.
Calculations continue below temperatures of 0 degF. but the 'Calc out of Range' alarm will be
set.
The 'relative density at base conditions' is not updated when the 'observed temperature'
exceeds the table limits.

'Table 24A Modified' - NGLs and NGL Spiked Crude Oils

273
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

'Table 24A Modified' calculates the correction for temperature on the liquid 'CTL' based on 'Relative
Density at base conditions', and 'observed temperature'.
The range of the application is:

Relative Density Temperature, degF


0.6110 to 0.7795 0 to 200
0.7795 to 0.8250 0 to 250
0.8250 to 1.076 0 to 300

If the 'observed relative density' is out of range, the 'CTL' remains at the last calculated value.
Calculations continue below temperatures of 0 degF., the 'Calc out of Range' alarm will be
set.
The 'CTL' is not updated when the 'observed temperature' exceeds the table limits.

Ethane/Propane and Propane/Propylene Mixes


GPA RR133 EP Mix (Table Select = 6)

This algorithm has been replaced by API 11.2.4,23E/24E(GPA TP27). The algorithm is based on
GPA RR133 with program improvements designed to eliminate unexpected results which could
occur when using the published report under certain operating conditions. The algorithm was meant
for use with limited binary mixtures only and has a range of:

Relative Density
0.350 to 0.676

A convergent routine is used to determine relative density at base conditions (SG60) given
observed Relative Density, temperature and pressure.
The relative density at base conditions (SG60) is left at the last know good calculated value
should the algorithm fail to converge in 20 loops.
Temperature correction factor CTL, pressure correction CPL, equilibrium pressure Pe, and
compressibility factor F are also not updated if the algorithm fails to converge or any variable is
out of range.

P/P Mix (Table Select = 7)

This algorithm uses a combination of GPA TP16 and API 11.3.3.2 to measure binary mixtures of pro-
pane and propylene. Based on observed Relative Density, temperature and pressure, and using an
empirical lookup table, the algorithm determines the relative fractions of propane and propylene. The
correction factors and relative densities at base conditions for each of these fractions are then indi-
vidually determined using either GPA TP16 or API 11.3.3.2. The composite factors and densities are
then calculated according to the relative fractions of propane and propylene. The algorithm range is:

Relative Density
0.507 to 0.580

274
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

Correction factors CTL and CPL, equilibrium pressure Pe, and compressibility factor F are left at the
last known good value, should any input variable be out of range of the stated limits of this algorithm,
or the underlying algorithms used by it.

Mass Calculation
Mass Calculation (Table Select = 4)

Use this algorithm when a flowing density is available and there is no known algorithm to correct for
temperature or pressure effects on the liquid.

Gross (IV) = Volume Pulses / K-Factor

Net (GSV) = Gross (IV) x CTL x CPL x MF

Mass = Gross (IV) x Flowing Density x MF

CPL is set to 1.0000.

CTL = Flowing Density / Base Density

Base or Reference Density is the 'absolute' value entered at the 'Product Setup' tab.

Butadiene and Butadiene Concentrations


ASTM D1550 (Table Select = 13)

These tables are applicable to both Butadiene and Butadiene concentrates (minimum of 60%
Butadiene).

The ASTM 1550 standard provides two tables:

Table 1 is used to convert observed Relative Density at observed temperature, to relative density at
base conditions (SG60).
The table limits are as follows:

Relative Density Temperature, degF


0.585 to 0.615 65.0 to 110.0
0.620 to 0.650 15.0 to 85.0
0.655 to 0.675 -10.0 to 30.0

Table 2 is used to calculate the correction factor for temperature on a liquid 'CTL' at observed tem-
perature.
The table limits are as follows:

Relative Density at
Temperature, degF
Base Conditions (SG60)

275
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

0.621 to 0.634 -10.0 to 110.0

If the relative density is out of the table range, the nearest table edge value is used and the
'Calc Out of Range' alarm is raised.
If the temperature value is out of the table range the nearest table edge value is used and the
'Calc Out of Range' alarm is raised.
If the table lookup provides a zero value the previous value will be returned and the 'Calc out
of Range' alarm is raised.

Aromatic Hydrocarbons
ASTM D1555 (Table Select = 14)

Algorithm range: -5 to 150 degF.

ASTM D1555 consists of 11 different CTL lookup tables for 11 different aromatic products. When
selecting the ASTM D1555 algorithm, the appropriate CTL table to use is determined by the flow
computer by examining the configured value for SG Override (relative density at base) in the
'Product Setup’ tab.

Because several aromatic products have overlapping densities at base conditions, it is only possible
for the flow computer to automatically determine only 8 of the 11 CTL tables to use for the 11 aro-
matic products. The 8 products are: Cyclohexane, p-Xylene, m-Xylene, o-Xylene, Cumene,
Toluene, Benzene and Styrene. Because of this limitation, the selection of ASTM D1555 algorithm is
not recommended for new installations and users should instead select the algorithm for the indi-
vidual aromatic product being measured. The ASTM D1555 algorithm selection is provided only for
backward compatibility with firmware when this algorithm was first implemented into the flow com-
puter.

Benzene (Table Select = 16)

Use for Benzene, SG entry required.

Algorithm range: 43 to 140 degF.

Cumene (Table Select = 24)

Use for Cumene, SG entry required.

Algorithm range: 5 to 140 degF.

Cyclohexane (Table Select = 22)

Use for Cyclohexane, SG entry required.

Algorithm range: 44 to 140 degF.

Ethylbenzene (Table Select = 23)

276
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

Use for Ethylbenzene, SG entry required.

Algorithm range: 5 to 140 degF.

m-Xylene (Table Select = 18)

Use for m-Xylene, SG entry required.

Algorithm range: 5 to 140 degF.

o-Xylene (Table Select = 20)

Use for o-Xylene, SG entry required.

Algorithm range: 5 to 140 degF.

p-Xylene (Table Select = 21)

Use for p-Xylene, SG entry required.

Algorithm range: 56 to 150 degF.

Styrene (Table Select = 19)

Use for Styrene, SG entry required.

Algorithm range: 15 to 140 degF.

Toluene (Table Select = 17)

Use for Toluene, SG entry required.

Algorithm range: -5 to 140 degF.

Aromatic Hydrocarbon (Boiling Point 300 - 350 degF) (Table Select = 25)

Use for Aromatic Hydrocarbons within the boiling point temperature range 300 - 350 degF, SG entry
required.

Algorithm range: 5 to 140 degF.

Aromatic Hydrocarbon (Boiling Point 350 - 400 degF) (Table Select = 26)

Use for Aromatic Hydrocarbons within the boiling point temperature range of 350 - 400 degF, SG
entry required.

Algorithm range: 5 to 140 degF.

277
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

Olefins
Propylene API 2565/11.3.3.2 (Table Select = 5)

This standard was originally issued and known as subroutine Propyl of API 2565.

Temperature, degF Pressure, PSIA


30 to 165 Psaturation to 1600

The Propylene density is calculated and placed in ' 7n07 ' (equation of state density). The density
value will be left at the last known good value if either the temperature or pressure are out of range,
or if the algorithm can not converge on a solution.

If a densitometer signal is available, mass will be calculated using the live densitometer signal. Mass
will be calculated using the calculated density, if a live densitometer signal is not available.

Note: When this table is selected, the Mole Fraction of Propylene is automatically set to 1.0 to indic-
ate pure propylene. If you are not measuring pure propylene, please go to the Product Setup page
to configure the correct mole fraction for your application.

Ethylene IUPAC (Table Select = 8)

This equation of state was developed in 1988 and is designated IUPAC88.

The equation calculates flowing density and isentropic exponent, given flowing temperature and
pressure.

Because the equation of state will solve for all states (liquid and gas), there are no preset tem-
perature or pressure limits.

If the algorithm fails to converge on a solution within 50 loops the 'Calc out of Range' alarm is set and
the flowing density and isentropic exponent are left at the last known good values.

Ethylene density calculated is placed in ' 7n07 ' (equation of state density).

If a densitometer signal is available, mass will be calculated using the live densitometer signal. Mass
will be calculated using the calculated density, if a live densitometer signal is not available.

Ethylene NIST 1045 (Table Select = 9)

Originally designated NBS 1045, now known as NIST 1045.

Calculates flowing density of Ethylene, given flowing temperature and pressure.

Temperature, degF Pressure, PSIA


-273 to 260 Psaturation to 5800

278
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

The Ethylene density is calculated and placed in ' 7n07 ' (equation of state density). The density
value will be left at the last known good value if either the temperature or pressure are out of range,
or if the algorithm can not converge on a solution.

If a densitometer signal is available, mass will be calculated using the live densitometer signal. Mass
will be calculated using the calculated density, if a live densitometer signal is not available.

Ethylene API 2565/11.3.2 (Table Select = 10)

This standard was originally issued and known as subroutine Ethyl of API 2565.

Temperature, degF Pressure, PSIA


65 to 167 200 to 2100

Shortly after its release, industry found that the original temperature and pressure limits of the
algorithm did not address the needs of the pipeline transportation system in many cases.

The calculations were extended to use any temperature and pressure input values calculate the
Ethylene density. However, the "calc out of range" alarm will be set if the temperature or pressure
input values are out of the published API 11.3.2 algorithm range.

The density value will be left at the last known good value if the algorithm cannot converge on a solu-
tion.

When flowing parameters are within the original algorithm limits, the flow computer is in strict com-
pliance with the original standard.

Ethylene density is calculated and placed in ' 7n07 ' (equation of state density).

If a densitometer signal is available, mass will be calculated using the live densitometer signal. Mass
will be calculated using the calculated density, if a live densitometer signal is not available.

API MPMS 11.1 (2007) Commodity types:


Crude Oil, Refined Products, Lubricating Oil, Special Applications (Table Selects =
28-31, Available with firmware versions 20.74.10 and higher)

Chapter 11.1.6.1

Calculate the Volume Correction Factor (CTPL) for correcting from density at the base conditions
(60 degF and 0 PSIG) to alternate temperature and pressure conditions. The parameters used in
this procedure depends on the commodity group to which the liquid belongs.

The limits of the standard are:

Temperature, Pressure,
Density
degF PSIG
-58.0 to 302.0 0 to 1500 Density @ base conditions minimum to

279
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

Density @ base conditions maximum (if commodity type is


specified)

For Special Applications:

Alpha
230x10-6to 930.0x10-6
(Alpha at 60 degF per degF units)

Product Type Density at Base Conditions Min Density at Base Conditions Max
Crude Oil 610.6 kg/m3 1163.5 kg/m3
Refined Products 610.6 kg/m3 1163.5 kg/m3
Lubricating Oil 800.9 kg/m3 1163.5 kg/m3

K1 coefficients used in these equations depend upon the commodity group. The following table gives
the coefficients to be used.

Product Density, kg/m3 K0 K1 K2


Crude Oil 610.6 to 1163.5 341.0957 0.0 0.0
Fuel Oils 838.3127 to 1163.5 103.8720 0.2701 0.0
Jet Fuels 787.5195 to 838.3127 330.3010 0.0 0.0
Transition Zone 770.3520 to 787.5195 1489.0670 0.0 -0.00186840
Gasolines 610.6 to 770.3520 192.4571 0.2438 0.0
Lubricating Oils 800.9 to 1163.5 0.0 .034878 0.0
Specialized Products - - - -

Other Miscellaneous Fluids


CO2PAC (Table Select = 11)

Uses equation of state called CO2PAC to calculate the density of pure or near pure carbon dioxide.

Algorithm limits are:

Temperature, degF Pressure, PSIA


-260 to 540 0 to 45,000

Flowing density will be left at the last known good value should the equation be unable to converge
on a solution.

Water (Table Select = 27, Available with firmware versions 20.74.10 and higher)

Water density and compressibility are calculated in accordance with API MPMS 11.4.1

The API equation is based on Patterson and Morris.

280
OMNICOM: Measurement Algorithm (Firmware Versions 20 and
21)

The VCF factor combines the corrections for temperature and pressure.
The CPL factor is set to 1.0000

Anhydrous Ammonia (Table Select = 32, Available with firmware versions 20.74.22
and higher)

Temperature range for table is -28.0 degF to +100 degF


If temperature is out of limits, the Calc Out of Range alarm is set but it continues to calculate.

It is recommended that an OMNI flow computer measuring Anhydrous Ammonia be dedicated spe-
cifically to measuring only that fluid and no other fluid due to the unique units of measurement
required to measure Anhydrous Ammonia that will apply globally throughout the flow computer (i.e.,
lbs for prover volume setting, Tons for flow rates and totals, lb/ft3 for flowing density, Tons for flow
rate alarm limits and batch size units, etc.).

281
OMNICOM: Measurement Algorithm (Firmware Version 22)

Measurement Algorithm (Firmware Version 22)


Select the calculation standards to use when running this product. Selecting a standard auto-
matically causes the flow computer to use the appropriate companion standards to calculate density
or specific gravity (SG) at reference conditions. i.e.selecting Table 24A causes the flow computer to
use Table 23A to calculate reference relative density (SG) at 60 degF. API MPMS Chapter 11.2.1 is
used in this case to calculate the pressure compressibility factor 'F' which is used to calculate the
pressure correction factor 'CPL'.

Once you enter the information and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are the settings covering each dialog within the Measurement Algorithm Tab.
Click on the setting for more information.

API MPMS Chapter 11.1 (1980 edition)


Table 23A/24A (Table Select = 0)

Table 23A Generalized Crude Oils & JP-4 Aviation Fuel

Table 23A converts observed relative density at observed temperature to relative density at base
conditions (SG60F). The range of the algorithm is:

Relative Density, (SG) Temperature, degF


0.6110 to 0.7795 0 to 200
0.7800 to 0.8250 0 to 250
0.8255 to 1.0760 0 to 300

The relative density at base conditions (SG60) will be left at the last calculated value if the input
observed relative density (SG), or observed temperature is out of range of the algorithm.

The API table limits for 23A are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 24A Generalized Crude Oils & JP-4 Aviation Fuel

Table 24A calculates the correction for temperature on the liquid 'CTL' based on relative density at
base conditions (SG60) and observed temperature.
The Range of the application is:

Relative Density, (SG) Temperature, degF

282
OMNICOM: Measurement Algorithm (Firmware Version 22)

0.6110 to 0.7795 0 to 200


0.7795 to 0.8250 0 to 250
0.8250 to 1.0760 0 to 300

If the relative density at base conditions (SG60) or the observed temperature is out of range, the
'CTL' correction factor will be left at the last calculated value. 'CTL' defaults to 1.0000 at program
startup.

Table 23B/24B (Table Select = 1)

Table 23B Refined Products

Table 23B converts 'observed relative density' (SG) at 'observed temperature' to 'relative density at
base conditions' (SG60F).
The range of the algorithm is:

Relative Density, (SG) Temperature, degF


0.6535 to 0.7795 0 to 200
0.7800 to 0.8250 0 to 250
0.8255 to 1.0760  0 to 300

Gasolines and Napthens range: 0.6535 to 0.7790


Jet Fuels, Kerosenes and Solvents: 0.7795 to 0.8395
Diesel, Heating Oil and Fuel Oils: 0.8400 to 1.076

The relative density at base conditions (SG60) will be left at the last calculated value if the input
observed relative density (SG), or observed temperature is out of range of the algorithm.

The API table limits for 23B are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 24B Refined Products

Table 24B calculates the correction for temperature on the liquid 'CTL' based on relative density at
base conditions (SG60) and observed temperature.
The Range of the application is:

Relative Density, (SG) Temperature, degF


0.6535 to 0.7795 0 to 200
0.7800 to 0.8250 0 to 250
0.8255 to 1.0760 0 to 300

If the relative density at base conditions (SG60) or the observed temperature is out of range, the
'CTL' correction factor will left at the last calculated value. 'CTL' defaults to 1.0000 at program star-
tup.

283
OMNICOM: Measurement Algorithm (Firmware Version 22)

Table 24C (Table Select = 2)

Table 24C - Special Applications


The range of the algorithm is:

Alpha Temperature degF


530 to 930 (1860) x10-6 0 to 200
510 to 530 x10-6 0 to 250
(135) 270 to 510 x10-6 0 to 300

Values in red are extensions to the original algorithm limits.

If the Alpha Factor or Temperature is out of range, the Volume Correction Factor (CTL) will be left at
the last calculated value. The CTL value is initialized to 1.0000 at program startup.

Table 5A/6A (Table Select = 33, Available with firmware versions 22.75.00 and
higher)

Table 5A Generalized Crude Oils JP-4 Aviation Fuel

Table 5A converts API gravity at observed temperature to API gravity at base conditions (60 degF).
The range of the algorithm is:

API Gravity Temperature, degF


50 to 100 0 to 200
40 to 50 0 to 250
0 to 40 0 to 300

The API gravity at base conditions (60 degF) will be left at the last calculated value if the input
observed API gravity, or observed temperature is out of range of the algorithm.

The API table limits for 5A are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 6A Generalized Crude Oils & JP-4 Aviation Fuel

Table 6A calculates the correction for temperature on the liquid 'CTL' based on API at base con-
ditions (60 degF) and observed temperature.
The Range of the application is:

API Gravity Temperature, degF


50 to 100 0 to 200

284
OMNICOM: Measurement Algorithm (Firmware Version 22)

40 to 50 0 to 250
0 to 40 0 to 300

If the API gravity at base conditions (60 degF) or the observed temperature is out of range, the 'CTL'
correction factor will be left at the last calculated value. 'CTL' defaults to 1.0000 at program startup.

Table 5B/6B (Table Select = 34, Available with firmware versions 22.75.00 and
higher)

Table 5B Refined Products

Table 5B converts API gravity at observed temperature to API gravity at base conditions (60 degF).
The range of the algorithm is:

API Gravity Temperature, degF


50 to 85 0 to 200
40 to 50 0 to 250
0 to 40 0 to 300

The API gravity at base conditions (60 degF) will be left at the last calculated value if the input
observed API gravity, or observed temperature is out of range of the algorithm.

The API table limits for 5B are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 6B Refined Products

Table 6B calculates the correction for temperature on the liquid 'CTL' based on API at base con-
ditions (60 degF) and observed temperature.
The Range of the application is:

API Gravity Temperature, degF


50 to 85 0 to 200
40 to 50 0 to 250
0 to 40 0 to 300

If the API gravity at base conditions (60 degF) or the observed temperature is out of range, the 'CTL'
correction factor will be left at the last calculated value. 'CTL' defaults to 1.0000 at program startup.

Table 6C (Table Select = 35, Available with firmware versions 22.75.00 and higher)

Table 6C - Special Applications


The range of the algorithm is:

285
OMNICOM: Measurement Algorithm (Firmware Version 22)

Alpha Temperature degF


530 to 930 (1860) x 10-6 0 to 200
510 to 530 x 10-6 0 to 250
(135) 270 to 510 x 10-6 0 to 300

Values in red are extensions to the original algorithm limits.

If the Alpha Factor or Temperature is out of range, the Volume Correction Factor (CTL) will be left at
the last calculated value. The CTL value is initialized to 1.0000
at program startup.

Crude Oil Historical Tables (API 2540/ASTM D1250 1952 edition)


Table 23/24 (Table Select = 4)

The crude oil section of the historical 1952 tables is supported:


Table 23:

Relative Density Range Temperature Range


0.600 to-1.095 0 to 300 degF

Table 24:

Relative Density Range Temperature Range


0.600 to 1.1 0 to 300 degF

If the relative density or temperature is out of range, the last known good value for Specific Gravity
@60 or CTL is used.

Table 5/6 (Table Select = 36, Available with firmware versions 22.75.04 and higher)

The crude oil section of the historical 1952 tables is supported:

API Gravity @60 degF range Temperature Range


0.0 to-100.0 0 to 300 degF

Table 5

ASTM D 1250 (1952) Table 5 calculates the values of API gravity at 60 degF corresponding to API
gravities observed with a glass hydrometer at temperatures other than 60 degF if a negative API
gravity override is entered.

The firmware shall use the last known good value for API at 60 degF when one of the following con-
dition occurs:

286
OMNICOM: Measurement Algorithm (Firmware Version 22)

API gravity is less than 0.0.


API gravity is greater than 100.0.
Density/Gravity temperature is less than 0.0 degF.
Density/Gravity temperature is greater than 250.0 degF for API gravity between 0 and 29.
Density/Gravity temperature is greater than 200.0 degF for API gravity between 29.01 and
49.
Density/Gravity temperature is greater than 150.0 degF for API gravity between 49.01 and
100.

If there is no value in Table 5 for the API or the observed temperature, a calc out of range alarm is
raised and the last known good value for API at 60 degF is used.

Table 6

ASTM D 1250 (1952) Table 6 is used to calculate the factors for converting oil volumes observed at
temperatures other than 60 degF to the corresponding volumes at 60 degF for values of API gravity
at 60 degF in the range of 0 to 100 if a positive API override is entered or API at 60 degF is calculated
using Table 5.

The firmware shall set the calculation out of range alarm when one of the following condition occurs:
API gravity at 60 degF is less than 0.0.
API gravity at 60 degF is greater than 100.0.
Meter temperature is less than 0.0 degF.
Meter temperature is greater than 300.0 degF for API gravity at 60 degF between 0 and 19.
Meter temperature is greater than 250.0 degF for API gravity at 60 degF between 19.01 and
29.
Meter temperature is greater than 200.0 degF for API gravity at 60 degF between 29.01 and
39.
Meter temperature is greater than 150.0 degF for API gravity at 60 degF between 39.01 and
100.

The Volume Correction Factor (VCF) is left at the last calculated value if one of the above alarm con-
ditions occurs.

API 11.2.1 is used to calculate the F Factor and then calculate the CPL (pressure correction factor).
The equilibrium pressure is set to zero.

Note: API 11.2.1 and API 11.2.2 have limits when calculating the F Factor used in the CPL cal-
culation:

API 11.2.1

Relative Density (SG) Temperature, degF


1.076 to 0.638 -20 to 200

API 11.2.2

287
OMNICOM: Measurement Algorithm (Firmware Version 22)

Relative Density (SG) Temperature, degF


0.637 to 0.350 -50 to 140

If the temperature or relative density is out of range of the algorithm the 'F' factor will be left at the last
known good value calculated.

Note: If the relative density is between 0.638 and 0.637, the F Factor is calculated using linear inter-
polation between API 11.2.1 and API 11.2.2.

LPGs and NGLs


GPA TP16 (Table Select = 3)

TP16 - Live Density/Gravity

Note: TP16 is obsolete and has been replaced with API 11.2.4,23E/24E. It may still be appropriate
to use this algorithm if existing contracts mandate its use.

When flowing density or gravity is provided, the relative density at base temperature (SG60) is
determined using historical table 23 or algorithm 23A depending upon the following limits.

Table 23
Relative Density Temperature
0.425 to 0.6535 -50 to 140 degF

Table 23A
Relative Density Temperature
0.6535 to 0.700 -50 to 140 degF

Table details: Specific Gravity Increment is 0.005


Temperature Increment is 1.0 degF

Specific Gravity is rounded to .xxxx


Temperature is rounded to xxx.x

Note: If the relative density or temperature is out of Table Range, the relative density at base
(SG60) is set to the table edge value. If the lookup table produces a zero value the relative density
(SG60) is left at the last known good value. If the density or temperature is between table bound-
aries, an interpolation between the tables is made.

TP16 - Fixed Gravity at Base

The CTL factor is determined by a table lookup of historical table 24 or algorithm 24A depending
upon the following limits:

Table 24

288
OMNICOM: Measurement Algorithm (Firmware Version 22)

Relative Density Temperature


0.500 to 0.6500 -50 to 140 degF

Table 24A
Relative Density Temperature
0.655 to 0.700 -50 to 140 degF

Table details: relative density Increment is 0.005**


Temperature Increment is 1.0 degF

** TP16 adds an additional column to the historical table 24 at SG 0.507 by interpolation of table 24.
This was done to accommodate 507 Propane.

Input: Relative Density (SG60) is rounded to .xxxx


 Temperature is rounded to xxx.x

Output: VCF (volume correction factor) (also known as CTL)

Note: If the relative density (SG60) or temperature is out of Table Range , the CTL value will be set
to the table edge value.

Pressure Compensation
Pressure correction factor CPL is calculated as follows:

CPL = 1 / ( 1- [ P - Pe]

The compressibility factor 'F' is calculated by either API 11.2.1 or API 11.2.2 depending upon rel-
ative density at base temperature (SG60).

API 11.2.1
Relative Density Temperature
1.076 to 0.638 -20 to 200 degF

API 11.2.2
Relative Density Temperature
0.637 to 0.350 -50 to 140 degF

If the temperature or relative density is out of range of the algorithm the 'F' factor will be left at the last
known good value calculated.

Note: If the relative density is between 0.638 and 0.637, the F Factor is calculated using linear inter-
polation between API 11.2.1 and API 11.2.2.

Equilibrium Pressure Pe

289
OMNICOM: Measurement Algorithm (Firmware Version 22)

Is calculated using API 11.2.5(GPA TP15 extended) equilibrium pressure correlation.

API 11.2.5
Specific Gravity Temperature
0.676 to 0.350 -50 to 140~ degF

The upper limit of 140 degF cannot be reached when product relative densities at 60 degF are below
0.430. Refer to API 11.2.5 to estimate the upper temperature limit.

API 11.2.4,23E/24E(GPA TP27) (Table Select = 15, Available with firmware versions
22.74.06 and higher)

This standard supersedes the 1988 GPA TP16 standard and consists of the following fluid types:

Ethane/Ethylene - 68 mole% Ethane/32 mole% Ethylene


Ethane
Ethane/Propane - 65 mole % Ethane/35 mole % Propane
Ethane/Propane - 35 mole % Ethane/65 mole % Propane
Propane
iso-Butane
normal-Butane
iso-Pentane
normal-Pentane
iso-Hexane
normal-Hexane
normal-Heptane

Table 23E is used to convert relative density at observed temperature and pressure to relative dens-
ity (SG60) at base temperature and pressure conditions. The range of table 23E is:

Table 23E
Relative Density (SG) Range 0.2100 to 0.7400
Temperature Range degF -50.0 to 200.0

The relative density at base conditions (SG60) is set to 0.00 and the 'Calc out of Range' error flag
raised if observed relative density (SG) or temperature is out of range.

Table 24E is used to calculate the CTL correction factor given relative density at base conditions
(SG60) and observed temperature. The algorithm limits are:

Table 24E
Relative Density at Base (SG60) 0.3500 to 0.6880
Temperature Range degF 50.0 to 200.0

290
OMNICOM: Measurement Algorithm (Firmware Version 22)

The 'Calc out of Range' error flag is raised and the CTL factor is left at the last known good value if
either the relative density at base conditions (SG60) or the observed temperature is out of limits. The
CTL is initialized at 1.0000 at program startup.

Pressure Compensation
Pressure correction factor CPL is calculated as follows:

CPL = 1 / ( 1- [ P - Pe] x F )

The compressibility factor 'F' is calculated by either API 11.2.1 or API 11.2.2 depending upon rel-
ative density at base temperature (SG60)

API 11.2.1
Relative Density (SG)Range 1.076 to 0.638
Temperature Range degF -20.0 to 200.0

API 11.2.2
Relative Density (SG)Range 0.637 to 0.350
Temperature Range degF -50.0 to 140.0

If the temperature or relative density is out of range of the algorithm the 'F' factor will be left at the last
known good value calculated.

Note: If the relative density is between 0.638 and 0.637, the F Factor is calculated using linear inter-
polation between API 11.2.1 and API 11.2.2.
Equilibrium Pressure Pe
Is calculated using API 11.2.5(GPA TP15 extended) equilibrium pressure correlation.

API 11.2.5
Relative Density (SG) Range 0.676 to 0.350
Temperature Range degF -50.0 to 140.0~

Ethane/Propane and Propane/Propylene Mixes


GPA RR133 EP Mix (Table Select = 5)

This algorithm has been replaced by API 11.2.4,23E/24E(GPA TP27). The algorithm is based on
GPA RR133 with program improvements designed to eliminate unexpected results which could
occur when using the published report under certain operating conditions. The algorithm was meant
for use with limited binary mixtures only and has a range of:

Relative Density range


0.350 to 0.676

291
OMNICOM: Measurement Algorithm (Firmware Version 22)

A convergent routine is used to determine relative density at base conditions (SG60) given observed
relative density, temperature and pressure. The relative density at base conditions (SG60) is left at
the last know good calculated value should the algorithm fail to converge in 20 loops.
Temperature correction factor CTL, pressure correction CPL, equilibrium pressure Pe, and com-
pressibility factor F are also not updated if the algorithm fails to converge or any variable is out of
range.

API MPMS 11.1 (2007)

Commodity types:
Crude Oil, Refined Products, Lubricating Oil, Special Applications (Table Selects =
28-31, Available with firmware versions 22.74.06 and higher)

Chapter 11.1.6.1
Calculate the Volume Correction Factor (CTPL) for correcting from density at the base conditions
(60 degF and 0 PSIG) to alternate temperature and pressure conditions. The parameters used in
this procedure depends on the commodity group to which the liquid belongs.

The limits of the standard are:

Temperature Pressure Density


Density @ base conditions minimum to
-58.0 degF to 302.0 degF 0 PSIG to 1500 PSIG Density @ base conditions maximum
(if commodity type is specified)

For special applications:


Alpha Range
230x10-6 to 930.0x10-6 (Alpha at 60 degF per degF units)

Density at Base
Product Density at Base Conditions Max
Conditions Min
Type kg/m3
kg/m3
Crude Oil 610.6 1163.5
Refined
610.6 1163.5
Products
Lubricating
800.9 1163.5
Oil

K1 coefficients used in these equations depend upon the commodity group. The following table gives
the coefficients to be used.

Product Density Range kg/m3 K0 K1 K2


Crude Oil 610.6 to 1163.5 341.0957 0.0 0.0

292
OMNICOM: Measurement Algorithm (Firmware Version 22)

Fuel Oils 838.3127 to 1163.5 103.8720 0.2701 0.0


Jet Fuels 787.5195 to 838.3127 330.3010 0.0 0.0
Transition Zone 770.3520 to 787.5195 1489.0670 0.0 -0.00186840
Gasolines 610.6 to 770.3520 192.4571 0.2438 0.0
Lubricating Oils 800.9 to 1163.5 0.0 .034878 0.0

293
OMNICOM: Measurement Algorithm (Firmware Version 24)

Measurement Algorithm (Firmware Version 24)


Select the calculation standards to use when running this product. Selecting a standard auto-
matically causes the flow computer to use the appropriate companion standards to calculate density
at reference conditions. i.e.selecting Table 53/54 when using live density causes the flow computer
to use Table 53 to calculate reference density. API MPMS Chapter 11.2.1M is used in this case to
calculate the pressure compressibility factor 'F' used to calculate the pressure correction factor
'CPL'.

Once you enter the information and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are the settings covering each dialog within the Measurement Algorithm Tab.
Click on the setting for more information.

Note: For 24.75.04 and higher, for all of the algorithms, if the calculated CPL is out of range (less
than 0.5 or greater than 2.0), the 'Calculation Out of Range' alarm will be raised and the CPL will be
set to 1.0 .

API MPMS Chapter 11.1 (1980 edition)


Table 53A/54A(Table Select = 0)

Table 53A Generalized Crude Oils & JP-4 Aviation Fuel

Table 53A converts 'observed density and temperature' to 'density at base conditions'. The range of
the algorithm is:

Density, kg/m3 Temperature, degC


610.5 to 778.5 -18 to 95
 779.0 to 824.0 -18 to 125
824.5 to 1075.0 -18 to 150

The API table limits for 53A are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 54A Generalized Crude Oils & JP-4 Aviation Fuel

Table 54A calculates the correction for temperature on the liquid 'CTL' based on 'density at base con-
ditions', and 'observed temperature'.

The range of the application is:

294
OMNICOM: Measurement Algorithm (Firmware Version 24)

Density, kg/m3 Temperature, degC


610.5 to 778.5 -18 to 95
779.0 to 824.0 -18 to 125
824.5 to 1075.0 -18 to 150

If the 'observed density' is out of range, the 'CTL' remains at the last calculated value.
Calculations continue below temperatures of -18degC., the 'Calc out of Range' alarm will be
set.
The 'CTL' is not updated when the 'observed temperature' exceeds the table limits.

Table 53B/54B(Table Select = 1)

Table 53B Refined Products

Table 53B converts 'observed density' at 'observed temperature' to 'density at base conditions'.

The range of the algorithm is:

Density, kg/m3 Temperature, degC


653.0 to 778.5 -18.0 to 90.0
779.0 to 824.0 -18.0 to 125.0
824.5 to 1075.0 -18.0 to 150.0

Product Name Density Range, kg/m3


Gasolines and Napthens 653.0 to 778.5
Jet Fuels, Kerosenes and Solvents 779.0 to 838.5
Diesel, Heating Oil and Fuel Oils 839.0 to 1075.0

The API table limits for 53B are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 54B Refined Products

Table 54B calculates the correction for temperature on the liquid 'CTL' based on density at base con-
ditions and observed temperature.

The Range of the application is:

Density, kg/m3 Temperature, degC


653.0 to 778.5 -18.0 to 90.0
779.0 to 824.0 -18.0 to 125.0
824.5 to 1075.0 -18.0 to 150.0

295
OMNICOM: Measurement Algorithm (Firmware Version 24)

If the 'observed density' is out of range, the 'CTL' remains at the last calculated value.
Calculations continue below temperatures of -18degC., the 'Calc out of Range' alarm will be
set.
The 'CTL' is not updated when the 'observed temperature' exceeds the table limits.

Table 54C(Table Select = 2)

Special Applications

The range of the algorithm is:

Alpha Temperature, degC


955 to 15000 x10-6 -18 to 95
918 to 954 x10-6 -18 to 125
243 to 918 x10-6 -18 to 150

Values in red are extensions to the original algorithm limits.

The algorithm will continue to calculate when temperatures are below -18 degC but the 'Calc
out of Range' alarm will be set.
If the Alpha Factor is out of range, or the Temperature above maximum, the Volume Cor-
rection Factor (CTL) will be left at the last calculated value. The CTL value is initialized to
1.0000 at program startup.

Table 53D/54D(Table Select = 27, Available with firmware versions 24.73 and
higher)

Table 53D Generalized Lubricating Oils Correction of Observed Density to Density at 15


degC

Table 53D converts 'observed density' to 'density at base conditions'. The range of the algorithm is:

Density, kg/m3 Temperature, degC


1164.0 to 800.0 -18 to 150

The API table limits for 53D are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 54D Generalized Lubricating Oils Correction of Volume to 15 degC Against Density
at 15 degC

Table 54D gives volume correction factors (VCF) for converting volumes observed at temperatures
other than 15 degC to corresponding volumes at 'base conditions'.

296
OMNICOM: Measurement Algorithm (Firmware Version 24)

Density, kg/m3 Temperature, degC


1164.0 to 800.0 -18 to 150

The algorithm will continue to calculate when temperatures are below -18degC but the 'Calc
out of Range' alarm will be set.
If the density is out of range, or the Temperature above maximum, the Volume Correction
Factor (CTL) will be left at the last calculated value.
The CTL value is initialized to 1.0000 at program startup.

Crude Oil Historical Tables (API 2540/ASTM D1250 1952 edition)


Table 53/54(Table Select = 12)

The crude oil section of the historical 1952 tables is supported:

Table 53 Crude Oil and NGLs

Table 53 converts 'observed density and temperature' to 'density at base conditions'. The range of
the algorithm is:

Density, kg/m3 Temperature, degC


600 to 780 -25 to 50
780 to 880 -25 to 100
880 to 1095 -25 to 125

If the density or temperature is out of range of the table density at reference will be set to 0.0 and the
'Calc out of Range Flag' set

Table 54 Crude Oil and NGLs

Table 54 calculates the correction for temperature on the liquid 'CTL' based on density at base con-
ditions and observed temperature.
The Range of the application is:

Reference Density, kg/m3 Temperature, degC


600 to 840 -25 to 75
840 to 870 -25 to 100
870 to 960 -25 to 125
960 to 1100 -25 to 150

If the reference density or temperature are outside of the table limits, the CTL will be set to 1.0000.
CTL is initialized to 1.000 at program startup.

LPGs and NGLs


GPA TP16M(Table Select = 3)

297
OMNICOM: Measurement Algorithm (Firmware Version 24)

TP16M - Live Density/Gravity

Note: TP16 is obsolete and has been replaced with API 11.2.4,53E/54E. It may still be appropriate
to use this algorithm if existing contracts mandate its use.

When flowing density is provided, the density at base temperature is determined using historical
table 53 or algorithm 53A depending upon the following limits.

Table 53

Density, kg/m3 Temperature, degC


420 to 655 -50 to 60

Table 53A

Density, kg/m3 Temperature, degC


660 to 700 -50 to 60

Density Increment is 5 kg/m3


Temperature Increment is 0.5 degC

Note: If the density or temperature is out of Table Range, the density at base is set to the table edge
value. If the lookup table produces a zero value the density is left at the last known good value. If the
density or temperature is between table boundaries, an interpolation between the tables is made.

TP16M - Fixed Gravity at Base

The CTL factor is determined by a table lookup of historical table 54 or algorithm 54A depending
upon the following limits:

Table 54

Density, kg/m3 Temperature, degC


500 to 595 -50 to 60
600 to 655 -35 to 75

Table 54A

Density, kg/m3 Temperature, degC


660 to 700 -35 to 75

Density Increment is 5 kg/m3


Temperature Increment is 0.5 degC

** TP16M adds an additional column to the historical table 54 at density 507kg/m3 by interpolation of
table 54. This was done to accommodate 507 Propane.

298
OMNICOM: Measurement Algorithm (Firmware Version 24)

Input: Density is rounded to xxx.x


 Temperature is rounded to xxx.x5

Output : VCF (volume correction factor) ( also known as CTL )

Note: If the density or temperature is out of Table Range , the CTL value will be set to the table edge
value.

Pressure Compensation

Pressure correction factor CPL is calculated as follows:

CPL = 1 / ( 1- [ P - Pe] x F )

The compressibility factor 'F' is calculated by either API 11.2.1M or API 11.2.2M depending upon
density at base temperature.

API 11.2.1M

Density, kg/m3 Temperature, degC


638 to 1074 -30 to 90

API 11.2.2M

Density, kg/m3 Temperature, degC


350 to 637 -46 to 60

If the temperature or relative density is out of range of the algorithm the 'F' factor will be left at the last
known good value calculated.

Note: If the density is between 637 and 638 kg/m3, the F Factor is calculated using linear inter-
polation between API 11.2.1M and API 11.2.2M.

Equilibrium Pressure Pe
Is calculated using API 11.2.5(GPA TP15M extended) equilibrium pressure correlation adjusted for
metric units of measure.

API 11.2.5

Density, kg/m3 Temperature, degC


350 to 675 -46 to 60

The upper limit of 140 degF cannot be reached when product relative densities at 60 degF are below
0.430. Refer to API 11.2.5 to estimate the upper temperature limit.

API 11.2.4,53E/54E(GPA TP27M)(Table Select = 15)

299
OMNICOM: Measurement Algorithm (Firmware Version 24)

This standard supersedes the 1988 GPA TP16M standard and consists of the following fluid types:

Ethane/Ethylene - 68 mole% Ethane/32 mole% Ethylene


Ethane
Ethane/Propane - 65 mole % Ethane/35 mole % Propane
Ethane/Propane - 35 mole % Ethane/65 mole % Propane
Propane
iso-Butane
normal-Butane
iso-Pentane
normal-Pentane
iso-Hexane
normal-Hexane
normal-Heptane

Table 53E - Correction of Observed Density to Density at 15 degC

Table 53E is used to convert density at observed temperature and pressure to density at base tem-
perature and pressure conditions. The range of table 53E is:

Density, kg/m3 Temperature, degC


210.0 to 740.0 -45 to 93

The density at base conditions is set to 0.00 and the 'Calc out of Range' error flag raised if the dens-
ity or temperature is out of range.

Table 54E - Correction of Volume to 15 degC Against Density at 15 degC

Table 54E is used to calculate the CTL correction factor given density at base conditions and
observed temperature. The algorithm limits are:

Density at Base, kg/m3 Temperature, degC


350.0 to 688.0 -45 to 93

The 'Calc out of Range' error flag is raised and the CTL factor is left at the last known good value if
either the density at base conditions or the observed temperature is out of limits.

The CTL is initialized at 1.0000 at program startup.


Pressure Compensation
Pressure correction factor CPL is calculated as follows:

    CPL = 1 / ( 1- [ P - Pe] x F )

The compressibility factor 'F' is calculated by either API 11.2.1M or API 11.2.2M depending upon
density at base temperature.

API 11.2.1M

300
OMNICOM: Measurement Algorithm (Firmware Version 24)

Density, kg/m3 Temperature, degC


638 to 1074 -30 to 90

Note: The OMNI implements the API 11.2.1M algorithm and does not follow the calculation pro-
cedure to generate the printed table so the range checking listed above is ignored.

API 11.2.2M

Density, kg/m3 Temperature, degC


350 to 637 -46 to 60

If the temperature or relative density is out of range of the algorithm the 'F' factor will be left at the last
known good value calculated.

Note: If the density is between 637 and 638 kg/m3, the F Factor is calculated using linear inter-
polation between API 11.2.1M and API 11.2.2M.

Equilibrium Pressure Pe

Is calculated using API 11.2.5(GPA TP15M extended) equilibrium pressure correlation adjusted for
metric units of measure.

API 11.2.5

Density, kg/m3 Temperature, degC


350 to 675 -45 to 60

API MPMS 11.2.4 59E/60E(Table Select = 37, Available with firmware versions
24.75.04 and higher)

Table 59E - Correction of Observed Density to Density at 20 degC

Table 59E is used to convert density at observed temperature and pressure to density at base tem-
perature and pressure conditions. The range of table 59E is:

Density, kg/m3 Temperature, degC


331.7 to 683.6 -46 to 93

The density at base conditions is set to 0.00 and the 'Calc out of Range' error flag raised if the dens-
ity or temperature is out of range.

Table 60E - Correction of Volume to 20 degC Against Density at 20 degC

Table 60E is used to calculate the CTL correction factor given density at base conditions and
observed temperature.

301
OMNICOM: Measurement Algorithm (Firmware Version 24)

The 'Calc out of Range' error flag is raised and the CTL factor is left at the last known good value if
either the density at base conditions or the observed temperature is out of limits.

The CTL is initialized at 1.0000 at program startup.

Pressure Compensation

Pressure correction factor CPL is calculated as follows:

CPL = 1 / ( 1- [ P - Pe]xF )

The compressibility factor 'F' is calculated by either API 11.2.1M or API 11.2.2M depending upon
density at base temperature.

API 11.2.1M

Density, kg/m3 Temperature, degC


638 to 1074 -30 to 90

API 11.2.2M

Density, kg/m3 Temperature, degC


350 to 637 -46 to 60

If the temperature or relative density is out of range of the algorithm the 'F' factor will be left at the last
known good value calculated.

Note: If the density is between 637 and 638 kg/m3, the F Factor is calculated using linear inter-
polation between API 11.2.1M and API 11.2.2M.

Equilibrium Pressure Pe

Is calculated using API 11.2.5(GPA TP15M extended) equilibrium pressure correlation adjusted for
metric units of measure.

API 11.2.5

Density, kg/m3 Temperature, degC


350 to 675 -40 to 60

NGL(Table Select = 40, Available with firmware versions 24.73 and higher and only
on Products 1 and 2)

This algorithm is used to measure NGLs, and Crude Oils spiked with significant quantities of NGL. It
is based on API's Table 53A and 54A Crude Oil algorithm with manual entries of coefficients K0 and
K1 (see 'Product Setup' tab). The lower density limits of Table 53A and 54A are also extended to
accommodate the lower density NGL components.

302
OMNICOM: Measurement Algorithm (Firmware Version 24)

'Table 53A Modified' - NGLs and NGL Spiked Crude Oil

'Table 53A Modified' converts 'observed density and temperature' to 'density at base conditions'.
The range of the algorithm is:

Density, kg/m3 Temperature, degC


N/A to 778.5 -18 to 95
779.0 to 824.0 -18 to 125
824.5 to 1075.0 -18 to 150

1) If the 'observed density' is out of range, the 'density at base conditions' remains at the last cal-
culated value.
2) Calculations continue below temperatures of -18 degC. but the 'Calc out of Range' alarm will be
set.
3)The 'density at base conditions' is not updated when the 'observed temperature' exceeds the table
limits.

'Table 54A Modified' - NGLs and NGL Spiked Crude Oils

'Table 54A Modified' calculates the correction for temperature on the liquid 'CTL' based on 'density
at base conditions', and 'observed temperature'.
The range of the application is:

Density, kg/m3 Temperature, degC


N/A to 778.5 -18 to 95
779.0 to 824.0 -18 to 125
824.5 to 1075.0 -18 to 150

1) If the 'observed density' is out of range, the 'CTL' remains at the last calculated value.
2) Calculations continue below temperatures of -18 degC., the 'Calc out of Range' alarm will be set.
3)The 'CTL' is not updated when the 'observed temperature' exceeds the table limits.

Ethane/Propane and Propane/Propylene Mixes


GPA RR133 EP Mix(Table Select = 6)

This algorithm has been replaced by API 11.2.4,53E/54E(GPA TP27M). The algorithm is based on
GPA RR133 with program improvements designed to eliminate unexpected results which could
occur when using the published report under certain operating conditions. The algorithm was meant
for use with limited binary mixtures only and has a range of:

Relative Density
0.350 to 0.676

A convergent routine is used to determine relative density at base conditions given observed relative
density, temperature and pressure. The relative density at base conditions is left at the last known
good calculated value should the algorithm fail to converge in 20 loops.

303
OMNICOM: Measurement Algorithm (Firmware Version 24)

Temperature correction factor CTL, pressure correction CPL, equilibrium pressure Pe, and com-
pressibility factor F are also not updated if the algorithm fails to converge or any variable is out of
range.
out of range (CTL = 0 after calculation), also does not update VCF, CPL, PE, A factor, B factor and
F factor.

P/P Mix(Table Select = 7)

This algorithm uses a combination of GPA TP16 and API 11.3.3.2 to measure binary mixtures of pro-
pane and propylene. Based on observed relative density, temperature and pressure, and using an
empirical lookup table, the algorithm determines the relative fractions of propane and propylene. The
correction factors and relative densities at base conditions for each of these fractions are then indi-
vidually determined using either GPA TP16M or API 11.3.3.2M. The composite factors and densities
are then calculated according to the relative fractions of propane and propylene. The algorithm
range is:

Relative Density
0.507 to 0.580

Correction factors CTL and CPL, equilibrium pressure Pe, and compressibility factor F are left at the
last known good value, should any input variable be out of range of the stated limits of this algorithm,
or the underlying algorithms used by it.

Mass Calculation
Mass Calculation(Table Select = 4)

Use this algorithm when a flowing density is available and there is no known algorithm to correct for
temperature or pressure effects on the liquid:

Gross (IV) = Volume Pulses / K-Factor

Net (GSV) = Gross (IV) x CTL x CPL x MF

Mass = Gross (IV) x Flowing Density x MF

CPL is set to 1.0000.

CTL = Flowing Density / Base Density

Base or Reference Density is the 'absolute' value entered at the 'Product Setup' tab.

Butadiene and Butadiene Concentrations


ASTM D1550M(Table Select = 13)

These tables are applicable to both Butadiene and Butadiene concentrates (minimum of 60%
Butadiene).

304
OMNICOM: Measurement Algorithm (Firmware Version 24)

The ASTM 1550 standard provides two tables:

Table 1 is used to convert observed density at observed temperature, to density at base conditions.

The table limits are as follows:

Density, kg/m3 Temperature, degC


585 to 615 18 to 92
620 to 650 -9 to 67
655 to 675 -23 to 1

Table 2 is used to calculate the correction factor for temperature on a liquid 'CTL' at observed tem-
perature.

The table limits are as follows:

Density at Base Conditions, kg/m3 Temperature, degC


621 to 634 -23 to 92

1) If the density is out of the table range, the nearest table edge value is used and the 'Calc Out of
Range' alarm is raised.

2) If the temperature value is out of the table range the nearest table edge value is used and the
'Calc Out of Range' alarm is raised.

3) If the table lookup provides a zero value the previous value will be returned and the 'Calc out of
Range' alarm is raised.

Aromatic Hydrocarbons
ASTM D1555M(Table Select = 14)

Algorithm range: -15 to 65.5 degC.

ASTM D1555M consists of 11 different CTL lookup tables for 11 different aromatic products. When
selecting the ASTM D1555M algorithm, the appropriate CTL table to use is determined by the flow
computer by examining the configured value for Reference Density in the 'Product Setup’ tab.

Because several aromatic products have overlapping densities at base conditions, it is only possible
for the flow computer to automatically determine only 8 of the 11 CTL tables to use for the 11 aro-
matic products. The 8 products are: Cyclohexane, p-Xylene, m-Xylene, o-Xylene, Cumene,
Toluene, Benzene and Styrene. Because of this limitation, the selection of ASTM D1555M algorithm
is not recommended for new installations and users should instead select the algorithm for the indi-
vidual aromatic product being measured. The ASTM D1555M algorithm selection is provided only

305
OMNICOM: Measurement Algorithm (Firmware Version 24)

for backward compatibility with firmware when this algorithm was first implemented into the flow com-
puter.

Benzene(Table Select = 16)

Use for Benzene, reference density entry required.

Algorithm range: 6 to 60 degC.

Cumene(Table Select = 24)

Use for Cumene, reference density entry required.

Algorithm range: -15 to 60 degC.

Cyclohexane(Table Select = 22)

Use for Cyclohexane, reference density entry required.

Algorithm range: 7 to 60 degC.

Ethylbenzene(Table Select = 23)

Use for Ethylbenzene, reference density entry required.

Algorithm range: -15 to 60 degC.

m-Xylene(Table Select = 18)

Use for m-Xylene, reference density entry required.

Algorithm range: -15 to 60 degC.

o-Xylene(Table Select = 20)

Use for o-Xylene, reference density entry required.

Algorithm range: -15 to 60 degC.

p-Xylene(Table Select = 21)

Use for p-Xylene, reference density entry required.

Algorithm range: 13.5 to 65.5 degC.

Styrene(Table Select = 19)

Use for Styrene, reference density entry required.

306
OMNICOM: Measurement Algorithm (Firmware Version 24)

Algorithm range: -9 to 60 degC.

Toluene(Table Select = 17)

Use for Toluene, reference density entry required.

Algorithm range: -20 to 60 degC.

Aromatic Hydrocarbon (Boiling Point 148.9 to 176.7 degC)(Table Select = 25)

Use for Aromatic Hydrocarbons within the boiling point temperature range 148.9 to 176.7 degC.
Reference density entry required.

Algorithm range: -15 to 60 degC.

Aromatic Hydrocarbon (Boiling Point 176.7 to 204.4 degC)(Table Select = 26)

Use for Aromatic Hydrocarbons within the boiling point temperature range of 176.7 to 204.4 degC.
Reference density entry required.

Algorithm range: -15 to 60 degC.

Olefins
Propylene API 2565/11.3.3.2M(Table Select = 5)

This standard was originally issued and known as subroutine Propyl of API 2565.

Temperature, degC Pressure, Bar(absolute)


0 to 74 Psaturation to 110

The Propylene density is calculated and placed in ' 7n07 ' (equation of state density). The density
value will be left at the last known good value if either the temperature or pressure are out of range,
or if the algorithm can not converge on a solution.

If a densitometer signal is available, mass will be calculated using the live densitometer signal. Mass
will be calculated using the calculated density, if a live densitometer signal is not available.

Note: When this table is selected, the Mole Fraction of Propylene is automatically set to 1.0 to indic-
ate pure propylene. If you are not measuring pure propylene, please go to the Product Setup page
to configure the correct mole fraction for your application.

Ethylene IUPAC(Table Select = 8)

This equation of state was developed in 1988 and is designated IUPAC88.

307
OMNICOM: Measurement Algorithm (Firmware Version 24)

The equation calculates flowing density and isentropic exponent, given flowing temperature and
pressure.

Because the equation of state will solve for all states (liquid and gas), there are no preset tem-
perature or pressure limits.

If the algorithm fails to converge on a solution within 50 loops the 'Calc out of Range' alarm is set and
the flowing density and isentropic exponent are left at the last known good values.

Ethylene NIST 1045(Table Select = 9)

Originally designated NBS 1045, now known as NIST 1045.

Calculated flowing density of Ethylene, given flowing temperature and pressure.

Ethylene API 2565/11.3.2M(Table Select = 10)

This standard was originally issued and known as subroutine Ethyl of API 2565.

Temperature, degC Pressure, Bar(absolute)


18.3 to 75 13.8 to 144.8

Shortly after its release, industry found that the original temperature and pressure limits of the
algorithm did not address the needs of the pipeline transportation system in many cases.

The calculations were extended to use any temperature and pressure input values calculate the
Ethylene density. However, the "calc out of range" alarm will be set if the temperature or pressure
input values are out of the published API 11.3.2M algorithm range.

The density value will be left at the last known good value if the algorithm cannot converge on a solu-
tion.

When flowing parameters are within the original algorithm limits, the flow computer is in strict com-
pliance with the original standard.

Ethylene density is calculated and placed in ' 7n07 ' (equation of state density).

If a densitometer signal is available, mass will be calculated using the live densitometer signal. Mass
will be calculated using the calculated density, if a live densitometer signal is not available.

API MPMS 11.1 (2007) Commodity types


Crude Oil, Refined Products, Lubricating Oil, Special Applications(Table Selects =
28-31, Available with firmware versions 24.73 and higher)

308
OMNICOM: Measurement Algorithm (Firmware Version 24)

Calculate the Volume Correction Factor (VCF) for correcting from density at the base conditions (15
degC and 0 kPa). The parameter used in this procedure depends on the commodity group to which
the liquid belongs.

The limits of the standard are:

Temperature, degC Pressure, Bar Density, kg/m3


Density @ base conditions minimum to
-47 to 150 0 to 103 Density @ base conditions maximum
(if commodity type is specified)

For Special Applications:

Alpha Range
230x10-6 to 930.0x10-6 (Alpha at 60 degF per degF units)

Density at Base Conditions Min, Density at Base Conditions Max,


Product Type
kg/m3 kg/m3
Crude Oil 610.6 1163.5
Refined
610.6 1163.5
Products
Lubricating Oil 800.9 1163.5

 K1 coefficients used in these equations depend upon the commodity group. The following table
gives the coefficients to be used.

Product Density, kg/m3 K0 K1 K2


Crude Oil 610.6 to 1163.5 341.0957 0.0 0.0
Fuel Oils 838.3127 to 1163.5 103.8720 0.2701 0.0
Jet Fuels 787.5195 to 838.3127 330.3010 0.0 0.0
Transition Zone 770.3520 to 787.5195 1489.0670 0.0 -0.00186840
Gasolines 610.6 to 770.3520 192.4571 0.2438 0.0
Lubricating Oils 800.9 to 1163.5 0.0 .034878 0.0

IP Petroleum Measurement Paper No. 3 (1988 edition)


Table 59A/60A(Table Select = 34 - Available with firmware versions 24.75.04 and
higher)

Table 59A - Generalized Crude Oils Correction of Observed Density to Density at 20 degC

Table 59A converts 'observed density and temperature' to 'density at base conditions'. The ref-
erence temperature is fixed at 20 degC. The range of the algorithm is:

309
OMNICOM: Measurement Algorithm (Firmware Version 24)

Density, kg/m3 Temperature, degC


610 <= Density <= 778 -18 to 95
778 < Density <= 824 -18 to 125
824 < Density <= 1075 -18 to 150

The density at 20 degC is calculated based on observed density and observed temperature.

The API table limits for 59A are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 60A - Generalized Crude Oils Correction of Volume to 20 degC Against Density at
20 degC

Table 60A calculates the correction for temperature on the liquid 'CTL' based on 'density at base con-
ditions', and 'observed temperature' when the reference density override is entered as a positive
number.

The Volume Correction Factor (VCF) is calculated to 20 degC for each meter based on density at 20
degC and the meter temperature.

A calculation out of range alarm is given when the density or temperature is out of range.

The Volume Correction Factor (VCF) will be left at the last calculated value if the alarm con-
dition occurs.

The Volume Correction Factor (VCF) will be calculated and the calculation out of range alarm
will be raised if the temperature is below -18degC.

Table 59B/60B(Table Select = 35 - Available with firmware versions 24.75.04 and


higher)

Table 59B - Generalized Products Correction of Observed Density to Density at 20 degC

Table 59B converts 'observed density and temperature' to 'density at base conditions'. The ref-
erence temperature is fixed at 20 degC. The range of the algorithm is:

Density, kg/m3 Temperature, degC


653 <= Density <= 778 -18 to 95
778 < Density <= 824 -18 to 125
824 < Density <= 1075 -18 to 150

The density at 20 degC is calculated based on observed density and observed temperature.

310
OMNICOM: Measurement Algorithm (Firmware Version 24)

The API table limits for 59B are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 60B - Generalized Products Correction of Volume to 20 degC Against Density at 20


degC

Table 60B calculates the correction for temperature on the liquid 'CTL' based on 'density at base con-
ditions', and 'observed temperature' when the reference density override is entered as a positive
number.

The Volume Correction Factor (VCF) is calculated to 20degC for each meter based on the density at
20degC and the meter temperature.

A calculation out of range alarm is given when the density or temperature is out of range.

The Volume Correction Factor (VCF) will be left at the last calculated value if the alarm con-
dition occurs.

The Volume Correction Factor (VCF) will be calculated and the calculation out of range alarm
will be raised if the temperature is below -18degC.

Table 59D/60D(Table Select = 36 - Available with firmware versions 24.75.04 and


higher)

Table 59D Generalized Lubricating Oils Correction of Observed Density to Density at 20 degC

Table 59D converts 'observed density and temperature' to 'density at base conditions'. The ref-
erence temperature is fixed at 20 degC. The range of the algorithm is:

Density, kg/m3 Temperature, degC


800 <= Density <= 824 -18 to 125
824 < Density <= 1164 -18 to 150

The density at 20 degC is calculated based on observed density and observed temperature.

The API table limits for 59D are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 60D - Generalized Lubricating Oils Correction of Volume to 20 degC Against Dens-
ity at 20 degC

311
OMNICOM: Measurement Algorithm (Firmware Version 24)

Table 60D calculates the correction for temperature on the liquid 'CTL' based on 'density at base con-
ditions', and 'observed temperature' when the reference density override is entered as a positive
number.

The Volume Correction Factor (VCF) is calculated to 20degC for each meter based on the density at
20degC and the meter temperature.

A calculation out of range alarm is given when the density or temperature is out of range.

The Volume Correction Factor (VCF) will be left at the last calculated value if the alarm con-
dition occurs.

The Volume Correction Factor (VCF) will be calculated and the calculation out of range alarm
will be raised if the temperature is below -18degC.

Alcohols
Alcohol (ABNT NBR 5992:2008)(Table Select = 38, Available with firmware ver-
sions 24.75.04 and higher)

Brazilian Standard ABNT NBR 5992:2008

The alcohol strength by mass percent is determined by the alcohol calculation selection:

If the alcohol calculation is 'Use Reference Density', the alcohol strength by mass percent is
calculated based on the entered reference density and fixed reference temperature of
20degC.

If the alcohol calculation is 'Use Observed Density', the alcohol strength by mass percent is cal-
culated based on the input values of observed density and observed temperature. The density
at 20degC is also calculated.

If the alcohol calculation is 'Use Strength by Mass Percent', an override value is entered for
the alcohol strength by mass percent. The density at 20degC is calculated.

The alcohol strength by mass percent along with the observed temperature are used to calculate the
density of Ethanol and its mixture with water. The volume correction factor is also calculated.

The alcohol strength by volume percent is calculated using the density at observed temperature and
alcohol strength by mass percent.

The compressibility factor 'F' of the Ethanol and its mixtures with water is calculated using API
11.2.1M/API 11.2.2M when a negative F Factor override is entered. The pressure correction factor,
CPL, is calculated using either the calculated F Factor or using an entered positive non-zero F
Factor override. If the F Factor override is zero (default), the CPL will be set to 1.0.

The calculation out of range alarm is raised when the density, temperature, or the Alcohol Strength
by Mass % is out of the range:

312
OMNICOM: Measurement Algorithm (Firmware Version 24)

Density < 771.92 kg/m3 or Density > 999.84 kg/m3 (when 'Use Observed Density' is selec-
ted)
Temperature < -20 degC or Temperature > 40 degC
Alcohol Strength Mass % < 0.0 or Alcohol Strength Mass % > 100.0 (user entered)
Calculated Alcohol Strength Mass % < 0.0 or Calculated Alcohol Strength Mass % > 100.0
(when 'Use Observed Density' is selected)

The calculated Alcohol Density, Alcohol Density at 20 degC, Alcohol Strength by Volume %, Alcohol
Strength by Mass %, and Volume Correction Factor (VCF) will be left at the last calculated value if
one of the above alarm conditions occur.

Alcohol (OIML R22)(Table Select = 39, Available with firmware versions 24.75.04
and higher)

Alcohol (OIML R22) - International Recommendation No.22 'Alcoholometry' International Alco-


holmetric Tables

The alcohol strength by mass percent is determined by the alcohol calculation selection:

If the alcohol calculation is 'Use Reference Density', the alcohol strength by mass percent is
calculated based on the entered reference density and fixed reference temperature of 20
degC.

If the alcohol calculation is 'Use Observed Density', the alcohol strength by mass percent is cal-
culated based on the input values of observed density and observed temperature. The density
at 20 degC is also calculated.

If the alcohol calculation is 'Use Strength by Mass Percent', an override value is entered for
the alcohol strength by mass percent. The density at 20 degC is calculated.

The alcohol strength by mass percent along with the observed temperature are used to calculate the
density of Ethanol and its mixture with water. The volume correction factor is also calculated.

The alcohol strength by volume percent is calculated using the density at observed temperature and
alcohol strength by mass percent.

The compressibility factor 'F' of the Ethanol and its mixtures with water is calculated using API
11.2.1M/API 11.2.2M when a negative F Factor override is entered. The pressure correction factor,
CPL, is calculated using either the calculated F Factor or using an entered positive non-zero F
Factor override. If the F Factor override is zero (default), the CPL will be set to 1.0.

The calculation out of range alarm is raised when the density, temperature, or the Alcohol Strength
by Mass Percent is out of the range:

Density < 771.92 kg/m3 or Density > 999.84 kg/m3 (when 'Use Observed Density' is selec-
ted)
Temperature < -20 degC or Temperature > 40 degC
Alcohol Strength Mass % < 0.0 or Alcohol Strength Mass % > 100.0 (user entered)

313
OMNICOM: Measurement Algorithm (Firmware Version 24)

Calculated Alcohol Strength Mass % < 0.0 or Calculated Alcohol Strength Mass % > 100.0
(when 'Use Observed Density' is selected)

The calculated Alcohol Density, Alcohol Density at 20 degC, Alcohol Strength by Volume %, Alcohol
Strength by Mass %, and Volume Correction Factor (VCF) will be left at the last calculated value if
one of the above alarm conditions occur.

Other Miscellaneous Fluids


CO2PAC(Table Select = 11)

Uses equation of state called CO2PAC to calculate the density of pure or near pure carbon dioxide.

Algorithm limits are:

Temperature, degC Pressure, Bar(absolute)


-162 to 282 0 to 3000

Flowing density will be left at the last known good value should the equation be unable to converge
on a solution.

Water(Table Select = 32, Available with firmware versions 24.74.17 and higher)

Water density and compressibility are calculated in accordance with API MPMS 11.4.1

The API equation is based on Patterson and Morris.

The VCF factor combines the corrections for temperature and pressure.
The CPL factor is set to 1.0000

NIST14(Table Select = 41, Available with firmware versions 24.74.17 and higher
and only on Products 1-4)

The NIST 14 equations are used to calculate the 'observed density' at a given reference or base
pressure, temperature and overall composition.

Algorithm limits are:

Temperature, degC Pressure, MPa


-219 to 727 0 to 300

You may select to use the live density for the NIST14 calculations by checking the "Use Live Density"
box in the NIST14 group on the Meter Run Setup screen.

314
OMNICOM: Measurement Algorithm (Firmware Version 24)

The composition analysis basis can be Mole Percent, Mole Fraction, Mass Percent, or Mass Frac-
tion.

You may enter up to 17 components. For more information see the help for NIST14 Component
Analysis.

Asphalt - ASTM D4311M-09(Table Select = 33, Available with firmware versions


24.75.03 and higher)

ASTM D4311M-09 Table 1 (Eq. 1 for column A and Eq. 2 for column B) is used to calculate the
volume correction factor for Asphalt.

Algorithm limits are:

Temperature, degC Density, kg/m3


-25 to 275 850.0 to 'no high limit'

API 11.2.1M is used to calculate the F factor.

A calculation out of range alarm is generated when one of the following conditions occur:

Density@15 is less than 850.0 kg/m3


Meter temperature is less than -25.0 degC
Meter temperature is greater than 275.0 degC

315
OMNICOM: Measurement Algorithm (Firmware Version 26)

Measurement Algorithm (Firmware Version 26)


Select the calculation standards to use when running this product. Selecting a standard auto-
matically causes the flow computer to use the appropriate companion standards to calculate density
at reference conditions. i.e.selecting Table 53/54 when using live density causes the flow computer
to use Table 53 to calculate reference density.API MPMS Chapter 11.2.1M is used in this case to cal-
culate the pressure compressibility factor 'F' used to calculate the pressure correction factor 'CPL'.

Once you enter the information and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are the settings covering each dialog within the Measurement Algorithm Tab.
Click on the setting for more information.

Note: For 26.75.03 and higher, for all of the algorithms, if the calculated CPL is out of range (less
than 0.5 or greater than 2.0), the 'Calculation Out of Range' alarm will be raised and the CPL will be
set to 1.0 .

API MPMS Chapter 11.1 (1980 edition)


Table 53A/54A (Table Select = 0)

Table 53A Generalized Crude Oils & JP-4 Aviation Fuel

Table 53A converts 'observed density and temperature' to 'density at base conditions'. The range of
the algorithm is:

Density, kg/m3 Temperature, degC


610.5 to 778.5 -18 to 95
 779.0 to 824.0 -18 to 125
824.5 to 1075.0 -18 to 150

The API table limits for 53A are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 54A Generalized Crude Oils & JP-4 Aviation Fuel

Table 54A calculates the correction for temperature on the liquid 'CTL' based on 'density at base con-
ditions', and 'observed temperature'.
The range of the application is:

316
OMNICOM: Measurement Algorithm (Firmware Version 26)

Density, kg/m3 Temperature, degC


610.5 to 778.5 -18 to 95
779.0 to 824.0 -18 to 125
824.5 to 1075.0 -18 to 150

If the 'observed density' is out of range, the 'CTL' remains at the last calculated value.
Calculations continue below temperatures of -18 degC., the 'Calc out of Range' alarm will be
set.
The 'CTL' is not updated when the 'observed temperature' exceeds the table limits.

Table 53B/54B (Table Select = 1)

Table 53B Refined Products

Table 53B converts 'observed density' at 'observed temperature' to 'density at base conditions'.
The range of the algorithm is:

Density, kg/m3 Temperature,degC


653.0 to 778.5 -18.0 to 90.0
779.0 to 824.0 -18.0 to 125.0
824.5 to 1075.0 -18.0 to 150.0

Product Name Density Range, kg/m3


Gasolines and Napthens 653.0 to 778.5
Jet Fuels, Kerosenes and Solvents 779.0 to 838.5
Diesel, Heating Oil and Fuel Oils 839.0 to 1075.0

The API table limits for 53B are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 54B Refined Products

Table 54B calculates the correction for temperature on the liquid 'CTL' based on density at base con-
ditions and observed temperature.
The Range of the application is:

Density, kg/m3 Temperature, degC


653.0 to 778.5 -18.0 to 90.0
779.0 to 824.0 -18.0 to 125.0
824.5 to 1075.0 -18.0 to 150.0

317
OMNICOM: Measurement Algorithm (Firmware Version 26)

If the 'observed density' is out of range, the 'CTL' remains at the last calculated value.
Calculations continue below temperatures of -18 degC., the 'Calc out of Range' alarm will be
set.
The 'CTL' is not updated when the 'observed temperature' exceeds the table limits.

Table 54C (Table Select = 2)

Special Applications

The range of the algorithm is:

Alpha Temperature, degC


955 to 15000 x10-6 -18 to 95
918 to 954 x10-6 -18 to 125
243 to 918 x10-6 -18 to 150

Values in red are extensions to the original algorithm limits.

The algorithm will continue to calculate when temperatures are below -18 degC but the 'Calc out of
Range' alarm will be set.
If the Alpha Factor is out of range, or the Temperature above maximum, the Volume Correction
Factor (CTL) will be left at the last calculated value. The CTL value is initialized to 1.0000 at program
startup.

Crude Oil Historical Tables (API 2540/ASTM D1250 1952 edition)


Table 53/54 (Table Select = 4)

The crude oil section of the historical 1952 tables is supported:

Table 53 Crude Oil and NGLs

Table 53 converts 'observed density and temperature' to 'density at base conditions'. The range of
the algorithm is:

Density, kg/m3 Temperature, degC


600 to 780 -25 to 50
780 to 880 -25 to 100
880 to 1095 -25 to 125

If the density or temperature is out of range of the table density at reference will be set to 0.0 and the
'Calc out of Range Flag' set

Table 54 Crude Oil and NGLs

Table 54 calculates the correction for temperature on the liquid 'CTL' based on density at base con-
ditions and observed temperature.

318
OMNICOM: Measurement Algorithm (Firmware Version 26)

The Range of the application is:

Reference Density, kg/m3 Temperature, degC


600 to 840 -25 to 75
840 to 870 -25 to 100
870 to 960 -25 to 125
960 to 1100 -25 to 150

If the reference density or temperature are outside of the table limits, the CTL will be left at the last
known good value. CTL is initialized to 1.000 at program startup.

LPGs and NGLs


GPA TP16M (Table Select = 3)

TP16M - Live Density/Gravity

Note: TP16M is obsolete and has been replaced with API 11.2.4,53E/54E. It may still be appropriate
to use this algorithm if existing contracts mandate its use.

When flowing density is provided, the density at base temperature is determined using historical
table 53 or algorithm 53A depending upon the following limits.

Table 53

Density, kg/m3 Temperature, degC


420 to 655 -50 to 60

Table 53A

Density, kg/m3 Temperature, degC


660 to 700 -50 to 60

Density Increment is 5 kg/m3


Temperature Increment is 0.5 degC

Note: If the density or temperature is out of Table Range, the density at base is set to the table edge
value. If the lookup table produces a zero value the density is left at the last known good value. If the
density or temperature is between table boundaries, an interpolation between the tables is made.

TP16M - Fixed Gravity at Base

The CTL factor is determined by a table lookup of historical table 54 or algorithm 54A depending
upon the following limits:

Table 54

319
OMNICOM: Measurement Algorithm (Firmware Version 26)

Density, kg/m3 Temperature, degC


500 to 595 -50 to 60
600 to 655 -35 to 75

Table 54A

Density, kg/m3 Temperature, degC


660 to 700 -35 to 75

Density Increment is 5 kg/m3


Temperature Increment is 0.5 degC

** TP16M adds an additional column to the historical table 54 at density 507 kg/m3 by interpolation of
table 54. This was done to accommodate 507 Propane.

Input: Density is rounded to xxx.x


Temperature is rounded to xxx.x5

Output : VCF (volume correction factor) ( also known as CTL )

Note: If the density or temperature is out of Table Range , the CTL value will be set to the table edge
value.

Pressure Compensation

Pressure correction factor CPL is calculated as follows:

CPL = 1 / ( 1- [ P - Pe]

The compressibility factor 'F' is calculated by either API 11.2.1M or API 11.2.2M depending upon
density at base temperature.

API 11.2.1M

Density, kg/m3 Temperature, degC


638 to 1074 -45.55 to 60

API 11.2.2M

Density, kg/m3 Temperature, degC


350 to 637 -45.55 to 60

If the temperature or relative density is out of range of the algorithm the 'F' factor will be left at the last
known good value calculated.

Note: If the density is between 637 and 638 kg/m3, the F Factor is calculated using linear inter-
polation between API 11.2.1M and API 11.2.2M.

320
OMNICOM: Measurement Algorithm (Firmware Version 26)

Equilibrium Pressure Pe

Is calculated using API 11.2.5(GPA TP15M extended) equilibrium pressure correlation adjusted for
metric units of measure.

API 11.2.5
Density, kg/m3 Temperature, degC
350 to 675 -45.55 to 60

The upper limit of 140 degF cannot be reached when product relative densities at 60 degF are below
0.430. Refer to API 11.2.5 to estimate the upper temperature limit.

API 11.2.4,53E/54E(GPA TP27M) (Table Select = 15, Available with firmware version
26.74.10 and higher)

This standard supersedes the 1988 GPA TP16M standard and consists of the following fluid types:

Ethane/Ethylene - 68 mole% Ethane/32 mole% Ethylene


Ethane
Ethane/Propane - 65 mole % Ethane/35 mole % Propane
Ethane/Propane - 35 mole % Ethane/65 mole % Propane
Propane
iso-Butane
normal-Butane
iso-Pentane
normal-Pentane
iso-Hexane
normal-Hexane
normal-Heptane

Table 53E - Correction of Observed Density to Density at 15 Degrees C

Table 53E is used to convert density at observed temperature and pressure to density at base tem-
perature and pressure conditions. The range of table 53E is:

Density, kg/m3 Temperature, degC


210.0 to 740.0 -45 to 93

The density at base conditions is set to 0.00 and the 'Calc out of Range' error flag raised if the dens-
ity or temperature is out of range.

Table 54E - Correction of Volume to 15 Degrees C Against Density at 15 Degrees C

Table 54E is used to calculate the CTL correction factor given density at base conditions and
observed temperature. The algorithm limits are:

321
OMNICOM: Measurement Algorithm (Firmware Version 26)

Density at Base, kg/m3 Temperature, degC


350.0 to 688.0 -45 to 93

The 'Calc out of Range' error flag raised, and the CTL factor is left at the last known good value,
should either the density at base conditions or observed temperature be out of limits. The CTL is ini-
tialized at 1.0000 at program startup.

Pressure Compensation

Pressure correction factor CPL is calculated as follows:

CPL = 1 / ( 1- [ P - Pe]xF )

The compressibility factor 'F' is calculated by either API 11.2.1M or API 11.2.2M depending upon
density at base temperature.

API 11.2.1M

Density, kg/m3 Temperature, degC


638 to 1074 -30 to 90

Note: The OMNI implements the API 11.2.1M algorithm and does not follow the calculation pro-
cedure to generate the printed table so the range checking listed above is ignored.

API 11.2.2M

Density, kg/m3 Temperature, degC


350 to 637 -46 to 60

If the temperature or relative density is out of range of the algorithm the 'F' factor will be left at the last
known good value calculated.

Note: If the density is between 637 and 638 kg/m3, the F Factor is calculated using linear inter-
polation between API 11.2.1M and API 11.2.2M.

Equilibrium Pressure Pe

Is calculated using API 11.2.5(GPA TP15M extended) equilibrium pressure correlation adjusted for
metric units of measure.

API 11.2.5

Density, kg/m3 Temperature, degC


350 to 675 -40 to 60

322
OMNICOM: Measurement Algorithm (Firmware Version 26)

API MPMS 11.2.4 59E/60E (Table Select = 37, Available with firmware versions
26.75.03 and higher)

Table 59E - Correction of Observed Density to Density at 20 Degrees C

Table 59E is used to convert density at observed temperature and pressure to density at base tem-
perature and pressure conditions. The range of table 59E is:

Density, kg/m3 Temperature, degC


331.7 to 683.6 -46 to 93

The density at base conditions is set to 0.00 and the 'Calc out of Range' error flag raised if the dens-
ity or temperature is out of range.

Table 60E - Correction of Volume to 20 Degrees C Against Density at 20 Degrees C

Table 60E is used to calculate the CTL correction factor given density at base conditions and
observed temperature.

The 'Calc out of Range' error flag is raised and the CTL factor is left at the last known good value if
either the density at base conditions or the observed temperature is out of limits.

The CTL is initialized at 1.0000 at program startup.

Pressure Compensation

Pressure correction factor CPL is calculated as follows:

CPL = 1 / ( 1- [ P - Pe] x F )

The compressibility factor 'F' is calculated by either API 11.2.1M or API 11.2.2M depending upon
density at base temperature.

API 11.2.1M

Density, kg/m3 Temperature, degC


638 to 1074 -30 to 90

API 11.2.2M

Density, kg/m3 Temperature, degC


350 to 637 -46 to 60

If the temperature or relative density is out of range of the algorithm the 'F' factor will be left at the last
known good value calculated.

Note: If the density is between 637 and 638 kg/m3, the F Factor is calculated using linear inter-
polation between API 11.2.1M and API 11.2.2M.

323
OMNICOM: Measurement Algorithm (Firmware Version 26)

Equilibrium Pressure Pe

Is calculated using API 11.2.5(GPA TP15M extended) equilibrium pressure correlation adjusted for
metric units of measure.

API 11.2.5

Density, kg/m3 Temperature, degC


350 to 675 -40 to 60

API MPMS 11.1 (2007) Commodity types


Crude Oil, Refined Products, Lubricating Oil, Special Applications (Table Selects =
28-31, Available with firmware version 26.74.10 and higher)

Calculate the Volume Correction Factor (VCF) for correcting from density at the base conditions (15
degC and 0 kPa). The parameter used in this procedure depends on the commodity group to which
the liquid belongs.

The limits of the standard are:

Temperature, degC Pressure, Bar Density, kg/m3


Density @ base conditions minimum to
-47 to 150 0 to 103 Density @ base conditions maximum
(if commodity type is specified)

For special applications:

Alpha Range
230x10-6 to 930.0x10-6 (Alpha at 60 degF per degF units)

Density at Base Conditions Density at Base Conditions


Product Type
Min, kg/m3 Max, kg/m3
Crude Oil 610.6 1163.5
Refined Products 610.6 1163.5
Lubricating Oil 800.9 1163.5

 K1 coefficients used in these equations depend upon the commodity group. The following table
gives the coefficients to be used.

Product Density, kg/m3 K0 K1 K2


Crude Oil 610.6 to 1163.5 341.0957 0.0 0.0
Fuel Oils 838.3127 to 1163.5 103.8720 0.2701 0.0
Jet Fuels 787.5195 to 838.3127 330.3010 0.0 0.0

324
OMNICOM: Measurement Algorithm (Firmware Version 26)

Transition Zone 770.3520 to 787.5195 1489.0670 0.0 -0.00186840


Gasolines 610.6 to 770.3520 192.4571 0.2438 0.0
Lubricating Oils 800.9 to 1163.5 0.0 .034878 0.0

IP Petroleum Measurement Paper No. 3 (1988 edition)


Table 59A/60A (Table Select = 34 - Available with firmware versions 23.75.03 and
higher)

Table 59A - Generalized Crude Oils Correction of Observed Density to Density at 20 Degrees C

Table 59A converts 'observed density and temperature' to 'density at base conditions'. The ref-
erence temperature is fixed at 20 degC. The range of the algorithm is:

Density, kg/m3 Temperature, degC


610 <= Density <= 778 -18 to 95
778 < Density <= 824 -18 to 125
824 < Density <= 1075 -18 to 150

The density at 20 degC is calculated based on observed density and observed temperature.

The API table limits for 59A are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 60A - Generalized Crude Oils Correction of Volume to 20 Degrees C Against Dens-
ity at 20 Degrees C

Table 60A calculates the correction for temperature on the liquid 'CTL' based on 'density at base con-
ditions', and 'observed temperature' when the reference density override is entered as a positive
number.

The Volume Correction Factor (VCF) is calculated to 20 degC for each meter based on density at 20
degC and the meter temperature.

A calculation out of range alarm is given when the density or temperature is out of range.

The Volume Correction Factor (VCF) will be left at the last calculated value if the alarm con-
dition occurs.

The Volume Correction Factor (VCF) will be calculated and the calculation out of range alarm
will be raised if the temperature is below -18C.

Table 59B/60B (Table Select = 35 - Available with firmware versions 23.75.03 and
higher)

325
OMNICOM: Measurement Algorithm (Firmware Version 26)

Table 59B - Generalized Products Correction of Observed Density to Density at 20 Degrees C

Table 59B converts 'observed density and temperature' to 'density at base conditions'. The ref-
erence temperature is fixed at 20 degC. The range of the algorithm is:

Density, kg/m3 Temperature, degC


653 <= Density <= 778 -18 to 95
778 < Density <= 824 -18 to 125
824 < Density <= 1075 -18 to 150

The density at 20 degC is calculated based on observed density and observed temperature.

The API table limits for 59B are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 60B - Generalized Products Correction of Volume to 20 Degrees C Against Density


at 20 Degrees C

Table 60B calculates the correction for temperature on the liquid 'CTL' based on 'density at base con-
ditions', and 'observed temperature' when the reference density override is entered as a positive
number.

The Volume Correction Factor (VCF) is calculated to 20 degC for each meter based on the density
at 20 degC and the meter temperature.

A calculation out of range alarm is given when the density or temperature is out of range.

The Volume Correction Factor (VCF) will be left at the last calculated value if the alarm con-
dition occurs.

The Volume Correction Factor (VCF) will be calculated and the calculation out of range alarm
will be raised if the temperature is below -18C.

Table 59D/60D (Table Select = 36 - Available with firmware versions 23.75.03 and
higher)

Table 59D Generalized Lubricating Oils Correction of Observed Density to Density at 20


Degrees C

Table 59D converts 'observed density and temperature' to 'density at base conditions'. The ref-
erence temperature is fixed at 20 degC. The range of the algorithm is:

Density, kg/m3 Temperature, degC


800 <= Density <= 824 -18 to 125
824 < Density <= 1164 -18 to 150

326
OMNICOM: Measurement Algorithm (Firmware Version 26)

The density at 20 degC is calculated based on observed density and observed temperature.

The API table limits for 59D are not enforced by the flow computer because observed densities from
densitometers are not normally at atmospheric pressure, but are at elevated pipeline pressures,
requiring an iterative calculation to be performed. Initial input parameters to the calculation could be
outside the published API limits.

Table 60D - Generalized Lubricating Oils Correction of Volume to 20 Degrees C Against


Density at 20 Degrees C

Table 60D calculates the correction for temperature on the liquid 'CTL' based on 'density at base con-
ditions', and 'observed temperature' when the reference density override is entered as a positive
number.

The Volume Correction Factor (VCF) is calculated to 20 degC for each meter based on the density
at 20 degC and the meter temperature.

A calculation out of range alarm is given when the density or temperature is out of range.

The Volume Correction Factor (VCF) will be left at the last calculated value if the alarm con-
dition occurs.

The Volume Correction Factor (VCF) will be calculated and the calculation out of range alarm
will be raised if the temperature is below -18C.

Alcohols
Alcohol (ABNT NBR 5992:2008) (Table Select = 38, Available with firmware ver-
sions 23.75.03 and higher)

Brazilian Standard ABNT NBR 5992:2008

If 'Use Observed Density' is selected, the alcohol strength by mass percent is calculated based on
the input values of observed density and observed temperature. If observed density is not available,
enter an override value for the alcohol strength by mass percent.

The alcohol strength by mass percent along with the observed temperature are used to calculate the
density of Ethanol and its mixture with water. The density at 20 degC and the volume correction
factor are also calculated.

The alcohol strength by volume percent is calculated using the density at observed temperature and
alcohol strength by mass percent.

The compressibility factor 'F' of the Ethanol and its mixtures with water is calculated using API
11.2.1M/API 11.2.2M when a negative F factor override is entered. The pressure correction factor,
CPL, is calculated using either the calculated F factor or using an entered positive non-zero F factor
override. If the F Factor override is zero (default), the CPL will be set to 1.0.

327
OMNICOM: Measurement Algorithm (Firmware Version 26)

The calculation out of range alarm is raised when the density, temperature, or the Alcohol Strength
by Mass % is out of the range:

Density < 771.92 kg/m3 or Density > 999.84 kg/m3 (when 'Use Observed Density' is selec-
ted)
Temperature < -20 degC or Temperature > 40 degC
Alcohol Strength Mass % < 0.0 or Alcohol Strength Mass % > 100.0 (user entered)
Calculated Alcohol Strength Mass % < 0.0 or Calculated Alcohol Strength Mass % > 100.0
(when 'Use Observed Density' is selected)

The calculated Alcohol Density, Alcohol Density at 20 degC, Alcohol Strength by Volume %, Alcohol
Strength by Mass %, and Volume Correction Factor (VCF) will be left at the last calculated value if
one of the above alarm conditions occur.

Alcohol (OIML R22) (Table Select = 39, Available with firmware versions 23.75.03
and higher)

Alcohol (OIML R22) - International Recommendation No.22 'Alcoholometry' International Alco-


holmetric Tables

The entered alcohol strength by mass percent along with the observed temperature are used to cal-
culate the density of Ethanol and its mixture with water. The density at 20 degC and the volume cor-
rection factor are also calculated.

The alcohol strength by volume percent is calculated using the density at observed temperature and
alcohol strength by mass percent.

The compressibility factor 'F' of the Ethanol and its mixtures with water is calculated using API
11.2.1M/API 11.2.2M when a negative F factor override is entered. The pressure correction factor,
CPL, is calculated using either the calculated F factor or using an entered positive non-zero F factor
override. If the F Factor override is zero (default), the CPL will be set to 1.0.

The calculation out of range alarm is raised when the density, temperature, or the Alcohol Strength
by Mass % is out of the range:

Density < 771.92 kg/m3 or Density > 999.84 kg/m3 (when 'Use Observed Density' is selec-
ted)
Temperature < -20 degC or Temperature > 40 degC
Alcohol Strength Mass % < 0.0 or Alcohol Strength Mass % > 100.0 (user entered)
Calculated Alcohol Strength Mass % < 0.0 or Calculated Alcohol Strength Mass % > 100.0
(when 'Use Observed Density' is selected)

The calculated Alcohol Density, Alcohol Density at 20 degC, Alcohol Strength by Volume %, Alcohol
Strength by Mass %, and Volume Correction Factor (VCF) will be left at the last calculated value if
one of the above alarm conditions occur.

328
OMNICOM: Setup (Firmware Versions 20 and 21)

Setup (Firmware Versions 20 and 21)


The Product Setup for Liquid Applications is for entering meter factors for each flowmeter and inform-
ation about each of the products. Once you enter the information and/or make your selections, press
the [Apply] button to set.

Settings
Below are the settings used to configure the Product Setup Screen:

API Override

This is the API gravity at reference conditions. It is used to calculate the volume correction factor
VCF and the pressure correction factor CPL.

The Override gravity can also be entered as Specific Gravity (next entry).

When using a densitometer or gravitometer with API 11.1 (2007) Commodity Types measurement
selections, see the 'Calculate Reference API/SG' help topic below. For all other tables, specify a neg-
ative override value to have the flow computer use the live density to calculate reference density. If
you specify a 'positive' override value (note that a value of 0 is considered positive), the flow com-
puter will disregard the live density value and back calculate the meter density using the reference
density derived from the override API.

SG Override

This is the specific gravity at reference conditions. It is used to calculate the volume correction factor
CTL (VCF) and the pressure correction factor CPL.

The Override gravity can also be entered as API Gravity (last entry).

 When using a densitometer or gravitometer with API 11.1 (2007) Commodity Types measurement
selections, see the 'Calculate Reference API/SG' help topic below. For all other tables, specify a neg-
ative override value to have the flow computer use the live density to calculate reference density. If
you specify a 'positive' override value (note that a value of 0 is considered positive), the flow com-
puter will disregard the live density value and back calculate the meter density using the reference
density derived from the override SG.

API 11.1 (2007) F factor for CPL(available with firmware 20.74.22 and higher)

If any of the API MPMS Chapter 11.1 (1980 edition) measurement algorithm tables are selected, a
checkbox is provided for the CPL calculation:

If the box is checked, the OMNI uses the API 11.1.3.3(2007) calculated F factor to calculate
the CPL.

329
OMNICOM: Setup (Firmware Versions 20 and 21)

If the box is unchecked, the OMNI uses the API 11.2.1(1981) or API 11.2.2(1981) to calculate
the CPL.

Calculate Reference API/SG (Use Observed Density)

This setting applies only when selecting one of the API 11.1 (2007) Commodity Types standards
and if you would like the flow computer to calculate the reference density using the transducer dens-
ity.

Note: A negative override value for the API@60 or SG@60 when using API 11.1 (2007) is not used
by the flow computer in the same way as when you are using API 11.1 (1980).

The reason for this is that with API 11.1 (2007) the API range has been expanded down to a value of
-10 (negative 10) whereas when using API 11.1 (1980), the lowest valid API value is 0.

Since it is not possible to specify a double negative 10 as an API override value, the Use Observed
Density setting option was added to instruct the flow computer to use the transducer (observed)
density to calculate the reference density.

If you have a live density and you would like the flow computer to use the live density to calculate the
reference density, check this box and specify either a negative or positive override value for the ref-
erence API or SG override.

If the transducer then fails and you have the transducer Fail Code set to 'Use Product Override on
Transmitter Fail', the flow computer will use the absolute value of the override API or SG you
entered in the Product area to calculate the reference density and will back calculate the flowing
density.

If you have a live flowing density and would like to use an override API or SG at reference, specify a
positive override value for the API or SG at reference setting, and do not check this box.

If you do not have a live density, specify a positive API or SG override and do not check this box. The
flow computer will use the reference API or SG you entered in the Product area to calculate the ref-
erence density and will then back calculate the flowing density.

>USING A DENSITOMETER OR GRAVITOMETER FOR THIS PRODUCT


Checking this box causes the flow computer to use the signal from the densitometer or gravitometer
and correct it to reference temperature and pressure if required (this may be at flowing or reference
conditions. See 'Process Input' configuration tab).

USING THE SG OVERRIDE WHEN THE GRAVITOMETER OR DENSITOMETER FAILS


Should the densitometer or gravitometer fail, the flow computer can be made to use the API/SG over-
ride by selecting 'On transmitter fail use product override' in the 'Process Input' configuration tab.

Alpha Coefficient

330
OMNICOM: Setup (Firmware Versions 20 and 21)

API algorithms Table 24C, and 11.1 Special Applications Commodity Group require a value for
'Alpha-T' coefficient to be entered. This Alpha-T value is used to calculate the volume correction
factor 'VCF', also known as CTL.

Enter Alpha at 60 degF per degF units.

F Factor Override

Enter the F Factor override in PSIG units.

Enter 0.0 if you wish the flow computer to use API 11.2.1M or API 11.2.2M to calculate the
compressibility factor 'F' used in the CPL equation.
Enter a suitable compressibility factor 'F' if you wish to override the API calculated value.

Note: If Table 24C is selected and the API 11.1(2007) F Factor in Pressure Correction Calculation
box is checked, the F factor entry is disabled as it is not used.

Vapor Pressure

The GPA TP16 and API 11.2.4 23E/24E(GPA TP27) standards specify that the equilibrium pres-
sure of the flowing fluid be calculated according to API 11.2.5(GPA TP15 extended). Two API
11.2.5 equations are available:

The older method, designed primarily for pure products such as propanes, butanes and nat-
ural gasolines, requires no input data other than the temperature at flowing conditions and the
specific gravity at reference.

The newer improved correlation, is suitable for use with more varied NGL mixtures, where dif-
ferent product mixes could have the same specific gravity at reference but different equilibrium
pressures.

The older method (enter a negative override value), calculates vapor pressure in PSIA at 100
degF and stores the result in Modbus register 7629 (for Meter 1) in absolute units. Enter a neg-
ative vapor pressure in the appropriate absolute pressure units of measure at 100 degF.

For the newer improved method, enter a positive vapor pressure in PSIA at 100 degF. The
flow computer stores this value in Modbus register 7629 (for Meter 1) in absolute units.

Mole Fraction of Propylene

This entry applies only to Propylene and Propylene/Propane mixtures.


Enter the mole fraction of pure Propylene in the mixture as follows: an entry of 1.0 means the mixture
is 100% pure Propylene. A Propylene fraction of 0.93 means the mixture is 93% Propylene and 7%
Propane.

Caution: Do not set this value to 0.0000 or it will be measuring 100% Propane and 0% Propylene.

331
OMNICOM: Setup (Firmware Versions 20 and 21)

Note: when this table is selected in the Product Measurement Algorithm page, the mole fraction is
set to 1.0.

Use Separate CTL and CPL(available with firmware 20.74.22 and higher)

This field is provided when one of the API 11.1 (2007) Commodity Group tables is selected:

If the box is not checked, the combined CTPL factor calculated by API 11.1 is used to cal-
culate the corrected volume.

If the box is checked, the individual CTL and CPL are multiplied together to calculate the cor-
rected volume.

Base Pressure (Pe)(available with firmware 20.74.24 and higher)

The use of Base Pressure (Pe) at a value other than 0 was introduced by API in the API MPMS 11.1
(2007) standard.

Enter this value in gauge units, not absolute units. Default value is 0.00.

In API MPMS 11.1 (2007), this setting is always referred to as Base Pressure (Pe) but otherwise
known as Equilibrium Pressure. It is used in the CPL equation when choosing any of the API 11.1
(2007) Commodity Types and the flow computer now optionally allows you to use it when using any
of the API 11.1 (1980 edition) tables if you have selected the “Use API 11.1(2007) F Factor for CPL”
option.

In certain applications, additives may be introduced into the flowing product in order to reduce the vis-
cosity and thus facilitate movement of the product through the pipeline. The introduction of additives
into the product can sometimes change the base or equilibrium pressure of the flowing product to
something other than 0.00.

This setting allows usage of Pe at values other than 0 gauge pressure when calculating CPL.

Correction for Dissolved Air in Water(available with firmware 20.74.10 and higher)

This entry applies only when measuring Water.

Check this box to have the flow computer correct the calculated water density for the presence of dis-
solved air.

The Patterson and Morris equation specified by API MPMS Chapter 11.4.1 assumes that the water
being measured is free of all air. This is usually not the case unless the water is in a vacuum. Consult
API MPMS Chapter 11.4.1 Appendix D for further information.

332
OMNICOM: Setup (Firmware Versions 20 and 21)

NGL K0 Coefficient(available with firmware 20.74.14 and higher)

When NGL product type is selected, the OMNI flow computer uses a modified version of API Tables
23A and 24A which allows the user to substitute empirically derived values for coefficients K0 and
K1.

Enter the experimentally determined coefficient K0.

NGL K1 Coefficient(available with firmware 20.74.14 and higher)

When NGL product type is selected the OMNI flow computer uses a modified version of API Tables
23A and 24A which allows the user to substitute empirically derived values for coefficients K0 and
K1.

Enter the experimentally determined coefficient K1.

NGL Equilibrium Pressure(available with firmware 20.74.14 and higher)

When NGL product type is selected the OMNI flow computer uses a modified version of API Tables
23A and 24A which allows the user to substitute empirically derived values for coefficients K0 and
K1.

NGL products are more volatile than crude oil and may have an elevated equilibrium pressure which
must be taken into account when calculating the pressure correction factor CPL.

Enter the equilibrium pressure in gauge pressure units at flowing temperature.

333
OMNICOM: Setup (Firmware Version 22)

Setup (Firmware Version 22)


The Product Setup for Liquid Applications is for entering meter factors for each flowmeter and inform-
ation about each of the products. Once you enter the information and/or make your selections, press
the [Apply] button to set.

Settings
Below are the settings used to configure the Product Setup Screen:

API Override

This is the API gravity at reference conditions. It is used to calculate the volume correction factor
VCF and the pressure correction factor CPL.

The Override gravity can also be entered as Specific Gravity (next entry).

When using a densitometer or gravitometer with API 11.1 (2007) Commodity Types measurement
selections, see the 'Calculate Reference API/SG' help topic below. For all other tables, specify a neg-
ative override value to have the flow computer use the live density to calculate reference density. If
you specify a “positive” override value (note that a value of 0 is considered positive), the flow com-
puter will disregard the live density value and back calculate the meter density using the reference
density derived from the override API.

SG Override

This is the specific gravity at reference conditions. It is used to calculate the volume correction factor
CTL (VCF) and the pressure correction factor CPL.

The Override gravity can also be entered as API Gravity (last entry).

When using a densitometer or gravitometer with API 11.1 (2007) Commodity Types measurement
selections, see the 'Calculate Reference API/SG' help topic below. For all other tables, specify a neg-
ative override value to have the flow computer use the live density to calculate reference density. If
you specify a “positive” override value (note that a value of 0 is considered positive), the flow com-
puter will disregard the live density value and back calculate the meter density using the reference
density derived from the override SG.

API 11.1 (2007) F factor in Pressure Correction Calculation (available with firmware
22.74.06 and higher)

If any of the API MPMS Chapter 11.1 (1980 edition) measurement algorithm tables are selected, a
checkbox is provided for the CPL calculation:

334
OMNICOM: Setup (Firmware Version 22)

If the box is checked, the OMNI uses the API 11.1.3.3(2007) calculated F factor to calculate
the CPL.
If the box is unchecked, the OMNI uses the API 11.2.1(1981) or API 11.2.2(1981) to calculate
the CPL.

Calculate Reference API/SG (Use Observed Density)(available with firmware


22.74.06 and higher)

This setting applies only when selecting one of the API 11.1 (2007) Commodity Types standards
and if you would like the flow computer to calculate the reference density using the transducer dens-
ity.

Note: A negative override value for the API@60 or SG@60 when using API 11.1 (2007) is not used
by the flow computer in the same way as when you are using API 11.1 (1980).

The reason for this is that with API 11.1 (2007) the API range has been expanded down to a value of
-10 (negative 10) whereas when using API 11.1 (1980), the lowest valid API value is 0. Since it is not
possible to specify a double negative 10 as an API override value, the Use Observed Density setting
option was added to instruct the flow computer to use the transducer (observed) density to calculate
the reference density.

If you have a live density and you would like the flow computer to use the live density to calculate the
reference density, check this box and specify either a negative or positive override value for the ref-
erence API or SG override.

If the transducer then fails and you have the transducer Fail Code set to 'Use Product Override on
Transmitter Fail', the flow computer will use the absolute value of the override API or SG you
entered in the Product area to calculate the reference density and will back calculate the meter dens-
ity.

If you have a live flowing density and would like to use an override API or SG at reference, specify a
positive override value for the API or SG at reference setting, and do not check this box.

USING A DENSITOMETER OR GRAVITOMETER FOR THIS PRODUCT


Checking this box causes the flow computer to use the signal from the densitometer or gravitometer
and correct it to reference temperature and pressure if required (this may be at flowing or reference
conditions. See 'Process Input' configuration tab).

USING THE SG OVERRIDE WHEN THE GRAVITOMETER OR DENSITOMETER FAILS


Should the densitometer or gravitometer fail, the flow computer can be made to use the API/SG over-
ride by selecting 'On transmitter fail use product override' in the 'Process Input' configuration tab.

Alpha Coefficient

API algorithms Table 24C, and 11.1 Special Applications Commodity Group require a value for
'Alpha-T' coefficient to be entered. This Alpha-T value is used to calculate the volume correction
factor 'VCF', also known as CTL.

335
OMNICOM: Setup (Firmware Version 22)

Enter Alpha at 60 degF per degF units.

F Factor Override

Enter the F Factor override in PSIG units.

Enter 0.0 if you wish the flow computer to use API 11.2.1M or API 11.2.2M to calculate the
compressibility factor 'F' used in the CPL equation.
Enter a suitable compressibility factor 'F' if you wish to override the API calculated value.

Note: If Table 24C or Table 6C is selected and the API 11.1(2007) F Factor in Pressure Correction
Calculation box is checked, the F factor entry is disabled as it is not used.

Use ASTM D1250 (1952) instead of API Table 23/24A(available with firmware
22.74.33 and higher and 22.75.01 and higher)

If the GPA TP16 measurement algorithm is selected, a checkbox is enabled for the user to select the
algorithm used by the OMNI to calculate SG @60 degF and the VCF. If the box is checked, the
OMNI uses the ASTM D1250 (1952) Table. If the box is not checked, API Table 23/24A is used.
The default is API Table 23/24A.

Vapor Pressure

The GPA TP16 and API 11.2.4 23E/24E(GPA TP27) standards specify that the equilibrium pres-
sure of the flowing fluid be calculated according to API 11.2.5(GPA TP15 extended). Two API
11.2.5 equations are available:

The older method, designed primarily for pure products such as propanes, butanes and nat-
ural gasolines, requires no input data other than the temperature at flowing conditions and the
specific gravity at reference.

The newer improved correlation, is suitable for use with more varied NGL mixtures, where dif-
ferent product mixes could have the same specific gravity at reference but different equilibrium
pressures.

The older method (enter a negative override value), calculates vapor pressure in PSIA at 100
degF and stores the result in Modbus register 7629 (for Meter 1) in absolute units. Enter a neg-
ative vapor pressure in the appropriate absolute pressure units of measure at 100 degF.

For the newer improved method, enter a positive vapor pressure in PSIA at 100 degF. The
flow computer stores this value in Modbus register 7629 (for Meter 1) in absolute units.

Use Separate CTL and CPL(available with firmware 22.74.06 and higher)

336
OMNICOM: Setup (Firmware Version 22)

This field is provided when one of the API MPMS Chapter 11.1 (2007) Commodity Group tables is
selected:

If the box is not checked, the combined CTPL factor calculated by API 11.1 is used to cal-
culate the corrected volume.
If the box is checked, the individual CTL and CPL are multiplied together to calculate the cor-
rected volume.

Base Pressure (Pe)(available with firmware 22.74.30 and higher)

The use of Base Pressure (Pe) at a value other than 0 was introduced by API in the API MPMS 11.1
(2007) standard.

Enter this value in gauge units, not absolute units. Default value is 0.00.

In API MPMS 11.1 (2007), this setting is always referred to as Base Pressure (Pe) but otherwise
known as Equilibrium Pressure. It is used in the CPL equation when choosing any of the API 11.1
(2007) Commodity Types and the flow computer now optionally allows you to use it when using any
of the API 11.1 (1980 edition) tables if you have selected the “Use API 11.1(2007) F Factor for CPL”
option.

In certain applications, additives may be introduced into the flowing product in order to reduce the vis-
cosity and thus facilitate movement of the product through the pipeline. The introduction of additives
into the product can sometimes change the base or equilibrium pressure of the flowing product to
something other than 0.00.

This setting allows usage of Pe at values other than 0 gauge pressure when calculating CPL.

Apply Hydrometer Correction(available with firmware 22.75.00 and higher)

Do not check the 'Apply Hydrometer Correction' if you have a live density input from an online dens-
itometer. The default is not to apply hydrometer correction (unchecked).

The 'Apply Hydrometer Correction' should only be checked if you have configured a virtual dens-
itometer I/O point, a density temperature I/O point, and a density pressure I/O point and intend to
enter observed API gravity and temperature as overrides into these virtual I/O devices (pressure
override must always be 0 PSIG). i.e. In this case, the flow computer will correct the entered
observed API gravity measured using a glass hydrometer to API at 60 degF using Table 5A or 5B
and the entered observed temperature.

337
OMNICOM: Setup (Firmware Version 24)

Setup (Firmware Version 24)


The Product Setup for Liquid Applications is for entering meter factors for each flowmeter and inform-
ation about each of the products. Once you enter the information and/or make your selections, press
the [Apply] button to set.

Settings
Below are the settings used to configure the Product Setup Screen:

Reference Density Override

Enter the density of the fluid in kg/m3 at base or reference temperature and pressure.

Specify a negative override value to have the flow computer use the live density to calculate
reference density. If you specify a 'positive' override value (note that a value of 0 is considered
positive), the flow computer will disregard the live density value and back calculate the meter
density using the reference density override.

When using a densitometer or gravitometer with API 11.1 (2007) Commodity Types meas-
urement selections, see the 'Use Observed Density (Calculate Reference Density)' help topic
below instead of using a negative number.

For Alcohols, please use the 'Use Observed Density' setting in the 'Alcohol Calculation Selec-
tion' help topic below instead of using a negative number.

Reference Temperature

Enter the reference or base temperature that all fluid volumes will be corrected to. The OMNI
flow computer will correct measured Gross indicated volumes to the equivalent Net standard
volumes measured at this reference temperature.

Note: For Tables 59A/60A, 59B/60B, 59D/60D, 59E/60E and Alcohol ABNT and Alcohol
OIML, the reference temperature is defaulted to 20 degC and disabled.

API 11.1 (2007) F factor in Pressure Correction Calculation(available with firm-


ware 24.74.18 and higher)

If any of the API MPMS Chapter 11.1 (1980 edition) measurement algorithm tables are selec-
ted, a checkbox is provided for the CPL calculation:

If the box is checked, the OMNI uses the API 11.1.3.3(2007) calculated F factor to cal-
culate the CPL.
If the box is unchecked, the OMNI uses the API 11.2.1(1981) or API 11.2.2(1981) to

338
OMNICOM: Setup (Firmware Version 24)

calculate the CPL.

Use Observed Density (Calculate Reference Density)

This setting applies only when selecting one of the API 11.1 (2007) Commodity Types stand-
ards and if you would like the flow computer to calculate the reference density using the trans-
ducer density.

If you have a live density and you would like the flow computer to use the live density to cal-
culate the reference density, check this box and specify either a negative or positive override
value for the reference density. If the transducer fails and you have the transducer Fail Code
set to 'Use Product Override on Transmitter Fail', the flow computer will use the absolute
value of the reference density override you entered in the Product area and will back calculate
the meter density.

If you have a live flowing density and would like to specify an override reference density, spe-
cify a positive override value for the reference density, and do not check this box.

If you do not have a live density, specify a positive override value for the reference density and
do not check this box. The flow computer will use the reference density override value you
entered in the Product area and will back calculate the meter density.

USING A DENSITOMETER FOR THIS PRODUCT


Checking this box causes the flow computer to use the signal from the densitometer and cor-
rect it to reference temperature and pressure if required (this may be at flowing or reference
conditions. See 'Process Input' configuration tab).

USING THE DENSITY OVERRIDE WHEN THE DENSITOMETER FAILS


Should the densitometer fail, the flow computer can be made to use the Reference Density
override by selecting 'On transmitter fail use product override' in the 'Process Input' con-
figuration tab.

Alpha Coefficient

API algorithms Table 54C and 11.1 Special Applications Commodity Group require a value
for 'Alpha-T' coefficient. to be entered. This Alpha-T value is used to calculate the volume cor-
rection factor 'VCF', also known as CTL.

For Table 54C, enter Alpha at 15 degC per degC units.

For 11.1 (2007) Special Applications Commodity Group, enter Alpha at 60 degF per
degF units.

F Factor Override

339
OMNICOM: Setup (Firmware Version 24)

Enter the F Factor override in kPa units even if the pressure units selection in the Factors and
Constants screen was selected as something other than kPa.

Enter 0.0 if you wish the flow computer to use API 11.2.1M or API 11.2.2M to calculate
the compressibility factor 'F' used in the CPL equation.*

Enter a suitable compressibility factor 'F' if you wish to override the API calculated
value.*

Note: If Table 54C is selected and the API 11.1(2007) F Factor in Pressure Correction Cal-
culation box is checked, the F factor entry is disabled as it is not used.

*Note: If an Alcohol measurement algorithm is selected, the compressibility factor 'F' of the
Ethanol and its mixtures with water is calculated using API 11.2.1M/API 11.2.2M when a neg-
ative F factor override is entered. The pressure correction factor, CPL, is calculated using
either the calculated F factor or using an entered positive non-zero F factor override. If the F
Factor override is zero (default), the CPL will be set to 1.0.

Vapor Pressure at 37.8 degC.

The GPA TP16M and API 11.2.4,53E/54E(GPA TP27M) standards specify that the equi-
librium pressure of the flowing fluid be calculated according to API 11.2.5(GPA TP15M exten-
ded). Two API 11.2.5 equations are available:

The older method, designed primarily for pure products such as propanes, butanes and
natural gasolines, requires no input data other than the temperature at flowing con-
ditions and the density at reference.

The newer improved correlation, is suitable for use with more varied NGL mixtures,
where different product mixes could have the same density at reference but different
equilibrium pressures.

The older method (enter a negative override), calculates vapor pressure in gauge units
at 37.8 degC, and stores the result into Modbus register 7629 (for Meter 1) in gauge
units.

For the newer improved method, enter the vapor pressure in absolute units at 37.8
degC. The flow computer stores this override value in Modbus register 7629 (for Meter
1) in absolute units.

The vapor pressure result from whichever method is in use, is then used to calculate
Equilibrium Pressure and is stored in Modbus register 7624 (for Meter 1) in gauge units.

NGL K0 Coefficient

340
OMNICOM: Setup (Firmware Version 24)

When NGL product type is selected, the OMNI flow computer uses a modified version of API
Tables 53A and 54A which allows the user to substitute empirically derived values for coef-
ficients K0 and K1.

Enter the experimentally determined coefficient K0.

NGL K1 Coefficient

When NGL product type is selected the OMNI flow computer uses a modified version of API
Tables 53A and 54A which allows the user to substitute empirically derived values for coef-
ficients K0 and K1.

Enter the experimentally determined coefficient K1.

NGL Equilibrium Pressure

When NGL product type is selected the OMNI flow computer uses a modified version of API
Tables 53A and 54A which allows the user to substitute empirically derived values for coef-
ficients K0 and K1.

NGL products are more volatile than crude oil and may have an elevated equilibrium pressure
which must be taken into account when calculating the pressure correction factor CPL.

Enter the equilibrium pressure in gauge pressure units at flowing temperature.

Mole Fraction of Propylene

This entry applies only to Propylene and Propylene/Propane mixtures.


Enter the mole fraction of pure Propylene in the mixture as follows: an entry of 1.0 means the
mixture is 100% pure Propylene. A Propylene fraction of 0.93 means the mixture is 93% Pro-
pylene and 7% Propane.

Caution: Do not set this value to 0.0000 or it will be measuring 100% Propane and 0% Pro-
pylene.

Note: when this table is selected in the Product Measurement Algorithm page, the mole frac-
tion is set to 1.0.

Use Separate CTL and CPL(available with firmware 24.74.18 and higher)

This field is provided when one of the API 11.1 (2007) Commodity Group tables is selected:

If the box is not checked, the combined CTPL factor calculated by API 11.1 is used to
calculate the corrected volume.

341
OMNICOM: Setup (Firmware Version 24)

If the box is checked, the individual CTL and CPL are multiplied together to calculate
the corrected volume.

Base Pressure (Pe)(available with firmware 24.74.18 and higher)

The use of Base Pressure (Pe) at a value other than 0 was introduced by API in the API
MPMS 11.1 (2007) standard.

Enter this value in gauge units, not absolute units. Default value is 0.00.

In API MPMS 11.1 (2007), this setting is always referred to as Base Pressure (Pe) but oth-
erwise known as Equilibrium Pressure. It is used in the CPL equation when choosing any of
the API 11.1 (2007) Commodity Types and the flow computer now optionally allows you to
use it when using any of the API 11.1 (1980 edition) tables if you have selected the 'Use API
11.1(2007) F Factor for CPL' option.

In certain applications, additives may be introduced into the flowing product in order to reduce
the viscosity and thus facilitate movement of the product through the pipeline. The introduction
of additives into the product can sometimes change the base or equilibrium pressure of the
flowing product to something other than 0.00.

This setting allows usage of Pe at values other than 0 gauge pressure when calculating CPL.

Correction for Dissolved Air in Water(available with firmware 24.74.17 and


higher)

This entry applies only when measuring Water.

Check this box to have the flow computer correct the calculated water density for the pres-
ence of dissolved air.

The Patterson and Morris equation specified by API MPMS Chapter 11.4.1 assumes that the
water being measured is free of all air. This is usually not the case unless the water is in a
vacuum. Consult API MPMS Chapter 11.4.1 Appendix D for further information.

NIST14 Reference Pressure

If you entered a negative value for the override reference density setting, enter the reference
or base pressure in absolute units that the NIST14 calculated reference density will be cor-
rected to.

If you entered a positive value for the override reference density setting, the OMNI completely
disregards this setting but it is recommended you enter the reference or base pressure in abso-
lute units that the override reference density was corrected to for documentation purposes.

342
OMNICOM: Setup (Firmware Version 24)

NIST14 Analysis Basis(available with firmware 24.74.17 and higher)

Enter the basis in which the components are analyzed for the NIST14 equations. The
choices are Mole Percent, Mole Fraction, Mass Percent, and Mass Fraction.

Asphalt - Factor A or B(available with firmware versions 24.75.03 and higher)

Asphalt - the user may select for the OMNI to use Factor A or Factor B in the ASTM D4311M-
09 calculation.
If reference temperature is 15 degC, the standard states to use Factor A if the override density
is 965 kg/m3 or greater and Factor B if 865 to 965 kg/m3.
Since the user may enter a reference temperature other than 15 degC, we provide the option
of selecting which factor to use.

Alcohol Calculation Selection(available with firmware versions 24.75.04 and


higher)

The calculations selections are:


Use Reference Density Override - select this option to enter and use a fixed reference
density in the alcohol strength by mass calculation. Note that a negative reference dens-
ity is not allowed - select 'Use Observed Density' instead.
Use Observed Density - use the live density in the calculation of the alcohol strength by
mass percent.
Use Strength by Mass Percent - enter the strength by mass percent.

Alcohol Strength by Mass Percent(available with firmware versions 24.75.04


and higher)

If 'Use Strength by Mass Percent' is selected for the Alcohol Calculation, enter the alcohol
strength by mass percent ranging from zero to 100%. The default is zero.

The alcohol strength by mass percent along with the observed temperature are used to cal-
culate the density of Ethanol and its mixture with water.

343
OMNICOM: Setup (Firmware Version 26)

Setup (Firmware Version 26)


The Product Setup for Liquid Applications is for entering meter factors for each flowmeter and inform-
ation about each of the products. Once you enter the information and/or make your selections, press
the [Apply] button to set.

Settings
Below are the settings used to configure the Product Setup Screen:

Reference Density Override

Enter the density of the fluid in kg/m3 at base or reference temperature and pressure.

Specify a negative override value to have the flow computer use the live density to calculate ref-
erence density. If you specify a 'positive' override value (note that a value of 0 is considered positive),
the flow computer will disregard the live density value and back calculate the meter density using the
reference density override.

When using a densitometer or gravitometer with API 11.1 (2007) Commodity Types measurement
selections, see the 'Use Observed Density (Calculate Reference Density)' help topic below instead
of using a negative number.

For Alcohols, please use the 'Use Observed Density' setting in the 'Alcohol Calculation Selection'
help topic below instead of using a negative number.

Reference Temperature

Enter the reference or base temperature that all fluid volumes will be corrected to. The OMNI flow
computer will correct measured Gross indicated volumes to the equivalent Net standard volumes
measured at this reference temperature.

Note: For Tables 59A/60A, 59B/60B, 59D/60D, 59E/60E and Alcohol ABNT and Alcohol OIML, the
reference temperature is defaulted to 20 degC and disabled.

API 11.1 (2007) F factor in Pressure Correction Calculation

If any of the API MPMS Chapter 11.1 (1980 edition) measurement algorithm tables are selected, a
checkbox is provided for the CPL calculation:

If the box is checked, the OMNI uses the API 11.1.3.3(2007) calculated F factor to calculate
the CPL.
If the box is unchecked, the OMNI uses the API 11.2.1(1981) or API 11.2.2(1981) to calculate
the CPL.

344
OMNICOM: Setup (Firmware Version 26)

Use Observed Density (Calculate Reference Density)(available with firmware


26.74.10 and higher)

This setting applies only when selecting one of the API 11.1 (2007) Commodity Types standards
and if you would like the flow computer to calculate the reference density using the transducer dens-
ity.

If you have a live density and you would like the flow computer to use the live density to calculate the
reference density, check this box and specify either a negative or positive override value for the ref-
erence density. If the transducer fails and you have the transducer Fail Code set to 'Use Product
Override on Transmitter Fail', the flow computer will use the absolute value of the reference density
override you entered in the Product area and will back calculate the meter density.

If you have a live flowing density and would like to specify an override reference density, specify a
positive override value for the reference density, and do not check this box.

If you do not have a live density, specify a positive override value for the reference density and do not
check this box. The flow computer will use the reference density override value you entered in the
Product area and will back calculate the meter density.

USING A DENSITOMETER OR GRAVITOMETER FOR THIS PRODUCT


Checking this box causes the flow computer to use the signal from the densitometer or gravitometer
and correct it to reference temperature and pressure if required (this may be at flowing or reference
conditions. See 'Process Input' configuration tab).

USING THE SG OVERRIDE WHEN THE GRAVITOMETER OR DENSITOMETER FAILS


Should the densitometer or gravitometer fail, the flow computer can be made to use the API/SG over-
ride by selecting 'On transmitter fail use product override' in the 'Process Input' configuration tab.

Alpha Coefficient

API algorithms Table 54C and 11.1 Special Applications Commodity Group require a value for
'Alpha-T' coefficient. to be entered. This Alpha-T value is used to calculate the volume correction
factor 'VCF', also known as CTL.

For Table 54C, enter Alpha at 15 degC per degC units.

For 11.1 (2007) Special Applications Commodity Group, enter Alpha at 60 degF per degF
units.

F Factor Override

Enter the F Factor override in kPa units.

Enter 0.0 if you wish the flow computer to use API 11.2.1M or API 11.2.2M to calculate the
compressibility factor 'F' used in the CPL equation.*

345
OMNICOM: Setup (Firmware Version 26)

Enter a suitable compressibility factor 'F' if you wish to override the API calculated value.*

Note: If Table 54C is selected and the API 11.1(2007) F Factor in Pressure Correction Calculation
box is checked, the F factor entry is disabled as it is not used.

*Note: If an Alcohol measurement algorithm is selected, the compressibility factor 'F' of the Ethanol
and its mixtures with water is calculated using API 11.2.1M/API 11.2.2M when a negative F factor
override is entered. The pressure correction factor, CPL, is calculated using either the calculated F
factor or using an entered positive non-zero F factor override. If the F Factor override is zero
(default), the CPL will be set to 1.0.

Vapor Pressure at 37.8 degC.

The GPA TP16M and API 11.2.4,53E/54E(GPA TP27M) standards specify that the equilibrium pres-
sure of the flowing fluid be calculated according to API 11.2.5(GPA TP15M extended). Two API
11.2.5 equations are available:

The older method, designed primarily for pure products such as propanes, butanes and nat-
ural gasolines, requires no input data other than the temperature at flowing conditions and the
density at reference.

The newer improved correlation, is suitable for use with more varied NGL mixtures, where dif-
ferent product mixes could have the same density at reference but different equilibrium pres-
sures.

The older method (enter a negative override), calculates vapor pressure in gauge units at 37.8
degC, and stores the result into Modbus register 7629 (for Meter 1) in gauge units.

For the newer improved method, enter the vapor pressure in absolute units at 37.8 degC. The
flow computer stores this override value in Modbus register 7629 (for Meter 1) in absolute
units.

The vapor pressure result from whichever method is in use, is then used to calculate Equi-
librium Pressure and is stored in Modbus register 7624 (for Meter 1) in gauge units.

Use Separate CTL and CPL(available with firmware 26.74.10 and higher)

This field is provided when one of the API 11.1 (2007) Commodity Group tables is selected:

If the box is not checked, the combined CTPL factor calculated by API 11.1 is used to cal-
culate the corrected volume.
If the box is checked, the individual CTL and CPL are multiplied together to calculate the cor-
rected volume.

Base Pressure (Pe)(available with firmware 26.74.10 and higher)

346
OMNICOM: Setup (Firmware Version 26)

The use of Base Pressure (Pe) at a value other than 0 was introduced by API in the API MPMS 11.1
(2007) standard.

Enter this value in gauge units, not absolute units. Default value is 0.00.

In API MPMS 11.1 (2007), this setting is always referred to as Base Pressure (Pe) but otherwise
known as Equilibrium Pressure. It is used in the CPL equation when choosing any of the API 11.1
(2007) Commodity Types and the flow computer now optionally allows you to use it when using any
of the API 11.1 (1980 edition) tables if you have selected the 'Use API 11.1(2007) F Factor for CPL'
option.

In certain applications, additives may be introduced into the flowing product in order to reduce the vis-
cosity and thus facilitate movement of the product through the pipeline. The introduction of additives
into the product can sometimes change the base or equilibrium pressure of the flowing product to
something other than 0.00.

This setting allows usage of Pe at values other than 0 gauge pressure when calculating CPL.

Alcohol Calculation Selection(available with firmware versions 26.75.03 and


higher)

The calculations selections are:


Use Reference Density Override - select this option to enter and use a fixed reference density
in the alcohol strength by mass calculation. Note that a negative reference density is not
allowed - select 'Use Observed Density' instead.
Use Observed Density - use the live density in the calculation of the alcohol strength by mass
percent.
Use Strength by Mass Percent - enter the strength by mass percent.

Alcohol Strength by Mass Percent(available with firmware versions 26.75.03 and


higher)

If a live density is not used ('Use Observed Density' is not checked), the entered alcohol strength by
mass percent is used to calculate the density of Ethanol and its mixtures with water at observed tem-
perature, the density at a base temperature of 20 degC, and the volume correction factor at
observed temperature.

347
OMNICOM: Meter Factor Curve

Meter Factor Curve

A meter factor curve page is shown for each configured meter run.

Curve Date

Use this entry to record the date which helps identify when the meter factor curve was determ-
ined.

Meter Factors
Up to twelve meter factors per product / per meter can be entered.
The flow computer dynamically interpolates the curve to determine the correct factor to apply
at any flow rate.

Flow Rates

Enter the flow rate that existed when the meter factor was determined. Up to twelve meter
factor / flow rates can be entered per meter per
product.
Data sets must be entered lowest flow rate first working up to maximum rate last.

348
OMNICOM: Fluid Products

Fluid Products
In the Fluid Products dialogs you can enter and select various meter run configuration settings for up
to 8 products. Based upon the Linearization Method you selected within the Application dialog of the
Meter Run Setup, OMNICOM makes available only those dialogs that apply to your meter run con-
figuration.

Topics
The items listed below are links to topics within the Fluid Products setup. Click on a link to go to that
topic.

Setup
Live Input
Analysis
NIST14 Component Analysis

349
OMNICOM: Fluid Setup

Fluid Setup
The Fluid Setup is for entering the type of gas and gas analysis data for each of the products.

Topics
The items listed below are links to topics within the Fluid Setup category. Click on a link to go to that
topic.

Fluid Setup (Firmware 23)


Fluid Setup (Firmware 27)

350
OMNICOM: Fluid Setup (Firmware Version 23)

Fluid Setup (Firmware Version 23)


The Fluid Setup is for entering the type of gas and gas analysis data for each of the products. Once
you enter the information and / or make your selections, press the [Apply] button to set.

Settings
Below are the settings used to configure the Fluid Setup Screen:

Fluid Type

Select the fluid or gas you will be measuring when this product is selected.

The choices are:

Fluid Type Equation


Using AGA 8 1994,1992 and 1985 Equation of State
Natural Gas
*
Steam (ASME) Using ASME Equation of State
Steam (NIST) Using NIST Equation of State **
Based on the publication containing the density equa-
Water (K&K) tions by
Joseph H. Keenan, Frederick G
Argon Using NIST 1048 Equation of State
Nitrogen Using NIST 1048 Equation of State
Oxygen Using NIST 1048 Equation of State
Hydrogen Using NIST 1048 Equation of State
Ethylene Using NIST 1048 Equation of State
Ethylene IUPAC Using IUPAC 1988 Equation of State
Using NIST 14 Equations to calculate density, heat-
ing value, Cp, Cp/Cv,
sound velocity, Joules Thompson coefficient and vis-
NIST14
cosity.
(Available with firmware versions 23.74.19 and
higher)
*Note: AGA-8 can also be used for many other GAS mixtures including Carbon
Dioxide.
**Note: (NBS later became NIST)

Fluid Name

Enter up to eight ASCII characters to identify this product on reports.

Viscosity

351
OMNICOM: Fluid Setup (Firmware Version 23)

Note: Viscosity is only required in differential pressure device calculations.

Fluid Type Viscosity Override Calculate Viscosity


Starting with firmware version 23.75.02:
For AGA-8 Detailed Method, select the “Cal-
culate Viscosity” radio button. It uses the LBC
calculation.

For AGA-8 Method 2, select the “Calculate


Viscosity” radio button. The LBC calculation
In all versions of 23 firm-
Natural with an estimated component method is used.
ware, enter a positive vis-
Gas
cosity override value.
Starting with firmware version 23.75.00:
For AGA-8 Detailed Method, select the “Cal-
culate Viscosity” radio button. It uses the LBC
calculation.

Firmware versions prior to 23.75.00 do not support


calculation of viscosity.
Starting with firmware version 23.75.00:
Select the “Calculate Viscosity” radio button.
In all versions of 23 firm- It uses the Equation of State.
Steam
ware, enter a positive vis-
(ASME)
cosity override value. For firmware versions prior to 23.75.00
Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 23.75.00:
Select the “Calculate Viscosity” radio button.
In all versions of 23 firm- It uses the Equation of State.
Steam
ware, enter a positive vis-
(NIST)
cosity override value. For firmware versions prior to 23.75.00
Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 23.75.00:
Select the “Calculate Viscosity” radio button.
In all versions of 23 firm- It uses the Equation of State.
Water
ware, enter a positive Vis-
(K&K)
cosity override value. For firmware versions prior to 23.75.00
Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 23.75.00:
Select the “Calculate Viscosity” radio button.
In all versions of 23 firm- It uses the Equation of State.
Argon ware, enter a positive Vis-
cosity override value. For firmware versions prior to 23.75.00
Enter a negative viscosity override. It uses the
Equation of State.

352
OMNICOM: Fluid Setup (Firmware Version 23)

Starting with firmware version 23.75.00:


Select the “Calculate Viscosity” radio button.
In all versions of 23 firm- It uses the Equation of State.
Nitrogen ware, enter a positive vis-
cosity override value. For firmware versions prior to 23.75.00
Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 23.75.00:
Select the “Calculate Viscosity” radio button.
In all versions of 23 firm- It uses the Equation of State.
Oxygen ware, enter a positive vis-
cosity override value. For firmware versions prior to 23.75.00
Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 23.75.00:
Select the “Calculate Viscosity” radio button.
In all versions of 23 firm- It uses the Equation of State.
Hydrogen
ware, enter a positive vis-
cosity override value. For firmware versions prior to 23.75.00
Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 23.75.00:
Select the “Calculate Viscosity” radio button.
In all versions of 23 firm- It uses the Equation of State.
Ethylene ware, enter a positive vis-
cosity override value. For firmware versions prior to 23.75.00
Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 23.75.00:
Select the “Calculate Viscosity” radio button.
In all versions of 23 firm- It uses the Equation of State.
Ethylene
ware, enter a positive vis-
IUPAC
cosity override value. For firmware versions prior to 23.75.00
Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 23.75.00:
Select the “Calculate Viscosity” radio button.
In all versions of 23 firm- It uses the Equation of State.
NIST14 ware, enter a positive vis-
cosity override value. For firmware versions prior to 23.75.00
Enter a negative viscosity override. It uses the
Equation of State.

Use Override: enter the viscosity at flowing conditions.

In all versions of firmware, to use viscosity override, enter a positive viscosity override value.

353
OMNICOM: Fluid Setup (Firmware Version 23)

Enter the viscosity in centipoise units. For Natural Gas, reasonable viscosity limits are 0.005 to
0.1 cP and a reasonable value is 0.012 cP.

Calculate Viscosity:

For firmware versions 23.75.00 and higher, the 'Calculate' selection is available.

For firmware versions prior to 23.75.00 for all products except for Natural Gas, enter a neg-
ative value in the viscosity override to cause the flow computer to calculate viscosity.

For Steam (ASME and NIST), Water (K&K), NIST 1048, Ethylene IUPAC, and NIST14 fluid
types, the appropriate equation of state is used.

For Natural Gas, the viscosity calculation is LBC.

LBC

For firmware versions 23.75.00 and higher, this calculation requires a component ana-
lysis and is therefore suitable for Natural Gas with an AGA-8 1994, 1992, and 1985
detailed analysis. It is based on the following references:

GasVLe, Kay (Ind.Eng.Chem., 1936),

For firmware versions 23.75.02 and higher, for Natural Gas using density methods
AGA-8 1994 or 1992 Gross Method 2, where a full analysis is not available, the OMNI
estimates an abbreviated component analysis given heating value, relative density, and
CO2 mole percentage. The abbreviated component analysis consists of the following
components:

Methane (CH4)
Nitrogen (N2)
Carbon Dioxide (CO2)
Propane (C3H8)

All other components in the mixture will be set to zero.

Viscosity results calculated using the LBC method with this abbreviated component ana-
lysis and the LBC method were compared to results calculated using the full gas ana-
lysis in 1000 test cases. The maximum deviation between calculated viscosities was
less than +/- 0.1%.

Related Modbus Registers:


7n39 = Viscosity in Use (where n = 1-4 for Meter 1 - Meter 4)

Isentropic Exponent

Note: Isentropic Exponent is only required in differential pressure device calculations.

354
OMNICOM: Fluid Setup (Firmware Version 23)

Isentropic Exponent Over-


Fluid Type Calculate Isentropic Exponent
ride
Starting with firmware version 23.75.02:
For AGA-8 1994 Detailed Method with
AGA-10 enabled, select the “Calculate Isen
Exp” radio button and select the calculation
method:
Estimated
AGA-10

For all other Density Methods, select the


“Calculate Isen Exp” radio button. It uses
the Estimated method.
In all versions of 23 firm-
Natural ware, enter a positive isen- Starting with firmware version 23.75.00:
Gas tropic exponent override For AGA-8 1994 Detailed Method with
value. AGA-10 enabled, select the “Calculate Isen
Exp” radio button. It uses the AGA-10
method.

Starting with firmware version 23.74.11:


For AGA-8 1994 Detailed Method with
AGA-10 enabled, enter a negative isen-
tropic exponent override value. It uses the
AGA-10 method.

Firmware versions prior to 23.74.11 do not sup-


port the calculation of isentropic exponent.
In all versions of 23 firm-
Steam ware, enter a positive isen- Isentropic exponent calculation is not supported in
(ASME) tropic exponent override any firmware version.
value.
In all versions of 23 firm-
Steam ware, enter a positive isen- Isentropic exponent calculation is not supported in
(NIST) tropic exponent override any firmware version.
value.
In all versions of 23 firm-
Water ware, enter a positive isen- Isentropic exponent calculation is not supported in
(K&K) tropic exponent override any firmware version.
value.
Starting with firmware version 23.75.00:
Select the “Calculate Isen Exp” radio but-
In all versions of 23 firm-
ton. It uses the Equation of State.
ware, enter a positive isen-
Argon
tropic exponent override
For firmware versions prior to 23.75.00
value. Enter a negative isentropic exponent over-
ride. It uses the Equation of State.

355
OMNICOM: Fluid Setup (Firmware Version 23)

Starting with firmware version 23.75.00:


Select the “Calculate Isen Exp” radio but-
In all versions of 23 firm-
ton. It uses the Equation of State.
ware, enter a positive isen-
Nitrogen
tropic exponent override
For firmware versions prior to 23.75.00
value. Enter a negative isentropic exponent over-
ride. It uses the Equation of State.
Starting with firmware version 23.75.00:
Select the “Calculate Isen Exp” radio but-
In all versions of 23 firm-
ton. It uses the Equation of State.
ware, enter a positive isen-
Oxygen
tropic exponent override
For firmware versions prior to 23.75.00
value. Enter a negative isentropic exponent over-
ride. It uses the Equation of State.
Starting with firmware version 23.75.00:
Select the “Calculate Isen Exp” radio but-
In all versions of 23 firm-
ton. It uses the Equation of State.
Hydrogen ware, enter a positive isen-
tropic exponent override
For firmware versions prior to 23.75.00
value. Enter a negative isentropic exponent over-
ride. It uses the Equation of State.
Starting with firmware version 23.75.00:
Select the “Calculate Isen Exp” radio but-
In all versions of 23 firm-
ton. It uses the Equation of State.
ware, enter a positive isen-
Ethylene
tropic exponent override
For firmware versions prior to 23.75.00
value. Enter a negative isentropic exponent over-
ride. It uses the Equation of State.
Starting with firmware version 23.75.00:
Select the “Calculate Isen Exp” radio but-
In all versions of 23 firm-
ton. It uses the Equation of State.
Ethylene ware, enter a positive isen-
IUPAC tropic exponent override
For firmware versions prior to 23.75.00
value. Enter a negative isentropic exponent over-
ride. It uses the Equation of State.
In all versions of 23 firm-
ware, enter a positive isen- Isentropic exponent calculation is not supported in
NIST14
tropic exponent override any firmware version.
value.

Use Override: enter the Isentropic Exponent dimensionless factor for this product.

In all versions of firmware, to use isentropic exponent override, enter a positive override value.

For Natural Gas, reasonable isentropic exponent override limits are 1.0 to 3.0 and a reas-
onable value is 1.35.

Calculate Isentropic Exponent:

356
OMNICOM: Fluid Setup (Firmware Version 23)

Firmware versions 23.75.00 and higher provide a 'Calculate' selection for Natural Gas, NIST
1048, and Ethylene IUPAC fluid types.

Firmware versions prior to 23.75.00, for NIST 1048 and Ethylene IUPAC fluid types, enter a
negative override value to cause the flow computer to calculate Isentropic Exponent.

For NIST 1048 and Ethylene IUPAC fluid types, the appropriate equation of state is used.

For Natural Gas:


For firmware versions 23.75.02 and higher, the user may select the isentropic exponent
calculation:
Estimated

This is a simplified equation suitable for typical natural gases. Within the range 0
to 20 degC, 5 to 75 bar, it provides a standard uncertainty of 0.009 (compared
with calculation from AGA-8 / AGA-10 / ISO 20765:1). The uncertainty of the cal-
culated isentropic exponent may be higher when operating outside of these tem-
perature and pressure limits.

Isentropic Exponent = (1.3028 - 0.0005794 x Tf) + (-0.0008437 +


0.00002658 x Tf) x Pf + (0.00003267 - 5.517E-07 x Tf) x Pf^2
where:
Tf is in Centigrade
Pf is in bar absolute

If an input is out of range, the isentropic exponent is still calculated


however a calculation out of range alarm is raised.

The isentropic exponent of natural gases within these operating tem-


peratures and pressures ranges from approximately 1.28 to 1.43.

AGA-10

Available only for AGA-8 1994 detailed analysis when the AGA-10 calculation is
selected. The isentropic exponent is calculated by the AGA-10 equation.

For firmware versions prior to 23.75.00 through 23.74.11, for AGA-8 1994 Detailed
Method with AGA-10 enabled, enter a negative isentropic exponent override value. It
uses the AGA-10 method.

Firmware versions prior to 23.74.11 do not support calculation of isentropic exponent.

Related Modbus Registers:


 7n40 = Isentropic Exponent In Use (where n = 1-4 for Meter 1 - Meter 4)
18n28 = AGA-10 Calculated Isentropic Exponent (where n = 5-8 for Meter 1 - Meter 4)

SG

357
OMNICOM: Fluid Setup (Firmware Version 23)

The SG entry is only available for Natural Gas'. Net volumes are calculated by dividing mass flow by
density at reference conditions.

Override:
For AGA-8 Detailed Density methods:

Firmware versions earlier than 23.75.02 require a negative value to instruct the flow computer
to calculate density at reference conditions using the AGA-8 equation of state.

Firmware versions 23.75.02 and higher provide a Reference Density Calculation selection.
Note: the SG entry is only enabled for Natural Gas when the Reference Density Calculation
selection is 'SG @ Base Conditions x Density of Dry Air @ Base Conditions'.

For other density methods, enter a positive override value of specific gravity at reference con-
ditions that will be used together with the density of dry air entry to calculate the density at ref-
erence conditions.

For Product 1 only, this value is overwritten if SG is obtained from a frequency input from a
Micro Motion (Solartron) 3096/3098 gravitometer or from a 4-20ma SG input.

In cases where a chromatograph is used, this entry serves as the GC failure override. The GC
value of SG, if available, will also be used unless the component number for SG is set to '0' in
the 'Analysis Setup' screen.

Related Modbus Registers:


Relative Density (at base conditions) in use is 8n67 (where n = 5-8 for Meter 1 - Meter 4)

Heating Value

Override:

Firmware versions earlier than 23.75.02 require a negative value to be entered to cause the
flow computer to calculate heating value.

Firmware versions 23.75.02 and higher provide a 'Calculate Heating Value' selection. Neg-
ative values for override are not allowed in these firmware versions.

Enter a positive override value to be used in place of the calculated value in systems where a
GC is not available. In systems which use a GC, this override is also the fall back value should
the GC fail. The GC HV will always be used if available unless it is assigned the component
number '0' in the 'Analysis Setup' screen.

For Product 1 only, this value is overwritten if HV is obtained from a 4-20mA input from a BTU
analyzer.

Calculate Heating Value:

358
OMNICOM: Fluid Setup (Firmware Version 23)

For firmware versions 23.75.02 and higher the 'Calculate' option is available for Natural Gas
with an AGA-8 detailed density calculation, Steam (NIST), Water (K&K), NIST 1048
products, and NIST14.

For Steam (NIST), Water (K&K), NIST 1048 products, and NIST14 fluid types, the
appropriate equation of state is used.

For Natural Gas with an AGA-8 detailed density method is selected, the user may also
select the HV calculation method and how to handle the neo-Pentane component.
Select the equation to calculate the heating value of the gas:
AGA 5 (1999)
AGA-5 (2009) (available with firmware versions 23.75.02 and higher)
GPA 2172 (1996)*
GPA 2172 (2009)* (available with firmware versions 23.75.02 and higher)
ISO 6976 (1995)**

*Note: If GPA 2172 is selected:

For Firmware versions beginning with 23.75.10:


When specifying a default base temperature value equivalent to 60 degF AND
using an AGA-8 Detailed Density Method, the flow computer uses the simplified
method shown in the GPA-2172 standard to calculate the heating value. Any
base pressure can be used.

If specifying a base temperature other than the default 60 degF value, the flow
computer uses the alternate Basic program (also part of the GPA-2172 standard
and known as Equation A.7 or Equation 7) to calculate the heating value. Any
base pressure can be used.

For Firmware versions prior to 23.75.10:


When specifying a default base temperature value of 60 degF, AND when spe-
cifying a base pressure in absolute units of 14.696 PSI, AND using an AGA-8
Detailed Density Method, the flow computer uses the simplified method shown in
the GPA-2172 standard to calculate the heating value.

If specifying a base temperature other than the default 60 degF value, OR when
specifying a base pressure in absolute units other than 14.696 PSI, AND using
an AGA-8 Detailed Density Method, the flow computer uses the alternate Basic
program (also part of the GPA-2172 standard and known as Equation A.7 or
Equation 7) to calculate the heating value.

**Note: If ISO 6976 (1995) is selected, the calculations are made based on:
15 degC for firmware versions 23.75.01 and lower
60 degF for firmware versions 23.75.02 and higher (the OMNI calculates using ISO
6976 (1995) Annex L)

neo-Pentane component - the following choices are available regarding how the neo-Pentane
component is to be used in the HV calculation:

359
OMNICOM: Fluid Setup (Firmware Version 23)

use the neo-Pentane component (AGA-5 (1999), AGA-5 (2009), and ISO 6976 (1995))
disregard the neo-Pentane component (GPA 2172 (1996) and GPA 2172 (2009))
add the neo-Pentane component to the iso-Pentane component (available with firmware ver-
sions 23.74.20 and higher)
add the neo-Pentane component to the n-Pentane component (available with firmware ver-
sions 23.74.30 and higher)

Related Modbus Registers:


Heating Value (at base conditions) in use is 8n68 (where n = 5-8 for Meter 1 - Meter 4)

Reference Density

Firmware versions 23.75.02 and higher provide a 'Reference Density Calculation' selection
for Natural Gas:

If any of the AGA-8 detailed density calculations are selected, the user may select the ref-
erence density calculation:
Calculate using AGA-8
Calculate using SG @ Base Conditions x Density of Dry Air @ Base Conditions

For all other density methods except Redlich-Kwong, the only selection available is 'Calculate
using Relative Density(SG) @ Base Conditions x Density of Dry Air @ Base Conditions'.

For all firmware versions for all products other than Natural Gas, enter the override value in
lb/ft3.

Water Content

Enter the amount of water that the gas contains in lbs/mmcf of gas. It is used to calculate the cor-
rection factor FWV which corrects the net volume and therefore energy for water content.

Due to the resolution of FWV, X.XXXX, water contents of 7 lbs/mmcf and less produce FWV factors
of 1.0000.

Enter zero if a GC is providing water content in the compositional analysis.

Enter a negative value to have the flow computer calculate the water vapor content:

Water Content (lbs/mmcf) = (A / P) + B

where:

A = Exponent[X1 - (X2 / (X3 + FT) )]


B = Exponent[X4 - (X5 / (X6 + FT) )]
P = Upstream Pressure in PSIA

X1 = 25.36794227
X2 = 7170.42747964

360
OMNICOM: Fluid Setup (Firmware Version 23)

X3 = 389.5293906
X4 = 15.97666211
X5 = 7737.37631961
X6 = 483.28778105
FT = Upstream Temperature in degF

NIST14 Analysis Basis

Enter the basis in which the components are analyzed for the NIST14 equations. The choices are:

Mole Percent - default selection


Mole Fraction
Mass Percent
Mass Fraction.

Density Methods and method specific items


Density Methods

Select the Density Method required for the Natural Gas. Use a "detailed method" of calculation if a
Gas Analyzer is connected.

Selecting a Density method turns on/off fields and tabs that are associated with the Density Method
selection.

AGA-8 1994 Method 1: Detailed Analysis


AGA-8 1994 Method 2: Gross.Method - HV / SG / CO2
AGA-8 1994 Method 3: Gross.Method - SG / N2 / CO2

AGA-8 1992 Method 1: Detailed Analysis (ISO 12213-2)


AGA-8 1992 Method 2: Gross.Method - HV / SG / CO2
AGA-8 1992 Method 3: Gross.Method - SG / N2 / CO2

AGA-8 1985 Method 1: Detailed Analysis


AGA-8 1985 Method 2: Gross.Method - HV / SG / CO2
AGA-8 1985 Method 3: Gross.Method - HV / SG / N2 / CO2
AGA-8 1985 Method 4: Gross.Method - SG / N2 / CO2
AGA-8 1985 Method 5: Gross.Method - HV / N2 / CO2
AGA-8 1985 Method 6: Gross.Method - SG / N2 / CO2 / CH4

Redlich-Kwong EOS: The Redlich-Kwong equation of state (EOS) (1949) is a modification


of the van-der-Waals EOS. Use of this EOS only requires the input of critical temperature, Tc,
and critical pressure, Pc, for the mixture. The Redlich-Kwong equation is adequate for cal-
culation of gas phase properties when the ratio of the pressure to the critical pressure is less
than about one-half of the ratio of the temperature to the critical temperature.

The Soave-Redlich-Kwong (SRK) EOS is available with firmware version 23.74.30 and
higher. It is one of the most widely used three-parameter equations of state in the refinery and

361
OMNICOM: Fluid Setup (Firmware Version 23)

gas processing industries. Equations of state are used for the prediction of fluid physical prop-
erties such as vapor phase compressibility. The SRK equation of state in 1972 became the
first successful modification to the original Redlich-Kwong (RK) equation from 1949. Soave
proposed an adjustment of the temperature influence and the adding of a third parameter
called the “accentric factor” (also called the “Pitzer accentric factor”) to the original RK para-
meters of critical pressure and critical temperature. The inclusion of the accentric factor
accounts for some of the molecular complexity including shape and polarity influences. The
accentric factor,

w = -log PrSat (at Tr = 0.7) - 1.000


where PrSat is the reduced pressure at saturation.

Using the SRK equation of state generally improves the accuracy of results and has increased
rangeability of use as compared with the use of RK equations.

Ideal Gas Calculation: (Available with firmware versions 23.74.19 and higher.)

Requires entry of the value used for Z in the following ideal gas equation:

Density = (Pf / Pb) x (Tb / Tf) x (1 / Z) x Density @ Ref. Condition.

where Density @ Ref. Condition = SG x Density of Air.

GC Stream(available for firmware versions 23.74.30 and higher)

In many cases a gas chromatograph or gas analyzer will be shared between several meter runs or
flow streams. When data is transmitted to the flow computer the analyzer will identify which flow
stream the analysis data pertains to. Enter the number of the flow stream that this fluid product
should match before using the analysis data.

Available for Natural Gas with a detailed density method and for NIST14. The GC entry is enabled if
a Gas Chromatograph is selected in the Equipment List screen.

Note: For firmware versions below 23.74.30, the GC Stream selection is located in the Meter Setup
screen.

AGA-10 Calculation(available with firmware versions 23.74.11 and higher)

Available for Natural Gas with the AGA-8 1994 Detailed Analysis density method selected. Enable
the AGA-10 calculation by checking the box. The default is not checked.

neo-Pentane Handling

For Natural Gas with any of the AGA-8 Detailed density methods are selected or for NIST14, the
user may select how to handle the neo-Pentane component before it is used in the density cal-
culation:

362
OMNICOM: Fluid Setup (Firmware Version 23)

Disregard the neo-Pentane component


Add the neo-Pentane component to the iso-Pentane component (available with firmware ver-
sions 23.74.20 and higher)
Add the neo-Pentane component to the n-Pentane component (available with firmware ver-
sions 23.74.30 and higher)

Redlich-Kwong EOS

Enter the inputs to the Redlich-Kwong equation of state (please see the help for 'Density Methods'
for more information):

The critical temperature, Tc, of a material is the temperature above which distinct liquid and
gas phases do not exist. As the critical temperature is approached, the properties of the gas
and liquid phases become the same. Above the critical temperature, there is only one phase.

The critical pressure, Pc, is the vapor pressure at the critical temperature.

The Soave-Redlich-Kwong (SRK) EOS is available with firmware versions 23.74.30 and
higher. If the Soave-Redlich-Kwong method is selected, the user is asked for an Accentric
Factor. The default is zero.

Ideal Gas(available with firmware versions 23.74.19 and higher.)

Override Z: Enter the value used for Z in the following ideal gas equation:

Density = (Pf / Pb) x (Tb / Tf) x (1 / Z) x Density @ Ref. Condition.


where Density @ Ref. Condition = SG x Density of Air.

363
OMNICOM: Fluid Setup (Firmware Version 27)

Fluid Setup (Firmware Version 27)


The Fluid Setup is for entering the type of gas and gas analysis data for each of the products. Once
you enter the information and/or make your selections, press the [Apply] button to set.

Settings
Below are the settings used to configure the Fluid Setup Screen:

Fluid Type

Select the fluid or gas you will be measuring when this product is selected.

The choices are:

Fluid Type Equation


Using AGA-8 1994,1992 and 1985 Equation of
Natural Gas
State *
Natural Gas Using ISO 12213-3:2006 and SGerg 88 methods.
Steam (ASME) Using ASME Equation of State
Steam (NIST) Using NIST Equation of State **
Based on the publication containing the density
Water (K&K) equations by
Joseph H. Keenan, Frederick G.
Argon Using NIST 1048 Equation of State
Nitrogen Using NIST 1048 Equation of State
Oxygen Using NIST 1048 Equation of State
Hydrogen Using NIST 1048 Equation of State
Ethylene Using NIST 1048 Equation of State
Ethylene IUPAC Using IUPAC 1988 Equation of State
Using NIST 14 Equations to calculate density, heat-
ing value, Cp, Cp/Cv,
sound velocity, Joules Thompson coefficient and vis-
NIST14
cosity.
(Available with firmware versions 27.74.18 and
higher)
Krohne Ethylene
* Note: AGA-8 can also be used for many other GAS mixtures including Carbon
Dioxide.
**Note:(NBS later became NIST)

Fluid Name

Enter up to eight ASCII characters to identify this product on reports.

364
OMNICOM: Fluid Setup (Firmware Version 27)

Viscosity

Note: Viscosity is only required in differential pressure device calculations.

Fluid Type Viscosity Override Calculate Viscosity


Starting with firmware version 27.75.06:
For AGA-8 Detailed Method and for ISO 12213-
3:2006(SGerg), select the “Calculate Viscosity”
radio button and select the viscosity calculation
method:
LBC
GazProm

For AGA-8 Method 2, select the “Calculate Vis-


cosity” radio button and select the viscosity cal-
culation method. The LBC calculation uses an
estimated component method.
LBC
In all versions of 27
GazProm
Natural firmware, enter a pos-
Gas itive viscosity override
For AGA-8 Methods 3-6, Redlich-Kwong, Ideal
value.
Gas, NX-19, or SGerg Methods 2-4, select the
“Calculate Viscosity” radio button. It uses the
GazProm calculation.

Starting with firmware version 27.75.00:


For AGA-8 Detailed Method, select the “Calculate
Viscosity” radio button. It uses the LBC cal-
culation.
For NX-19 MOD, select the "Calculate Viscosity"
radio button. It uses the GazProm calculation.

Firmware versions prior to 27.75.00 do not support cal-


culation of viscosity.
Starting with firmware version 27.75.00:
Select the “Calculate Viscosity” radio button. It
In all versions of 27
uses the Equation of State.
Steam firmware, enter a pos-
(ASME) itive viscosity override
For firmware versions prior to 27.75.00
value. Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 27.75.00:
In all versions of 27 Select the “Calculate Viscosity” radio button. It
Steam firmware, enter a pos- uses the Equation of State.
(NIST) itive viscosity override
value. For firmware versions prior to 27.75.00
Enter a negative viscosity override. It uses the

365
OMNICOM: Fluid Setup (Firmware Version 27)

Equation of State.
Starting with firmware version 27.75.00:
Select the “Calculate Viscosity” radio button. It
In all versions of 27
uses the Equation of State.
Water firmware, enter a pos-
(K&K) itive Viscosity over-
For firmware versions prior to 27.75.00
ride value. Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 27.75.00:
Select the “Calculate Viscosity” radio button. It
In all versions of 27
uses the Equation of State.
firmware, enter a pos-
Argon
itive Viscosity over-
For firmware versions prior to 27.75.00
ride value. Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 27.75.00:
Select the “Calculate Viscosity” radio button. It
In all versions of 27
uses the Equation of State.
firmware, enter a pos-
Nitrogen
itive viscosity override
For firmware versions prior to 27.75.00
value. Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 27.75.00:
Select the “Calculate Viscosity” radio button. It
In all versions of 27
uses the Equation of State.
firmware, enter a pos-
Oxygen
itive viscosity override
For firmware versions prior to 27.75.00
value. Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 27.75.00:
Select the “Calculate Viscosity” radio button. It
In all versions of 27
uses the Equation of State.
Hydrogen firmware, enter a pos-
itive viscosity override
For firmware versions prior to 27.75.00
value. Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 27.75.00:
Select the “Calculate Viscosity” radio button. It
In all versions of 27
uses the Equation of State.
firmware, enter a pos-
Ethylene
itive viscosity override
For firmware versions prior to 27.75.00
value. Enter a negative viscosity override. It uses the
Equation of State.
Starting with firmware version 27.75.00:
In all versions of 27
Select the “Calculate Viscosity” radio button. It
Ethylene firmware, enter a pos-
uses the Equation of State.
IUPAC itive viscosity override
value.
For firmware versions prior to 27.75.00

366
OMNICOM: Fluid Setup (Firmware Version 27)

Enter a negative viscosity override. It uses the


Equation of State.
Starting with firmware version 27.75.00:
Select the “Calculate Viscosity” radio button. It
In all versions of 27
uses the Equation of State.
firmware, enter a pos-
NIST14
itive viscosity override
For firmware versions prior to 27.75.00
value. Enter a negative viscosity override. It uses the
Equation of State.
In all versions of 27
Krohne firmware, enter a pos- Viscosity calculation is not supported in any firmware ver-
Ethylene itive viscosity override sion.
value.

Use Override: enter the viscosity at flowing conditions.

In all versions of firmware, to use viscosity override, enter a positive viscosity override value.

Enter the viscosity in pascal seconds. For Natural Gas, reasonable viscosity limits are
0.000005 to 0.0001 Pa.s and a reasonable value is 0.000012 Pa.s.

Calculate Viscosity:

For firmware versions 27.75.00 and higher the 'Calculate' option is available for all fluid
products except Krohne Ethylene.

For firmware versions prior to 27.75.00 for all products except for Natural Gas and Krohne
Ethylene, enter a negative value in the viscosity override to cause the flow computer to cal-
culate viscosity.

For Steam (ASME and NIST), Water (K&K), NIST 1048, Ethylene IUPAC, and NIST14 fluid
types, the appropriate equation of state is used.

For Natural Gas, the user may select the viscosity calculation as follows:

LBC

For firmware versions 27.75.00 and higher, this calculation requires a component ana-
lysis and is therefore suitable for Natural Gas with an AGA-8 1994, 1992, and 1985, or
ISO 12213-3:2006 (SGerg) Method 1detailed analysis. It is based on the following ref-
erences:

GasVLe, Kay (Ind.Eng.Chem., 1936),

For firmware versions 27.75.06 and higher, for Natural Gas using density methods
AGA-8 Gross Method 2, where a full analysis is not available, the OMNI estimates an
abbreviated component analysis given heating value, relative density, and CO2 mole
percentage. The abbreviated component analysis consists of the following com-
ponents:

367
OMNICOM: Fluid Setup (Firmware Version 27)

Methane (CH4)
Nitrogen (N2)
Carbon Dioxide (CO2)
Propane (C3H8)
Hydrogen (H2)-(only used for ISO 12213-3:2006 (SGerg) Method 1)

All other components in the mixture will be set to zero.

Viscosity results calculated using the LBC method with this abbreviated component ana-
lysis and the LBC method were compared to results calculated using the full gas ana-
lysis in 1000 test cases. The maximum deviation between calculated viscosities was
less than +/- 0.1%.

GazProm

This calculation method for dynamic viscosity can be used for all Natural Gas density cal-
culation methods:

Viscosity = n x sqrt(Tf / Tb) x [(1 + 164 / Tb) / (1 + 164 / Tf)] x (0.99625 + 0.003753 x Pf)

where:
n is the reference viscosity (at Tb) in
Tf and
Pf is in bar absolute
Viscosity is in Pa.s

The reference viscosity is entered in exponential notation. The default value is 1.099E-5
Pa.s.

The above equation is believed by OMNI to be acceptable to the Russian GazProm


organization. OMNI has no additional information as to its technical origin or applic-
ability.

When using this equation, the flowing temperature can range from -20 degC to 60
degC and the flowing pressure can range from 0 to 56 bar. The reference viscosity con-
stant must be entered as a positive number. When operating outside of these limits, the
viscosity is still calculated however a calculation out of range alarm is raised.

For firmware versions 27.75.00 and higher, for Natural Gas with the NX-19 MOD dens-
ity method, the GazProm method is used to calculate viscosity.

For firmware versions 27.75.06 and higher, for Natural Gas with the AGA-8 Methods 3-
6, Redlich-Kwong, Ideal Gas, NX-19, or SGerg Methods 2-4 density methods, the
GazProm method is used to calculate viscosity.

Related Modbus Registers:


7n39 = Viscosity in Use (where n = 1-4 for Meter 1 - Meter 4)

368
OMNICOM: Fluid Setup (Firmware Version 27)

Isentropic Exponent

Note: Isentropic Exponent is only required in differential pressure device calculations.

Isentropic Exponent Over-


Fluid Type Calculate Isentropic Exponent
ride
Starting with firmware version 27.75.06:
For AGA-8 1994 Detailed Method with
AGA-10 enabled, select the “Calculate Isen
Exp” radio button and select the calculation
method:
Estimated
GazProm
AGA-10

For all other Density Methods, select the


“Calculate Isen Exp” radio button and select
the calculation method:
Estimated
GazProm
In all versions of 27 firm-
Starting with firmware version 27.75.00:
Natural ware, enter a positive isen- For AGA-8 1994 Detailed Method with
Gas tropic exponent override AGA-10 enabled, select the “Calculate Isen
value. Exp” radio button. It uses the AGA-10
method.

For NX-19 MOD density method, select the


“Calculate Isen Exp” radio button. It uses
the GazProm method.

Starting with firmware version 27.74.11:


For AGA-8 1994 Detailed Method with
AGA-10 enabled, enter a negative isen-
tropic exponent override value. It uses the
AGA-10 method.

Firmware versions prior to 27.74.11 do not sup-


port the calculation of isentropic exponent.
In all versions of 27 firm-
Steam ware, enter a positive isen- Isentropic exponent calculation is not supported in
(ASME) tropic exponent override any firmware version.
value.
In all versions of 27 firm-
Steam ware, enter a positive isen- Isentropic exponent calculation is not supported in
(NIST) tropic exponent override any firmware version.
value.

369
OMNICOM: Fluid Setup (Firmware Version 27)

In all versions of 27 firm-


Water ware, enter a positive isen- Isentropic exponent calculation is not supported in
(K&K) tropic exponent override any firmware version.
value.
Starting with firmware version 27.75.00:
Select the “Calculate Isen Exp” radio but-
In all versions of 27 firm-
ton. It uses the Equation of State.
ware, enter a positive isen-
Argon
tropic exponent override
For firmware versions prior to 27.75.00
value. Enter a negative isentropic exponent over-
ride. It uses the Equation of State.
Starting with firmware version 27.75.00:
Select the “Calculate Isen Exp” radio but-
In all versions of 27 firm-
ton. It uses the Equation of State.
ware, enter a positive isen-
Nitrogen
tropic exponent override
For firmware versions prior to 27.75.00
value. Enter a negative isentropic exponent over-
ride. It uses the Equation of State.
Starting with firmware version 27.75.00:
Select the “Calculate Isen Exp” radio but-
In all versions of 27 firm-
ton. It uses the Equation of State.
ware, enter a positive isen-
Oxygen
tropic exponent override
For firmware versions prior to 27.75.00
value. Enter a negative isentropic exponent over-
ride. It uses the Equation of State.
Starting with firmware version 27.75.00:
Select the “Calculate Isen Exp” radio but-
In all versions of 27 firm-
ton. It uses the Equation of State.
Hydrogen ware, enter a positive isen-
tropic exponent override
For firmware versions prior to 27.75.00
value. Enter a negative isentropic exponent over-
ride. It uses the Equation of State.
Starting with firmware version 27.75.00:
Select the “Calculate Isen Exp” radio but-
In all versions of 27 firm-
ton. It uses the Equation of State.
ware, enter a positive isen-
Ethylene
tropic exponent override
For firmware versions prior to 27.75.00
value. Enter a negative isentropic exponent over-
ride. It uses the Equation of State.
Starting with firmware version 27.75.00:
Select the “Calculate Isen Exp” radio but-
In all versions of 27 firm-
ton. It uses the Equation of State.
Ethylene ware, enter a positive isen-
IUPAC tropic exponent override
For firmware versions prior to 27.75.00
value. Enter a negative isentropic exponent over-
ride. It uses the Equation of State.
In all versions of 27 firm- Isentropic exponent calculation is not supported in
NIST14
ware, enter a positive isen- any firmware version.

370
OMNICOM: Fluid Setup (Firmware Version 27)

tropic exponent override


value.
In all versions of 27 firm-
Krohne ware, enter a positive isen- Isentropic exponent calculation is not supported in
Ethylene tropic exponent override any firmware version.
value.

Use Override: enter the Isentropic Exponent dimensionless factor for this product.

In all versions of firmware, to use isentropic exponent override, enter a positive override value.

For Natural Gas, reasonable isentropic exponent override limits are 1.0 to 3.0 and a reas-
onable value is 1.35.

Calculate Isentropic Exponent:

For firmware versions 27.75.00 and higher, the 'Calculate' option is available for Natural Gas,
NIST 1048, and Ethylene IUPAC fluid types.

Firmware versions earlier than 27.75.00, for NIST 1048 and Ethylene IUPAC fluid types,
enter a negative override value to cause the flow computer to calculate Isentropic Exponent.

For NIST 1048 and Ethylene IUPAC fluid types, the appropriate equation of state is used.

For Natural Gas


For firmware versions 27.75.06 and higher, the user may select the isentropic exponent
calculation:
Estimate

This is a simplified equation suitable for typical natural gases. Within the range 0
to 20 degC, 5 to 75 bar, it provides a standard uncertainty of 0.009 (compared
with calculation from AGA-8 / AGA-10 / ISO 20765:1). The uncertainty of the cal-
culated isentropic exponent may be higher when operating outside of these tem-
perature and pressure limits.

Isentropic Exponent = (1.3028 - 0.0005794 x Tf) + (-0.0008437 +


0.00002658 x Tf) x Pf + (0.00003267 - 5.517E-07 x Tf) x Pf^2
where:
Tf is in Centigrade
Pf is in bar absolute

If an input is out of range, the isentropic exponent is still calculated how-


ever a calculation out of range alarm is raised.

The Isentropic Exponent of natural gases within these operating tem-


peratures and pressures ranges from approximately 1.28 to 1.43.

GazProm

371
OMNICOM: Fluid Setup (Firmware Version 27)

This calculation method can be used for all Natural Gas density calculation meth-
ods:

Isentropic Exponent = 1.29 + 7.18E-7 x (2575 + (346.23 - Tf) ^ 2) x Pf


where:
Tf is in Kelvin
Pf is in bar absolute

The above equation is believed by OMNI to be acceptable to the Russian


GazProm organization. OMNI has no additional information as to its tech-
nical origin or applicability.

For this equation, the flowing temperature can range from -20 degC to 60
degC and the flowing pressure can range from 0 to 56 bar. The uncertainty
of the calculated isentropic exponent may be higher when operating out-
side of these temperature and pressure limits.

AGA-10

Available only for AGA-8 1994 detailed analysis when the AGA-10 calculation is
selected. The isentropic exponent is calculated by the AGA-10 equation.

For firmware versions 27.75.00 and higher the 'Calculate' option is available for the fol-
lowing:

For the AGA-8 1994 detailed analysis density method selected and AGA-10
enabled, the exponent is calculated using AGA-10.

For the AGA NX-19 MOD density method selected, the GazProm method is
used.

For firmware versions prior to 27.75.00 to 27.74.11, for AGA-8 1994 Detailed Method
with AGA-10 enabled, enter a negative isentropic exponent override value. It uses the
AGA-10 method.

Firmware versions prior to 27.74.11 do not support calculation of isentropic exponent


for Natural Gas.

Related Modbus Registers:


18n28 = AGA-10 Calculated Isentropic Exponent (where n = 5-8 for Meter 1 - Meter 4)
 7n40 = Isentropic Exponent In Use (where n = 1-4 for Meter 1 - Meter 4)

SG

The SG entry is only available for Natural Gas. Net volumes are calculated by dividing mass flow by
density at reference conditions.

Override:

372
OMNICOM: Fluid Setup (Firmware Version 27)

For AGA-8 Detailed Density methods:

Firmware versions earlier than 27.75.06 require a negative value to instruct the flow computer
to calculate density at reference conditions using the AGA-8 equation of state.

Firmware versions 27.75.06 and higher, a Reference Density Calculation selection is


provided. Note: the SG entry is only enabled for Natural Gas when the Reference Density Cal-
culation selection is 'Relative Density @ Base Conditions x Density of Dry Air @ Base Condi-
tions'.

For other density methods, enter a positive override value of specific gravity at reference con-
ditions that will be used together with the density of dry air to calculate the density at reference
conditions.

For Product 1 only, this value is overwritten if SG is obtained from a frequency input from a
Micro Motion (Solartron) 3096/3098 gravitometer or from a 4-20ma SG input.

In cases where a chromatograph is used, this entry serves as the GC failure override. The GC
value of SG, if available, will also be used unless the component number for SG is set to '0' in
the 'Analysis Setup' screen.

Base Temperature (available with firmware versions 27.75.06 and higher):

The Base Temperature selection will only be shown when the Reference Density Calculation
selection is 'Relative Density @ Base Conditions x Density of Dry Air @ Base Conditions'.

Select the base temperature the relative density is measured at. It is used to match the input
requirements of the selected density algorithm.

The ISO 12213-3:2006 (SGerg) and SGerg 1988 Methods 2-4 algorithms require relative
density at 0 degC. For these algorithms, the OMNI uses the following conversion factors to
convert relative density at base temperature to relative density at 0 degC:

Relative Density @Base Temperature Relative Density @0 Conversion


degC degC Factor*
0 0 1.0000
15 0 1.0002
20 0 1.0003
15.556 0 1.0002

*The conversion factors are based on ISO 12213-3 and ISO 13443.

The OMNI uses the following conversion factors to convert relative density at base tem-
perature to base conditions at combustion/volumetric base temperature:

373
OMNICOM: Fluid Setup (Firmware Version 27)

Base Condition @ Com-


Relative Density @Base Tem- bustion / Conversion
perature degC Volumetric Base Tem- Factor*
perature degC
0 25 / 0 1.0000
0 0/0 1.0000
0 15 / 0 1.0000
0 15 / 15 0.9998
0 20 / 20 0.9997
0 25 / 20 0.9997
0 15.556 / 15.556 0.9998

15 25 / 0 1.0002
15 0/0 1.0002
15 15 / 0 1.0002
15 15 / 15 1.0000
15 20 / 20 0.9999
15 25 / 20 0.9999
15 15.556 / 15.556 1.0000

20 25 / 0 1.0003
20 0/0 1.0003
20 15 / 0 1.0003
20 15 / 15 1.0001
20 20 / 20 1.0000
20 25 / 20 1.0000
20 15.556 / 15.556 1.0001

15.556 25 / 0 1.0002
15.556 0/0 1.0002
15.556 15 / 0 1.0002
15.556 15 / 15 1.0000
15.556 20 / 20 0.9999
15.556 25 / 20 0.9999
15.556 15.556 / 15.556 1.0000

*The conversion factors are based on ISO 12213-3 and ISO 13443.

Related Modbus Registers:


Relative Density (at base conditions) in use is 8n67 (where n = 5-8 for Meter 1 - Meter 4)

Heating Value

374
OMNICOM: Fluid Setup (Firmware Version 27)

Override:

Firmware versions earlier than 27.75.06 require a negative value to be entered to cause the
flow computer to calculate heating value.

Firmware versions 27.75.06 and higher provide a 'Calculate Heating Value' selection. Neg-
ative values for override are not allowed in these firmware versions.

Enter a positive override value to be used in place of the calculated value in systems where a
GC is not available. In systems which use a GC, this override is also the fall back value should
the GC fail. The GC HV will always be used if available unless it is assigned the component
number '0' in the 'Analysis Setup' screen.

For Product 1 only, this value is overwritten if HV is obtained from a 4-20mA input from a BTU
analyzer.

Firmware versions 27.75.06 and higher provide a Combustion/Volumetric Base Temperature


selection for Natural Gas.

The OMNI uses the following conversion factors to convert the heating value override to base
conditions for input into the energy calculation:

Base Condition @ Com-


Heating Value @ Combustion /
bustion / Conversion
Volumetric Base Temperature
Volumetric Base Temperature Factor*
degC
degC
25 / 0 25 / 0 1.0000
25 / 0 0/0 1.0025
25 / 0 15 / 0 1.0010
25 / 0 15 / 15 0.9485
25 / 0 20 / 20 0.9318
25 / 0 25 / 20 0.9313
25 / 0 15.556 / 15.556 0.9466

0/0 25 / 0 0.9975
0/0 0/0 1.0000
0/0 15 / 0 0.9985
0/0 15 / 15 0.9462
0/0 20 / 20 0.9294
0/0 25 / 20 0.9290
0/0 15.556 / 15.556 0.9443

15 / 0 25 / 0 0.9990
15 / 0 0/0 1.0015

375
OMNICOM: Fluid Setup (Firmware Version 27)

15 / 0 15 / 0 1.0000
15 / 0 15 / 15 0.9476
15 / 0 20 / 20 0.9308
15 / 0 25 / 20 0.9304
15 / 0 15.556 / 15.556 0.9457

15 / 15 25 / 0 1.0543
15 / 15 0/0 1.0569
15 / 15 15 / 0 1.0553
15 / 15 15 / 15 1.0000
15 / 15 20 / 20 0.9823
15 / 15 25 / 20 0.9818
15 / 15 15.556 / 15.556 0.9980

20 / 20 25 / 0 1.0732
20 / 20 0/0 1.0759
20 / 20 15 / 0 1.0743
20 / 20 15 / 15 1.0180
20 / 20 20 / 20 1.0000
20 / 20 25 / 20 0.9995
20 / 20 15.556 / 15.556 1.0160

25 / 20 25 / 0 1.0738
25 / 20 0/0 1.0764
25 / 20 15 / 0 1.0748
25 / 20 15 / 15 1.0185
25 / 20 20 / 20 1.0005
25 / 20 25 / 20 1.0000
25 / 20 15.556 / 15.556 1.0165

15.556 / 15.556 25 / 0 1.0563


15.556 / 15.556 0/0 1.0590
15.556 / 15.556 15 / 0 1.0574
15.556 / 15.556 15 / 15 1.0020
15.556 / 15.556 20 / 20 0.9843
15.556 / 15.556 25 / 20 0.9838
15.556 / 15.556 15.556 / 15.556 1.0000

*The conversion factors are based on ISO 12213-3 and ISO 13443.

Firmware versions 27.75.06 and higher for Natural Gas using one of the following density cal-
culations: ISO 12213-3:2006 Method 1, and SGerg 1988 Methods 2-4, have the following

376
OMNICOM: Fluid Setup (Firmware Version 27)

table of conversion factors to convert the heating value at combustion/volumetric base tem-
perature to 25 / 0 degC and 101.325 kPa:

Heating Value @ Combustion


Heating Value @ 25 / 0 Heating Value @ 25 / 0
/
degC degC
Volumetric Base Temperature
and 101.325 kPa* and 101.56 kPa*
degC
25 / 0 1.0000 0.9977
0/0 0.9975 0.9952
15 / 0 0.9990 0.9967
15 / 15 1.0543 1.0518
20 / 20 1.0732 1.0707
25 / 20 1.0738 1.0713
15.556 / 15.556 1.0564 1.0539

*The conversion factors are based on ISO 12213-3 and ISO 13443.

Calculate Heating Value:

For firmware versions 27.75.06 and higher the 'Calculate' option is available for Natural Gas
with an AGA-8 detailed density calculation, Steam (NIST), Water (K&K), NIST 1048
products, and NIST14.

For Steam (NIST), Water (K&K), NIST 1048 products, and NIST14 fluid types, the appro-
priate equation of state is used.

If Natural Gas with an AGA-8 detailed density method is selected, the user may select also the
HV calculation method and how to handle the neo-Pentane component:

Method: Select the equation to calculate the heating value of the gas:
AGA 5 (1999)
AGA-5 (2009) (available with firmware versions 27.75.06 and higher)
GPA 2172 (1996)*
GPA 2172 (2009)* (available with firmware versions 27.75.06 and higher)
ISO 6976 (1995)**

*Note: If GPA 2172 is selected:

For Firmware versions beginning with 27.75.10:


When specifying a default base temperature value equivalent to 15 degC AND
using an AGA-8 Detailed Density Method, the flow computer uses the simplified
method shown in the GPA-2172 standard to calculate the heating value. Any
base pressure can be used.

If specifying a base temperature other than the default 15 degC value, the flow
computer uses the alternate Basic program (also part of the GPA-2172 standard
and known as Equation A.7 or Equation 7) to calculate the heating value. Any
base pressure can be used.

377
OMNICOM: Fluid Setup (Firmware Version 27)

For Firmware versions prior to 27.75.10:


When specifying a default base temperature value of 15 degC, AND when spe-
cifying a base pressure in absolute units of 101.325 kPa or 1.01325 Bar or
1.03323 kg/cm2, AND using an AGA-8 Detailed Density Method, the flow com-
puter uses the simplified method shown in the GPA-2172 standard to calculate
the heating value.

If specifying a base temperature other than the default 15 degC value, OR when
specifying a base pressure in absolute units other than 101.325 kPa or 1.01325
Bar or 1.03323 kg/cm2, AND using an AGA-8 Detailed Density Method, the flow
computer uses the alternate Basic program (also part of the GPA-2172 standard
and known as Equation A.7 or Equation 7) to calculate the heating value.

**Note: If ISO 6976 (1995) is selected, the calculations are made based on:
15 degC for firmware versions 27.74.18 and lower
0 degC, 15 degC, or 20 degC for firmware version 27.74.19 and higher
the base conditions combustion/volumetric base temperature selection for firmware ver-
sions 27.75.06 and higher

neo-Pentane component - the following choices are available regarding how the neo-
Pentane component is to be used in the HV calculation:
use the neo-Pentane component (AGA-5 (1999), AGA-5 (2009), and ISO 6976 (1995)
only)
disregard the neo-Pentane component (GPA 2172 (1996) and GPA 2172 (2009) only)
add the neo-Pentane component to the iso-Pentane component (available with firm-
ware versions 27.74.20 and higher)
add the neo-Pentane component to the n-Pentane component (available with firmware
versions 27.74.20 and higher)

Related Modbus Registers:


Heating Value (at base conditions) in use is 8n68 (where n = 5-8 for Meter 1 - Meter 4)

Base Conditions

Base Conditions are configurable for each product available with firmware versions 27.74.19 and
higher (for 27.74.18 and lower it is configurable for the system in the Factors and Systems Con-
stants screen). The base conditions are only required for Natural Gas and for NIST14 fluids.

Note Please reference the help for the SG and the Heating Value on this page for conversion of over-
rides to base conditions for the ISO 12213-3 2007 (SGerg) and SGerg 1988 Methods 2-4.

Base Temperature

For firmware versions 27.75.06 and higher:

For Natural Gas with AGA-8 1994 detailed density method, AGA-8 1992 detailed density
method, or AGA-8 1985 detailed density method and a heating value calculation method of:

378
OMNICOM: Fluid Setup (Firmware Version 27)

ISO 6976 (1995), select a combustion/volumetric base temperature


AGA-5 (2009), GPA 2172 (1996), and GPA 2172 (2009), select a com-
bustion/volumetric base temperature selection where the combustion temperature is
equal to the volumetric base temperature
AGA-5 (1999), the base temperature is fixed at 15.556 degC

For Natural Gas with AGA-8 1994 Methods 2 and 3, AGA-8 1992 Methods 2 and 3, ISO
12213-3 2007 (SGerg) and SGerg 1988 Methods 2-4, select a combustion/volumetric base
temperature.

For Natural Gas with AGA-8 1985 Methods 2-6, the base temperature is fixed at 15.556
degC.

For Natural Gas with Redlich-Kwong EOS, Ideal Gas, or AGA NX-19 1962, and AGA NX-19
MOD and NIST14, enter the contract base temperature in degC.

Note: For Natural Gas with AGA-8 1994 detailed density method or AGA-8 1992 detailed
density method, if selecting GPA-2172 for Heating Value calculation, please see note regard-
ing base pressure under the help for Heating Value.

For Firmware versions 27.74.19 and higher:

For Natural Gas and for NIST14, enter the contract base temperature in degC.

For Natural Gas with an AGA-8 Detailed density method, if an ISO 6976 selection is made for
the heating value calculation method, the base temperature value is automatically set to the
metering reference temperature.

Base Pressure

For firmware versions 27.75.06 and higher:

For Natural Gas with AGA-8 1994 detailed density method, AGA-8 1992 detailed density
method, Redlich-Kwong EOS, Ideal Gas, AGA NX-19 1962, or AGA NX-19 MOD and for
NIST14, enter the contract base pressure in absolute units.

For Natural Gas with AGA-8 1994 Methods 2 and 3, AGA-8 1992 Methods 2 and 3, ISO
12213-3:2006 (SGerg) Method 1 and SGerg Methods 2-4, base pressure can be selected as:
101.325 kPa / 1.01325 bar / 1.03323 kg/cm2 - or
101.56 kPa / 1.0156 bar / 1.03562 kg/cm2
depending on the pressure unit selection.

For Natural Gas with AGA-8 1985 Methods 1-6, base pressure is fixed at 101.56 kPa, 1.0156
bar, or 1.03563 kg/cm2 depending on the pressure unit selection.

For Firmware versions 27.74.19 and higher:

For Natural Gas and NIST14, enter the contract base pressure in absolute units.

379
OMNICOM: Fluid Setup (Firmware Version 27)

Reference Density

Firmware versions 27.75.06 and higher provide a 'Reference Density Calculation' selection
for Natural Gas:

If any of the AGA-8 detailed density calculations are selected, the user may select the ref-
erence density calculation:
Calculate using AGA-8
Calculate using ISO 6976
Calculate using SG @ Base Conditions x Density of Dry Air @ Base Conditions

For all other density methods except Redlich-Kwong, the only selection available is 'Calculate
using Relative Density(SG) @ Base Conditions x Density of Dry Air @ Base Conditions'.

Firmware versions 27.74.20 through 27.75.05 provide an ISO 6976 reference density cal-
culation selection for Natural Gas using an AGA-8 detailed density method. If the ISO 6976 cal-
culation is selected, the OMNI uses ISO 6976 at the selected reference temperature to
calculate the reference density. Note: If the user has selected an ISO 6976 Heating Value
Method and the temperature selected there does not match the temperature selected for ref-
erence density, a warning message is displayed.

For all firmware versions for all products other than Natural Gas, enter the override value in
kg/m3.

NIST 14 Analysis Basis

Enter the basis in which the components are analyzed for the NIST14 equations. The choices are:

Mole Percent - default selection


Mole Fraction
Mass Percent
Mass Fraction

Density Methods and method specific items


Density Methods

Select the Density Method required for the Natural Gas. Use a "detailed method" of calculation if a
Gas Analyzer is connected.

Selecting a Density method turns on/off fields and tabs that are associated with the Density Method
selection.

AGA-8 1994 Method 1: Detailed Analysis


AGA-8 1994 Method 2: Gross.Method - HV / SG / CO2
AGA-8 1994 Method 3: Gross.Method - SG / N2 / CO2

AGA-8 1992 Method 1: Detailed Analysis (ISO 12213-2)


AGA-8 1992 Method 2: Gross.Method - HV / SG / CO2

380
OMNICOM: Fluid Setup (Firmware Version 27)

AGA-8 1992 Method 3: Gross.Method - SG / N2 / CO2

AGA-8 1985 Method 1: Detailed Analysis


AGA-8 1985 Method 2: Gross.Method - HV / SG / CO2
AGA-8 1985 Method 3: Gross.Method - HV / SG / N2 / CO2
AGA-8 1985 Method 4: Gross.Method - SG / N2 / CO2
AGA-8 1985 Method 5: Gross.Method - HV / N2 / CO2
AGA-8 1985 Method 6: Gross.Method - SG / N2 / CO2 / CH4

Redlich-Kwong EOS: The Redlich-Kwong equation of state (EOS) (1949) is a modification


of the van-der-Waals EOS. Use of this EOS only requires the input of critical temperature, Tc,
and critical pressure, Pc, for the mixture. The Redlich-Kwong equation is adequate for cal-
culation of gas phase properties when the ratio of the pressure to the critical pressure is less
than about one-half of the ratio of the temperature to the critical temperature.

The Soave-Redlich-Kwong (SRK) EOS is available with firmware versions 27.74.21


and higher. It is one of the most widely used three-parameter equations of state in the
refinery and gas processing industries. Equations of state are used for the prediction of
fluid physical properties such as vapor phase compressibility. The SRK equation of
state in 1972 became the first successful modification to the original Redlich-Kwong
(RK) equation from 1949. Soave proposed an adjustment of the temperature influence
and the adding of a third parameter called the “accentric factor” (also called the “Pitzer
accentric factor”) to the original RK parameters of critical pressure and critical tem-
perature. The inclusion of the accentric factor accounts for some of the molecular com-
plexity including shape and polarity influences. The accentric factor,

w = -log PrSat (at Tr = 0.7) - 1.000


where PrSat is the reduced pressure at saturation.

Using the SRK equation of state generally improves the accuracy of results and has
increased rangeability of use as compared with the use of RK equations.

Ideal Gas Calculation: (Available with firmware versions 27.74.18 and higher.)
Requires entry of the value used for Z in the following ideal gas equation:

Density = (Pf / Pb) x (Tb / Tf) x (1 / Z) x Density @ Ref. Condition.


where Density @ Ref. Condition = SG x Density of Air.

AGA NX-19:

NX-19 1962 - N2/CO2/SG: Algorithm AGA NX-19 calculates the supercompressibility


factor (Fpv) of transmission quality natural gas. The supercompressibility of a fluid is a
function of the ratio of compressibility of the fluid at flowing and at base temperature and
pressure conditions. For calculation speed and efficiency, the AGA NX-19 1962 density
method assumes that the compressibility of natural gas at base temperature and pres-
sure is equal to 1.0000. The OMNI flow computer correctly implements AGA NX-19 as
written and published in 1962.

NX-19 MOD - N2/CO2/SG: (Available with firmware versions 27.75.00 and higher.)

381
OMNICOM: Fluid Setup (Firmware Version 27)

Although AGA-8 has superseded AGA NX-19, many Eastern European countries still
use the AGA NX-19 algorithm but in a modified form. The fluid compressibility (Zb) at
base temperature and pressure is now required to be calculated according to Russian
GOST standards and is done so when the AGA NX-19 MOD density method is selec-
ted.

ISO 12213-3:2006 (SGerg) and SGerg Methods 2-4:

The ISO 12213-3:2006 (also known as BS EN ISO 12213-3:2009) and SGerg-88 methods
are used by the flow computer for Calculation of Compression Factor Z and Density of Natural
Gas using a simplified gas analysis. The standard was last updated in 1996 with the following
suggested as valid ranges:

Hydrogen Nitrogen
Carbon Dioxide *Superior Calorific
(H2) (N2) *Relative
(CO2) Value (HS)
Mole Frac- Mole Frac- Density
Mole Fraction in MJ/m3
tion tion
0.0 to 0.3 0.0 to 0.1 0.0 to 0.5 20.0 to 48.0 0.55 to 0.9

*Note: Metering at T = 0.0 degC, P = 1.01325 bar, combustion at T = 25.0 degC.

Further input parameters are:

Pressure in bara: 0.0 to 120.0


T in degC: -30.0 to 65.0 (changed from initial 1988 range of -8.15 to 61.85)

GC Stream (available for firmware versions 27.74.30 and higher)

In many cases a gas chromatograph or gas analyzer will be shared between several meter runs or
flow streams. When data is transmitted to the flow computer the analyzer will identify which flow
stream the analysis data pertains to. Enter the number of the flow stream that this fluid product
should match before using the analysis data.

Available for Natural Gas with a detailed density method and for NIST14. The GC entry is enabled if
a Gas Chromatograph is selected in the Equipment List screen.

Note: For firmware versions below 27.74.30, the GC Stream selection is located in the Meter Setup
screen.

AGA-10 Calculation

Available for Natural Gas with the AGA-8 1994 Detailed Analysis density method selected. Enable
the AGA-10 calculation by checking the box. The default is not checked.

neo-Pentane Handling

382
OMNICOM: Fluid Setup (Firmware Version 27)

For Natural Gas with any of the AGA-8 Detailed density methods are selected or for NIST14, the
user may select how to handle the neo-Pentane component before it is used in the density cal-
culation:

Redlich-Kwong EOS

Enter the inputs to the Redlich-Kwong equation of state (please see the help for 'Density Methods'
for more information):

The critical temperature, Tc, of a material is the temperature above which distinct liquid and
gas phases do not exist. As the critical temperature is approached, the properties of the gas
and liquid phases become the same. Above the critical temperature, there is only one phase.

The critical pressure, Pc, is the vapor pressure at the critical temperature.

The Soave-Redlich-Kwong(SRK) EOS is available with firmware versions 27.74.21 and


higher. If the Soave-Redlich-Kwong method is selected, the user is asked for an Accentric
Factor. The default is zero.

Ideal Gas

Override Z: Enter the value used for Z in the following ideal gas equation:

Density = (Pf / Pb) x (Tb / Tf) x (1 / Z) x Density @ Ref. Condition

where Density @ Ref. Condition = SG x Density of Air

383
OMNICOM: Detailed Analysis

Detailed Analysis
The Detailed Analysis dialogs within the Fluid Products–Natural Gas subcategory is for selecting
and entering various gas analysis settings for natural gas metering. Once you enter the information
and/or make your selections, press the [Apply] button to set.

Settings
Below are the settings used within the 'Detailed Analysis 1985/1992/1994' setup tab :

Component Overrides

Enter the mole percentages of each component of the gas stream. This data is used to cal-
culate the flowing density and heating value if the application does not have a gas chro-
matograph (GC) or the GC fails.

Note: The component for neo-Pentane was added with firmware versions 23.74.20 and
27.74.20 and higher. See the help for Fluid Setup for more information on how this com-
ponent is used.

Import/Export Component Analysis


Component Analysis Configuration files can be imported or exported if the Advanced User com-
mand line switch "-AU" is enabled. If you need help adding a command line switch, please speak
with your IT representative.

After the command line switch is enabled, access the import/export feature by right-clicking in the
Analysis page in configuration. Files are defaulted to the extension: "*. oXXcmp" where XX is the
application (20, 23...), however the user may enter any extension.

Files may be imported or exported while online or offline.

384
OMNICOM: NIST14 Component Analysis

NIST14 Component Analysis

Settings
(NIST14 is available with firmware versions 23.74.19, 24.74.17 (only on Products 1-4), and
27.74.18 and higher.)

The items listed below are links to descriptions of each setting option within the Configuration dialog.
Click on a link to go to that setting's description.

Below are the settings used within the 'NIST14 Component Analysis' setup tab :

Component Overrides

Enter the values of each component depending on the analysis basis entered. These values
are used in the NIST14 calculation.

If the basis is mole or mass percentage the total should add up to 100. If the basis is mole or
mass fraction, the total should add up to 1.0. The total is shown in red if it does not add up to
the correct number however it does not prevent the numbers from being transmitted to the
OMNI.

Note: The component for neo-Pentane was added with firmware versions 23.74.20 and
27.74.20 and higher. See the help for Fluid Setup for more information on how this com-
ponent is used.

Import/Export Component Analysis


Component Analysis Configuration files can be imported or exported if the Advanced User com-
mand line switch "-AU" is enabled. If you need help adding a command line switch, please speak
with your IT representative.

After the command line switch is enabled, access the import/export feature by right-clicking in the
Analysis page in configuration. Files are defaulted to the extension: "*. oXXcmp" where XX is the
application (23, 24...), however the user may enter any extension.

Files may be imported or exported while online or offline.

385
OMNICOM: Live Input

Live Input
The Live Inputs category is for entering the configuration, Setup, and Alarm Limits to the live input
channel that the product input is connected. Live inputs can be used to input SG, HV, N2, CO2 vari-
ables. Once you enter the information and/or make your selections, press the [Apply] button to set.

Note:The majority of this information is view only, to edit these settings you must go to the OMNI I/O
and modify the Process /O settings of the individual I/O modules.

Settings
The items listed below are links to descriptions of each setting option within the Configuration dialog.
Click on a link to go to that setting's description.

Configuration

I/O Point: Enter the number of the I/O point to be used to input the live input signal for this
fluid product.

Tag: 8 character ASCII character string which identifies each transducer. The tag appears in
the LCD display before the value of the variable. Note: This field is not useable if a '99' has
been assigned as I/O.

Type: is only valid for SG Live Inputs. The types are SG - 4-20mA or SG - Micro Motion
(Solartron).

Setup

Override Code: This entry determines the strategy to be used regarding the 'Live Input Over-
ride Value'.

Override Value: This is the value that will be substituted for the transducer value depending
on the 'Override Code' selection.

Zero Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 4 milliamperes
or 1 volt.

Full Scale: *Note: This item is set when the I/O analog inputs are configured in the input scal-
ing. This value represents the engineering units that the transmitter outputs at 20 mil-
liamperes or 5 volts.

Alarm Limits

Low: The low alarm activates when the live input value drops below this value.

High: The low alarm activates when the live input value rises above this value.

386
OMNICOM: Live Input

Micro Motion (Solartron) (only displayed if a Micro Motion (Solartron) 3096/3098


Gravitometer digital pulse (frequency) input is selected for the SG I/O point)

Reference Gas 'X' or 'Y' . Sample gases 'X' and 'Y' are used to determine the calibration constants
K0 and K2 for the Micro Motion (Solartron) 3096/3098 specific gravity transducer.

Reference SG - Enter the specific gravity of 'Reference Gas X' or 'Reference Gas Y'.

Periodic Time - Enter the periodic time (in microseconds) recorded when measuring 'Refer-
ence Gas 'X' or 'Reference Gas Y'.

387
OMNICOM: PID Control

PID Control
Setup the parameters for each of the four PID (proportional–integral–derivative) control loops. Each
control loop can provide proportional plus integral control of a primary variable (flow rate for
example) and also allow override control of a secondary variable (pressure for example). These dia-
logs are accessed from the OMNICOM navigation tree.

Topics
The items listed below are links to topics covering PID control loops. Click on a link to go to that topic.

PID Loop Configuration


PID Loop Ramp Control
PID Loop Tuning

388
OMNICOM: PID Loop Configuration

PID Loop Configuration


Each PID control loop involves a primary controlled variable with override control by a secondary
variable. The primary variable is the controlled variable unless the secondary variable exceeds or
falls below a secondary setpoint. Individual startup & shutdown ramp limit functions are also
provided. This menu is used to assign the variables that will be controlled and what physical I/O
points will be used to input remote setpoints etc. You can also set the control action and startup
mode for each PID control loop. Once you enter the information and/or make your selections, press
the [Apply] button to set.

Settings
The items listed below are the settings covering each dialog within the PID Loop Configuration. Click
on the setting for more information.

Control Output Tag

Enter an 8 character ASCII string which will be used to identify the control loop output. For example,
if this PID loop is used to adjust control valve 100, an appropriate entry could be CV-100.

Primary Control Variable

Variable Assignment: Enter the number which specifies what data base variable will be
the primary controlled variable. For a list of variable assignments reference the Database
Browser.

Remark: Use this 16 character field to document the function of the primary variable assign-
ment. The data field is stored in the flow computer ensuring that the documentation always
matches the computer.

Zero Scale: Enter the minimum scale value in engineering units of the primary variable.This
entry is ALWAYS required even if you do not intend to use a remote setpoint input for the PID
controller as the PID algorithm uses this value to determine the zero value for the primary con-
trolled variable.

Full Scale: Enter the max scale value in engineering units of the primary variable.This entry
is ALWAYS required even if you do not intend to use a remote setpoint input for the PID con-
troller as the PID algorithm uses this value to determine the maximum value for the primary
controlled variable.

Secondary Control Variable

Variable Assignment: Enter the number which specifies what data base variable will be the
secondary controlled variable. For a list of variable assignments reference the Database
Browser.

389
OMNICOM: PID Loop Configuration

Remark: Use this 16 character field to document the function of the secondary variable
assignment. The data field is stored in the flow computer ensuring that the documentation
always matches the computer.

Zero Scale: Enter the minimum scale value in engineering units of the secondary vari-
able.This entry is ALWAYS required even if you do not intend to use a remote setpoint input
for the PID controller as the PID algorithm uses this value to determine the zero value for the
secondary controlled variable.

Full Scale: Enter the max scale value in engineering units of the secondary variable. This
entry is ALWAYS required even if you do not intend to use a remote setpoint input for the PID
controller as the PID algorithm uses this value to determine the maximum value for the sec-
ondary controlled variable.

Primary Setpoint

Remote Setpoint I/O Assignment: The setpoint for the primary controlled variable can be
input locally at the flow computer using the UP/DOWN arrow keys or it can be input remotely
via an analog input. Select the number of the input channel that you wish to use for the 'remote
setpoint'. Select 'Unassigned' if you will not be using a remote setpoint.

Min Acceptable Primary Setpoint: The primary setpoint variable will not be allowed to drop
below this engineering unit value.

Max Acceptable Primary Setpoint: The primary setpoint variable will not be allowed to rise
above this engineering unit value.

Secondary Setpoint

Secondary Setpoint Value: Enter the required setpoint of the secondary variable (engin-
eering units). The primary variable will be the controlled variable until the secondary variable
reaches this setpoint. The secondary variable will not be allowed to drop below or rise above
this setpoint depending on the 'error select' entry in the 'Configure PID' menu.

390
OMNICOM: PID Loop Tuning

PID Loop Tuning


Each PID Loop Tuning involves a individual startup & shutdown ramp limit functions. This menu is
used to assign the percentage rate that the control output will be allowed to change. You can also set
the Minimum Ramp to % each PID control loop. Once you enter the information and/or make your
selections, press the [Apply] button to set.

Settings
The items listed below are the settings covering each dialog within the PID Loop Ramp Control.
Click on the setting for more information.

Primary Control Variable

Action: Select 'forward' action if the primary variable value increases as the controller output
increases. Select 'reverse' action if the primary variable value decreases as the controller out-
put increases.

Response:

Enter a Gain Factor number between 0.01 to 99.99 to be used for the primary gain. Gain is
the reciprocal of proportional gain / 100. This setting determines how responsive the control
will be to changes or upsets to the Primary variable. The higher the entry, the more responsive
the control, but a value too high will cause instability and oscillations to occur. if the setting is
too low, the system will be too slow to respond and unable to adapt to changing conditions. A
setting of 0.75 is a reasonable starting value for typical applications.

Enter the Repeat/Min value between 0.0 to 40.00 for the primary integral factor. Repeats per
minute is the reciprocal of reset period. This entry determines the integral action of the con-
troller. Integral action gradually integrates the error between the measurement and the set-
point, adjusting the error to zero. The larger this entry is, the faster the output will respond. If
this entry is set too high, the system will be too responsive and the controller will overshoot the
setpoint, causing instability in oscillations. A setting of 5.0 is a reasonable starting value for typ-
ical applications.

Secondary Control Variable

Action: Select 'forward' action if the secondary variable value increases as the controller out-
put increases. Select >'reverse' action if the secondary variable value decreases as the con-
troller output increases.

Response:

The Gain Factor is used to trim out response variances between the Primary and Secondary
variables. The actual controller gain used when controlling the secondary variable is the

391
OMNICOM: PID Loop Tuning

product of this entry and the 'primary gain factor'. Tune the primary control variable first and
then use this entry to adjust for stable control of the secondary variable.

Enter the Repeat/Min value between 0.0 and 40.00 for the secondary variable repeats per
minute. Repeats per minute is the reciprocal of integral period.

Deadband

PID deadband is used to minimize wear and tear on the control valve actuator in cases where the
control variable is continuously changing. The control output of the flow computer will not change as
long as the calculated PID error percentage is equal or less than the entered deadband percentage.

Startup Mode

The startup mode entry determines how the PID control will resume after a system reset or power-
up (such as a momentary power loss).

Selecting 'Last' will cause the PID loop to stay in the operating mode it was in before the system
reset occurred.

Selecting 'Manual' will cause the PID loop to startup in the manual mode with the control output %
frozen to the value before the reset.

Error Select

Choose Low Error Select to instruct the flow computer to control whichever Variable has the “lowest
calculated Error %”.

Example: Assume the Primary Variable is assigned Meter 1 Gross Flow Rate (7101) and the Sec-
ondary Variable is assigned Meter 1 Pressure (7106). When calculating the Error % for Gross Flow
Rate and the Error % for Meter Pressure, the Gross Flow Rate variable has the “lowest calculated
Error %” so the flow computer will control the Gross Flow Rate.

Choose High Error Select to control whichever Variable has the “highest calculated Error %”.

Primary Variable Error % ‘ep’ equation:

Forward Action
eP = Primary Setpoint % Span - Primary Variable % Span
Reverse Action
eP = Primary Variable % Span - Primary Setpoint %
Secondary Variable Error % ‘es’ equation:

Forward Action
eS = Secondary Gain × (Sec. Setpoint % Span - Sec. Variable % Span)
Reverse Action
eS = Secondary Gain × (Sec. Variable % Span - Sec. Setpoint % Span)

392
OMNICOM: PID Loop Ramp Control

PID Loop Ramp Control


Each PID Loop Ramp Control involves a individual startup & shutdown ramp limit functions. This
menu is used to assign the percentage rate that the control output will be allowed to change. You
can also set the Minimum Ramp to % each PID control loop. Once you enter the information and/or
make your selections, press the [Apply] button to set.

PID Start, Stop and Shutdown command points have been added to eliminate the need to manip-
ulate the PID permissives directly. Using these command points greatly simplifies operation of the
PID ramping functions.

Command Point Action


PID 1 PID 2 PID 3 PID 4
1727 1728 1729 1730 'Start' Ramp Up to Setpoint
1788 1789 1790 1791 'Shutdown' Ramp Down to MinValve%
1792 1793 1794 1795 'Stop' Ramp Down to Fully Closed%

Settings
The items listed below are the settings covering each dialog within the PID Loop Ramp Control.
Click on the setting for more information.

Startup Ramp %

Enter the maximum percentage that the control output will be allowed to change each 500ms
cycle. The control output is clamped at 0% until the 1st PID permissive signal is set true. The
control output % is then allowed to increase at the 'Start Up' ramp rate.

Modbus Register Description


>PID 1 PID 2 PID 3 PID 4
1722 1723 1724 1725 1st Permissive

Shutdown Ramp %

When the 1st permissive is lost the control output will ramp down toward 0% at the 'Shut
Down' ramp rate.

During the ramp down phase a second PID permissive is used to provide a 'Ramp Hold' func-
tion. If this second permissive is true 100ms before entering the ramp down phase, the control
output % will ramp down and be held at the 'Minimum Ramp Down Limit %' (see following

393
OMNICOM: PID Loop Ramp Control

entry) until it goes false. The control output will then immediately go to 0%. (Reference the
chart above for command functions.)

Modbus Register Description


PID 1 PID 2 PID 3 PID 4
1752 1753 1754 1755 2nd Permissive

Minimum Ramp To

In many cases it is important to be able to deliver a precise amount of product. This requires
that the control output be ramped to some minimum % and held there until the required deliv-
ery is complete. The control output is then immediately set to 0%.

Enter the minimum percentage that the control output will be allowed ramp down to.

The control output is clamped at 0% until the 1st PID permissive signal is received. The output
% is then allowed to increase at the 'Start Up' ramp rate. When the permissive is lost the out-
put will ramp down toward the 'Minimum Ramp Down To %' at the 'Shut Down' ramp rate.
During the ramp down phase a second PID permissive is used to provide a 'Ramp Hold' func-
tion. If this second permissive is true during the ramp down phase the output % will be held at
the 'Minimum Ramp Down Limit %' (see previous entry) until it goes false. The control output
will then immediately go to 0%.

See 'Shutdown' commands (1788, 1789, 1790 and 1791).

394
OMNICOM: Front Panel Counters

Front Panel Counters


Each of the three electromechanical counters on the OMNI front panel can be programmed to count
at any rate up to 10 counts per second. Select the flow variable and count rate for each counter.
Once you enter the information and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Front Panel Counters dia-
log. Click on a setting for more information.

Assign

Enter a 4 digit number which specifies which data base variable used to increment this front panel
counter.
Valid Assignments Are (substitute the meter # for 'n'):

Meter Run Station


1n01 = Gross Flow 1801 = Positive Gross Flow
1n02 = Net Flow 1802 = Positive Net Flow
1n03 = *Mass Flow 1803 = *Positive Mass Flow
1n04 = *Energy Flow 1804 = *Positive Energy Flow
1805 = Negative Gross Flow
1806 = Negative Net Flow
1807 = *Negative Mass Flow
1808 = *Negative Energy Flow
*Note: Not applicable to some applications.

Additional user programmable assignments are available starting from 1089 through 1099. Each of
these user variables has an associated floating point variable which is where the user places data
that is to be output to a counter.

For example data placed in 7089 will be output to a counter by assigning it 1089. See following 'Pro-
grammable Variable' entries for help on how to do this.

Remarks

This sixteen character text field is provided to allow the user to better document the function of I/O
assignments etc. This data is actually stored in the flow computers memory and can be viewed from
the front panel display when making these entries.

Pulse/Unit

395
OMNICOM: Front Panel Counters

A multiplication factor applied to the internal flow totalizer specified in the Assign entry. It is used to
specify how fast the counter should increment based on the unit of flow being measured. The front
panel counter does not have to increment at the same rate as the internal flow totalizer. Enter the
number of pulses per unit volume, mass or energy unit.

The unit is the 'displayed' unit ie: BBL, Tonnes, KLB, Gj

Examples:

You wish to count 100 kg increments and the displayed units are Tonnes (1000 kg per
Tonne). Pulses/unit needed = 1000/100 = 10.0 counts per Tonne.

You wish to count 10 gallon increments and the displayed units are Barrels (42 gallons per
Barrel) - Pulses/unit needed = 42/10 = 4.2 counts per Barrel.

You wish to count 10 Barrel increments and the displayed units are Barrels - Pulses/unit
needed = 1/10 = 0.1 counts per Barrel.

396
OMNICOM: User Displays

User Displays
You may configure up to 8 custom displays that can be viewed on the LCD display. Each screen
setup requires you to select the key presses that will recall the display, the 4 variables and descrip-
tion tags that will be displayed. Any Bit, string, integer or floating point variable in the data base can
be selected to be displayed. User displays are recalled just like the resident displays by pressing the
correct keys followed by the 'Display' key. User displays can be made to override the resident dis-
plays by assigning them the same key press sequence. Once you enter the information and/or make
your selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the User Displays dialog. Click
on a setting for more information.

Key Sequence

Use the letters 'A' though 'Z' on the keys to specify which keys will be used to recall this display
screen. You may specify up to 4 key presses.

 Example: A+B+C+D

NOTE: User key press sequences take priority over any existing resident key press
sequences.

The following table showe the existing resident key press sequences:

Gross A & Net B % Mass C 7 Energy D 8 SG/API E 9 Control F /


Temp G # Press H $    Density I 4 DP J 5 Orifice K 6 Meter L *
Time M : Counts N " Factor 0 1 Preset P 2 Batch Q 3 Analysis R =
Print S ; Prove T , Status U 0 Alarms V . Product W _ Setup X +
Input Y (    Output Z )

Variable

Tag: Enter an 8 character field which will be used to describe or identify the display vari-
able. The field appears before the variable on the same display line.

Point: Each variable within the flow computer data base is assigned an index number
or address. Enter the index number of the variable that you wish to display on this dis-
play line. Any valid 32 bit integer (index #s 5001-6999) or IEEE float (7001- 899) can be
specified. For Meter Run 'n' Variables: (Replace 'n' with meter run number)

Resolution: Select the number of digits to the right of the decimal for this display vari-

397
OMNICOM: User Displays

able ( 0 to 7 max).

Import/Export User Displays


User Display Configuration files can be imported or exported if the Advanced User command line
switch "-AU" is enabled. If you need help adding a command line switch, please speak with your IT
representative.

After the command line switch is enabled, access the import/export feature by right-clicking on the
User Display tree item or page in configuration or selecting via the File menu. Files are defaulted to
the extension: "*.oXXud" where

If a file is imported while online, the program automatically asks the user if they want to transmit all
the displays to the OMNI.
If the user responds "Yes", all the 8 displays are written to the unit.
If the user responds with "No" they will still have the option to select "Transmit All" from the menu at a
later time - or - Apply the page they are on, but any page navigated to will be refreshed with the data
from the OMNI.

398
OMNICOM: Statements

Statements
Programmable statements allow the user to do special functions that may not be included in our
base firmware. There are two types of statements, Boolean and Variable. After making changes,
press the [Apply] button.

Topics
The items listed below are links to topics covering each list within the Statements dialog. Click on a
link to go to that topic.

Boolean Statements
Variable Statements

Import/Export Boolean/Variable Statement Configurations


Boolean/Variable Statement Configuration files can be imported or exported if the Advanced User
command line switch "-AU" is enabled. If you need help adding a command line switch, please speak
with your IT representative.

After the command line switch is enabled, access the import/export feature by right-clicking on the
tree item or selecting via the File Menu. Files are defaulted to the extension: "*.oXXbv" where XX is
the application (20, 24...) however the user may enter any extension.

Note: Boolean/Variable Statement Configuration files may not be imported while online.

399
OMNICOM: Boolean Statements

Boolean Statements
Boolean points are simply single bit variables in the flow computers memory which are either ON or
OFF. Each of the transducer high/low alarm bits are Boolean variables as are the 24 physical digital
I/O points in the system (points 1001 through 1024).

There are also 128 (see note*) Boolean points numbered 1025 through 1088 and 11025 through
11088 which can provide simple logic control of valves etc. Each of these points is controlled by a
simple logic statement which is evaluated every 100 ms starting at point number 1025 proceeding to
1088 or 11025 proceeding to 11088.

*Note: the number of Boolean statements increased from 64 to 128 for firmware versions 20.75.10,
22.75.10, 23.75.10, 24.75.10, 26.75.10, and 27.75.10 and higher.

Use the Database Browser to assist in entering the registers used in the statements. Any register
selected is appended to the end of the statement. You may select multiple registers and they will be
in appended to the subsequent statements.

Each statement can contain 3 Boolean variables optionally preceded by the slash '/' denoting the
NOT function and separated by a Boolean operator.

For example to program point 1025:


1025: /1106&/1206+1107 (point 1025 is true when NOT proving meter 1 AND NOT proving meter 2
OR when any meter 1 alarm is active)

Note: To allow more display characters on the flow computer's LCD screen, "25:" is displayed
instead of "1025".

Boolean Operators

Description Operator
NOT '/'
AND '&'
OR '+'
EXOR '*'
EQUAL '='
GOTO 'G'
IF ')'
MOVE RANGE ':'
TIMER FUNCTION ','
RISING EDGE '('
FALLING EDGE '(/'
ONE SHOT '@'

400
OMNICOM: Boolean Statements

The result of the evaluation (true (1) or false(0)) is used to set a corresponding software flag or bit.
These software flags can be used to control the status of a physical I/O point, used as an input to
other statements or be read via the Modbus data link.

Examples
NOT '/' Operator

When the variable to the right of the operator is false, it causes the Boolean statement to be true and
vice versa.

Example: Flowmeter pulse frequencies above the Active Frequency threshold configuration setting
located in the Meter Run Setup screen will set the "meter active" flag bit (Modbus Point 1n05). By
using any Boolean statement you can use this flag bit to enable and disable totalizing by controlling
the "disable meter run totalizing" flags (1736, 1737, 1738, and 1739).
1030: 1736=/1105 (Turns off Meter 1 totalizing if frequency is below the Active Frequency set-
ting. Turns on Meter 1 totalizing if frequency is at or above the threshold setting.)

AND '&' Operator

All variables to the left AND right of this operator must correspond to the logic they are being
checked for (TRUE or FALSE) before the Boolean statement is considered to be true.

Example: Create a momentary to detect a change in digital input #2 from a low to a high state, thus
making statement 1025 true during on 100ms update cycle.
1025: 1002*1026&1002 (EXOR or compare the current state of Digital input #2 with the pre-
vious state of Digital #2 saved in the previous 100ms cycle to see if there has been a change of
state, AND check to see if the change was from a low to a high state by checking if Digital
input #2's current state is high.)
1026: 1002 (Save the current value of Digital #2 for comparison with Digital #2 value in the
next 100ms cycle.)

OR '+' Operator

Either the variable(s) or logic to the left OR to the right of this operator must correspond to the logic
being checked for (TRUE or FALSE) before the Boolean statement is considered to be true.

Example: Check to see if Meter 1 or Meter 2 is active. If either meter is active, statement 1025 is
true.
1025: 1105+1205 (Modbus flags at 1n05 are set or reset by the OMNI based on whether or
not the Active Frequency (for Pulse/Turbine meters) or Low Flow Cutoff (for DP/Orifice
meters) configuration setting is exceeded.

EXOR '*' Operator

The variable(s) or logic to the left of this operator must be the exact opposite of the variable(s) or
logic to the right of this operator before the Boolean statement is considered to be TRUE.

401
OMNICOM: Boolean Statements

Example: (See the example for the AND '&' Operator.)

EQUAL '=' Operator

Use the '=' operator to move the result of a statement into another Boolean.

Example: 30: 1719=1026 (if 1026 is TRUE set the 'request snapshot' command bit 1719).

GOTO 'G' Operator

Use the 'G' operator to change the order of statement execution by going to the Boolean statement
number following the 'G' (it must be a valid statement number between 1025 and 1088).

Reverse GOTOs are allowed but the total number of statements that can be executed has been set
to 200 for firmware versions 20.75.10, 22.75.10, 23.75.10, 24.75.10, 26.75.10, and 27.75.10 and
higher and 100 for firmware versions prior to 20.75.10, 22.75.10, 23.75.10, 24.75.10, 26.75.10, and
27.75.10 to avoid system crashes which could occur with unexpected program loops.

Example 1: Jump to statement 1040


1031: G1040

Example 2: If 1719 is TRUE, jump to statement 1040


1031: 1719)G1040

Example 3: If 1719 is FALSE, jump to statement 1040


1031: /1719)G1040

IF ')' Operator

Use the IF ')' operator to conditionally process a statement. If the variable preceding the ')' is true the
remainder of the statement will be processed.

Example: 32: 1105) G1042 (Go process statement 1042 if Boolean variable 1105 [meter run #1 is
active] is true)

MOVE RANGE ':' Operator

Always used with the EQUAL '=' operator. Copies the range of points to the right of the '=' into a
range of points starting at the point specified to the left of the '=' operator. Cast type if needed.

Example: 35: 1501=1105:1110 (copy points 1105 through 1110 into scratchpad points 1501
through 1506)

Internal flags are also set and reset depending on the operation of the flow computers program
(alarm limits, prover status flags etc). There are no limitations as to what Boolean points can be
used in a statement.

TIMER FUNCTION ',' Operator

402
OMNICOM: Boolean Statements

Points 1640 - 1649 are dedicated to the timer function. You can delay activating or deactivating a
Boolean point in increments of 100ms ticks to avoid momentary alarms or to allow time for status
flags to remain on for extended periods so they can be detected via Modbus reads. This Operator
works in the same manner as the “Delay On” and “Delay Off” settings when configuring a digital out-
put point.
These timers can be used as shown in the following example:

1025: 1640=1501,50,100

Where 1640 is the target timer, 1501 is the trigger Boolean, the first parameter 50 is the number of
100ms ticks to delay after the trigger before turning on the timer. The second parameter 100 is the
hang time of the timer in 100ms ticks after the trigger goes to false.

RISING EDGE '(' Operator(Available with 20.73.20, 22.74.06, 23.74.10, 24.74.10,


26.74.10, and 27.74.10)

This Operator is used to detect a change in state from a low to high.

1071: (7599
Remarks: TestRisingEdgeOp

Statement 1071 will be true for 500ms when the value in Modbus register 7599 goes from a negative
value to a positive value (note that 0 value in 7599 is considered positive).

When using the Rising Edge Operator, only the Rising Edge Operator symbol and the register num-
ber you are checking the Low to High transition status of are allowed in the Boolean Statement. No
additional Rising Edge Operator symbol or any other Boolean Operator or other register numbers
are allowed within the statement.

FALLING EDGE '(/' Operator(Available with 20.73.20, 22.74.06, 23.74.10, 24.74.10,


26.74.10, and 27.74.10)

This Operator is used to detect a change in state from a high to low.

1072: (/7599
Remarks: TestFallingEdgOp

Statement 1072 will be true for 500ms when the value in Modbus register 7599 goes from a positive
value to a negative value (note that 0 value in 7599 is considered positive).

When using the Falling Edge Operator, only the Falling Edge Operator and the NOT ‘/’ Operator sym-
bol and the register number you are checking the High to Low transition status of are allowed in the
Boolean Statement. No additional Falling Edge Operator symbol or any other Boolean Operator or
other register numbers are allowed within the statement.

ONE SHOT '@' Operator(Available with 20.73.20, 22.74.06, 23.74.10, 24.74.10,


26.74.10, and 27.74.10)

403
OMNICOM: Boolean Statements

This Operator is used to detect a change in state, either from a positive to negative or a negative to
positive.

1073: @7599
Remarks: TestOneShotOpr

Statement 1073 will be true for 500ms when the value in Modbus register 7599 changes from a pos-
itive value to a negative value or from a negative value to a positive value (note that 0 value in 7599 is
considered positive).

When using the One Shot Operator, only the One Shot Operator symbol and the register number
you are checking the transition status of are allowed in the Boolean Statement. No additional One
Shot Operator symbol or any other Boolean Operator or other register numbers are allowed within
the statement.

USER DEFINED ALARM MESSAGES

In addition to containing logic statements, statements 1073 through 1088 (16 alarms) can be used to
implement 'user alarms'. Note: For application 23, statements 1057 through 1088 can be used (32
alarms).

Example: Provide a user alarm which displays 'High Filter DP' on the LCD alarm display, and is time
and date stamped in the alarm log. Digital point #2 is connected to DP switch across a strainer.
            30: 1088=1002 (Make 1088 follow status of Digital I/O #2 see the EQUAL '=' operator
below)
 .
 .
            88: High Filter DP (Text cannot be evaluated so computer treats statement text as an alarm
message.)

Note: Do not use a statement or Modbus register number in the Custom alarm statement. Example:
88: HighFilterDP1030

written into statement 1088 is not valid since it has a reference to statement 1030, which is also a
Modbus register number.

Using Integer and Floating Point Variables in Boolean Statements

Point numbers for normal integer and floating point number variables can also be included in
Boolean statements. Positive values will be regarded as TRUE, negative values FALSE.

Example: 1031: 1719=/7801 (if station flow rate [7801 reverses ie: goes] negative, trigger a snap-
shot report [1719]

Packing and Unpacking Booleans

Boolean statement can include integer register moves to Boolean variables (unpacked) and
Boolean variables moves to integer registers (packed).

404
OMNICOM: Boolean Statements

Example 1:
3501=1501:1530 (packs 30 bits into 16-bit integer registers 3501 and 3502 with 3501 con-
taining 1501 in the LSB through 1516 in the MSB and the remaining 14 bits would be packed
into 3502 with 1517 in the LSB and the remaining bits ascending from there.

Example 2:
1501=3501:3502 (unpacks 3501 with point 1501 containing the LSB of 3501 and point 1517
would end up holding the LSB of 3502.

Physical Digital I/O Points

The current state of any input or output point can also be used in programmable Boolean state-
ments. I/O Points 01 (1001) through 12 (1012) are available when one digital I/O module is installed
or I/O points 01 (1001) through 24 (1024) when two digital I/O modules are installed.

Scratch Pad Booleans or Flags

Boolean points 1501 through 1649, with the exception of 1600 which is reserved, are scratch pad
points that can be used to store the result of user Boolean statements or Boolean variables received
via a communication link. In addition, Boolean points 1650 through 1699 are one-shot Boolean
scratch pads that can be used to send commands to the OMNI. These one-shot points automatically
reset themselves after two seconds.

For full data point listing, reference the Database Browser.

405
OMNICOM: Variable Statements

Variable Statements
There are 128 (see note*) programmable analog variable points which can be used to provide cus-
tomized data variables. These 128 analog variables are assigned the points numbers 7025 through
7088 and 27025 through 27088.

*Note: the number of Variable statements increased from 64 to 128 for firmware versions 20.75.10,
22.75.10, 23.75.10, 24.75.10, 26.75.10, and 27.75.10 and higher.

Use the Database Browser to assist in entering the registers used in the statements. Any register
selected is appended to the end of the statement. You may select multiple registers and they will be
in appended to the subsequent statements.

They may be displayed, printed or sent to an analog output. Typical use would be to convert an exist-
ing variable to another unit.
For example to provide a variable representing BBLS/DAY you could multiply the existing BBLS/HR
variable (point 7101) by 24. To do this you would enter the simple statement 7025=7101*#24

Programmable analogs are evaluated every 500ms. The numeric value of a variable depends upon
the program statement to the right of it. Each program statement can contain 3 variables or con-
stants separated by valid operators.

Note: In the Variable Statements, a value is considered 'true' if it is greater than or equal to zero and
'false' if it is less than zero.

Math Operators

Operator Description
'+' ADD the following variable/constant
'-' SUBTRACT the following variable/constant
'*' MULTIPLY the following variables/constant
DIVIDE by the following variable/constant. (This operator serves the same
function as the NOT operator serves in a custom Boolean statement when it is
'/'
the first character in a Variable Statement. The NOT operator is used with the
IF operator.)
'$' Use ABSOLUTE value of following variable
'#' Number following is a CONSTANT
'&' Raise to the POWER of following variable/constant

Other miscellaneous operators are:

406
OMNICOM: Variable Statements

Operator Description
EQUAL operator. Put the resultant value of the expression in the point to the
'='
left of the'=' sign. Cast type if needed.
'G' GOTO and evaluate the statement number following the 'G'.
IF the "logical" value of the variable to the left of the ')' is true (greater than or
')'
equal to zero), evaluate the rest of the statement.
Always used with the EQUAL '=' operator. Copy the range of points to the
MOVE
right of the '=' into a range of points starting at the point to the left of the '='
RANGE ':'
operator. Cast type if needed.
EXACT
Compare the value left of the '%' with the value to the right of the '%'. The
COMPARE
statement result is +1 if exactly equal and -1 if not exactly equal.
'%'
INDIRECT
Use the contents of the point following ';' (*See note below) to determine the
REFERENCE
address of the target data base point.
';'
WRITE ASCII Write the ASCII string data between quotes to the address to the left of the '='
STRING '"' sign.
Used to create custom totalizers where remainders need to be carried into the
TOTALIZE ','
custom totalizer in the next calculation cycle.
RISING Triggers for 500ms on a rising edge. (Available with 20.73.20, 23.74.10,
EDGE '(' 24.74.10, and 27.74.10)
FALLING Triggers for 500ms on a falling edge. (Available with 20.73.20, 23.74.10,
EDGE '(/' 24.74.10, and 27.74.10)
Triggers for 500ms on either edge (rising or falling - when checking floats, trig-
ONE SHOT
gers when the value goes from a negative to positive or positive to negative
'@'
state). (Available with 20.73.20, 23.74.10, 24.74.10, and 27.74.10)
RANGE The variable statement result will be a value of 1 if the value of the variable
CHECKING being checked is within the ranges specified or a value of -1 if outside the
'<' range. (Available with 20.73.20, 23.74.10, 24.74.10, and 27.74.10).

*NOTE: Beginning in approximately September 2001 the indirect operator symbol was changed in
some revisions of firmware. The indirect operator symbol changed to the semi-colon (;) and the old
indirect (") symbol is now used as the Write ASCII string operator.

Order of Precedence of Operators:

Order of Precedence
ABSOLUTE '$'
POWER '&'
MULTIPLY '*' and DIVIDE '/'
ADD '+' and SUBTRACT '-'

In cases where operators have equal precedence they are executed in order left to right.

407
OMNICOM: Variable Statements

Including Boolean Variables


For the purposes of MATHEMATICAL evaluation: Boolean variable have the value 1.0 if they are
TRUE and 0.0 if they are FALSE.

Example 1: Shows statement 7025 (note, to maximize the available display characters only the
digits '25' are displayed)
           25: 7030*1105 (multiplies floating point variable 7030 by 1.0 if meter run #1 is active or by 0.0 if
                                meter run #1 is not active [1105 is meter run active flag]).

USING THE LOGICAL VALUE OF BOOLEAN AND NUMERIC VARIABLES


IN AN EXPRESSION
As show above Boolean variables have a numeric value of 1.0 or 0.0 depending upon their 'true or
false' logical value. Likewise a numeric variable such as a flow rate or temperature variable has a
logical value of 'true or false' depending upon whether it is positive or negative (Note: 0.0 is con-
sidered a positive number). The NOT '/' and IF ')' operators are the only operators that uses the
"logical" value of a variable.

Example 2: (IF Operator): Shows statement 7026 used to conditionally place a value in another vari-
able.
7026: 1105)7030=#1.2 (IF Boolean variable 1105 is true, set variable statement 7030 equal
to a constant value of 1.2.)

Example 3: (SUBTRACT, CONSTANT, IF, and GOTO Operators): Changing the execution order
of variable statements depending on the value of a floating point variable (in this case flow rate).
7027: 7101-#1000 (Gross flow rate meter 1, contained in 7101, minus a constant value of
                                          1000)
7028: 7027)G7040 (GOTO statement 7040, skipping statements 7029 through 7039, if
the
                                         result of variable statement 7027 is equal to or greater than 1000)

GOTO statements can be either forward or reverse referenced but must reference a valid statement
number between 7025 and 7088. A limit of 200 is placed on the total number of statements that can
be executed. This ensures that system crashes are avoided in cases where program errors cause
endless loops to occur.

Example 4: (MULTIPLY and CONSTANT Operators): Use program variable (7025) to provide a
daily flow rate by multiplying the hourly flow rate variable (7101) by 24. The program statement looks
like
7025: 7101*#24

Example 5: (SUBTRACT, CONSTANT, and DIVIDE Operators): Use program variables (7050
and 7051) to provide meter temperature in degC by subtracting 32 from the degF variable (7105)
and dividing the result (7050) by 1.8. The program statements look like:
7050: 7105-#32
7051: 7050/#1.8

408
OMNICOM: Variable Statements

Example 6: (MOVE and MULTIPLY Operators): Use program variable (7030) to provide an addi-
tional totalizer (7073) which represents meter factored gross barrels by multiplying the gross barrel
increment (7640) by the meter factor variable (5121). Assign the matching accumulator point 1073
to a digital point to output pulses (1073 is automatically associated with 7073). The program state-
ment looks like
7030: 7073=7640*5121

Example 7: (EQUAL and MOVE RANGE Operators): Move floating point variables 7101 through
7106 into scratch pad floating point registers 7501 through 7506 and move 7112 through 7117 into
scratch pads 7507 through 7512 to allow an HMI system to make a single poll for a block of registers
in the range of 7501 through 7512. The program statements look like:
7060: 7501=7101:7106
7061: 7507=7112:7117

Example 8: (EQUAL, ADD, CONSTANT, and INDIRECT Operators): Calculate pointer address to
7551 (assuming address 7500 contains a value of 7500) and store in 3501, then store a constant
(25) in 7551 using an indirect write via 3501. The program statements look like:
7065: 3501=7500+#51
7066: "3501=#25
*See note at top of page on the INDIRECT ';' operator.

Example 9: (EXACT COMPARE, CONSTANT, IF, and EQUAL Operators): Check to see if the
time is 03:00:00 PM and if true, print a snapshot report. The program statements looks like
7070: 5848%#150000
7071: 7070)1719=7070

Example 10: (EQUAL and WRITE ASCII STRING Operator): Move the string ABCDEFGH into
string variable 4501
7025: 4501="ABCDEFGH"
Move the string ABC into the left most bytes of string variable 4501. The remaining 5 bytes to the
right would be padded with spaces.
7025: 4501="ABC"
Move the string ABCDEFGH into string variable 4501 truncating any characters after the first 8 char-
acters.
7025: 4501="ABCDEFGHI"
*See note at top of page on the INDIRECT ‘;’ and the WRITE ASCII STRING ‘"’ operators.

Example 11: (TOTALIZE Operator): Comma symbol is used as the totalize operator.
7025: 5501,7043#3
Where:
7025: the remainder part of totalizer argument1
argument1: the totalizer of an integer with inferred decimal places, a long integer scratch pad point
(5501 - 5599) should be used. Indirect mode is allowed.

argument 2: the increment to be added to the totalizer, any float, short integer or long integer type of
database index number or a constant will be valid. Indirect mode is allowed. The increment must be
positive; a negative increment will be set to zero.

409
OMNICOM: Variable Statements

argument3: the number of inferred decimal position of the totalizer, a constant range from 0 to 6 will
be valid for this field. Zero inferred decimal will be used if this field is not entered.

The following five examples of the totalize operator will be taken as legal statements:
Example 11a: Accumulate value contained at 7043 into long integer 5501. An inferred decimal pos-
ition of 3 places (XXX, XXX. XXX)
7025: 5501,7043#3

Example 11b: Accumulate value contained at 7043 into long integer 5502. Non inferred decimal
position specified (XXX, XXX, XXX)
7026: 5502,7043

Example 11c: Accumulate a constant value into long integer 5503 with an inferred decimal res-
olution of 3 decimal places. (XXX, XXX. XXX)
7027: 5503,#1.234#2

Example 11d: Accumulate a constant value into long integer 5504 with no inferred decimal res-
olution specified. (XXX, XXX, XXX)
7028: 5504,#1.234

Example 11e: Accumulate using indirect references to accumulator and increment


7032: 3502=#5506 Setup pointer to accumulator register 5506
7033: 3551=#7502 Setup pointer to totalizer increment register
7034: ;3502,;3551 Indirect Totalizer operation. 3502 points to accumulator, 3551 points to
increment register

Example 12: (RISING EDGE Operator) (Available with 20.73.20, 22.74.06, 23.74.10, 24.74.10,
26.74.10, and 27.74.10)
This Operator is used to detect a change in state from a low to high.
7025: (7599
Statement 7025 will be a value of +1 for 500ms at the instance when the value in Modbus register
7599 goes from a negative to a positive value (note that a 0 value in 7599 is considered positive). Dur-
ing all other conditions, the value in statement 7025 will be a -1

Example 13: (FALLING EDGE ‘(/’ Operator (Available with 20.73.20, 22.74.06, 23.74.10, 24.74.10,
26.74.10, and 27.74.10)
This Operator is used to detect a change in state from a high to low.
7026: (/7599
Statement 7026 will be a value of +1 for 500ms at the instance when the value in Modbus register
7599 goes from a positive to a negative (note that a 0 value in 7599 is considered positive). During all
other conditions, the value in statement 7025 will be a -1

Example 14: ONE SHOT ‘@’ Operator (Available with 20.73.20, 22.74.06, 23.74.10, 24.74.10,
26.74.10, and 27.74.10)
This Operator is used to detect a change in state, both from a positive to negative or a negative to
positive.
7025: @7501
Statement 7025 will be true with a value of +1 for 500ms at the moment the value in Modbus register
7501 changes from a positive value to a negative value or from a negative value to a positive value

410
OMNICOM: Variable Statements

(note that a 0 value in 7501 is considered positive). At all other times, the value in statement 7025 will
be -1

Example 15: (RANGE CHECKING '<’ Operator) (Available with 20.73.20, 22.74.06, 23.74.10,
24.74.10, 26.74.10, and 27.74.10)
This Operator is used to detect if a value is within or outside a specified low and high range similar to
the Low and High Alarm Limits settings in the configuration.
7025: #60.5<7105<#75.5
Assuming the current temperature for Meter 1 in the OMNI (register 7105) is 65.0 which is between
the 60.5 and 75.5 values keyed into the statement, the value in register 7025 is +1.
If the Meter 1 temperature changes to 60.5 or less or 75.5 or higher, causing it to fall outside of the
specified range, the value in register 7025 will have a value of -1.

CONFIGURABLE USER ENTRIES


Statements 7025 through 7032 can also be used to prompt for user data as follows:
7025: Pressure Limit ? (No expression just a text prompt!)
7040: 7106-7025 (7040 is positive if meter pressure is greater than pressure limit)
7041: 7040)G7070 (GOTO statement 7070 if meter pressure is greater than "Pressure
Limit"

Press 'Prog 'Input 'Enter' on the OMNI keypad to display the "Pressure Limit ?" prompt. The display
shows the
statement number on the first line, cursor on the second line to enter data, and the message prompt
on the third line:

User Variable #7025 Value 0 Pressure Limit ?

Special Modbus functions (currently only in versions 20.71 and higher)


Modbus communications function code 6 in the OMNI has been modified to allow additional func-
tionality. Some outdated communications systems cannot write ASCII string data using Modbus
because they do not support communications function code 16 which is normally used to write ASCII
string data. The additional functionality allows use of Modbus function code 6 which is normally sup-
ported by older systems to write "ASCII string" Batch ID data from a host system to the OMNI flow
computer.

The "ASCII string" would always be a number from 1 to 65535, never alpha characters. The number
0 will always be reserved for a special function (a single 0 instructs the OMNI to set all 8 characters
as "spaces", not nulls, in the register when a single 0 is written to it). The Batch ID numbers should
always be written to the Batch ID registers in the address range of 4852 through 4899 in the OMNI
Modbus database. The even numbered registers (4852, 4854, 4856, et al) should always have a
single 0 written to them once and then never written to again for some time. The odd numbered
registers (4853, 4855, 4857, et al) are the registers where you would write the numbers 1 to 65535
into.

Example: The host system writes a single 0 to Modbus register 4856. This instructs the OMNI to put
8 "spaces" into 4856. The host also writes the number 254 to Modbus register 4857. This instructs
the OMNI to put the number 254, right-justified, into register 4857. The OMNI should automatically

411
OMNICOM: Variable Statements

put 5 spaces in front of the number 254 in register 4857 to fill out the rest of the 8 characters. Modbus
register 4856 will already have 8 spaces in it because it had a 0 written to it. When the OMNI shifts
the batch stack due to a batch end, "spaces" are shifted into the new registers instead of nulls.

Example 1: Allows an 8-byte ASCII string to be transferred to 2 long integers at 5501 and 5502:
7030: 5501=4857

If 4857 contains a value of 254 (20 20 20 20 20 32 35 34)


5501 will contain a value of 538976288 (20 20 20 20)
5502 will contain a value of 540161332(20 32 35 34)

Example 2: Allows an 8-byte ASCII string to be transferred to 4 short integers at 3501, 3502, 3503,
and 3504:
7031: 3501=4857

If 4857 contains a value of 254 (20 20 20 20 20 32 35 34)


3501 will contain a value of 8224 (20 20)
3502 will contain a value of 82241 (20 20)
3503 will contain a value of 8242 (20 32)
3504 will contain a value of 13620 (35 34)

Example 3: Allows 2 long integers to be transferred to an 8-byte ASCII string:


7032: 4501=5501 (use the values shown in Example 1)

Note: the only integers allowed for the special functions are 16-bit integers 3501 thru 3599 and 32-
bit integers 5501-5599.

Note: the special functions do not work for ASCII registers which are read only regardless if source
or destination.

412
OMNICOM: Gas Chromatograph

Gas Chromatograph
The Gas Chromatograph subcategory is for entering and selecting GC settings. This function is avail-
able within OMNICOM if you select the Gas Chromatograph (GC) setting within the Equipment List
dialog of the OMNI General Setup. Based upon your selections, OMNICOM makes available only
those options that apply to your metering system configuration.

In order for the GC to function correctly, the protocol must have been selected on Serial Port 3 of the
OMNI. Note: if connecting to a Danalyzer RTU via RS-485, echo should be off.

Topics
The items listed below are links to topics within the Gas Chromatograph category. Click on a link to
go to that topic.

Gas Chromatograph Setup


Gas Chromatograph Components

413
OMNICOM: Gas Chromatograph Setup

Gas Chromatograph Setup


The Gas Chromatograph Setup dialog is for Entering the ID number of the gas analyzer and the
interval that the flow computer should wait between result updates. This dialog also allows the user
to specify if the flow computer should talk back to the analyzer or just listen. Once you enter the
information and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Gas Chromatograph Setup
dialog. Click on a setting for more information.

GC Protocol

Analyzer ID: Enter the identifying number of the ABB HCl-A or Daniel Danalyzer gas chro-
matograph. This is the serial communication ID number of the analyzer.

Analyzer 2 ID: Enter the identifying number of the Daniel Danalyzer gas chromatograph.
This is the serial communication ID number of the analyzer.

Analyzer Type: The OMNI flow computer can communicate and retrieve analysis data from
either an ABB (HC1-A protocol) or a Daniel Danalyzer chromatograph. In both cases the flow
computer uses the Serial Port 3 for GC communications.

When talking to an ABB GC, the flow computer uses the ABB proprietary HCI-A protocol inter-
face. Note: OMNI’s testing policy is to re-test GC communication protocols after flow com-
puter firmware changes have been made. This has not been possible with the HCI-A protocol
because ABB, the company that acquired the Applied Automation GC product line, no longer
supports the HCI-A protocol. OMNI therefore cannot guarantee proper operation of HCI-A
protocol.

When talking to a Danalyzer Modbus ASCII or RTU is used.

Results Interval: This is the maximum number of seconds (for v74 and higher) or minutes
(for v73 and lower) that the flow computer should wait for results from either type of gas chro-
matograph.
If the GC is in the 'query' mode, the 'GC Alarm' bit will be set if no com-
munications from the GC are received after a request for data.

If the GC is in 'listen only' mode, the OMNI adds 30 seconds to the results interval
value. The 'GC Alarm' bit will be set if no communications from the GC are
received within the results interval value since the last communication from the
GC.
Mole Deviation: Checks if the Mole % total of GC components deviates from 100 % within
the entered limit. If outside the limit, Mol % Out of Range alarm Modbus point 1881 is raised.

414
OMNICOM: Gas Chromatograph Setup

Mode

Listen Only: In many cases more than one flow computer will be connected to a single gas ana-
lyzer. Only one flow computer is allowed to act as a host device and request data from the analyzer.
All of the remaining computers must 'listen' to the result data 'only'.

GC Fail Code

This entry selects what override strategy will be used should the Gas Chromatograph fail.

The selections are:

Always use the last good analysis from the GC


Always use the manual overrides specified in the Fluid Products Setup screen.
Use the manual overrides if the GC fails.
Use GC2 on GC1 failure (if the GC2 also fails, the OMNI uses the manual overrides specified
in the Fluid Products Setup screen)
Always use GC2

Note: When using overrides that use GC2, GC1 and GC2 must have identical stream configurations.

A failure may be due to a fatal error flagged by the GC indicating that the composition data may not
be reliable. Fatal errors usually are caused by some type of hardware problem at the GC; i.e.
EPROM ERROR, D/A CONVERTER ERROR etc. A breakdown of communications between the
flow computer and the GC will also cause a GC failure error.

Danalyzer Type

Select either the USA or ISO version of the Danalyzer.

Note: GPM is available on USA versions of the Models 2251 and 2255 only. ISO versions of the con-
troller will contain weight percent only. (See OMNI's technical bulletin on the Danalyzer GC for com-
plete GC register information.)

Danalyzer Heating Value

Select the register for the flow computer to read to acquire the heating value from the GC. The
choices are “Actual BTU (7054)" and "Dry Superior (7033)”. The default is Actual BTU (7054).

For firmware versions prior to 23.75.01 and 27.75.01, the flow computer first reads the Actual BTU
register 7054. If the value is zero, the flow computer reads the Dry Superior register 7033.

415
OMNICOM: Gas Chromatograph Components

Gas Chromatograph Components


The items listed below are links to descriptions of each setting option within the GC Components dia-
log. Click on a link to go to that setting's description.

Component Order Setup

Each gas chromatograph (GC) can be unique in the number of components it can analyze,
and also in the order that it can present these. For each of these settings, enter the component
number position of each component recognized by your GC. Consult the GC documentation
for the corresponding component order. Enter 0 for any unused components.

A Danalyzer GC for instance stores the mole percentages of each component it analyzes in
it's Modbus database starting at 7001 through 7016 with a typical ordering as follows:

C6+ 7001
Propane 7002
i-Butane 7003
n-
7004
Butane
neo- 7005 (add this component in the GC to i-Pentane component before it is read
Pentane by the OMNI. Neo-Pentane does not exist in AGA-8 or AGA-5)
i-
7006
Pentane
n-
7007
Pentane
Nitrogen 7008
Methane 7009
CO2 7010
Ethane 7011

Note: Since component 1 in a Danalyzer GC is typically used for C6+, if the user is con-
figuring components for a Danalyzer GC and selects another component as 1, OMNICOM dis-
ables the C6+ distribution.

Note: The above component order is used only as an example, consult your GC doc-
umentation to determine the actual order that the components are placed in your GC.

Note: While the SG and BTU data in the GC is not really component data, the flow computer
still needs a number to be entered for each entry. Simply assign them the next two sequential
numbers after all other components are numbered.

The component for neo-Pentane was added with firmware versions 23.74.20 and 27.74.20
and higher. See the help for Fluid Setup for more information on how this component is used.

416
OMNICOM: Gas Chromatograph Components

C6+ Distribution

Since the amount of Hexane and higher components within a gas mixture is usually quite
small, some GCs provide a combined C6+ figure instead of individual mole percentages as
the analysis result.

Use these fields to specify the percentage of C6 through C10 components that make up the
C6+ contribution. Make sure that the sum of the C6+ components equals 100%.
Enter 0 for any unused components.

Note: Since component 1 in a Danalyzer GC is typically used for C6+, if the user is con-
figuring components for a Danalyzer GC and selects another component as 1, OMNICOM dis-
ables the C6+ distribution.

417
OMNICOM: Custom Packets

Custom Packets
The custom Modbus data packets are provided to reduce the number of polls needed to read mul-
tiple variables which may be in different areas of the data base.

Each packet consists of groups of data points concatenated into a single contiguous reply message.
The packet is described by specifying the starting index number of each of the groups followed by
the number of following points.

Three separate data packets can be configured:

   Packet #1 - Address 001 contains up to 20 groups of data.


   Packet #2 - Address 201 contains up to 8 groups of data.
   Packet #3 - Address 401 contains up to 20 groups of data.

Enter the point and point count for each packet. Use the Database Browser to assist in selecting
points. All of the points in the packet must be available for the application.

If the number of bytes for the packet exceeds 250, a warning message is displayed in yellow but the
user may apply the changes.

If the number of bytes for the packet exceeds 400, an error message is displayed in red and the user
may not apply the changes.

When Modicon compatibility is not selected in the serial port or Ethernet port configuration used to
read the Custom Modbus packets, the packets are Read-Only and the entire configured packet must
be read as one poll. The number of data bytes in any packet cannot exceed 250 (RTU mode) or 500
(ASCII mode).

When Modicon compatibility is selected for the serial port or Ethernet port configuration, the Custom
Modbus packets are Read or Write and the number of data bytes in a custom packet cannot exceed
400 (RTU mode) or 800 (ASCII mode). With Modicon compatibility you are allowed to read from or
write to certain parts of each packet instead of having to read or write the entire packet. Although the
Modbus protocol still limits the number of data bytes in any packet to 250 (RTU mode) and 500
(ASCII mode), you are able to exceed this size limitation when configuring the Custom Modbus pack-
ets because Modicon Compatibility allows you access to the entire configured packet by utilizing mul-
tiple reads or writes.

Note: When in Modicon compatibility mode, the OMNI packs 8 Boolean points to each byte so it is
important to configure the booleans in groups of 16 to ensure the packet returned contains an even
number of bytes in order to be Modicon compatible. Note that when reading boolean bits, the OMNI
sends back all the bytes in the packet no matter which individual register within the packet or how
many registers are requested. Additionally, custom data packets can only use function codes 03, 06,
and 16, and cannot use 01, 05, and 15, so it is recommended that writes to Boolean coils be accom-
plished by using the normal Modbus function code 05 and writing directly to the database Boolean
point address. However, if you will be writing to Boolean bits inside the custom packets, be

418
OMNICOM: Custom Packets

especially careful when writing to command points. You should first read the Boolean bits from the
packet, "OR" your command into the polled bits, and then write them back to the custom data packet
in order to avoid sending unintentional commands to the OMNI.

Operating with VSAT Systems


With these satellite systems it is advantageous to be able to transmit data without being asked to do
so. The flow computer can be configured to transmit any of the custom data packets out of any Mod-
bus port without being polled.

The following boolean points are used to trigger the transmissions.

2701 Custom Packet #1 Transmitted via Serial Port #1


2702 " " #2 " " " " #1
2703 " " #3 " " " " #1
2704 Custom Packet #1 Transmitted via Serial Port #2
2705 " " #2 " " " " #2
2706 " " #3 " " " " #2
2707 Custom Packet #1 Transmitted via Serial Port #3
2708 " " #2 " " " " #3
2709 " " #3 " " " " #3
2710 Custom Packet #1 Transmitted via Serial Port #4
2711 " " #2 " " " " #4
2712 " " #3 " " " " #4

Settings
The items listed below are descriptions of each setting option within the Custom Packets dialog.
Click on a setting for more information.

Packet Point Number - Enter the address or Modbus index number for the first data point in this
group. For Meter Run 'n' Variables: (Replace 'n' with meter run number).

Packet Point Count - Enter the number of consecutive data points to be included in this data
group. This is always input in terms of OMNI 'logical' elements. ie: An IEEE floating point number
comprises two 16 bit words but is considered one logical element.

Modbus Packets
Modbus Packet 001
Modbus Packet 201
Modbus Packet 401

Import/Export Custom Packet Configurations


Custom Packet Configuration files can be imported or exported if the Advanced User command line
switch "-AU" is enabled. If you need help adding a command line switch, please speak with your IT

419
OMNICOM: Custom Packets

representative.

After the command line switch is enabled, access the import/export feature by right-clicking on the
tree item or selecting via the File Menu. Files are defaulted to the extension: "*.oXXcpNNN" where
XX is the application (20, 24...), and NNN is 001, 201, or 401 however the user may enter any exten-
sion.

420
OMNICOM: Modbus Packet 001

Modbus Packet 001


Packet #1 - Address 001 contains up to 20 groups of data.

Use the Database Browser to assist in selecting points.

Modicon 984 Mode


In Modicon mode the packet entries are used to specify logical arrays within the OMNI which can be
READ or WRITE. The starting address of the array is 1 (the same as when used as a custom
packet). Group similar data types together as this allows the programmer of the PLC or DCS system
to define matching arrays within their system, greatly simplifying the transfer of data back and forth.

The example below shows how to setup an array of floats, 8-character ASCII strings, longs,
Booleans, and 16-character ASCII strings using custom packet definition entries. The Address is the
Modbus register address you would use if you wanted to access that particular variable. The Offset
shown is the register offset from the start of the data type group.

In the Modicon protocol, the only data type recognized are 16-bit integers. The OMNI's floats and
longs registers are 4 bytes each and are transmitted as two 16-bit integer registers. Booleans are 8
points to one byte but in Modicon should be configured and transmitted as one 16-bit integer register
(two bytes) so each register contains 16 points. The 8-character ASCII strings are 8 bytes and are
transmitted as four 16-bit integer registers. The 16-character ASCII strings are 16 bytes and are
transmitted as eight 16-bit integer registers. It is up to the receiving machine to re-group the 16-bit
integer registers into their proper format.

Note: When in Modicon compatibility mode, the OMNI packs 8 Boolean points to each byte so it is
important to configure the Booleans in groups of 16 to ensure the packet returned contains an even
number of bytes in order to be Modicon compatible. Note that when reading Boolean bits, the OMNI
sends back all the bytes in the packet no matter which individual register within the packet or how
many registers are requested. Additionally, custom data packets can only use function codes 03, 06,
and 16, and cannot use 01, 05, and 15, so it is strongly recommended that writes to Boolean coils be
accomplished by using the normal Modbus function code 05 and writing directly to the database
Boolean point address. However, if you will be writing to Boolean bits inside the custom packets, be
especially careful when writing to command points. You should first read the Boolean bits from the
packet, "OR" your command into the polled bits, and then write them back to the custom data packet
in order to avoid sending unintentional commands to the OMNI.

Note: Use the Modbus Tester in OMNICOM Diagnostics and select function code 03 and the "Cus-
tom Data Packet" data type to see how your custom packets data will look translated into the con-
figured format. If using a Modicon connection, Modbus Tester also shows the corresponding
addresses used for each packet.

Modbus Modbus Number of


Description
Packet Index Points

421
OMNICOM: Modbus Packet 001

Meter 1 Flow Rates, Temperatures &


1 7101 6
Pressures
Meter 2 Flow Rates, Temperatures &
2 7201 6
Pressures
3 4111 Meter 1 Serial number etc. 4
4 4211 Meter 2 Serial number etc. 4
5 5101 Meter 1 Batch in Progress Totals 4
6 5201 Meter 2 Batch in Progress Totals 4
7 1105 Meter 1 Status bits 48
8 1205 Meter 2 Status bits 48
Programmable Variables 87 and 88
9 14275 2
Remarks

Note: 'Number of Points' refers to number of variables not words. For the example shown, the
Honeywell APM arrays would be setup as follows:

Array of 12 Real IEEE Floats


Note that each float is 4 bytes of data and require two 16-bit integer registers to read and write.

Address Offset Variable Description


1 0 Meter 1 Gross Flow Rate
3 2 Meter 1 Net Flow Rate
5 4 Meter 1 Mass Flow Rate
7 6 Meter 1 Energy Flow Rate
9 8 Meter 1 Temperature
11 10 Meter 1 Pressure
13 12 Meter 2 Gross Flow Rate
15 14 Meter 2 Net Flow Rate
17 16 Meter 2 Mass Flow Rate
19 18 Meter 2 Energy Flow Rate
21 20 Meter 2 Temperature
23 22 Meter 2 Pressure

Array of eight 8-character strings


Note that each 8-character ASCII string is 8 bytes of data and require four 16-bit integer registers to
read and write.

Address Offset Variable Description


25 0 Meter 1 Serial Number
29 4 Meter 1 Size
33 8 Meter 1 Model Type

422
OMNICOM: Modbus Packet 001

37 12 Meter 1 ID Tag
41 16 Meter 2 Serial Number
45 20 Meter 2 Size
49 24 Meter 2 Model Type
53 28 Meter 2 ID Tag

Array of 8 Longs
Note that each long is 4 bytes of data and require two 16-bit integer registers to read and write.

Address Offset Variable Description


57 0 Meter 1 Batch in Progress - Gross Total
59 2 Meter 1 Batch in Progress - Net Total
61 4 Meter 1 Batch in Progress - Mass Total
63 6 Meter 1 Batch in Progress - Energy/NSV Total
65 8 Meter 2 Batch in Progress - Gross Total
67 10 Meter 2 Batch in Progress - Net Total
69 12 Meter 2 Batch in Progress - Mass Total
71 14 Meter 2 Batch in Progress - Energy/NSV Total

Array of 96 Boolean points


Note that 8 Boolean points make up one byte of data. Each 16-bit integer is two bytes of data so
each register contains 16 Boolean points to read and write. For this reason, it is best to configure the
Boolean points in the custom data packet in groups of 16. Note that on a read, the OMNI always
sends the entire Boolean packet no matter which address or how many registers are requested. For
example, if you requested register 74 for 1 register, instead of getting the expected 1 register (two
bytes) with points 16-31, you will get the whole packet #7 which is 3 registers (6 bytes) with all 48
Boolean points.

Point
Address Offset Variable Description
Offset
73 0 0 Meter 1 Active Flag through Meter 1 Flow Rate Low
Meter 1 Flow Rate Low Alarm through Meter 1 Density
74 1 16
Temperature Trans Fail Low
Meter 1 Density Temperature Low Alarm through Meter 1
75 2 32
DP High Range is Selected
76 3 48 Meter 2 Active Flag through Meter 1 Flow Rate Low
Meter 2 Flow Rate Low Alarm through Meter 1 Density
77 4 64
Temperature Trans Fail Low
Meter 2 Density Temperature Low Alarm through Meter 1
78 5 80
DP High Range is Selected

423
OMNICOM: Modbus Packet 001

Array of two 16-character strings


Note that each 16-character ASCII string is 16 bytes of data and require eight 16-bit integer registers
to read and write. Note: these registers are just used as an example as you would not normally read
and write programmable statement remarks.

Address Offset Variable Description


79 0 Programmable Variable 87 Remarks
87 8 Programmable Variable 88 Remarks

Notes
Note 1) Modicon addresses transmitted over the Modbus RTU link are one less than the
addresses shown. Modbus ASCII mode transmits the same addresses as shown.

Note 2) Long Integers are two word variables which cannot be split and must be read and writ-
ten as a set.

Note 3) Floats are two word variables which cannot be split and must be read and written as a
set.

Note 4) 8-byte strings are four word variables which cannot be split and must be read and writ-
ten as a set.

Note 5) 16-character strings are 8 word variables which cannot be split and must be read and
written as a set.

Note 6) Modicon works with "words" (i.e., 16 bits). If you will be configuring Boolean points in
the Custom Modbus Packet arrays, it is good practice to configure the number of Boolean
points as divisible by 16 (i.e., 16, 32, 48, 64, etc). Do not configure the number of Boolean
points to 8 or 9 or 31 for example, or you will most likely experience communications prob-
lems. The OMNI will pad zeroes to complete the "byte", not the "word" though, before sending
out the Boolean data so in effect you could probably get away with assigning 9 or 31 as the
OMNI would complete the rest of the byte which in this particular case would also complete
the word. However, this is not good practice as your polling system may have problems with
receiving extra data bits it did not request or that it may not be expecting. Simply specify the
number of Boolean points as divisible by 16 and then throw away any extra bits you do not
want at your polling device.

Note 7) The use of the data packets can be split between Modicon compatible mode users
and normal mode users. The packet at address 001 for example could be configured to
provide read/write arrays for a Modicon 984 PLC on one serial port, while packets addressed
at 201 and 401 could be used to provide read only data packets required by normal (non-
Modicon) mode user on another serial port.

424
OMNICOM: Modbus Packet 201

Modbus Packet 201


Packet #2 - Address 201 contains up to 8 groups of data.

Use the Database Browser to assist in selecting points.

Modicon 984 Mode


In Modicon mode the packet entries are used to specify logical arrays within the OMNI which can be
READ or WRITE. The starting address of the array is 201 (the same as when used as a custom
packet). Group similar data types together as this allows the programmer of the PLC or

The example below shows how to setup an array of floats, 8-character ASCII strings, longs,
Booleans, and 16-character ASCII strings using custom packet definition entries. The Address is the
Modbus register address you would use if you wanted to access that particular variable. The Offset
shown is the register offset from the start of the data type group.

In the Modicon protocol, the only data type recognized are 16-bit integers. The OMNI's floats and
longs registers are 4 bytes each and are transmitted as two 16-bit integer registers. Booleans are 8
points to one byte but in Modicon should be configured and transmitted as one 16-bit integer register
(two bytes) so each register contains 16 points. The 8-character ASCII strings are 8 bytes and are
transmitted as four 16-bit integer registers. The 16-character ASCII strings are 16 bytes and are
transmitted as eight 16-bit integer registers. It is up to the receiving machine to re-group the 16-bit
integer registers into their proper format.

Note: When in Modicon compatibility mode, the OMNI packs 8 Boolean points to each byte so it is
important to configure the Booleans in groups of 16 to ensure the packet returned contains an even
number of bytes in order to be Modicon compatible. Note that when reading Boolean bits, the OMNI
sends back all the bytes in the packet no matter which individual register within the packet or how
many registers are requested. Additionally, custom data packets can only use function codes 03, 06,
and 16, and cannot use 01, 05, and 15, so it is strongly recommended that writes to Boolean coils be
accomplished by using the normal Modbus function code 05 and writing directly to the database
Boolean point address. However, if you will be writing to Boolean bits inside the custom packets, be
especially careful when writing to command points. You should first read the Boolean bits from the
packet, "OR" your command into the polled bits, and then write them back to the custom data packet
in order to avoid sending unintentional commands to the OMNI.

Note: Use the Modbus Tester in OMNICOM Diagnostics and select function code 03 and the "Cus-
tom Data Packet" data type to see how your custom packets data will look translated into the con-
figured format. If using a Modicon connection, Modbus Tester also shows the corresponding
addresses used for each packet.

Modbus Modbus Number of


Description
Packet Index Points
1 7101 Meter 1 Flow Rates, Temperatures & 6

425
OMNICOM: Modbus Packet 201

Pressures
2 4111 Meter 1 Serial number etc. 4
3 5101 Meter 1 Batch in Progress Totals 4
4 1105 Meter 1 Status bits 48
Programmable Variables 87 and 88
5 14275 2
Remarks

Note: 'Number of Points' refers to number of variables not words. For the example shown, the
Honeywell APM arrays would be setup as follows:

Array of 6 Real IEEE Floats


Note that each float is 4 bytes of data and require two 16-bit integer registers to read and write.

Address Offset Variable Description


201 0 Meter 1 Gross Flow Rate
203 2 Meter 1 Net Flow Rate
205 4 Meter 1 Mass Flow Rate
207 6 Meter 1 Energy Flow Rate
209 8 Meter 1 Temperature
211 10 Meter 1 Pressure

Array of four 8-character strings


Note that each 8-character ASCII string is 8 bytes of data and require four 16-bit integer registers to
read and write.

Address Offset Variable Description


 213 0 Meter 1 Serial Number
217 4 Meter 1 Size
221 8 Meter 1 Model Type
225 12 Meter 1 ID Tag

Array of 4 Longs
Note that each long is 4 bytes of data and require two 16-bit integer registers to read and write.

Address Offset Variable Description


229 0 Meter 1 Batch in Progress - Gross Total
231 2 Meter 1 Batch in Progress - Net Total
233 4 Meter 1 Batch in Progress - Mass Total
235 6 Meter 1 Batch in Progress - Energy/NSV Total

426
OMNICOM: Modbus Packet 201

Array of 48 Boolean points


Note that 8 Boolean points make up one byte of data. Each 16-bit integer is two bytes of data so
each register contains 16 Boolean points to read and write. For this reason, it is best to configure the
Boolean points in the custom data packet in groups of 16. Note that on a read, the OMNI always
sends the entire Boolean packet no matter which address or how many registers are requested. For
example, if you requested register 238 for 1 register, instead of getting the expected 1 register (two
bytes) with points 16-31, you will get the whole packet #4 which is 3 registers (6 bytes) with all 48
Boolean points.

Point
Address Offset Variable Description
Offset
237 0 0 Meter 1 Active Flag through Meter 1 Flow Rate Low
Meter 1 Flow Rate Low Alarm through Meter 1 Density
238 1 16
Temperature Trans Fail Low
Meter 1 Density Temperature Low Alarm through Meter 1
239 2 32
DP High Range is Selected

Array of two 16-character strings


Note that each 16-character ASCII string is 16 bytes of data and require eight 16-bit integer registers
to read and write. Note: these registers are just used as an example as you would not normally read
and write programmable statement remarks.

Address Offset Variable Description


240 0 Programmable Variable 87 Remarks
248 8 Programmable Variable 88 Remarks

Notes
Note 1) Modicon addresses transmitted over the Modbus RTU link are one less than the
addresses shown. Modbus ASCII mode transmits the same addresses as shown.

Note 2) Long Integers are two word variables which cannot be split and must be read and writ-
ten as a set.

Note 3) Floats are two word variables which cannot be split and must be read and written as a
set.

Note 4) 8-byte strings are four word variables which cannot be split and must be read and writ-
ten as a set.

Note 5) 16-character strings are 8 word variables which cannot be split and must be read and
written as a set.

Note 6) Modicon works with "words" (i.e., 16 bits). If you will be configuring Boolean points in
the Custom Modbus Packet arrays, it is good practice to configure the number of Boolean

427
OMNICOM: Modbus Packet 201

points as divisible by 16 (i.e., 16, 32, 48, 64, etc). Do not configure the number of Boolean
points to 8 or 9 or 31 for example, or you will most likely experience communications prob-
lems. The OMNI will pad zeroes to complete the "byte", not the "word" though, before sending
out the Boolean data so in effect you could probably get away with assigning 9 or 31 as the
OMNI would complete the rest of the byte which in this particular case would also complete
the word. However, this is not good practice as your polling system may have problems with
receiving extra data bits it did not request or that it may not be expecting. Simply specify the
number of Boolean points as divisible by 16 and then throw away any extra bits you do not
want at your polling device.

Note 7) The use of the data packets can be split between Modicon compatible mode users
and normal mode users. The packet at address 201 for example could be configured to
provide read/write arrays for a Modicon 984 PLC on one serial port, while packets addressed
at 001 and 401 could be used to provide read only data packets required by normal (non-
Modicon) mode user on another serial port.

428
OMNICOM: Modbus Packet 401

Modbus Packet 401


Packet #3 - Address 401 contains up to 20 groups of data.

Use the Database Browser to assist in selecting points.

Modicon 984 Mode


In Modicon mode the packet entries are used to specify logical arrays within the OMNI which can be
READ or WRITE. The starting address of the array is 401 (the same as when used as a custom
packet). Group similar data types together as this allows the programmer of the PLC or DCS system
to define matching arrays within their system, greatly simplifying the transfer of data back and forth.

The example below shows how to setup an array of floats, 8-character ASCII strings, longs,
Booleans, and 16-character ASCII strings using custom packet definition entries. The Address is the
Modbus register address you would use if you wanted to access that particular variable. The Offset
shown is the register offset from the start of the data type group.

In the Modicon protocol, the only data type recognized are 16-bit integers. The OMNI's floats and
longs registers are 4 bytes each and are transmitted as two 16-bit integer registers. Booleans are 8
points to one byte but in Modicon should be configured and transmitted as one 16-bit integer register
(two bytes) so each register contains 16 points. The 8-character ASCII strings are 8 bytes and are
transmitted as four 16-bit integer registers. The 16-character ASCII strings are 16 bytes and are
transmitted as eight 16-bit integer registers. It is up to the receiving machine to re-group the 16-bit
integer registers into their proper format.

Note: When in Modicon compatibility mode, the OMNI packs 8 Boolean points to each byte so it is
important to configure the Booleans in groups of 16 to ensure the packet returned contains an even
number of bytes in order to be Modicon compatible. Note that when reading Boolean bits, the OMNI
sends back all the bytes in the packet no matter which individual register within the packet or how
many registers are requested. Additionally, custom data packets can only use function codes 03, 06,
and 16, and cannot use 01, 05, and 15, so it is strongly recommended that writes to Boolean coils be
accomplished by using the normal Modbus function code 05 and writing directly to the database
Boolean point address. However, if you will be writing to Boolean bits inside the custom packets, be
especially careful when writing to command points. You should first read the Boolean bits from the
packet, "OR" your command into the polled bits, and then write them back to the custom data packet
in order to avoid sending unintentional commands to the OMNI.

Note: Use the Modbus Tester in OMNICOM Diagnostics and select function code 03 and the "Cus-
tom Data Packet" data type to see how your custom packets data will look translated into the con-
figured format. If using a Modicon connection, Modbus Tester also shows the corresponding
addresses used for each packet.

Modbus Modbus Number of


Description
Packet Index Points

429
OMNICOM: Modbus Packet 401

Meter 1 Flow Rates, Temperatures &


1 7101 6
Pressures
Meter 2 Flow Rates, Temperatures &
2 7201 6
Pressures
3 4111 Meter 1 Serial number etc. 4
4 4211 Meter 2 Serial number etc. 4
5 5101 Meter 1 Batch in Progress Totals 4
6 5201 Meter 2 Batch in Progress Totals 4
7 1105 Meter 1 Status bits 48
8 1205 Meter 2 Status bits 48
Programmable Variables 87 and 88
9 14275 2
Remarks

Note: 'Number of Points' refers to number of variables not words. For the example shown, the
Honeywell APM arrays would be setup as follows:

Array of 12 Real IEEE Floats


Note that each float is 4 bytes of data and require two 16-bit integer registers to read and write.

Address Offset Variable Description


401 0 Meter 1 Gross Flow Rate
403 2 Meter 1 Net Flow Rate
405 4 Meter 1 Mass Flow Rate
407 6 Meter 1 Energy Flow Rate
409 8 Meter 1 Temperature
411 10 Meter 1 Pressure
413 12 Meter 2 Gross Flow Rate
415 14 Meter 2 Net Flow Rate
417 16 Meter 2 Mass Flow Rate
419 18 Meter 2 Energy Flow Rate
421 20 Meter 2 Temperature
423 22 Meter 2 Pressure

Array of eight 8-character strings


Note that each 8-character ASCII string is 8 bytes of data and require four 16-bit integer registers to
read and write.

Address Offset Variable Description


425 0 Meter 1 Serial Number
429 4 Meter 1 Size
433 8 Meter 1 Model Type
437 12 Meter 1 ID Tag

430
OMNICOM: Modbus Packet 401

441 16 Meter 2 Serial Number


445 20 Meter 2 Size
449 24 Meter 2 Model Type
453 28 Meter 2 ID Tag

Array of 8 Longs
Note that each long is 4 bytes of data and require two 16-bit integer registers to read and write.

Address Offset Variable Description


457 0 Meter 1 Batch in Progress - Gross Total
459 2 Meter 1 Batch in Progress - Net Total
461 4 Meter 1 Batch in Progress - Mass Total
463 6 Meter 1 Batch in Progress - Energy/NSV Total
465 8 Meter 2 Batch in Progress - Gross Total
467 10 Meter 2 Batch in Progress - Net Total
469 12 Meter 2 Batch in Progress - Mass Total
471 14 Meter 2 Batch in Progress - Energy/NSV Total

Array of 96 Boolean points


Note that 8 Boolean points make up one byte of data. Each 16-bit integer is two bytes of data so
each register contains 16 Boolean points to read and write. For this reason, it is best to configure the
Boolean points in the custom data packet in groups of 16. Note that on a read, the OMNI always
sends the entire Boolean packet no matter which address or how many registers are requested. For
example, if you requested register 474 for 1 register, instead of getting the expected 1 register (two
bytes) with points 16-31, you will get the whole packet #7 which is 3 registers (6 bytes) with all 48
Boolean points.

Point
Address Offset Variable Description
Offset
473 0 0 Meter 1 Active Flag through Meter 1 Flow Rate Low
Meter 1 Flow Rate Low Alarm through Meter 1 Density
474 1 16
Temperature Trans Fail Low
Meter 1 Density Temperature Low Alarm through Meter 1
475 2 32
DP High Range is Selected
476 3 48 Meter 2 Active Flag through Meter 1 Flow Rate Low
Meter 2 Flow Rate Low Alarm through Meter 1 Density
477 4 64
Temperature Trans Fail Low
Meter 2 Density Temperature Low Alarm through Meter 1
478 5 80
DP High Range is Selected

431
OMNICOM: Modbus Packet 401

Array of two 16-character strings


Note that each 16-character ASCII string is 16 bytes of data and require eight 16-bit integer registers
to read and write. Note: these registers are just used as an example as you would not normally read
and write programmable statement remarks.

Address Offset Variable Description


479 0 Programmable Variable 87 Remarks
487 8 Programmable Variable 88 Remarks

Notes
Note 1) Modicon addresses transmitted over the Modbus RTU link are one less than the
addresses shown. Modbus ASCII mode transmits the same addresses as shown.

Note 2) Long Integers are two word variables which cannot be split and must be read and writ-
ten as a set.

Note 3) Floats are two word variables which cannot be split and must be read and written as a
set.

Note 4) 8-byte strings are four word variables which cannot be split and must be read and writ-
ten as a set.

Note 5) 16-character strings are 8 word variables which cannot be split and must be read and
written as a set.

Note 6) Modicon works with "words" (i.e., 16 bits). If you will be configuring Boolean points in
the Custom Modbus Packet arrays, it is good practice to configure the number of Boolean
points as divisible by 16 (i.e., 16, 32, 48, 64, etc). Do not configure the number of Boolean
points to 8 or 9 or 31 for example, or you will most likely experience communications prob-
lems. The OMNI will pad zeroes to complete the "byte", not the "word" though, before sending
out the Boolean data so in effect you could probably get away with assigning 9 or 31 as the
OMNI would complete the rest of the byte which in this particular case would also complete
the word. However, this is not good practice as your polling system may have problems with
receiving extra data bits it did not request or that it may not be expecting. Simply specify the
number of Boolean points as divisible by 16 and then throw away any extra bits you do not
want at your polling device.

Note 7) The use of the data packets can be split between Modicon compatible mode users
and normal mode users. The packet at address 401 for example could be configured to
provide read/write arrays for a Modicon 984 PLC on one serial port, while packets addressed
at 001 and 201 could be used to provide read only data packets required by normal (non-
Modicon) mode user on another serial port.

432
OMNICOM: Archives

Archives
There are 10 custom archive data files which allow the user to store historical records of any data
contained within the database. Select one of the 10 archive files to be configured. Each file is a cir-
cular buffer. When the file is full the oldest data records are overwritten by new data as it is saved.
The data records contained within each archive file can be individually defined as to what data is
stored and how many total records can be saved. Once you enter the information and/or make your
selections, press the [Apply] button to set.

You may only configure the archives when the archive configuration is enabled. To enable the
archives, see the help for Archive Maintenance.

Note: In versions 70 and 71 of the firmware, the Historical Text Reports (i.e. Snapshot, Daily,
Batch) are generated before the 701-710 Archiving takes place. In version 74 of the firmware, the
701-710 Archiving takes place before the Historical Text Reports are generated. If you are updating
your firmware to version 74, you may need to modify the triggers based on the change in processing
sequence.

A Detailed Daily Report is available only in gas applications. It can be enabled via OMNICOM in
Archive 701 for firmware v23.74.19 and v27.75.10 and higher (but only from the front panel in firm-
ware v23.74.10 to v23.74.18). If the Detailed Daily Report is activated, the Boolean Trigger and
Packets are configured automatically and the user may only configure the Max Records field of
Archives 701-705. All the fields in Archives 706-710 are free for the user to configure.

Settings
The items listed below are descriptions of each setting option within the Archives Options dialog.
Click on a setting for more information.

Boolean Trigger

Enter the Modbus database point number of the Boolean bit which will trigger the archive save
event. This can be any valid "momentary" Boolean point within the database including the result of a
Boolean Statement equation. Use the Database Browser to assist in selecting the trigger.

1025: 1105+1205&1831

Example: The Boolean statement 1025 above is true for 500mS if either meter run 1 OR 2 is active
AND the momentary Hour Start Flag (point 1831) is true. By configuring the 'Archive Boolean Trig-
ger' as 1025, the user can cause the archive record to be saved every hour on the hour assuming
either meter 1 or 2 is flowing.

NOTE: You should only specify "momentary" Boolean points as archive triggers - preferably those
that are high only for 500mS. Momentary Boolean points reset themselves after a short time. Do not
use Boolean points that do not reset themselves (i.e., 1501 - 1649 for example). Because the archiv-
ing takes place on the high level (not the edge trigger), if you specify non-momentary triggers, the

433
OMNICOM: Archives

archiving will not work reliably and you may even have data being archived at times when you do not
desire the data to be archived. In the above example, statement 1025 is allowed because although
1105 and 1205 are not momentaries, 1831 is a momentary flag that will cause statement 1025 to be
high for only 500mS.

Max Records

Enter the maximum number of records that can be stored in this archive file before old data is over-
written by new data. The flow computer will not allow the archiving process to start if more records
are specified than will fit in available flow computer memory. The user should check the 'Archive
RAM Status' display of the flow computer by pressing 'Status' 'Setup' 'Enter' or 'Setup' 'Status'
'Enter'.

Data in this field cannot be changed unless archiving within the flow computer is stopped and the
archiving configuration is enabled. (See Archive Maintenance in the Operate Menu).

Packets

The packet describes a set of data points to be grouped together as one retrievable record.

Enter the starting data base point number (address) of the group and the number of consecutive
points to read. Use the Database Browser to assist in selecting points. All of the points in the packet
must be available for the application and of the same type.

For Example: 7105 for '# of points' 2 would cause meter run 1 temperature (7105) and pressure
(7106) to be placed in the record.

Import/Export Archive Configurations


Archive Configuration files can be imported or exported if the Advanced User command line switch
"-AU" is enabled. If you need help adding a command line switch, please speak with your IT rep-
resentative.

After the command line switch is enabled, access the import/export feature by right-clicking on the
tree item or selecting via the File Menu. Files are defaulted to the extension: "*.oXXarNNN" where
XX is the application (20, 24...), and NNN is 701-710 however the user may enter any extension.

Note: Archive Configuration files may not be imported when Archive configuration is disabled.

434
OMNICOM: Checksum Lists

Checksum Lists

The Checksum Lists are available with firmware versions 20.75.10, 22.75.10, 23.75.10, 24.75.10,
26.75.10, and 27.75.10 and higher.

There are four checksum lists. Enter up to 100 configuration registers for each list. Use the Data-
base Browser to assist in selecting points.

The flow computer makes a checksum based on the values of the configured registers in the list. The
checksums allow the user to determine if certain configuration registers have changed values.

The flow computer ignores real time variables.

Modbus Registers
2614 - Configuration List 1 - checksum change alarm flag
2615 - Configuration List 2 - checksum change alarm flag
2616 - Configuration List 3 - checksum change alarm flag
2617 - Configuration List 4 - checksum change alarm flag
2618 - Configuration Lists - Total checksum change alarm flag

2729 - Configuration List - checksum change acknowledge command

4641 - Configuration List 1 - checksum


4642 - Configuration List 2 - checksum
4643 - Configuration List 3 - checksum
4644 - Configuration List 4 - checksum
4645 - Configuration List - Total checksum

435
OMNICOM: Audit

Audit

Audit Configuration is available with firmware versions XX.75.10 and higher.

Click on a link to learn more about a topic.

Variable Statements

The auditing of configuration changes made by the Variable Statements can be set as on or off. The
default is auditing on.

If the auditing is on, the FC records changes to the configuration made by the Variable Statements
as the statements are executed. The audit log will record the change as made by 'Program State-
ment'.

GC Components (available for gas applications only)

Auditing the changes in the GC components can be configured as:


Audit OFF
Audit both live and override GC components (default)
Audit override GC components
Audit live GC components

436
OMNICOM: Allen-Bradley PLC

Allen-Bradley PLC
An Allen-Bradley PLC can only be configured on Serial Port 4 after you have selected Allen-Bradley
in the Equipment Flags in the General Setup. Based upon your selections, OMNICOM makes avail-
able only those options that apply to your metering system configuration.

Topics
The items listed below are links to topics within the Allen-Bradley category. Click on a link to go to
that topic.

Read Blocks 1-3


Command Blocks
Setpoint Blocks

Import/Export Allen-Bradley Configurations


Allen-Bradley Configuration files can be imported or exported if the Advanced User command line
switch "-AU" is enabled. If you need help adding a command line switch, please speak with your IT
representative.

After the command line switch is enabled, access the import/export feature by right-clicking on the
tree item or selecting via the File Menu. Files are defaulted to the extension: "*.oXXab" where XX is
the application (20, 24...) however the user may enter any extension.

If a file is imported while online, the program automatically asks the user if they want to transmit all
the Allen-Bradley blocks to the OMNI.
If the user responds "Yes", all the blocks are written to the unit.
If the user responds with "No" they will still have the option to select "Transmit All" from the menu at a
later time - or - Apply the page they are on, but any page navigated to will be refreshed with the data
from the OMNI.

437
OMNICOM: Read Blocks 1-3

Read Blocks 1-3


Three translation tables used to define data that will be included in unprotected block reads by a
Allen-Bradley PLC-2. Any type of data in the data base can be included in the translation tables
except that boolean data must be sets of 16 points. Once you enter the information and/or make your
selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Read Blocks dialog. Click on
a setting for more information.

Start Address

Enter the logical address of the beginning of this block of data in decimal (not octal). This is the
where the Allen-Bradley thinks the data is within the OMNI flow computer.

Point Number

Enter the index number of the first variable in this group of points. Any data type can be spe-
cified but the OMNI has certain variables shown below that are stored in a format which is usu-
ally more readily accepted by a PLC. Use the Database Browser to assist in selecting points.

Index# Variable Stored Format


3n40 = Net Flow Rate Integer 0-999 = 0-99.9%
3n41 = Net BBL Accumulator Integer 0-65535
3n42 = Gross Flow Rate Integer 0-999 = 0-99.9%
3n43 = Gross BBL Accumulator Integer 0-65535
3n44 = Mass Flow Rate Integer 0-999 = 0-99.9%
3n45 = Mass Accumulator Integer 0-65535 (100LB increments)
3n46 = Meter Pressure Integer 0-999 = 0-99.9%
3n47 = Meter Temperature Integer 0-999 = 0-99.9%
3n48 = Flowing Gravity Integer 0-999 = 0-99.9%
(substitute meter run number for 'n')

Index# Variable Stored Format


3802 = Station Net Flow Rate Integer 0-999 = 0-99.9%
3803 = Station BBL Accumulator Integer 0-65535
3804 = Station Gross Flow Rate Integer 0-999 = 0-99.9%
3805 = Station Gross BBL Acc. Integer 0-65535

438
OMNICOM: Read Blocks 1-3

3806 = Station Mass Flow Rate Integer 0-999 = 0-99.9%


3807 = Station Mass Accumulator Integer 0-65535
3808 = Station Pressure Integer 0-999 = 0-99.9%
3809 = Station Temperature Integer 0-999 = 0-99.9%
3810 = Station Flowing Gravity Integer 0-999 = 0-99.9%
3903 = Prover Right Pressure Integer 0-999 = 0-99.9%
3904 = Prover Right Temperature Integer 0-999 = 0-99.9%
3905 = Prover Left Pressure Integer 0-999 = 0-99.9%
3906 = Prover Left Temperature Integer 0-999 = 0-99.9%
3907 = Prover Counts  Integer 0-65535

Point Count

Enter the number of data points to be included in this group. When the data is boolean status
you must specify in increments of 16 to ensure the data is sent in word format. Unused bit pos-
itions will be set to zero in cases where the OMNI does not have valid data.

439
OMNICOM: Command Block

Command Block
The Allen-Bradley PLC-2 sends digital commands to the OMNI by executing an unprotected block
write. This translation table is used to define the bit content of this write block. Only boolean type data
may be specified. Once you enter the information and/or make your selections, press the [Apply]
button to set.

Settings
The items listed below are descriptions of each setting option within the Command Blocks dialog.
Click on a setting for more information.

Start Address

Enter the logical address of the start of the command block in decimal. This is where the Allen-
Bradley thinks the command block is within the OMNI.

Point Number

Boolean command points within the OMNI are located at data base index numbers starting at
1701. Enter the starting index number for the first boolean command for this group. Use the
Database Browser to assist in selecting points.

Point Count

Enter the number of contiguous data points that are to be included. NOTE: The total number
of data points within the block must be an exact multiple of 16.

440
OMNICOM: Setpoint Block

Setpoint Block
The Allen-Bradley sends analog variables to the OMNI by executing a PLC-2 unprotected block
write. This translation table is used to specify the data content on this block. Any data type of data
except boolean data can be specified. Once you enter the information and/or make your selections,
press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Setpoint Block dialog. Click
on a setting for more information.

Start Address

Enter the logical address of the setpoint data block in decimal. This is where the Allen-Bradley
thinks it is writing the data to within the OMNI.

Point Number

Enter the data base index point for the first variable in this group Any data type can be spe-
cified. Use the Database Browser to assist in selecting points.

Point Count

Enter the number of contiguous points within this group. Contiguous boolean data must be
specified in groups of 16.

441
OMNICOM: Local Printer

Local Printer
A printer can only be configured on Serial Port 1. Once you enter the information and/or make your
selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the printer dialog. Click on a set-
ting for more information.

Printer Type

Printer Type: Select the type of printer connected to the OMNI. If you select something other
than "Custom", a default condensed and normal mode string for that printer type will be dis-
played.

Printer Condensed/ Normal Mode String: These entries are meaningful only when using
the default report templates stored in EPROM. Some of these reports are more than 80 char-
acters wide under certain circumstances (four meter runs + station). The flow computer will
automatically send an ASCII escape string to switch the printer to condensed character mode
(16+ characters per inch for an Okidata) or to normal (10 characters per inch for an Okidata).
Enter the data as hexadecimal characters (groups of two characters, enter '0F' not just 'F')
with up to 5 sets of characters.

Printers Condensed Mode String Normal Mode String


Epson, IBM, Panasonic 0F 12
OKI DATA 1D 1E
HP Laser Jet 1B266B3253 1B266B3053

Port Options

Print Priority: Enter 0 when the computer is connected to a dedicated printer. If several com-
puters are sharing a common printer, one computer must be designated as the master and
must be assigned the number 1. The remaining computers must each be assigned a different
Print Priority number between 2 and 12.

Number of NULLs: For slow printers without an input buffer a number of nulls can be sent
after each carriage return or line feed. A number between 0-255 will be accepted. Set this to 0
if your printer supports hardware handshaking and you have connected pin 20 of the printer
connector to terminal 6 of the flow computer (See 'Serial Devices' Chapter 3).

442
OMNICOM: Report Setup

Report Setup
Automatic printed reports on a timed interval can be specified. Once you enter the information and/or
make your selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Report Setup dialog. Click
on a setting for more information.

Daily Report Time

The beginning of the contract day at which hour a daily report will print in HH:MM format (eg. 07:00).

If you would like the report to be printed at midnight, you may enter a time of 00:00 or 24:00 (see spe-
cific examples below): (Note: 24:00 time entry is available for version 20.74.22, 22.74.06, 23.74.20,
24.74.18, 26.74.10, 27.74.20 and higher).

Example 1:
Entering a time of 00:00 instructs the OMNI to print a time of 00:00:00 on the Daily Report or
Auto Batch End Report (if Weekly or Monthly Auto-Batching enabled) and a date reflecting
the new day's date. Using the end of day on 31 July 2006 as an example, the OMNI will print a
daily report showing a time of 00:00:00 and a date of 01 August 2006.

Example 2:
Entering a time of 24:00 instructs the OMNI to print a time of 24:00:00 on the Daily Report or
Auto Batch End Report (if Weekly or Monthly Auto-Batching enabled) and a date reflecting
the previous day's date. Using the end of day on 31 July 2006 as an example, the OMNI will
print a daily report showing a time of 24:00:00 and a date of 31 July 2006.

Disable Daily Report Printing

The Daily Report printing may be disabled by checking this box. The report is still generated and
saved in the historical buffers (last eight) and archived (if archive is setup) regardless of this setting.

Detailed Daily Report Active (available with firmware versions 23.74.10 and
27.75.10 and higher)

A Detailed Daily Report is available only in gas applications v23.74.10 and 27.75.10 and higher:

If online, and the detailed daily report is activated, it is shown in red on the Report Setup
screen.

To activate the Detailed Daily Report, go to the Archives section and enable it in Archive 701.

Use Default Template

443
OMNICOM: Report Setup

There are two types of report templates: Default and Custom:

Default Report Templates

There are five default report templates, which are the Snapshot, Batch End, Daily
Report, Prove Report, and Monthly (available with 20.75.10 and higher) templates.

Default Report Templates are built into the OMNI 3000/6000 EPROMs. You cannot
view or modify default report templates, you can only turn them on or off in the
OMNICOM configuration by selecting or deselecting the Use Default Template check-
box or answering 'Y' or 'N' from the front panel of the flow computer.

Custom Report Templates

If you wish to create a custom report, you must send custom report templates to the
flow computer. When OMNICOM is installed, 'sample' custom report templates are
installed to your PC as part of the OMNICOM install process.

From the OMNICOM Report Template Editor, you can use the File/Import feature to
import the sample templates into the OMNICOM file and use them exactly as provided
or modify them to your liking before sending them to the OMNI flow computer.

Checking the Use Default Template box instructs the flow computer to use the default report
templates stored in EPROM for generating all four reports (Snapshot, Batch End, Daily, and
Prover reports). The newer firmware supports a separate checkbox for each individual
report. Check the box if you wish to use the default report template for that specific report.
(Available with 20.74.14, 21.74.00, 22.74.06, 23.74.17, 24.74.14, 26.74.10, and 27.74.15 and
higher.)

Remove the check if you have uploaded your own custom report templates using OMNICOM.

If the box(es) is(are) not checked and you do not provide the OMNI with Custom Report Tem-
plates, the OMNI will not be able to generate reports.

If you want to use the Custom Report Text Archiving feature, you must use Custom Report
Templates and specify either the 1000 or 2000 Conditional Archive Boolean in the custom tem-
plate .

Note: there are new sample custom Daily templates for firmware versions 20.74.30, 22.74.30,
23.74.30, 24.74.30, 26.74.30, and 27.74.30 and higher. There are new sample custom Batch tem-
plates for firmware versions 23.74.30 and 27.74.30 and higher.

Print Interval

Print Interval In Minutes: Enter the number of minutes between each interval report. Enter-
ing 0 will disable interval reports. The maximum allowed is 1440 minutes which will provide
one interval report each 24 hour period.

444
OMNICOM: Report Setup

Print Interval Start Time: Enter the start time from which the interval report timer is based
(eg. Entering 01:00 with a print interval of 120 minutes will provide an interval report every odd
hour only).

Monthly Report Day Number (available for 20.75.10 and higher)

Enter the day of the month that the Monthly Report should be generated. The time of the report gen-
eration is the same as the Daily Report time.

The range of the day number is 0 to 31. If the day number is zero, a monthly report will not be gen-
erated. The default is zero.

Checked/Proved For String (available with firmware v22.74.00 and v26.74.00 and
higher)

Enter text for "Checked/Proved For" string using up to 16 alphanumeric characters.

This text is used on the default Prove Report (PROVED FOR string) and the default Batch
Report (CHECKED FOR string).

Prove Report

                             PROVING REPORT
                       OMNI Flow Computers, Inc.
                             REPORT NUMBER 1
(X) OFFICIAL ( ) UNOFFICIAL (  )
  ABORTED
LOCATION: Sugar Land, TX 77478 DATE/TIME:
05/09/08 10:09
METER MANUFACTURER: Dresser PROVER MANUFACTURER: Dresser
METER MODEL: LMMA PROVER SERIAL NUMBER: 85730
METER SERIAL NUMBER:B PROVER BASE VOLUME(bbl):
2.00000
METER SIZE(in): 4 Inch PROVER OUTSIDE DIAMETER(in):
13.000
NOM. K FACTOR 50.000 PROVER WALL THICKNESS(in): .875
METER TAG NUMBER: Left PROVER MATERIAL: stainless
steel
                                     COEF. OF CUBICAL EXP(1/F):
.0000124
                                     MODULUS OF ELASTICITY(psi):
30000000
Liquid: Prod 1 OBSERVED DENSITY .0 deg API AT 74.9F= 32.6 deg
API AT 60F
=====================================================================-
=========
TRIAL PULSES TOTAL PRESS(psig) TEMP(degF) TRIAL M.F.
        L-R R-L TOTAL TIME(s) PROVER METER PROVER METER MFt
 1 48 50 98 20.5 99.5 104.4 73.0 74.9 1.0222
 2 50 48 98 20.5 99.5 104.4 73.0 74.9 1.0222

445
OMNICOM: Report Setup

 3 50 50 100 21.0 99.5 104.4 73.0 74.9 1.0017


=====================================================================-
=========
AVG OF LAST 3 TRIALS 98.7 20.7 99.5 104.4 73.0 74.9
1.0154
REPEATABILITY FOR LAST 3 TRIALS = 2.02%
A. BASE PROVER VOLUME AT 60 degF & 14.696 psia (BPV) 2.0000
bbl
B. TEMP. CORRECTION FACTOR FOR STEEL OF PROVER (CTSp) 1.0009
C. PRESS. CORRECTION FACTOR FOR STEEL OF PROVER (CPSp) 1.0000
D. TEMP. CORRECTION FACTOR FOR LIQUID IN PROVER (CTLp) .9943
E. PRESS. CORRECTION FACTOR FOR LIQUID IN PROVER (CPLp) 1.0005
F. COMBINED CORRECTION FACTOR FOR PROVER (CCFp) .9957
G. GROSS STANDARD VOLUME FOR PROVER (GSVp) 1.9914
bbl
H. INDICATED METER VOLUME (IVm) 1.9740
bbl
I. TEMP.CORRECTION FACTOR FOR LIQUID IN METER (CTLm) .9935
J. PRESS. COR.FACTOR FOR LIQUID IN METER (CPLm) 1.0005
K. COMBINED CORRECTION FACTOR FOR METER (CCFm) .9940
L. GROSS STANDARD VOLUME FOR METER (GSVm) 1.9622
bbl
M. AVG.METER FLOW RATE
348.7 bbl/h
N. METER FACTOR @ PROVING FLOW RATE
1.0149
O. METER FACTOR @ NORMAL METER FLOW RATE OF 1000.0bbl/h 1.0149
   DEVIATION FOR TEST NO./(%): 1)/ 1.48 2)/ .00
   HISTORICAL DATA OF METER FACTORS @ NORMAL METER FLOW RATE OF @
1000.0 bbL/h
   INITIAL BASE METER FACTOR (DATE: 11/29/05) = 1.0001
DATE:
FACTOR: .0000 .0000 .0000 .0000 .0000
DEVIATION(+/-): .00% .00% .00% .00% .00%
DATE:
FACTOR: .0000 .0000 .0000 .0000 .0000
DEVIATION(+/-): .00% .00% .00% .00% .00%
PROVED FOR My Oil Company BY:_____________________________DATE: _____
_______
WITNESSED BY: _____________________________________ COMPANY: ________
____________

Batch Report
                              METER TICKET
                       OMNI Flow Computers, Inc.
(My Oil Company )
(  
)
  DELIVERY OR ( ) RECEIPT TICKET 1- 0
(  
)
  OFFICIAL ( ) UNOFFICIAL
LOCATION: Sugar Land, TX 77478 PRINT
DATE/TIME:05/09/08/10:07

446
OMNICOM: Report Setup

DELIVERED TO/RECEIVED FROM:


METER MANUFACTURER: METER SIZE(in):
4 Inch
METER MODEL: Turbine NOMINAL K FACTOR: 49.000
METER SERIAL NUMBER: 4321-ABC METER TAG NUMBER:
Right
1. BATCH NUMBER
2. TYPE OF LIQUID Prod 1
3. METER CLOSING READING (DATE/TIME) 05/09/08/10:07
4. METER OPENING READING (DATE/TIME) 05/09/08/08:36
5. NET DELIVERY/RECEIPT TIME 1.471 hours
6. METER CLOSING READING 529 bbl
7. METER OPENING READING 0 bbl
8. INDICATED VOLUME 529 bbl
9. AVERAGE FLOW RATE 359.4 bbl/h
10. GROSS VOLUME 529 bbl
11. AVERAGE METER FACTOR .9991
12. OBSERVED DENSITY .0 deg API
(M)
13. OBSERVED TEMPERATURE 75.0 F(M)
14. DENSITY AT 60 F 32.6 deg API
15. WEIGHTED AVERAGE TEMPERATURE 75.0 F
16. TEMPERATURE CORRECTION FACTOR (CTLm) .9934
17. WEIGHTED AVERAGE PRESSURE 105.2 psig
18. PRESSURE CORRECTION FACTOR (CPLm) 1.0005
19. COMBINED CORRECTION FACTOR (CCFm) .9939
20. NET STD VOL AT 60 F & 14.696 psia (0 psig) 526 bbls
21. NET STD VOL AT 15 C & 101.325 kPa (0 kPa(ga)) 83.6 m3
22. NET WEIGHT 71 long
tons
23. NET WEIGHT 72 metric
tons
NON-NEGOTIABLE, NON-TRANSFERABLE
OMNI Flow Computers, Inc.
CHECKED FOR My Oil Company
BY: _____________________________________________ DATE: ___________
_________
WITNESSED BY:
BY: _____________________________________________ COMPANY: ________
_________

447
OMNICOM: Batch

Batch
Six batch setups per meter run can be programmed with alphanumeric batch ID tag, product num-
ber to run and expected size of batch. Individual meter run batch preset down counters provide
'batch end warning' and 'batch end reached' alarms. Batches can be ended manually or auto-
matically on size of batch, change of product, beginning of new day, day of the week or day of the
month. Product interface detection is achieved using a station interface detector densitometer moun-
ted ahead of the meter runs. Line pack count down counters allow up to three product interfaces to
be tracked between the interface detector gravitometer and the valve manifold allowing preemptive
product cuts. Based upon your selections, OMNICOM makes available only those options that
apply to your metering system configuration.

Topics
The items listed below are links to topics within the Batch category. Click on a link to go to that topic.

Batch Setup
Batch Scheduling

448
OMNICOM: Batch Setup

Batch Setup
The flow computer can be programmed with batch setup information. The batch information is
stored in the batch stack - see Operate | Control | Batch - Batch Stack.

The batch stack may be configured as a Common Batch Stack meaning the flowmeters are all run-
ning the same product and the totals and flows are combined and treated as a station. This provides
up to 24 individual batches that may be programmed into the OMNI flow computer . For liquid applic-
ations using a Common Batch Stack, the Station is used in the Operate section to enter the products
to the batch stack and for ending the batch. For this reason, a Station must be configured in the Sta-
tion Setup screen in the "Station Totals and Flows" field. Note that for applications with just one
meter run you must enter '1' or '1+1-1' in that field in order to end batches for the station. If a Batch
Preset Warning value is required, enter it in the Station Setup.

The batch stack may also be split into 4 Independent Batch Stacks in the OMNI flow computer,
each stack representing a meter run. This configuration allows six batches to be programmed into
the flow computer for each meter run. Independent batch stacks are useful when running different
products on each meter run. If a Batch Preset Warning value is required, enter it in the Meter Setup.

NOTE: The number of entries allowed in the Batch Stack should not be confused with the number of
previous batches available for recalculation. Refer to the OMNI Technical Bulletin on “Recalculating
a Previous Batch within the Flow Computer” for details of the previous batch recalculation feature.

The flow computer uses the batch setup data for the batch last completed if the meter's batch stack
is empty at the beginning of a new next batch.

Once you enter the information and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Batch Setup dialog. Click on
a setting for more information.

Batch Preset Units

Select gross (IV), net (GSV) or mass units to use for all the batch preset counters within the
flow computer.

Batch Stack

Use Common Batch Stack: Check the box if you will be running the same product at the
same time on all meter runs. In this case, the flowmeter's totals and flows are combined and
treated as a station. This provides up to 24 individual batches that may be programmed into

449
OMNICOM: Batch Setup

the OMNI flow computer . For liquid applications using a Common Batch Stack, the Station is
used in the Operate section to enter the products to the batch stack and for ending the batch.
For this reason, a Station must be configured in the Station Setup screen in the "Station Totals
and Flows" field. Note that for applications with just one meter run you must enter "1+1-1" in
that field in order to end batches for the station. If a Batch Preset Warning value is required,
enter it in the Station Setup.

Uncheck the box if each meter run will be running different products at the same time. The
batch stack will be split into 4 Independent Batch Stacks, each stack representing a meter
run. This configuration allows six batches to be programmed into the flow computer for each
meter run. If a Batch Preset Warning value is required, enter it in the Meter Setup for each
meter.

The flow computer allows you to define multiple meter runs as part of a station even when you
do not have Common Batch Stack enabled. This is allowed for the purpose of using the sta-
tion batch end command 1702 or 2755, either via Modbus write or user programmable custom
Boolean/Variable statements, if there is a need to simultaneously end all the independent
batches of the meter runs configured in the station definition. The batch end commands for the
individual meter runs (1703 – 1706 or 2751 – 2754), can still be used to end an individual
meter run batch without ending the batches on the other meter runs.

Batch Start (available with firmware versions 20.74.30, 22.74.30, 23.74.30,


24.74.30, 26.74.30, and 27.74.30)

Check the box to make the batch start time/date equal to the previous batch end time/date. In
instances where no flow takes place during that time period, the totalizers and averages will
indicate 0.0. If the meter becomes active during that time period, the batch start time/date is
updated to the time/date the meter became active.

Uncheck the box to capture the batch start time/date based on the meter becoming active.

Net Weight Calculation Method(available with firmware versions 22.75.00 and


higher)

The long ton and metric ton net weight values appearing on the Batch report can be calculated
in the following ways:

Determine Long Tons then Metric Tons using Table 11: The flow computer con-
verts the NSV at 60 degF to long tons using a calculation which emulates ASTM D1250
(1952) Table 11. Metric tons are then calculated using a conversion factor.
Long Tons = NSV x [0.0375 x ((589.9438 / (API + 131.5)) - 0.0050789)]
Metric Tons = Long Tons x 1.01605

Determine Metric Tons then Long Tons using Table 13:The flow computer con-
verts the NSV at 60 degF to metric tons using lookup table ASTM D1250 (1952) Table

450
OMNICOM: Batch Setup

13 (valid for API at 60 degF from 12 to 100). Long tons are then calculated using a con-
version factor.
Metric Tons = NSV x Table 13 value
Long Tons = Metric Tons x 0.98421

Determine Long Tons then Metric Tons using Table 29 (available with firmware
versions 22.75.04 and higher): The flow computer converts the NSV at 60 degF to long
tons using a calculation using ASTM D1250 (1952) Table 29. Metric tons are then cal-
culated using a conversion factor.
Long Tons = NSV x ASTM D1250 (1952) Table 29 Conversion Factor
Metric Tons = Long Tons x 1.01605

The flow computer uses the low limit SG60 to calculate the Table 29 conversion factor if
the SG60 is less than 0.5.
It uses the high limit SG60 to calculate the Table 29 conversion factor if the SG60 is
greater than 1.1.

There is no low/high alarm if the SG60 is out of range. The flow computer uses the
batch flow weighted average specific gravity at 60 degF (rounded to 4 decimal places).

451
OMNICOM: Batch Scheduling

Batch Scheduling
Batch reports can be requested for hourly, day of the week, and day of the month intervals.

The Batch Scheduling feature is completely independent of the meter runs defined in the Station
Totals and Flows setting in the Setup tab of the Station/Configuration and Setup menu and also com-
pletely independent of the Common Batch Stack setting in the Batch Setup tab of the Batch menu.

The Batch Scheduling feature will end the batch for “all meter runs configured” in the flow computer
on an hourly, weekly, or monthly basis, depending on your selection(s) as described below. The
flow computer will end the batches regardless of whether the meter runs are defined or not defined
as part of the Station Totals and Flows.

Once you enter the information and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are descriptions of each setting option within the Batch Scheduling dialog.
Click on a setting for more information.

Auto Batch End Select

Automatic Hourly Batch Select: Select the checkbox to automatically cause a batch
end every hour on the hour.

If default report templates are selected (see Report Setup “Use Default Batch Report Tem-
plate” entry), a batch end is executed but no batch end report will be generated nor printed
and therefore a report will not be included as part of the last 8 historical batch reports.

If customized instead of default batch report templates are selected, a batch end report will be
generated and archived as part of the last 8 historical batch reports. Whether or not the
report is printed will depend on whether or not your custom batch report template allows it
(i.e., using the 1000 conditional Boolean will allow archiving only but no printing, whereas
using the 2000 conditional Boolean in the report template will allow it to be archived and prin-
ted).

Weekly: Select the day of the week that you wish to have an automatic batch end
report in addition to the daily report. The batch report will be generated at the same
time as the Daily Report.

Note: The OMNI flow computer recognizes a contract day time of 00:00:00 to be the end of
the previous contract day as well as the beginning of a new contract day. In addition, the
OMNI recognizes this as the start of a new “calendar” day. (See also the Daily Report Time
field of the Report Setup for 24:00 time setup.)

 If you would like a batch end report to be automatically generated at “calendar day end” of a
specific day of the week (meaning you have 00:00:00 entered for the contract day time), select

452
OMNICOM: Batch Scheduling

the next calendar day of the week for this setting. Example: If you have the flow computer con-
figured for a contract time of midnight (00:00:00) and you wish to generate a weekly batch end
report at the end of the day or midnight on Sunday (same as beginning of Monday), specify
Monday as the day you would like to end the batch instead of specifying Sunday. If you spe-
cify Sunday, the batch end will occur at the end of Saturday (same as beginning of Sunday),
which will be 24 hours earlier than intended.

If your contract time is set to a time other than 00:00:00 (e.g., 07:00:00), then you would spe-
cify in the setting the exact day of the week you wish to end the batch instead of specifying the
next day.

Monthly: Valid entries are 1 through 31 to automatically generate a batch end report in
addition to a daily report on a specific day of the month (0 = No batch end).

 Note: If you would like a batch end report to be generated on the last day of the month, every
month, you should specify the 1st day of the month in the setting. Example: If you have the
flow computer configured for a contract time of midnight (00:00:00) and you wish to generate
a monthly batch end report, specify 1 as the day you would like to end the batch instead of spe-
cifying 29, or 30, or 31 as some months do not have this many days and therefore a monthly
batch end may not always occur. If you specify 31 and there are in fact 31 days in the month,
the batch end will occur at the end of day 30 which is the same as the beginning of day 31,
which will be 24 hours earlier than intended. Therefore, specify 1 so that the batch end will
occur at the end of the last day of “any” month which is also the first day of the next month.
(See also the Daily Report Time field of the Report Setup for 24:00 time setup.)

 If your contract time is set to a time other than 00:00:00 for midnight (e.g., 07:00:00), then you
would still specify in the setting the first day of the month since the flow for each “contract”
month always begins 7 hours into the calendar month and therefore should end 7 hours into
the next calendar month.

Clear Daily Total at Batch End

Do not check the box if you wish the flow computer to provide 24 Hour totals of all flow through
the flowmeter regardless of what product is run through the daily period.

Check the box if you would like the daily totalizers to be cleared at the end of each batch. This
would mean that the daily totalizers would not necessarily represent 24 hours of flow but
would represent the amount of flow since the last batch end, or the last daily report.

Note: This setting only applies to manual and hourly batch ends because the weekly and
monthly batches end at daily contract time where the daily totals are always cleared.

Disable Stack Shift on Scheduled Auto Batch End (Available with firmware ver-
sions 20.74.22, 22.74.06, 24.74.18, and 26.74.10 and higher)

By default, a batch stack shift occurs after a batch end that happened as a result of a sched-
uled automatic batch end or via a product strobe.

453
OMNICOM: Batch Scheduling

If you would like the OMNI to begin a new batch which will measure the same product as the
automatic batch that just ended, select the checkbox so that a batch stack shift operation does
not occur when the batch is ended automatically or via a product strobe.

To use the front panel to end a meter run batch, press "PROG BATCH METER 'n' ENTER". If
a station is configured and you wish to end a station batch, press "PROG BATCH ENTER".

Starting with some checksums of firmware versions 20.75.10, 22.75.10, 24.75.10, and
26.75.10, the following selections will appear on the front panel to allow the option to
shift or not shift the stack:

End Batch-Shift?

End Batch-No Shift?

For prior firmware versions, the front panel displays "Print & Reset?" and will use the
"Disable Stack Shift on Scheduled Auto Batch End" setting to determine whether to
shift or not shift the stack.

If using Modbus command points or programmable statements which use the command
points to end the batch, the OMNI provides separate command registers to shift or not shift the
stack:

Batch End - Stack Shift Operation


1702 = End Station Batch
1703 = End Meter 1 Batch
1704 = End Meter 2 Batch
1705 = End Meter 3 Batch
1706 = End Meter 4 Batch

Batch End - No Stack Shift Operation


2751 = End Meter 1 Batch
2752 = End Meter 2 Batch
2753 = End Meter 3 Batch
2754 = End Meter 4 Batch
2755 = End Station Batch

Does this setting


Batch End Operation affect the oper- Firmware Version
ation?
Scheduled Automatic 20.74.22, 22.74.06, 24.74.18, and
Yes
Batch End 26.74.10
20.74.22, 22.74.06, 24.74.18, and
Yes
26.74.10
Front Panel Starting with some checksums of
No 20.75.10, 22.75.10, 24.75.10, and
26.75.10

454
OMNICOM: Batch Scheduling

Modbus Command and


Programmable State- 20.74.22, 22.74.06, 24.74.18, and
No
ments using Modbus 26.74.10
Command
20.74.22, 22.74.06, 24.74.18, and
Product Strobe Yes
26.74.10

Automatic Day End on Batch End (Available with firmware versions 20.75.10,
22.75.10, 24.75.10, 26.75.10 and higher)

By default, the day ends at the contract time.

If you would like the OMNI to begin a new day on each batch end, check the 'Automatic Day End on
Batch End' box.

Note: The time and date printed on the auto-batch end reports can vary depending on how the Daily
Report Time is configured in the Report Setup screen.

Note: If you do not wish the OMNI to end the batches on “all the meter runs configured” in the flow
computer but to end the batches only on the meter runs defined as part of the Station, do not use the
Batch Scheduling feature. Instead, write custom Boolean Statements to automatically end the
batches for only the meter runs defined as part of the Station.

Example Boolean statements to execute Hourly, Weekly, and Monthly Station Batch ends with stack
shift for the meter runs defined as part of the station:

Hourly: 1831)1702=1831
Weekly: 1832)1702=1832
Monthly: 1833)1702=1833

If you instead wish to execute batch ends only on an individual meter run, such as Meter 1, which
may or may not be defined as part of the Station Flows and Totals, substitute 1703 (1704, 1705, or
1706 for Meter 2, 3, and 4 respectively) for 1702 in the above statements.

455
OMNICOM: Peer to Peer

Peer to Peer
Using the 'peer to peer' configuration allows multiple OMNI flow computers to exchange data. This
is done by using Serial port number 2 of each OMNI as a 'peer to peer' communication link. Other
Modbus slaves such as PLC devices can also be polled by multiple OMNI computers. These dialogs
are accessed from the OMNICOM navigation tree.

Note: In OMNI flow computers acting as a Peer to Peer master and using firmware version 75.10
and higher, the flow computer automatically disregards any security settings on the Peer to Peer
serial port. If a slave OMNI flow computer’s serial port is connected to a Peer to Peer master OMNI
flow computer’s serial port and the slave has firmware version 75.10 and higher, ensure the security
is not configured on the slave flow computer serial port so that communications will be possible.

Topics
The items listed below are links to topics covering Peer to Peer communications. Click on a link to go
to that topic.

Peer to Peer Setup


Transaction Group

456
OMNICOM: Peer to Peer Setup

Peer to Peer Setup


Serial port number 2 of each OMNI can be configured to act as a simple Modbus slave port or as a
'peer to peer' communication link. Using the 'peer to peer' configuration allows multiple OMNI flow
computers to exchange data. Other Modbus slaves such as PLC devices can also be polled by mul-
tiple OMNI computers. Once you enter the information and/or make your selections, press the
[Apply] button to set.

Note: In OMNI flow computers acting as a Peer to Peer master and using firmware version 75.10
and higher, the flow computer automatically disregards any security settings on the Peer to Peer
serial port. If a slave OMNI flow computer’s serial port is connected to a Peer to Peer master OMNI
flow computer’s serial port and the slave has firmware version 75.10 and higher, ensure the security
is not configured on the slave flow computer serial port so that communications will be possible.

Settings
The items listed below are the settings covering each dialog within the Peer to Peer Setup. Click on
the setting for more information.

Redundancy Mode

In critical applications where failure of a flow computer cannot be tolerated flow computers
can be made to operate in pairs. Each flow computer receives the same process signals and
performs the same calculations.

Activate - Checking this box allows both flow computers to manage the peer to peer
link between them and automatically switch between being master or slave computer.
Important data such as meter factors and PID control settings are continually
exchanged between the flow computers ensuring that at any time should a failure
occur, the other unit would be able to assume control of the PID functions and ticketing
functions. Note: The redundancy mode requires that four digital I/O ports be cross con-
nected to sense watchdog failure modes (contact OMNI for assistance).

Use this OMNI as the Default Master - (only available when Activate is checked for
firmware versions 20.74.30, 22.74.30, 23.74.30, 24.74.30, 26.74.30, and 27.74.24 and
higher) - check this box if you would like this OMNI to be the master on power up. This is
to prevent contention when two OMNI's are trying to be the master on power up.

Sequencing

Next Master in Sequence: Enter 0 to disable the peer to peer feature and use serial
port #2 as a standard Modbus slave port. Enter the Modbus ID of the 'peer' (OMNI com-
puter) to pass control of the communication link to. Enter the Modbus ID of this OMNI if
there are no other peers on the communication link. For maximum efficiency always
start Modbus ID definitions from 1.

457
OMNICOM: Peer to Peer Setup

Last Master in Sequence: Enter the highest Modbus ID number of a device on the com-
munication link. Each master attempts to hand over control of the peer to peer link to the
'next master in sequence' (see previous entry). If that master does not take control of
the link, after several retries the current master will try to establish communications with
any device with a Modbus ID up to or equal to this entry. Enter the Modbus ID of this
OMNI if it is the only master on the link.

Retry Timer

Should any slave device fail to respond to a communication request the master device will
retry to establish communications several times. Enter the number of 50ms ticks to wait
between communication retries. To ensure fast recovery from communication failures set this
to as low a number as possible. Use 3 for peer to peer links involving only OMNI flow com-
puters. Other Modbus devices may need more time to respond.

458
OMNICOM: Transaction Group

Transaction Group
A Transaction Group is the method in which OMNI using the 'peer to peer' configuration allows mul-
tiple OMNI flow computers to exchange data. Each Transaction group has a maximum of four trans-
actions for a total of 16 transactions.

Note: The OMNI continues to process all 16 transactions until it comes to a transaction
with a point count of zero. Keep in mind when configuring transactions not to have gaps
in the list because the first transaction with a zero point count terminates the list. Any
remaining transactions which come after a transaction with a zero point count will not be
processed.

Note: In OMNI flow computers acting as a Peer to Peer master and using firmware version 75.10
and higher, the flow computer automatically disregards any security settings on the Peer to Peer
serial port. If a slave OMNI flow computer’s serial port is connected to a Peer to Peer master OMNI
flow computer’s serial port and the slave has firmware version 75.10 and higher, ensure the security
is not configured on the slave flow computer serial port so that communications will be possible.

Once you enter the information and/or make your selections, press the [Apply] button to set.

Settings
The items listed below are the settings covering each dialog within the Transaction Group Setup.
Click on the setting for more information.

Target Slave ID

Enter the Modbus ID number of the slave that this communication transaction will take place with.
Modbus ID '0' can be used to 'broadcast' or write to all Modbus slaves connected to the link (reads
are not supported with broadcasts). Other valid IDs range from 1 to 247.

Points

Source Index: Enter the Modbus index or point number that is used to identify the first data
point in this transaction. This is the slave's index number when the transaction is a 'read', and
the master's index number when the transaction is a write. Refer to the OMNI operational
manual for a list of available index #s.
(Note: when using Modicon protocol you should subtract 1 from the source index when the trans-
action is a 'read'.)

Num of Points: Each transaction can transfer multiple data points which can be any valid
data type recognized by OMNI. The number of points that can be transferred depend on the
type of data:

IEEE floating points (4 bytes each) 62 points max

459
OMNICOM: Transaction Group

32 Bit Long Integers (4 bytes each) 62 points max


16 Bit Short Integers (2 Bytes each) 125 points max
Packed Coils or Status (8 to a Byte) 2000 points max

The OMNI automatically knows what Modbus function to use and what data types are
involved by the Modbus index number of the data within the OMNI data base (The source
index number determines the data type when the transaction is a 'write'. The destination index
number determines the type when the transaction is a 'read'). The number of data bytes in any
transaction's packet size cannot exceed 250 (RTU mode) or 500 (ASCII mode).

(Note: Modicon works with "words" (i.e., 16 bits). When using the Modbus protocol with
Modicon compatibility and floats or 32-bit long integers, each of these two types of registers
count as two points when reading data from or writing data to another OMNI or other Modicon
compatible device. When using Modbus protocol with Modicon compatibility, float bytes are
swapped from ‘aa bb cc dd’ to ‘cc dd aa bb’.

When using the Modbus protocol with Modicon compatibility and ASCII registers are used,
divide the size of the register by 2. i.e. if you are reading the Computer ID, register 4836, it is
an 8 character string so the number of points would be 4. If you are reading the Pro-
grammable Variable 87 Remarks, register 14275, it is a 16 character string so the number of
points would be 8. )

Dest Point: Enter the Modbus index number or data base address where the data trans-
ferred in this transaction will be placed. If the transaction is a read this will be the index number
within the OMNI's data base. If the transaction is a 'write' this will be the index or register num-
ber within the remote slave.
(Note:when using Modicon protocol you should subtract 1 from the destination index when the trans-
action is a 'write'.)

Read/Write

Is this OMNI reading or writing data to the slave device?

Note: The OMNI uses function codes 01 and 03 for Read and function codes 15 and 16 for Write.

460
OMNICOM: Premium Billing

Premium Billing
Threshold Settings

For firmware versions 23.75.11 and higher, the threshold settings can be entered as float val-
ues ranging from zero to 9999999.0. For firmware versions below 23.75.11, the thresholds
are entered as unsigned 32-bit integers ranging from zero to 9999999. The default is zero.

Note: The threshold values should be entered in increasing values from Level 1 to Special
Billing.

Flow which occurs below the Level 1 threshold will be accumulated in the 'Base Level'
totalizer.

Flow occurring between the Level 1 and the Level 2 threshold will accumulate in the
'Level 1' totalizer and the 'Base Level' totalizer.

Flow occurring between the Level 2 and the Level 3 threshold will accumulate in the
'Level 2' totalizer, 'Level 1' totalizer, and the 'Base Level' totalizer.

Flow occurring above the Level 3 threshold will accumulate in the 'Level 3' totalizer,
'Level 2' totalizer, 'Level 1' totalizer, and the 'Base Level' totalizer.

The 'Special Billing' threshold acts just like a fourth premium level when it is set to be
greater in value than the Level 3 threshold, but overrides any other premium threshold
that is set greater than the Special Billing threshold.

Premium totalizers are stored for each meter run and the station for the last 10 days.

Related Modbus Registers: ( 'n' = 1,2,3,4 or 8)

For firmware versions 23.75.11 and higher, the threshold settings are float-point registers. For
firmware versions below 23.75.11, the thresholds registers are unsigned 32-bit integers.

6n01 Meter 'n' Premium Level 1 Threshold (MSCF/hr)


6n02 Meter 'n' Premium Level 2 Threshold (MSCF/hr)
6n03 Meter 'n' Premium Level 3 Threshold (MSCF/hr)
6n04 Meter 'n' Premium Special Billing Threshold (MSCF/hr)

The following registers are unsigned 32-bit integer registers:

6n06 Meter 'n' Cumulative Premium Base Total MSCF (XXXXXXXX.X typical of all)
6n07 Meter 'n' Cumulative Premium Level 1 (MSCF)
6n08 Meter 'n' Cumulative Premium Level 2 (MSCF)
6n09 Meter 'n' Cumulative Premium Level 3 (MSCF)
6n10 Meter 'n' Cumulative Premium Special Billing (MSCF)
6n11 - 6n15 Today's Totalizers (same order as above)

461
OMNICOM: Premium Billing

6n16 - 6n20 Today-1 Totalizers


6n21 - 6n25 Today-2 Totalizers
6n26 - 6n30 Today-3 Totalizers
6n31 - 6n35 Today-4 Totalizers
6n36 - 6n40 Today-5 Totalizers
6n41 - 6n45 Today-6 Totalizers
6n46 - 6n50 Today-7 Totalizers
6n51 - 6n55 Today-8 Totalizers
6n56 - 6n60 Today-9 Totalizers
6n61 - 6n65 Today-10 Totalizers

462
OMNICOM: Blank Page

Blank Page
Folder objects on the tree display a blank property page showing a picture of an OMNI 6000 Flow
Computer.

To view help about a tree folder item, click on the folder and press the 'F1' key while the folder name
is highlighted.

463
OMNICOM: Configuration Print

Configuration Print

Select this tree item while Online to an OMNI 3000/6000 or Offline with a file.

Lists the configuration with their descriptions and values in the order of the tree items shown in the
left view pane.

Save Report

This will save the Configuration Print to file under the Reports folder. The save file name is displayed
on the screen.

Print Report

This will send the Configuration Print to a printer local to your PC.

Search

The search feature allows you to search for certain items in the Configuration Print:

Type in a case-sensitive search phrase, such as "Printer" or "Meter Run", in the search edit box and
press the Search button.
If the search item is not found, a message is displayed.
If the search item is found, it is highlighted in the edit box. If you press the Search button again
it goes to the next instance of the search item.
If the search item has been found at least once and you press the Search button again but it is
not found in the remainder of the configuration print, it asks you if you would like to start the
search again from the top of the print.

464
Report Template Editor

Report Template Editor Introduction 466


Topics Element Setup 469
Report Templates 474
Report View 475
Raw View 476
OMNICOM: Report Template Editor Introduction

Report Template Editor Introduction


OMNICOM’s template editor is used to create and edit the custom report templates. (For information
regarding the difference between custom and default templates please see the help for 'Use Default
Report Template' in Report Setup.) Templates can be created, imported, and edited while con-
nected to an OMNI in the Online mode, or while in the Offline mode.

Note: there are new sample custom Daily templates for firmware versions 20.74.30, 22.74.30,
23.74.30, 24.74.30, 26.74.30, and 27.74.30 and higher. There are new sample custom Batch tem-
plates for firmware versions 22.74.30, 23.74.30, 26.74.30, and 27.74.30 and higher. There are new
sample custom Snapshot and Prove templates for firmware versions 22.74.30 and 26.74.30 and
higher.

Select one of the options below for more detailed information on the Template Editor

Report Viewing Options

The three tabs labeled ‘Formatted’, ‘Report View’, and ‘Raw’ are used to change the way the
report is presented in the RH pane.

The ‘Formatted View’ is the normal method used to edit a report template. Black text is literal
text, it will print exactly as it appears. Fields that will be replaced by data values from the
OMNI’s database at the time of printing are identified as ‘00000000’. The Formatted view also
shows the position of all formatting controls within the template. The status bar shows the line
and column position of the cursor.

The formatting controls and conditional printing codes embedded within the report can make it
difficult to line up data in columns; use the ‘Report View’ to see a version of the report without
the embedded controls. Note: that you can only view the report, you cannot edit the report
template while in the Report View mode.

The ‘Raw View’ is provided for advanced users and OMNI technical support staff who may
want to see the unformatted content of the report template. This view details the actual Mod-
bus register numbers used by the OMNI when it creates the report at time of printing. Note:
that while you can edit the report template data while in the Raw view mode, you may exper-
ience unpredictable operation and report results unless you fully understand what you are
doing. The raw view can be printed or saved to file 'as is' using the right-click menu.

Adding Literal Text

Position the cursor and type. To add ‘white space’, use the ‘Space’ character. OMNICOM
does not recognize the ‘Tab’ character and translates it to a ‘Space’ character. Existing text
can be edited by using the ‘Delete’ and the ‘Backspace’ key. Use the ‘Ins’ key to toggle the
‘Insert/Over-type’ mode. The status bar shows the current settings for Caps lock, Insert/Over-
type mode etc. The status bar also shows the line and column position of the cursor.

466
OMNICOM: Report Template Editor Introduction

Conditional Printing Data on a Report

Sometimes it may be necessary to have data appear or not appear on a printed report
depending upon some Boolean (logical) condition. An example of this might be; including or
excluding data from a report when a certain product is being delivered to a customer. Includ-
ing or excluding data from a printed report is accomplished by defining ‘Boolean True
Blocks’, and ‘Boolean False Blocks’.

Report Formatting Controls

Position the cursor and use the ‘right click’ menu to insert formatting controls such as "Form
Feed’’.;

Time Span of Reports

Each type of report spans a specific time period. This information is used when determining
how much historical data should be included in a report:
A Daily report for example typically spans 24 hours unless it is lengthened or shortened
by daylight saving time events.
A Snapshot report spans the amount of time since the last Snapshot report.
The time span of a Batch report is the amount of time between the Batch Start and
Batch End.
A Prove report includes the amount of time from the beginning of the prove operation to
the point of prove completion.

Importing and Exporting Report Templates

OMNICOM includes an Import and Export function to speed up the creation of report tem-
plates. Existing report templates can be imported and modified to fit the required application.
The export function is used to create a library of templates by allowing the user to store the
edited templates to disk.

When OMNICOM is installed, “sample” custom report templates are installed to your PC as
part of the OMNICOM install process. You can use the File/Import feature to import the
sample templates into OMNICOM and use them exactly as provided or modify them to your lik-
ing before sending them to the OMNI flow computer.

To import an existing report template click on the ‘File’ menu on the toolbar while in the
Template Editor mode or right-click, select 'Import’ and browse the disk drive to find
the required report template. The report template will overwrite the current report. You
must click the ‘Apply’ button to accept and use the newly imported file! Changing
screens or leaving the Template editor will cancel the import operation and restore the
original report template.

Click on the ‘File’ menu on the toolbar and select ‘Export’ to export the current report
template in the editor window. Select the file name and path to be used to save the
report template.

467
OMNICOM: Report Template Editor Introduction

Note: there are new sample custom Daily templates for firmware versions 20.74.30, 22.74.30,
23.74.30, 24.74.30, 26.74.30, and 27.74.30 and higher. There are new sample custom Batch
templates for firmware versions 23.74.30 and 27.74.30 and higher.

Below are the Element controls for the Template Editor. Click on a link to go to that topic.

Database Point
Boolean Block
Archive Block

If using the 1000 conditional Boolean followed by the opening and closing braces with the text
data inside the two braces, means that you would like to only archive the entire text data within
the braces, but not print the data.

Print Archive Block

If using the 2000 conditional Boolean followed by the opening and closing braces with text
data inside the two braces, means that you would like to archive and also print the entire text
within the braces.

Insert Printer Code


Form Feed

Insert a form feed control into the template. The form feed is represented by <FF> in the
formatted and report views.

468
OMNICOM: Element Setup

Element Setup

Topics
Insert Boolean Block
Insert Database Point
Insert Printer Code

469
OMNICOM: Insert Boolean Block

Insert Boolean Block


A boolean block consists of an embedded control that specifies the database point to be tested at the
time of printing for a Boolean true or false condition. This embedded control is followed by literal text
or any other legal report template constructs, enclosed in ‘{…}’ braces. The data contained within the
‘{..}’ braces will be printed if the Boolean evaluation of the controlling database point is true. The
embedded control point is shown on the report template as a green block containing a '?'.

Nesting Boolean Blocks


Boolean blocks can contain other Boolean blocks to a nesting level of 10.

Use the Database Browser to assist in selecting a point however the point must be a Boolean type.

470
OMNICOM: Insert Database Point

Insert Database Point

Adding Database Variables to the Report Template


Position the cursor on the report where the database variable should appear and activate the right
click menu and select ‘Insert’. Click on the first menu item labeled ‘Database Point’, to activate the
‘Database Display Settings’ dialog control.

Database Display Settings


This control dialog is used to select the database point variable to be inserted into the report template
at the cursor position and also to specify the minimum field width and decimal precision to print.

Database point

Activate the Database Point Select Control by double clicking in this field or clicking once on
the button to the right of the field. Select the database point variable to be added to the report
using this select control. Use the Database Browser to assist in selecting a point.

Display Width

OMNI reports typically require data points to be arranged in vertical columns. The ‘Display
Width’ field facilitates this by allowing the user to specify the minimum number of characters
that a data point will occupy on the report. The display width operates differently when spe-
cifying numeric data verses ASCII string data:

Numeric data is right justified within the field and padded with spaces to the width spe-
cified. The data field on the printed report will be automatically expanded on the right
should the number exceed the width of the specified field. To ensure that data in your
printed report lines up correctly make sure that you specify enough digits for the display
width.

ASCII data strings are treated differently, they are left justified and truncated or padded
with spaces to the width specified.

Precision and Default Precision

These settings are active only when placing database points of floating point type on a report.
Checking the ‘Use Default Precision’ check box ensures that the report template will not need
to be adjusted when the OMNI’s configuration is changed to reflect more or less decimal pre-
cision.

Database points added to a report template are displayed using the appropriate number of
characters as determined by the ‘display width’ setting. They are flagged as to their data type
as follows:

471
OMNICOM: Insert Database Point

ASCII data types ‘AAAAAAAA’


Time data types ‘HH:MM:
Date data types ‘MM/DD/YY’,
Numeric data type, precision specified ‘0000.0000’
Numeric data type, integer or default precision specified ‘00000000’

472
OMNICOM: Insert Printer Code

Insert Printer Code

Inserting a Printer Control Code


This could be any of the 256 ASCII byte codes. Each code is entered individually and the actual
sequence of codes is printer dependent for the desired function. Please reference your printer
manual for a list of supported code sequences.

To insert a printer code, position the cursor on the report where the literal printer code should
appear, activate the right click menu and select ‘Insert’. Click on the menu item labeled ‘Printer
Code’, to activate the ‘Insert Printer Code' dialog.

Selecting a Printer Code


To select a printer code, use one of the following methods:
Enter the code using the decimal equivalent
Enter the code using the hexadecimal equivalent
Use the Browser Button to select from a list of codes.

For example: To enter an escape code you could enter a 27 in the decimal code box - or - enter a 1B
in the hexadecimal code box - or - select <ESC> from the Browser printer code list.

In the Browser, a selection may be made by double clicking on a selection, pressing the return key
for a selection, or clicking on the Select button for a selection. To cancel a selection, click the Cancel
button or hit the ESC key.

473
OMNICOM: Report Templates

Report Templates
The OMNI creates two main types of reports; fixed format reports such as the Alarm and Audit Trail
reports, and custom formatted reports such as the Snapshot, Daily, Batch, and Prove reports. The
content of fixed format reports varies only in the amount of data printed, i.e. the number of alarm or
audit events that have been requested by the user. The actual data printed for each event is fixed
and cannot be changed. The content of the custom formatted reports is flexible and is determined by
the user, the data content and format of these reports is transmitted to the OMNI in the form of a
report template.

OMNICOM’s template editor is used to create and edit these report templates. Templates can be cre-
ated and edited while connected to an OMNI in the Online mode, or while in the Offline mode. For
information on how to create and edit a report click here.

474
OMNICOM: Report View

Report View
The conditional printing and formatting controls embedded within the report can make it difficult to
line up data in columns; use the ‘Report View’ to see a version of the report without the embedded
controls. Note: that you can only view the report, you cannot edit the report template while in the
Report View mode. For information on how to create and edit a report click here.

475
OMNICOM: Raw View

Raw View
The ‘Raw View’ is provided for advanced users and OMNI technical support staff who may want to
see the unformatted content of the report template. This view details the actual database ‘file and ele-
ment’ number references used by the OMNI when it creates the report at time of printing. Note: that
while you can edit the report template data while in the Raw view mode, you may experience unpre-
dictable operation and report results unless you fully understand what you are doing. For information
on how to create and edit a report click here.

You may informally print or save the template's Raw View by using the right-click popup menu when
displaying the Raw View. There are no page headers or any other text added to the print or save,
only what is displayed on the view. When saving, you may select a file name to save the raw tem-
plate view to. The save defaults to the OMNICOM install folder and one of the following names
depending on which template you are viewing:
TemplateRawSnapshot.txt
TemplateRawBatch.txt
TemplateRawDaily.txt
TemplateRawProve.txt

476
Operate

Current Reports 478


Topics Reports 484
Retrieve Archive Data 492
Control 502
Archive Maintenance 517
OMNICOM: Current Reports

Current Reports
These reports represent the current data in the system. Reports are retrieved automatically and dis-
played when online. The reports can be printed or saved to file. The reports can be saved using
either the Computer ID or the File Name with either the OMNICOM DOS extension or with the date
and time appended with a ".txt" extension (See help for Preferences under Reports). If a file being
saved already exists, the user is prompted if they would like to overwrite it.

The user may also bypass the condensed mode checking when printing reports to OMNICOM (See
help for Preferences under Reports).

Saved reports can be viewed either online or offline. The viewing file type and extension defaults to
the preference selected.

Topics
Snapshot Report
Product File
Status
Site List

478
OMNICOM: Snapshot

Snapshot
A snapshot report can be uploaded from the flow computer or the last snapshot report uploaded and
stored to disk can be viewed.

Previously saved report files can also be viewed. The OMNICOM DOS extension is ".snr" for these
reports.

If the mode is ONLINE, a current report is retrieved from the OMNI upon entering the screen. If the
mode is OFFLINE, the View Saved Reports screen is displayed for the user to select a previously
saved report.

479
OMNICOM: Status

Status
The status report shows the current meter run active status as well as which transducer inputs are
currently in alarm. The current batch stack is also shown.

Previously saved report files can also be viewed. The OMNICOM DOS extension is ".sts" for these
reports.

If the mode is ONLINE, a current report is retrieved from the OMNI upon entering the screen. If the
mode is OFFLINE, the View Saved Reports screen is displayed for the user to select a previously
saved report.

480
OMNICOM: Product File

Product File
The product file report contains the meter factors to be used for each flowmeter. It shows each of the
sixteen products, the override gravities to be used and the calculation standards to be used when
that product is flowing.

Previously saved report files can also be viewed. The OMNICOM DOS extension is ".prd" for these
reports.

If the mode is ONLINE, a current report is retrieved from the OMNI upon entering the screen. If the
mode is OFFLINE, the View Saved Reports screen is displayed for the user to select a previously
saved report.

481
OMNICOM: Site List

Site List
A list of the connection sites and associated units configured via the Edit | Sites screen. Available
online and offline.

The site information includes:


Direct

Shows the site name, comm port, baud rate, data bits, stop bits and parity.

Modem

Shows the site name, phone number, comm port, baud rate, data bits, stop bits and parity.

Satellite

Shows the site name, satellite number, comm port, baud rate, data bits, stop bits and parity.

TCP/IP

Shows the site name.

The unit information includes:


Direct/Modem/Satellite

Shows the unit name, Modbus ID, Modbus Type, Modicon compatible, initial character delay,
character delay, and retries

TCP/IP

Shows the unit name, Modbus ID, Modbus Type, Modicon compatible, IP Address, TCP port,
connection time out, message time out, and retries.

Buttons:
Save Report

This will save the list to file under the Reports folder. Note: there is no DOS extension for this
report so it is saved using the Date/Time and ".txt" extension.

Print Report

482
OMNICOM: Site List

This will send the list to a printer local to your PC.

483
OMNICOM: Reports

Reports
Reports are retrieved automatically when online and displayed. The reports can be printed or saved
to file. The reports can be saved using either the Computer ID or the File Name with either the
OMNICOM DOS extension or with the date and time appended with a ".txt" extension (See help for
Preferences). If a file being saved already exists, the user is prompted if they would like to overwrite
it.

The user may also bypass the condensed mode checking when printing reports to OMNICOM (See
help for Preferences under Reports).

Saved reports can be viewed either online or offline. The viewing file type and extension defaults to
the preference selected.

Topics
The items listed below are links to topics within the Current Reports. Click on a link to go to that topic.
Snapshot
Product File
Status

The items listed below are links to topics within the Historical Reports. Click on a link to go to that
topic.

Alarm (500) or Alarm(150)


Audit Trail (150)
Last Local Snapshot

Batch Report
Daily Report
Prove Report
Monthly Report(available with firmware versions 20.75.10 and higher)

484
OMNICOM: Historical Alarm Report

Historical Alarm Report


An historical alarm report detailing the last 1000 (see notes*) alarm occurrences can be uploaded
from the flow computer or the last alarm report uploaded and stored to disk can be loaded for view-
ing.

Previously saved report files can also be viewed. The OMNICOM DOS extension is ".alr" for these
reports.

*Note: The number of alarm events has increased to 1000 for 20.75.10, 22.75.10, 23.75.10,
24.75.10, 26.75.10, and 27.75.10 and higher.
*Note: The number of alarm events has increased from 150 to 500 events for 22.74.30 and 26.74.10
and higher and prior to 22.75.10 and 26.75.10.

If the mode is ONLINE, a current report is retrieved from the OMNI upon entering the screen. If the
mode is OFFLINE, the View Saved Reports screen is displayed for the user to select a previously
saved report.

If the alarm report shows an SE Module Printer error, please see the Troubleshooting Network Print-
ing section for information on the error codes.

485
OMNICOM: Historical Audit Trail Report

Historical Audit Trail Report


A report detailing the last 1000 (see note*) data base changes can be uploaded from the flow com-
puter or from the disk. Each change to the data base is a numbered event in the audit trail. Each
event is time and date tagged and includes the Modbus point number of the variable involved,
together with the original and new value. The starting point number and number of points changed
are listed when the changes are made via a Modbus communication port.

Available with firmware versions XX.75.10, the User or Port ID of the person or device making the
change is also shown.

*Note: the number of audit events has increased from 150 to 1000 for firmware versions XX.75.10
and higher.

Previously saved report files can also be viewed. The OMNICOM DOS extension is ".adt" for these
reports.

If the mode is ONLINE, a current report is retrieved from the OMNI upon entering the screen. If the
mode is OFFLINE, the View Saved Reports screen is displayed for the user to select a previously
saved report.

Note: Changes made from OMNICOM and via other Modbus clients are only audited for items that
affect the measurement according to API Chapters 21.1 and 21.2. Changes made from the Front
Panel are always audited.

486
OMNICOM: Last Local Snapshot

Last Local Snapshot


A copy of the last snapshot report printed locally at the flow computer can be uploaded .

Previously saved report files can also be viewed. The OMNICOM DOS extension is ".snl" for these
reports.

If the mode is ONLINE, a current report is retrieved from the OMNI upon entering the screen. If the
mode is OFFLINE, the View Saved Reports screen is displayed for the user to select a previously
saved report.

487
OMNICOM: Historical Batch Report

Historical Batch Report


Batch reports are printed locally at the flow computer at the end of each batch. The flow computer
stores reports for the last eight batch ends.

Previously saved report files can also be viewed. The OMNICOM DOS extension is ".b01" through
".b08" for these reports where ".b01" would be the latest batch report.

If the mode is ONLINE, a current report is retrieved from the OMNI upon entering the screen. If the
mode is OFFLINE, the View Saved Reports screen is displayed for the user to select a previously
saved report.

488
OMNICOM: Historical Daily Report

Historical Daily Report


Daily reports are printed locally at the flow computer at the contract day start time of each day. The
flow computer stores reports for the last eight days.

Previously saved report files can also be viewed. The OMNICOM DOS extension is ".d01" through
".d08" for these reports where ".d01" would be the latest batch report.

If the mode is ONLINE, a current report is retrieved from the OMNI upon entering the screen. If the
mode is OFFLINE, the View Saved Reports screen is displayed for the user to select a previously
saved report.

489
OMNICOM: Historical Monthly Report

Historical Monthly Report


Monthly reports are available with firmware versions 20.75.10 and higher.

They are printed locally at the flow computer at the contract day start time of the configured monthly
report day. The flow computer stores reports for the last eight days.

Previously saved report files can also be viewed. Although these reports were not available with
OMNICOM for DOS, an OMNICOM DOS extension is provided and is ".m01" through ".m08" for
these reports where ".m01" would be the latest batch report.

If the mode is ONLINE, a current report is retrieved from the OMNI upon entering the screen. If the
mode is OFFLINE, the View Saved Reports screen is displayed for the user to select a previously
saved report.

490
OMNICOM: Historical Prove Report

Historical Prove Report


Prove reports are printed locally at the flow computer at the completion of each prove sequence. The
last eight prove reports are stored.

Previously saved report files can also be viewed. The OMNICOM DOS extension is ".p01" through
".p08" for these reports where ".p01" would be the latest batch report.

If the mode is ONLINE, a current report is retrieved from the OMNI upon entering the screen. If the
mode is OFFLINE, the View Saved Reports screen is displayed for the user to select a previously
saved report.

491
OMNICOM: Retrieve Archive Data

Retrieve Archive Data


Note: These functions are only available in the ONLINE mode.

Data is saved in the OMNI in user configurable formats at user configurable times or events. Select
from the following to view the archived data.

Topics
Archive Path - Note this entry has been moved to the Preferences screen under the Edit
Menu.
Text Archive
Archive Data 701-710
Alarm (711)
Audit (712) (for firmware versions below XX.75.10)
Audit (713)(for firmware versions XX.75.10 and above)

492
OMNICOM: Text Archive

Text Archive
Note: This screen is only available in the ONLINE mode.

Retrieve archived data from OMNI flow computer. Data can be archived as text data or in raw binary
data. In either case data is retrieved and stored to disk in readable ASCII format using the same file
name as the current configuration file but with a different extension i.e.

Text Archive File 'filename.arc.txt' Overwritten if file exists and the user unchecks the "Append
to File" button.

493
OMNICOM: Archive Data 701-710

Archive Data 701-710


Note: This screen is only available in the ONLINE mode.

Note: In versions 70 and 71 of the firmware, the Historical Text Reports (i.e. Snapshot, Daily, Batch)
are generated before the 701-710 Archiving takes place. In version 74 of the firmware, the 701-710
Archiving takes place before the Historical Text Reports are generated. If you are updating your firm-
ware to version 74, you may need to modify the triggers based on the change in processing
sequence.

Data Retrieval
The archive data 701-710 is retrieved from the OMNI flow computer in raw binary data. Data is
retrieved and stored to disk in readable ASCII format using the same file name as the current con-
figuration file but with a different extension i.e.

Archive File 701 'filename.701' Appended if file exists


Archive File 702 'filename.702' " " " "
     ... ...
Archive File 710 'filename.710' " " " "

The starting record is always defaulted to the oldest record in the archive. Change this value to start
retrieving from a later record. The count value is the number of records from the record you entered
in the start to the newest record in the archive.

If a file already exists with data in it, the 'Append to Existing File' checkbox is automatically checked.
Uncheck the box if you would like a new file created. (Note: if unchecked, all the existing data in the
file will be cleared.)

The current date and time are also stored with each entry when the data is archived in the flow com-
puter. With each data record received, there are six bytes of date/time data at the start of the record.

For Example: consider a date and time of August 29, 2007 11:36:52:

If your date format is "MM/DD/YY", the first six bytes are


     08 1D 07 0B 24 34

If your date format is "DD/MM/YY", the first six bytes are


     1D 08 07 0B 24 34

Data Registers
There are two methods of retrieval of the archive data:

494
OMNICOM: Archive Data 701-710

Method 1:
Write the record number required to the request record number register. Each archive has its
own request record register (3703, 3706, 3709, 3712, 3715, 3718, 3721, 3724). For Archive
701, the register is 3703.

Next the archive data (registers 701-710) can be read. For Archive 701, read register 701.

The date/time stamp only records can also be read using registers 751-760 for archives 701-
710 respectively. For Archive 701, read register 751.
Method 2:
Method 2 allows a faster access of the data using a single read. The "register count" field becomes
the record requested so that it
does not require to first write the request record number (3703, 3706...).

Many of our firmware versions now support the Method 2 registers (20.74.00, 21.74.00, 22.74.06,
23.74.00, 24.74.00, 26.74.10, and 27.74.00 and higher). (Note: Level B support for the faster access
registers are in 20.74.22, 21.74.01, 22.74.06, 23.74.19, 24.74.17, 26.74.10, and 27.74.18 and
higher.)

For Archive Data 701-710, use registers 721-730 respectively.


For Date/Time Data for Archives 701-710 use registers 771-780 respectively.

For Example: Read Archive 703 record 150 (Modbus RTU protocol)

TX: 01 03 02 D3 00 96 35 E5

For Example: Read Date/Time for Archive 702 record 8 (Modbus RTU protocol)

TX: 01 03 03 04 00 08 05 89
RX: 01 03 06 08 1D 07 0B 24 34 A6 5E - Date/Time is August 29, 2007 11:36:52 (date format
"MM/DD/YY")

Modicon Compatible Floats


Archive data sent as float register values when using Modicon compatible protocol use the Modicon
compatible float format when transmitted i.e. the float bytes are swapped from ‘aa bb cc dd’ to
‘cc dd aa bb’.

For example: The float number 72.3 is sent as the Modicon format:

Modicon (from OMNI) 99 9A 42 90

495
OMNICOM: Alarm 711

Alarm 711
Note: This screen is only available in the ONLINE mode.

The Alarm archive data 711 is retrieved from the OMNI flow computer in raw binary data. Firmware
versions 20.75.10, 22.75.10, 23.75.10, 24.75.10, 26.75.10, and 27.75.10 and higher support up to
1000 records of data. Data is retrieved and stored to disk in readable ASCII format using the same
file name as the current configuration file but with a different extension i.e.

Alarm Log Archive 'filename.711' Appended if file exists

The starting record is always defaulted to the oldest record in the archive. Change this value to start
retrieving from a later record. The count value is the number of records from the record you entered
in the start to the newest record in the archive.

If a file already exists with data in it, the 'Append to Existing File' checkbox is automatically checked.
Uncheck the box if you would like a new file created. (Note: if unchecked, all the existing data in the
file will be cleared.)

The current date and time are also stored with each entry when the data is archived in the flow com-
puter. With each data record received, there are six bytes of date/time data at the start of the record.

For Example: consider a date and time of August 29, 2007 11:36:52:

If your date format is "MM/DD/YY", the first six bytes are


08 1D 07 0B 24 34

If your date format is "DD/MM/YY", the first six bytes are


1D 08 07 0B 24 34

Alarm Record Format

Description Data Type


Date/Time 6 bytes (as described above)
Modbus Index 16-bit unsigned integer
Alarm Type/Boolean Value 16-bit unsigned integer
Transducer Value float
Volume Totalizer 32-bit unsigned integer
Mass Totalizer 32-bit unsigned integer

Note: Liquid Pulse Type Meter with Meter Factor Curve Applications (22/26) do not support the Mod-
bus Index field.

496
OMNICOM: Alarm 711

Data Registers
Many of our firmware versions now support data registers that allow a faster access of the data
(20.74.00, 21.74.00, 22.74.06, 23.74.00, 24.74.00, 26.74.10, and 27.74.00 and higher). (Note:
Level B support for the faster access registers are in 20.74.22, 21.74.01, 22.74.06, 23.74.19,
24.74.17, 26.74.10, and 27.74.18 and higher.)

For Archive Data 711, use register 731 (old register is 711).
For Date/Time Data for Archives 711 use register 781 (old register is 761).

When using these new registers, the "register count" field becomes the record requested.

For Example: Read Archive 711 record 150 (Modbus RTU protocol)

TX: 01 03 02 DB 00 64 35 A2

For Example: Read Date/Time for Archive 711 record 8 (Modbus RTU protocol)

TX: 01 03 03 0D 00 08 D5 8B
RX: 01 03 06 08 1D 07 0B 24 34 A6 5E - Date/Time is August 29, 2007 11:36:52 (date format
"MM/DD/YY")

Modicon Compatible Floats


Archive 711 data sent as float register values (Transducer value) when using Modicon compatible
protocol use the RTU float format when transmitted i.e. the bytes are not swapped.

For example: The float number 72.3 is sent as:

RTU (from OMNI) 42 90 99 9A

497
OMNICOM: Audit 712

Audit 712
Note: This screen is only available in the ONLINE mode.

The Audit archive data 712 is retrieved from the OMNI flow computer in raw binary data. There are a
maximum of 150 records of audit data. Firmware version XX.75.10 supports up to 1000 records of
data.

Note: Changes made from OMNICOM and via other Modbus clients are only audited for items that
affect the measurement according to API Chapters 21.1 and 21.2. Changes made from the Front
Panel are always audited.

Data is retrieved and stored to disk in readable ASCII format using the same file name as the current
configuration file but with a different extension i.e.

Audit Log Archive 'filename.712' Appended if file exists

The starting record is always defaulted to the oldest record in the archive. Change this value to start
retrieving from a later record. The count value is the number of records from the record you entered
in the start to the newest record in the archive.

If a file already exists with data in it, the 'Append to Existing File' checkbox is automatically checked.
Uncheck the box if you would like a new file created. (Note: if unchecked, all the existing data in the
file will be cleared.)

The current date and time are also stored with each entry when the data is archived in the flow com-
puter. With each data record received, there are six bytes of date/time data at the start of the record.

For Example: consider a date and time of August 29, 2007 11:36:52:

If your date format is "MM/DD/YY", the first six bytes are


     08 1D 07 0B 24 34

If your date format is "DD/MM/YY", the first six bytes are


     1D 08 07 0B 24 34

Audit Record Format

Description Data Type


Date/Time 6 bytes (as described above)
Event Number 16-bit unsigned integer
Modbus Index 16-bit unsigned integer
Before Numeric Value float
After Numeric Value float

498
OMNICOM: Audit 712

Before string 16-byte ASCII


After string 16-byte ASCII
Volume Totalizer 32-bit unsigned integer
Mass Totalizer 32-bit unsigned integer

Note: Liquid Pulse Type Meter with Meter Factor Curve Applications (22/26) do not support the
Volume and Mass Totalizer fields.

Data Registers
Many of our firmware versions now support data registers that allow a faster access of the data
(20.74.00, 21.74.00, 22.74.06, 23.74.00, 24.74.00, 26.74.10, and 27.74.00 and higher). (Note:
Level B support for the faster access registers are in 20.74.22, 21.74.01, 22.74.06, 23.74.19,
24.74.17, 26.74.10, and 27.74.18 and higher.)

For Archive Data 712, use register 732 (old register is 712).
For Date/Time Data for Archives 712 use register 782 (old register is 762).

When using these new registers, the "register count" field becomes the record requested.

For Example: Read Archive 712 record 100 (Modbus RTU protocol)

TX: 01 03 02 DC 00 64 84 63

For Example:Read Date/Time for Archive 712 record 8 (Modbus RTU protocol)

TX: 01 03 03 0E 00 08 25 8B
RX: 01 03 06 08 1D 07 0B 24 34 A6 5E - Date/Time is August 29, 2007 11:36:52 (date format
"MM/DD/YY")

Modicon Compatible Floats


Archive 712 data sent as float register values when using Modicon compatible protocol use the RTU
float format when transmitted i.e. the bytes are not swapped.

For example: The float number 72.3 is sent as:

RTU (from OMNI) 42 90 99 9A

499
OMNICOM: Audit 713

Audit 713
Note: This screen is only available in the ONLINE mode.

The Audit archive data 713 is available for firmware versions XX.75.10 and up.

The audit data is retrieved from the OMNI flow computer in raw binary data for firmware versions .
There are a maximum of 1000 records of audit data.

Note: Changes made from OMNICOM and via other Modbus clients are only audited for items that
affect the measurement according to API Chapters 21.1 and 21.2. Changes made from the Front
Panel are always audited.

Data is retrieved and stored to disk in readable ASCII format using the same file name as the current
configuration file but with a different extension i.e.

Audit Log Archive 'filename.713' Appended if file exists

The starting record is always defaulted to the oldest record in the archive. Change this value to start
retrieving from a later record. The count value is the number of records from the record you entered
in the start to the newest record in the archive.

If a file already exists with data in it, the 'Append to Existing File' checkbox is automatically checked.
Uncheck the box if you would like a new file created. (Note: if unchecked, all the existing data in the
file will be cleared.)

The current date and time are also stored with each entry when the data is archived in the flow com-
puter. With each data record received, there are six bytes of date/time data at the start of the record.

For Example: consider a date and time of August 29, 2007 11:36:52:

If your date format is "MM/DD/YY", the first six bytes are


     08 1D 07 0B 24 34

If your date format is "DD/MM/YY", the first six bytes are


     1D 08 07 0B 24 34

Audit Record Format

Description Data Type


Date/Time 6 bytes (as described above)
Event Number 16-bit unsigned integer
Modbus Index 16-bit unsigned integer
Before Numeric Value float

500
OMNICOM: Audit 713

After Numeric Value float


Before string 16-byte ASCII
After string 16-byte ASCII
Volume Totalizer 32-bit unsigned integer
Mass Totalizer 32-bit unsigned integer
User or Port ID 16-byte ASCII

Note: Liquid Pulse Type Meter with Meter Factor Curve Applications (22/26) now support the
Volume and Mass Totalizer fields in Audit 713.

Data Registers

Audit Archive 713 is only available with Method 2.

For Archive Data 713, use register 733.


For Date/Time Data for Archives 713 use register 783.

When using these registers, the "register count" field becomes the record requested.

For Example: Read Archive 713 record 100 (Modbus RTU protocol)

TX: 01 03 02 DD 00 64 D5 A3

For Example:Read Date/Time for Archive 713 record 8 (Modbus RTU protocol)

TX: 01 03 03 0F 00 08 74 4B
RX: 01 03 06 0C 0B 0D 0E 10 0D 2B 12 - Date/Time is November 12, 2013 14:16:13 (date format
"MM/DD/YY")

Modicon Compatible Floats


Archive 713 data sent as float register values when using Modicon compatible protocol use the RTU
float format when transmitted i.e. the bytes are not swapped.

For example: The float number 72.3 is sent as:

RTU (from OMNI) 42 90 99 9A

501
OMNICOM: Control

Control
You may monitor or control the Batches or Proving operations in the OMNI.

Topics
Batch
Prover

502
OMNICOM: Batch

Batch

Topics
Batch Control
Batch Control - Meter Runs
Batch Control - Station
Batch Stack
Batch Ticket

503
OMNICOM: Batch Control

Batch Control
Note: This screen is only available in the ONLINE mode.

A complete set of software batch totalizers and flow weighted averages are also provided in addition
to the daily and cumulative totalizers. These totalizers and averages can be printed, saved, and reset
automatically, based on the amount delivered, change of product, or on demand.

The OMNI can keep track of 4 independent meter runs running any combination of up to 32 different
products (available with firmware versions 20.75.10 and 24.75.10) or up to 16 different products for
prior firmware versions.

For liquid applications, if a Common Batch Stack (see Batch Setup) is used, flowmeter runs can be
combined and treated as a station (see Station Setup). The batch stack is entered and batches for
the combined meter runs are ended using the station. (Note that for applications with just one meter
run you must enter either '1' or '1+1-1' in the Station Setup Totals and Flows field in order to end
batches for the station.)

If Independent Batch Stacks are used, the batch stack is entered and batches ended using the indi-
vidual Meter Runs.

You can select to control the batch stack shift by selecting an item under the "Batch - Stack Shift"
or "Batch - No Stack Shift" headings in the Operate tree (Available with firmware versions
20.74.22, 22.74.06, 24.74.18, and 26.74.10 and higher):

Batch - Stack Shift

Using this option instructs the OMNI to end the batch on the current running product, shift the
batch stack upwards, and begin a new batch on the first product in the batch stack.

If a new product number was not entered into the batch stack prior to ending the batch, the
OMNI will not shift the batch stack and will begin a new batch measuring the same product as
the batch that just ended.

If independent batch stacks are used, the configured meters and station are shown in the list.
If common batch stack is selected, only the station is shown in the list.

Note: When utilizing the front panel of the OMNI to end a batch by pressing PROG BATCH
METER 'n' ENTER or PROG BATCH ENTER, the OMNI will look at the "Disable Batch
Stack Operation" setting in the Batch Scheduling configuration to determine whether it should
shift the batch stack or not. If it is not checked, it will shift the batch.

All batch end commands 1702 – 1706 and 2751 – 2755 are allowed even when the “Disable
Batch Stack Operation” setting is checked. The Disable Batch Stack Operation setting is for
use with the automated batch scheduling configuration settings only.

504
OMNICOM: Batch Control

If using Modbus command points to end the batch instead of using the front panel:

Batch End - Stack Shift Operation


1702 = End Station Batch
1703 = End Meter 1 Batch
1704 = End Meter 2 Batch
1705 = End Meter 3 Batch
1706 = End Meter 4 Batch

Batch - No Stack Shift

Using this option instructs the OMNI to end the batch on the current running product and to
begin a new batch measuring the same product as the batch that just ended.

The OMNI will not shift the batch stack even if there were products entered into the batch
stack prior to ending the batch.

Note: When utilizing the front panel of the OMNI to end a batch by pressing PROG BATCH
METER 'n' ENTER or PROG BATCH ENTER, the OMNI will look at the "Disable Batch
Stack Operation" setting in the Batch Scheduling configuration to determine whether it should
shift the batch stack or not. If it is checked, it will not shift the batch.

All batch end commands 1702 – 1706 and 2751 – 2755 are allowed even when the “Disable
Batch Stack Operation” setting is checked. The Disable Batch Stack Operation setting is for
use with the automated batch scheduling configuration settings only.

If using Modbus command points to end the batch instead of using the front panel:

Batch End - No Stack Shift Operation


2751 = End Meter 1 Batch
2752 = End Meter 2 Batch
2753 = End Meter 3 Batch
2754 = End Meter 4 Batch
2755 = End Station Batch

Topics
Batch Control for Meter Runs
Batch Control for Station
Batch Stack (Only for liquid applications)
Batch Ticket (Available with firmware v22.74.05 and higher)

505
OMNICOM: Batch Control - Meter Runs

Batch Control - Meter Runs


Note: This screen is only available in the ONLINE mode.

Monitor the totalizers of each meter run in 'real time' and send 'end batch' commands.

Topics
Batch Status

The following information is shown:


Batch Start: The date and time the batch started.

Batch Status:
In Progress - Batch is in progress with the meter active.
Suspended - Batch is in progress with the meter not active. Note: the flow com-
puter continues to totalize unless the totalizers have been disabled (see Alarms -
Active Frequency in the Meter Run Setup screen).
Batch Ended - Batch End has been received, meter not active.

Type of batch stack: Independent (per meter) or Common (per station). (Note:this is
not available for gas applications.)

Totalizers

The current values of the following totalizers are shown:


Uncorrected IV (Uncorrected for Anhydrous Ammonia)
Corrected GSV (Corrected for Anhydrous Ammonia)
Corrected NSV (not used for Anhydrous Ammonia)
Mass (not used for Anhydrous Ammonia)

(Anhydrous Ammonia is available with v20.74.22+.)

Batch Control

End Batch Button: Press this button if you would like to send an 'End Batch' com-
mand to the OMNI.

Adjust Batch Size: If independent batch stacks are used, you may adjust the batch
size for the meter run. Enter a value in the edit box next to the button to enable the but-
ton. Press the button to adjust the batch size. If you enter a positive number, the batch
size is increased by the amount entered. If you enter a negative number, the batch size
is decreased by the amount entered. (Note: this is only available with firmware versions
20 and 24.) (Note: Enter the batch size in Tons to two decimal places for Anhydrous
Ammonia v20.74.22+.)

506
OMNICOM: Batch Control - Meter Runs

Current Batch: Information is displayed regarding the current batch in progress such
as ASCII Batch ID, Numerical Batch ID (available with firmware versions 20.75.10 and
24.75.10), Product Name, Numerical Product Name (available with firmware versions
20.75.10 and 24.75.10), Batch Meter Factor, Batch Size, and Batch Remaining.
(Note: this is not available for gas applications.)

Next Batch: Limited information is available such as ASCII Batch ID, Numerical Batch
ID (available with firmware versions 20.75.10 and 24.75.10), Product Name, Numerical
Product Name (available with firmware versions 20.75.10 and 24.75.10), and Batch
Size. (Note:this is not available for gas applications.)

507
OMNICOM: Batch Control - Station

Batch Control - Station


Note: This screen is only available in the ONLINE mode.

Monitor the common totalizers in 'real time' and send 'end batch' commands.

For liquid applications, if a Common Batch Stack (see Batch Setup) is used, flowmeter runs can be
combined and treated as a station (see Station Setup). The batch stack is entered via the Station.
Batches for the combined meter runs are ended via the Station.(Note that for applications with just
one meter run you must enter '1' or '1+1-1' in the Station Setup Totals and Flows field in order to end
batches for the station.)

Topics
Batch Status

The following information is shown:


Batch Start: The date and time the batch started.

Batch Status:
In Progress - Batch is in progress with the common meters active.
Suspended - Batch is in progress with the any of the common meters not active. Note:
the flow computer continues to totalize unless the totalizers have been disabled (see
Alarms - Active Frequency in the Meter Run Setup screen).
Batch Ended - Batch End has been received, common meters not active.

Type of batch stack: Independent or Common.(Note: this is not available for gas applic-
ations.)

Totalizers

The current values of the following common totalizers are shown:


Uncorrected IV (Uncorrected for Anhydrous Ammonia)
Corrected GSV (Corrected for Anhydrous Ammonia)
Corrected NSV (not used for Anhydrous Ammonia)
Mass (not used for Anhydrous Ammonia)

(Anhydrous Ammonia is available with v20.74.22+.)

Batch Control

End Batch Button: Press this button if you would like to send an 'End Batch' command to
the OMNI.

Adjust Batch Size: If common batch stacks are used, you may adjust the batch size for the
station. Enter a value in the edit box next to the button to enable the button. Press the button to
adjust the batch size. If you enter a positive number, the batch size is increased by the amount

508
OMNICOM: Batch Control - Station

entered. If you enter a negative number, the batch size is decreased by the amount entered.
(Note: this is only available with firmware versions 20 and 24.) (Note: Enter the batch size in
Tons to two decimal places for Anhydrous Ammonia v20.74.22+.)

Current Batch: Information is displayed regarding the current batch in progress such as
ASCII Batch ID, Numerical Batch ID (available with firmware versions 20.75.10 and
24.75.10), Product Name, Numerical Product Name (available with firmware versions
20.75.10 and 24.75.10), Batch Meter Factor, Batch Size, and Batch Remaining. (Note:this is
not available for gas applications.)

Next Batch: Limited information is available such as ASCII Batch ID, Numerical Batch ID
(available with firmware versions 20.75.10 and 24.75.10), Product Name, Numerical Product
Name (available with firmware versions 20.75.10 and 24.75.10), and Batch Size. (Note: this
is not available for gas applications.)

509
OMNICOM: Batch Stack

Batch Stack
Note: This screen is only available in the ONLINE mode.

(Only available for liquid applications. Note: this tab is enabled for Level B users in firmware versions
20.74.23, 22.74.06, 24.74.18, and 26.74.10 and higher)

The OMNI can be programmed with batch setup information. The batch information is stored in the
batch stack.

The batch stack may be configured as a Common Batch Stack (see Batch Setup) meaning the
flowmeters are all running the same product and the totals and flows are combined and treated as a
station. This provides up to 24 individual batches that may be programmed into the OMNI flow com-
puter. For applications using a Common Batch Stack, the Station is used to enter the products for
the batch stack and for ending the batch. For this reason, a Station must be configured in the Station
Setup screen in the "Station Totals and Flows" field. (Note that for applications with just one meter
run you must enter '1' or '1+1-1' in that field in order to end batches for the station.) If a Batch Preset
Warning value is required, it is entered in the Station Setup.

The batch stack may also be split into 4 Independent Batch Stacks in the OMNI flow computer,
each stack representing a meter run. This configuration allows six batches to be programmed into
the flow computer for each meter run. Independent batch stacks are useful when running different
products on each meter run. If a Batch Preset Warning value is required, it is entered in the Meter
Setup.

NOTE: The number of entries allowed in the Batch Stack should not be confused with the number of
previous batches available for recalculation. Refer to the OMNI Technical Bulletin on “Recalculating
a Previous Batch within the Flow Computer” for details of the previous batch recalculation feature.

You can select to control the batch stack shift by selecting an item under the "Batch - Stack Shift"
or "Batch - No Stack Shift" nodes in the Operate tree (Available with firmware versions 20.74.22,
22.74.06, 24.74.18, and 26.74.10 and higher):

Batch - Stack Shift

Using this option instructs the OMNI to end the batch on the current running product, shift the batch
stack upwards, and begin a new batch on the first product in the batch stack.

If a new product number was not entered into the batch stack prior to ending the batch, the OMNI will
not shift the batch stack and will begin a new batch measuring the same product as the batch that
just ended.

If independent batch stacks are used, the configured meters and station are shown in the list. If a
batch is ended for a station, it ends the batch only on the meters assigned to the station.

If common batch stack is selected, only the station is shown in the list.

510
OMNICOM: Batch Stack

Batch - No Stack Shift

Using this option instructs the OMNI to end the batch on the current running product and to begin a
new batch measuring the same product as the batch that just ended.

The OMNI will not shift the batch stack even if there were products entered into the batch stack prior
to ending the batch.

Settings
To edit the batch stack, double click anywhere on the sequence row. A screen will come up to enter:

ASCII Batch ID

Enter a 16-character alphanumeric ID for the batch.

Numerical Batch ID

Numerical Batch IDs are available with firmware versions 20.75.10 and 24.75.10 and above.

Enter a 32-bit integer ID for the batch.

Product

Select from a drop down list of available products.

Numeric product names are available with firmware versions 20.75.10 and 24.75.10 and above. If
there is a numeric product name, it is combined with the product name i.e.: 'Crude - 4567'.

Batch Size

Enter the size of the batch (a 32-bit long integer). Note: for Anhydrous Ammonia (available with
20.74.22+) enter the batch size in Tons to two decimal positions (a float).

Product Gravity Adjustment(Available with firmware versions 20.74.30, 22.74.30,


24.74.30, and 26.74.30 and higher)

The adjustment methods for English applications are:


0) No Gravity Adjustment Required (default)
1) Adjust SG Gravity at Batch Stack Shift
2) Adjust API at Batch Stack Shift

The adjustment methods for Metric applications are:


0) No Gravity Adjustment Required (default)
1) Adjust Reference Density at Batch Stack Shift

If the adjustment selection is zero, there is no action taken by the OMNI at batch shift.

511
OMNICOM: Batch Stack

If the adjustment selection is 1, enter a value for the SG Override (absolute numerical value of
0.350 to 1.500) for English applications or the Reference Density (absolute numerical value of 350 to
1500) for Metric applications. On a new batch stack shift (i.e. new batch start), the OMNI overwrites
the SG/Reference Density for the product identified by the batch stack with the value entered here.
The OMNI also uses the SG override to calculate the equivalent API gravity and overwrites the
product's API gravity.

If the adjustment selection is 2 (English applications only), enter a value for the API Override
(absolute numerical value of 0.0 to 150). On a new batch stack shift (i.e. new batch start), the OMNI
overwrites the API for the product identified by the batch stack with the value entered here. The
OMNI also uses the API Override to calculate the equivalent SG and overwrites the product's SG.

NOTE: Changing the Product Gravity Adjustment is not allowed for the current running batch stack
position.

The OMNI uses the batch setup data for the last batch completed if the batch stack is empty at the
beginning of a new batch.

512
OMNICOM: Batch Ticket (Firmware Version 22)

Batch Ticket (Firmware Version 22)


Note: This screen is only available in the ONLINE mode.

Configure items to be printed on the Batch Ticket before the batch is ended. (This item is available
with firmware versions 22.74.05 and higher.)

Settings
Maintenance Ticket

Check the box to have an "M" appended to the ticket number.

Official Ticket

Selections are: None, Official, and Unofficial

If "Official" is selected an 'X' will be added to the Official field.


If "Unofficial is selected an 'X' will be added to the Unofficial field.
If "None" is selected there will be no 'X'.

Receipt Ticket

Selections are: None, Receipt, and Delivery

If "Receipt" is selected an 'X' will be added to the Receipt field.


If "Delivery" is selected an 'X' will be added to the Delivery field.
If "None" is selected there will be no 'X'.

Batch Number

Enter a Batch Number to be printed on the batch ticket. You may use up to 8 alphanumeric
characters.

513
OMNICOM: Prover Control

Prover Control
Note: This screen is only available in the ONLINE mode.

(Available with firmware versions 20, 22, 23, 24, 26 and 27)

You may monitor or control the operation of a meter prover which is controlled by a remote OMNI
flow computer.

Use the drop down list to select the flowmeter you wish to prove or monitor.

The display shows the live data as it changes as well as an event history.

Note: If you are proving a meter which has Anhydrous Ammonia product table selected
(v20.74.22+), the Volume units are lbs, Density units are lb/ft3 and the flow rate is in Tons/hr. This is
reflected in the prover control table heading, real time flow rate display, and Previous Prove Data dis-
play.

514
OMNICOM: Trapil Control

Trapil Control
Note: This screen is only available in the ONLINE mode.

This page is displayed for firmware revisions 24.74.18 and higher when the Trapil Functions are
enabled:
Enable the Trapil functions in OMNICOM with the command line switch '-Trapil'. If you need
help adding a command line switch, please speak with your IT representative.
Enable the Trapil functions in the OMNI in the Password menu by setting the 'Trapil Function'
to 'Y'.

Fields
Gross Flow Rate for Meter 1&2, Meter 1 and Meter 2
Gross Totals for Meter 1&2, Meter 1 and Meter 2

Partial Status (Partial A or Partial B is active)


Partial A and Partial B totals

Alarms
Pulse Fidelity Error Counts for Meter 1 and Meter 2

Commands
Partial Toggle

Totalizing occurs in either Partial A or Partial B but never in both partial counters at the same
time. Trapil operators can at any time choose to toggle between the A Partial or B Partial
counter by pressing the "Partial Toggle" button.

The edge-triggered command toggles the true/false value of the ‘Active Partial Status Flag’ (0
= Partial A active, 1 = Partial B active). The OMNI’s Meter Runs are enabled or disabled
depending upon the state of the ‘Active Partial Status Flag’:
A status flag value = 0 (Partial A active) causes Meter Run #1 and Meter Run #2 to be
enabled and causes Meter Run #3 and Meter Run #4 to be disabled.
A status flag value = 1 (Partial B active) causes Meter Run #3 and Meter Run #4 to be
enabled and causes Meter Run #1 and Meter Run #2 to be disabled.

RAZ

Trapil operators can at any time choose to reset the inactive Partial Counter to zero by press-
ing the ‘RAZ" button’.

515
OMNICOM: Trapil Control

The RAZ command is edge triggered and in fact simply performs a ‘Batch End’ of the appro-
priate Meter Runs within the flow computer depending upon the true/false state of the ‘Active
Partial Status Flag’ i.e.:
A status flag value = 0 (Partial A active) causes the batch running on Meter Run #3 and
Meter Run #4 to be ended.
A status flag value = 1 (Partial B active) causes the batch running on Meter Run #1 and
Meter Run #2 to be ended.
The RAZ command also clears any Hydraulic Alarms and Heavy Hydraulic Alarms and
initializes the sampling process.

516
OMNICOM: Archive Maintenance

Archive Maintenance
Note: This screen is only available in the ONLINE mode.

Any changes made to the flow computer's configuration which involves the format of the data record,
number of records in an archive file, or the total number of archive files within the flow computer, will
cause the memory used to store the archive data to be re-initialized. This would cause all data stored
in archive to be lost. Therefore no changes to the target flow computers archive configuration will be
allowed unless automatic data archiving has been stopped and the archive configuration is enabled.

WARNING: The flow computer will not accept changes made to the archive setup at the time of a
'Transmit OMNI Configuration' upload unless the archiving feature has been turned off.

517
Diagnostics

I/O Overview 519


Topics HART Input Summary 520
System Information 522
WINPANEL 525
Test Communications Screen 531
OMNICOM: I/O Overview

I/O Overview
You must be connected and online with a flow computer for this selection to work.

The screen displays diagnostic information about the flow computer such as:
number and type of I/O modules fitted
status of digital I/O
current output percent of analog outputs
raw input signals coming into the flow computer
Virtual Inputs and their values (firmware versions 20.75.10, 22.75.10, 23.75.10, 24.75.10,
26.75.10, and 27.75.10 and higher)

Digital Inputs
In OMNICOM v1.55 and higher, both digital input and output LEDs are shown in green when TRUE.

In all versions of OMNICOM prior to v1.55, the digital input LEDs were shown in green when TRUE,
and the output LEDs shown in red when TRUE. This was changed because when visually looking at
the parallel LED for each channel on the Digital I/O board, red indicates a blown fuse.

Note: OMNICOM does not show the fuse condition as this information is not available via Modbus
points.

519
OMNICOM: HART Input Summary

HART Input Summary


OMNICOM must be online with a flow computer for this screen to be viewed (available with firmware
versions 20.75.01, 22.75.02, 23.75.01, 24.75.01, 26.75.01, and 27.75.04 and higher).

The screen displays diagnostic information about the HART devices connected to the flow com-
puter:
Input

An integer ranging from 25 to 88 representing the HART input number. The input also indic-
ates the poll ID for multidrop networks and indicates the variable type for multivariable net-
works.

I.e. if the input number was 27 and was the third input on a multidrop network, the display
would be "27 (3)" and for a multivariable network it would be "27 (TV)".

HART ID

A one byte number representing the manufacturer's code (HART revision 6 and lower) - or - a
two byte extended device type (HART revision 7 and higher). The ID is read directly from the
HART device.

Device ID

A three byte hexadecimal number representing the HART device ID read directly from the
HART device.

HART Rev

The HART software revision. This is read directly from the HART device.

Short Tag

An 8-byte alphanumeric text string that is read directly from the HART device.

HART Value

A float value that is read directly from the HART device. For point-to-point or multidropped
inputs, this is the primary variable (PV). For multivariable, this may be the PV, SV, TV, or QV
variable depending on which input (1-4) it is on the network.

HART Units

The units code read directly from the HART device and translated to text using the table depic-
ted in the HART Input Help File. If there is not a translation match, 'Unknown' is displayed for
the units.

520
OMNICOM: HART Input Summary

Field Device Status

The device status read directly from the HART device. The status is displayed in hexadecimal
and then translated into a text string (i.e. "01h - PV out of limits").

OMNI Tag

If the HART input is assigned, the 8-byte OMNI tag is displayed. If the tag is blank or the user's
authorization is Level B, a short description of the field (i.e. MR1-Temp) will be shown.

OMNI Variable

If the HART input is assigned, the current value of the variable in the OMNI will be displayed.

OMNI Units

If the HART input is assigned, the fixed or configured units of the variable in the OMNI will be
displayed (see table in the HART Input Help File).

Comm Status

The reported communications status will be displayed. It can be any one of the following:
Not Used
OK
Error (input row displayed in red)
No data available
Discovery (input row displayed in blue)

HART Discovery Button

When the discovery button is pressed, OMNICOM issues a command to the OMNI to discover
all the HART devices connected to the OMNI (regardless of whether they are assigned) for all
the possible physical HART inputs.

Warning: Discovery may momentarily interrupt data retrieval to assigned inputs and generate
alarms.

521
OMNICOM: System Information

System Information
The System Information section of Diagnostics provides the user with helpful information. Click on a
topic link to learn more.

Boolean and Variable Statement Results


Checksums

522
OMNICOM: Boolean and Variable Statement Results

Boolean and Variable Statement Results


This screen is only available online.

The user can view the results of the Boolean and Variable Statements.

A refresh of the statements and remarks can be made by pressing the 'Refresh Statements' button
to the left of the tables.

523
OMNICOM: Checksums

Checksums
This screen is only available online.

The checksums corresponding to the lists created in configuration are displayed along with a total
checksum.

If any of the checksums have changed, indicating a value of a configured register in the list has
changed, the word 'Changed' is displayed in red next to the list.

Note that there is also a 'Total Checksum' made up of the four individual checksums. If any of the indi-
vidual checksums change, that checksum shall also change. The total was added so that a system
can determine if any have changed with one register read.

The user may clear the changed status by pressing the 'Clear Changed Status' button.

Modbus Registers
2614 - Configuration List 1 - checksum change alarm flag
2615 - Configuration List 2 - checksum change alarm flag
2616 - Configuration List 3 - checksum change alarm flag
2617 - Configuration List 4 - checksum change alarm flag
2618 - Configuration Lists - Total checksum change alarm flag

2729 - Configuration List - checksum change acknowledge command

4641 - Configuration List 1 - checksum


4641 - Configuration List 2 - checksum
4641 - Configuration List 3 - checksum
4641 - Configuration List 4 - checksum
4641 - Configuration List - Total checksum

524
OMNICOM: WINPANEL

WINPANEL
Setup and Connect to a unit at a site. Click on the Diagnostics Icon or from the menu, Actions | Dia-
gnostics, and select WINPANEL from the tree on the left hand side of the screen. If the connection
is successful, the Flow Computer ID, Station ID, and Modbus ID displays on the OMNI bitmap.

Use the mouse, mouse wheel, and PC keyboard presses to access the OMNI.

Hotspots on the OMNI bitmap

Click on any button to execute that function on the OMNI.


Click above and below the OMNI display to scroll up or down.
Click on a line in the OMNI display to go to that line.
Click to the left or right of the OMNI display to go left or right one space.
Click on an OMNI LED:
Diagnostic – puts the OMNI in Diagnostic Mode
Program – puts the OMNI in Program Mode
Active Alarm – same as pressing the ‘Alarms’ and ‘Enter’ buttons on the keypad
Alpha Shift – same as pressing the ‘Alpha Shift’ buttons on the keypad

Use the PC Keyboard

ALT-B and CTRL-G - causes OMNI to beep


ALT-M - to access User Messages (remember the command line setting)
TAB - is the same as pressing ‘Prog’ button on the keypad
LEFT and RIGHT ARROW - scrolls cursor one position to left or right
UP and DOWN ARROW - scrolls display one line up or down
PAGE UP and DOWN - scrolls OMNI display 4 lines up or down
HOME and END - scrolls OMNI display to top and bottom of current list
DEL - delete character at cursor position.
BACKSPACE - remove character that is to left of cursor.
CAPS LOCK - locks Alpha Shift to red
All letters lower or upper case - automatically takes care of Alpha Shift however it takes
less time if it is set beforehand with CAPS LOCK.
All numbers are supported.

525
OMNICOM: Mimic OMNI Panel Beeper (Setup menu)

Mimic OMNI Panel Beeper (Setup menu)


If the site of the OMNI is not within earshot, it may be convenient to have the PC beep when the
OMNI Panel beeps.
To enable this function, click on the Setup menu and the select Mimic OMNI Panel Beeper.
When the function is enabled, there is a check mark next to the item on the menu.

526
OMNICOM: OMNI Keypad (View menu)

OMNI Keypad (View menu)


Click on this item to show the entire OMNI panel with keypad. To enable this function, click on the
View menu and the select OMNI Keypad. When the function is enabled, there is a check mark next
to the item on the menu.

There may be times when you just want to monitor the unit’s display. To disable the keypad, click
again. There is no check mark if the item is disabled.

Note: The window cannot be resized in this mode.

527
OMNICOM: WINPANEL Menu

WINPANEL Menu

The WINPANEL menu offers the following commands:

Setup Mimic OMNI Panel Beeper and Log Communications


View Show/Hide the OMNI Keypad and View Communications Log

528
OMNICOM: WINPANEL User Menu

WINPANEL User Menu

The WINPANEL User menu offers the following commands:

Setup Mimic OMNI Panel Beeper and Log Communications


View Show/Hide the OMNI Keypad and View Communications Log
User Message Send messages to the OMNI Panel

529
OMNICOM: User Message

User Message
Send a message to the OMNI panel display.

Enter the message you’d like to be displayed on the OMNI panel display.

Press [Send].

Press [Exit and Keep Message] if you want to leave the message up on the display.

Press [Cancel] to exit.

530
OMNICOM: Test Communications Screen

Test Communications Screen


Modbus Tester Screen. This screen is only enabled in the ONLINE mode.

The Modbus type, Modicon Compatibility, and Modbus ID are displayed for convenience but
the user may not modify them directly. For more information on configuring those items, please see
the help for the Setup Communications Screen.

Note that for Modicon Compatible units, the test program automatically subtracts one from the
register number and formats the protocol to conform with 16-bit integers.

If float data types are used, the float bytes are swapped from ‘aa bb cc dd’ to ‘cc dd aa bb’.

Fields:
OMNI

Select from the drop list the Function Code of the test message.

Note: Function Code 06 - Preset Single Register - is not supported for ASCII registers on an
OMNI 3000/6000.

Note that there is a ‘User Defined’ function code for any non-standard functions. If the user
selects ‘User Defined’, a box appears to enter the function code. The range for the user
defined function code is 1 to 127 (because of the exception response of 0x80 plus function
code). The default value is 255 to remind the user to enter a code.

Data Type

Select the Data Type from the drop list. This is how you would like the data to appear in the
‘Data Values’ box – it does not affect how the data is transmitted. Only data types appropriate
to the function code selected are listed. For more information, see help on Data Types.

Modbus Address (Custom Data Packet data types only)

If the "Custom Data Packet" data type is selected, the Modbus Address drop down box is
enabled. The Custom Data Packet data type is available for function codes "03", "06"
(Modicon only), and "16" (Modicon only). Select the Modbus address of the custom packet
you would like to work with. The selections are: 001, 201, and 401.

If the configuration of the OMNI has been read, the custom packets can be read and displayed
according to the configured format for each packet.

If the connection is Modicon compatible, writes are allowed and the data for the packet write
can be entered in the configured format for each packet. It is advised to first read the packet,
make the edits, and then perform the write.

531
OMNICOM: Test Communications Screen

For Modicon compatible connections, an address other than the packet address may be
entered with a specified number of registers. This is to allow reading/writing of individual
registers within the custom packet. For convenience, the Modbus address range of each
packet is provided in the Data Values display.

Register Number/Diagnostic Code

The field entry will either be labeled "Data Register" or "Diag. Code".

Most function types require a Register Number entry. Enter a value between 1 and
65535.

Note: the OMNI 3000/6000 does not allow a register number of zero.

Note: that for Modicon Compatible units, the test program automatically subtracts
one from the register number. Use the Database Browser to assist in selecting a
register.

For the Diagnostic function (08), the entry is the Diagnostics Code. Enter a value
between 0 and 65535.

Note: for an OMNI 3000/6000 flow computer, the only diagnostic code supported is 0.
Available with 27.75.06 and higher, diagnostic code 2 is also supported and returns
zeros for the response.

Number of Points/Values or Data Value

For coil type function codes, the entry is the Number of Points.

For register type function codes, the entry is the Number of Values.

For the Diagnostic function (08), the entry is the Data Value to be sent. Note: for the OMNI
3000/6000 flow computers, the data value can be anything. If the same data value is returned
or "looped back" from the flow computer, then the test passed.

String Size (ASCII string data types only)

The ASCII String data type also requests the String Size. For example if you had three 8-
character ASCII strings to read, you would enter a "3" for the "Number of Values" field and an
"8" for the "String Size" field.

Data Values

The Data Values box is used to enter/display the values transmitted/received from the unit in
the format previously selected in the data type field. Separate multiple data values using the
symbol displayed in the label (it is the list separator configured for your system - in most cases
it is a comma).

Repeat Delay

532
OMNICOM: Test Communications Screen

If an item is going to be transmitted repeatedly, this would be the approximate amount of time
after the response has been received that the system will wait before repeating the trans-
mission.

It can also be used in conjunction with the Register List. This is the approximate amount of
time that the system will wait before transmitting the next item in the list. If it is the last item in
the list and list repeat is enabled, it is the amount of time the system waits before re-trans-
mitting the first item in the list.

CRC/LRC

The user may select how the CRC/LRC is calculated. Automatic means the system cal-
culates it automatically and appends it to the transmit message.
If the user selects User Defined, a box appears for the user to enter the CRC/LRC in two hex
bytes (with no space in between). For example if you wanted to send a CRC of ‘E2 9D’, enter
it as ‘E29D’.
No CRC/LRC is sent if a setting of Not Used is selected.

Commands:
Transmit

Press Transmit to send the test message to the unit. The actual message sent is shown in the
Transmit Message box. The response message is displayed in the Receive Message box.
If the Modbus type is ASCII, for convenience the actual ASCII character is also shown on a
separate line.

Repeat/Stop

Press Repeat to send the test message continuously.


Press Stop to terminate the repeat send.

Register List/Add to List/Apply Edit

The Register List allows you to set up a list of registers for transmission. See the help for
Register List for more information.

If the Register List dialog is already open, set up a register item in the Test Communications
Screen and press Add to List to add a new register to the list.

If the Register List dialog is already open and an item on the Register List dialog is selected for
editing, make any changes in the Test Communications Screen and press Apply Edit to
amend the list item.

Abort

Press Abort to terminate a transmission.

533
OMNICOM: Test Communications Screen

Convertor

A handy number convertor is available by pressing Convertor. Note this screen can be
moved around and remain up while more testing is done. For more information, see the help
for Convertor.

Comms Log

You can view the Communications Log by pressing Comms Log. Note this screen can be
moved around and remain up while more testing is done. For more information, see the help
for Communications Log.

534
OMNICOM: Register List

Register List
The Register List screen allows you to set up a list of items to be transmitted in succession to the con-
nected unit. The list can be repeatedly sent based on a number of times or a date/time range. The
register list can be saved to a file on disk.

The Register List screen can only be enabled by pressing the Register List button in the Test Com-
munications screen. Set up a register transmission in the Test Communications screen and then add
the register to the register list by pressing the Add to List button in the Test Communications
screen.;

To edit an item, double click on an item in the register list - or - select the item or items and press the
Edit button. The first selected item's information is displayed in the Test Communications screen.
Make any changes to the item in the Test Communications screen and then press the Apply Edits
button in the Test Communications screen. The information changed is updated in the register list for
all the selected items.

You may drag and drop items in the register list to change the list order.

The following is description of the fields on the screen:

Register List

The register list shows a summary of a transmission item in the list that was set up in the Test
Communications screen:
Modbus ID
Function Code
Register
Register Count
Data Type- if the data type is a string, the data type is "ASCII-x" where 'x' is the string
size.
Protocol - the protocol is a combination of the Modbus Type and the first character of
the Addressing Mode.
Errors - an error count is provided for each item in the list. The error count is increased
for every communications or data processing error encountered during the trans-
mission.
Data Values - either the values received if the function is a read-type function or the
data sent if the function is a write-type function. If the function code is "User Defined"
the data values are always the data sent.

The information saved from the Test Communications screen but not shown in the register list
includes:
Repeat Delay
CRC Type
User Defined CRC

Repeat Duration

535
OMNICOM: Register List

The user may select one of two methods to indicate when the repeat process should stop:

Number of Times - enter the number of times you would like the list to be transmitted.
If a zero is entered, the list will be transmitted indefinitely.

Date/Time Range - enter a start date and time and a stop date and time. The dates
and times are based on your PC"s date and time.
Use the drop down on the date fields to see a calendar. Click on "Today" at the
bottom of the calendar to select the current date or click on the date you wish to
use.
Use the up and down arrows on the time fields to set the hour and minute based
on a 24 hour clock where 00:00 is midnight. You may also enter a number in each
of the fields.

Ignore Errors

If the box is not checked and there are any errors in the transmission of an item in the register
list, the message is displayed and all transmissions are stopped.

If the box is checked and there are errors in the transmission of an item in the register list, no
messages are displayed and transmissions continue as normal.

An error count is provided in the register list and is updated as errors occur.

The following is a description of the buttons on the screen:

Open File

Pressing the Open File button brings up the standard Open File dialog. You may open an
existing Register List file (default extension ".orl") for editing. The contents of the file are dis-
played in the register list.

Save File

You may save the contents of the register list by pressing the Save File button. This brings up
the standard File Save dialog. (The default file extension is ".orl".)

Edit

To edit an item, double click on an item in the register list - or - select the item or items and
press the Edit button. The first selected item's information is displayed in the Test Com-
munications screen.

Make any changes to the item in the Test Communications screen and then press the Apply
Edits button in the Test Communications screen. The information changed is updated in the
register list for all the selected items.

536
OMNICOM: Register List

Copy

To copy register list entries, click or select the items in the register list. Press the Copy button
or select Copy from the right-click menu.

If there are more than one register list entries, you will be asked if you want to append the
copied items to the end of the list. If you select Yes, all the selected items are copied and
placed at the end of the list. If you select No, each copy is placed directly after the selected
item in the list. If you select Cancel, no action is taken.

Delete

To delete items, click on the item or items in the list and press the Delete button. You will be
asked to confirm each item to be deleted.

Transmit

Pressing the Transmit button, transmits the items in the list in order one time.

Note: It is probably a good idea to transmit the list one time to test if all items in the list are valid
before using the Repeat button.

Repeat

Pressing the Repeat Button transmits the list continuously in sequence until the number of
times is reached (if non-zero), the stop date and time is reached or the Stop Button is
pressed.

Note: the Repeat button becomes the Stop button when active.

Clear Errors

The user may select items and click on Clear Errors to reset the error count to zero for all the
selected items. If no items are selected when Clear Errors is pressed, all the error counts are
reset to zero.

Note: There is a right-click menu that provides an alternative to using the buttons.

537
OMNICOM: Data Types (Test Comms Screen)

Data Types (Test Comms Screen)


In the Test Comms Screen, the data types represents the format of the data when it is entered for a
write or how it is displayed for reads. Once you enter the information and/or make your selections,
press the [Apply] button to set.

The following is a description of each type:

Boolean

Enter numbers as 1’s and 0’s. For example if you wanted to Force One Coil (05) and set the value to
be ‘on’, then enter the data value as a ‘1’.

For the Force Multiple Coils (15), enter the values beginning with the first point. For example register
1001 we would like to set 1001, 1004, and 1005. In the Data Values, enter ‘1,0,0,1,1’.

If you were to read those coils back using a Read Coil Status function, the data would be received as
a '0x19' but is displayed as ‘1, 0, 0, 1, 1’ showing coils 1001, 1004, and 1005 are set.

Integers

Integers can be signed or unsigned based on what has been selected. Enter the number as an
integer.

Floats

Floats are entered as numbers with up to 7 significant digits.

Floats can also be displayed in exponential notation.

Note that for Modicon Compatible units, the test program automatically subtracts one from the
register number and formats the protocol to conform with 16-bit integers. Float bytes are swapped
from ‘aa bb cc dd’ to ‘cc dd aa bb’.

For example: The float number 72.58 is converted to:

RTU (to/from OMNI) (Big Endian) 91 28 F6


Modicon (to/from OMNI) F6 42 91

Doubles

Doubles can be user selectable 15-17 significant digits.

ASCII Strings

For ASCII strings you also need to enter the length of one string.

538
OMNICOM: Data Types (Test Comms Screen)

For example if you had three 8-character ASCII strings to read, you would enter a "3" for the "Num-
ber of Values" field and an "8" for the "String Size" field.

IP Address (IPV4)

The IP Address is entered/displayed in IPv4 dotted decimal notation. The value read/written to the
associated register is a four byte unsigned integer in Motorola (Big-Endian) format.

For Example: IPv4 in dotted decimal = 216.136.87.229


unsigned integer in Motorola hex = D8 88 57 E5

Custom Data Packet

The "Custom Data Packet" data type is available for function codes '03' and '16' (Function Code 16
is for Modicon only).

If the configuration of the OMNI has been read, the custom packets can be read and displayed
according to the configured format for each packet.

Note: If the packet size is greater than 250 bytes and protocol is not Modicon compatible, only the
data up to 250 bytes or fewer (if would incur partial data values) can be read.

If the connection is Modicon compatible, to read the entire packet, select the Modbus Address from
the drop down and then enter zero for the data register number. Modbus Tester will automatically
set the register count to the maximum 16-bit integers for a read.(125). If the packet size is greater
than 250 bytes, then multiple reads are required using subsequent register numbers to get the entire
packet.

If the connection is Modicon compatible, writes are allowed and the data for the packet write can be
entered in the configured format for each packet. It is advised to first read the packet, make the edits,
and then perform the write. Note: It is strongly recommended to use the direct addressing
with code 15 to perform writes to boolean data types.

For Modicon compatible connections, an address other than the packet address may be entered
with a specified number of registers. This is to allow reading/writing of individual registers within the
custom packet.

539
OMNICOM: Diagnostic Convertor

Diagnostic Convertor
Number Convertor to convert numeric data types to Hexadecimal format and back. Note this screen
can be moved around and remain up while more testing is done.

Select the data type you would like convert to or from.

Select the hexadecimal format you would like to convert to or from. Note: Modicon format is only
available for floats and doubles.
Motorola (Big Endian)
Intel (Little Endian)
Modicon

Enter the data you would like converted. Clear the other field you would like the conversion for.

Press [Convert] and the converted number is displayed.

For example: The float number 300.0 is converted to:

Motorola 43 96 00 00
Intel 00 00 96 43
Modicon 00 00 43 96

For example: The IP Address 216.136.87.229 is converted to:

Motorola D8 88 57 E5
Intel E5 57 88 D8

540
Security

This menu is only available online for firmware versions XX.75.10 and
higher and provides a means for configuring user and port security in
the system.

User Security is for front panel and OMNICOM access. Port Security is
for other devices such as SCADA or HMI systems.

Topics
Administrator Functions 542
Port Security 547
User Permissions 545
User Security 543
OMNICOM: Administrator Functions

Administrator Functions

This screen is only available online for firmware versions XX.75.10 and higher.

The administrator can select if users are able to change their own passwords in the system. The
default is no.

The administrator can export security settings from an OMNI and save it to a file.

They can also connect to an OMNI, import a file, and transfer the security settings to the OMNI. The
administrator will be asked if they wish to override the administrator settings that are currently in the
OMNI. The default is no.

542
OMNICOM: User Security

User Security
This screen is only available online for firmware versions XX.75.10 and higher.

The administrator may configure their own security plus 16 additional users.

The user password is used at the OMNI front panel and when using OMNICOM to access the OMNI.

Note: OMNICOM does not use the configured port security levels and port security passwords and
always uses the configured OMNICOM permissions and configured OMNICOM passwords instead.
Non-OMNICOM software packages accessing the OMNI, even when using the same port as
OMNICOM, cannot use the OMNICOM permissions and OMNICOM passwords and instead must
use the configured port security levels and configured port security passwords set up under each
port’s configuration. For more information please reference the help for Port Security.

Password

For users 01-16, enter a 2-6 character alphanumeric password. For the Administrator user, enter a
1-6 character alphanumeric password.

The character set is limited to those that can be entered on the front panel except that spaces
cannot be used. Only uppercase letters are supported on the front panel so OMNICOM will
automatically translate any entered lowercase letters to uppercase.
A "blank" password is considered an inactive user. Only the Administrator can set a blank
password for purposes of disabling a user. The Administrator password cannot be blank.
The password will show as six (6) asterisks to maintain security.
The Administrator password cannot begin with the numbers "01" through "16".

The password entry for OMNICOM or the OMNI Front Panel for users 01-16 is the two digit user
number plus the password. Examples of the password used for log in are displayed for convenience:

User 01 with Password 234567 enters the following to log in: 01234567
User 01 with Password ABCD enters the following to log in: 01ABCD

User 13 with Password 234567 enters the following to log in: 13234567
User 13 with Password ABCD enters the following to log in: 13ABCD

The password entry for OMNICOM and the OMNI Front Panel for the Administrator is only the pass-
word with no prefix.

If the administrator has set the flag to allow users to change their own passwords, users may change
their passwords by entering a 2-6 character alphanumeric password. However they are not allowed
to reset it to a blank password. Only the Administrator can set a blank password for purposes of dis-
abling that user.

Note: Only the Administrator can change their OMNICOM/Front Panel password from the front
panel of the flow computer, by first entering their current password, clearing it, then entering the new

543
OMNICOM: User Security

password. Users 01 through 16 cannot change their password from the front panel and must log in
with OMNICOM to change their OMNICOM/Front Panel password.

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 alphanumeric characters can be entered.

Name

Enter a maximum 16-character alphanumeric First Name and maximum 16-character alphanumeric
Last Name for the user. The first and last names are displayed in the OMNICOM status bar after log
in.

Front Panel Access

Select the access level this user will have when entering data at the front panel or via WINPANEL.
The following are the selections:

None (default)
Level 2
Level 1A
Level 1
Privileged

Note that the administrator is automatically set to Privileged and cannot be changed. Please refer to
the manual for definitions for the front panel levels.

If the administrator allows the user to change their own password (see the Administrator Functions
help), when the user is logged in, only the password can be modified. Once the user enters the pass-
word, they are required to enter it again to confirm the entry. The Front Panel Access permission is
also shown however it cannot be changed.

544
OMNICOM: User Permissions

User Permissions
This screen is only available online for firmware versions XX.75.10 and higher.

The administrator can view and edit the permissions for each user except their own. The admin-
istrator's permission is fixed as "Full Access".

The users can only view their permissions.

Access Type
Select the type of access for the user:

Full Access (Similar to a "Level A" password - user has all permissions)
Read Only (Similar to a "Level C" password - user can view only - select which items
you want the user to be able view)
Custom (user can view and edit - select which items you want the user to be able to
edit)

Note: The administrator's permission is fixed as "Full Access".

Permissions
The following are the configurable permissions (depending on the access type):

Operate - Retrieve Reports


Operate - Retrieve Archives
Operate - Archive Maintenance
Operate - Batch Control
Operate - Prove Control (not available for application 21)
Diagnostics - Test Communications

Transmit configuration to an OMNI


Receive Configuration from the OMNI

If 'Receive Configuration from the OMNI' is selected, the user can further refine what can be
viewed by a 'Read Only' user or edited by a 'Custom Access' user:

Configuration - General Setup


Configuration - OMNI I/O
Configuration - Communications Ports
Configuration - Meter Runs
Configuration - Station
Configuration - Prover (not available for application 21)
Configuration - Products
Configuration - PID Control
Configuration - Boolean and Variable Statements
Configuration - Checksum Lists and Audit Configuration (Checksum Lists not available
for application 21)

545
OMNICOM: User Permissions

Configuration - K-Factors, Meter Factors, and Density Correction Factors (K-Factors


not available for application 21)
Custom Report Templates (Report Template Editor)

If a user has "Read Only" access, and has permission for an item, the item will appear on the Tree
but they will only be able to view the data. If the user does not have access to an item, it will not
appear on the tree. If it is an item on a screen with other items, it will be hidden. A note is shown on
the screen indicating the user does not have permission to view some items.

If a user has 'Custom' access, and has permission for an item, the item will appear on the Tree and
they will be able to view and edit the data. If the user does not have access to an item, it will not
appear on the tree. If it is an item on a screen with other items, it will be disabled and shown in yel-
low. A note is shown on the screen indicating the user does not have permission to edit some items.

If the administrator selects "Full Access" for a user, the user will have full access to all of the fea-
tures of OMNICOM. All the permissions and the "Select All" and "Reset All" buttons are disabled.

If the administrator selects 'Read Only" for a user, the following permissions are not allowed:
Operate - Archive Maintenance
Transmit configuration to an OMNI

For "Read Only" and "Custom", the permissions may be individually selected.

If "Receive Configuration from the OMNI" is selected, the configuration items below "Receive Con-
figuration from the OMNI" are enabled. If it is deselected, all the items below it are deselected and dis-
abled.

If "Custom Report Templates" is selected:


The "Report Template Editor" is enabled on the toolbar and Action menu
The option to "Work Online with individual Templates" without having to read all configuration
is enabled when the Report Template Editor tree item is expanded.
A user with "Custom" access can edit the templates and a user with "Read Only" access can
only view the templates.

Pressing 'Select All' will select only the enabled items.

Pressing 'Reset All' deselects all items.

546
OMNICOM: Port Security

Port Security
This screen is only available online for firmware versions XX.75.10 and higher.

There is port security for each of the configured ports in the system.

Only the administrator may configure the port security.

Security can be enabled for a port. The default is disabled.

Note: OMNICOM does not use the configured port security levels and port security passwords and
always uses the configured OMNICOM permissions and configured OMNICOM passwords instead.
Non-OMNICOM software packages accessing the OMNI, even when using the same port as
OMNICOM, cannot use the OMNICOM permissions and OMNICOM passwords and instead must
use the configured port security levels and configured port security passwords set up under each
port’s configuration.

Note: Port Security is automatically disregarded for Gas Chromatograph and Allen-Bradley ports.

Note: In OMNI flow computers acting as a Peer to Peer master, the flow computer automatically dis-
regards any security settings on the Peer to Peer serial port. If a slave OMNI flow computer's serial
port is connected to a Peer to Peer master OMNI flow computer's serial port, ensure the security is
not configured on the slave flow computer serial port so that communications will be possible.

There are eight (8) password entries configurable for each port. Each entry contains the following
items:

Port ID

For every password entry, there is a fixed port identifier as 'Pne-' where 'n' is the port number (1-6)
and 'e' is the password entry (1-8).

For example: for Port 4 the Port IDs would be: P41-, P42-, ... P48-

Audit ID

Enter a maximum 12-character alphanumeric Audit ID.

The Port ID in combination with the Audit ID is used to log changes in the Audit Log when the device
connected to the port makes a change.

ASCII Password

Enter a 1-8 character alphanumeric password to be used when the device connects to the OMNI.
The device can log in using this password or the integer password. Note that a blank password is
considered an inactive password or a log off.

547
OMNICOM: Port Security

The passwords are case sensitive and can be any ASCII character except spaces. The
ASCII passwords cannot be duplicated on a port.

To access the port externally, write the ASCII-8 password using Modbus Index 4850 with Modbus
function code 16.

Integer Password

Enter a 32-bit integer to be used when the device connects to the OMNI ranging from zero to
9999999. The device can log in using this password or the ASCII password. Note that a zero pass-
word is considered an inactive password or a log off.

The integer passwords cannot be duplicated on a port.

To access the port externally, write the 32-bit integer password using Modbus Index 5848 with Mod-
bus function code 06 or 16.

Time Out (seconds)

Enter the inactivity time in seconds for this password and this port. It ranges from zero to 120 with a
default of zero. A zero entry means the password will not time out.

Port Security Level

The port security levels are the same as the levels that exist in the firmware prior to XX.75.10. The
selections are:

Disabled
Level A - Full Access
Level B - Operator Functions such as controlling the batches and proving.
Level C - Read Only Access

548
OMNICOM: Enter Password

Enter Password
This screen is only available online for firmware versions XX.75.10 and higher.

Enter your User Password.

For Users 01-16, enter the two-digit user number plus password.

For example:

User 07 with password ABC123 enters the following to log in: 07ABC123

User 15 with password 4S8T enters the following to log in: 154S8T

549
Menus

File Menu Commands 551


Topics Edit menu commands 565
View menu commands 580
Action menu commands 587
Window menu commands 600
Help menu commands 604
OMNICOM: File Menu Commands

File Menu Commands

The File menu offers the following commands:

Menu item Description


New Initializes OMNICOM and creates an empty configuration with default settings.
Open Load an existing OMNI configuration.
Close Close an open document.
Save Save the active document to its current name and directory.
Save As Save and name the active document.
Print Setup Select a printer and a printer connection.
Export Export template data to file
Recent File Select from the most recent files used list.
Exit End the OMNICOM session

551
OMNICOM: New Configuration (File menu)

New Configuration (File menu)


Initializes OMNICOM and creates an empty configuration with default settings.

Shortcuts

Toolbar: 
Keys: CTRL+N

552
OMNICOM: File Application

File Application

OMNI Type

Select which type of OMNI you have. The choices are 3000 or 6000.

OMNI CPU

Select the type of CPU board you have. The choices are a 68-6001 or 68-6201.

If 68-6001 is selected, the firmware version is defaulted to 74.


If 68-6201 is selected, the firmware version is defaulted to 75.

Application

Select the application of OMNICOM to match the application of the OMNI flow computer firm-
ware.

Version and Revision

The default, shown as "20.74.---" for example, will enable all features for the latest firmware
version that OMNICOM supports for the application selected.

Press the Select button if you would like to specify a specific version and revision of OMNI firm-
ware. OMNICOM only shows or enables the items available for that application, version and
revision on each screen.

For example for firmware version: 20.74.30:


application = 20
version = 74
revision = 30

553
OMNICOM: File Version and Revision

File Version and Revision


All of the firmware versions available that this version of OMNICOM supports for the application
selected is displayed in the list. Select a specific version and revision of OMNI firmware from the list.

You may double click on an item - or - single click and press OK.

554
OMNICOM: Open Existing Configuration File (File menu)

Open Existing Configuration File (File menu)


Provides a ‘File Open’ control dialog allowing you to load an existing OMNI configuration from disk.
Use this command to open an existing document in a new window. You can open multiple doc-
uments at once. Use the Window menu to switch among the multiple open documents.

Shortcuts

Toolbar: 
Keys: CTRL+O

The following options are then displayed to allow you to specify which file to open:

File Name

Type or select the filename you want to open. This box lists files with the extension you select
in the List Files of Type box.

List Files of Type

Select the type of file you want to open.

Drives

Select the drive in which OMNICOM stores the file that you want to open.

Directories

Select the directory in which OMNICOM stores the file that you want to open.

Network

Choose this button to connect to a network location, assigning it a new drive letter.

555
OMNICOM: Close Command (File menu)

Close Command (File menu)


Use this command to close all windows containing the active document. OMNICOM suggests that
you save changes to your document before you close it. If you close a document without saving, you
lose all changes made since the last time you saved it. Before closing an untitled document,
OMNICOM displays the Save As dialog box and suggests that you name and save the document.

You can also close a document by using the Close icon on the document's window, as shown below:

556
OMNICOM: Save Command (File menu)

Save Command (File menu)


Use this command to save the active document to its current name and directory. When you save a
document for the first time, OMNICOM displays the Save As dialog box so you can name your doc-
ument. If you want to change the name and directory of an existing document before you save it,
choose the Save As command.

Shortcuts
Toolbar: 
Keys: CTRL+S

557
OMNICOM: Save As Command (File menu)

Save As Command (File menu)


Use this command to save and name the active document. OMNICOM displays the Save As dialog
box so you can name your document.

To save a document with its existing name and directory, use the Save command.

558
OMNICOM: File Save Template

File Save Template


When the user is on the Report Template Editor Tree and has selected a report, the user may save
that template using the "File | Save Template As..." command from the Main Menu.

559
OMNICOM: File Import Template

File Import Template


When the user is on the Report Template Editor Tree and has selected a report, the user may open
a template using the Import Template..." command from the File Menu.

560
OMNICOM: File Export Template

File Export Template


When the user is on the Report Template Editor Tree and has selected a report, the user may save a
template using the "File | Export Template..." command from the Main Menu.

561
OMNICOM: Print Setup Command (File menu)

Print Setup Command (File menu)


Use this command to select a printer and a printer connection. This command presents a Print
Setup dialog box, where you specify the printer and its connection.

562
OMNICOM: 1, 2, 3, 4 Command (File menu)

1, 2, 3, 4 Command (File menu)


Use the numbers and filenames listed at the bottom of the File menu to open the last four documents
you closed. Choose the number that corresponds with the document you want to open.

563
OMNICOM: Exit Command (File menu)

Exit Command (File menu)


Use this command to end your OMNICOM session. You can also use the Close command on the
application Control menu. OMNICOM prompts you to save documents with unsaved changes.

Shortcuts
Mouse: Double-click the application's Control menu button.

Keys: ALT+F4

564
OMNICOM: Edit menu commands

Edit menu commands

The Edit menu offers the following commands:

Menu item Description


Undo Reverse previous editing operation.
Cut Deletes data from the document and moves it to the clipboard.
Copy Copies data from the document to the clipboard.
Paste Pastes data from the clipboard into the document.
Preferences Select folder preferences for file actions and report naming convention.
Log Com- Activates the logging function so that all communications are logged to
munications file.
Setup Sites Edit communications sites, units, and communications parameters

565
OMNICOM: Edit Undo

Edit Undo
Reverse previous editing operation.

Shortcuts
Toolbar:
Keys: CTRL+Z

566
OMNICOM: Cut command (Edit menu)

Cut command (Edit menu)


Use this command to remove the currently selected data from the document and put it on the clip-
board. This command is unavailable if there is no data currently selected.

Cutting data to the clipboard replaces the contents previously stored there.

Shortcuts
Toolbar: 
Keys: CTRL+X

567
OMNICOM: Copy command (Edit menu)

Copy command (Edit menu)


Use this command to copy selected data onto the clipboard. This command is unavailable if there is
no data currently selected.

Copying data to the clipboard replaces the contents previously stored there.

Shortcuts
Toolbar: 
Keys: CTRL+C

568
OMNICOM: Paste Command (Edit menu)

Paste Command (Edit menu)


Use this command to insert a copy of the clipboard contents at the insertion point. This command is
unavailable if the clipboard is empty.

Shortcuts
Toolbar: 
Keys: CTRL+V

569
OMNICOM: Preferences (Edit Menu)

Preferences (Edit Menu)


The user may set up their folder preferences for files such as saved reports or archive data.

Settings
Reports

Enter your preference for the reports folder when saving reports in OMNICOM. The
default is the "Reports" folder under the folder where OMNICOM is installed.

Chose whether to bypass the condensed mode checking when printing a report from
OMNICOM. If the checking is enabled (default), the criteria is:
if printing in Portrait Mode, the maximum characters in a line is 80
if printing in Landscape Mode, the maximum characters is 120.
If this criteria is exceeded, the user is asked if they would like the report printed in con-
densed mode.

Select your preference for the report file name when saving reports in OMNICOM. The
reports can be saved using either the Computer ID or the File Name with either the
OMNICOM DOS extension or with the date and time appended with a ".txt" extension.
(The sample shown is for the Snapshot Report.) The default is the Computer ID with
the DOS extension.

Archives

Enter your preference for the Archive Folder when retrieving and saving archive data. The
default is the "Archives" folder under the folder where OMNICOM is installed.

Note: This selection used to be located in the Operate menu under Retrieve Archive Data -
Archive Path.

Communications

The settings file holds all of the communication Sites configuration. If the user changes the
folder for the settings file, OMNISettings.dat, the user has the option of saving their current set-
tings to the new folder or using the settings from the new folder. The default is the folder
where OMNICOM is installed.

The Communications Log folder is used to store communications logs that are periodically
saved when Log Communications is enabled. The default is the "CommsLogs" folder under
the folder where OMNICOM is installed.

The logs can be viewed from the Comms Log entry in the View menu. The default is the
"CommsLogs" folder under the folder where OMNICOM is installed.

570
OMNICOM: Preferences (Edit Menu)

Communications Statistics can be viewed from the Comms Statistics entry in the View menu.
The user has the option to clear the comms statistics whenever a connection is made. When
the box is checked, the statistics are cleared on connect. The default is checked or cleared on
connection.

Configuration

The Configuration File folder is the folder last used when opening or saving a configuration
file. The default is the folder where OMNICOM is installed.

Advanced and Advanced 2 Configuration

The Advanced User configuration is enabled with the command line switch "-AU".

The last folders used when importing and exporting files used the configure the named con-
figuration section. The default folder for all is the folder where OMNICOM is installed. The fol-
lowing are the configuration sections supported:
Ethernet Configuration
Product Configuration
Fluid Component Analysis
User Displays
Boolean/Variable Statements
Custom Packets
Archives
Allen-Bradley

Templates

The Template folders are the last folders used when importing and exporting templates. The
default import folder is the "Sample Templates" folder under the folder where OMNICOM is
installed. The default export folder is the folder where OMNICOM is installed.

Register List

The Register List folders are the last folders used when importing and exporting the register
list files used in Modbus Tester. The default is the "RegList" folder under the folder where
OMNICOM is installed.

571
OMNICOM: Log Communications (Edit menu)

Log Communications (Edit menu)


To enable this function, click on the  Edit menu and the select Log Communications.

When the function is enabled, there is a check mark next to the item on the menu.

To view the log, click on the View menu and select Comms Log. For more information, please see
the help for the Communications Log.

572
OMNICOM: Setup Sites (Edit menu)

Setup Sites (Edit menu)


The Setup Sites screen is used to configure the connection sites and units. You can add, edit, delete,
or reorder the units within the site.

Settings
The items listed below are descriptions of each setting option within the Sites dialog. Click on a set-
ting for more information.

Search

The user can enter a search string (part of a name, IP address, ID number, port number, phone num-
ber, etc...) and press the Search button, press Enter, or press F3 to initiate the search. If a match is
found, the site or unit is highlighted in the site and unit tree. If it is not found, a message is displayed.

To find the next match, press the Search button, press Enter, or press F3.

Add Site

To add a site press Add Site or click your right mouse button and select Add Site from the short cut
menu.

Edit Site

To edit an existing site double click on a site in the list or click once on a site in the list and press Edit
Site or click the right mouse button on a site in the list and select Edit Site from the shortcut menu.

Delete Site

To delete an existing site, click once on a site in the list and press Delete Site or click the right mouse
button on a site in the list and select Delete Site from the shortcut menu.

Re-order Site

To re-order the site list, click on a site or unit in the list and while holding down the left mouse button,
drag the item where you would like and release the left mouse button.

Convert Site File

Pressing this button brings the user to a standalone Convert Site utility. The user can export the
OMNICOM site file to a tabbed delimited file or into a Modbus Tester file. It can also convert a tabbed
delimited file into an OMNICOM site file or a Modbus Tester file into an OMNICOM site file.

573
OMNICOM: Setup Sites (Edit menu)

*Note: The Setup Communications Screen is displayed if the user is adding or editing a site. Follow
the instructions for the Setup Communications Screen.

574
OMNICOM: Setup Communications (Edit | Setup Site )

Setup Communications (Edit | Setup Site )


The Setup Communication Screen is used to configure communications parameters within
OMNICOM to establish communications with an OMNI. Parameters include: Baud Rate, Data Bits,
Stop Bits and Parity settings.

WARNING: Changing the parameters for the port you are connected to will cause communications
with the flow computer to be lost.

Settings
The items listed below are descriptions of each setting option within the dialog. Click on a setting for
more information.

Media Type

The connection media. The four choices are Direct, Modem, Satellite, and TCP/IP. The
default is Direct.

Site Name

Enter a description of the site.

Units

Add Unit

To add a unit press Add Unit or click your right mouse button and select Add Unit
from the shortcut menu.

Edit Unit

To edit an existing unit, double click on a unit in the list or click once on a unit in the list
and press Edit Unit or click the right mouse button on a unit in the list and select Edit
Unit from the shortcut menu.

Delete Unit

To delete an existing unit, click once on a unit in the list and press Delete Unit or click
the right mouse button on a unit in the list and select Delete Unit from the shortcut
menu.

Re-order Unit

575
OMNICOM: Setup Communications (Edit | Setup Site )

To re-order the unit list, click on a unit in the list and while holding down the left mouse
button, drag the item where you would like and release the left mouse button.

The Setup Unit Screen is displayed if the user is adding or editing a unit.
Follow the instructions for the Setup Unit Screen.

Direct, Modem, or Satellite Connections

Phone Number or Satellite Number – (Only shown for Modem and Satellite) - the
number to dial for the connection. You may enter dashes between the numbers.

Comm Port – the serial port on the PC to be used for the connection. The program
automatically lists the available ports on your PC. The default is the first port on the list.

Baud Rate – communications speed in bits per second. The values range from 300 to
38400. The default is 9600.

Data Bits – a group of bits used to represent a single character of data for trans-
mission. The choices are 7 or 8. The default is 8 for all media types except Satellite
which is 7.

Stop Bits – a bit that signals the end of a character. The choices are 1 or 2. The default
is 1 for all media types except Satellite which is 2.

Parity – method of error checking the transmission. The choices are Even, Odd, and
None. The default is None for all media types except Satellite which is Even.

Modem Settings – (only shown for Modem and Satellite) press this button to go to the
Setup Modem Screen.

485 2-Wire – (only shown for Direct) – check this box if you have a 2-wire 485 con-
nection to the OMNI.

TCP/IP Connections

(there are no additional fields)

576
OMNICOM: Setup Modem (Edit | Sites Screen )

Setup Modem (Edit | Sites Screen )


Use this menu to configure the modems.

Settings
The items listed below are the settings covering each field within the Setup Modem Screen. Click on
the setting for more information.

Initialization String

The string sent to the modem to ready the modem for communications.
The default string is: AT &F E0 M1

AT – attention (if you omit this command, it is inserted for you automatically)
&F – restore factory defaults
E0 – echo off (helps to speed communications)
M1 – speaker volume is on until a connection is made

Cancel the call if not connected within XX seconds

The default is 60 seconds. After a call has been dialed, the program aborts the call process if a
connection was not established before the connection timeout.

Wait before redialing

The default is 10 seconds. A call has been made but a connection was not established before
the connect timeout. The program waits these number of seconds before redialing the num-
ber.

Disconnect the modem after XX minutes

The default is 15 minutes. If a connection is established via modem, the program automatically
disconnects after this period of inactivity.

Defaults

Restore the default values.

577
OMNICOM: Setup Unit

Setup Unit
The Setup Unit Dialog is for the initial setup of a unit to be used under your site setup.

Settings
The items listed below are the settings covering each dialog within the Setup Unit. Click on the set-
ting for more information.

Unit Name

Enter a description of the unit.

Modbus ID

The unit’s Modbus ID or address. Click on the up arrow to increase the number and the down
arrow to decrease the number. You may also just enter in a number directly. The ID can range
from 1-255. The OMNI 3000/6000 can only accept an ID up to 247. If you enter a value
greater than 247, a caution message is displayed however you are not prevented from enter-
ing a value up to 255. The default value is 1.

Modbus Type

Modbus Type is the Protocol Format: The choices are RTU or ASCII and Modbus/TCP (avail-
able with Media Type TCP/IP). The default is RTU for all media types except serial Satellite
which is ASCII.

Modicon Compatible

Note that for Modicon Compatible units, OMNICOM automatically subtracts one from the
register number and formats the protocol to conform with 16-bit integers. If float data types
are used, the float bytes are swapped from ‘aa bb cc dd’ to ‘cc dd aa bb’.

The default is not compatible.

Retries

The number of times a message is re-sent if no response or an invalid response is received by


the unit. The default is 2.

578
OMNICOM: Setup Unit

Direct, Modem, or Serial Satellite Connections

Initial Character delay – the amount of time in milliseconds the PC waits for a response from
the unit. Defaults are automatically set based on media type and for Direct connections baud
rate is also a factor.

Character Delay – the amount of time in milliseconds allowed between characters in a


response from the unit. Defaults are automatically set based on media type and for Direct con-
nections baud rate is also a factor.

TCP/IP Connections

TCP/IP Connections  Connection Timeout – the amount of time in milliseconds to wait


before a connection attempt is aborted. The default is 5000ms. (Note: If VSAT com-
munications are used with a TCP/IP connection, we suggest starting with a connection
timeout of at least 10000ms.)

Message Timeout – after a connection is established, the amount of time in milliseconds to


wait for a response from the unit. The default is 2000ms. (Note: If VSAT communications are
used with a TCP/IP connection, we suggest starting with a message timeout of at least
5000ms.)

Scan Rate – the amount of time in milliseconds to wait before the next poll. The default is
1000ms. A setting of zero disables the scan rate and the serial rate is used. (The scan rate is
used for the polling rate in WINPANEL.)

IP Address – enter each of the four 3-digit numbers that make up the address. The default is
all zeros.

TCP Port – the port number. The default is 6000. For Modbus/TCP protocol, the port number
is 502.

579
OMNICOM: View menu commands

View menu commands

The View menu offers the following commands:

Menu item Description


Comms Log The Communications Log is displayed.
Comms Statistics View the Communications Statistics
Toolbar Shows or hides the toolbar.
Status Bar Shows or hides the status bar.

580
OMNICOM: Communications Log (View menu)

Communications Log (View menu)


The Communications Log is for viewing the Modbus communications between the OMNI and
OMNICOM. Note: Communications are only recorded when the ‘Log Communications’ setting is
enabled from the Edit menu. For more information, see the help for Log Communications.

The current log in progress is displayed when the user first enters the screen. After approximately
20,000 logs (about 15 minutes worth of normal communications), the log is saved to file. The files are
stored in a "Comms Log" folder found under the install folder. The file name is "CL_YYMMDD_
HHMMSS.olg" where YYMMDD is the year, month, and day and HHMMSS is the hours, minutes,
and seconds of the first log in the group. Historical Log files can be viewed in this screen.

The logs are sorted by index number and by date and time. Click on a column heading to sort the
log for a different item.

To see the time difference in milliseconds between two entries, select two log entries. Click on a
log to select the first one. To select the second log, press and hold Ctrl on the PC keyboard and click
on a log. (If more than two logs are selected, it uses the first two selected logs to compute the time dif-
ference.)

Settings
The items listed below are descriptions of each setting option within the Communications Log dialog.
Click on a setting for more information.

Refresh

Displays the current log in progress and retrieves any entries that have occurred since the last
display. If the display was showing a historical log, the display is replaced with the current log
in progress.

Save to File

Saves the current log in progress to a file. Normally, the logs are saved to file when there are
approximately 20,000 logs. The Save to File button provides a means to save the current log
in progress to file at any time.

The files are stored in a "Comms Log" folder found under the install folder. The file name is
"CL_YYMMDD_HHMMSS.olg" where YYMMDD is the year, month, and day and HHMMSS
is the hours, minutes, and seconds of the first log in the group.

Save As Text

The current log in progress or a historical log can be saved to a pre-formatted text file by press-
ing Save As Text. After it is saved, it is automatically opened in a text editor for convenience.

581
OMNICOM: Communications Log (View menu)

The user may specify a save file name for the text file. The default folder is the "Comms Log"
folder under the install folder. The default file name for the current log in progress is
"OMNICOMLog.txt" and the default file name for a historical log is the historical log's name
with the ".txt" extension.

View Historical

Use this button to view historical logs that were saved to disk. The sorting and time difference
features are still available when viewing historical logs.

Clear Log

The clear log function deletes all entries in the current log in progress. It does not delete any
entries for the historical logs.

Cancel

Press Cancel to exit the Comms Log view screen.

582
OMNICOM: Communications Statistics (View menu)

Communications Statistics (View menu)


Statistics that are accumulated during Modbus communications as well as response percents are
presented in this screen.

Statistics
Transmissions Sent

The total number of transmissions (including broadcasts where Modbus ID = 0).

If the count exceeds the size of a 32-bit unsigned integer, the rollover value is increased. Note:
The percentage calculations will no longer be valid when a rollover occurs.

Responses Received

The total responses received (including invalid responses).

If the count exceeds the size of a 32-bit unsigned integer, the rollover value is increased. Note:
The percentage calculations will no longer be valid when a rollover occurs.

Rollover

A rollover value is shown for Transmissions and for Responses. A rollover occurs when the
number of transmissions or responses exceeds the value of an unsigned 32-bit integer
(4,294,967,295).

Broadcast Transmissions

the number of broadcast transmissions sent where Modbus ID = 0.

Invalid Response

The number of invalid responses received not including time outs (no response) or Exception
Code 05 - password required messages.

No Responses

The number of no responses when a response was expected (i.e. not a broadcast trans-
mission).

583
OMNICOM: Communications Statistics (View menu)

Flushes

Typically, before transmitting a new message the buffer is checked for any data remaining in
the receive buffer. If there is data, the buffer is flushed.

Percents
Response Success

This is the percent of success of responses to messages sent calculated as:


( (Responses Received - Invalid Responses) / (Transmissions Sent - Broadcast Trans-
missions) ) x 100.

Note: The percentage calculations will no longer be valid when a rollover occurs.

Response Error Percent

This is the error percent of responses to messages sent calculated as:


( (Invalid Responses + No Responses) / (Transmissions Sent - Broadcast Transmissions) ) x
100.

Note: The percentage calculations will no longer be valid when a rollover occurs.

584
OMNICOM: Toolbar command (View menu)

Toolbar command (View menu)


Use this command to display and hide the Toolbar, which includes buttons for some of the most com-
mon commands in OMNICOM, such as File Open. A check mark appears next to the menu item
when the Toolbar is displayed.

See Toolbar for help on using the toolbar.

585
OMNICOM: Status Bar command (View menu)

Status Bar command (View menu)


Use this command to display and hide the Status Bar, which describes the action to be executed by
the selected menu item or depressed toolbar button, and keyboard latch state. A check mark
appears next to the menu item when the Status Bar is displayed.

See Status Bar for help on using the status bar.

586
OMNICOM: Action menu commands

Action menu commands

The Actions menu offers the following commands:

Menu item Description


Log On Enter a password that is used to allow communications to the OMNI via a port.
Log Off Log off the password entered for communications.
Online Connect to an OMNI unit via Direct, Modem, Satellite or TCP/IP.
Offline Disconnect from an OMNI unit.
Perform operations such as retrieving reports, archive data and control oper-
Operate
ations.
Reports Modify report templates.
Configure Configuration setup.
Transmit Write configuration, archive configuration, and report templates to an OMNI unit.
Read configuration, archive configuration, and report templates from an OMNI
Receive
unit.
Diagnostics I/O Overview, WINPANEL and test communications.
WINPANEL Access the front panel of the OMNI unit.

587
OMNICOM: Log On (Actions menu)

Log On (Actions menu)

For firmware versions XX.75.10 and higher, use this command to log in with a User Password. See
the help for Enter Password.

For firmware versions prior to XX.75.10, use this command to log on to a port with a Serial Pass-
word to allow communications to an OMNI. The following screen is displayed Password

588
OMNICOM: Log Off (Actions menu)

Log Off (Actions menu)


Use this command to Log off of the:

User Password for firmware versions XX.75.10 and higher

Serial Password for firmware versions prior to XX.75.10

589
OMNICOM: Connect Screen (Actions | Online menu)

Connect Screen (Actions | Online menu)


The connect Screen is used to establish communications with a unit on a site. This screen is only
enabled in the OFFLINE mode. The screen displays a list of the available connection sites.

To search for a particular site or unit:


bThe user can enter a search string (part of a name, IP address, ID number, port number,
phone number, etc...) and press the Search button, press Enter, or press F3 to initiate the
search.
If a match is found, the site or unit is highlighted in the site and unit tree.
If it is not found, a message is displayed.
To find the next match, press the Search button, press Enter, or press F3.

To Connect with the unit at that site:


Double click on a site in the list
or click once on a site and press Connect.

When a connection is made successfully, the screen goes away. The 'Connect' icon on the toolbar
and menu item is disabled and the 'Disconnect' icon and menu item becomes active.

For Modem and Satellite connections:


The modem connection progress is shown
the responses from the modem are also shown
an Abort button appears when dialing has commenced. The user may abort the dialing pro-
cess by pressing this button.

Press Cancel to exit without connecting.

After a connection, the user is informed if a 'Check Modules' is required at the OMNI unit. The user
may continue with the receive or transmit of the configuration without performing a 'Check Modules',
however, OMNICOM will use the modules installed in the 'S-Ware' column of the OMNI display.

590
OMNICOM: Offline (Actions menu)

Offline (Actions menu)


Use this command to disconnect from a unit or to work with files.

591
OMNICOM: Actions Online Data Sync

Actions Online Data Sync


Synchronizes the information between the OMNI and the computer while the user is online with the
OMNI.

Selections
Receive all data from the OMNI unit

Use this command to Read configuration data, archive configuration and report templates
from the OMNI.

Receive Configuration only data from the OMNI unit

Use this command to Read only configuration data and archive configuration from the OMNI.

Transmit all data to the OMNI unit

Use this command to Send the configuration, archive configuration (if archive is not running)
and report templates to the OMNI.

Transmit Configuration only data to the OMNI unit

Use this command to Send only the configuration and archive configuration (if archive is not
running) to the OMNI.

Go Offline and continue

Use this command to disconnect from a unit or to work with files.

Work online with Templates(only available via the Reports menu)

Select a specific template to work with.


Use ‘Refresh’ to read a template.
To write a template, make changes and ‘Apply’.
If you would like to transmit a template file, right-click on the template, and use ‘Import
Template’, then press ‘Apply’. Note: Apply is only enabled if the template has changed
from what was currently displayed.

592
OMNICOM: Actions Online Disconnect

Actions Online Disconnect


Use this command to disconnect from a unit or to work with files in OMNICOM.

593
OMNICOM: Operate Control before data sync

Operate Control before data sync


The user has selected the Control on the Operate Tree before data synchronization with the unit has
taken place.

The system need to read some core data in order to fill out the Control tree. This dialog is displayed
during the read.

594
OMNICOM: Actions Online RX/TX

Actions Online RX/TX


Shows the register numbers being read or sent and the communications status or errors.

If selected from the toolbar, the user has the opportunity to check if they want to receive or send only
the configuration data without the templates.

If selected from the synchronization screen, the checkbox will show the selection that the user made
on that screen.

595
OMNICOM: Actions Online TX Check

Actions Online TX Check


When transmitting all the configuration, the system makes a check between the file core data, such
as module types and numbers, and the unit's core data. Any differences are listed and the user has
a choice whether to go offline and correct or continue with the transmit.

596
OMNICOM: Transmit (Actions menu)

Transmit (Actions menu)


Use this command to Send the configuration, archive configuration (if archive is not running) and
report templates to the OMNI.

Select [Start] to begin transmitting the information to the OMNI.

597
OMNICOM: Receive (Actions menu)

Receive (Actions menu)


Use this command to Read configuration data, archive configuration and report templates from the
OMNI.

Select [Start] to begin receiving the information from the OMNI.

598
OMNICOM: Archives Disabled on Configuration Write

Archives Disabled on Configuration Write


The archives can only be written to the OMNI when the archive configuration is enabled.

The user may select to:

Continue with the configuration write and loose any changes made to the archive con-
figuration.
Save all the configuration to a file and continue with the configuration write.
Terminate the configuration write.

599
OMNICOM: Window menu commands

Window menu commands

The Window menu offers the following commands, which enable you to arrange multiple views of
multiple documents in the application window:

Menu item Description


Cascade Arranges windows in an overlapped fashion.
Tile Arranges windows in non-overlapped tiles.
Window 1, 2, ... Goes to specified window.

600
OMNICOM: Cascade command (Window menu)

Cascade command (Window menu)


Use this command to arrange multiple opened windows in an overlapped fashion.

601
OMNICOM: Tile command (Window menu)

Tile command (Window menu)


Use this command to arrange multiple opened windows in a non-overlapped fashion.

602
OMNICOM: Window 1, 2,

Window 1, 2,
Lists the currently open files in the program. select the files you would like to go to.

603
OMNICOM: Help menu commands

Help menu commands

The Help menu offers the following commands, which provide you assistance with this application:

Menu item Description


Help Topics Offers you an index to topics on which you can get help.
Database Docu-
Displays a PDF file with the Modbus indexes used in the application.
ments
License Agreement Displays the License Agreement that is shown on install.
Release Notes Lists changes made for each program release.
User Notes Users can make their own notes and save them to a file.
Check For Updates Check if updates are available from our OMNI web site.
Displays the version number of this application and contact inform-
About OMNICOM
ation.

604
OMNICOM: Index command (Help menu)

Index command (Help menu)


Use this command to display the opening screen of Help. From the opening screen, you can jump to
step-by-step instructions for using OMNICOM and various types of reference information.

Once you open Help, you can click the Contents button whenever you want to return to the opening
screen.

605
OMNICOM: Help Database Documents

Help Database Documents

Select the database document for the application you wish to display. It displays a PDF file describ-
ing the Modbus indexes used in that application.

606
OMNICOM: Help License Agreement

Help License Agreement


Displays the License Agreement that is shown on install.

607
OMNICOM: Release Notes (Help menu)

Release Notes (Help menu)


Use this command to display the readme.txt file in Notepad. The file contains the updates and
release notes for the program.

608
OMNICOM: User Notes (Help menu)

User Notes (Help menu)


Opens a file in Notepad to allow the user to enter their own OMNICOM notes.

609
OMNICOM: Check For Updates (Help menu)

Check For Updates (Help menu)


Compares the current running version of OMNICOM to the latest version released on the OMNI web
site. A message is displayed to tell the user whether or not an update is available.

Click on the following link and navigate to the download page to obtain updates.

www.omniflow.com

610
OMNICOM: About Command (Help menu)

About Command (Help menu)


Use this command to display the copyright notice and version number of your copy of OMNICOM.

611
OMNICOM: Context Help Command

Context Help Command


Use the Context Help command to obtain help on some portion of OMNICOM. When you choose
the Toolbar's Context Help button, the mouse pointer will change to an arrow and question mark.
Then click somewhere in the OMNICOM window, such as another Toolbar button. The Help topic
will be shown for the item you clicked.

Shortcut

Keys: SHIFT+F1

612
OMNICOM: Using Help command (Help menu)

Using Help command (Help menu)


Use this command for instructions about using Help.

613
Standard Interface

Toolbar 615
Topics Title Bar 617
Status Bar 618
Restore command (Control menu) 620
Close command (Control menus) 621
No Help Available 622
Scroll bars 623
Size command (System menu) 624
Maximize command (System menu) 625
Minimize command (application Control menu)
626
Move command (Control menu) 627
OMNICOM: Toolbar

Toolbar

Online Toolbar

Offline Toolbar

The toolbar is displayed across the top of the application window, below the menu bar. The toolbar
provides quick mouse access to many tools used in OMNICOM,

To hide or display the Toolbar, choose Toolbar from the View menu (ALT, V, T).

Click To

New - Initializes OMNICOM and creates an empty configuration with default settings. You are
asked for application version and revision of the new file.

Open an existing document. Provides a ‘File Open’ control dialog allowing you to load an exist-
ing OMNICOM configuration from disk.

Saves the active configuration and report template files to its current name and directory. When
you save a document for the first time, OMNICOM displays the Save As dialog box so
you can name your file set.

 Remove selected data from the document and stores it on the clipboard.

Copy the selection to the clipboard.

Insert the contents of the clipboard at the insertion point.

Undo the last edit.

Log on - use this command to log on to a port to allow communications to an OMNI.

615
OMNICOM: Toolbar

Log Off - remove the password authorization

Offline - Use this command to disconnect from a unit or to work with files.

Connect - Connect to an OMNI unit via Direct, Modem, Satellite or TCP/IP.

Operate - Perform operations such as retrieving reports, archive data and performing prover
control and batch operations.

Reports - Modify report templates.

Configure – Configure the OMNI unit for operation.

Database Browser - lists Modbus registers for the application.

Receive - reads the entire configuration from the OMNI unit.

Transmit – sends the entire configuration to the OMNI unit.

Diagnostics – I/O overview, WINPANEL, and a communications test utility.

WINPANEL – Access to the front panel and display of the OMNI with the active connection.

Security - set up user and port passwords and permissions.

About Box - gives product and version information.

Click on this button and then anywhere on the dialog for information on a dialog. menu, or tool-
bar item.

616
OMNICOM: Title Bar

Title Bar
The title bar is located along the top of a window. It contains the name of the application and doc-
ument.
To move the window, drag the title bar. Note: You can also move dialog boxes by dragging their title
bars.

A title bar contains the following elements:

Maximize button
Minimize button
Name of the application - OMNICOM
Name of the document - OMNICOM1
Restore button

617
OMNICOM: Status Bar

Status Bar

The status bar is displayed at the bottom of the OMNICOM window. To display or hide the status
bar, use the Status Bar command in the View menu.

The left area of the status bar shows how to access help for any screen you are in.
The middle area shows the communications LEDs reflecting the communications activity. The Red
LED indicates transmission while the Green LED indicates reception.

The right area of the status bar provides connection information. Click on a link for the type of:
Direct

Site Name
MadCap:keyword term="Unit Name" />Unit Name
Modbus ID
Protocol
>Modicon Compatibility (Y/N)
Comm Port
Baud Rate
Number of Data Bits
Number of Stop Bits
Parity
Initial Character Delay
Character Delay
Retries

Modem and Satellite

Site Name
Unit Name
Site Number
Modbus ID
Protocol
Modicon Compatibility (Y/N)
Comm Port
Baud Rate
Number of Data Bits
Number of Stop Bits
Parity
Initial Character Delay
Character Delay
Retries

618
OMNICOM: Status Bar

TCP/IP

Site Name
Unit Name
IP Address
TCP Port
Modbus ID
Protocol
Modicon Compatibility (Y/N)
Scan Rate
Connection Timeout
Message Timeout
Retries

619
OMNICOM: Restore command (Control menu)

Restore command (Control menu)


Use this command to return the active window to its size and position before you chose the Maximize
or Minimize command.

620
OMNICOM: Close command (Control menus)

Close command (Control menus)


Use this command to close the active window or dialog box.

Double-clicking a Control-menu box is the same as choosing the Close command.

Note: If you have multiple windows open for a single document, the Close command on the doc-
ument Control menu closes only one window at a time. You can close all windows at once with the
Close command on the File menu.
Shortcuts
Keys:
CTRL+F4 closes a document window
ALT+F4 closes the OMNICOM window or dialog box

621
OMNICOM: No Help Available

No Help Available
No help is available for this area of the window.

622
OMNICOM: Scroll bars

Scroll bars
Displayed at the right and bottom edges of the document window. The scroll boxes inside the scroll
bars indicate your vertical and horizontal location in the document. You can use the mouse to scroll
to other parts of the document.

623
OMNICOM: Size command (System menu)

Size command (System menu)


Use this command to display a four-headed arrow so you can size the active window with the arrow
keys.

After the pointer changes to the four-headed arrow:


1. Press one of the DIRECTION keys (left, right, up, or down arrow key) to move the pointer to the
border you want to move.
2. Press a DIRECTION key to move the border.
3. Press ENTER when the window is the size you want.

Note: This command is unavailable if you maximize the window.


Shortcut
Mouse: Drag the size bars at the corners or edges of the window.

624
OMNICOM: Maximize command (System menu)

Maximize command (System menu)


Use this command to enlarge the active window to fill the available space.
Shortcut

Mouse: Click the maximize icon on the title bar; or double-click the title bar.
Keys: CTRL+F10 enlarges a document window.

625
OMNICOM: Minimize command (application Control menu)

Minimize command (application Control menu)


Use this command to reduce the OMNICOM window to an icon.
Shortcut

Mouse:Click the minimize icon on the title bar.


Keys: ALT+F9

626
OMNICOM: Move command (Control menu)

Move command (Control menu)


Use this command to display a four-headed arrow so you can move the active window or dialog box
with the arrow keys.

Note: This command is unavailable if you maximize the window.


Shortcut
Keys: CTRL+F7

627
Troubleshooting

Ethernet Communications Troubleshooting 629


Topics Network Printing Troubleshooting 637
Modem Connections Troubleshooting 633
Serial Communications Troubleshooting 631
Exception Codes 634
Troubleshooting - Contact Us 640
OMNICOM: Ethernet Communications Troubleshooting

Ethernet Communications Troubleshooting


Use OMNI's Network Utility (valid for Ethernet firmware v1.22 and higher) to see if the OMNI is dis-
played in the list or use “Telnet” or “Ping” to see if there is a response. If there is a response, the
connection is OK. If not, then go to Board Checks.

If the connection is OK, use OMNI's Modbus Tester and try to communicate. If you are able to com-
municate but you get errors, check the OMNICOM site setup to see if it matches the OMNI unit - i.e.
Modicon compatibility and protocol. If you are not able to communicate, check the Modbus ID set up
in the unit on the Ethernet port is the same as the Modbus ID set up in the Ethernet card.

Board checks:
Note that the board addressing for the S cards are mutually exclusive with the addressing for
the SE cards. That means you cannot have S-1 and SE-1 at the same time. It would be S-1
and SE-2 or SE-1 and S-2 for example.
If the firmware is prior to 20.74.10, 21.75.10, 22.74.10, 23.74.10, 24.74.10, 26.74.10, and
27.74.10, the SE card is going to be shown as an S card. Check the baud rate set up in the
OMNI for the Ethernet port is the same as the baud rate set up in the SE Module (it defaults to
38400). Note: for 12 mHz CPU boards, the maximum baud rate is 19200. Configure the SE
Module for 19200 baud.
If the firmware is 20.74.10, 21.75.10, 22.74.10, 23.74.10, 24.74.10, 26.74.10, and 27.74.10
and higher, make sure the “SE Firmware >2.0” is set to ‘N’ (unchecked) on the Front Panel for
the Ethernet port. (The network printing version of the firmware does not have this display.)
Look at the TX and RX LEDs on the Ethernet board for activity.
If it is an OMNI and there is activity on the repeater LEDs, it may indicate the Modbus ID
doesn't match and the messages are being sent out the Repeater port instead. Check the
Modbus ID in the Host configuration of the Ethernet Port in OMNICOM (if Ethernet con-
figuration is supported) or via Network Utility.
Check the interrupt level setting on the physical board matches your board configuration.
(Interrupt Level on S & SE Modules must be on IRQ 2. If an SV Module is also installed in the
system, all S & SE Modules must have their IRQ set to 3 and the SV IRQ must be set to 2).

Connection Errors
Exception Code 02 - See the help for Exception Codes.
Attempt to Connect Forcefully Rejected - there are only four Modbus and one Telnet con-
nection allowed at any one time. If an additional connection is attempted, this error will occur.
The System Information screen in the Network Utility configuration shows the current con-
nections.

The number of bytes returned from the unit is not correct errors:
The configuration may not match the protocol of the OMNICOM site. For example: the OMNI
port is not Modicon Compatible but the OMNICOM site is configured for Modicon

629
OMNICOM: Ethernet Communications Troubleshooting

Compatible.
May be caused by too short a Message Time Out. Go to Setup Sites. Edit the unit and
increase the "Message Timeout" setting. For more information see the help for TCP/IP Con-
nections in Setup Unit.

Communications Log
One of the best methods to aid in troubleshooting is to check the 'Log Communications' entry
on the Edit menu. You may view the communications log by selecting 'Comms Log' from the
View menu. The log may give you some hints as to what is happening and where it occurs.

Ethernet Debug Mode


As a last resort, you may find it helpful to run the Ethernet card (SE Module) in Debug Mode
using OMNI's Network Utility or Telnet:
Press “9” to enter debug mode. (If you do not see a “9” on your menu, then press “SHIFT Z”.)
If you pressed “9” then press “A” for "Debug All".
The times on the left hand side are relative timings. (For example if the time on the first line is 1
and the time on the next line is 3 then there were 2ms between the lines.)
Messages from the Ethernet card are preceded by an “E”.
Messages from the Host are preceded by an “H”.
Messages from the Repeater are preceded by an “R”.
Press any key (or “SHIFT Z”) to exit debug mode.

630
OMNICOM: Serial Communications Troubleshooting

Serial Communications Troubleshooting

No Connection or Timed Out on connect:


Check the physical cable connections.
Is the correct COM port configured for the site? See the Setup Communications Screen.
Baud Rate of the OMNI port does not match the PC port. See the Setup Communications
Screen.
The OMNI's port protocol configuration may not match the protocol of the OMNICOM site.
For example: the OMNI port is not Modicon Compatible but the OMNICOM site is con-
figured for Modicon Compatible. See the Setup Unit Screen.
Jumpers on the serial card do not match the type of communications required (i.e. wired
for RS-232 but jumpers indicate RS-485 - or - wired for RS-485 but jumpers indicate RS-
232).
Site configuration doesn't match the type of communications required (i.e. box checked for
RS-485 2-wire but wired for RS-232 or RS-485 4-wire - or - box not checked for RS-485 2-
wire but wired for RS-485 2-wire). See the Setup Communications Screen.
Is the OMNI port a Peer to Peer slave port? If so, be sure to disable port security for any OMNI
Peer to Peer slave ports for firmware versions 75.10 and up.

Exception Code 02 on connect


See the help for Exception Codes.

Timed out waiting for a response messages:


Increase the retry count in Setup Unit.
Increase the Initial Character Delay in Setup Unit.

Invalid CRC errors:


Baud Rate of the OMNI port does not match the PC port. See the Setup Communications
Screen.
May be caused by too short an inter-character delay. Go to Setup Sites. Edit the unit and
increase the "Character Delay" timing. For more information see Setup Unit.

The number of bytes returned from the unit is not correct errors:
If it is on connection, the OMNI's port protocol configuration may not match the protocol of
the OMNICOM site. For example: the OMNI port is not Modicon Compatible but the
OMNICOM site is configured for Modicon Compatible.
May be caused by too short an inter-character delay. Go to Setup Sites. Edit the unit and
increase the "Character Delay" timing. For more information see Setup Unit.
Jumpers on the serial card do not match the type of communications required (i.e. wired
for RS-232 but jumpers indicate RS-485 - or - wired for RS-485 but jumpers indicate RS-
232).

631
OMNICOM: Serial Communications Troubleshooting

Site configuration doesn't match the type of communications required (i.e. box checked for
RS-485 2-wire but wired for RS-232 or RS-485 4-wire - or - box not checked for RS-485 2-
wire but wired for RS-485 2-wire).

Communications Log
One of the best methods to aid in troubleshooting is to check the 'Log Communications' entry
on the Edit menu. You may view the communications log by selecting 'Comms Log' from the
View menu. The log may give you some hints as to what is happening and where it occurs.

632
OMNICOM: Modem Connections Troubleshooting

Modem Connections Troubleshooting

Starts to initialize but quits before dialing:


Check the physical cable connections.
Was a Modem or Satellite site selected to connect to?
Is the correct COM port configured for the site? See the Setup Communications Screen.
Check the Modem Initialization String has commands that are valid for your modem. See
the Setup Modem Screen.
Some modems require the baud rate of the COM port matches the modem’s baud rate. See
the Setup Site Screen.

Dials the number but does not connect:


Is the Connect Wait Time set for long enough to allow the modems to connect? See the
Setup Modem Screen.
Has the modem at the OMNI been properly configured and connected?
Continuous Tone - No Carrier

We have found there is a connection problem with some modems that are built in to the Dell
laptops and the white US Robotics 56K Model 701 on the OMNI side.

The modems do not connect - dials, rings, answers, but has continuous tone - no carrier
To correct this problem, change the modulation control to V34 instead of V90 or V92 by
adding this command to the initialization string:
+MS=V34,0

Go to Edit - Sites. On the Setup Sites screen press the Modem Settings button. Add the ini-
tialization command to the end of your existing string.

Additionally, there are some changes to the configuration of the US Robotics modem at the
OMNI side:
First set the switch settings up to 1, 3, and 8 down. (Switch 7 was incorrectly listed as down
but should be up - this loads from NVRAM on power up).

Using Hyperterminal, configure the modem to:


AT &D0 &H0 &K0 &N6 &U6 &R1 S0=1 Y0 &W0
(Note the &U6 (upper limit baud rate) and Y0 (load NVRAM 0) have been added along with a
zero after the

If the above describes the problem, please check the Troubleshooting for Serial Connections.

633
OMNICOM: Exception Codes

Exception Codes
The OMNI sets the high bit of the function code in the return message to differentiate a normal
response from an exception response. The following exception codes are supported by the OMNI
flow computer:

Exception Code 01

There are two reasons you might see this exception code:
an illegal function code was sent to unit
too many data points

The following function codes are supported by the OMNI flow computer:
01 - Read Coil Status
02 - Read Input Status
03 - Read Holding Registers
04 - Read Input Registers
05 - Force Single Coil
06 - Preset Single Register
07 - Read Exception Status
08 - Diagnostics
15 - Force Multiple Coils
16 - Preset Multiple Registers
65 - OMNI Specific Read
66 - OMNI Specific Write

Example of illegal function code 20:

TX: 01 14 00 01 80 1C
RX: 01 94 01 8F 00

Example of too many data points - read 300 16-bit integers:

TX: 01 03 0D AD 01 2C D6 CA
RX: 01 83 01 80 F0

Exception Code 02

There are several reasons you might see this exception code:
an illegal data address was sent to unit
the number of registers does not agree with data type
if the message occurs during connection, a possible cause is that the connection port at the
OMNI is set for Modicon compatible but the OMNICOM site is not set up for Modicon protocol.
a connection is attempted to something other than an OMNI 3000/6000.
the physical connections between the PC and the OMNI may be incorrect or faulty.

634
OMNICOM: Exception Codes

Example of an illegal address - Use function code 01- read coil status with 16-bit integer address
3501:

TX: 01 01 0D AD 00 01 6E 87
RX: 01 81 02 C1 91

Example of the number of registers not agree with data type - Modicon compatible protocol
reading float register 7501 however only asking for one register:

TX: 01 03 1D 4C 00 01 43 B1
RX: 01 83 02 C0 F1

Exception Code 03

An illegal data value was sent to the unit.

Example: Force one coil (register 1501) using a data value of 01 00 (data value should be FF 00 or
00 00):

TX: 01 05 05 DD 01 00 5C AC
RX: 01 85 03 02 91

Exception Code 04

The data sent to the unit was not written. There may be several causes:
a write attempt is made to a read only register
the lockout switch on the OMNI is set in the locked position and the lockout flag is set for the
communications port

Example of data not written: Attempt a write to register 5144 which is a read only register:

TX: 01 06 14 18 00 00 04 24 C6 0A
RX: 01 86 04 43 A3

Exception Code 05

A password entry is required for this function. Here are some possible reasons for this exception
code:
a serial password is set in the OMNI's Password menu for the port and a valid password has
not been sent to the OMNI yet
a TCP password is set in the SE Module's Ethernet configuration and a valid password has
not been sent yet
a Level B user is attempting a configuration register read or write
a Level C user is attempting a register write

Example: Level C user writes to register 3501

TX: 01 06 0D AD 00 01 DB 47
RX: 01 86 05 82 63

635
OMNICOM: Exception Codes

Exception Code 06

Downloads are disabled for this unit. This exception occurs when the "Disable Download" field is
set in the Password menu on the OMNI and a read of a register is performed.

Example:

TX: 01 03 33 12 00 01 2B 4B
RX: 01 83 06 C1 32

If you are getting an exception code and would like to see the specific message causing the problem:
Click on the Log Communications entry on the Edit menu.
Run OMNICOM again to re-create the error.
Go to the View menu and click on Comms Log.
Sort the messages by type by clicking on the "Type" column header.
Find the Exception Code error message and select it by clicking anywhere on the line.
Sort the messages again by index number by clicking on the "Index" column header.
Scroll down until you find the highlighted line.
Look at the transmit/receive messages occurring just before the logged error message.

636
OMNICOM: Network Printing Troubleshooting

Network Printing Troubleshooting


Network Printing is available with OMNI firmware versions 20.74.30, 21.75.10, 22.74.30, 24.74.19,
26.74.10, and 27.74.21 and higher and OMNI SE Module firmware v1.50 and higher.

If your OMNI firmware and Ethernet firmware support network printing, you should be able to view
the Ethernet version on the Status display of the OMNI front panel.

For example:
SE-2 EthV. 1.62.60
indicates that the second communications module is an SE Module card and the version of the Eth-
ernet firmware is v1.62.60.

Reports are not Printing


Have you configured a Printer IP in the Ethernet Printer configuration?
Have you checked the box for the reports you would like to print to each printer (printers 1 and
2) in the Ethernet Printer Configuration?
Is the Printer IP address on your OMNI's SE Module's network (see Ethernet Configuration)?
If not, a gateway might need to be configured.
Does the configured netmask for the OMNI SE Module include the address for the printers
(see Ethernet Configuration)?
Have you configured the IP Address on the printer or printer interface itself? (Consult the
manuals that came with the printer.).
Does your printer or printer interface support the LPD protocol?
If you are using custom templates, the minimum size of the report is 500 bytes for a network
printer. If you think the template is smaller than that, add some additional spaces to the tem-
plate and try again to print to the network printer.
If you are still having problems, please consult the SE Module Technical Bulletin at our web
site, www.omniflow.com

SE Module Network Printer Error Codes


If there is an error printing a report, the OMNI reports an "SE Printer" alarm. If you retrieve the alarm
report via OMNICOM, the error code is in the value column. The report ID is in the mass column.

The following are the printer error code definitions:

Error Code Description


0 Error cleared
1 Printer socket open error or error establishing socket
2 Receive Job Command error
3 Receive Control File Command error
4 Control File error
5 Receive Data File Command error

637
OMNICOM: Network Printing Troubleshooting

6 Error while sending report


7 Error while sending nulls
8 Job Done Character error
9 Last report record not received from OMNI
255 Network parameter change

Code 1 - go through the check list above under "Reports not Printing". This is most likely a problem
with the Ethernet configuration set up. The SE Module is not able to make a connection to the
printer.

Codes 2-8 have to do with the actual transfer of the report to the printer.

Code 9 - while a report was being queued in the SE module, the last record of the report was not
received by the SE Module from the OMNI. The report is printed anyway however it may be incom-
plete with up to 64 bytes missing from the end of the report.

Code 255 - Each time the SE Module's IP address or the Printer IP address changes, the con-
nection between the SE Module and the printer is no longer valid. This is more of an informational
error.

The following are the report IDs:

Report ID Description
16 Meter 1 - Daily Report
17 Meter 1 - Batch Report
18 Meter 1 - Prove Report
19 Meter 1 - Prove Passes Report
20 Meter 1 - Detailed Daily Report (gas applications only)
21 Meter 1 - Monthly Report
32 Meter 2 - Daily Report
33 Meter 2 - Batch Report
34 Meter 2 - Prove Report
35 Meter 2 - Prove Passes Report
36 Meter 2 - Detailed Daily Report (gas applications only)
37 Meter 2 - Monthly Report
48 Meter 3 - Daily Report
49 Meter 3 - Batch Report
50 Meter 3 - Prove Report
51 Meter 3 - Prove Passes Report
52 Meter 3 - Detailed Daily Report (gas applications only)
53 Meter 3 - Monthly Report
64 Meter 4 - Daily Report
65 Meter 4 - Batch Report

638
OMNICOM: Network Printing Troubleshooting

66 Meter 4 - Prove Report


67 Meter 4 - Prove Passes Report
68 Meter 4 - Detailed Daily Report (gas applications only)
69 Meter 4 - Monthly Report
80 Snapshot
81 Previous Batch (1-8) Report
82 Previous Daily (1-8) Report
83 Previous Prove (1-8) Report
84 Historical Alarm Report
85 Audit Trail Report
86 Text Archive
87 Status Report
88 Previous Snapshot Report
89 Prove Abort Report
90 Trial Prove Report
91 Product File Report
92 OMNI Initialization Report
93 Previous Monthly (1-8) Report

Example Alarm Report

                        OMNI Flow
                        Sugar Land, TX 77478
                        Historical Alarm Report Page : 1

Date : 02/08/11 Time : 11:54:41 Computer ID: App 20 Rev:20.75.02-


C030
Time Date Alarm State Value
Gross BBL Mass KLB ID Val
16:16:01 12/11/10 SE-2 Ethernet Printer#1 Error OK
.000000E+00 1440539 17 2646 0
16:16:01 12/11/10 M1 Batch End
1.567370E+02 326232 112113 1112 1
09:52:11 12/11/10 SE-2 Ethernet Printer#1 Error Alarm
2.000000E+00 1440539 17 2646 1
09:51:40 12/11/10 M1 Batch End
1.572088E+02 325222 111947 1112 1

The first alarm shows a Receive Job Command error on printer 1 when printing the Meter 1 - Batch
Report.
The next entry is a clearing of the error when the report is next printed and the error does not reoc-
cur.

639
OMNICOM: Troubleshooting - Contact Us

Troubleshooting - Contact Us
You may contact us via the web at www.omniflow.com.

email us at: [email protected]

OMNI Flow Computers, Inc.


12320 Cardinal Meadow, Suite 180
Sugar Land, TX 77478 USA

281-240-6161 - telephone
281-240-6162 - fax

640
OMNICOM: Apply Bar

Apply Bar

Most tabs have an "Apply" and "Cancel" button at the top. If any changes are made to a tab, the
Apply and Cancel buttons become active. Pressing the Apply button commits those changes while
the Cancel button restores the previous values.

When Online the Apply button also causes the changes to be transmitted to the active connected
OMNI. The progress bar shows the progress of the communications. The status shows inform-
ational messages.

641
OMNICOM: Database Browser

Database Browser

The Database Browser (magnifying glass on the ribbon bar shown above) displays all of the Modbus
registers that are applicable for your configuration - Liquid or Gas, US or Metric, and K-Factor or
Meter Factor Curve. It shows the current Database Revision of the file or OMNI unit (online) and the
total register count for the current filters.

To go to a certain register or register area, click on the register list and begin to type the
register number.

Select a Data Type from the drop down list to filter on a data type.

Click on Meter 1-4 or Station to add those registers to the list. If there are no meter, station, or
system filters selected, all registers are shown.

Click on System to see a register that has a usage but is not a meter or station such as product
or prover. If there are no meter, station, or system filters selected, all registers are shown.

Click on the top of a column to sort the register list on that item.

Enter a word or phrase and press Enter or press the Search button to find all the registers with
that search word or phrase.

Press 'Clear Filters' to remove all the filters and display the register list for the application.

Press the 'Close' button to exit the screen.

Using the Browser while editing Modbus registers in a screen:


To put a register into an entry box that accepts a database register (such as a Digital I/O or
Analog Output), click on the entry box and press the ellipsis to invoke the browser. You may
also right-click and select Browser from the menu. The edit box on the screen will turn a light
yellow color indicating the Browser is active for that edit. In the Browser, select the register
you want to put in the entry and double click or select it and press the 'Select' button.

If a register is already in the edit field when the Browser is invoked, the Browser will locate and
highlight the register in the Browser register list. If the register is not found in the list, it is per-
haps due to a filter.

To select multiple registers to put into a list (i.e. the Archive Configuration, Custom Packets,
Allen-Bradley PLC, and Boolean/Variable Statements), on the screen, select the point that
you wish to start with. In the Browser, select multiple consecutive registers by selecting the
starting register, hold the SHIFT key, and select the ending register - or - select randomly by
holding the CTRL button and clicking on the desired registers. Once all the registers are selec-
ted, press the 'Select' button. The registers are placed sequentially in the list beginning with
the starting point.

642
OMNICOM: Database Browser

643
OMNICOM: Print Lists

Print Lists

Select from the following print list links:

Configuration Print
Site List

644
OMNICOM: Edit Serial Passwords

Edit Serial Passwords


This screen is available online for firmware versions prior to XX.75.10.

Modify the passwords on the serial port. Press "CTRL + ALT + P" to edit passwords.

Three levels of passwords are available: Level A, Level B and Level C:

Level A

Allows Complete access to data and functions within the flow computer.

Level B

Allows access to printed reports and operator functions such as ending batches and proving flow-
meters.

The Configuration tree, Report Template Editor tree, configuration upload or download, and the
Operate Batch Stack editing is not accessible to Level B users.

Level C

Allows read access to most everything but no write access except to those Modbus registers needed
to retrieve reports.

The Operate Control functions and the Historical Archives 701-710 are not available to Level C
users.

Please check the box of the password you would like to change. As you enter your password, aster-
isks are shown in place of the characters you type in. Note that passwords are case sensitive. You
will be asked to re-enter your password to ensure what you typed was correct. When finished, press
OK. If the password change was successful, you will see a message indicating your new password
is in effect. Press CANCEL to exit the screen.

There has to be a Level A password assigned before Level B and Level C passwords will go into
effect. The Level A password is the Serial Port password for the serial port the user is connected to
at the OMNI. If a Level A password is modified or assigned, the OMNI automatically logs the user in
with that password. (Note: On the OMNI front panel, the user is able to view the Serial Port (Level A)
password after entering the privileged password. See the OMNI user's manual for more information
on the privileged password.)

The OMNI will keep a serial password active for 2 minutes or until the user logs out. OMNICOM auto-
matically logs out the user when the user goes offline or OMNICOM is closed. The user may also log
themselves out by clicking the door ICON on the toolbar. The "user log in" ICON is the head on the
toolbar. Note: It is suggested to log out using the door ICON after assigning a Level A password in
order to test the other password levels.

645
OMNICOM: Edit Serial Passwords

If password levels have been previously assigned, the user will be asked to enter a password before
being allowed to change it.
Level A users may change Level A, Level B, and Level C passwords.
Level B users can only change the Level B password.
Level C users can only modify the Level C password.

To remove a password, simply check the box for the Level you would like to remove and press OK. It
is important to remove password Level B and Level C passwords before removing the Level A pass-
word.

646
OMNICOM: Password

Password
This screen is available online for firmware versions prior to XX.75.10.

Enter your password at this point if you wish to retrieve printed reports or upload or download con-
figuration data.

Three levels are provided:

Level A

Allows complete access to all data and functions within the flow computer.

Level B

Allows access to printed reports and operator functions such as ending batches and proving flow
meters.

Level C

Allows read access to everything but no write access except to those Modbus registers needed to
retrieve reports.

Change your password on a regular basis.

647
OMNICOM: OMNICOM Logo Bar

OMNICOM Logo Bar

You may contact us via the web at www.omniflow.com.

email us at: [email protected]

OMNI Flow Computers, Inc.


12320 Cardinal Meadow, Suite 180
Sugar Land, TX 77478 USA

281-240-6161 - telephone
281-240-6162 - fax

648
OMNICOM: Communication LEDs

Communication LEDs

The RED LED indicates data transmission from the OMNICOM PC program to the OMNI (sending
to OMNI).

The GREEN LED indicates data reception from the OMNI to the OMNICOM PC (receiving from
OMNI).

649
1-5v/4-20mA – Adjust Selection

1
1-5v/4-20mA 65
10BaseT Ethernet Port 133
2
2-wire RS-485 133, 575
2-wire RS-485 Repeater Port 133
4
4-20 mA 87-91
Channel 87-91
4-20mA 65, 106, 184, 194, 203, 217, 223, 243, 251, 258, 350, 386
4-20ma SG 350
4-wire RS-485 133
A
Abort button 590
Abort Prove 54
Aborted 234
Index

About Command 611


About OmniCom 604
Accumulated 461
Acknowledge Meter 55
Action 391, 525
Action menu commands 587
Actions menu 587, 598
Actions Offline 591
Actions Online 590, 592-593, 595-596
Actions Online Disconnect 593
Actions Receive 598
Actions Transmit 597
Activate 443, 457, 471
Database Point Select 471
Active Alarms 525
Active Frequency 163, 401
Actual Density 199
ADD 406
Add Site 7-10
Add Unit 8
Adding 466, 471
Database Variables 471
Literal Text 466
Address 001 421, 425, 429
Address 201 421, 425, 429
Address 401 421, 425, 429
Adjust Selection 146

650
Index: Advanced – Archive Maintenance

Advanced 124 Analog Outputs 69


AGA 350, 416 Analysis 163, 315, 343, 349-350, 384-385,
AGA-10 150, 153, 155, 157 414, 417
AGA-10 VOS Deviation 149, 152, 154, 156 Analysis basis entered 385
AGA-5 350 Analyzer ID 414
AGA-8 350 AND 57, 239, 400, 433
AGA 10 137 AND NOT 400
AGA 3-92 137 API 163, 194, 217, 251, 265, 294, 329, 334,
AGA 3-92/API 14.3 137 338, 344
Air 350 API's Table 23A 265
Density 350 API 11.1 2004 product 514
Alarm 54, 59, 65, 106, 114, 145, 149, 153- API 11.2.1 268, 287, 330, 335
154, 156, 163, 185-186, 193, 196, API 11.2.1M 300, 320, 340, 345
203, 205, 207, 209-210, 218, 223, API 11.2.2 269, 287, 330, 335
225, 241-243, 252, 258, 260, 268, API 11.2.2M 300, 320, 340, 345
287, 294, 316, 386, 400, 414, 448, API 11.3.2 279, 308
474, 480, 484-485, 492, 496, 525 pressure limits 278
Alarm Acknowledge 54 API 11.3.3.2 274, 304
Alarm Band 145 API 11.3.3.2. 265
Alarm Band High Limit 145 API 11.3.3.2M 294
Alarm Band Low Limit 145 API 12.2.3 Rounding Rules 47
Alarm Limits 65, 106, 149, 153-154, 157, API 23E/24E 265
185-186, 196, 203, 205, 207, 218, API 2540/ASTM D1250 1952 265, 282,
223, 225, 241, 243, 252, 258, 260, 386 294, 316
Densitometers/Gravitometers 65 API 2565 307
Station 207 Ethyl 306
Alarm Log Archive 496 Propyl 274, 303
Alarm Meter Inactive 163 API gravity 329, 334
Alarm Sampling 214 API Linear 194, 217, 251
Alarms And Training 214 API MPMS 11.1 279, 308
All 400 API MPMS 11.4.1 265, 294
Allen-Bradley PLC 20, 110, 437-438, 440- API MPMS Chapter 11.1 265, 282, 294, 316
441 API MPMS Chapter 11.2.1 265, 282
Allowable Flow 235 API MPMS Chapter 11.2.1M 294, 316
Allowable Temperature Change 234 API MPMS Chapter 11.4.1 332, 342
Allowable Temperature Difference- API Override 329, 334
Prover 234 API Tables 53A 294, 341
Meter 234 Applied Automation 110, 414
Alpha Factor 267, 284, 296, 318 Apply Bar 641
Alpha Shift 525 Apply button 641
ALT commands 525 Online 641
Analog 96 Pressing 641
Analog input 69 Apply Meter Factor Retroactively 234
Analog Input 65 Archive All Reports 236
Analog Input Dialog 65, 87-91, 94-96 Archive Block 468
Analog output 88, 90, 406 Archive Boolean Trigger 433
Analog Output 64, 69, 87, 89, 91, 94-96, 102 Archive Data 701-710 492, 494
Analog Output Assignments 102 Archive Maintenance 433, 517

651
Index: Archive Path – baud rate

Archive Path 492 Backpanel 133


Archive RAM Status 434 BACKSPACE 525
Archives 234, 433, 443, 466, 477, 492-493, Backspace’ key 466
495, 497, 499, 501, 517, 587, 597- Band High Limit 145
599, 615 Warning 145
Archives 701-710 495 Band Low Limit 145
Archives Disabled on Configuration Warning 145
Write 599 Barrels 57, 396
Archives Options dialog 433 Barrels Pulses/unit 395
arrows 525 Base 265, 282, 294, 316, 338, 344, 461
ASCII 106, 109, 163, 184, 186, 194, 203, Premium 461
205, 217, 223, 225, 241-243, 251, Base Conditions 232, 265, 294, 350
258, 260, 386, 407, 421, 425, 429, Base Conditions Max 280, 294
442, 470-471, 473, 493-494, 496, 498, Base Conditions Min 279
500, 531, 578 Base Cumulative MSCF 461
send 442 Base Density 275, 304
Speed 109 Base Flowrate 163
Write 407 BASE LEVEL 461
ASCII String 532 Base Temperature 232, 350
Assign 20 Batch 47, 54, 60, 109, 163, 207-208, 236,
I/O 20 411, 433, 442-444, 448-449, 452, 466,
Assign I/O 59 474, 480, 484, 488-491, 494, 502,
ASTM 1550M 294 504, 506, 508, 510, 513, 616, 645, 647
ASTM 1555 265 ID 510
ASTM 1555M 294 Batch Control 504, 506, 508
ASTM D1555M 305 Batch end 443, 467, 506, 508
AT 577, 633 Batch End Acknowledge Toggle 60
Audit 474, 484, 486, 492, 498, 500 Batch End Acknowledgement 61
Audit Log Archive 498, 500 Batch End Pulse 60
Audit Trail 474, 484, 486 Batch ID 411, 448, 507, 509, 511
Auto Adjust Set 146 Batch Meter 54, 507, 509
Auto Implement 236 Batch Preset Reached Flag 60
Meter Factor 234 Batch Preset Warning 163, 209, 449, 510
Auto Implement Meter Factor Station 208
Immediately 234 Batch Preset Warning Flag 60
Auto Prove 239 Batch Remaining 507, 509
Auto Prove Enable 163 Batch Report 442, 467, 484, 488-491
Auto Prove Problem 60 Batch Scheduling 448-449, 452, 504, 510
Auto Prove Setup 228 Batch Scheduling List 207-208
Auto Prove Setup Screen 239 Batch Screen 209
automatic disconnect 577 Batch Setup 207-208, 448-449, 452, 504,
Automatic Disconnect 10 508, 510
Automatic Hourly Batch Select 452 Batch Size 506, 508
Auxiliary Inputs 20, 49, 65, 106, 163, 188 Batch Stack 449, 452
Average Relative Adjustment 145 Batch Ticket 505, 513
Batch Warning 163, 209
B baud rate 482, 575, 618, 631
Omni port 631
B Combo Modules 64, 88

652
Index: Baud Rate – Conditions/Ratio

Baud Rate 9, 111 Cancel button 473, 641


BCC 109 Caps 466
beep 525 caps lock 525
beeper 526 Cardinal Meadow 640, 648
Bi Directional 55 Channel 87-91, 163
Bidirectional 234 4-20 mA 87-91
Big Endian 540 Flowmeter 163
Blade Tip Sensor Factor 145 character delay 575
Blank Page 463 Character Delay 579, 618, 631
Block 438 Check For Updates 610
data 438 Checked/Proved For 442
Board Checks 629 Chromatograph 350, 414
Boolean 399-400, 467, 470, 539 Chronometry 91
deactivating 403 Clear All Totals 43
moves 404 COM port 575, 631, 633
printing 470 COM Port 9
Boolean Block Control Points 470 Combo Modules 64-65, 87-91, 94-96, 163
Boolean Blocks 466, 470 Comm 188, 575
Nesting 470 Comm Port 482, 618
Boolean False Blocks’ 467 Command Block 437, 440
Boolean Points 1025 59 Command Inputs 53-54
Boolean Statements 54, 163, 400, 433 Command Point 393
Boolean Trigger 433 Common Batch Stack 207-208, 449, 452,
sets 433 504, 508, 510
Boolean True Blocks’ 467 Comms Log 572, 580
Boolean True/False Block 470 comms statistics 583
Boolean Variables 408 Communication LEDs 649
Including 408 Communications 577
Brooks 231, 245 modem 577
Brooks Compact Prover 229, 245 communications log 572, 581
Using 229 Communications Log 534, 580
Brooks Prover 163 Communications Log dialog 581
Browser 473 communications parameters 573, 575, 577
Browser Button 473 Communications Parameters 9-10
use 473 Communications Screen 631, 633
Browser printer 473 Compact Prover/Run 62
BS&W 106, 163 Company Name 16
BTSF 145 Component Order Setup 416
BTU 350 Component Overrides 385
Compressibility 265, 294
C Compressibility factor 271, 289, 300, 320,
C Combo Modules 64, 89 331, 336, 340, 346
Calibration 198, 220, 254 Computer ID 442, 484
supplied 254 Condensed Mode String 442
Supplied 198, 220 Conditional Printing Data 467
Calibration Chart Which Correlates Reyn- Report 466
olds Number Versus Flowmeter Flow Conditions/Ratio 199
Coefficient Cf 162 Specific Heats 199

653
Index: CONFIGURABLE USER ENTRIES – data value

CONFIGURABLE USER ENTRIES 411 Cp/Cv 350


Configuration Print 464, 644 CPL 265, 282, 294, 316, 329, 334, 338, 344
configure 575, 577 CPL factor 281, 314
Configure 7, 9-10 CPSP 230
Configure PID 390 Calculate 230
configure site 573 CRC Detection Enabled 109
connect 590 CRC/LRC 533
Connect 12, 114, 156, 163, 525, 587 Critical applications 457
Ethernet Port 114 Critical Temperature 350
Connect - Connect 616 Cst 65
Connect Screen 12, 590 CTL 265, 282, 294, 316, 329, 334, 339, 345
connect wait 577 calculate 294
Connect Wait 10 Calculate 265
Connect Wait Time 633 limits 294, 316
Connect’ 590 CTL factor 270, 288, 300, 319
connection 482, 525, 551, 562, 573, 575, CTPL 279
577, 579, 590, 616, 618, 629, 631, Ctrl 581, 645
633-634 PC 581
Connection 12, 63, 87, 89-91, 94-96, 109, CTRL+Z 566
114, 131, 133 CTSP 230, 232
To Make 12 Calculate 230
Connection problem 633 Cumulative MSCF 461
Connection Screen 12 Current Assignments 49, 97
connection timeout 575 Current Reports 466, 478, 484
CONSTANT Operators 408 Custom Packets 418, 421, 425, 429
Constants 15, 163, 198-199, 201-202, 220-
D
222, 254, 256-257, 406
Contact Us 640 Daily 47, 433, 444, 474, 494
Contants 22 Daily Report 433, 452, 467, 484, 489-490
Context Help 612 Danalyzer ASCII 110
Use 612 Danalyzer GC 416
Control 53-54, 59, 150, 163, 210, 388-389, Danalyzer Modbus ASCII 414
391, 393, 400, 449, 457, 466, 470- Danalyzer RTU 110
471, 473, 475, 502, 514, 564, 587, Daniel 65, 86, 96, 135, 154, 414
594, 620-621, 626-627, 633 Daniel Danalyzer 414
Control output percentage 389 Daniel Danalyzer chromatograph 414
Control Output Tag 389 Daniel Ultrasonic 65, 86, 96, 135, 154
Control Outputs 53, 59 SV 154
Control Variable 389 Daniel Ultrasonic Flowmeter 154
convert numbers 540 Modbus ID 154
Convertor 534 Daniel Ultrasonic Meter 154
pressing 534 K-Factor Curve 155
Coriolis 65, 135, 144, 163, 216, 250 data bits 575
Coriolis Flowmeters 190 Data Bits 9
Coriolis Meter 144 data types 540
Corrected GSV 506, 508 Data Types 438, 441, 460, 472, 531, 538
Corrected NSV 506, 508 data value 531
Cp 350

654
Index: Data Values – Edit menu

Data Values 531, 538 Density/Gravity Temperature 203, 223, 258


requests 532 Density/Gravity Type 217, 251
Database Point 468, 471 Detailed Analysis 384
Database Point’ 471 Detailed Daily Report 433
Database Variables 471 activate 443
Adding 471 diagnostic 525
Date Format Entry 16 Diagnostics 4, 518-519, 525, 532, 540, 587,
Daylight Savings Time 16 616, 634
Deadband 245 dial 590
Decimal Resolution 15, 47 Digital Channels 53
delay 575 Digital I/O 49, 53, 63, 400
Delay Off 59, 403 Configuration 63
Delay On 59, 403 DIGITAL I/O MODULE 63
Delayed Rate Of Change 61 DIGITAL I/O OUTPUTS 63
Delete’ 466 Digital Input Assignments 103
Denisty Pressure Override Value 205 Digital Input No 157
Densitometer 65, 69, 88, 106, 163, 193-194, Digital IO 53, 63
196, 198-199, 203, 205, 217-218, 220, direct 573, 575, 590
223, 225, 251-252, 254, 258, 260, Direct 9
263, 265, 294, 329, 334, 338, 448 Direct connections 579
Type 194, 217, 251 Direct, Modem 575, 579
Densitometer calibration constants 254 Direct/Modem/Satellite 482
Densitometer Calibration Constants 198, Disable NIST14 Flowing Density
220 Calculation 163
Densitometers 90, 193, 203, 205, 223, 225, Disconnect’ 590
258, 260 display 525, 527
Densitometers/Gravitometers 65 display message 530
Alarm Limits 65 Dissolved Air 332
Density / Gravity Type 194 DIVIDE Operators 408
Density Correction Factors 196, 218, 252 double 538
Density Pressure Override Value 225, 260 DP 66, 94-96, 163, 183, 401
Density Pulse 66 Type 96
Density Stability Time 234 DP High Range 163
Density Temperature 70, 203, 223, 258 DP I/O Point 163, 183
Input 203, 223, 258 DP Mid Range 163
Density Temperature High Alarm 60 DP Setup 163, 183
Density Temperature Low Alarm 60 DP Switchover 183
Density Temperature Override Value 203, DP/Orifice 401
223, 258 Dual Error Alarm 163
Density/gravity 227 DZ/dT 142
Density/Gravity 56, 65, 193, 196, 216, 218,
E
250, 252
Selecting 196 E Combo Modules 64, 91
Density/Gravity Override Value 196, 218, E/D Combo Modules 64, 90
252 Edge Triggered Commands 54
Density/Gravity Pressure 205, 225, 260 Edit Communications 7, 575
Density/Gravity Settings 207 Edit Log Communications 572
Density/Gravity Setup 196, 218, 252 Edit menu 565, 572, 581

655
Index: Edit Menu – Fluid Products

Edit Menu 7-10 File Import 560


Edit Modem 577 File Import Template 560
Edit Serial Passwords 11, 645 File Menu Commands 551
Edit Sites 8-10, 573 File Name 484
Edit Undo 566 File New 5
Edit Unit 8, 578 File New command 552
Elasticity 230 File Open 5, 585
Modulus 230 File Open command 555
Electromechanical 395 File Open Template 560
Element 468 File Open’ control dialog 555, 615
Element’ 466, 476 File Print Setup command 562
end 525 File Save As command 558
Energy Flow 58, 395 File Save command 554, 557
Energy Flowrate 421, 425, 429 File Save Template 559
Epson 442 float 538
EQUAL Operators 409 Floating Point Variables 404
Equimeter AAT 135, 145 Flow Coefficient 162
Equimeter Auto-Adjust Turbine Meter 145 Flow Coefficient Cf 162
Equipment List 15, 20, 110, 184, 186, 196, Remaining 162
218, 252, 413 Values 162
Error Check Threshold 163 Flow Deviation 153, 155, 157
ESC 473 Exceeds 155, 157
Ethernet 50, 108, 114-116, 118, 120, 122, Flow Direction 149, 152, 154, 157
124-125, 128-129, 133, 629, 637 Flow High Limit 163, 208
EXACT COMPARE 400, 407 Flow I/O Point 163
Exception code 634 Flow Low Limit 163, 208
Exit command 564 Flow Meter 66
EXOR 400 Flow Minutes 155, 157
Export Template 561 See 155, 157
Export User Displays 398 Flow Pulse 66
Exporting Report Templates 467 Flow Rate Change 239
Flow Stable Time 239
F Flow Tube Expansion Coefficient 161
Flow Tube Inside Diameter 161
Factor Acceptability Criteria 236
Flow Tube Reference Temperature 161
Factor Calculation Resolution 236
Flowmeter– Pulse Signal 143-144
Factor Curve 262, 348
Flowmeter DP Setup 183
Factors 15, 22, 145, 149, 163, 188, 190,
Flowmeter Flow Coefficient Cf 162
196, 199, 201-202, 218, 221-222, 231, Flowmeter Linearization 190
236, 252, 256-257, 262-263, 268, 287, Flowmeter Setup 135
296, 316, 329, 334, 338, 344, 350, Flowmeter Type 134
391, 397, 406, 457, 481, 506, 508, 578 Flowrate High Alarm 59
Factors and Constants 15 Flowrate High High Alarm 59
FALLING EDGE 400, 407 Flowrate Low Alarm 59
False 401, 470 Flowrate Low Low Alarm 59
File | Save Template As 559 Flowrates 208, 210, 348, 421, 425, 429
File Application 5, 553 FLOWSIC 600 Ultrasonic 135, 156
File Close command 556 SV 156
File Export Template 561 Fluid Products 137, 349

656
Index: Fluid Setup – Honeywell SMV3000 DP Meter

Fluid Setup 149, 152, 154, 156, 350 Gravity/Density Low Alarm 60
Fluid Type 350 GREEN LED 618, 649
FMC MPU 1200 86, 96, 135, 152 Gross BBL Accumulator 438
SV 152 Gross Flow 58, 395
Folder/Archives 570 Gross Flowrate 406, 421, 425, 429, 438
folders 571 Gross Flowrate Full Scale 208
Force Multiple Coils 538 Gross Full Scale 163
Force One Coil 538 Gross Volume 275, 304
Form Feed 467
Formatted view 466 H
Front Panel Counters 395 H Combo Modules 64, 94
Full Scale 67, 106, 184, 186, 196, 203, 205, Hardware Setup 108, 111
218, 223, 225, 241-243, 252, 258, HART 51, 64-65, 77, 82, 92-93, 99, 520
260, 386, 389 HART Network 82
function code 531 Heating 69, 350
G Value 76, 350
Heating Value Method 350
Gain Factor 391 Heavy Hydraulic 214
Gas Chromatograph 2, 110, 163, 384, 413- help 628-629, 631, 633-634, 637, 640
414, 416 Help 605, 612-613
Gas Chromatograph Components 413, 416 screen 605
Gateway 115-116 Help About 463, 611
GC Alarm 414 Help menu commands 604
GC Components 416 Help Release Notes 608
GC Setup 414 Help Topics 604
GC Stream 163 Help User Notes 609
GC2 415 Help Using Help Command 612
General Setup 4, 15-16, 20, 43, 47, 184, hexadecimal 538, 540
186, 196, 218, 252, 413, 437 High %DP 211
GOTO 400, 407 High Alarm 67, 163
GPA-TP15 329, 334, 338, 344 High Filter DP 404
GPA-TP16 329, 334, 344 High High Alarm 163, 209
GPA-TP16M 338 High/low alarm 400
GPA-TP27 329, 334, 338, 344 Historical 486, 488-491
GPA 2172-96 350 Historical Alarm 485
GPA 27 265, 294 Historical Average 236
GPA 27 53/54E 294 Historical Reports 484
GPA RR133 EP Mix 274, 282, 303 Historical Text Reports 433, 494
GPA TP15 271, 290, 301, 321, 331, 336, home 525
340, 346 Honeywell 65, 94-95, 135, 148, 163, 183,
GPA TP16 269, 288, 298 422, 426, 430
GPA TP16M 298, 319 Honeywell APM 422, 426, 430
GPA TP27 290, 300, 321 Honeywell DE 94-95
Gravitometer 194, 196, 216-218, 250-252, Honeywell DE Protocol 65
329, 334, 448 Honeywell SMV-3000 163
Gravity Change 212 Honeywell SMV-3000 Multivariable 95
Gravity Rate Of Change 61 Honeywell SMV3000 DP 135
Gravity/Density High Alarm 60 Honeywell SMV3000 DP Meter 148

657
Index: Host – keypad

Host 118, 629 Initial Character Delay 618, 631


hotspots 525 Increase 631
HP Laser Jet 442 initialization string 577
HV 95, 106, 184, 203, 223, 243, 258, 350, Initialization String 10
386 Inlet/Outlet Pressure 227, 241
value 350 Inlet/Outlet Temperature 227, 243
HV Combo Modules 64, 95 Input 243
Hydraulic Alarms 214, 516 Input Scaling 65
Input Type 66
I Input/Output Calibration 69
Insert Boolean Block 470
I/O 14, 20, 50, 53-54, 57, 59, 63, 65, 97,
Insert Database Point 471
106, 133, 155, 157, 163, 184, 186,
Insert Printer Code 473
194, 203, 205, 217, 223, 225, 241- Insert/Over-type 466
243, 251, 258, 260, 386, 389, 395, Instromet Ultrasonic 86, 96, 135, 149, 160-
400, 519 161
Assign 20 SV 149
number 260, 386 integer 538
Number 106, 184, 186, 194, 203, 205, Inter-character 631
217, 223, 225, 241-243, 251, 258 Inter-Character 109
reserves 54 Interface Detection 212, 448
Summary 104 Interface Switching 207
type 519 Invalid CRC 631
Type 50 IP address 575
I/O Allocations 50 IP Address 115-116, 482, 579, 619
I/O module 260, 386, 405 Isentropic Expansion 137
I/O Module 53, 63, 108, 131, 184, 186, 196, Isentropic Exponent 141, 163, 278, 308, 350
203, 205, 223, 225, 241-243, 258 Isentropic Temperature Correction 137
I/O Overview 519, 587, 616 ISO 6976 350
I/O Point 54, 57, 59, 106, 184, 186, 194, ISO5167 Version 137
203, 205, 217, 223, 225, 241-243, IUPAC88 278, 307
251, 258, 260, 386
I/O ports 457 J
I/O Ports 111
Joules Thompson 350
IBM 442
ID 16, 208, 414, 510, 525, 578 K
accept 578
batch 510 K-Factor 190, 421, 425, 429
Ideal Gas Calculation 350 Determining 190
IF Operator 406 K-Factor Curve 143-144, 151, 153, 155,
Import 466, 615 158
use 615 Daniel Ultrasonic Meter 154
Import User Displays 397 Flowmeter 156
Import/Export 398 Pulse Signal 143-144
Import/Export User Displays 398 Ultrasonic FMC Kongsberg Meter 153
Inactive Meter 62 Ultrasonic Instromet 151
Inactivity Timer 234 K3 Thermodynamic Constant 163
Independent Batch Stacks 449, 504, 510 keypad 525, 527
INDIRECT Operators 409

658
Index: Kongsberg MPU 1200 Ultrasonic Gas Flowmeter – Meter Run Setup

Kongsberg MPU 1200 Ultrasonic Gas Flow- Mass Percent 343, 350
meter 152 Master Meter 229, 232, 234
Configuring 152 MATHEMATICAL 408
Krohne Ethylene 350 Max Acceptable Primary Setpoint 389
Kwong Method 350 Max Error Counts Per 163
Max Good Pulses 163
L Max Records 433
Maximize 620
Last Local Snapshot 484, 487
Maximum Deviation 235
Last Master 458
Maximum Down Time 152, 154, 156
LCF 188
Maximum Flow Between Proves 239
LEDs 618
Maximum Flow Deviation 149
Line Pack Delay 212
Maximum Gain 153
Linearization Coefficients 188
Measurement Algorithm 163, 262, 265, 282,
Linearization Method 349
Listen Only 414 294, 316, 329, 340
Literal Text 466 Mechanical Output 145
Adding 466 media type 576
Little Endian 540 Media Type 9
log communications 572, 581 menu_actions 587
Log Off 587, 589 menu_edit 565
Log On 587-588 menu_help 604
Logical address 438, 440-441 menu_view 580
setpoint data block 441 menu_window 600
Long Integers 424, 427, 432 message 530
Low %DP 211 message timeout 575
Low Alarm 66, 163 Meter Density/Gravity Dialog 194, 217
Low Flow Cutoff 183, 401 Meter Density/Gravity Pressure dialog 260
Set 183 Meter Density/Gravity Pressure Dialog 205
Low Low Alarm 163, 208 Meter Density/Gravity Temperature
LRC 109 Dialog 203, 223, 258
LSB 405 Meter Factor 234
containing 404 Auto Implement 236
holding 405 Meter factor curve 348
Meter ID 163
M Meter Manufacturer 175
Meter Run 4, 20, 54, 58-59, 67, 69, 106,
Main Rotor 145 134-135, 137, 143-145, 147-149, 152,
Manipulate 393 154, 156, 159-161, 163, 184, 186,
PID permissives 393 193-194, 196, 198-199, 201-203, 205,
Manual 392
207-208, 210, 218, 227-228, 252, 262,
Manual Implement MF Time Limit 234
294, 348-349, 389, 395, 397, 402,
Manually Override Strategy 65
Mass 190 408, 433, 438, 448-449, 452, 461,
Mass Calculation 275, 304 480, 504, 506, 508, 510
Mass Flow 58, 395 Meter Run Density UGC 193, 202
Mass Flowrate 421, 425, 429, 438 Meter Run Density/Gravity Dialog 196, 218,
Mass Flowrate Full Scale 208 252
Mass Fraction 315, 343, 350 Meter Run Pressure 134, 186
Mass Full Scale 163 Meter Run Setup 134, 137, 147-148, 163-

659
Index: Meter Run Setup – Nesting

164, 169, 172, 176, 294, 349 modem 573, 575, 590, 631
Meter Run Temperature 134, 163, 184 Modem 9
Meter Setup 163-164, 169, 172, 176, 449, Modem Connection 109
510 RTU Using 109
Meter Station Run Switching Dialog 210 Modem Initialization String 633
Meter Type 135, 139, 143-145, 147, 149, Check 633
152, 154, 156, 159 Modem Screen 633
Mild Carbon Steel 230 modem settings 576-577
mimic beeper 526 Modem Settings 9-10
Mimic OMNI Panel Beeper 526, 528-529 modem setup 573
Min Acceptable Primary Setpoint 389 Modicon 9, 421, 425, 429, 482, 538, 540
Minimize command 620, 626 Modicon 984 Mode 421, 425, 429
Minimum Flow Rate Change 240 Modicon 984 PLC 424, 428, 432
Minimum Percent Sample Ratio 150 Modicon Compatibility 531
Minimum Performance 150 Modicon compatible 575
Minimum Ramp 391, 393 Modicon Compatible 109, 114, 495, 531,
set 391, 393 538, 578, 634
Minimum Ramp Down Limit 393 Modules 49-50, 53, 63-64, 86-91, 94-96,
Minimum Ramp Down To 394 108, 114, 131, 133, 149, 152, 154,
Modbus 54, 108-109, 131, 163, 209-210, 156, 163, 184, 186, 196, 203, 205,
212, 393, 401, 410, 416, 418, 457, 223, 225, 241-243, 258, 260, 386,
459, 486, 531, 581, 645, 647 405, 519, 596, 629
includes 486 Modulus 230
Selecting 109 Elasticity 230
Sends 54 Mole Deviation 414
use 406 Mole Fraction 278, 307, 331, 341, 350
Modbus ASCII 156, 424, 427, 432 Propylene 274, 303, 331, 341
Modbus data point number 433 Mole Percent 315, 343, 350
boolean bit which 433 Mole percentages 384
Modbus ID 68, 96, 114, 154, 156, 457, 459, Monel 137, 161
482, 525, 531, 578, 618, 629 Monthly Report 484
Daniel Ultrasonic Flowmeter 154 Motorola 540
FLOWSIC 600 Ultrasonic MOV 210
Flowmeter 156 MOVE 400, 407, 627
Omni 114 MOVE RANGE 400, 407
Modbus ID number 459 MSB 405
slave 459 MULTIPLY 406
Modbus Mux 114 Multivariable 86, 96
Modbus Packet 001 421
Modbus Packet 201 425 N
Modbus Packet 401 429 Nagle Algorithm 124
Modbus RTU Modem 109 NBS 1045 278, 308
Modbus RTU Modicon Compatible 109 Negative Energy Flow 58, 395
Modbus tester 531 Negative Gross Flow 58, 395
Modbus Tester Screen 531 Negative Mass Flow 58, 395
Modbus Type 9, 482, 575, 578 Negative Net Flow 58, 395
Modbus" 108 Nesting 470
Modbus/TCP 578 Boolean Blocks 470

660
Index: Net – panel

Net 163, 338, 344 OMNICOM Help 2


Net Flow 58, 395 OmniCom Logo Bar 648
Net Flowrate 421, 425, 429, 438 ONE SHOT 400, 407
Net Volume 275, 304 online 531, 540, 581, 590
Netmask 115-116 Online 11, 15, 398, 443, 464, 466, 474, 484,
Network Identifier 114 519, 587, 592, 641, 645
Contain 114 Apply button 641
New Configuration 552 Omni 3000/6000 464
Next Master 457 Online menu 590
NGL 269, 288, 297, 318, 331, 336, 340, 346 Online Menu 12
NIST 1048 350 Open 555
NIST14 163, 314, 342, 350, 385 want 555
analyzed 343, 350 Operate 2, 65, 131, 145, 207-208, 210, 245,
NIST14 Analysis Basis 343, 350 265, 282, 294, 391, 414, 418, 434,
NIST14 Component 385 449, 457, 471, 477, 587, 594
NIST14 Component Analysis 294, 349, 385 Operate Menu 434
NIST14 Reference Pressure 342 Operators 400, 406
NMI Gross Volume 190 OR 400, 433
Nmi K-Factor 191 Order 407
Non-Master Meter Proving 232 Precedence 407
Normal Mode String 442 Orifice 55, 134-135, 137, 147-148, 160, 163,
NOT 400, 406 183, 210
denoting 400 Orifice Applications 134, 163
number convertor 540 Orifice DP 135, 160
Numeric Product Name 263 Orifice DP Meter 137, 147-148
Numeric’ 470 Orifice Inside Diameter 137
Orifice Plate Meter 55
O
Orifice Plate Taps 137
Observed Density 294 Orifice Reference Temperature 137
OFF 57, 59, 400 Orifice/Venturi Expansion Coefficients 137
Official, Unofficial 236 Override 65, 329, 334
Offline 464, 466, 474, 482, 484, 587, 590- Override Code 106, 184, 186, 196, 203,
591, 596 205, 218, 223, 225, 241, 243, 252,
OKI DATA 442 258, 260, 386
OMNI beeper 526 Override Value 106, 184, 186, 196, 203,
OMNI display 527, 530 205, 218, 223, 225, 241, 243, 252,
Omni Flow Computer 114, 149, 152, 154, 258, 260, 386
156, 640, 648 Overtravel 233
Omni I/O 4, 49, 53, 64-65, 83, 97, 184, 186, Overtravel Forward Direction 62
196, 203, 205, 223, 225, 241-243, Overtravel Reverse Direction 62
258, 260, 386
P
Omni Keypad 528-529
Show/Hide 528-529 Packed Coils 460
OMNI keypad 527 Packets 124, 433
OMNI LED 525 page down 525
OMNI panel 527 page up 525
OMNI Panel 526, 529-530 Panasonic 442
OmniCom DOS 479-481, 484-491 panel 527

661
Index: parity – Process Input Assignments

parity 482, 575 Port 4, 9, 50, 68, 86, 96, 108-109, 111, 113-
Parity 9, 111 114, 131, 133, 149, 152, 154, 156
Partial Counter 515 Special Settings 109
Partial Status 515 Port Ethernet 114
Passes 234 Port number 68
Number 234 POWER 406
password 645, 647 Precedence 407
Password 11 Order 407
Paste Command 569 preferences 570
PC beeper 526 Premium Billing 461
PC Keyboard 525 Pressure 56, 60, 66, 69, 94-97, 106, 137,
Use 525 147-148, 159, 163, 183, 186, 193-194,
PD Meters Flow Pulses 163 198, 201-202, 205, 210, 216, 220-222,
Peer 131, 456-457, 459 225, 227, 230, 232, 235, 241-242,
Peer 456 245, 250, 254, 256-257, 260, 265,
Peer Setup 457 282, 294, 316, 329, 334, 338, 344,
Peer/Peer Active Flag 61 350, 388, 411, 434, 438
Phone Number 576 Pressure Compensation 270, 282, 294, 316
Physical 137, 147-148, 159-161 Pressure High Alarm 60
Physical Digital I/O Points 400 Pressure limits 278, 406
Physical Input Channel 163 API 11.3.2 279, 308
Select 163 Pressure Low Alarm 60
PID Control 55, 388-389, 391, 393, 457 Pressure Override 60
PID deadband 392 Pressure Override Value 106, 186, 241
PID Functions 393 Pressure Pe 271, 289, 301, 321
chart 393 Pressure Signal 163, 241
PID Loop Configuration 388-389 Prover 241
PID Loop Ramp Control 388, 391, 393 Primary Element 137, 147-148, 159, 161
PID Loop Tuning 388, 391 Primary Measurement Source 154, 156
PID Permissive 54, 393 Primary Setpoint 390
manipulate 393 Print Buffer Full Flag 61
PID Setpoint 66 Print Interval 442
PID Start 393 Print Interval In Minutes 442
Ping” 629 Print Interval Start Time 442
Pipe Expansion Coefficients 137 Print Priority 442
Pipe Inside Diameter 137 Printer 20, 108-109, 111, 131, 442, 464,
Pipe Reference Temperature 137
468, 473, 483, 551, 562
PLC 421, 425, 429, 438, 456-457
Printer Code 468
Plenum Charge Command 62
Printer Code’ 473
Plenum Deadband 246
Printer Condensed 442
Plenum Pressure 227, 242, 245
Printer Type 442
Plenum Vent Command 62
Printing 470, 562
Point Number 54
Boolean 470
Points 400, 421, 425, 429, 459
Process I/O 49, 64-65, 83, 97, 184, 186,
Num 459
196, 203, 205, 223, 225, 241-243
port 14, 414, 418, 421, 425, 429, 437, 442,
Modify 184, 186, 196, 203, 205, 223,
456-457, 482, 486, 575, 579, 587-588,
225, 241-243
618, 629, 631, 633, 645
Process Input Assignments 98

662
Index: Process Inputs – Receive

Process Inputs 64-65, 87-91, 94-96, 98, Prover Inlet/Outlet Temperature Dialog 243
329, 338 Prover Internal Diameter 230
Process IO 64 Prover Manufacturer 238
Product File 236, 478, 481, 484 Prover Material 238
Product Name 263, 507, 509 Prover Meter Ticket Report 442
Product number 448 Prover Operational Setup 234
Product Running 163 Prover Serial Number 238
Product Type 265, 294 Prover Setup 20, 227-228, 238
Products 4, 54, 59, 142, 163, 188, 196, 207- Prover Tag Number 238
208, 212, 218, 234, 252, 262-263, Prover Tube 230
266, 283, 295, 317, 329, 334, 338, Inside Diameter Measurement 230
344, 348-350, 386, 391, 393, 397, Prover Tube Cubical Coefficient 230
415, 448-449, 452, 466, 478, 481, Thermal Expansion 230
484, 504, 506, 508, 510, 514 Prover Type 228-229
program 525 Prover Volume/Mass 228, 232
Program Mode 525 Prover Wall Thickness 230
program version 608 Pulse Fidelity 163
Programmable 399, 406 Pulse Input 154, 156
Programmable Variable 395 Pulse - Select 154, 156
protocol 459, 531, 538, 578, 581, 634 Pulse Outputs 53, 57
Protocol 65, 86, 94-96, 108-109, 111, 114, Pulse Signal 143-144
156 K-Factor Curve 143-144
Protocol Format 578 Pulse Width 57
protocol tester 531 Pulse/Unit 57
Protocol Type 109 Pulses Per Unit 190
Prove 444 Number 190
PROVE 47 Pulses/unit 396
Prove Report 47, 163, 236, 238, 467, 484, Pulses/Unit 57
Pycnometer 196, 218, 252
491
Prover 4, 20, 55, 61, 65, 71, 89, 163, 216, Q
218, 227-230, 232, 234, 238-239, 241-
243, 245, 250-252, 254, 256-258, 260, Q-Sonic Ultrasonic Gas Flowmeter 149
402, 439, 442, 502, 514, 616
R
Plenum Pressure Signal 242
Pressure Signal 241 Ramp Hold 393
Prover Auto Prove Setup 239 Ramp Up 393
Prover Characteristics 228, 230 Setpoint 393
Prover Control 514, 616 RANGE CHECKING 407
Prover Counts 439 Raw Report 476
Prover Densitometer 65, 250 Raw view 466, 476
Prover Density - Sarasota Pulse 256 READ 421, 425, 429
Prover Density - UGC Pulse 257 Read Blocks 1-3 437-438
Prover Density Configuration Dialog 254, Read Coil Status 538
256-257 Read configuration 587, 598
Prover Density Sarasota 256 READ ONLY 43
Prover Density Solartron Liquid 254 Read/Write 424, 428, 432, 460
Prover Density UGC 257 receive 532
Prover Inlet/Outlet Pressure Dialog 241 Receive 598, 616

663
Index: Receive Message – Send

Receive Message 533 RJ45 133


RED LED 618, 649 Roll All Totalizers 43
redial wait 577 Rosemount 67, 86, 96, 135, 147, 183
Redial Wait 10 Rosemount 3095FB DP Meter 147
Redialing 577 Rosemount 3095FB Multivariable 68
Redlich-Kwong 350 Rotor 145
inputs 350 Sensing 145
Reference conditions 329, 334 RS-232 131, 133, 631
Reference Density 338 Shows 131
use 338 RS-232/RS-485 108
Reference Density Override 338 RS-232/RS-485 Port 133
Reference Density Range kg/m3 294, 316 RS-485 86, 96, 131, 631
Reference Temperature 137 Jumpered 131
Register List 535 RS-485 2-wire 631
Relative Density 69, 265, 282, 301, 320 RS-485 4-wire 631
release notes 608 Rtd 65, 106, 184, 203, 223, 243, 258
Release Notes 604 RTU 109, 414, 424, 427, 432, 538, 578
Remote Inputs 20, 101 RTU Protocol 109
Remote Setpoint I/O Assignment 389 Run Repeatability 234
Remote UP Arrow Function 55 Run Switching 207, 210
Repeat Delay 535
Repeat/Min 391 S
Report Formatting Controls 467 S&W 65, 69
Report Setup 443 S/N 163
Report String 442 Sample Time 212, 235
Report Template Editor 2, 466, 559-561 Sarasota 66, 90, 194, 216-217, 250-251
Report template files 615 Sarasota Densitometer 201, 221, 256
Report Templates 2, 444, 466, 470-471, Sarasota Pulse 194, 217, 251
474-476, 559-561, 616 satellite 573, 575, 577, 590
Report View 466, 475 Satellite 9-10, 578, 587, 616, 618
Reports 114, 350, 452, 467, 482, 484 Save 558, 615
Conditional Printing Data 467 use 558
Time Span 467 Save As 551, 558, 615
Reports folder 464 Save As Command 557-558
file under 464 Save As dialog 556-558, 615
Reports/Archive 484 scan rate 575
Results Interval 414 Scan Rate 579, 619
Retransmit 124 Scratch Pad Booleans 405
Retrieve Archive Data 492 Scroll bars 623
retry count 575 scrollbars 623
Retry Count 154, 156 SE Firmware 629
Retry Timer 154, 156, 458 SE Modules 108, 114, 124, 133, 629
Reverse 149, 152, 154, 157 Secondary Setpoint 390
Reverse GOTOs 402 Security 541
Reynolds Number 162 Sediment & Water 69
Remaining 162 send 533
Values 162 Send 54, 442, 597, 649
RISING EDGE 400, 407 ASCII 442

664
Index: SeniorSonic – Subnet Mask

CRC 533 Solartron Liquid Densitometer


Modbus 54 Constants 198, 220, 254
Omni 649 Solartron Pulse 194, 217, 251
SeniorSonic 155 Source Index 459
Compared 155 Special Billing Threshold 461
Sensing 145 Specific Gravity 69, 265, 282, 329, 334, 350
Rotor 145 value 265, 282
Sequence 397, 457 Stability Check 235
Serial - Select Serial Data 154, 156 Stainless 161, 230
Serial Modules 114, 131, 133 Stainless Steel 137, 230
Serial Password 589, 635 Start Up 393
Serial Port 109, 418, 437, 442, 456 Startup Permissive 54
Serial/Ethernet 50 Startup Ramp 393
Setpoint 389, 393 Startup/Shutdown 54
Ramp Up 393 Statements 399
Setpoint Blocks 437, 441 Station 4, 20, 54, 58-59, 65, 196, 207-208,
Setup Communications Screen 7-10, 531, 210, 212, 216-218, 220-223, 225, 250,
574-575 252, 395, 404, 438, 442, 448-449,
Setup Menu 7 461, 504, 506, 508, 510, 525
Setup Modem Screen 10, 576-577 Alarm Limits 207
Setup PC beeper 526 Batch Preset Warning 209
Setup Screen 329, 334, 338, 344 Station Alarms/Status Points 61
Setup Sites 565, 573, 575, 631, 633 Station Density - Sarasota Pulse 221
Setup Sites Screen 7-10 Station Density - UGC Pulse 222
Setup Unit 578, 631 Station Density Configuration Dialog 220-
Setup Unit Screen 8, 576 222
SHIFT+F1 612 Station Density Sarasota 221
Shutdown Ramp 393 Station Density Solartron Liquid 220
Signal Type 65 Station Density UGC 222
site 590 Station End Batch 54
Site 7, 12 Station High Flow Alarm 209
Site name 482 Station Information 208
Shows 482 Station Low Flow Alarm 209
Site Screen 633 Station Setup 207-208, 449, 504, 508, 510
sites 573, 575 Station Setup Totals 504, 508
Sites 9 Station Totals 207-208, 449, 510
Slave 459 statistics 583
Modbus ID number 459 status bar 466, 580, 586, 618
Snapshot 47, 54, 61, 402, 409, 433, 444, Status flags 402
466, 474, 478-479, 484, 487, 494 Stop' Ramp Down 393
Snapshot Report 478 Fully Closed 393
software version 608 stop bits 482, 575, 618
Solartron 66, 90, 194, 198-199, 217, 220, Number 618
251, 254, 386 Stop Bits 9, 111
Solartron Density Pulse 198-199, 220, 254 String 421, 425, 429, 532, 577
Solartron Gas 216, 250 sent 577
Solartron Gas Densitometer Factors 199 Size 532
Solartron Liquid 216, 250 Subnet Mask 114

665
Index: SUBTRACT – Text Archive

SUBTRACT 406 Table 53B Refined Products 295, 317


Sugar Land 640, 648 Table 53B/54B 295, 317
suite 640, 648 Table 53D Generalized Lubricating Oils Cor-
SV 67, 86, 96, 149, 152, 154, 156, 163 rection 294
Daniel Ultrasonic 154 Observed Density 294
FLOWSIC 600 Ultrasonic 156 Table 53D/54D 296
FMC MPU 1200 152 Table 54 Crude Oil 294, 316
Instromet Ultrasonic 149 Table 54A 294, 316
SV Combo Module Provides 86 selecting 294, 316
SV Combo Modules 64-65, 86, 96, 106, Table 54A Generalized Crude Oils 294, 316
149, 152, 163, 184, 203, 223, 243, 258 Table 54A Modified 303
SV Modbus ID 154, 156 Table 54B 295, 317
SV module 629 Table 54B Refined Products 294, 316
SV Port 68, 149, 152, 154, 156 Table 54C 296, 318, 339, 345
SV Port Number 68 Table 54D 296
Switch Bar Temperature 248 Table 54D Generalized Lubricating Oils Cor-
System Date 15, 18 rection 294
System Maximize Command 625 Volume 296
System Minimize Command 626 Table 54E 300, 321
System Time 15, 19 Table Range 270, 288, 298, 319
Table Select 265, 282, 294, 316
T Tables 23E 265
TAB 525 Tables 53E 294
Tab’ 466 Tag ID 65
Table 23A 265, 282 Tag Number Using 238
limits 265 Target Slave ID 459
Table 23A Generalized Crude Oils 265, 282 TCP 482, 578
Table 23A Modified 273 TCP Port 575, 619
Table 23A/24A 265, 282 TCP/IP 9, 124, 482, 573, 575, 578, 587,
Table 23B 266, 283 590, 616, 619
Table 23B Refined Products 266, 283 TCP/IP Connections 576, 579
Table 23B/24B 266, 283 TCP/IP initial character delay 575
Table 24A 265, 282 Telnet 629
selecting 282 Temperature 94-96, 184, 265, 282, 294,
Selecting 265 316
Table 24A Generalized Crude Oils 265, 282 Temperature High Alarm 60
Table 24A Modified 273 Temperature Low Alarm 60
Table 24B 266, 283 Temperature Override Value 184, 243
Table 24B Refined Products 265, 282 Temperature Range 267, 286
Table 24C 267, 331, 335 Temperature, degF 278
Table 24E 272 Temperature, TP 27 282
Table 53 Crude Oil 294, 316 Template Editor 466
Table 53/54A 294, 316 Terminal Block Diagram 105
Table 53A 294, 316 Test Comms Screen 538, 540
limits 294 test communications 533
Table 53A Generalized Crude Oils 294, 316 Test Communications Screen 533
Table 53A Modified 303 Test message 531
Table 53B 294, 316 Text Archive 492-493

666
Index: Thermal – User Defined

Thermal 265, 294 archive save event 433


Thermal Expansion 137, 230 trouble 628-629, 631, 633-634, 637, 640
Prover Tube Cubical Coefficient 230 Troubleshooting 628, 634, 637, 640
Threshold 239, 461 Troubleshooting Ethernet
Threshold %DP 210 Communications 629
Threshold Settings 461 Troubleshooting Modem Connections 633
Ticket number 513 Troubleshooting Serial
appended 513 Communications 631
Tile command 602 True 400, 470
time difference 581 Turbine/PD 135, 143
Time Span 467
Reports 467 U
Timed Out 631
UGC 90, 194, 216-217, 250-251
Timeout 577
UGC densitometer constants 222
TIMER COMPARE 400
UGC Densitometer Constants 202, 257
TIMER FUNCTION 400
UGC Densitometers 66
timing 575
UGC Density Pulse 202, 222, 257
Timing 9
Ultrasonic Flowmeter Tube 161
Title Bar 617, 625-626
Ultrasonic FMC Kongsberg 153
To Edit Serial Passwords 11
Ultrasonic Instromet 151
toolbar 467, 552, 555, 557, 566-569, 580,
K-Factor Curve 151
585-586, 612, 615
Un-Adj Set 146
File’ menu 466
Un-Adjust Selection 146
Total Counts 236
Un-Adjusted 146
TOTALIZE 407
Disable 146
Totalizer 43, 407, 461
Enable 146
position 410
Uncorrected IV 506, 508
Totalizer Decimal Places 43
Unidirectional Reports 234
Totalizers 15, 43, 153, 155, 158, 208, 407,
Unit Name 578
453, 461, 504, 506, 508 Units 190, 578
TP 27 265, 294, 316 description 578
TP15 271, 290, 301, 321, 331, 336, 340, Following 190
346 Unpacking Booleans 404
Refer 265, 282, 294, 316 UP/DOWN 390
TP16 269, 288 updates 610
TP16M 298, 319 US Robotics 633
Transaction Group 456, 459 Use BS&W 163
Transducer 65 Use Common Batch Stack 449
Transducer Density 163 Use Default Precision’ 471
transmit 531 Use Downstream Pressure 137
Transmit 385, 419, 474, 597, 616 Use GC2 on GC1 415
Omni 385, 474, 592 Use LCF 188
Transmit Message 533 Use Live Density 163, 314
Transmit Omni Configuration 517 Use Meter Factor 163
Trapil Alarms & Traning 214 Use Observed Density 330, 338
Trapil Control 515 Use Upstream Temperature 137
Trigger 407, 433 User 588
500ms 406 User Defined 531

667
Index: User Displays – Zero Scale

User Displays 397 Weight 265


user message 530 Water Content 350
User Messages 525, 529-530 Welcome 2
User Notes 604, 609 Width’ 471
User Programmable Accumulators 58 Window menu 555, 600
User Variable 411 Use 555
Using Help command 613 WINDOW TILE 602
WinPanel 525, 528-529, 587, 616
V WinPanel Menu 528
V-Cone 135, 159-160, 162, 183 WinPanel User Menu 529
V-Cone Flow Coefficients 162 Write 407, 421, 425, 429
V-Cone Meter 159, 162 WRITE ASCII STRING 407
Value @ 20mA 76 WRITE ASCII STRING Operator 407
Value @ 4mA 76 Z
Van-der-Waals EOS 350
Variable 399 Zero Scale 67, 106, 184, 186, 196, 203,
Variable Assignment 389 205, 218, 223, 225, 241-243, 252,
Variable Statements 406 258, 260, 386, 389
VCF 163, 268, 287, 296, 320, 329, 334,
339, 345
Venturi 139
version 608
Version 2003 137
View Communications Log 528-529, 581
View Omni Keypad 527
View RS-232 Connections 131
View RS-485 Connections 132
View Toolbar command 585
Viewing Options 466
Virtual 64-65
Virtual Inputs 83, 100
Viscosity Linearization 143, 188
Volume Correction Factor 268, 287, 296,
318
Volume/Mass 232
Volumetric 190
VOS 150, 153, 155, 157
VOS Deviation 153, 155, 157
VSAT Communications 124
VSAT Systems 419
W
WARNING 111, 145, 517, 575
Band 145
Band High Limit 145
Band Low Limit 145
Water 332, 340
measuring 331, 341

668

You might also like