Sei sulla pagina 1di 523

OmniCom Help

Table Of Contents
OmniCom Help ................................................................................................................................ 1
Topics........................................................................................................................................... 1
Configuration ................................................................................................................................... 2
Configuration................................................................................................................................ 2
Topics ....................................................................................................................................... 2
General Setup .............................................................................................................................. 3
General Setup .......................................................................................................................... 3
Topics ................................................................................................................................... 3
Setup ........................................................................................................................................ 4
Settings ................................................................................................................................. 4
System Date ............................................................................................................................. 6
System Time............................................................................................................................. 7
Equipment List.......................................................................................................................... 8
Settings ................................................................................................................................. 8
Factors and Constants ........................................................................................................... 10
Settings ............................................................................................................................... 10
Totalizers ................................................................................................................................ 13
Settings ............................................................................................................................... 13
Decimal Resolution ................................................................................................................ 15
Settings ............................................................................................................................... 15
Omni IO...................................................................................................................................... 17
Omni I/O ................................................................................................................................. 17
Modules .................................................................................................................................. 18
Settings ............................................................................................................................... 18
Digital IO................................................................................................................................. 19
Digital Channels.................................................................................................................. 19
Digital IO Module ................................................................................................................ 20
Process IO.............................................................................................................................. 30
Process I/O ......................................................................................................................... 30
Process Inputs .................................................................................................................... 31
Analog Outputs ................................................................................................................... 34
'A' Type Combo Modules.................................................................................................... 36
'B' Type Combo Modules.................................................................................................... 37
'C' Type Combo Modules.................................................................................................... 38
'E' Type Combo Modules.................................................................................................... 39
'E/D' Combo Modules ......................................................................................................... 40
'H' Combo Modules............................................................................................................. 41
'HV' Combo Modules .......................................................................................................... 42
SV Module Setup................................................................................................................ 43
'SV' Type Combo Modules ................................................................................................. 44
Virtual Inputs ....................................................................................................................... 45
Current Assignments.............................................................................................................. 46
Current Assignments .......................................................................................................... 46
Process Input Assignments ................................................................................................ 47
Remote Inputs .................................................................................................................... 48
Virtual Input Assignments ................................................................................................... 49
Analog Output Assignments ............................................................................................... 50
Digital Input Assignments ................................................................................................... 51
I/O Summary....................................................................................................................... 52
Terminal Block Diagram ..................................................................................................... 53
Auxiliary Inputs ....................................................................................................................... 54
Settings ............................................................................................................................... 54
Ports ........................................................................................................................................... 55

ii
Table Of Contents

Ports ....................................................................................................................................... 55
Topics ................................................................................................................................. 55
Protocol .................................................................................................................................. 56
Settings ............................................................................................................................... 56
Hardware Setup ..................................................................................................................... 58
Settings ............................................................................................................................... 58
Timing..................................................................................................................................... 59
Ethernet Setup ....................................................................................................................... 60
Settings ............................................................................................................................... 60
Ethernet Configuration ........................................................................................................... 61
Ethernet Configuration........................................................................................................ 61
Ethernet .............................................................................................................................. 62
Host..................................................................................................................................... 64
Repeater ............................................................................................................................. 65
Security ............................................................................................................................... 67
Advanced ............................................................................................................................ 69
Logging ............................................................................................................................... 70
Printing................................................................................................................................ 71
SysLog Examples ............................................................................................................... 73
Serial I/O Module Types 686005 & 686205 ........................................................................... 75
SE Modules ............................................................................................................................ 77
Meter Run .................................................................................................................................. 78
Meter Run............................................................................................................................... 78
Topics ................................................................................................................................. 78
Flowmeters ............................................................................................................................. 79
Flowmeter Setup................................................................................................................. 79
Orifice DP Meter ................................................................................................................. 81
Physical Meter Run............................................................................................................. 85
Turbine/PD Meter ............................................................................................................... 86
Rosemount 3095FB DP Meter............................................................................................ 87
Honeywell SMV3000 DP Meter .......................................................................................... 88
Instromet Ultrasonic Meter.................................................................................................. 89
Instromet Ultrasonic Meter - Physical Meter Run ............................................................... 92
V-Cone Meter ..................................................................................................................... 93
V-Cone Flow Coefficients ................................................................................................... 94
FMC MPU 1200 Meter........................................................................................................ 95
Equimeter Auto-Adjust Turbine Meter ................................................................................ 97
Coriolis Meter...................................................................................................................... 99
Daniel Ultrasonic Meter .................................................................................................... 100
FLOWSIC 600 Ultrasonic ................................................................................................. 102
DP Setup........................................................................................................................... 105
Meter Run Setup .................................................................................................................. 106
Meter Run Setup (Firmware Versions 20 and 24)................................................................ 107
Settings ............................................................................................................................. 107
Meter Run Setup (Firmware Versions 21 and 25)................................................................ 111
Settings ............................................................................................................................. 111
Meter Run Setup (Firmware Versions 22 and 26)................................................................ 114
Settings ............................................................................................................................. 114
Meter Run Setup (Firmware Versions 23 and 27)................................................................ 118
Settings ............................................................................................................................. 118
K-Factors With Curve ........................................................................................................... 123
Settings ............................................................................................................................. 123
Modbus Addresses ........................................................................................................... 124
Meter Run Temperature ....................................................................................................... 126
Settings ............................................................................................................................. 126
Meter Run Pressure ............................................................................................................. 127

iii
OmniCom Help

Settings ............................................................................................................................. 127


Density Gravity ..................................................................................................................... 128
Density/Gravity ................................................................................................................. 128
Density/Gravity Configuration ........................................................................................... 129
Density/Gravity Setup ....................................................................................................... 130
Density/Gravity Temperature............................................................................................ 132
Density/Gravity Pressure .................................................................................................. 134
Meter Run Density - Solartron Liquid ............................................................................... 135
Meter Run Density - Solartron Gas Pulse ........................................................................ 136
Meter Run Density - Sarasota Pulse ................................................................................ 137
Meter Run Density - UGC Pulse....................................................................................... 138
Viscosity Linearization.......................................................................................................... 139
Settings ............................................................................................................................. 139
Station ...................................................................................................................................... 140
Station .................................................................................................................................. 140
Topics ............................................................................................................................... 140
Station Setup ........................................................................................................................ 141
Settings ............................................................................................................................. 141
Interface Detection ............................................................................................................... 143
Settings ............................................................................................................................. 143
Run Switching ...................................................................................................................... 144
Settings ............................................................................................................................. 144
Trapil Alarms and Training ................................................................................................... 146
Hydraulic Alarm Sampling ................................................................................................ 146
Training ............................................................................................................................. 146
Density Gravity ..................................................................................................................... 147
Density/Gravity ................................................................................................................. 147
Density/Gravity Configuration ........................................................................................... 148
Density/Gravity Setup ....................................................................................................... 149
Density/Gravity Temperature............................................................................................ 150
Density/Gravity Pressure .................................................................................................. 152
Station Density - Solartron Liquid ..................................................................................... 153
Station Density - Solartron Gas Pulse .............................................................................. 154
Station Density - Sarasota Pulse ...................................................................................... 155
Station Density - UGC Pulse ............................................................................................ 156
Prover....................................................................................................................................... 157
Prover ................................................................................................................................... 157
Topics ............................................................................................................................... 157
Configuration ........................................................................................................................ 158
Prover ............................................................................................................................... 158
Prover Type ...................................................................................................................... 159
Prover Characteristics ...................................................................................................... 160
Prover Volume/Mass ........................................................................................................ 162
Prover Operational Setup ................................................................................................. 164
Prover Auto Prove Setup (Firmware Versions 20 and 24) ............................................... 167
Prover Setup ..................................................................................................................... 169
Density Gravity ..................................................................................................................... 170
Density/Gravity ................................................................................................................. 170
Density/Gravity Configuration ........................................................................................... 171
Density/Gravity Setup ....................................................................................................... 172
Density/Gravity Temperature............................................................................................ 173
Density/Gravity Pressure .................................................................................................. 175
Prover Density - Solartron Liquid...................................................................................... 176
Prover Density - Solartron Gas Pulse............................................................................... 178
Prover Density - Sarasota Pulse....................................................................................... 179
Prover Density - UGC Pulse ............................................................................................. 180

iv
Table Of Contents

Inlet/Outlet Temperature ...................................................................................................... 181


Settings ............................................................................................................................. 181
Inlet/Outlet Pressure............................................................................................................. 182
Settings ............................................................................................................................. 182
Switch Bar Temperature....................................................................................................... 183
Settings ............................................................................................................................. 183
Plenum Pressure.................................................................................................................. 185
Settings ............................................................................................................................. 185
Plenum Pressure Setup ....................................................................................................... 186
Settings: ............................................................................................................................ 186
Products ................................................................................................................................... 187
Products ............................................................................................................................... 187
Product ................................................................................................................................. 188
Settings ............................................................................................................................. 188
Measurement Algorithm (Firmware Versions 20 and 21) .................................................... 189
Settings ............................................................................................................................. 189
Pressure Compensation ................................................................................................... 193
Equilibrium Pressure Pe ................................................................................................... 193
Pressure Compensation ................................................................................................... 194
Equilibrium Pressure Pe ................................................................................................... 195
Measurement Algorithm (Firmware Version 22) .................................................................. 204
Settings ............................................................................................................................. 204
Pressure Compensation ................................................................................................... 210
Equilibrium Pressure Pe ................................................................................................... 210
Pressure Compensation ................................................................................................... 211
Equilibrium Pressure Pe ................................................................................................... 212
Measurement Algorithm (Firmware Versions 24 and 25) .................................................... 215
Settings ............................................................................................................................. 215
Pressure Compensation ................................................................................................... 220
Equilibrium Pressure Pe ................................................................................................... 220
Pressure Compensation ................................................................................................... 221
Equilibrium Pressure Pe ................................................................................................... 221
Measurement Algorithm (Firmware Version 26) .................................................................. 230
Settings ............................................................................................................................. 230
Pressure Compensation ................................................................................................... 234
Equilibrium Pressure Pe ................................................................................................... 234
Pressure Compensation ................................................................................................... 235
Equilibrium Pressure Pe ................................................................................................... 235
Setup (Firmware Versions 20 and 21) ................................................................................. 238
Settings ............................................................................................................................. 238
Setup (Firmware Version 22) ............................................................................................... 242
Settings ............................................................................................................................. 242
Setup (Firmware Versions 24 and 25) ................................................................................. 246
Settings ............................................................................................................................. 246
Setup (Firmware Version 26) ............................................................................................... 250
Settings ............................................................................................................................. 250
Meter Factor Curve .............................................................................................................. 253
Fluid Products .......................................................................................................................... 254
Fluid Products ...................................................................................................................... 254
Topics ............................................................................................................................... 254
Fluid Setup ........................................................................................................................... 255
Settings ............................................................................................................................. 255
Live Input .............................................................................................................................. 262
Settings ............................................................................................................................. 262
Detailed Analysis .................................................................................................................. 263
Settings ............................................................................................................................. 263

v
OmniCom Help

NIST14 Component Analysis ............................................................................................... 264


Settings ............................................................................................................................. 264
Gas Chromatograph ................................................................................................................ 265
Gas Chromatograph............................................................................................................. 265
Topics ............................................................................................................................... 265
Gas Chromatograph Setup .................................................................................................. 266
Settings ............................................................................................................................. 266
Gas Chromatograph Components ....................................................................................... 268
PID Control............................................................................................................................... 270
PID Control ........................................................................................................................... 270
Topics ............................................................................................................................... 270
PID Loop Configuration ........................................................................................................ 271
Settings ............................................................................................................................. 271
PID Loop Ramp Control ....................................................................................................... 273
Settings ............................................................................................................................. 273
PID Loop Tuning .................................................................................................................. 275
Settings ............................................................................................................................. 275
Front Panel Counters ............................................................................................................... 277
Settings................................................................................................................................. 277
User Displays ........................................................................................................................... 279
Settings................................................................................................................................. 279
Import/Export User Displays................................................................................................. 280
Statements ............................................................................................................................... 281
Statements ........................................................................................................................... 281
Topics ............................................................................................................................... 281
Import/Export Boolean/Variable Statement Configurations.............................................. 281
Boolean Statements ............................................................................................................. 282
Variable Statements ............................................................................................................. 287
Custom Packets ....................................................................................................................... 293
Custom Packets ................................................................................................................... 293
Settings ............................................................................................................................. 294
Modbus Packets ............................................................................................................... 294
Import/Export Custom Packet Configurations .................................................................. 294
Modbus Packet 001.............................................................................................................. 295
Modbus Packet 201.............................................................................................................. 299
Modbus Packet 401.............................................................................................................. 302
Archives ................................................................................................................................... 306
Settings................................................................................................................................. 306
Import/Export Archive Configurations .................................................................................. 307
Allen Bradley PLC .................................................................................................................... 308
Allen-Bradley PLC ................................................................................................................ 308
Topics ............................................................................................................................... 308
Import/Export Allen-Bradley Configurations ..................................................................... 308
Command Block ................................................................................................................... 309
Settings ............................................................................................................................. 309
Read Blocks 1-3 ................................................................................................................... 310
Settings ............................................................................................................................. 310
Setpoint Block ...................................................................................................................... 312
Settings ............................................................................................................................. 312
Local Printer ............................................................................................................................. 313
Settings................................................................................................................................. 313
Report Setup ............................................................................................................................ 314
Settings................................................................................................................................. 314
Batch ........................................................................................................................................ 318
Batch .................................................................................................................................... 318
Topics ............................................................................................................................... 318

vi
Table Of Contents

Batch Setup .......................................................................................................................... 319


Settings ............................................................................................................................. 319
Batch Scheduling ................................................................................................................. 321
Settings ............................................................................................................................. 321
Peer to Peer ............................................................................................................................. 324
Peer to Peer ......................................................................................................................... 324
Topics ............................................................................................................................... 324
Peer to Peer Setup............................................................................................................... 325
Settings ............................................................................................................................. 325
Transaction Group................................................................................................................ 327
Settings ............................................................................................................................. 327
Premium Billing ........................................................................................................................ 329
Configuration Print ................................................................................................................... 330
Blank Page............................................................................................................................... 331
Report Template Editor ............................................................................................................... 332
Report Template Editor ............................................................................................................ 332
Report Templates..................................................................................................................... 335
Element Setup.......................................................................................................................... 336
Boolean True/False Block .................................................................................................... 336
Nesting Boolean Blocks.................................................................................................... 336
Boolean Block Control Points ........................................................................................... 336
Database Point ..................................................................................................................... 337
Insert Printer Code ............................................................................................................... 339
Report View.............................................................................................................................. 340
Raw View ................................................................................................................................. 341
Operate........................................................................................................................................ 342
Operate .................................................................................................................................... 342
Topics ................................................................................................................................... 342
Control...................................................................................................................................... 343
Control .................................................................................................................................. 343
Topics ............................................................................................................................... 343
Batch .................................................................................................................................... 344
Batch Control .................................................................................................................... 344
Batch Control - Meter Runs .............................................................................................. 346
Batch Control - Station...................................................................................................... 348
Batch Stack....................................................................................................................... 350
Batch Ticket (Application 22) ............................................................................................ 352
Prover Control ...................................................................................................................... 353
Trapil Control ........................................................................................................................ 354
Current Reports........................................................................................................................ 355
Current Reports .................................................................................................................... 355
Topics ............................................................................................................................... 355
Snapshot .............................................................................................................................. 356
Status ................................................................................................................................... 357
Product File .......................................................................................................................... 358
Site List................................................................................................................................. 359
Historical Reports..................................................................................................................... 360
Reports ................................................................................................................................. 360
Topics ............................................................................................................................... 360
Historical Alarm (500) or Alarm (150) Report....................................................................... 361
Historical Audit Trail (150) Report ........................................................................................ 362
Last Local Snapshot............................................................................................................. 363
Historical Batch Report......................................................................................................... 364
Historical Daily Report.......................................................................................................... 365
Historical Prove Report ........................................................................................................ 366
Retrieve Archive Data .............................................................................................................. 367

vii
OmniCom Help

Retrieve Archive Data .......................................................................................................... 367


Topics ............................................................................................................................... 367
Text Archive.......................................................................................................................... 368
Archive Data 701-710........................................................................................................... 369
Data Retrieval ................................................................................................................... 369
Data Registers .................................................................................................................. 369
Modicon Compatible Floats .............................................................................................. 370
Alarm (711)........................................................................................................................... 371
Alarm Record Format ....................................................................................................... 371
Data Registers .................................................................................................................. 371
Modicon Compatible Floats .............................................................................................. 372
Audit (712) ............................................................................................................................ 373
Audit Record Format........................................................................................................ 373
Data Registers .................................................................................................................. 373
Modicon Compatible Floats .............................................................................................. 374
Archive Maintenance ............................................................................................................... 375
Diagnostics .................................................................................................................................. 376
Diagnostics............................................................................................................................... 376
I/O Overview ............................................................................................................................ 377
WinPanel.................................................................................................................................. 378
WinPanel .............................................................................................................................. 378
Mimic OMNI Panel Beeper (Setup menu)............................................................................ 379
OMNI Keypad (View menu).................................................................................................. 380
WinPanel Menu .................................................................................................................... 381
User Message ...................................................................................................................... 382
WinPanel User Menu ........................................................................................................... 383
Modbus Tester ......................................................................................................................... 384
Test Communications Screen .............................................................................................. 384
Register List.......................................................................................................................... 387
Diagnostic Convertor ............................................................................................................ 390
Data Types (Test Comms Screen)....................................................................................... 391
HowTo ......................................................................................................................................... 393
Getting Started ......................................................................................................................... 393
How To Make a Connection..................................................................................................... 394
How To Configure Sites ........................................................................................................... 395
How To Configure Communications Parameters .................................................................... 396
How To Configure Modem Settings ......................................................................................... 397
How To Configure Units ........................................................................................................... 398
How To Edit Serial Passwords................................................................................................. 399
Menus .......................................................................................................................................... 400
Actions ..................................................................................................................................... 400
Action menu commands....................................................................................................... 400
Connect Screen (Actions | Online menu) ............................................................................. 401
Offline (Actions menu).......................................................................................................... 402
Log On (Actions menu) ........................................................................................................ 403
Log Off (Actions menu) ........................................................................................................ 404
Actions Online Data Sync..................................................................................................... 405
Receive (Actions menu) ....................................................................................................... 406
Transmit (Actions menu) ...................................................................................................... 407
Archives Disabled on Configuration Write............................................................................ 408
Actions Online Disconnect ................................................................................................... 409
Operate Control before data sync ........................................................................................ 410
Actions Online RX/TX........................................................................................................... 411
Actions Online TX Check ..................................................................................................... 412
Edit ........................................................................................................................................... 413
Edit menu commands........................................................................................................... 413

viii
Table Of Contents

Edit Undo.............................................................................................................................. 414


Cut command (Edit menu) ................................................................................................... 415
Copy command (Edit menu)................................................................................................. 416
Paste Command (Edit menu) ............................................................................................... 417
Preferences (Edit Menu) ...................................................................................................... 418
Settings ............................................................................................................................. 418
Log Communications (Edit menu)........................................................................................ 420
Setup Sites (Edit menu) ....................................................................................................... 421
Settings ............................................................................................................................. 421
Setup Communications (Edit | Setup Site ) .......................................................................... 422
Settings ............................................................................................................................. 422
Setup Modem (Edit | Sites Screen ) ..................................................................................... 424
Settings ............................................................................................................................. 424
Setup Unit............................................................................................................................. 425
Settings ............................................................................................................................. 425
File ........................................................................................................................................... 427
File Menu Commands .......................................................................................................... 427
File Application ..................................................................................................................... 428
File Version and Revision..................................................................................................... 429
New Configuration (File menu)............................................................................................. 430
Open Existing Configuration File (File menu) ...................................................................... 431
Close Command (File menu) ............................................................................................... 432
Save Command (File menu) ................................................................................................ 433
File Save Template .............................................................................................................. 434
Save As Command (File menu) ........................................................................................... 435
File Import............................................................................................................................. 436
File Import Template ............................................................................................................ 437
File Export Template ............................................................................................................ 438
Print Setup Command (File menu)....................................................................................... 439
1, 2, 3, 4 Command (File menu) .......................................................................................... 440
Exit Command (File menu)................................................................................................... 441
Help .......................................................................................................................................... 442
Help menu commands ......................................................................................................... 442
Release Notes (Help menu) ................................................................................................. 443
User Notes (Help menu)....................................................................................................... 444
Check For Updates (Help menu).......................................................................................... 445
About Command (Help menu).............................................................................................. 446
Index command (Help menu) ............................................................................................... 447
Using Help command (Help menu) ...................................................................................... 448
Context Help Command ....................................................................................................... 449
View ......................................................................................................................................... 450
View menu commands ......................................................................................................... 450
Communications Log (View menu) ...................................................................................... 451
Settings ............................................................................................................................. 451
Communications Statistics (View menu).............................................................................. 453
Status Bar command (View menu) ...................................................................................... 455
Toolbar command (View menu) ........................................................................................... 456
Window .................................................................................................................................... 457
Window menu commands .................................................................................................... 457
Tile command (Window menu)............................................................................................. 458
Cascade command (Window menu) .................................................................................... 459
Window 1, 2,......................................................................................................................... 460
TroubleShooting .......................................................................................................................... 461
Trouble Shooting...................................................................................................................... 461
Topics ................................................................................................................................... 461
Ethernet Communications Trouble Shooting ........................................................................... 462

ix
OmniCom Help

Board checks: ................................................................................................................... 462


Connection Errors ............................................................................................................. 462
Communications Log ........................................................................................................ 462
Ethernet Debug Mode....................................................................................................... 462
Serial Communications Trouble Shooting ............................................................................... 464
No Connection or Timed Out on connect: ........................................................................ 464
Exception Code 02 on connect......................................................................................... 464
Timed out waiting for a response messages: ................................................................... 464
Invalid CRC errors: ........................................................................................................... 464
The number of bytes returned from the unit is not correct errors: .................................... 464
Communications Log ........................................................................................................ 464
Modem Connections Trouble Shooting ................................................................................... 466
Starts to initialize but quits before dialing: ........................................................................ 466
Dials the number but does not connect: ........................................................................... 466
Network Printing Trouble Shooting .......................................................................................... 467
Reports are not Printing ....................................................................................................... 467
SE Module Printer Error Codes............................................................................................ 467
Exception Codes ...................................................................................................................... 469
Trouble Shooting - Contact Us................................................................................................. 472
Standard Interface ....................................................................................................................... 473
Close command (Control menus) ............................................................................................ 473
Move command (Control menu) .............................................................................................. 474
No Help Available..................................................................................................................... 475
Restore command (Control menu)........................................................................................... 476
Scroll bars ................................................................................................................................ 477
Size command (System menu)................................................................................................ 478
Status Bar ................................................................................................................................ 479
Maximize command (System menu)........................................................................................ 481
Minimize command (application Control menu)....................................................................... 482
Title Bar.................................................................................................................................... 483
Toolbar ..................................................................................................................................... 484
Apply Bar ..................................................................................................................................... 486
OmniCom Logo Bar ..................................................................................................................... 487
Communication LEDs .................................................................................................................. 488
Edit Serial Passwords.................................................................................................................. 489
Password ..................................................................................................................................... 490
Print Lists ..................................................................................................................................... 491
Index ............................................................................................................................................ 493

x
OmniCom Help
Last Modified August 28, 2008

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 application,
based upon your configured selections.

Note: In the configuration screens you may use ALT-M on a field to display the Modbus Register
Number used in the Omni. Use ALT-L on an edit field to display the range of the entry.

Topics
Below are links to the main topic categories of Configuring the Omni. Click on a link to go to that
category.

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

1
Configuration
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
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 Configuration category. Click on a link to go to
that topic.

Allen Bradley PLC


Auxiliary Inputs
Archives
Batch
Boolean Statements
Configuration Print
Custom Packets
Fluid Products
Front Panel Counters
Gas Chromatograph
General Setup
Meter Run
Omni I/O
Peer to Peer
PID Control
Ports
Premium Billing
Printer
Products
Prover
Report Setup
Station
User Displays
Variable Statements

2
Configuration

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 & Constants
Totalizers
Decimal Resolution

3
OmniCom Help

Setup

The Setup dialog within the Omni General Setup category is for entering Omni identification
information. 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 selections, press the [Apply] button to set.
Settings

The items listed below are descriptions of each setting option within the Setup dialog. Click on a
setting 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.

Daylight Savings
Select this option if you want the Omni to automatically adjust for daylight savings time.
When selecting 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/02 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 firmware. (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 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 automatically 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

4
Configuration

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 up)
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.

5
OmniCom Help

System Date

Enter the date using MM/DD/YY format or DD/MM/YY depending upon the date format selected
in the Setup Screen.

6
Configuration

System Time

Enter the time using HH:MM:SS format.

7
OmniCom Help

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 (applications 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 up.)

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 settings 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.

Quality (applications 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.

8
Configuration

Options (applications 23 and 27)


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

9
OmniCom Help

Factors and Constants

The Factors and Constants dialog within the Omni General Setup category is for entering
application 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
dialog. 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. i.e. High limit is 100 deg.F, Low limit is 20 deg.F, Alarm
deadband is set to 2 percent. A transducer input which exceeded 100 deg.F
will set the 'high alarm'. The transducer signal must drop 2 percent below the
high alarm setpoint (98 deg.F) before the alarm will clear.

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 leaving 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 active, it will not be
recorded in the log. Enter '0' seconds if you would like to record the alarm
every time it occurs.

Constants
Flowrate Average Factor: This entry is only used for turbine meter runs. It has
no function when using orifice devices. The flow averaging factor is the
number of calculation cycles used to smooth the displayed flowrate. A number
1-99 will be accepted. (A calculation cycle is 500ms).

Weight of Water at 60degF: The weight of a barrel of water at 60 deg.F 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 gr/cc to lb/BBL sometimes given as 350.507. (Default = 350.161
lb/BBL).

Weight of Water at 15degC: The weight of a kilogram of water at 15 deg.C and


101.325 kPa absolute. It is used to convert from specific gravity units to
density (kg/m3) for calculating mass. (Default = 999.1 kg/m3).

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
'Specific Gravity' entry in the 'Fluid Data and Analysis' menu. Entering '0'
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 conditions'.
(Default for app 23 = 0.0763210 lb/ft3, Default for app 27 = 1.225410 kg/m3).

10
Configuration

Molecular Weight of Air: This entry is needed only for natural gas
measurement where the Redlich-Kwong method is selected. (Default =
28.9626).

Conditions
Pressure Units: For English versions the Pressure units are fixed at PSI. For
Metric versions you may select which units you would like to use, KiloPascals,
Bar, or Kilogram per square centimeter. The units are configurable for
firmware versions 26.74.10+ however for any previous version the units are
fixed at KiloPascals.

Atmospheric Pressure: This is used to convert flowing pressure readings to


absolute pressure units. If the pressure sensor provides pressure in absolute
instead of gauge the Atmospheric Pressure should be set to zero so that no
conversion takes place. (Default for English versions = 14.696 PSIA. Default
for Metric versions = 101.325 kPa.)

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

Base Temperature: Enter the contract base temperature in degrees F or C.


(Note: for firmware v27.74.19 and up this field was moved to the Fluid
Products Setup screen.)
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 barrels. (Application 21
Default = 5.614555)

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. (Application 23 Default = 7.480556. Note: if a zero is entered,
the Omni will set to the default value automatically when used)

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 in
version 21 firmware and the Anhydrous Ammonia in version 20.74.22+
firmware require density to be measured using lb/ft3. Enter the conversion

11
OmniCom Help

factor needed to convert grams/cc to lb/ft3. (20.74.22+ and Application 21


Default = 62.42797).

kg/m3 to lb/ft3: Enter the multiplier needed to convert most pulse type flowing
densitometer readings from kg/m3 to lb/ft3. (Application 23 Default = 0.062428
Note: if a zero is entered, the Omni will set to the default value automatically
when used)

Mj/m3 to Btu/ft3: If heating value method ISO 6976 is selected, the calculations
are made in metric units. The flow computer displays heating value in BTU/ft3.
Enter the multiplier needed to convert Mj/m3 to BTU/ft3. (Application 23
Default = 26.83919. Note: if a zero is entered, the Omni will set to the default
value automatically when used).

Volume Units (applications 24, 25, and 26)


You may select cubic meters or litres for volume units.

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

Energy Units (applies to firmware versions 27.74.21 and up)


You may select Gigajoules or Kilowatt hours.

DP Units (applications 25 and 27)


You may select KiloPascals or Millibar.

12
Configuration

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
configuration. 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+.

13
OmniCom Help

14
Configuration

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, 6): This entry determines the resolution (number of
decimal places) for the following correction factors: Ctl, Cpl and CCF which
appear on the Batch, Daily and Snapshot reports. The default is 4 decimal
places.

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 rounding 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 up.)

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, 6): This entry determines the resolution (number of
decimal places) for the following correction 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 rounding 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.

15
OmniCom Help

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 up.)

To comply with API standard MPMS 12.2.3 in general, select 4 decimal


places for prove meter factor result.

16
Configuration

Omni IO
Omni I/O

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

Modules
Digital I/O
Process I/O
Virtual Inputs (available with firmware versions 20.74.30, 22.74.30, 24.74.19, 26.74.10, and
27.74.21 and up)
Auxiliary Inputs
Current Assignments

17
OmniCom Help

Modules

The Modules dialog allows the user to specify the number and type of I/O Modules and the I/O
Allocations 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 shown here is updated based on the amount of modules
selected in the number of modules installed section.

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 up (enables SE Module configuration via OmniCom and
network printing.)

18
Configuration

Digital IO

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.

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.

19
OmniCom Help

Digital IO Module

Each digital I/O module has 12 channels. Each channel can be assigned as either an input or an
output.

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.

DIGITAL I/O 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
individual channel.

DIGITAL I/O MODULE

The module has 12 connections to the back panel terminal strips.


view connections

Below is the area used within the Digital I/O for configuration. Click on the link to go to that topic.

Digital Module Configuration

20
Configuration

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 to 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
10ms ticks. ie. a pulse width of 5 ticks would provide a 50ms ON time AND minimum 50ms
OFF time.

The maximum pulse width is 10ms therefore the maximum frequency that can be output is 50
Hertz.

The flow computer will buffer pulses it was unable to output due to the maximum frequency
limitation and will continue to output pulses until it can catch up.

Pulse/Unit
Enter the number of pulses per unit volume, mass or energy unit. The unit is the 'displayed'
unit ie: Ton, Barrel, KLb, MMBTU, GJOULE

Example 1) You wish to count 100 Lb increments and the displayed units are Klbs (1000 lbs
per Klb).
Pulses/unit needed = 1000/100 = 10.0 counts per Klbs.

Example 2) 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.

Example 3) You wish to count 10 Barrel increments and the displayed units are Barrels
Pulses/unit needed = 1/10 = 0.1 counts per Barrel.

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

21
OmniCom Help

*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.

22
Configuration

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 to 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 (These are the results of the 64 boolean expressions)

Meter Run Alarms/Status Points

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

23
OmniCom Help

1n14 Using Density Pressure Override


1n16 Using Temp. Override
1n17 Using Pressure Override
1n18 Using Gravity/Density Override
1n19 Using Density Temperature Override
1n20 Flowrate Low Low Alarm
1n21 Flowrate Low Alarm
1n22 Flowrate High Alarm
1n23 Flowrate 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
1n49 'A' Channel Has Failed
1n50 'B' Channel Has Failed
1n51 Partial Failure A or B

Station Alarms/Status Points

Point Function
1809 Flowrate Low Low Alarm
1810 Flowrate Low Alarm
1811 Flowrate High Alarm
1812 Flowrate 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

24
Configuration

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
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

25
OmniCom Help

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

26
Configuration

Status or Command Inputs


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

Point Number Function


1700 (reserves the I/O point as a Dummy variable
general purpose input to be used in
a boolean statement or used as a
detector switch input).
1701 Prove Seal OK
1702 Station End Batch
1703 End Batch Meter 1
1704 " " " 2
1705 " " " 3
1706 " " " 4

1707 (Edge Triggered Commands) Station Product


Change Strobe
1708 Request Prove Meter
1
1709 " " " 2

1710 " " " 3

1711 " " " 4

1712 (Use 1732-35 for meter run Station Alarm


alarms) Acknowledge
1713 (Power fail is set at power up) Reset Power Fail
Flag
1714 (Single run prove) Request Trial Prove
Meter 1
1715 " " "
Meter 2
1716 " " "
Meter 3
1717 (Edge Triggered Commands) " " "
Meter 4
1718 Abort Prove in
Progress
1719 Request Local
Snapshot Report
1720 (Sends to the Modbus report Request Snapshot to
buffer to be polled for later) Modbus
1721 (Sends to the Modbus report Request Alarms to
buffer to be polled for later) Modbus
1722 (Controls the PID 1 Startup
startup/shutdown ramps. See 2nd Permissive
Stage PID Permissives below)

27
OmniCom Help

1723 " 2 " "


1724 " 3 " "
1725 " 4 " "

1726 (Activate to start prove Prove Start


sequence) Permissive
1731 (Must be false to launch Prover Piston Not
piston) Up-Stream
1732 (Edge triggered - Use 1712 Acknowledge Meter 1
to acknowledge station alarms) Alarms
1733 " " 2
"
1734 " " 3
"
1735 " " 4
"
1736 (Active to disable meter run Disable Meter Run 1
flow. Usually used in Bi Directional
flow applications where forward and
reverse meter runs use the same
meter)
1737 " " " 2

1738 " " " 3


1739 " " " 4

1741 (Provides ability to scroll Remote UP Arrow


display via digital I/O points) Function
1742 " DOWN "
"
1743 (The status of these bits are Product Selection Bit
checked to see what product is 0
selected to run when the Change
Product Strobes are activated. See
1707 & 1747-50)
1744 " " Bit 1

1745 " " Bit 2


1746 " " Bit 3
1747 (Edge triggered - Causes Product Change
current batch to be ended and the Strobe Run 1
next batch to start using the product
selected in 1743-1746 above)
1748 " " "
Run 2
1749 " " "
Run 3
1750 " " "
Run 4
1751 (Can be used to facilitate Freeze All Analog
calibration) Inputs
1752 (Used to provide two stage 2nd Stage 1 PID
shutdown of PID control) Permissive

28
Configuration

1753 " " 2 PID


Permissive
1754 " " 3 PID
Permissive
1755 " " 4 PID
Permissive
1756 (Holds current mass flowrate Change Orifice Plate
while active) Meter 1
1757 " " "
" 2
1758 " " "
" 3
1759 " " "
" 4
1760 (Edge triggered. Causes Freeze Temperature,
variables to be snapshot and Pressure,
saved.) Density/Gravity &
Totals

29
OmniCom Help

Process IO

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 Combo Modules
E/D Combo Modules
H Combo Modules
HV Combo Modules
SV Combo Modules

Process Inputs
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 up)
Analog Outputs

30
Configuration

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). Based upon
your selections, OmniCom makes available only those dialogs that apply to your flowmeter. Once
you enter the information and/or make your selections, press the [Apply] button to set.

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 up)

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 selected.

Tag ID
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.

Signal Type
Select a signal that will be received on this input.

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 transducer that provides a linear 4-20mA output.

Flow Pulse
Digital metering devices such as ultrasonic flowmeters and Coriolis meters
allow you to communicate with the Omni with serial and/or flow pulse
signals. Check 'Flow Pulses Required' if your metering configuration
requires this option. If you select this option, you must also assign pulse I/O
point and enter the active threshold frequency.

Density Pulse
Digital metering devices such as Sarasota, Solartron, and UGC
Densitometers allow you to communicate with the Omni with serial and/or
density pulse signals.

31
OmniCom Help

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
SV
SG (this can be configured as a 4-20ma signal type or as a density pulse signal
type Solartron 3096/3098 Gravitometer)

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.

Input Scaling
Input at Zero Scale:
This entry is used to determine the Input at Zero Scale (4 mA or 1V).
Temperature: Degrees Fahrenheit or Celsius
Pressure: Psi, Kpa
Density: Lbs/Ft3 or Kg/m3
S&W: %
Viscosity: Cst

Input at Full Scale:


This entry is used to determine the Input at Full Scale (20 mA or 5V).
Temperature: Degrees Fahrenheit or Celsius
Pressure: PSI or Kpa
Density: Lbs/Ft3 or Kg/M3
S&W: %
Viscosity: Cst

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.

32
Configuration

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:

Damping Honeywell Honeywell Rosemount


Code (Temperature (other
Inputs) 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 Manually Override Strategy you wish to use by selecting the
checkbox. 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 if the user so
desired.

SV Port Number
Enter the port number of the SV combo module that is connected to this Rosemount
3095FB multivariable transmitter, Instromet Q-Sonic meter, FMC Kongsberg Ultrasonic
or Daniel Ultrasonic.
Port numbers 1 and 2 are on the SV-1 combo module. Port numbers 3 and 4 are on
the SV-2 combo module.
Instromet Q-Sonic ultrasonic flowmeters require dedicated SV ports to
operate. They cannot be multi-dropped.
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 runs DP, temperature and pressure.

33
OmniCom Help

Analog Outputs

The Analog Output dialog within the Input/Output Calibration subcategory is for entering the
configuration 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
dialog. Click on a setting for more information.

Assign
The window lists all of the variables that this analog input has been assigned to
represent. An analog input used to measure temperature for example, could be
assigned to represent the temperature at the meter run, densitometer, and the prover if
the user so desired.

Remarks
Enter any comments or remarks about this transducer (up to 16 characters).

Value @ 4mA
Enter the measurement value at zero scale of this process variable. Make sure that the
value you enter is consistent with the units selected within the Measurement Units
dialog of the Meter Run Configuration & Setup subcategory.

This value represents the engineering units that the transmitter outputs at 20
milliamperes or 5 volts. You can set a zero scale value to the following process
measurement variables:

Flow Rate (linear analog and differential pressure flowmeters only)


Differential Pressure (low/high range)
Temperature
Pressure
Density
Density Temperature
Density Pressure
Relative Density (Specific Gravity)
Sediment & Water (S&W)
Viscosity
Heating Value
Nitrogen
Carbon Dioxide
Analog Inputs
Analog Outputs

Value @ 20mA
Enter the measurement value at full scale of this process variable. Make sure that the
value you enter is consistent with the units selected within the Measurement Units
dialog of the Meter Run Configuration & Setup subcategory.

34
Configuration

This value represents the engineering units that the transmitter outputs at 20
milliamperes or 5 volts. You can set a full scale value to the following process
measurement variables:

Flow Rate (linear analog and differential pressure flowmeters only)


Differential Pressure (low/high range)
Temperature
Pressure
Density
Density Temperature
Density Pressure
Relative Density (Specific Gravity)
Sediment & Water (S&W)
Viscosity
Heating Value
Nitrogen
Carbon Dioxide
Analog Inputs
Analog Outputs

35
OmniCom Help

'A' Type 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.
view terminal wiring

Configuration Options

Each input channel is configured as a 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 3 and 4 of each module can be converted to accept voltage pulse signals
(turbine and PD flow meters) by moving sets of mini jumpers from the 'A'(analog) to the
'P'(pulse) position 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 Analog Input dialog.
Click on a setting for more information.

Process Inputs
Analog Outputs

36
Configuration

'B' Type 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.
view terminal wiring

CONFIGURATION OPTIONS

Each input channel is configured as a 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 3 and 4 of each module can be converted to accept voltage pulse signals
(turbine 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 Analog Input dialog.
Click on a setting for more information.

Process Inputs
Analog Outputs

37
OmniCom Help

'C' Type 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.
view terminal wiring

CONFIGURATION OPTIONS

Each input channel is configured as a 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 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'(analog) 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 Analog Input dialog.
Click on a setting for more information.

Process Inputs
Analog Outputs

38
Configuration

'E' Type Combo Modules

Each module accepts a total of 4 input channels with channels three and four always dedicated to
turbine or PD flow meter pulses. Each combo module is associated with 12 connections on the
back panel terminals.
view terminal wiring

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.
Four wire Rtds can be accommodated 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
interpolation).

SETTINGS

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

Process Inputs
Analog Outputs

39
OmniCom Help

'E/D' Combo Modules

Each module accepts a total of 4 input channels with channels three and four always dedicated to
frequency type densitometers producing pulses. Each combo module is associated with 12
connections on the back panel terminals.
This module is actually a standard E type module with the JPD jumper installed.
view terminal wiring

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.
Four wire Rtds can be accommodated 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 'ED' type combo module are always used to accept
voltage pulse signals from frequency type densitometers such as Solartron, UGC and
Sarasota.
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 Solartron densitometers which usually provide a 3 to 5 volt peak to
peak signal which rides on a 18 vol DC level.
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 Analog Input dialog.
Click on a setting for more information.

Process Inputs
Analog Outputs

40
Configuration

'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.
view terminal wiring

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 configurator 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 Analog Input dialog.
Click on a setting for more information.

Process Inputs
Analog Outputs

41
OmniCom Help

'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.
view terminal wiring

CONFIGURATION OPTIONS

Each input channel accepts serialized data from a Honeywell SMV-3000 multivariable
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 configurator 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 Analog Input dialog.
Click on a setting for more information.

Process Inputs
Analog Outputs

42
Configuration

SV Module Setup

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

SETUP OPTIONS

Each input channel accepts serialized data from any compatible multivariable transmitter
using various protocols.
Meter types can be Rosemount 3095FB DP, Instromet Ultrasonic, FMC MPU 1200, or
Daniel Ultrasonic.

43
OmniCom Help

'SV' Type Combo Modules

The 'SV' type combo module provides a total of 2 RS-485 serial ports to connect to compatible
multivariable 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.
View Terminal Wiring

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, or
Daniel Ultrasonic.
Rosemount 3095FB DP and Daniel Ultrasonic also require a Modbus ID.
If a Rosemount 3095FB DP meter type is assigned an input type of DP: The two inputs
immediately following are automatically assigned to input types Temperature and
Pressure respectively. 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 Analog Input dialog.
Click on a setting for more information.

Process Inputs
Analog Outputs

44
Configuration

Virtual Inputs

Virtual Inputs can be used as dummy inputs when there is no physical input but a value is input to
simulate 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 up.

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

Clicking on the "Virtual Inputs" item brings up a screen similar to the Process Inputs
configuration except with a tab for inputs 98 - 90 (in that order):

a) Signal Types - Flow Pulse and Density Pulse are disabled.


b) Input Types - All the input types are available except for "Flow meter" and "PID" which are
disabled.
c) Input Scaling (Zero and Full Scale values) are hidden.
d) Damping Code is hidden.
e) Override Code is set to "Never Use" and all selections are disabled.
f) Override Value is enabled.

The Current Assignments item on the tree now 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
- All valid Process Inputs for the I/O type
- Remote Input 99
- All valid 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.

45
OmniCom Help

Current Assignments

Current Assignments

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

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

46
Configuration

Process Input Assignments

Shows all physical inputs (1 - 24) 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).

47
OmniCom Help

Remote Inputs

Shows all inputs assigned to I/O point 99.

48
Configuration

Virtual Input Assignments

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

49
OmniCom Help

Analog Output Assignments

Shows all physical inputs and lists each one's assignments.

50
Configuration

Digital Input Assignments

Shows all physical inputs and lists each one's assignments.

51
OmniCom Help

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.

52
Configuration

Terminal Block Diagram

The terminal block diagram dialog uses the configuration of the Modules and the I/O to show the
suggested module placement and terminal descriptions. A picture of the back panel indicating the
fuses used is also shown.

SETTINGS

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

Extended Back Panel


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

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.

53
OmniCom Help

Auxiliary Inputs

The Auxiliary Inputs category is for entering the configuration, Setup, and Alarm Limits to the
physical 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 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.

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 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 scaling. 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 scaling. 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.

54
Configuration

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
Ethernet 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 printer or Modbus™.


Port 2 can be used for as a Modbus master for redundant flow computer applications and
communicating 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, 22.74.30, 23.74.30,
24.74.19, 26.74.10, and 27.74.21 and up)

Serial Modules
SE Modules

55
OmniCom Help

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 each of the 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 corrupted. 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
incomming messages. 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


Serial Port 1 can be configured as a dedicated local printer port or a Modbus port.
Selecting Modbus 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.

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:

Applied Automation

56
Configuration

Danalyzer RTU
Danalyzer ASCII

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 supports 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 protocol selections available:
Allen-Bradley Full Duplex (CRC)
Allen-Bradley Half Duplex (CRC)

Allen-Bradley Full Duplex (BCC)


Allen-Bradley Half Duplex (BCC)

57
OmniCom Help

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.

58
Configuration

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.

59
OmniCom Help

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 up)
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’.

60
Configuration

Ethernet Configuration

Ethernet Configuration

SE Module Configuration via OmniCom and Network Printing is available with Omni firmware
versions 20.74.30, 22.74.30, 23.74.30, 24.74.19, 26.74.10, and 27.74.21 and up using Omni SE
Module firmware v1.50 and up. Note that the network printing configuration is not available 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 Printing configuration. To enable offline configuration of
the Ethernet module, check the "SE Firmware v1.50 and up" 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
channels - two Ethernet and Two Serial. Each Ethernet channel can support four connections.
For more information on setting up the SE module reference Technical Bulletin TB020101, 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 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: "*.oXXEthN"
where XX is the application (20, 24...), and N is the SE Module number (1, 2, or 3 according to
the Serial and SE Module placement in the Omni), however the user may enter any extension.

61
OmniCom Help

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 network connections to the SE Module and is the same as the one
configured in the Omni for the Ethernet 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.

Encap. 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
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 number must be different from the Encap.
Modbus port number.

Telnet Port

62
Configuration

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 up will detect the configured Telnet port and use that
for the connection. It can also detect a disabled port and give you a chance to reset it
to the default of 23. 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 connection. 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.

63
OmniCom Help

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
setting 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 up)
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’.

Initial Delay
This is the time in milliseconds that the SE Module waits for a response from the Omni
before freeing up the TCP port for other connections. 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 freeing up the TCP port
for other connections. The default is 20ms and that is the recommended setting.

64
Configuration

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 converted 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.

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”.

65
OmniCom Help

66
Configuration

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). The passwords are case sensitive. If you have forgotten your password,
contact Omni technical 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 Technical 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. Do not use the TCP/IP password simultaneously with serial
port passwords on an Ethernet port!

Respond to Ping
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

67
OmniCom Help

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.

68
Configuration

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.

69
OmniCom Help

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 messages 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 Syslog 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.

70
Configuration

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.

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

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.

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

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
setting for more information.

IP Address
All devices on a network require a unique IP address. This is the static IP address
used for the network 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.

Printer Type
Printer Type: Select the type of network printer. If you select something other
than "Custom", 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 characters 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 (approximately 16+ characters
per inch) or to normal (approximately 10 characters per inch). Enter the data
as hexadecimal characters (groups of 2, 0F not F!) with up to 16 sets of
characters.

Printers Condensed Normal Mode


Mode String String
HP 1B266B3253 1B266B3053
LaserJet

71
OmniCom Help

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.

72
Configuration

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
<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

73
OmniCom Help

<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

74
Configuration

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. 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 designated 'masters' to talk to designated 'slaves'. In this mode 'masters' cannot talk
to other 'masters' and 'slaves' cannot talk to other 'slaves'. 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

75
OmniCom Help

76
Configuration

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. The board can be used with existing
Omni 3000/6000 flow computers with no additional firmware modifications required. This is
achieved by the Ethernet port “emulating” a serial 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).

Ethernet/Serial Terminal Assignments


The connections for the RS-232/RS-485 serial port always occupy contacts 1 through
6 of the appropriate Omni backpanel terminal strip (see table below). 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 backpanel (see table below). 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.

77
OmniCom Help

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: In versions 20/24 and 22/26, the meter type is hard coded in the firmware to Turbine/PD
so there is no Flowmeter Type selection screen. For versions 20/24 firmware, 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. Versions 22/26 firmware
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 Orifice 21/25 and Gas 23/27 Applications)
Meter Run Setup
Meter Run Temperature
Meter Run Pressure
Density / Gravity

78
Configuration

Flowmeters

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.

Orifice DP
Turbine/PD
Rosemount 3095FB DP
Honeywell SMV3000 DP
Instromet Ultrasonic
V-Cone
FMC MPU 1200
Equimeter AAT
Daniel Ultrasonic
Coriolis (available with applications 23.74.19 and 27.74.18 and up)
FLOWSIC 600 Ultrasonic (available with applications 23.74.20 and 27.74.19 and up)

CONFIGURATION SELECTION CHART

Applications 23/27:

Meter Type Selection


Orifice DP 0
Turbine/PD 1
Rosemount 2
3095FB DP
Honeywell 3
SMV3000 DP
Instromet 4
Ultrasonic
V-Cone 5
FMC MPU 1200 6
Equimeter ATT 7
Daniel Ultrasonic 8
Coriolis 9

79
OmniCom Help

FLOWSIC 600 10
Ultrasonic

Applications 21/25:

Meter Type Selection


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

80
Configuration

Orifice DP Meter

The "Physical Meter Run - Orifice DP" is for entering the specific Primary Element data for any
Orifice 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.

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.

Applications 21 and 23 enter value in inches.


Applications 25 and 27 enter value in mm.

Pipe Reference Temperature


Enter the temperature that corresponds to the temperature of
the metering tube when the orifice diameter was measured.

Applications 21 and 23 use degrees F.


Applications 25 and 27 use degrees C.

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 AGA 3-92
equations require the linear coefficient of expansion.

Applications 21 and 23:


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

Applications 25 and 27:


For mild steel plate -73.3 to 148.9 deg.C. = 1.116 x E-5
304/316 Stainless steel -73.3 to 148.9 deg.C. = 1.665 x E-5
For Monel -21.6 to 67.8 deg.C. = 1.431 x E-5

Orifice 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.

Applications 21 and 23 enter value in inches.


Applications 25 and 27 enter value in mm.

Orifice Reference Temperature


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

Applications 21 and 23 use degrees F.


Applications 25 and 27 use degrees C.

81
OmniCom Help

Orifice/Venturi 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 AGA 3-92
equations require the linear coefficient of expansion.

Applications 21 and 23:


For mild steel plate -100 to 300 deg.F. = 6.2 x E-6
304/316 Stainless steel -100 to 300 deg.F. = 9.25 x E-6
For Monel -7 to 154 deg.F. = 7.95 x E-6

Applications 25 and 27:


For mild steel plate -73.3 to 148.9 deg.C. = 1.116 x E-5
304/316 Stainless steel -73.3 to 148.9 deg.C. = 1.665 x E-5
For Monel -21.6 to 67.8 deg.C. = 1.431 x E-5

Orifice Plate Taps


The flow computer must be informed as to where the differential pressure taps are
located on the orifice metering tube.

Pressure Transmitter is located Downstream


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

Applications 23 and 27:


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 venturi is known.

Application 23:
Disable Isentropic Temperature Correction
Check the box to disable the 'downstream' to 'upstream' temperature correction
calculation which assumes that an 'isentropic expansion' occurs after the orifice plate.
The default for this entry is checked as AGA 3-92/API 14.3 do NOT mandate the use
of this correction.

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 choose to ignore this effect by checking the box or
correct for this
effect by not checking the box'.

The flow computer corrects the downstream temperature to the equivalent upstream
temperature using the following equation which assumes an Isentropic Expansion
through the orifice.
T1 = T2 x (P1/P2')^((k-1)/k)

82
Configuration

where: T1 = Upstream absolute temperature


T2 = Downstream absolute temperature
P1 = Upstream absolute pressure
P2'= Calculated downstream abs. pressure at temperature sensor
k = Isentropic Exponent

Applications 25 and 27:


Temperature Probe is located Upstream
The temperature of the flowing fluid can be obtained from a probe located upstream or
downstream of the orifice. Check the box if the temperature probe is located upstream
of the orifice. The default is to use the downstream temperature probe.

As the orifice equations use the upstream temperature as the flowing temperature, the
OMNI calculates the temperature upstream of the orifice.

ISO5167 Version
Select one of the following:
Version 1991(E)
Version 1998(E)
Version 2003(E) (available with firmware versions 27.74.11+)

If Version 2003(E) is selected and the Omni firmware is v27.74.11+, enter the values
for Cmp and dZ/dT. Entering a negative value will cause the Omni to calculate the
results if AGA 10 is selected in the Fluid Products screen for the product that is running
on the orifice meter.

If Version 2003(E) is selected and the Omni firmware is v27.74.21+, you may also
select to use the simplified Joule-Thomson equation to calculate the upstream density.

Two versions of ISO 5167 (Versions 1991 and 1998) in the flow computer software use
an ideal gas law and the isentropic exponent (k) to calculate the upstream corrected
density (D1) using:

D1 = Dm * (P1 / P2) ^ (1 / k)

This method neglects any temperature differences and assumes that the flow is
isentropic and reversible. The paper by Niazi and Thalayasingam (North Sea Flow
Measurement Workshop, 2001) has shown that the flow process is isenthalpic and not
isentropic. After consultation with Dr M Reader-Harris (TUV NEL), the following
equation of state (Version 2003) is now used to calculate the upstream density:

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

where:
D1 = Upstream density (at P1,T1) (kg/m3).
Dm = Measured density (at P2,T3) from the densitometer in bypass mode (kg/m3).
P1 = Upstream pressure (barA).
P2 = Pressure at the downstream tapping (barA).
T1 = Upstream temperature (K) (see item 'b' below).
T3 = Measured temperature at the downstream recovery point (K).
Z(P1,T1) = AGA8 compressibility at P1, T1.
Z(P2,T3) = AGA8 compressibility at P2, T3.

83
OmniCom Help

The flow computer calculates Z(P1,T1) using AGA8. This calculation method requires
an additional calculation of Z(P2,T3).

The static pressure to be used in the simplified Joule-Thomson equation is the


upstream pressure P1:

u = 0.35 - 0.00142 * T3 + (0.231 - 0.00294 * T3 + 0.0000136 * T3^2) * (0.998 +


0.00041 * P1 - 0.0001115 * P1^2 + 0.0000003 * P1^3)

Dt = u * w
T1 = T3 + Dt

where:
Dt = Change in temperature (degC).
u = Joule-Thomson coeff (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).

84
Configuration

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.

Orifice DP
Instromet Ultrasonic
V-Cone

85
OmniCom Help

Turbine/PD Meter

The "Flowmeter – Turbine/PD Meter" tabbed dialogs are for entering and selecting pulse signal
flow transmitter settings. These dialogs are available in OmniCom only if you select 'Turbine/PD
Meter as the flowmeter type in the Meter Type tab of the Meter Run Configuration.

In versions 20/24 and 22/26, the meter type is hard coded in the firmware to Turbine/PD. For
versions 20/24 firmware, 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. Versions 22/26 firmware 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 versions 23/27 firmware, if you are using a Coriolis flowmeter that is outputting volumetric
pulses instead of mass pulses, select the Flowmeter Type as "Turbine/PD Meter". If you are
using a Coriolis flowmeter that is outputting mass pulses, select the Flowmeter Type as "Coriolis
Meter".
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 (Applications 20 and 24)

86
Configuration

Rosemount 3095FB DP Meter

The "Physical - Rosemount 3095FB DP" 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 Orifice DP Meter help.

87
OmniCom Help

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 Orifice DP Meter help.

88
Configuration

Instromet Ultrasonic Meter

The "Flowmeter – Instromet Ultrasonic" tabbed dialogs are for configuring Instromet Q-Sonic
Ultrasonic 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: Pulse Fidelity checking added for Instromet Meters in firmware versions 23.74.20 and
27.74.20 and up.

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 is listed.

Primary Measurement Source (available with firmware versions 23.74.20 and


27.74.20 and up)
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. This means 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 calculations by the flow
computer.

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 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 totalize depends upon several factors:
Firmware 23.74.20 and 27.74.20 and up:
 (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 serially by the
Q-Sonic.
 (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 transmitted by the Q-Sonic and
calculate flow based on the temperature compensated area

89
OmniCom Help

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.
 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.
Firmware 23.74.19 and 27.74.19 and below:
 (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 percentage of the flow transmitted
serially by the Q-Sonic.
 (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.
 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 directions. 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 up. AGA-10 is 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
Some gas movement can occur even when an ultrasonic meter is blocked-in. This is
caused by convection currents within the meter tube. Enter a minimum gas velocity, in
feet per second (Application 23) or meters per second (Application 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
Instromet meter. Click on the link for more information.

K-Factor Curve

90
Configuration

91
OmniCom Help

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 calculate flowrate.

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 degrees F (firmware 23) or degrees C (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.

Application 23:
For Mild steel plate -100 to 300 deg.F. = 6.20 x E-6
304/316 Stainless steel -100 to 300 deg.F. = 9.25 x E-6
Monel -7 to 154 deg.F. = 7.95 x E-6

Application 27:
For mild steel plate -73.3 to 148.9 deg.C. = 1.116 x E-5
304/316 Stainless steel -73.3 to 148.9 deg.C. = 1.665 x E-5
For Monel -21.6 to 67.8 deg.C. = 1.431 x E-5

92
Configuration

V-Cone Meter

The "Physical Meter Run - V-Cone" is for entering the specific Primary Element data. 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.

For more information see the Orifice DP Meter help.

93
OmniCom Help

V-Cone Flow Coefficients

Reynolds Number
The V-Cone meter may have been supplied with a calibration chart which correlates
Reynolds Number 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 Number 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.

94
Configuration

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.

Series (available with application 23.74.30 and 27.74.20 and up)


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.

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 or reverse flow on any meter run with an ultrasonic 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 deviation of one or more paths exceeds this value.

AGA-10 VOS Deviation: (Available with firmware versions 23.74.11 and


27.74.11 and up. 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 channel 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.

95
OmniCom Help

Maximum Down Time: Enter the maximum allowable MPU downtime in


minutes. If the communication 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

96
Configuration

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 calculation is to provide a measurement registration that
is adjusted back to original factory calibration 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
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

97
OmniCom Help

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.

98
Configuration

Coriolis Meter

The "Flowmeter – Coriolis Meter" 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 selection is available with applications 23.74.19 and 27.74.18 and up.

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.

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 flowmeter in order to retrieve variable 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

99
OmniCom Help

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
Configuration.

SETTINGS

Setup
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 the Daniel Ultrasonic on the SV Port Setup screen is 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
up.) 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. This means 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 calculations by the flow
computer.

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 or reverse flow on any meter run with an ultrasonic meter.

Alarm Limits
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 deviation of one or more paths exceeds this value.

AGA-10 VOS Deviation: (Available with firmware versions 23.74.11 and


27.74.11 and up. 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

100
Configuration

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
fluctuating flow pulse frequency output by the flowmeter.)

Flow Deviation: Only valid if a flow pulse I/O point is assigned. The allowable
percent deviation 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 previous.)

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-
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)

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

101
OmniCom Help

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 applications 23.74.20 and 27.74.19 and up.

Note: Omni firmware 23.74.20+ and 27.74.20+ and up 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 available with each module up to four ports. Only the ports
configured for the FLOWSIC 600 Ultrasonic on the SV Port Setup screen is
listed.

SV Modbus ID: This is the Modbus ID of the FLOWSIC 600 Ultrasonic flowmeter
communications 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 flowmeter 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. This means 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 calculations by the flow
computer.

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
Flow Direction: FLOWSIC 600 flowmeters allow for bidirectional fluid flow
measurement.

102
Configuration

Forward or Reverse: For pulse frequency signals, setup the flow computer to
totalize either forward 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 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. 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 measurement 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. (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: 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 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 recommended 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 deviation between the calculated flow from the pulse input channel
compared to the FLOWSIC flow data received via the Omni SV serial port.

103
OmniCom Help

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 up)
The FLOSIC 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

104
Configuration

DP Setup

The Flowmeter DP Setup screen is shown for Orifice, Honeywell, Rosemount and V-Cone meter
types. You may view the settings for the DP I/O Points as well as set the Low Flow Cutoff and
DP Switchover points.

Low Flow Cutoff


Differential pressure signals lower than this value will not be
totalized.
Note: Differential pressure is expressed as 'inches of water' for U.S. units applications
and 'kPa' for metric units applications.

DP Switchover
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.

105
OmniCom Help

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
configuration. Select from the list below for you application.

Meter Setup (Firmware Versions 20 and 24)


Meter Setup (Firmware Versions 21 and 25)
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)

106
Configuration

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
configuration. 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 transducer. 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 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.

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
differences of phase or frequency between the pulse trains. Totalizing will be

107
OmniCom Help

unaffected by a failure 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 disabled until either the A or the B channel of the flowmeter pick-
offs are providing 50 pulses per second.

Max Error Counts Per Batch - Enter the maximum number of error pulses
allowed in one transaction.
The dual pulse error checking alarms are activated once this count threshold is
exceeded.
The alarm points are:
Description Modbus Point #
Comparitor 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.

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.

Batch
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 equal to or 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: 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 mechanical or electrical temperaturecompensator. If the box is checked,
the Omni sets the temperature correction factor (VCF) to 1.0000 in all
equations. Do not check the boxif the meter provides gross uncompensated
pulses.

108
Configuration

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 flowrate 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.
(See the prover help for Auto Prove Setup.)

Upstream Prover: 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.

Meter Information
Enter meter identification information in the corresponding fields indicated below.
These entries usually 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: Two16-bit integer variables representing meter run gross and
net flowrate 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 flowrate
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%).

109
OmniCom Help

Flow Low Limit: The Low alarm (Modbus point 1n21) will activate when meter
run (n) flowrate drops below this value. The Low Low alarm (Modbus point
1n20) activates when the flowrate drops 5% below this value.

Flow High Limit: The High alarm (Modbus point 1n22) will activate when meter
run (n) flowrate exceeds this value. The High High alarm (Modbus point 1n23)
activates when the flowrate rises 5% above this value.

NIST14/water
Use Live Density: (Available with application 24.74.17 and up) Check the box if
you would like to use the measured 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.

Disable NIST14 Flowing Density Calculation: (Available with applications


24.74.18 and up.) 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 selected and a
densitometer is configured for the meter. This checkbox is only available if the
"Use Live Density" box is checked.

110
Configuration

Meter Run Setup (Firmware Versions 21 and 25)

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
configuration. 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 pressure 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 (forward 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 (forward and reverse flow for example).

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 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.

Constants
Viscosity - Enter the viscosity of the measured fluid in centipoise units for
Application 21 and pascal.seconds units for Application 25 at flowing
temperature and pressure. You may enter any minus number to instruct the

111
OmniCom Help

flow computer to attempt to calculate 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 0 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 equal to or 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.

Flow
Gross Full Scale: Two16-bit integer variables representing meter run gross and
net flowrate 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 flowrate
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) flowrate drops below this value. The Low Low alarm (Modbus point
1n20) activates when the flowrate drops 5% below this value.

112
Configuration

Flow High Limit: The High alarm (Modbus point 1n22) will activate when meter
run (n) flowrate exceeds this value. The High High alarm (Modbus point 1n23)
activates when the flowrate rises 5% above this value.

Click on the link below for more information on the DP Setup tab:

DP Setup

113
OmniCom Help

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
configuration. 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 transducer. 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 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.

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
differences of phase or frequency between the pulse trains. Totalizing will be
unaffected by a failure of either pulse train and simultaneous transients and
noise pulses will be rejected with an 85% certainty.

114
Configuration

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 disabled until either the A or the B channel of the flowmeter pick-
offs are providing 50 pulses per second.

Max Error Counts Per Batch - Enter the maximum number of error pulses
allowed in one transaction.
The dual pulse error checking alarms are activated once this count threshold is
exceeded.
The alarm points are:
Description Modbus Point #
Comparitor 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.

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.

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 equal to or less than this entry.

Volume
Use Meter Factor in Net: Check the box to apply the meter factor in the net and
mass flow equations. If the box is unchecked, 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 mechanical or electrical temperaturecompensator. If the box is checked,
the Omni sets the temperature correction factor (VCF) to 1.0000 in all
equations. Do not check the boxif 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' will cause the flowmeter to be
automatically proved on flowrate changes and after a meter has been out of

115
OmniCom Help

service. The 'auto prove enable' is automatically cancelled if a meter fails an


automatic prove on 10 consecutive attempts.

Upstream Prover: 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 to be used during
a prove. Leave the entry blank to select the downstream 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 Flowrate: 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 flowrate for validation/comparison
and historical archival purposes.

Meter Manufacturer: The manufacturer of the prover meter. You may use up to
8 alphanumerical characters.

Meter Information
Enter meter identification information in the corresponding fields indicated below.
These entries usually 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: Two16-bit integer variables representing meter run gross and
net flowrate 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 flowrate
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) flowrate drops below this value. The Low Low alarm (Modbus point
1n20) activates when the flowrate drops 5% below this value.

Flow High Limit: The High alarm (Modbus point 1n22) will activate when meter
run (n) flowrate exceeds this value. The High High alarm (Modbus point 1n23)
activates when the flowrate rises 5% above this value.

116
Configuration

117
OmniCom Help

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
configuration. 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.

NON-ORIFICE 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.

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 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.

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

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

118
Configuration

differences of phase or frequency between the pulse trains. Totalizing will be


unaffected by a failure 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 disabled until either the A or the B channel of the flowmeter pick-
offs are providing 50 pulses per second.

Max Error Counts Per Batch - Enter the maximum number of error pulses
allowed in one transaction.
The dual pulse error checking alarms are activated once this count threshold is
exceeded.
The alarm points are:
Description Modbus Point #
Comparitor 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.

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 (except for app 27 versions below
27.74.21 where it was 9,999,999).

ORIFICE METERS

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 pressure 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. (forward and reverse flow for example).

DP Mid Range (Available with firmware versions 23.74.19 and 27.74.18 and up)
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. (forward and reverse flow for example).

119
OmniCom Help

DP High Range
Enter the I/O point used to input the signal from the high 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. (forward and reverse flow for example).

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.

Click on the following link for more information on the DP Setup tab: DP Setup

COMMON SETTINGS

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 Process Inputs section for configuration of the tag field.

Note: This field is not useable if a '99' has been assigned as I/O.

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 flowrate 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%).

120
Configuration

Mass Full Scale: A 16-bit integer variable representing meter run mass flowrate
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) flowrate drops below this value. The Low Low alarm (Modbus point
1n20) activates when the flowrate drops 5% below this value.

Flow High Limit: The High alarm (Modbus point 1n22) will activate when meter
run (n) flowrate exceeds this value. The High High alarm (Modbus point 1n23)
activates when the flowrate rises 5% above this value.

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 number of metering runs.

GC Stream: 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 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 up, the GC
Stream selection has moved to the Fluid Product Setup screen.

Krohne VOS: (Application 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
Transducer Density: Check the box (Application 23) or select a transducer
(Application 27) 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 flowrate. Not checking the box (Application 23) or selecting
"No Transducer" (Application 27) will cause the flow computer to use the
appropriate equation of state.

Disable NIST14 Flowing Density Calculation: (Available with applications


23.74.20 and 27.74.19 and up.) 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 measurement algorithm selected
and a densitometer is configured for the meter. Additionally, this checkbox is
only available if a transducer density is used.

k3 Thermodynamic Constant: (Application 27 only)If a downstream transducer


density is selected, a k3 constant can be entered. It is used to correct
downstream flowing density to upstream conditions.
 For compressible fluids k3 is equal to the reciprocal of isentropic
exponent (1/k)
 For incompressible fluids k3 is equal to 1.0

121
OmniCom Help

122
Configuration

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 and/or make your selections, 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 in 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
applications 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)
Metric = pulses/m3

Gas applications with flowmeters outputting Mass pulses:


U.S. = Pulses/Klb
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.

Note: The K-Factor Frequencies are in floating point format for firmware version
27.75.00 and up. 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

123
OmniCom Help

instruments. Dutch law requires that the flow computer display certain critical
parameters as listed below:

V[units] Gross Volume (accumulated flow that occurs when there is


no accountable alarm)
Vn[units] Net Volume (accumulated flow that occurs when there is no
accountable alarm)
V.e[units] Gross Error Volume (accumulated flow that occurs while an
accountable alarm exists)
Vn.e[units] Net Error Volume (accumulated flow that occurs while an
accountable alarm exists)
P[units] Pressure
t[units] Temperature
d(=S.G.) Specific Gravity
Hs[units] Heating Value
%CO2
%H2
C Compressibility
Z Z Factor
KF(pulses/units) NMi K-Factor

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 comparator 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 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

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

124
Configuration

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

125
OmniCom Help

Meter Run Temperature

The Setup dialog within the Meter Run Temperature category is for entering and selecting the
temperature 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 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 Temperature
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 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 scaling. 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 scaling. 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 drops below this value.

High: The high alarm activates when the temperature rises above this value.

126
Configuration

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 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 scaling. 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 scaling. 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 pressure drops below this value.

High: The high alarm activates when the pressure rises above this value.

127
OmniCom Help

Density Gravity

Density/Gravity

OmniCom provides independent settings for the meter run 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. 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
category. Click on a link to go to that topic.

Configuration
Setup
Pressure
Temperature
Meter Run Density Sarasota
Meter Run Density Solartron Gas
Meter Run Density Solartron Liquid
Meter Run Density UGC

128
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
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 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 gr/cc density
units

Solartron Pulse: When using a Solartron digital pulse type densitometer.

Sarasota Pulse: When using a Sarasota digital pulse type densitometer.

UGC Pulse: When using a 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.

129
OmniCom Help

Density/Gravity Setup

The Setup dialog within the Meter Density/Gravity category is for entering and selecting the
Density/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 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
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 gravity whenever that product is run. In this case
the (0)- Never Use override (1)- Always use override (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 overrides 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 pycnometer.

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.

130
Configuration

131
OmniCom Help

Density/Gravity Temperature

OmniCom provides independent settings for the meter run 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] 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 Density/Gravity
Temperature 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 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: 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 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 scaling. 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 scaling. 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 high alarm activates when the temperature at the densitometer rises
above this value.

132
Configuration

133
OmniCom Help

Density/Gravity Pressure

OmniCom provides independent settings for the meter run 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] 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 Density/Gravity
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 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 Pressure 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 scaling. 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 scaling. 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 pressure at the densitometer drops
below this value.

High: The high alarm activates when the pressure at the densitometer rises
above this value.

134
Configuration

Meter Run Density - Solartron Liquid

The Solartron / Liquid dialog is for entering the various Solartron liquid densitometer constants.
This dialog is available only if you select 'Solartron 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 items listed below are descriptions of each setting option within the Solartron / Liquid dialog.
Click on the setting for more information.

Solartron Liquid Densitometer Constants


Densitometer calibration constants are supplied on a calibration
certificate supplied by the densitometer manufacturer.

For English applications:


Enter the constants in gr/cc, degrees F, and PSIG.

For Metric applications:


CAUTION: The calibration certificates are usually based on
kg/M3, degrees C and Bar.
The Omni requires that they be expressed in terms of
degrees C 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.

135
OmniCom Help

Meter Run Density - Solartron Gas Pulse

The Solartron / Gas dialog is for entering the various Solartron gas densitometer constants. This
dialog is available only if you select 'Solartron 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 items listed below are links to descriptions of each setting option within the Solartron / Gas
dialog. Click on the setting for more information.

Solartron Gas Densitometer Factors


These factors are provided by the densitometer manufacturer on the original
calibration documentation.

Enter the numbers in terms of Kg/m3 and deg.C ( this is the way they are documented,
no conversions 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 K5 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)) (K5 - (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 deg.C
Da = Actual density of fluid at flowing conditions corrected for velocity of
sound effects.
G = (SG at reference conditions/Ratio of Specific Heats)

136
Configuration

Meter Run Density - Sarasota Pulse

The Sarasota dialog is for entering the various Sarasota densitometer constants. This dialog is
available only if you select '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 Sarasota Densitometer
subcategory dialog. Click on the setting for more information.

Sarasota Densitometer Constants


Enter the densitometer calibration constants supplied by the
manufacturer.

For English Liquid applications:


Enter the calibration constants based on gr/cc, degrees F and PSIG.

For application 23:


Constants must be entered in terms of Lb/Ft3, degrees F and PSI.

For Metric applications:


Enter the calibration constants based on kg/m3, degrees C and pressure units which
match the selected pressure unit of the flow computer (see 'Factor Setup' menu).

137
OmniCom Help

Meter Run Density - UGC Pulse

The UGC dialog is for entering the various UGC densitometer constants. This dialog is available
only if you select '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] button to set.

SETTINGS

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

UGC Densitometer Constants


Enter the densitometer calibration constants supplied by the
manufacturer.

For English Liquid applications:


Enter the constants based on gr/cc, degrees F and PSIG.

For Application 23:


Constants must be entered in terms of Lb/Ft3, degrees F and PSI.

For Metric Applications:


Enter the constants based on kg/m3, degrees C and pressure units which match the
pressure unit selected in the 'Factor Setup' menu.

138
Configuration

Viscosity Linearization

The Viscosity Linearization dialog is for entering and selecting the variables used to measure the
resistance 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
Linearization 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 viscosity 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 calculation 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 u = (bbl/Hr) / Centi Stokes

139
OmniCom Help

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
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 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

140
Configuration

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 Defined As : Select which meter runs will be included
in the 'Station' totalizers and flowrates. Meter data can be added or subtracted
eg. 1+2+3-4 means that meter runs 1, 2 and 3 would be added together with
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.

Regardless of whether you are using Common Batch Stack or not, as long as
meter runs are configured in the Station, you can still issue a Station Batch end
command to end the batches for all the meter runs that are defined in the Station.
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
flowrates in addition to the meter run totals and flowrates, you must enter "1+1-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.

ID: Eight character string used to identify the meter station. Usually appears on
all reports (Modbus point #4815)

Flow
Note: specify Tons/Hr for Anhydrous Ammonia measurement. Mass FS is not used
with Anhydrous Ammonia (v20.74.22+).

Gross Flowrate Full Scale: 16 Bit integer variables representing station gross
and net flowrate 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 Flowrate Full Scale: A 16 Bit integer variable representing station mass
flowrate is included in the data base at 3806. 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 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 ( Modbus point #1809).

141
OmniCom Help

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)

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 equal or less than this entry.

142
Configuration

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 eliminated 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 densitometer 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.

Note: specify Tons for Anhydrous Ammonia measurement (v20.74.22+).

143
OmniCom Help

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
flowrate.

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 flowrate thresholds, low and high. Each flag is set
when the station flowrate crosses the high threshold for that flag. It is reset when the
flowrate 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 statements to automatically switch meter runs depending on flowrates.

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 flowrate.
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 flowrate to be established. If, after this amount of time
differential pressure or flowrate 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
command.

Threshold %DP
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.

144
Configuration

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
flowrate (KLbs/Hr).

145
OmniCom Help

Trapil Alarms and Training

This page is displayed for firmware revisions 24.74.18 and up when the Trapil Functions are on.

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.

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.

146
Configuration

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
Solartron Liquid
Solartron Gas
Sarasota
UGC

147
OmniCom Help

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
dialog. 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 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.

Density/Gravity Type
Select the type of signal used with the densitometer or gravitometer connected to your
Omni. Available 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 gr/cc density
units

Solartron Pulse: When using a Solartron digital pulse type densitometer.

Sarasota Pulse: When using a Sarasota digital pulse type densitometer.

UGC Pulse: When using a UGC digital pulse type densitometer.

148
Configuration

Density/Gravity Setup

The Density/Gravity setup is for entering and selecting the Density / Gravity transmitter scaling
values 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
General 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. In this case the
(0)- Never Use override (1)- Always use override (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 overrides 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 pycnometer.

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.

149
OmniCom Help

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] 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 Density/Gravity
Temperature 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 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.

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 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 scaling. 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 scaling. 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.

150
Configuration

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

151
OmniCom Help

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] 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 Density/Gravity 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 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 Pressure 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 scaling. 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 scaling. 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 pressure at the densitometer drops
below this value.

High: The high alarm activates when the pressure at the densitometer rises
above this value.

152
Configuration

Station Density - Solartron Liquid

The Solartron / Liquid dialog is for entering the various Solartron liquid densitometer constants.
This dialog is available only if you select 'Solartron 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 descriptions of each setting option within the Solartron / Liquid dialog.
Click on the setting for more information.

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 gr/cc, degrees F, and PSIG.

For Metric applications:


CAUTION: The calibration certificates are usually based on
kg/M3, degrees C and Bar.
The Omni requires that they be expressed in terms of
degrees C 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.

153
OmniCom Help

Station Density - Solartron Gas Pulse

The Solartron / Gas dialog is for entering the various Solartron gas densitometer constants. This
dialog is available only if you select 'Solartron 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 Solartron / Gas
dialog. Click on the setting for more information.

Solartron Gas Densitometer Constants


These factors are provided by the densitometer manufacturer on the original
calibration documentation.

Enter the numbers in terms of Kg/m3 and deg.C ( this is the way they are documented,
no conversions 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 K5 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)) (K5 - (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 deg.C
Da = Actual density of fluid at flowing conditions corrected for velocity of
sound effects.
G = (SG at reference conditions/Ratio of Specific Heats)

154
Configuration

Station Density - Sarasota Pulse

The Sarasota dialog is for entering the various Sarasota densitometer constants. This dialog is
available only if you select '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 Sarasota Densitometer
subcategory dialog. Click on the setting for more information.

Sarasota Densitometer Constants


Enter the densitometer calibration constants supplied by the
manufacturer.

For English Liquid applications:


Enter the calibration constants based on gr/cc, degrees F and PSIG.

For application 23:


Constants must be entered in terms of Lb/Ft3, degrees F and PSI.

For Metric applications:


Enter the calibration constants based on kg/m3, degrees C and pressure units which
match the selected pressure unit of the flow computer (see 'Factor Setup' menu).

155
OmniCom Help

Station Density - UGC Pulse

The UGC dialog within the Station Densitometer subcategory is for entering the various UGC
densitometer constants. This dialog is available only if you select '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 UGC dialog. Click
on a link to go to that setting's description.

UGC Densitometer Constants


Enter the densitometer calibration constants supplied by the
manufacturer.

For English Liquid applications:


Enter the constants based on gr/cc, degrees F and PSIG.

For Application 23:


Constants must be entered in terms of Lb/Ft3, degrees F and PSI.

For Metric Applications:


Enter the constants based on kg/m3, degrees C and pressure units which match the
pressure unit selected in the 'Factor Setup' menu.

156
Configuration

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
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.

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 up)
Plenum Pressure
Density/Gravity

157
OmniCom Help

Configuration

Prover

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 (applications 20 and 24 only)
Prover Setup (applications 22 and 26 only)

158
Configuration

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

Select a CONVENTIONAL Unidirectional or Bi-directional prover if more than 10, 000


pulses are accumulated between detectors.

Select a PULSE INTERPOLATION Unidirectional or Bi-directional compact prover if less


than 10, 000 pulses are accumulated between detectors. These provers are only
available with flow computers that have double chronometry 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 Unidirectional Pipe Compact if you are using an Emerson/Brooks compact prover.

Gas applications only have Master Meter proving type. Select the 'Master Meter' method
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 applications 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.

159
OmniCom Help

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 computer 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.7E6 2.03E6
Stainless Steel 2.8E7 to 2.9E7 1.93E8 to 2.0E8 1.93E6 to 2.0E6 1.89E6 to 1.96E6

Thermal Expansion
When a ‘Conventional Pipe’ prover type is selected, enter the ‘Cubical Coefficient of
Thermal Expansion’ for the prover pipe material. Conventional pipe provers will have
the detector switches mounted on the prover pipe.

Prover Material Cubical Expansion / Deg. F Cubical Expansion / Deg. C


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

When a ‘Pulse Interpolation’ prover type is selected enter the ‘Area Coefficient of
Thermal Expansion’ 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.

160
Configuration

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 Area Area Expansion


Material Expansion / / Deg. C
Deg. F
Mild Carbon 0.0000124 0.0000223
Steel
304 Stainless 0.0000192 0.0000346
Steel
316 Stainless 0.0000177 0.0000318
Steel
17-4PH 0.0000120 0.0000216
Stainless
Steel

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 temperature 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 / Deg. F Linear Expansion / Deg. C


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

161
OmniCom Help

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 degrees F for
English applications or 20.0 degrees C for Metric applications.

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 unidirectional pipe compact provers enter the upstream and downstream
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
measurement v20.74.22+)
Application 23 firmware = 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 = m3

For Metric units applications with flowmeters that output mass pulses:
For Non-Master Meter Proving:
Application 24 firmware = the configured volume units (m3 or L)
For Master Meter Proving:
Application 24 firmware = Tons or kg (in kg if the configured volume units are
L)
Application 27 firmware = kg

162
Configuration

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.

163
OmniCom Help

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 2 to 10.

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 and bi-directional compact 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.

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 flowrate 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 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)/Avg].

Enter for the Run Repeatability calculation based on:

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 following entry. Deviation is always
calculated using the meter factor when the 'Master Meter' prove method is
selected.

Stability Check

164
Configuration

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 Anhydrous Ammonia applications 20.74.22+,
the flowrate 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 rejects these
inaccurate measurements by holding the density value sampled just prior to
the launch, until the stability tmer expires. After that normal sampling
continues.

Allowable Temperature Deviation between Meter and Prover: Enter the


maximum temperature 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 temperature at the meter
and at the prover must be within 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.

165
OmniCom Help

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 firmware v20.74.18, v22.74.00, v23.74.19, v24.74.16,
v26.74.00, and v27.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 v22.74.00 and v26.74.00)

Number of MFs in Historical Average (1-10): Number of previous meter factors


to include in historical averages. (applications 22 and 26 only)

166
Configuration

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 flowrate 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
criteria) after a complete prove sequence, the Omni will immediately attempt another auto prove
sequence. If the Meter Factor is not auto implemented after the second complete prove
sequence, the Omni automatically disables Auto Proving in the configuration for that meter run.

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 current flow rate differs from the last meter proving flow rate by more
than this percent.
Note: In Omni firmware v24.74.19+, the Omni flow computer discards the
Pending Auto Prove flag (1n15) when flowrate 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 eliminates 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
flowrate 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

167
OmniCom Help

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.

168
Configuration

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 up.

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.

169
OmniCom Help

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
Solartron Liquid
Solartron Gas
Sarasota
UGC

170
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
dialog. 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. Available 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 gr/cc density
units

Solartron Pulse: When using a Solartron digital pulse type densitometer.

Sarasota Pulse: When using a Sarasota digital pulse type densitometer.

UGC Pulse: When using a UGC digital pulse type densitometer.

171
OmniCom Help

Density/Gravity Setup

The Density/Gravity setup is for entering and selecting the Density / Gravity transmitter scaling
values 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
General 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 override (1)- Always use override (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 overrides 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 pycnometer.

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.

172
Configuration

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] 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 descriptions of each setting option within the Meter Density/Gravity
Temperature 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 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
'Density 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 scaling. 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 scaling. 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 high alarm activates when the temperature at the densitometer rises
above this value.

173
OmniCom Help

174
Configuration

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] 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 descriptions of each setting option within the Meter Density/Gravity
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 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 Pressure 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 scaling. 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 scaling. 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 pressure at the densitometer drops
below this value.

High: The high alarm activates when the pressure at the densitometer rises
above this value.

175
OmniCom Help

Prover Density - Solartron Liquid

The Solartron / Liquid dialog is for entering the various Solartron liquid densitometer constants.
This dialog is available only if you select 'Solartron Density Pulse' as the signal type in the
Prover 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 descriptions of each setting option within the Solartron / Liquid dialog.
Click on the setting for more information.

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 gr/cc, degrees F, and PSIG.

For Metric applications:


CAUTION: The calibration certificates are usually based on
kg/M3, degrees C and Bar.
The Omni requires that they be expressed in terms of
degrees C 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.

SOLARTRON CALIBRATION CERTIFICATE CONSTANTS CONVERSION

Constant Certificate Value (Metric) Conversion Formula U.S. Value

Constant Certificate Conversion U.S. Value


Value (Metric) Formula
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 * -4.78689E-
14.504) 09
K21A 1.70300E-02 (K21A / 14.504) / 1.17416E-06

176
Configuration

1000
K21B -1.45300E-03 (K21B / (14.504 * -6.90701E-
14.504)) / 1000 09

Formulas convert Kg/m3 to gr/cc using Degrees F and PSIG.

177
OmniCom Help

Prover Density - Solartron Gas Pulse

The Solartron / Gas dialog is for entering the various Solartron gas densitometer constants. This
dialog is available only if you select 'Solartron Density Pulse' as the signal type in the Prover
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 Solartron / Gas
dialog. Click on the setting for more information.

Solartron Gas Densitometer Constants


These factors are provided by the densitometer manufacturer on the original
calibration documentation.

Enter the numbers in terms of Kg/m3 and deg.C ( this is the way they are documented,
no conversions 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 K5 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)) (K5 - (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 deg.C
Da = Actual density of fluid at flowing conditions corrected for velocity of
sound effects.
G = (SG at reference conditions/Ratio of Specific Heats)

178
Configuration

Prover Density - Sarasota Pulse

The Sarasota dialog is for entering the various Sarasota densitometer constants. This dialog is
available only if you select 'Sarasota Density Pulse' as the signal type in the Prover 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 Sarasota Densitometer
subcategory dialog. Click on the setting for more information.

Sarasota Densitometer Constants


Enter the densitometer calibration constants supplied by the
manufacturer.

For English Liquid applications:


Enter the calibration constants based on gr/cc, degrees F and PSIG.

For application 23:


Constants must be entered in terms of Lb/Ft3, degrees F and PSI.

For Metric applications:


Enter the calibration constants based on kg/m3, degrees C and pressure units which
match the selected pressure unit of the flow computer (see 'Factor Setup' menu).

179
OmniCom Help

Prover Density - UGC Pulse

The UGC dialog within the is for entering the various UGC densitometer constants. This dialog is
available only if you select 'UGC Density Pulse' as the signal type in the Prover 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 UGC dialog. Click
on a link to go to that setting's description.

UGC Densitometer Constants


Enter the densitometer calibration constants supplied by the
manufacturer.

For English Liquid applications:


Enter the constants based on gr/cc, degrees F and PSIG.

For Application 23:


Constants must be entered in terms of Lb/Ft3, degrees F and PSI.

For Metric Applications:


Enter the constants based on kg/m3, degrees C and pressure units which match the
pressure unit selected in the 'Factor Setup' menu.

180
Configuration

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
Temperature 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 scaling. 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 scaling. 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 drops below this value.

High: The high alarm activates when the temperature rises above this value.

181
OmniCom Help

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 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
"Pressure 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 scaling. 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 scaling. 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 pressure drops below this value.

High: The high alarm activates when the pressure rises above this value.

182
Configuration

Switch Bar Temperature

The Switch Bar Temperature is an input used to compensate the temperature of the detector
switch bar on unidirectional pipe compact provers such as Enraf's Calibron. The temperature
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 up.)

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
Temperature 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 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 scaling. 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 scaling. 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 drops below this value.

183
OmniCom Help

High: The high alarm activates when the temperature rises above this value.

184
Configuration

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
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 Plenum
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
'Pressure Override Value'.

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

185
OmniCom Help

Plenum Pressure Setup

The Plenum Pressure Setup is for entering and selecting constant values and deadband %
settings 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 inaccurate prove measurements and therefore must be
regulated.

The Plenum Pressure needed for correct operation of the Emerson/Brooks compact
prover is a function of the prover line pressure and plenum constant.

Plenum Pressure = (Line Pressure/Plenum Constant) + 60 PSIG.

The plenum constant depends on the size of the Emerson/Brooks compact prover:

Plenum Pressure Constants


Prover Size Constant
8 Inch 3.5
12 Inch Mini 3.2
12 Inch Standard 3.2
18 Inch 5.0
24 Inch 5.88
Larger Check with Emerson/Brooks

Plenum Deadband %
The 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.

186
Configuration

Products
Products

In the Products dialogs you can enter and select various meter run configuration settings for up to
16 products. OmniCom makes available only those dialogs that apply to your meter run
configuration.

Product

Firmware Versions 20 and 21


Measurement Algorithm
Setup

Firmware Version 22
Measurement Algorithm
Setup
Meter Factor Curve

Firmware Versions 24 and 25


Measurement Algorithm
Setup

Firmware Version 26
Measurement Algorithm
Setup
Meter Factor Curve

187
OmniCom Help

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 string 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 densitometer 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.

188
Configuration

Measurement Algorithm (Firmware Versions 20 and 21)

Select the calculation standards to use when running this product. Selecting a standard
automatically 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 deg. F. 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 (SG) at observed temperature to relative
density at base conditions (SG at 60F). The range of the algorithm is:

Relative Temperature,
Density, deg.F
(SG)
0.6110 to 0 to 200
0.7795
0.7800 to 0 to 250
0.8250
0.8255 to 0 to 300
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 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:

189
OmniCom Help

Relative Temperature,
Density, deg.F
(SG)
0.6110 to 0 to 200
0.7795
0.7795 to 0 to 250
0.8250
0.8250 to 0 to 300
1.076

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 Temperature,
Density, deg.F
(SG)
0.6535 to 0 to 200
0.7795
0.7800 to 0 to 250
0.8250
0.8255 to 0 to 300
1.0760

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, Temperature,

190
Configuration

(SG) deg.F
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 startup.

Table 24C (Table Select = 2)


Special Applications
The range of the algorithm is:

Alpha Temperature
106 deg. F
530 to 0 to 200
930
(1860)
510 to 0 to 250
530
(135) 270 0 to 300
to 510

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:

Relative 0.600
Density to
range 1.095
Temperature 0 to
Range 300
deg.F

If the relative density or temperature is out of range the last known good value for
Specific Gravity @60 or Ctl is used.

LPGS AND NGLS

GPA TP16 (Table Select = 3)


TP16 - Live Density/Gravity

191
OmniCom Help

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

Specific Gravity Range 0.425 to 0.6535


Temperature Range deg.F -50 to 140

Table 23A

Specific 0.6535
Gravity Range to
0.700
Temperature -50 to
Range deg.F 140

Table details: Specific Gravity Increment is .005


Temperature Increment is 1.0 deg.F

Specific Gravity is rounded to .xxxx


Temperature is rounded to xxx.x

Note: If the relative density (SG) 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 boundaries, 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

Specific 0.500
Gravity Range to
0.6500
Temperature -50 to
Range deg.F 140

Table 24A

Specific 0.655
Gravity Range to
0.700
Temperature -50 to
Range deg.F 140

Table details: Specific Gravity Increment is .005**

192
Configuration

Temperature Increment is 1.0 deg.F

** 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]xF )

The compressibility factor 'F' is calculated by either API 11.2.1 or API 11.2.2 depending
upon relative density at base temperature (SG60)

API 11.2.1

Specific 1.076
Gravity Range to
0.638
Temperature -20 to
Range deg.F 200

API 11.2.2

Specific 0.638
Gravity Range to
0.350
Temperature -50 to
Range deg.F 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.

Equilibrium Pressure Pe

Is calculated using API 11.2.5(GPA TP15 extended) equilibrium pressure correlation.

API 11.2.5

Specific 0.676
Gravity Range to
0.350
Temperature -50 to
Range deg.F 140~

193
OmniCom Help

~ The upper limit of 140 deg.F cannot be reached when product relative densities at 60
deg.F 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)


Table 23E is used to convert relative density (SG) at observed temperature and
pressure to relative density (SG60) at base temperature and pressure conditions. The
range of table 23E is:

Table 23E

Relative Density 0.2100 to


(SG) Range 0.7400
Temperature -50.0 to
Range 200.0
deg.F

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 (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 0.3500 to


at Base (SG60) 0.6880
Temperature -50.0 to
Range deg.F 200.0
deg.F

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 relative density at base temperature (SG60)

API 11.2.1

Specific 1.076 to
Gravity 0.638
Range
Temperature -20 to
Range 200
deg.F

194
Configuration

API 11.2.2

Specific 0.638 to
Gravity 0.350
Range
Temperature -50 to
Range 140
deg.F

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.

Equilibrium Pressure Pe

Is calculated using API 11.2.5(GPA TP15 extended) equilibrium pressure correlation.

API 11.2.5

Specific 0.676 to
Gravity 0.350
Range
Temperature -50 to
Range 140~
deg.F

NGL (Table Select = 40, Available with v20.74.14 and up 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 (SG) at observed temperature to relative
density at base conditions (SG at 60F). The range of the algorithm is:

Relative Temperature,
Density, deg.F
(SG)
0.6110 to 0 to 200
0.7795
0.7800 to 0 to 250
0.8250
0.8255 to 0 to 300
1.076

1) If the 'observed relative density' is out of range, the 'relative density at base
conditions' remains at the last calculated value.

195
OmniCom Help

2) Calculations continue below temperatures of 0 deg.F. but the 'Calc out of Range'
alarm will be set.
3)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

'Table 24A Modified' calculates the correction for temperature on the liquid 'Ctl' based
on 'relative density (SG) at base conditions', and 'observed temperature'.
The range of the application is:

Relative Temperature,
Density, deg.F
(SG)
0.6110 to 0 to 200
0.7795
0.7795 to 0 to 250
0.8250
0.8250 to 0 to 300
1.076

1) If the 'observed relative density' is out of range, the 'Ctl' remains at the last
calculated value.
2) Calculations continue below temperatures of 0 deg.F., 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,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 0.350
Density to
range 0.676

A convergent routine is used to determine relative density at base conditions (SG60)


given observed relative density (SG), 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)

196
Configuration

This algorithm uses a combination of GPA TP16 and API 11.3.3.2 to measure binary
mixtures of propane and propylene. Based on observed relative density (SG),
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 individually
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

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 or flowing relative density (SG) is available
and there is no known algorithm to correct for temperature or pressure effects on the
liquid.

Gross Volume = Volume Pulses / K-Factor

Net Volume = Gross Volume * CTL * CPL * MF

Mass = Gross Volume * Flowing Density * DCF * 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 (SG) at observed temperature, to


relative density at base conditions (SG60).
The table limits are as follows:

Relative Temperature,
Density, deg.F
(SG)
0.585 to 65.0 to 110.0

197
OmniCom Help

0.615
0.620 to 15.0 to 85.0
0.650
0.655 to -10.0 to 30.0
0.675

Table 2 is used to calculate the correction factor for temperature on a liquid 'Ctl' at
observed temperature.
The table limits are as follows:

Relative Temperature,
Density at deg F
Base
Conditions,
(SG60)
0.621 to 0.634 -10.0 to 110.0

1) If the relative density (SG) 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 D1555 (Table Select = 14)


Algorithm range: -50 to 120 deg.F.

This algorithm selection is provided for compatibility with early flow computer firmware.
ASTM D1555 is actually 11 different Ctl lookup tables for 11 different aromatic
products. This algorithm selection determines which Ctl table to use by examining the
users entry of Product SG60 (relative density at base) made on the 'Product Setup)
tab.

Because several aromatic products have overlapping SG60s it is only possible to


determine 8 of the 11 aromatic products. These products are: Cyclohexane, p-Xylene,
m-Xylene, o-Xylene, Cumene, Toluene, Benzene and Styrene.
Because of this limitation this implementation of ASTM D1555 is not recommended,
used one of the selection following:

Benzene (Table Select = 16)


Use for Benzene, no SG entry required.
Algorithm range: -50 to 120 deg.F.

Cumene (Table Select = 24)


Use for Cumene, no SG entry required.
Algorithm range: -50 to 120 deg.F.

198
Configuration

Cyclohexane (Table Select = 22)


Use for Cyclohexane, no SG entry required.
Algorithm range: -50 to 120 deg.F.

Ethylbenzene (Table Select = 23)


Use for Ethylbenzene, no SG entry required.
Algorithm range: -50 to 120 deg.F.

m-Xylene (Table Select = 18)


Use for m-Xylene, no SG entry required.
Algorithm range: -50 to 120 deg.F.

o-Xylene (Table Select = 20)


Use for o-Xylene, no SG entry required.
Algorithm range: -50 to 120 deg.F.

p-Xylene (Table Select = 21)


Use for p-Xylene, no SG entry required.
Algorithm range: -50 to 120 deg.F.

Styrene (Table Select = 19)


Use for Styrene, no SG entry required.
Algorithm range: -50 to 120 deg.F.

Toluene (Table Select = 17)


Use for Toluene, no SG entry required.
Algorithm range: -50 to 120 deg.F.

Aromatic Hydrocarbon (300degF - 350degF) (Table Select = 25)


Use for Aromatic Hydrocarbons within the temperature range (300degF/148.9degC -
350degF/176.7degC). No SG entry required.

Aromatic Hydrocarbon (350degF - 400degF) (Table Select = 26)


Use for Aromatic Hydrocarbons within the temperature range of (350degF/176.7degC
- 350degF/204.4degC). No SG entry required.

OLEFINS

Propylene API 2565/11.3.3.2 (Table Select = 5)


This standard was originally issued and known as subroutine Propyl of API 2565.

199
OmniCom Help

Temperature, Pressure,
deg.F 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 indicate 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 temperature 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, deg.F Pressure, PSIA


-273 to 260 Psaturation to 5800

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.

200
Configuration

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.

Original subroutine Ethyl limits:

Temperature, Pressure,
deg.F 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 temperature and pressure input values below
the limits of the API 11.3.2 algorithm to meet the needs of industry.

The density value will be left at the last known good value if either the temperature or
pressure are outside of the extended limits, or if the algorithm cannot converge on a
solution.

When flowing parameters are within the original algorithm limits the flow computer is in
strict compliance 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 (2004 EDITION).

COMMODITY TYPES:

Crude Oil, Refined Products, Lubricating Oil, Special Applications (Table Selects =
28-31, Available with firmware versions 20.74.10 and up)
Chapter 11.1.6.1
Calculate the Volume Correction Factor (Ctpl) for correcting from density at the base
conditions (60 Degrees F 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:

201
OmniCom Help

Temperature -58.0 deg. F to 302.0


deg. F
Pressure 0 psig to 1500psig

Density Density @ base


conditions minimum to
Density @ base
conditions maximum (if
commodity type is
specified)

For special applications:


-6 -6
Alpha 230x10 to 930.0x10 (if
Range Pre-Calculated 60 deg. F
Thermal expansion factor,
not commodity group type
is specified.)

Product Density at Density at


Type Base Base
Conditions Conditions
Min Max
Crude Oil 610.6Kg/m3 1163.5Kg/m3
Refined 610.6Kg/m3 1163.5Kg/m3
Products
Lubricating 800.9Kg/m3 1163.5Kg/m3
Oil
Special
Applications

K1 coefficients used in these equations depend upon the commodity group. The
flowing table gives the coefficients to be used.

Product Density K0 K1 K2
Range
Kg/M3
Crude Oil 610.6- 341.0957 0.0 0.0
1163.5
Fuel Oils 838.3127- 103.8720 0.2701 0.0
1163.5
Jet Fuels 787.5195- 330.3010 0.0 0.0
838.3127
Transition 770.3520- 1489.0670 0.0 -
Zone 787.5195 0.00186840
Gasolines 610.6- 192.4571 0.2438 0.0
770.3520
Lubricating 800.9- 0.0 .034878 0.0
Oils 1163.5
Special
Applications

202
Configuration

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, Pressure,
deg.F PSIA
-260 to 540 0 to
45,000

Flowing density will 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 up)
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

Anhydrous Ammonia (Table Select = 32, Available with firmware versions 20.74.22 and
up)
Temperature range for table is -28.0 deg.F to +100 deg.F
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 specifically 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 flowrates and
totals, lb/ft3 for flowing density, Tons for flowrate alarm limits and batch size units,
etc.).

203
OmniCom Help

Measurement Algorithm (Firmware Version 22)

Select the calculation standards to use when running this product. Selecting a standard
automatically 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 deg.F. 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 (SG) at observed temperature to relative
density at base conditions (SG60F). The range of the algorithm is:

Relative Temperature,
Density, (SG) deg.F
0.6110 to 0 to 200
0.7795
0.7800 to 0 to 250
0.8250
0.8255 to 0 to 300
1.760

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 Temperature,

204
Configuration

Density, deg.F
(SG)
0.6110 to 0 to 200
0.7795
0.7795 to 0 to 250
0.8250
0.8250 to 0 to 300
1.760

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 Temperature,
Density, deg.F
(SG)
0.6535 to 0 to 200
0.7795
0.7800 to 0 to 250
0.8250
0.8255 to 0 to 300
1.0760

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 Temperature,
Density, deg.F

205
OmniCom Help

(SG)
0.6535 to 0 to 200
0.7795
0.7800 to 0 to 250
0.8250
0.8255 to 0 to 300
1.0760

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 startup.

Table 24C (Table Select = 2)


Table 24C - Special Applications
The range of the algorithm is:

Alpha Temperature
106 deg. F
530 to 0 to 200
930
(1860)
510 to 0 to 250
530
(135) 270 0 to 300
to 510

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 up)
Table 5A Generalized Crude Oils & JP-4 Aviation Fuel

Table 5A converts API gravity at observed temperature to API gravity at base


conditions (60F). The range of the algorithm is:

API Temperature,
Gravity deg.F
50 to 0 to 200
100
40 to 0 to 250
50
0 to 40 0 to 300

The API gravity at base conditions (60F) 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

206
Configuration

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 conditions (60F) and observed temperature.
The Range of the application is:

API Temperature,
Gravity deg.F
50 to 0 to 200
100
40 to 0 to 250
50
0 to 40 0 to 300

If the API gravity at base conditions (60F) 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.05 and up)
Table 5B Refined Products

Table 5B converts API gravity at observed temperature to API gravity at base


conditions (60F). The range of the algorithm is:

API Temperature,
Gravity deg.F
50 to 0 to 200
85
40 to 0 to 250
50
0 to 40 0 to 300

The API gravity at base conditions (60F) 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 conditions (60F) and observed temperature.
The Range of the application is:

API Temperature,
Gravity deg.F

207
OmniCom Help

50 to 0 to 200
85
40 to 0 to 250
50
0 to 0 to 300
40

If the API gravity at base conditions (60F) 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.05 and up)
Table 6C - Special Applications
The range of the algorithm is:

Alpha Temperature
106 deg. F
530 to 0 to 200
930
(1860)
510 to 0 to 250
530
(135) 270 0 to 300
to 510

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:

Relative Temperature
Density Range
0.600 to 0 to 300
1.095 deg.F

If the relative density or temperature is out of range the last known good value for
Specific Gravity @60 or Ctl is used.

LPGS AND NGLS

GPA TP16 (Table Select = 3)


TP16 - Live Density/Gravity

208
Configuration

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

Specific Temperature
Gravity
0.425 to -50 to 140
0.6535 deg.F

Table 23A

Specific Temperature
Gravity
0.6535 -50 to 140
to 0.700 deg.F

Table details: Specific Gravity Increment is 0.005


Temperature Increment is 1.0 deg.F

Specific Gravity is rounded to .xxxx


Temperature is rounded to xxx.x

Note: If the relative density (SG) 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 boundaries, 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

Specific Temperature
Gravity
0.500 to -50 to 140
0.6500 deg.F

Table 24A

Specific Temperature
Gravity
0.655 to -50 to 140
0.700 deg.F

Table details: Specific Gravity Increment is 0.005**


Temperature Increment is 1.0 deg.F

209
OmniCom Help

** 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]xF )

The compressibility factor 'F' is calculated by either API 11.2.1 or API 11.2.2 depending
upon relative density at base temperature (SG60)

API 11.2.1

Specific Temperature
Gravity
1.076 to -20 to 200
0.638 deg.F

API 11.2.2

Specific Temperature
Gravity
0.638 to -50 to 140
0.350 deg.F

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.
Equilibrium Pressure Pe

Is calculated using API 11.2.5(GPA TP15 extended) equilibrium pressure correlation.

API 11.2.5

Specific Temperature
Gravity
0.676 to -50 to 140~
0.350 deg.F

~ The upper limit of 140 deg.F cannot be reached when product relative densities at 60
deg.F are below 0.430. Refer to API 11.2.5 to estimate the upper temperature limit.

210
Configuration

API 11.2.4,23E/24E(GPA TP27) (Table Select = 15, Available with firmware versions
22.74.06 and up)
Table 23E is used to convert relative density (SG) at observed temperature and
pressure to relative density (SG60) at base temperature and pressure conditions. The
range of table 23E is:

Table 23E

Relative Density 0.2100


(SG) Range to
0.7400
Temperature -50.0 to
Range deg.F 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 0.3500


Base (SG60) to
0.6880
Temperature -50.0 to
Range deg.F 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 relative density at base temperature (SG60)

API 11.2.1

Specific 1.076
Gravity Range to
0.638
Temperature -20.0
Range deg.F to
200.0

API 11.2.2

Specific 0.638

211
OmniCom Help

Gravity Range to
0.350
Temperature -50.0
Range deg.F 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.

Equilibrium Pressure Pe

Is calculated using API 11.2.5(GPA TP15 extended) equilibrium pressure correlation.

API 11.2.5

Specific 0.676
Gravity Range to
0.350
Temperature -50.0 to
Range deg.F 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 0.350
Density to
range 0.676

A convergent routine is used to determine relative density at base conditions (SG60)


given observed relative density (SG), 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.

API MPMS 11.1 (2004 EDITION)

COMMODITY TYPES:

212
Configuration

Crude Oil, Refined Products, Lubricating Oil, Special Applications (Table Selects =
28-31, Available with firmware versions 22.74.06 and up)
Chapter 11.1.6.1
Calculate the Volume Correction Factor (Ctpl) for correcting from density at the base
conditions (60 Degrees F 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 -58.0 deg. F to 302.0


deg. F
Pressure 0 psig to 1500psig

Density Density @ base


conditions minimum to
Density @ base
conditions maximum (if
commodity type is
specified)

For special applications:


-6 -6
Alpha 230x10 to 930.0x10 (if
Range Pre-Calculated 60 deg. F
Thermal expansion factor,
not commodity group type
is specified.)

Product Density at Density at


Type Base Base
Conditions Conditions
Min Max
Crude Oil 610.6Kg/m3 1163.5Kg/m3
Refined 610.6Kg/m3 1163.5Kg/m3
Products
Lubricating 800.9Kg/m3 1163.5Kg/m3
Oil
Special
Applications

K1 coefficients used in these equations depend upon the commodity group. The
flowing table gives the coefficients to be used.

Product Density K0 K1 K2
Range
Kg/M3
Crude Oil 610.6- 341.0957 0.0 0.0
1163.5
Fuel Oils 838.3127- 103.8720 0.2701 0.0
1163.5

213
OmniCom Help

Jet Fuels 787.5195- 330.3010 0.0 0.0


838.3127
Transition 770.3520- 1489.0670 0.0 -
Zone 787.5195 0.00186840
Gasolines 610.6- 192.4571 0.2438 0.0
770.3520
Lubricating 800.9- 0.0 .034878 0.0
Oils 1163.5
Special
Applications

214
Configuration

Measurement Algorithm (Firmware Versions 24 and 25)

Select the calculation standards to use when running this product. Selecting a standard
automatically causes the flow computer to use the appropriate companion standards to calculate
density at reference conditions. i.e. selecting Table 54A causes the flow computer to use Table
53B 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.

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,


deg.C
610.5 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 calculated value.
2. Calculations continue below temperatures of -18 deg.C 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.

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 conditions', and 'observed temperature'.
The range of the application is:

Density, kg/m3 Temperature,


deg.C

215
OmniCom Help

610.5 to 778.5 -18 to 95


779.0 to 824.0 -18 to 125
824.5 to 1075.0 -18 to 150

4. If the 'observed density' is out of range, the 'Ctl' remains at the last
calculated value.
5. Calculations continue below temperatures of -18 deg.C., the 'Calc out of
Range' alarm will be set.
6. 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:

Relative Density, Temperature,


kg/m3 deg.C
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

Gasolines and Napthens range: 653.0 to 778.5 kg/m3


Jet Fuels, Kerosenes and Solvents: 779.0 to 838.5 kg/m3
Diesel, Heating Oil and Fuel Oils: 839.0 to 1075.0 kg/m3

1. If the 'observed density' is out of range, the 'density at base conditions'


remains at the last calculated value.
2. Calculations continue below temperatures of -18 deg.C 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.

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 conditions and observed temperature.
The Range of the application is:

Relative Density, Temperature,


kg/m3 deg.C
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

216
Configuration

4. If the 'observed density' is out of range, the 'Ctl' remains at the last
calculated value.
5. Calculations continue below temperatures of -18 deg.C., the 'Calc out of
Range' alarm will be set.
6. 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 10 6
Temperature deg. C
955 to 3348 -18 to 95
918 to 954 -18 to 125
243 to 918 -18 to 150

Values in red are extensions to the original algorithm limits.

1. The algorithm will continue to calculate when temperatures are below -18
deg.C but the 'Calc out of Range' alarm will be set.
2. 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.

Table 53D/54D (Table Select = 27, Available with firmware versions 24.73 and up)
Table 53D Generalized Lubricating Oils Correction of Observed Density to
Density at 15 Degrees C

Table 53A converts 'observed density' to 'density at base conditions'. The range of the
algorithm is:

Density, kg/m3 Temperature,


deg.C
1164.0 to 800.0 -18 to 150

3. If the 'observed density' is out of range, the 'density at base conditions'


remains at the last calculated value.
4. Calculations continue below temperatures of -18 deg.C but the 'Calc out of
Range' alarm will be set.
5. The 'density at base conditions' is not updated when the 'observed
temperature' exceeds the table limits.

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 Degrees C


Against Density at 15 Degrees C

217
OmniCom Help

Table 54D gives volume correction factors (VCF) for converting volumes observed at
temperatures other than 15 degrees C to corresponding volumes at 'base conditions'.

Density, kg/m3 Temperature,


deg.C
1164.0 to 800.0 -18 to 150

6. The algorithm will continue to calculate when temperatures are below -18
deg.C but the 'Calc out of Range' alarm will be set.
7. 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.
8. 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 Range kg/m3 Temperature Range deg.C


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 conditions and observed temperature.
The Range of the application is:

Reference Density Range kg/m3 Temperature Range deg.C


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

218
Configuration

GPA TP16M (Table Select = 3)


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 Range 420 to 655 Kg/m3


Temperature Range -50 to 60 deg.C

Table 53A

Density Range 660 to 700 Kg/m3


Temperature Range -50 to 60 deg.C

Density Increment is 5 Kg/m3


Temperature Increment is 0.5 deg.C

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 Range 500 to 655 Kg/m3


Temperature Range -50 to 60 deg.C if Density 500 to 595
Temperature Range -35 to 75 deg.C if Density 600 to 655

Table 54A

Density Range 660 to 700 Kg/m3


Temperature Range -35 to 75 deg.C

Density Increment is 5 Kg/m3


Temperature Increment is 0.5 deg.C

** 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.

Input: Density is rounded to xxx.x


Temperature is rounded to xxx.x5

Output : VCF (volume correction factor) ( also known as Ctl )

219
OmniCom Help

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]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 Range kg/m3 638 to 1074


Temperature Range deg.C. -46 to 60

API 11.2.2M

Density Range kg/m3 350 to 637


Temperature Range deg.C -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.
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 Range kg/m3 350 to 675


Temperature Range deg.C -40 to 60

~ The upper limit of 140 deg.F cannot be reached when product relative densities at 60
deg.F 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)


Table 53E is used to convert density at observed temperature and pressure to density
at base temperature and pressure conditions. The range of table 53E is:

Density Range kg/m3 210.0 to 740.0


Temperature Range deg.C -45.55 to 93.33

The density at base conditions is set to 0.00 and the 'Calc out of Range' error flag
raised if the density or temperature is out of range.

Table 54E is used to calculate the Ctl correction factor given density at base
conditions and observed temperature. The algorithm limits are:

220
Configuration

Density at Base Range kg/m3 350.0 to 688.0


Temperature Range deg.C -45.55 to 93.33

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 be 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 Range kg/m3 638 to 1074


Temperature Range deg.C -46 to 60

API 11.2.2M

Density Range kg/m3 350 to 637


Temperature Range deg.C -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.
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 Range kg/m3 350 to 675


Temperature Range deg.C -40 to 60

NGL (Table Select = 40, Available with firmware versions 24.73 and up 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.

'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,

221
OmniCom Help

deg.C
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 calculated value.
2) Calculations continue below temperatures of -18 deg.C. 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,


deg.C
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 deg.C., 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 range 0.350 to 0.676

A convergent routine is used to determine relative density at base conditions given


observed relative density (SG), 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.
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.
out of range (CTL = 0 after calculation), also does not update VCF, CPL, PE, A factor,
B factor and F factor.

222
Configuration

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 propane and propylene. Based on observed relative density (SG),
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 individually
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 or flowing relative density (SG) is available
and there is no known algorithm to correct for temperature or pressure effects on the
liquid.

Gross Volume = Volume Pulses / K-Factor

Net Volume = Gross Volume * CTL * CPL * MF

Mass = Gross Volume * Flowing Density * DCF * 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).

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, deg


C
585 to 615 18 to 92

223
OmniCom Help

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 temperature.
The table limits are as follows:

Density at Base Temperature, deg


Conditions, F
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: -46 to 49 deg.C.

This algorithm selection is provided for compatibility with early flow computer firmware.
ASTM D1555M is actually 11 different Ctl lookup tables for 11 different aromatic
products. This algorithm selection determines which Ctl table to use by examining the
users entry of Product Density made on the 'Product Setup) tab.

Because several aromatic products have overlapping densities at base conditions it is


only possible to determine 8 of the 11 aromatic products. These products are:
Cyclohexane, p-Xylene, m-Xylene, o-Xylene, Cumene, Toluene, Benzene and
Styrene.
Because of this limitation this implementation of ASTM D1555M is not recommended
for new applications, users should select the actual aromatic product

Benzene (Table Select = 16)


Use for Benzene, no reference density entry required.
Algorithm range: -46 to 49 deg.C.

Cumene (Table Select = 24)


Use for Cumene, No reference density entry required.
Algorithm range: -46 to 49 deg.C.

Cyclohexane (Table Select = 22)


Use for Cyclohexane, No reference density entry required.
Algorithm range: -46 to 49 deg.C.

224
Configuration

Ethylbenzene (Table Select = 23)


Use for Ethylbenzene, No reference density entry required.
Algorithm range: -46 to 49 deg.C.

m-Xylene (Table Select = 18)


Use for m-Xylene, No reference density entry required.
Algorithm range: -46 to 49 deg.C.

o-Xylene (Table Select = 20)


Use for o-Xylene, No reference density entry required.
Algorithm range: -46 to 49 deg.C.

p-Xylene (Table Select = 21)


Use for p-Xylene, No reference density entry required.
Algorithm range: -46 to 49 deg.C.

Styrene (Table Select = 19)


Use for Styrene, No reference density entry required.
Algorithm range: -46 to 49 deg.C.

Toluene (Table Select = 17)


Use for Toluene, No reference density entry required.
Algorithm range: -46 to 49 deg.C.

Aromatic Hydrocarbon (148.9degC - 176.7degC) (Table Select = 25)


Use for Aromatic Hydrocarbons within the temperature range (148.9degC -
176.7degC). No reference density entry required.

Aromatic Hydrocarbon (176.7degC - 204.4degC) (Table Select = 26)


Use for Aromatic Hydrocarbons within the temperature range of (176.7degC -
204.4degC). No reference density entry required.

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, Pressure, BARa


deg.C
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.

225
OmniCom Help

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 indicate 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 temperature 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.

Original subroutine Ethyl limits:

Temperature, Pressure, BARa


deg.C
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 temperature and pressure input values below
the limits of the API 11.3.2 algorithm to meet the needs of industry.

The density value will be left at the last known good value if either the temperature or
pressure are outside of the extended limits, or if the algorithm cannot converge on a
solution.

When flowing parameters are within the original algorithm limits the flow computer is in
strict compliance with the original standard.

Ethylene density is calculated and placed in ' 7n07 ' (equation of state density).

226
Configuration

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 (2004 EDITION) COMMODITY TYPES

Crude Oil, Refined Products, Lubricating Oil, Special Applications (Table Selects =
28-31, Available with firmware versions 24.73 and up)
Calculate the Volume Correction Factor (VCF) for correcting from density at the base
conditions (15 Degrees C and 0 kPa (gauge)). The parameter used in this procedure
depends on the commodity group to which the liquid belongs.

The limits of the standard are:

Temperature -47 Deg C to 150 deg. C


Pressure 0 BARg to 103 BARg
Density Density @ base conditions minimum to
Density @ base conditions maximum (if
commodity type is specified)

For special applications:

-6 -6
Alpha Range 230x10 to 930.0x10 (if Pre-Calculated
60 deg. F Thermal expansion factor, not
commodity group type is specified.)

Product Type Density at Base Density at Base


Conditions Min 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
Special
Applications

K1 coefficients used in these equations depend upon the commodity group. The
flowing table gives the coefficients to be used.

Product Density K0 K1 K2
Range
Kg/M3
Crude Oil 610.6 to 341.0957 0.0 0.0
1163.5
Fuel Oils 838.3127 to 103.8720 0.2701 0.0
1163.5
Jet Fuels 787.5195 to 330.3010 0.0 0.0
838.3127
Transition 770.3520 to 1489.0670 0.0 -

227
OmniCom Help

Zone 787.5195 0.00186840


Gasolines 610.6 to 192.4571 0.2438 0.0
770.3520
Lubricating 800.9 to 0.0 .034878 0.0
Oils 1163.5

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, Pressure, BARa


deg.C
-162 to 282 0 to 3000

Flowing density will 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 up)
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 up 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, Pressure, MPa


deg.C
-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.

The composition analysis basis can be Mole Percent, Mole Fraction, Mass Percent, or
Mass Fraction.

228
Configuration

You may enter up to 17 components. For more information see the help for NIST14
Component Analysis.

229
OmniCom Help

Measurement Algorithm (Firmware Version 26)

Select the calculation standards to use when running this product. Selecting a standard
automatically causes the flow computer to use the appropriate companion standards to calculate
density at reference conditions. i.e. selecting Table 54A causes the flow computer to use Table
53B 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.

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,


deg.C
610.5 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 calculated value.
2) Calculations continue below temperatures of -18 deg.C. 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.

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 conditions', and 'observed temperature'.
The range of the application is:

Density, kg/m3 Temperature,


deg.C

230
Configuration

610.5 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 deg.C., the 'Calc out of Range'
alarm will be set.
3)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:

Relative Density, Temperature,


kg/m3 deg.C
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

Gasolines and Napthens range: 653.0 to 778.5 kg/m3


Jet Fuels, Kerosenes and Solvents: 779.0 to 838.5 kg/m3
Diesel, Heating Oil and Fuel Oils: 839.0 to 1075.0 kg/m3

1) If the 'observed density' is out of range, the 'density at base conditions' remains at
the last calculated value.
2) Calculations continue below temperatures of -18 deg.C., 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.

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 conditions and observed temperature.
The Range of the application is:

Relative Density, Temperature,


kg/m3 deg.C
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

1) If the 'observed density' is out of range, the 'Ctl' remains at the last calculated value.

231
OmniCom Help

2) Calculations continue below temperatures of -18 deg.C., the 'Calc out of Range'
alarm will be set.
3)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 10 6
Temperature deg. C
955 to 3348 -18 to 95
918 to 954 -18 to 125
243 to 918 -18 to 150

Values in red are extensions to the original algorithm limits.

The algorithm will continue to calculate when temperatures are below -18 deg.C 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 Range kg/m3 Temperature Range deg.C


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 conditions and observed temperature.
The Range of the application is:

Reference Density Range kg/m3 Temperature Range deg.C


600 to 840 -25 to 75
840 to 870 -25 to 100

232
Configuration

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 Range 420 to 655 Kg/m3


Temperature Range -50 to 60 deg.C

Table 53A

Density Range 660 to 700 Kg/m3


Temperature Range -50 to 60 deg.C

Density Increment is 5 Kg/m3


Temperature Increment is 0.5 deg.C

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 Range 500 to 655 Kg/m3


Temperature Range -50 to 60 deg.C if Density 500 to 595
Temperature Range -35 to 75 deg.C if Density 600 to 655

Table 54A

Density Range 660 to 700 Kg/m3


Temperature Range -35 to 75 deg.C

Density Increment is 5 Kg/m3

233
OmniCom Help

Temperature Increment is 0.5 deg.C

** 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.

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]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 Range kg/m3 638 to 1074


Temperature Range deg.C. -46 to 60

API 11.2.2M

Density Range kg/m3 350 to 637


Temperature Range deg.C -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.

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 Range kg/m3 350 to 675


Temperature Range deg.C -40 to 60

~ The upper limit of 140 deg.F cannot be reached when product relative densities at 60
deg.F 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 up)

234
Configuration

Table 53E is used to convert density at observed temperature and pressure to density
at base temperature and pressure conditions. The range of table 53E is:

Density Range kg/m3 210.0 to 740.0


Temperature Range deg.C. -45.55 to 93.33

The density at base conditions is set to 0.00 and the 'Calc out of Range' error flag
raised if the density or temperature is out of range.

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 Range 350.0 to 688.0


Temperature deg.C. -45.55 to 93.33

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 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 Range kg/m3 638 to 1074


Temperature Range deg.C. -46 to 60

API 11.2.2M

Density Range kg/m3 350 to 637


Temperature Range deg.C -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.
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 Range kg/m3 350 to 675


Temperature Range deg.C -40 to 60

235
OmniCom Help

API MPMS 11.1 (2004 EDITION) COMMODITY TYPES

Crude Oil, Refined Products, Lubricating Oil, Special Applications (Table Selects =
28-31, Available with firmware version 26.74.10 and up)
Calculate the Volume Correction Factor (VCF) for correcting from density at the base
conditions (15 Degrees C and 0 kPa (gauge)). The parameter used in this procedure
depends on the commodity group to which the liquid belongs.

The limits of the standard are:

Temperature -47 Deg C to 150 deg. C


Pressure 0 BARg to 103 BARg
Density Density @ base conditions minimum to
Density @ base conditions maximum (if
commodity type is specified)

For special applications:

-6 -6
Alpha Range 230x10 to 930.0x10 (if Pre-Calculated
60 deg. F Thermal expansion factor, not
commodity group type is specified.)

Product Type Density at Base Density at Base


Conditions Min 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
Special
Applications

K1 coefficients used in these equations depend upon the commodity group. The
flowing table gives the coefficients to be used.

Product Density K0 K1 K2
Range
Kg/M3
Crude Oil 610.6 to 341.0957 0.0 0.0
1163.5
Fuel Oils 838.3127 to 103.8720 0.2701 0.0
1163.5
Jet Fuels 787.5195 to 330.3010 0.0 0.0
838.3127
Transition 770.3520 to 1489.0670 0.0 -
Zone 787.5195 0.00186840
Gasolines 610.6 to 192.4571 0.2438 0.0
770.3520
Lubricating 800.9 to 0.0 .034878 0.0
Oils 1163.5

236
Configuration

237
OmniCom Help

Setup (Firmware Versions 20 and 21)

The Product Setup for Liquid Applications is for entering meter factors for each flowmeter and
information 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).

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 flowing density using the reference density derived from the
override API. When using a densitometer or gravitometer with API 11.1 (2004)
Commodity Types measurement selections, see the 'Calculate Reference API/SG' help
topic below.

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).

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 flowing density using the reference density derived from the
override SG. When using a densitometer or gravitometer with API 11.1 (2004)
Commodity Types measurement selections, see the 'Calculate Reference API/SG' help
topic below.

API 11.1 (2004) F factor for CPL (available with firmware 20.74.22 and up)
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(2004) 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)

238
Configuration

This setting applies only when selecting one of the API 11.1 (2004) Commodity Types
standards and if you would like the flow computer to calculate the reference density
using the transducer density.

Note: A negative override value for the API@60 or SG@60 when using API 11.1
(2004) 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 (2004) 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 reference 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 reference 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 flowing 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 override 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'. to be entered. This Alpha-T value is used to calculate the volume
correction factor 'VCF', also known as Ctl.

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.

239
OmniCom Help

Note: If Table 24C is selected and the API 11.1(2004) 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 pressure of the flowing fluid be calculated according to API 11.2.5(GPA
TP15 extended). Two API 11.2.5 equations are available:
The first, designed primarily for pure products such as propanes, butanes and
natural gasolines, requires no input data other than the temperature at flowing
conditions and the specific gravity at reference.
The second improved correlation, is suitable for use with more varied NGL
mixtures, where different product mixes could have the same specific gravity
but different equilibrium pressures.
If you wish to use the improved second method, enter the vapor pressure in the
appropriate absolute pressure units of measure at 100 deg.F.
Enter a minus number to use the normal API 11.2.5 method for propanes,
butanes and natural gasolines.

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.

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 up)
The separate use of CTL and CPL instead of always having to use CTPL was
introduced by API in the Spring 2007 Addendum to the API MPMS 11.1 (2004)
standard.

This field is provided when one of the API 11.1 (2004) 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.

If the box is checked, the individual CTL and CPL are multiplied together to
calculate the corrected volume.

Base Pressure (Pe) (available with firmware 20.74.24 and up)


The use of Base Pressure (Pe) at a value other than 0 was introduced by API in the
Spring 2007 Addendum to the API MPMS 11.1 (2004) standard.

Enter this value in gauge units, not absolute units. Default value is 0.00.

In the Spring 2007 Addendum to API MPMS 11.1 (2004), 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 (2004) Commodity Types and
the flow computer now optionally allows you to use it when using any of the API 11.1

240
Configuration

(1980 edition) tables if you have selected the “Use API 11.1(2004) 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 20.74.10 and up)
This entry applies only when measuring Water.

Check this box to have the flow computer correct the calculated water density for the
presence 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.

NGL K0 Coefficient (available with firmware 20.74.14 and up)


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 up)


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 up)


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.

241
OmniCom Help

Setup (Firmware Version 22)

The Product Setup for Liquid Applications is for entering meter factors for each flowmeter and
information 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).

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 flowing density using the reference density derived from the
override API. When using a densitometer or gravitometer with API 11.1 (2004)
Commodity Types measurement selections, see the 'Calculate Reference API/SG' help
topic below.

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).

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 flowing density using the reference density derived from the
override SG. When using a densitometer or gravitometer with API 11.1 (2004)
Commodity Types measurement selections, see the 'Calculate Reference API/SG' help
topic below.

API 11.1 (2004) F factor in Pressure Correction Calculation (available with firmware
22.74.06 and up)
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(2004) 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 up)

242
Configuration

This setting applies only when selecting one of the API 11.1 (2004) Commodity Types
standards and if you would like the flow computer to calculate the reference density
using the transducer density.

Note: A negative override value for the API@60 or SG@60 when using API 11.1
(2004) 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 (2004) 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 reference 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.

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 flowing 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 override by selecting 'On transmitter fail use product override' in the
'Process Input' configuration tab.

Alpha Coefficient
API algorithms Table 24C, Table 6C, and 11.1 Special Applications Commodity Group,
require a value for 'Alpha-T'. to be entered. This Alpha-T value is used to calculate
the volume correction factor 'VCF', also known as Ctl.

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(2004) F Factor in
Pressure Correction Calculation box is checked, the F factor entry is disabled as it is
not used.

Vapor Pressure

243
OmniCom Help

The GPA TP16 and API 11.2.4 23E/24E(GPA TP27) standards specify that the
equilibrium pressure of the flowing fluid be calculated according to API 11.2.5(GPA
TP15 extended). Two API 11.2.5 equations are available:
The first, designed primarily for pure products such as propanes, butanes and
natural gasolines, requires no input data other than the temperature at flowing
conditions and the specific gravity at reference.
The second improved correlation, is suitable for use with more varied NGL
mixtures, where different product mixes could have the same specific gravity
but different equilibrium pressures.
If you wish to use the improved second method, enter the vapor pressure in the
appropriate absolute pressure units of measure at 100 deg.F.
Enter a minus number to use the normal API 11.2.5 method for propanes,
butanes and natural gasolines.

Use Separate CTL and CPL (available with firmware 22.74.06 and up)
This field is provided when one of the API MPMS Chapter 11.1 (2004) 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.
If the box is checked, the individual CTL and CPL are multiplied together to
calculate the corrected volume.

Base Pressure (Pe) (available with firmware 22.74.30 and up)


The use of Base Pressure (Pe) at a value other than 0 was introduced by API in the
Spring 2007 Addendum to the API MPMS 11.1 (2004) standard.

Enter this value in gauge units, not absolute units. Default value is 0.00.

In the Spring 2007 Addendum to API MPMS 11.1 (2004), 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 (2004) 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(2004) 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.

Apply Hydrometer Correction (available with firmware 22.75.00 and up)


Do not check the 'Apply Hydrometer Correction' if you have a live density input from an
online densitometer. The default is not to apply hydrometer correction (unchecked).

The 'Apply Hydrometer Correction' should only be checked if you have configured a
virtual densitometer 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 60F using Table 5A or 5B and the entered observed
temperature.

244
Configuration

245
OmniCom Help

Setup (Firmware Versions 24 and 25)

The Product Setup for Liquid Applications is for entering meter factors for each flowmeter and
information 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 flowing density using the reference density override. When using a
densitometer or gravitometer with API 11.1 (2004) Commodity Types measurement
selections, see the 'Use Observed Density (Calculate Reference Density)' help topic
below.

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.

API 11.1 (2004) F factor in Pressure Correction Calculation (available with firmware
24.74.18 and up)
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(2004) 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.

Use Observed Density (Calculate Reference Density)


This setting applies only when selecting one of the API 11.1 (2004) Commodity Types
standards and if you would like the flow computer to calculate the reference density
using the transducer 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 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 flowing 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.

246
Configuration

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 flowing
density.

USING A DENSITOMETER FOR THIS PRODUCT


Checking this box causes the flow computer to use the signal from the densitometer
and correct it to reference temperature and pressure if required (this may be flowing 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' configuration tab.

Alpha Coefficient
API algorithms Table 54C, and 11.1 Special Applications Commodity Group, require a
value for 'Alpha-T'. to be entered. This Alpha-T value is used to calculate the volume
correction factor 'VCF', also known as Ctl.

F Factor Override
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(2004) F Factor in Pressure Correction
Calculation box is checked, the F factor entry is disabled as it is not used.

Vapor Pressure at 37.8 deg.C.


The GPA TP16M and API 11.2.4,53E/54E(GPA TP27M) standards specify that the
equilibrium pressure of the flowing fluid be calculated according to API 11.2.5(GPA
TP15M extended). Two API 11.2.5 equations are available:
The first, designed primarily for pure products such as propanes, butanes and
natural gasolines, requires no input data other than the temperature at flowing
conditions and the specific gravity at reference.
The second improved correlation, is suitable for use with more varied NGL
mixtures, where different product mixes could have the same specific gravity
but different equilibrium pressures.
If you wish to use the improved second method, enter the vapor pressure in the
appropriate absolute pressure units of measure at 37.8 deg.C.
Enter a minus number to use the normal API 11.2.5 method for propanes,
butanes and natural gasolines.

NGL K0 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 coefficients K0 and K1.

Enter the experimentally determined coefficient K0.

247
OmniCom Help

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 coefficients 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 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.

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.

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 24.74.18 and up)
The separate use of CTL and CPL instead of always having to use CTPL was
introduced by API in the Spring 2007 Addendum to the API MPMS 11.1 (2004)
standard.

This field is provided when one of the API 11.1 (2004) 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.
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 up)


The use of Base Pressure (Pe) at a value other than 0 was introduced by API in the
Spring 2007 Addendum to the API MPMS 11.1 (2004) standard.

Enter this value in gauge units, not absolute units. Default value is 0.00.

In the Spring 2007 Addendum to API MPMS 11.1 (2004), 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 (2004) Commodity Types and
the flow computer now optionally allows you to use it when using any of the API 11.1

248
Configuration

(1980 edition) tables if you have selected the 'Use API 11.1(2004) 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 up)
This entry applies only when measuring Water.

Check this box to have the flow computer correct the calculated water density for the
presence 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 (available with firmware 24.74.17 and up)


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 corrected 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 absolute units that the override reference density was corrected to for
documentation purposes.

NIST14 Analysis Basis (available with firmware 24.74.17 and up)


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.

249
OmniCom Help

Setup (Firmware Version 26)

The Product Setup for Liquid Applications is for entering meter factors for each flowmeter and
information 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 flowing density using the reference density override. When using a
densitometer or gravitometer with API 11.1 (2004) Commodity Types measurement
selections, see the 'Use Observed Density (Calculate Reference Density)' help topic
below.

Reference Temperature
Net corrected volumes represent equivalent volumes of liquid at this base or 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.

API 11.1 (2004) 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(2004) 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.

Use Observed Density (Calculate Reference Density) (available with firmware


26.74.10 and up)
This setting applies only when selecting one of the API 11.1 (2004) Commodity Types
standards and if you would like the flow computer to calculate the reference density
using the transducer 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 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 flowing density.

250
Configuration

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 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 flowing 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 override 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'. to be entered. This Alpha-T value is used to calculate the volume
correction factor 'VCF', also known as Ctl.

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.
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(2004) F Factor in Pressure Correction
Calculation box is checked, the F factor entry is disabled as it is not used.

Vapor Pressure at 37.8 deg.C.


The GPA TP16M and API 11.2.4 53E/54E(GPA TP27M) standards specify that the
equilibrium pressure of the flowing fluid be calculated according to API 11.2.5(GPA
TP15M extended). Two API 11.2.5 equations are available:
The first, designed primarily for pure products such as propanes, butanes and
natural gasolines, requires no input data other than the temperature at flowing
conditions and the specific gravity at reference.
The second improved correlation, is suitable for use with more varied NGL
mixtures, where different product mixes could have the same specific gravity
but different equilibrium pressures.
If you wish to use the improved second method, enter the vapor pressure in the
appropriate absolute pressure units of measure at 37.8 deg.C.
Enter a minus number to use the normal API 11.2.5 method for propanes,
butanes and natural gasolines.

Use Separate CTL and CPL (available with firmware 26.74.10 and up)
This field is provided when one of the API 11.1 (2004) Commodity Group tables is
selected:

251
OmniCom Help

If the box is not checked, the combined CTPL factor calculated by API 11.1 is
used to calculate the corrected volume.
If the box is checked, the individual CTL and CPL are multiplied together to
calculate the corrected volume.

Base Pressure (Pe) (available with firmware 26.74.10 and up)


The use of Base Pressure (Pe) at a value other than 0 was introduced by API in the
Spring 2007 Addendum to the API MPMS 11.1 (2004) standard.

Enter this value in gauge units, not absolute units. Default value is 0.00.

In the Spring 2007 Addendum to API MPMS 11.1 (2004), 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 (2004) 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(2004) 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.

252
Configuration

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
determined.

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 flowrate.

Flowrates
Enter the flowrate that existed when the meter factor was determined. Up to twelve
meter factor / flowrates can be entered per meter per
product.
Data sets must be entered lowest flowrate first working up to maximum rate last.

253
OmniCom Help

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 configuration.
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

254
Configuration

Fluid Setup

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.
Choices are:

Natural Gas Using AGA 8 1994,1992 and 1985 Equation of State *


Natural Gas Using SGerg 88 methods. (Metric Revisions Only)
Steam (ASME) Using ASME Equation of State
Steam (NIST) Using NIST Equation of State **
Water (K&K) Based on the publication containing the density equations by
Joseph H. Keenan, Frederick G. Keyes, et al., 'Steam Tables:
Thermodynamic Properties of Water Including Vapor, Liquid
and Solid Phases (John Wiley & Sons, 1969)', page 134."
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
NIST14 Using NIST 14 Equations to calculate density, heating value,
Cp, Cp/Cv, sound velocity, Joules Thompson coefficient and
viscosity. (Available with firmware versions 23.74.19 and up
and 27.74.18 and up)
Krohne (Only for application 27)
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.

GC Stream (available for firmware versions 23.74.30 and 27.74.30 and up)
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.

Note: For firmware versions below 23.74.30 and 27.74.30, the GC Stream selection is
located in the Meter Setup screen.

255
OmniCom Help

Fluid Properties
Viscosity: There are two selections: 'Use Override' or 'Calculate Viscosity'.
Use Override: enter the absolute viscosity of the gas or liquid at flowing
conditions.
For application 23, enter the viscosity in centipoise units. For Natural
Gas, viscosity limits are 0.005 to 0.1 cP and a reasonable default
value is 0.012 cP.
For application 27, enter the viscosity in pascal seconds. For
Natural Gas, viscosity limits are 0.000005 to 0.0001 Pa.s. and a
reasonable default value is 0.000012 Pa.s.
For Omni firmware versions 23.74.30 and 27.74.30 and below, when
using NIST 1048 products, you may enter -999 to have the flow
computer calculate the viscosity using the equation of state. Note:
This entry is needed for differential head devices only.
For firmware versions 23.75.00 and 27.75.00 and up, a 'Calculate
Viscosity' option is provided and must be used. Negative values
for override are not allowed.
Calculate Viscosity: enabled for applications 23.75.00 and 27.75.00 and
up for Natural Gas with a detailed analysis density method selected (AGA-
8 1994, AGA-8 1992, and AGA-8 1985), for Natural Gas with AGA NX-19
MOD density method (application 27.75.00 and up only) selected, and for
Steam (ASME and NIST), NIST 1048, Ethylene IUPAC, and NIST14 fluid
types. Note: The use of -999 or any negative number to trigger a viscosity
calculation is no longer allowed for 23.75.00 and 27.75.00 and up.

o The viscosity calculation for Natural Gas with a detailed analysis uses
the following methods:
GasVLe, Kay (Ind.Eng.Chem., 1936), Stiel and Thodos (AIChE J., 1961),
Herning and Zipperer (Gas-Wasserfach, 1936), and Jossi, Stiel, and
Thodos (AIChE J., 1962).

o The dynamic viscosity calculation for Natural Gas with the AGA NX-
19 MOD Density Method (available with application 27.75.00 and
up) selected is as follows:

viscosity = n * sqrt(Tf/Tb) * [(1 + 164/Tb) / (1 + (164/Tf))] * (0.99625


+ 0.003753 * Pf)
where n is the reference viscosity (at Tb) in Pa.s, Tf and Tb in
Kelvin, Pf is in bar absolute, and the viscosity is in Pa.s

The reference viscosity is entered in exponential notation. The default


value is 1.099E-5 Pa.s for a Tb of 20 degC.

The above equation is believed by OMNI to be acceptable to the Russian


GOST organization. OMNI has no additional information as to its
technical origin or applicability.

For this equation, the flowing temperature can range from -20C to 60C
and the flowing pressure can range from 0 to 56 bar. The viscosity
constant must be a positive number. If an input is out of this range, the
viscosity is still calculated however a calculation out of range alarm is
raised.

Related Modbus registers are as follows:


7n39 = Viscosity in Use (where n=1-4 for M1-M4)

256
Configuration

Isentropic Exponent: There are two selections: 'Use Override' or 'Calculate


Isentropic Exponent'.
Use Override: enter the Isentropic Exponent dimensionless factor for
this product. For Natural Gas, Isentropic Exponent limits are 1.0 to 3.0
and a reasonable default value is 1.35.
For Omni firmware versions 23.74.30 and 27.74.30 and below:
For Natural Gas products when an AGA-8 1994 Density Method
is used and AGA-10 is enabled, enter a negative Isentropic
Exponent value if you want the flow computer to have AGA-
10 calculate and use the calculated Isentropic Exponent.
For NIST 1048 fluids, enter -999 to have the flow computer
calculate the Isentropic Exponent for you using the equation
of state. Note: This entry is needed for differential head
devices only.
For firmware versions 23.75.00 and 27.75.00 and up, a 'Calculate
Isentropic Exponent' option is provided and must be used. Negative
values for override are not allowed.
Calculate Isentropic Exponent: enabled for applications 23.75.00 and
27.75.00 and up for Natural Gas with the AGA-8 1994 detailed analysis
density method selected and AGA-10 enabled, for Natural Gas with AGA
NX-19 MOD density method (application 27.75.00 and up only) selected,
and for NIST 1048 and Ethylene IUPAC fluid types. Note: The use of -999
or any negative number to trigger an isentropic exponent calculation is no
longer allowed for 23.75.00 and 27.75.00 and up.

The Isentropic Exponent calculation below is for Natural Gas when the AGA
NX-19 MOD Density Method (available with application 27.75.00 and up) is
selected:

isentropic exponent = 1.29 + 7.18E-7 * (2575 + (346.23 - Tf)**2) * Pf


where Tf is in Kelvin and Pf is in bar absolute

The above equation is believed by OMNI to be acceptable to the Russian


GOST organization. OMNI has no additional information as to its technical
origin or applicability.

For this equation, the flowing temperature can range from -20C to 60C and
the flowing pressure can range from 0 to 56 bar. If an input is out of this
range, the isentropic exponent is still calculated however a calculation out of
range alarm is raised.

Related Modbus registers are as follows:


18n28 = AGA-10 Calculated Isentropic Exponent (where n=5-8 for M1-M4)
7n40 = Isentropic Exponent In Use (where n=1-4 for M1-M4)

Specific Gravity: Enter a minus number to instruct the flow computer to


calculate 'density at reference conditions' using the AGA-8 equation of state,
detailed methods only. Net volumes are calculated by dividing mass flow by
'density at reference conditions'.
Otherwise enter a positive override value of specific gravity at reference
conditions that will be used together with the 'density of air' entry to
calculate 'density at reference conditions'.
On product #1 only, this value is overwritten if SG is to be obtained from
a frequency input from a Solartron 3096/3098 gravitometer or from a
4-20ma SG input.

257
OmniCom Help

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' menu.

Water Content: Enter the amount of water that the gas contains in lbs/mmcf of
gas. It is used to calculated the correction factor FWV. Due to the resolution of
FWV X.XXXX water contents of 7lb/mmcf and less produce FWV factors of
1.0000. Factor FWV corrects the net volume and therefore energy for water
content. Enter zero if a GC is providing water content in the compositional
analysis.

Heating Value: Enter a minus override value if you wish to use the calculated
heating value to calculate energy totals. Heating value for natural gas is
calculated using AGA 5-96, GPA 2172-96 or ISO 6976-95. NIST algorithms
are used for Steam and other gases.
Value: 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 if
available will always be used unless it is assigned the component number
'0' in the 'Analysis Setup' menu. Energy can also be calculated using the
live 4-20mA value obtained from a BTU analyzer. In this case the analyzer
value overwrites this entry in the #1 product area only.
Method: Select either the AGA 5-96, GPA 2172-96 or ISO 6976-95
equation to calculate the heating value of the gas. The energy flow of the
gas may or MAY NOT be calculated using this method depending upon
the manual override value for HV entered below. (Note: If ISO 6976-95 is
selected, the calculations are made based on 15C unless you have Omni
firmware v27.74.19 and up and then the calculations can be based on one
of the following 0C, 15C, or 20C.)
neo-Pentane component - if GPA 2172-96 or an ISO 6976-95 heating
value method is selected, the user may select whether to disregard the
neo-Pentane component (GPA 2172-96), use the neo-Pentane
component (ISO 6976-95 methods) add the neo-Pentane component to
the iso-Pentane component (available with firmware versions 23.74.20
and 27.74.20 and up), or add the neo-Pentane component to the n-
Pentane component (available with firmware versions 23.74.30 and
27.74.20 and up) before it is used in the HV calculation.

Base Conditions (available with firmware v27.74.19 and up - moved from the
Factors and Systems Constants screen):
Base Temperature: Enter the contract base temperature in degrees C.
If an ISO 6976 selection is made for Heating Value Method, the base
temperature value is automatically set to the metering reference
temperature.
Base Pressure: Enter the contract base pressure in absolute units.

AGA-10 Calculation - if the AGA-8 1994 Detailed Analysis density method is


selected, the user may enable the AGA-10 calculation by checking the box.
(Available with firmware versions 23.74.11 and 27.74.11 and up.)

AGA-8 Density Calculation -neo-Pentane Component - if any of the AGA-8


Detailed density methods are selected, the user may select whether to
disregard the neo-Pentane component, add the neo-Pentane component to
the iso-Pentane component (available with firmware versions 23.74.20 and
27.74.20 and up), or add the neo-Pentane component to the n-Pentane

258
Configuration

component (available with firmware versions 23.74.30 and 27.74.20 and up)
before feeding into the density calculation.

ISO 6976 Reference Density Calculation - if any of the AGA-8 Detailed density
methods are selected, the user may check the box so that the Omni uses ISO
6976 to calculate the reference density. If the box is checked, the user also
selects a reference temperature from the list. Note: If the user has selected an
ISO 6976 Heating Value Method and the temperature selected there does not
match the temperature selected for reference density, a warning message is
displayed. (Available with firmware versions 27.74.20 and up.)

Redlich-Kwong: Enter the inputs to the Redlich-Kwong equation of state.

 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 application
firmware 23.74.30 and 27.74.21 and up. (Please see the help for
Density Method for more information.) If the Soave-Redlich-Kwong
method is selected, the user is asked for an Accentric Factor. The
default is zero.

Ideal Gas Calculation Override Z: Enter the value used for Z in the following
ideal gas equation:
Density = Pf/Pb * Tb/Tf * 1/Z * Density @ Ref. Condition.
Density @ Ref. Condition = SG * Density of Air.

NIST14 Analysis Basis: 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.

NIST14 Density Calculation -Add neo-Pentane to iso-Pentane - the user may


select whether to disregard the neo-Pentane component, add the neo-Pentane
component to the iso-Pentane component (available with firmware versions
23.74.20 and 27.74.20 and up), or add the neo-Pentane component to the n-
Pentane component (available with firmware versions 23.74.30 and 27.74.20
and up) before it is used in the density calculation.

Density Method
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.

Redlich-Kwong Method: 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 each component.
The Redlich-Kwong equation is adequate for calculation of gas phase

259
OmniCom Help

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 application firmware


v27.74.21+ . 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 temperature. The inclusion of the
accentric factor accounts for some of the molecular complexity including shape
and polarity influences. The accentric factor, w (Omega), is defined as:
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 versions23.74.19 and 27.74.18


and up.) The equation used is:
Density = Pf/Pb * Tb/Tf * 1/Z * Density @ Ref. Condition.
Density @ Ref. Condition = SG * 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
pressure 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


up.) 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 selected.

SGERG Methods: The SGERG-88 method is 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:

CO2 Mole Fraction 0.0 to 0.3


H2 Hydrogen Mole Fraction 0.0 to 0.1
N2 Nitrogen Mole Fraction 0.0 to 0.5
*HS Calorific Value in MJ/m3 20.0 to 48.0
*Relative Density 0.55 to 0.9

*Note: Metering at T = 0.0 C, P = 1.01325 bar, combustion at T = 25.0 C.

260
Configuration

Further input parameters are:

Pressure in bar 0.0 to 120.0


T in degrees C -23.0 to 65.0 (changed from initial 1988 range of -23.0 to 61.85)

261
OmniCom Help

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
variables. 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 -
Solartron.

Setup
Override Code: This entry determines the strategy to be used regarding the
'Live Input Override 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 scaling. 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 scaling. 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 live input value drops below this value.

High: The low alarm activates when the live input value rises above this value.

262
Configuration

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
calculate the flowing density and heating value if the application does not have a gas
chromatograph (GC) or the GC fails.

Note: The component for neo-Pentane was added with firmware versions 23.74.20
and 27.74.20 and up. See the help for Fluid Setup for more information on how this
component is used.

263
OmniCom Help

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 up.)

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 up. See the help for Fluid Setup for more information on how this
component is used.

264
Configuration

Gas Chromatograph
Gas Chromatograph

The Gas Chromatograph subcategory is for entering and selecting GC settings. This function is
available 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.
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

265
OmniCom Help

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 Applied Automation or Daniel
Danalyzer gas chromatograph. 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 Applied Automation or a Daniel Danalyzer chromatograph.
In both cases the flow computer uses the Serial Port 3 for GC
communications.
 When talking to an Applied the flow computer uses the AA proprietary
HCI-A protocol interface. 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 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 up) or
minutes (for v73 and below) that the flow computer should wait for results from
either type of gas chromatograph. When operating with an Applied Automation
analyzer the flow computer will request results from the chromatograph if it not
in the 'listen only' mode. The 'GC Alarm' bit will be set if no results are received
after this request.

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.

Mode
Listen Only: In many cases more than one flow computer will be connected to a
single gas analyzer. 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

266
Configuration

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.

267
OmniCom Help

Gas Chromatograph Components

The items listed below are links to descriptions of each setting option within the GC Components
dialog. 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-Butane 7004
neo-Pentane 7005 (add this component in the GC to i-Pentane
component before it is read by the Omni. Neo-Pentane
does not exist in AGA 8 or AGA 5)
i-Pentane 7006
n-Pentane 7007
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
configuring components for a Danalyzer GC and selects another component as 1,
OmniCom disables the C6+ distribution.

Note:The above component order is used only as an example, consult your GC


documentation 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 up. See the help for Fluid Setup for more information on how this
component is used.

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.

268
Configuration

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
configuring components for a Danalyzer GC and selects another component as 1,
OmniCom disables the C6+ distribution.

269
OmniCom Help

PID Control
PID Control

Setup the parameters for each of the four PID control loops. Each control loop can provide
proportional plus integral control of a primary variable (flowrate for example) and also allow
override control
of a secondary variable (pressure for example).These dialogs 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

270
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 CV100.

Primary Control Variable


Variable Assignment: Enter the four digit number which specifies what data
base variable will be the primary controlled variable. For Meter Run 'n'
Variables: (Replace 'n' with meter run number). For a list of variable
assignments reference Volume 4 of the Omni Manual.

Remark: Use this 16 character field to document the function of each variable
assignment. The data field is stored in the flow computer ensuring that the
documentation always matches the computer.

Zero Scale: This entry is ALWAYS required even if you do not intend to use a
remote setpoint input for the PID controller. The PID algorithm uses this value
to determine the zero value for the primary controlled variable. Enter the
minimum scale value in engineering units of the primary variable.

Full Scale: This entry is ALWAYS required even if you do not intend to use a
remote setpoint input for the PID controller. The PID algorithm uses this value
to determine the maximum value for the primary controlled variable. Enter the
max scale value in engineering units of the primary variable.

Secondary Control Variable


Variable Assignment: Enter the four digit number which specifies what data
base variable will be the secondary controlled variable. For Meter Run 'n'
Variables: (Replace 'n' with meter run number). For a list of variable
assignments reference Volume 4 of the Omni Manual.

Remark: Use this 16 character field to document the function of each variable
assignment. The data field is stored in the flow computer ensuring that the
documentation always matches the computer.

Zero Scale: This entry is ALWAYS required even if you do not intend to use a
remote setpoint input for the PID controller. The PID algorithm uses this value

271
OmniCom Help

to determine the zero value for the primary controlled variable. Enter the
minimum scale value in engineering units of the primary variable.

Full Scale: This entry is ALWAYS required even if you do not intend to use a
remote setpoint input for the PID controller. The PID algorithm uses this value
to determine the maximum value for the primary controlled variable. Enter the
max scale value in engineering units of the primary 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 (see Operators Manual chapter 4) or it can be input remotely via an
analog input. Enter the number of the input channel that you wish to use for
the 'remote setpoint'. Enter '0' 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 (engineering 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.

272
Configuration

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
manipulate 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' function. 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 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

273
OmniCom Help

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 delivery 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 output 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' function. 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).

274
Configuration

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 Value


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 output 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 controller. Integral action gradually integrates the error
between the measurement and the setpoint, 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
typical applications.

Secondary Control Value


Action: Select 'forward' action if the secondary variable value increases as the
controller output increases. Select 'reverse' action if the secondary variable
value decreases as the controller 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 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

275
OmniCom Help

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
This 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
This entry is used to determine when the secondary variable will be controlled. This
entry must be set to High Error Select in applications using only one control variable
due to the fact that an unconfigured control variable always has a zero error.

Determine which of the two modes below you will be using for your particular
application in order to configure the flow computer to control the PID loop correctly:

Mode 1 - Control Primary Variable unless Secondary Variable exceeds Setpoint:


Are both Primary and Secondary actions Forward?
If Yes, use Low Error Select
If No, Is Secondary Action Forward?
If Yes, use Low Error Select
If No, use High Error Select

Mode 2 - Control Primary Variable unless Secondary Variable falls below


Setpoint:
Are both Primary and Secondary actions Forward?
If Yes, use High Error Select
If No, Is Secondary Action Forward?
If Yes, use High Error Select
If No, use Low Error Select

276
Configuration

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
dialog. Click on a setting for more information.

Assign
Enter a 4 digit number which specifies which data base variable will be sent to this
front panel counter.
Valid Assignments Are (substitute the meter # for 'n'):

Meter Run Station


1n01 = Gross Flow 1801 = Positive Gross Flow 1805 = Negative Gross Flow
1n02 = Net Flow 1802 = Positive Net Flow 1806 = Negative Net Flow
1n03 = *Mass Flow 1803 = *Positive Mass Flow 1807 = *Negative Mass Flow
1n04 = *Energy Flow 1804 = *Positive Energy 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 'Programmable
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
Enter the number of pulses per unit volume, mass or energy unit.

The unit is the 'displayed' unit ie: Ton, Barrel, KLb, MMBTU, GJOULE

Examples:

You wish to count 100 Lb increments and the displayed units are Tons (2000 lbs
per Ton). Pulses/unit needed = 2000/100 = 20.0 counts per Ton.

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.

277
OmniCom Help

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

278
Configuration

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
description 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 displays 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

Gross A Net B Mass C 7 Energy D SG/API E 9 Control F /


& % 8
Temp G # Press H $ Density I DP J 5 Orifice K 6 Meter L *
4
Time M : Counts N Factor 0 Preset P Batch Q 3 Analysis R =
" 1 2
Print S ; Prove T Status U Alarms V Product W _ Setup X +
, 0 .
Input Y ( Output Z
)

NOTE: User key press sequences take priority over any existing resident key press
sequences.

Variable
Tag: Enter an 8 character field which will be used to describe or identify the
display variable. 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 display 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
variable ( 0 to 7 max).

279
OmniCom Help

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 XX is the application (20, 23...), 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 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.

280
Configuration

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.

281
OmniCom Help

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 64 boolean points
numbered 1025 through 1088 which can provide simple logic control of valves etc. Each of these
points is controlled by a simple logic statement which is evaluated every 100ms starting at point
number 1025 proceeding to 1088. 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".

Valid boolean operators are:

NOT '/'
AND '&'
OR '+'
EXOR '*'
EQUAL '='
GOTO 'G'
IF ')'
MOVE ':'
RANGE
TIMER ','
FUNCTION
RISING '('
EDGE
FALLING '(/'
EDGE
ONE SHOT '@'

The result of the evaluation (true or false) 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.

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).

282
Configuration

1030: 1736=/1105 (Turns off Meter 1 totalizing if frequency is below the Active
Frequency setting. 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 previous 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.

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 100 to avoid system crashes which could occur with unexpected
program loops.

Example: 31: 1719=1026 G1040 (Same as the above example except that statement
1040 will be the next statement processed)

IF ')' Operator

283
OmniCom Help

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


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 output 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 number 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

284
Configuration

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 symbol 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)
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 positive 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

285
OmniCom Help

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 flowrate [7801 reverses ie: goes] negative,
trigger a snapshot 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).

Example 1:
3501=1501:1530 (packs 30 bits into 16-bit integer registers 3501 and 3502 with
3501 containing 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 statements. 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 Volume 4 of the Omni User Manual

286
Configuration

Variable Statements

There are 64 programmable analog variable points which can be used to provide customized
data variables. These 64 analog variables are assigned the points numbers 7025 through 7088.
They may be displayed, printed or sent to an analog output. Typical use would be to convert an
existing 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 constants separated by valid operators.

Valid math operators are:

'+' Add the following variable/constant


'-' 'Subtract the following
variable/constant
'*' Multiply the following
variables/constant
'/' Divide by the following
variable/constant
'$' Use absolute value of following
variable
'#' Number following is a constant
'&' Raise to the power of following
var/const

Other miscellaneous operators are:

'=' 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,
evaluate the rest of the statement.
MOVE RANGE ':' Always used with the EQUAL '=' operator. Copy the range of
points to the right of the '=' into a range of points starting at the
point to the left of the '=' operator. Cast type if needed.
EXACT COMPARE '%' Compare the value left of the '%' with the value to the right of the
'%'. The statement result is +1 if exactly equal and -1 if not
exactly equal.
INDIRECT REFERENCE Use the contents of the point following ';' (*See note below) to
';' determine the address of the target data base point.
WRITE ASCII STRING '"' Write the ASCII string data between quotes to the address to the
left of the '=' sign.
TOTALIZE ',' Used to create custom totalizers where remainders need to be
carried into the custom totalizer in the next calculation cycle.
RISING EDGE '(' Triggers for 500ms on a rising edge. (Available with 20.73.20,
23.74.10, 24.74.10, and 27.74.10)
FALLING EDGE '(/' Triggers for 500ms on a falling edge. (Available with 20.73.20,
23.74.10, 24.74.10, and 27.74.10)

287
OmniCom Help

ONE SHOT '@' Triggers for 500ms on either edge (rising or falling). (Available with
20.73.20, 23.74.10, 24.74.10, and 27.74.10)
RANGE CHECKING '<' The variable statement result will be a value of 1 if the value of the
variable 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 is:

ABSOLUTE '$'
POWER '&'
MULTIPLY '*' and
DIVIDE '/'
ADD '+' and
SUBTRACT '-'

In cases where operators have equal precedence they are executed in order left to right.

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 flowrate or temperature variable has
a logical value of 'true or false' depending upon whether it is positive or negative (Note: 0.0 is
considered 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
variable.
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 flowrate).
7027: 7101-#1000 (Gross flowrate meter 1, contained in 7101, minus a constant value
of
1000)

288
Configuration

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 100 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 flowrate by multiplying the hourly flowrate 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 deg.C by subtracting 32 from the deg.F variable
(7105) and dividing the result (7050) by 1.8. The program statements look like:
7050: 7105-#32
7051: 7050/#1.8

Example 6: (MOVE and MULTIPLY Operators): Use program variable (7030) to provide an
additional 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 statement 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
characters.
7025: 4501="ABCDEFGHI"
*See note at top of page on the INDIRECT ‘;’ and the WRITE ASCII STRING ‘"’ operators.

289
OmniCom Help

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.

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
position 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
resolution 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
resolution 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).
During 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)

290
Configuration

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 (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:
┌──────────────────┐
│User Variable #7025 │ (Statement number)
│Value 0 │ (Cursor on this line and enter data)
│Pressure Limit ? │ (Message prompt)
└──────────────────┘

Special Modbus functions (currently only in versions 20.71 and up)


Modbus communications function code 6 in the Omni has been modified to allow additional
functionality. 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 supported 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 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.

291
OmniCom Help

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-bit ASCII string to be transferred to 2 long integers at 5501 and 5502:
7030: 5501=4849
If 4849 contains a value of 20.74.00
Then 5501 will contain a value of 842018359
And 5502 will contain a value of 875442224

Example 2: allows an 8-bit ASCII string to be transferred to 4 short integers at 3501, 3502, 3503,
and 3504:
7031: 3501=4849
If 4849 contains a value of 20.74.00
Then 3501 will contain a value of 12848
And 3502 will contain a value of 11831
And 3503 will contain a value of 13358
And 3504 will contain a value of 12336

Example 3: allows 2 long integers to be transferred to an 8-bit ASCII string:


7032: 4501=5501

292
Configuration

Custom Packets
Custom Packets

The custom Modbus data packets are provided to reduce the number of polls needed to read
multiple 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.

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 packets because Modicon Compatibility allows you access to the
entire configured packet by utilizing multiple 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 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.

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
Modbus port without being polled.

The following boolean points are used to trigger the transmissions.

2701 Custom Packet #1 Transmitted via Serial Port #1

293
OmniCom Help

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 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 extension.

294
Configuration

Modbus Packet 001

Packet #1 - Address 001 contains up to 20 groups of data.

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
"Custom Data Packet" data type to see how your custom packets data will look translated into the
configured format. If using a Modicon connection, Modbus Tester also shows the corresponding
addresses used for each packet.

Modbus Packet Entries Description Number of Points

1) Index # 7101 Meter 1 Flowrates, temps & pressures 6


2) Index # 7201 Meter 2 Flowrates, temps & pressures 6
3) Index # 4111 Meter 1 Serial number etc. 4
4) Index # 4211 Meter 2 Serial number etc. 4
5) Index # 5101 Meter 1 Batch in Progress Totals 4
6) Index # 5201 Meter 2 Batch in Progress Totals 4

295
OmniCom Help

7) Index # 1105 Meter 1 Status bits 48


8) Index # 1205 Meter 2 Status bits 48
9) Index # 14275 Programmable Variables 87 and 88 Remarks 2

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 Flowrate
3 2 Meter 1 Net Flowrate
5 4 Meter 1 Mass Flowrate
7 6 Meter 1 Energy Flowrate
9 8 Meter 1 Temperature
11 10 Meter 1 Pressure
13 12 Meter 2 Gross Flowrate
15 14 Meter 2 Net Flowrate
17 16 Meter 2 Mass Flowrate
19 18 Meter 2 Energy Flowrate
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
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

296
Configuration

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.

Address Offset Point Offset Variable Description


73 0 0 Meter 1 Active Flag through Meter 1 Flowrate Low Low
Alarm
74 1 16 Meter 1 Flowrate Low Alarm through Meter 1 Density
Temperature Trans Fail Low
75 2 32 Meter 1 Density Temperature Low Alarm through Meter 1
DP High Range is Selected
76 3 48 Meter 2 Active Flag through Meter 2 Flowrate Low Low
Alarm
77 4 64 Meter 2 Flowrate Low Alarm through Meter 2 Density
Temperature Transducer Fail Low
78 5 80 Meter 2 Density Temperature Low Alarm through Meter 2
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


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 written as a set.

Note 3) Floats are two word variables which cannot be split and must be read and written
as a set.

297
OmniCom Help

Note 4) 8-byte strings are four word variables which cannot be split and must be read
and written 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 5) 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 problems. 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 6) 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.

298
Configuration

Modbus Packet 201

Packet #2 - Address 201 contains up to 8 groups of data.

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
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
"Custom Data Packet" data type to see how your custom packets data will look translated into the
configured format. If using a Modicon connection, Modbus Tester also shows the corresponding
addresses used for each packet.

Modbus Packet Entries Description Number of Points

1) Index # 7101 Meter 1 Flowrates, temps & pressures 6


2) Index # 4111 Meter 1 Serial number etc. 4
3) Index # 5101 Meter 1 Batch in Progress Totals 4
4) Index # 1105 Meter 1 Status bits 48
5) Index # 14275 Programmable Variables 87 and 88 Remarks 2

299
OmniCom Help

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 Flowrate
203 2 Meter 1 Net Flowrate
205 4 Meter 1 Mass Flowrate
207 6 Meter 1 Energy Flowrate
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

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.

300
Configuration

Address Offset Point Offset Variable Description


237 0 0 Meter 1 Active Flag through Meter 1 Flowrate Low Low
Alarm
238 1 16 Meter 1 Flowrate Low Alarm through Meter 1 Density
Temperature Trans Fail Low
239 2 32 Meter 1 Density Temperature Low Alarm through Meter 1
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 written 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 written 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 5) 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 problems. 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 6) 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.

301
OmniCom Help

Modbus Packet 401

Packet #3 - Address 401 contains up to 20 groups of data.

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
"Custom Data Packet" data type to see how your custom packets data will look translated into the
configured format. If using a Modicon connection, Modbus Tester also shows the corresponding
addresses used for each packet.

Modbus Packet Entries Description Number of Points

1) Index # 7101 Meter 1 Flowrates, temps & pressures 6


2) Index # 7201 Meter 2 Flowrates, temps & pressures 6
3) Index # 4111 Meter 1 Serial number etc. 4
4) Index # 4211 Meter 2 Serial number etc. 4
5) Index # 5101 Meter 1 Batch in Progress Totals 4
6) Index # 5201 Meter 2 Batch in Progress Totals 4

302
Configuration

7) Index # 1105 Meter 1 Status bits 48


8) Index # 1205 Meter 2 Status bits 48
9) Index # 14275 Programmable Variables 87 and 88 Remarks 2

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 Flowrate
403 2 Meter 1 Net Flowrate
405 4 Meter 1 Mass Flowrate
407 6 Meter 1 Energy Flowrate
409 8 Meter 1 Temperature
411 10 Meter 1 Pressure
413 12 Meter 2 Gross Flowrate
415 14 Meter 2 Net Flowrate
417 16 Meter 2 Mass Flowrate
419 18 Meter 2 Energy Flowrate
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
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

303
OmniCom Help

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.

Address Offset Point Offset Variable Description


473 0 0 Meter 1 Active Flag through Meter 1 Flowrate Low Low
Alarm
474 1 16 Meter 1 Flowrate Low Alarm through Meter 1 Density
Temperature Trans Fail Low
475 2 32 Meter 1 Density Temperature Low Alarm through Meter 1 DP
High Range is Selected
476 3 48 Meter 2 Active Flag through Meter 2 Flowrate Low Low
Alarm
477 4 64 Meter 2 Flowrate Low Alarm through Meter 2 Density
Temperature Transducer Fail Low
478 5 80 Meter 2 Density Temperature Low Alarm through Meter 2 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


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 written as a set.

Note 3) Floats are two word variables which cannot be split and must be read and written
as a set.

304
Configuration

Note 4) 8-byte strings are four word variables which cannot be split and must be read
and written 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 5) 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 problems. 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 6) 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.

305
OmniCom Help

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
circular 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 application 23. The Detailed Daily Report is available
but can only be enabled via the front panel in firmware v23.74.10 and up. It can be enabled also
via OmniCom in Archive 701 for firmware v23.74.19 and up. 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.

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 Trigger' 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 archiving takes place on the high level
(not the edge trigger), if you specify non-momentary triggers, the 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.

306
Configuration

Max Records
Enter the maximum number of records that can be stored in this archive file before old
data is overwritten 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.

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 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: "*.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.

307
OmniCom Help

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 available 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.

308
Configuration

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.

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.

309
OmniCom Help

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 specified but the Omni has certain variables shown below that are stored in a
format which is usually more readily accepted by a PLC.

Index# Variable Stored Format


3n40 = Net Flowrate Integer 0-999 = 0-99.9%
3n41 = Net BBL Accumulator Integer 0-65535
3n42 = Gross Flowrate Integer 0-999 = 0-99.9%
3n43 = Gross BBL Accumulator Integer 0-65535
3n44 = Mass Flowrate 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 Flowrate Integer 0-999 = 0-99.9%
3803 = Station BBL Accumulator Integer 0-65535
3804 = Station Gross Flowrate Integer 0-999 = 0-99.9%
3805 = Station Gross BBL Acc. Integer 0-65535
3806 = Station Mass Flowrate 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%

310
Configuration

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 positions will be set to zero in cases where the Omni does not have valid
data.

311
OmniCom Help

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
specified.

Point Count
Enter the number of contiguous points within this group. Contiguous boolean data
must be specified in groups of 16.

312
Configuration

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
setting 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 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 characters 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 2, 0F not F!)
with up to 5 sets of characters.

Printers Condensed Normal Mode


Mode String String
Epson, IBM, 0F 12
Panasonic
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 computers 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).

313
OmniCom Help

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 specific 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 up) .

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


The Daily Report may be disabled by checking this box. This simply blocks the report
from printing. Data will still be sent to the historical buffers (last 8) and archive if
archive is setup.

Detailed Daily Report Active (available with firmware versions 23.74.10 and up)
A Detailed Daily Report is available only in application 23 specifically v23.74.10 and
up:

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 Report Template


There are two types of report templates:

314
Configuration

1) Default Report Templates


There are four default report templates, which are the Snapshot, Batch End,
Daily Report, and Prove Report 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
Templates checkbox or answering 'Y' or 'N' from the front panel of the flow
computer.

2) 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 Templates 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, 25.74.00, 26.74.10, and
27.74.15 and up.)

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 Templates, 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 template .

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 up. There are new sample
custom Batch templates for firmware versions 23.74.30 and 27.74.30 and up.

Print Interval (Snapshot)


Print Interval In Minutes: Enter the number of minutes between each interval
report. Entering 0 will disable interval reports. The maximum allowed is 1440
minutes which will provide one interval report each 24 hour period.

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).

Checked/Proved For String (available with firmware v22.74.00 and v26.74.00 and up)
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).

315
OmniCom Help

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
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 deg F & 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:

316
Configuration

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
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:
_________________

317
OmniCom Help

Batch
Batch

Six batch setups per meter run can be programmed with alphanumeric batch ID tag, product
number 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
automatically 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 mounted 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

318
Configuration

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
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 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.

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.

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 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.

319
OmniCom Help

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)


The long ton and metric ton net weight values appearing on the Batch report can be
calculated one of two ways:

Determine Long Tons then Metric Tons: In this case, the flow computer
converts the NSV at 60F 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: In this case, the flow computer
converts the NSV at 60F to metric tons using lookup table ASTM D1250
(1952) Table 13. Long tons are then calculated using a conversion factor.
Metric Tons = NSV x Table 13 value
Long Tons = Metric Tons * 0.98421

Note: The conversion factors came from ASTM D1250 (1952) Table 1.

320
Configuration

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
completely 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 Template” 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 printed).

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 the next calendar day of the week for this setting.
Example: If you have the flow computer configured 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

321
OmniCom Help

specify 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 specify 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 specifying 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.

Disable Batch Stack Operation (Available with firmware versions 20.74.22, 22.74.06,
24.74.18, and 26.74.10 and up)
By default, a batch stack shift occurs after a batch end that happened as a result
of a scheduled auto-batch end.

If you would like the Omni to begin a new batch which will measure the same
product as the auto-batch that just ended, select the checkbox so that a batch
stack shift operation does not occur.

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
this setting to determine whether it should shift the batch stack or not.

If using Modbus command points to end the batch instead of using the front panel,
the Omni provides separate command registers to shift or not shift the stack:

322
Configuration

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

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.

323
OmniCom Help

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.
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

324
Configuration

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 multiple Omni computers. 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 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 connected 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 up) - 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 computer) 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.

Last Master in Sequence: Enter the highest Modbus ID number of a device on


the communication 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

325
OmniCom Help

failures set this to as low a number as possible. Use 3 for peer to peer links involving
only Omni flow computers. Other Modbus devices may need more time to respond.

326
Configuration

Transaction Group

A Transaction Group is the method in which Omni using the 'peer to peer' configuration allows
multiple Omni flow computers to exchange data. Each Transaction group has a maximum of four
transactions 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.

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 transaction 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.
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

327
OmniCom Help

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 Programmable 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 transferred 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 number within the remote slave.
(Note: when using Modicon protocol you should subtract 1 from the destination
index when the transaction is a 'write'.)

Read/Write
Is this Omni reading or writing data to the slave device?

328
Configuration

Premium Billing
Threshold Settings
Flow which occurs below 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.

Flow occurring between the LEVEL 2 and the LEVEL 3 threshold will accumulate
in the 'LEVEL 2' totalizer.

Flow occurring above the LEVEL 3 threshold will accumulated in the 'LEVEL 3'
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.

Modbus Point #s (All long integers - 'n' = 1,2,3,4 or 8)


6n01 Meter 'n' Base to Premium 1 Threshold (MSCF/Hr)
6n02 Meter 'n' Premium 1 to Premium 2 Threshold (MSCF/Hr)
6n03 Meter 'n' Premium 2 to Premium 3 Threshold (MSCF/Hr)
6n04 Meter 'n' Special Billing Threshold (MSCF/Hr)
6n06 Meter 'n' Base Cumulative MSCF (XXXXXXXX.X typical of all)
6n07 Meter 'n' Premium 1 Cumulative MSCF
6n08 Meter 'n' Premium 2 Cumulative MSCF
6n09 Meter 'n' Premium 3 Cumulative MSCF
6n10 Meter 'n' Special Billing Cumulative MSCF
6n11 - 6n15 Todays Totalizers (Same order as above)
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

329
OmniCom Help

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.

330
Configuration

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.

331
Report Template Editor
Report Template Editor
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 connected 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 up. There are new sample custom Batch
templates for firmware versions 23.74.30 and 27.74.30 and up.

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.

Theformatting 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 Modbus 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 experience 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.

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

332
Report Template Editor

customer. Including or excluding data from a printed report is accomplished by defining


‘Boolean True Blocks’, and ‘Boolean False Blocks’.

Report Formatting Controls


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
templates. 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 liking 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.

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 up. There are new sample
custom Batch templates for firmware versions 23.74.30 and 27.74.30 and up.

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

333
OmniCom Help

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.

334
Report Template Editor

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
created 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.

335
OmniCom Help

Element Setup
Boolean True/False 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 or not printed depending upon the ‘true/false’ Boolean evaluation of
the controlling database point. The embedded control point is shown on the report template as a
green block containing a T or an F signifying the true/false state needed to have the data
between the ‘{..}’ braces show on the printed reports. Image 1

Nesting Boolean Blocks

Boolean blocks can contain other Boolean blocks to a nesting level of 10.
Boolean Block Control Points

Database points that are embedded within a report template and used as control points are not
limited to Boolean types. For example: any ‘numeric’ type can also be used. Non-zero values are
evaluated as True, and a zero value is evaluated as false. An ASCII string type can also be used
and evaluated as long as it contains either of the following (case insensitive) character strings
True(1) or False(0).

336
Report Template Editor

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.

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 specifying numeric
data verses ASCII string data. Numeric data is right justified within the field and padded with
spaces to the width specified. 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 precision.

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:

ASCII data types ‘AAAAAAAA’


Time data types ‘HH:MM:SS’,
Date data types ‘MM/DD/YY’,
Numeric data type, precision specified ‘0000.0000’

337
OmniCom Help

Numeric data type, integer or default precision specified ‘00000000’

338
Report Template Editor

Insert Printer Code

Insert a literal 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.

To select a printer code, use one of the following methods: Enter the code using the decimal
equivalent, hexadecimal equivalent, or 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.

339
OmniCom Help

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.

340
Report Template Editor

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 element’ 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 unpredictable 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 template 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

341
Operate
Operate
The items listed below are links to topics within the Operate category. Click on a link to go to that
topic.

Topics

Current Reports
Historical Reports
Retrieve Archive Data
Archive Maintenance
Control

342
Operate

Control
Control

You may monitor or control the Batches or Proving operations in the Omni.
Topics

Batch
Prover

343
OmniCom Help

Batch

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 16 different
products.

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 "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
individual 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 (Applications with firmware
versions 20.74.22, 22.74.06, 24.74.18, and 26.74.10 and up):

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, only the configured meters 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.

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

344
Operate

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.

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 (Applications with firmware v22.74.05 and up)

345
OmniCom Help

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 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, 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'
command 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 button. Press the button to adjust the batch size. If you enter a
positive number, the batch size is incremented by the amount entered. If you
enter a negative number, the batch size is decremented by the amount
entered. (Note: this is only available for applications 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 Batch ID, Product Name, Batch Meter Factor, Batch Size, and Batch
Remaining. (Note: this is not available for gas applications.)

Next Batch: Limited information is available such as Batch ID, Product Name,
and Batch Size. (Note: this is not available for gas applications.)

346
Operate

347
OmniCom Help

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+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 applications.)

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 incremented by the amount entered. If you enter a
negative number, the batch size is decremented by the amount entered.
(Note: this is only available for applications 20 and 24.) (Note: Enter the batch
size in Tons to two decimal places for Anhydrous Ammonia v20.74.22+.)

348
Operate

Current Batch: Information is displayed regarding the current batch in progress


such as Batch ID, Product Name, Batch Meter Factor, Batch Size, and Batch
Remaining. (Note: this is not available for gas applications.)

Next Batch: Limited information is available such as Batch ID, Product Name,
and Batch Size. (Note: this is not available for gas applications.)

349
OmniCom Help

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 up)

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 computer . 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+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.

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 (Applications with firmware versions
20.74.22, 22.74.06, 24.74.18, and 26.74.10 and up):

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, only the configured meters are shown in the list.
If common batch stack is selected, only the station is shown in the list.

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

350
Operate

To edit the batch stack, double click anywhere on the sequence row. A screen will come up to
enter:

Batch ID
Enter a 16-character alphanumeric ID for the batch.

Product
Select from a drop down list of available products.

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 up)
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.

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.

351
OmniCom Help

Batch Ticket (Application 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 for Applications with firmware v22.74.05 and up.)

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.

352
Operate

Prover Control

Note: This screen is only available in the ONLINE mode.

(Applications 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 display.

353
OmniCom Help

Trapil Control

Note: This screen is only available in the ONLINE mode.

This page is displayed for firmware revisions 24.74.18 and up when the Trapil Functions are on.

This screen displays the following 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

The user may also issue the following 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
pressing the ‘RAZ" button’.

The RAZ command is edge triggered and in fact simply performs a ‘Batch End’ of the
appropriate 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.

354
Operate

Current Reports
Current Reports

These reports represent the current data in the system. Reports are retrieved automatically and
displayed 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). If a file being
saved already exists, the user is prompted if they would like to overwrite it.

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

355
OmniCom Help

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.

356
Operate

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.

357
OmniCom Help

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.

358
Operate

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
This will send the list to a printer local to your PC.

359
OmniCom Help

Historical 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.

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

360
Operate

Historical Alarm (500) or Alarm (150) Report

An historical alarm report detailing the last 500 or (150 for applications 22 and 26) alarm
occurrences can be uploaded from the flow computer or the last alarm report uploaded and
stored to disk can be loaded for viewing.

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 from 150 to 500 events for 22.74.30 and
26.74.10 and up.

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.

361
OmniCom Help

Historical Audit Trail (150) Report

A report detailing the last 150 data base changes can be uploaded from the flow computer 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.

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.

362
Operate

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.

363
OmniCom Help

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.

364
Operate

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.

365
OmniCom Help

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.

366
Operate

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)

367
OmniCom Help

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.

368
Operate

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 firmware 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
configuration 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 current date and time are also stored with each entry when the data is archived in the flow
computer. 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

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, 25.74.00, 26.74.10, and 27.74.00 and up).
(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, 25.74.00, 26.74.10, and 27.74.18 and up.)

For Archive Data 701-710, use registers 721-730 respectively (old registers are 701-710).
For Date/Time Data for Archives 701-710 use registers 771-780 respectively (old registers are
751-760).

When using these new registers, the "register count" field becomes the record requested.

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

369
OmniCom Help

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 99 9A
Omni) 42 90

370
Operate

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. 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 current date and time are also stored with each entry when the data is archived in the flow
computer. 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 16-bit unsigned integer
Type/Boolean
Value
Transducer float
Value
Volume 32-bit unsigned integer
Totalizer
Mass Totalizer 32-bit unsigned integer

Note: applications 22 and 26 do not have the Modbus Index field.


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, 25.74.00, 26.74.10, and 27.74.00 and up).
(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, 25.74.00, 26.74.10, and 27.74.18 and up.)

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)

371
OmniCom Help

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 42 90
Omni) 99 9A

372
Operate

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. 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 current date and time are also stored with each entry when the data is archived in the flow
computer. 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 float
Numeric Value
After Numeric float
Value
Before string 16-byte ASCII
After string 16-byte ASCII
Volume 32-bit unsigned integer
Totalizer
Mass Totalizer 32-bit unsigned integer

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, 25.74.00, 26.74.10, and 27.74.00 and up).
(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, 25.74.00, 26.74.10, and 27.74.18 and up.)

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.

373
OmniCom Help

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 42 90
Omni) 99 9A

374
Operate

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.

375
Diagnostics
Diagnostics
The items listed below are links to topics within the Diagnostics category. Click on a link to go to
that topic.

IO Overview
WinPanel
Test Communications

376
Diagnostics

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 and raw input
signals coming into the flow computer.

377
OmniCom Help

WinPanel
WinPanel

Setup and Connect to a unit at a site. Click on the Diagnostics Icon or from the menu, Actions |
Diagnostics, 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

o Click on any button to execute that function on the OMNI.


o Click above and below the OMNI display to scroll up or down.
o Click on a line in the OMNI display to go to that line.
o Click to the left or right of the OMNI display to go left or right one space.
o Click on an OMNI LED:
o Diagnostic – puts the OMNI in Diagnostic Mode
o Program – puts the OMNI in Program Mode
o Active Alarm – same as pressing the ‘Alarms’ and ‘Enter’ buttons on the keypad
o Alpha Shift – same as pressing the ‘Alpha Shift’ buttons on the keypad
o Click on the Modbus ID to modify the ID and other parameters

Use the PC Keyboard

o ALT-B and CTRL-G - causes OMNI to beep


o ALT-M - to access User Messages (remember the command line setting)
o TAB - is the same as pressing ‘Prog’ button on the keypad
o LEFT and RIGHT ARROW - scrolls cursor one position to left or right
o UP and DOWN ARROW - scrolls display one line up or down
o PAGE UP and DOWN - scrolls OMNI display 4 lines up or down
o HOME and END - scrolls OMNI display to top and bottom of current list
o DEL - delete character at cursor position.
o BACKSPACE - remove character that is to left of cursor.
o CAPS LOCK - locks Alpha Shift to red
o 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.
o All numbers are supported.

378
Diagnostics

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.

379
OmniCom Help

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.

380
Diagnostics

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

381
OmniCom Help

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.

382
Diagnostics

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 Send messages to the Omni Panel
Message

383
OmniCom Help

Modbus Tester
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:
Function Code
Select from the drop list the Function Code of the test message.

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.

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:

384
Diagnostics

that for Modicon Compatible units, the test program automatically subtracts one from
the register number.

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.

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
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 transmission.

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-transmitting the first item in the list.

CRC/LRC
The user may select how the CRC/LRC is calculated. Automatic means the system
calculates 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

385
OmniCom Help

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.

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.

386
Diagnostics

Register List

The Register List screen allows you to set up a list of items to be transmitted in succession to the
connected 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
Communications 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 function code is "User Defined" the data type is "User Def".
- 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
incremented for every communications or data processing error
encountered during the transmission.
 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
The user may select one of two methods to indicate when the repeat process should
stop:

387
OmniCom Help

 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 displayed 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
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.

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.

388
Diagnostics

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.

389
OmniCom Help

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 and clear the other field.

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

390
Diagnostics

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 back 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 6-7 significant digits.

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 300.0 is converted to:

RTU (to/from Omni) 43 96 00 00


Modicon (to/from Omni) 00 00 43 96

Doubles
Doubles have 15-16 significant digits.

ASCII strings
For ASCII strings you also need to enter the length of one string.
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.

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

391
OmniCom Help

Custom Data Packet


The "Custom Data Packet" data type is available for function codes "03", "06"(Modicon
only), and "16" (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.

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 (125) for
a read.

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: Writes to packets on or
below packets containing boolean data types are not supported. It is strongly
recommended to use the direct addressing with codes 05 and 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.

392
HowTo
Getting Started
When you first go into the program, a new file is automatically opened for you using the File
Application and Version last used. The default is version 20.74.

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.

To import an OmniCom DOS file, select File Import OmniCom DOS File.

393
OmniCom Help

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.

394
HowTo

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.

395
OmniCom Help

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.

396
HowTo

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’.

397
OmniCom Help

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.

398
HowTo

How To Edit Serial Passwords

In order to edit the serial passwords, the user must be online with the Omni and have navigated
to a Configuration page. Press CTRL + ALT + P to bring up the screen to edit passwords.

For more information on editing passwords, go to the Edit Serial Passwords screen.

399
Menus
Actions
Action menu commands

The Actions menu offers the following commands:

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.
Operate Perform operations such as retrieving reports, archive
data and control operations.
Reports Modify report templates.
Configure Configuration setup.
Transmit Write configuration, archive configuration, and report
templates to an Omni unit.
Receive Read configuration, archive configuration, and report
templates from an Omni unit.
Diagnostics I/O Overview, WinPanel and test communications.
WinPanel Access the front panel of the Omni unit.

400
Menus

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 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 program begins polling the
unit at that site. The Online menu changes from ‘Connect’ to ‘Disconnect’.

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
process by pressing this button.

Press Cancel to exit without connecting.

401
OmniCom Help

Offline (Actions menu)

Use this command to disconnect from a unit or to work with files.

402
Menus

Log On (Actions menu)

Use this command to log on to a port to allow communications to an Omni.

Password

403
OmniCom Help

Log Off (Actions menu)

Use this command to Log off of the Serial Password.

404
Menus

Actions Online Data Sync

Synchronizes the information between the Omni and the computer while the user is online with
the Omni. Changes done in OmniCom are not transmitted to the Omni until the [Apply] button is
pressed.

405
OmniCom Help

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.

406
Menus

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.

407
OmniCom Help

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
configuration.
Save all the configuration to a file and continue with the configuration write.
Terminate the configuration write.

408
Menus

Actions Online Disconnect

Use this command to disconnect from a unit or to work with files in OmniCom.

409
OmniCom Help

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.

410
Menus

Actions Online RX/TX

Shows the register numbers being read or sent and the communications status or errors.

411
OmniCom Help

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.

412
Menus

Edit
Edit menu commands

The Edit menu offers the following commands:

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 Activates the logging function so that all communications
Communications are logged to file.
Setup Sites Edit communications sites, units, and communications
parameters

413
OmniCom Help

Edit Undo

Reverse previous editing operation.

Shortcuts

Toolbar:
Keys: CTRL+Z

414
Menus

Cut command (Edit menu)

Use this command to remove the currently selected data from the document and put it on the
clipboard. 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

415
OmniCom Help

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

416
Menus

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

417
OmniCom Help

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.

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 settings 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.

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.

The Import DOS File Folder is the folder last used when importing a DOS configuration
file. The default is the "C:\OMNICOM" folder which was the default install folder for
OmniCom for DOS.

Advanced Configuration

418
Menus

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
configuration section. The default folder for all is the folder where OmniCom is
installed. The following are the configuration sections supported:
Ethernet Configuration
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.

The Import DOS File folder is the last folder used when importing a DOS template. The
default is the "C:\OMNICOM" folder which was the default install folder for OmniCom
for DOS.

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.

419
OmniCom Help

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.

420
Menus

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
setting for more information.

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.

*Note: The Setup Communications Screen is displayed if the user is adding or editing a site.
Follow the instructions for the Setup Communications Screen.

421
OmniCom Help

Setup Communications (Edit | Setup Site )

The Setup Communication Screen is used to configure communications parameters within


OmniCom to establish communications with as 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
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

422
Menus

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
transmission. 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
connection to the Omni.

TCP/IP Connections
(there are no additional fields)

423
OmniCom Help

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 XX seconds


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 number.

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.

424
Menus

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
setting 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 entering 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 (available 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.

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 connections baud rate is also a factor.

TCP/IP Connections

425
OmniCom Help

Connection Timeout – the amount of time in milliseconds to wait before a connection


attempt is aborted. The default is 5000ms. (Note: If VSAT communications 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.

426
Menus

File
File Menu Commands

The File menu offers the following commands:

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.
Import Import Data from files.
Export Export template data to file
Recent File Select from the most recent files used list.
Exit End the OmniCom session

427
OmniCom Help

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
firmware.

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 firmware. OmniCom only shows or enables the items available for that
application, version and revision on each screen.

Note for firmware version: 20.74.30:


application = 20
version = 74
revision = 30

428
Menus

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.

429
OmniCom Help

New Configuration (File menu)

Initializes OmniCom and creates an empty configuration with default settings.

Shortcuts

Toolbar:
Keys: CTRL+N

430
Menus

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
documents 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.

431
OmniCom Help

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:

432
Menus

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
document. 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

433
OmniCom Help

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.

434
Menus

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.

435
OmniCom Help

File Import

The user may import an OmniCom DOS file when on the Configuration Tree. All the DOS
Templates are automatically imported with the configuration file.

If the user is on the Report Template Editor tree and selected a report , the user may import an
OmniCom DOS template file for that report.

436
Menus

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.

437
OmniCom Help

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.

438
Menus

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.

439
OmniCom Help

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.

440
Menus

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

441
OmniCom Help

Help
Help menu commands

The Help menu offers the following commands, which provide you assistance with this
application:

Help Topics Offers you an index to topics on which you can get help.
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.
About OmniCom Displays the version number of this application and contact information.

442
Menus

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.

443
OmniCom Help

User Notes (Help menu)

Opens a file in Notepad to allow the user to enter their own OmniCom notes.

444
Menus

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 to download updates:

www.omniflow.com/support/softwaredownloads/index.html

445
OmniCom Help

About Command (Help menu)

Use this command to display the copyright notice and version number of your copy of OmniCom.

446
Menus

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.

447
OmniCom Help

Using Help command (Help menu)

Use this command for instructions about using Help.

448
Menus

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

449
OmniCom Help

View
View menu commands

The View menu offers the following commands:

Comms Log The Communications Log is displayed.


Comms View the Communications Statistics
Statistics
Toolbar Shows or hides the toolbar.
Status Bar Shows or hides the status bar.

450
Menus

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 difference.)
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 pressing Save As Text. After it is saved, it is automatically opened in a text editor
for convenience.

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

451
OmniCom Help

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.

452
Menus

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
incremented. 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
incremented. 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 Responses
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
transmission).

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

453
OmniCom Help

Response Success
This is the percent of success of responses to messages sent calculated as:
( (Responses Received - Invalid Responses) / (Transmissions Sent - Broadcast
Transmissions) ) * 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) ) * 100.

Note: The percentage calculations will no longer be valid when a rollover occurs.

454
Menus

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.

455
OmniCom Help

Toolbar command (View menu)

Use this command to display and hide the Toolbar, which includes buttons for some of the most
common 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.

456
Menus

Window
Window menu commands

The Window menu offers the following commands, which enable you to arrange multiple views of
multiple documents in the application window:

Cascade Arranges windows in an overlapped


fashion.
Tile Arranges windows in non-overlapped tiles.
Window 1, 2, Goes to specified window.
...

457
OmniCom Help

Tile command (Window menu)

Use this command to arrange multiple opened windows in a non-overlapped fashion.

458
Menus

Cascade command (Window menu)

Use this command to arrange multiple opened windows in an overlapped fashion.

459
OmniCom Help

Window 1, 2,

Lists the currently open files in the program. select the files you would like to go to.

460
TroubleShooting
Trouble Shooting
The items listed below are links to topics within the Trouble Shooting category. Click on a link to
go to that topic.

Topics

Ethernet Communications
Network Printing
Serial Communications
Modem Connections
Exception Codes
Contact Us

461
OmniCom Help

Ethernet Communications Trouble Shooting


Use Omni's Network Utility (valid for Ethernet firmware v1.22 and up) to see if the Omni is
displayed 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
communicate 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:

If the firmware is older than 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 Ethernet card (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 v74.10 and up, make sure the “SE Firmware >2.0” is set to ‘N’
(unchecked). (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 on the SE Module in OmniCom (if Ethernet
configuration 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
connection 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 connections.

Communications Log

One of the best methods to aid in trouble shooting 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".

462
TroubleShooting

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.

463
OmniCom Help

Serial Communications Trouble Shooting


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
configured 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.

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).
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

464
TroubleShooting

One of the best methods to aid in trouble shooting 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.

465
OmniCom Help

Modem Connections Trouble Shooting


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 initialization 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 &W.)

If the above does describe the problem, please check the Trouble Shooting for Serial
Connections.

466
TroubleShooting

Network Printing Trouble Shooting


Network Printing is available with Omni firmware versions 20.74.30, 22.74.30, 24.74.19, 26.74.10,
and 27.74.21 and up and Omni SE Module firmware v1.50 and up. 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.52.0

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 still having problems, please consult the SE Module Technical Bulletin at our
web site, www.omniflow.com.

SE Module 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 value is the error code. The following are the printer error code
definitions:

Error Description
Code
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
6 Error while sending report
7 Error while sending nulls
8 Job Done Character error
255 Network parameter change

467
OmniCom Help

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 255 - Each time the SE Module's IP address or the Printer IP address changes, the
connection between the SE Module and the printer is no longer valid. This is more of an
informational error.

468
TroubleShooting

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.

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

469
OmniCom Help

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

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

470
TroubleShooting

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.

471
OmniCom Help

Trouble Shooting - Contact Us


You may contact us via the web at www.omniflow.com.

E-mail us at: techsupport@omniflow.com

Omni Flow Computers, Inc.


12620 West Airport Blvd.
Suite 100
Sugar Land, TX 77478

281-240-6161 - telephone
281-240-6162 - fax

472
Standard Interface
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
document 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

473
OmniCom Help

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

474
Standard Interface

No Help Available
No help is available for this area of the window.

475
OmniCom Help

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.

476
Standard Interface

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.

477
OmniCom Help

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.

478
Standard Interface

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
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

TCP/IP
Site Name
Unit Name
IP Address

479
OmniCom Help

TCP Port
Modbus ID
Protocol
Modicon Compatibility (Y/N)
Scan Rate
Connection Timeout
Message Timeout
Retries

480
Standard Interface

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.

481
OmniCom Help

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

482
Standard Interface

Title Bar
The title bar is located along the top of a window. It contains the name of the application and
document.
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

483
OmniCom Help

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
existing OmniCom configuration from disk. Note that if you want to load an
OmniCom DOS file you must use the Import function on the File menu.

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.

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.

484
Standard Interface

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.

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.

About Box - gives product and version information.

Click on this button and then anywhere on the dialog for information on a dialog. menu, or
toolbar item.

485
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
informational messages.

486
OmniCom Logo Bar

You may contact us via the web at www.omniflow.com.

E-mail us at: techsupport@omniflow.com

Omni Flow Computers, Inc.


12620 West Airport Blvd.
Suite 100
Sugar Land, TX 77478

281-240-6161 - telephone
281-240-6162 - fax

487
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).

488
Edit Serial Passwords
Modify the passwords on the serial port. This screen is available when a user is online and
presses "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
flowmeters.

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,
asterisks 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 automatically 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.

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 password.

489
Password
Enter your password at this point if you wish to retrieve printed
reports or upload or download configuration 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.

490
Print Lists
Select from the following print list links:

Configuration Print
Site List

491
Index
1 Address 201............................ 295, 299, 302
1.5v/4-20mA ..............................................31 Address 401............................ 295, 299, 302
10BaseT Ethernet port ..............................77 Adjust Selection ........................................ 97
2 Advanced .................................................. 69
2-wire RS-485....................................77, 423 AGA .......................................... 10, 255, 268
2-wire RS-485 Repeater port.....................77 AGA 10 ..................................................... 81
4 AGA 3-92 ............................................ 10, 81
4-20 mA AGA 3-92/API 14.3 ................................... 81
channel...........................36, 37, 38, 39, 40 AGA-10 ............................... 89, 95, 100, 102
4-20 mA .....................................................36 AGA-10 VOS Deviation ...... 89, 95, 100, 102
4-20 mA .....................................................37 AGA-5 ..................................................... 255
4-20 mA .....................................................38 AGA-8 ............................................... 10, 255
4-20 mA .....................................................39 Air
4-20 mA .....................................................40 Density ................................................ 255
4-20mA 31, 54, 126, 148, 173, 181, 255, 262 Molecular Weight................................... 10
4-20ma SG ..............................................255 Air.............................................................. 10
4-wire RS-485............................................77 Air............................................................ 255
A Alarm 10, 23, 27, 31, 54, 60, 89, 95, 97, 100,
Abort button .............................................402 102, 106, 126, 127, 128, 140, 141, 144,
Abort Prove ..............................................27 172, 173, 175, 181, 182, 185, 189, 215,
Aborted ....................................................164 230, 262, 266, 279, 282, 318, 335, 358,
About Command......................................447 361, 362, 368, 372, 379
About OmniCom ......................................443 Alarm Acknowledge ............................... 27
Accumulated ............................................329 Alarm Band ............................................... 97
Acknowledge Meter.................................27 Alarm Band High Limit .............................. 97
Action...............................................275, 379 Alarm Band Low Limit ............................... 97
Action menu commands ..........................401 Alarm Deadband ....................................... 10
Actions menu ...................................401, 407 Alarm Limits
Actions Offline..........................................403 densitometers/gravitometers................. 31
Actions Online......... 402, 406, 410, 412, 413 station.................................................. 140
Actions Online Disconnect.......................410 Alarm Limits .............................................. 31
Actions Receive .......................................407 Alarm Limits .............................................. 54
Actions Transmit ......................................408 Alarm Limits .............................................. 89
Activate Alarm Limits .............................................. 95
Database Point Select .........................338 Alarm Limits ............................................ 100
Detailed Daily Report ...........................314 Alarm Limits ............................................ 102
Activate ....................................................314 Alarm Limits ............................................ 126
Activate ....................................................325 Alarm Limits ............................................ 127
Activate ....................................................338 Alarm Limits ............................................ 140
Active Alarms...........................................379 Alarm Limits ............................................ 172
Active Frequency .............................106, 282 Alarm Limits ............................................ 173
Actual Density..........................136, 154, 178 Alarm Limits ............................................ 175
ADD .........................................................287 Alarm Limits ............................................ 181
Add Site .................. 396, 397, 398, 399, 422 Alarm Limits ............................................ 182
Add Unit ...........................................399, 423 Alarm Limits ............................................ 262
Adding Alarm Log Archive................................... 372
Database Variables..............................338 Alarm Meter Inactive ............................... 106
Literal Text ...........................................332 Alarm Sampling....................................... 146
Adding......................................................332 Alarm setpoint ........................................... 10
Adding......................................................338 Alarm Timer .............................................. 10
Address 001.............................295, 299, 302 Alarms and Training................................ 146

493
OmniCom Help

All .............................................................282 API MPMS Chapter 11.2.1M .......... 215, 230


Allen-Bradley PLC 8, 56, 308, 309, 310, 312 API MPMS Chapter 11.4.1 ............. 238, 246
Allowable Flow.........................................164 API Override ................................... 238, 242
Allowable Temperature Change ..............164 API Tables 53A ............................... 215, 246
Allowable Temperature Difference-Prover API's Table 23A ...................................... 189
Meter ....................................................164 Applied Automation........................... 56, 266
Allowable Temperature Difference-Prover Apply Bar ................................................ 487
.............................................................164 Apply button
Alpha Coefficient..............238, 242, 246, 250 Online .................................................. 487
Alpha Factor ....................189, 204, 215, 230 Pressing .............................................. 487
Alpha Shift ...............................................379 Apply button ............................................ 487
ALT commands........................................379 Apply Meter Factor Retroactively............ 164
Analog........................................................44 Archive All Reports ................................. 164
Analog input.........................................31, 34 Archive Block .......................................... 332
Analog Input dialog .... 31, 36, 37, 38, 39, 40, Archive Boolean Trigger ......................... 306
41, 42, 44 Archive Data 701-710 ..................... 368, 370
Analog output. 30, 34, 36, 37, 38, 39, 40, 41, Archive Maintenance .............. 306, 343, 376
42, 44, 50, 287 Archive Path............................................ 368
Analog Output Assignments ......................50 Archive RAM Status................................ 306
Analog Outputs ..........................................34 Archives ..... 2, 164, 306, 314, 332, 343, 368,
Analysis ... 10, 106, 215, 246, 254, 255, 263, 369, 370, 372, 374, 376, 401, 407, 408,
264, 266, 268, 279 409, 485
Analysis basis entered.............................264 Archives 701-710 .................................... 370
Analyzer ID ..............................................266 Archives Disabled on Configuration Write
Analyzer Type..........................................266 ............................................................. 409
AND ...................................21, 167, 282, 306 Archives Options dialog .......................... 306
AND NOT.................................................282 arrows ..................................................... 379
API ... 15, 106, 148, 189, 215, 238, 242, 246, ASCII
250 send..................................................... 313
API 11.1 2004 product.............................354 speed..................................................... 56
API 11.2.1 ........................189, 204, 238, 242 Write .................................................... 287
API 11.2.1M .....................215, 230, 246, 250 ASCII......................................................... 54
API 11.2.2 ........................189, 204, 238, 242 ASCII......................................................... 56
API 11.2.2M .....................215, 230, 246, 250 ASCII....................................................... 106
API 11.3.2 ASCII....................................................... 126
pressure limits ......................................189 ASCII....................................................... 127
API 11.3.2 ................................................189 ASCII....................................................... 148
API 11.3.2 ................................................215 ASCII....................................................... 173
API 11.3.3.2 .....................................189, 215 ASCII....................................................... 175
API 11.3.3.2. ............................................189 ASCII....................................................... 181
API 11.3.3.2M ..........................................215 ASCII....................................................... 182
API 12.2.3 Rounding Rules .......................15 ASCII....................................................... 185
API 23E/24E ............................................189 ASCII....................................................... 262
API 2540/ASTM D1250 1952 .189, 204, 215, ASCII....................................................... 287
230 ASCII....................................................... 295
API 2565 ASCII....................................................... 299
Ethyl .............................................189, 215 ASCII....................................................... 302
Propyl ...........................................189, 215 ASCII....................................................... 313
API 2565 ..................................................189 ASCII....................................................... 336
API 2565 ..................................................215 ASCII....................................................... 338
API gravity .......................................238, 242 ASCII....................................................... 340
API Linear ................................................148 ASCII....................................................... 369
API MPMS 11.1 ...............................189, 215 ASCII....................................................... 370
API MPMS 11.4.1 ............................189, 215 ASCII....................................................... 372
API MPMS Chapter 11.1 .189, 204, 215, 230 ASCII....................................................... 374
API MPMS Chapter 11.2.1 ..............189, 204 ASCII....................................................... 385

494
Index

ASCII .......................................................392 Base Conditions Max ...................... 189, 215


ASCII .......................................................426 Base Conditions Min ....................... 189, 215
ASCII String .............................................385 Base Cumulative MSCF ......................... 329
Assign Base Density................................... 189, 215
I/O ............................................................8 Base Flowrate ......................................... 106
Assign ..........................................................8 BASE LEVEL .......................................... 329
Assign I/O .................................................23 Base Range ............................................ 215
ASTM 1550......................................189, 215 Base Temperature .................... 10, 162, 255
ASTM 1550M...........................................215 Batch
ASTM 1555..............................................189 ID ......................................................... 351
ASTM 1555M...........................................215 Batch ...... 15, 23, 27, 56, 106, 140, 141, 164,
ASTM D1555 ...........................................189 279, 287, 306, 313, 314, 318, 319, 321,
ASTM D1555M ........................................215 332, 335, 344, 345, 347, 349
AT ....................................................425, 467 Batch ....................................................... 351
Atmospheric Batch ....................................................... 353
gauge .....................................................10 Batch ....................................................... 358
Atmospheric...............................................10 Batch ....................................................... 361
Audit........................ 335, 361, 363, 368, 374 Batch ....................................................... 365
Audit Log Archive.....................................374 Batch ....................................................... 366
Audit Trail.................................335, 361, 363 Batch ....................................................... 367
Auto Adjust Set ..........................................97 Batch ....................................................... 370
Auto Implement Batch ....................................................... 485
Meter Factor.........................................164 Batch ....................................................... 490
Auto Implement........................................164 Batch ....................................................... 491
Auto Implement Meter Factor Immediately Batch Control .......................... 345, 347, 349
.............................................................164 Batch end................ 314, 321, 332, 347, 349
Auto prove ...............................................167 Batch End Acknowledge Toggle ........... 23
Auto Prove Enable...................................106 Batch End Acknowledgement ............... 23
Auto Prove Problem ................................23 Batch End Pulse...................................... 23
Auto Prove Setup.....................................158 Batch End Select .................................... 321
Auto Prove Setup Screen ........................167 Batch ID .................. 287, 318, 347, 349, 351
automatic disconnect .......................398, 425 Batch Meter ............................. 27, 347, 349
Automatic Hourly Batch Select ................321 Batch Number ......................................... 353
Auxiliary Inputs ......... 8, 17, 31, 54, 106, 139 Batch Preset Reached Flag ................... 23
Average Relative Adjustment ....................97 Batch Preset Units .................................. 319
B Batch Preset Warning
B Combo Modules ...............................30, 37 Station ................................................. 141
Backpanel ..................................................77 Batch Preset Warning ............................. 106
BACKSPACE...........................................379 Batch Preset Warning ............................. 141
Backspace’ key........................................332 Batch Preset Warning ............................. 319
Band High Limit Batch Preset Warning ............................. 351
Warning..................................................97 Batch Preset Warning Flag .................... 23
Band High Limit .........................................97 Batch Remaining............................. 347, 349
Band Low Limit Batch Report .... 15, 313, 332, 361, 365, 366,
Warning..................................................97 367
Band Low Limit ..........................................97 Batch Report Decimal Places ................... 15
Barrels ..............................................21, 277 Batch Scheduling .... 318, 319, 321, 345, 351
Barrels Conversion Batch Scheduling list ...................... 140, 141
Cubic Feet..............................................10 Batch Screen .......................................... 141
Barrels Conversion ....................................10 Batch Setup ... 140, 141, 318, 319, 321, 345,
Barrels Pulses/unit...................................277 349, 351
Base Batch Size............................... 347, 349, 351
Premium...............................................329 Batch Stack..................................... 319, 321
Base................ 189, 204, 215, 230, 246, 250 Batch Ticket .................................... 345, 353
Base.........................................................329 Batch warning ................................. 106, 141
Base Conditions........ 10, 162, 189, 215, 255 baud rate

495
OmniCom Help

Omni port .............................................465 C


baud rate............................58, 360, 397, 423 C Combo Modules .............................. 30, 38
baud rate..................................................465 Calibration
baud rate..................................................480 supplied ............................... 135, 153, 176
BCC ...........................................................56 Calibration............................................... 135
beep .........................................................379 Calibration............................................... 153
beeper......................................................380 Calibration............................................... 176
Bi Directional............................................27 Calibration chart which correlates Reynolds
Bidirectional .............................................164 Number versus Flowmeter Flow
Big Endian ...............................................391 Coefficient Cf......................................... 94
Blade Tip Sensor Factor ............................97 Cancel button.................................. 340, 487
Blank Page ..............................................331 Caps........................................................ 332
Block caps lock ................................................. 379
data ......................................................310 Channel
Block ........................................................310 4-20 mA......................... 36, 37, 38, 39, 40
Board Checks ..........................................463 flowmeter............................................. 106
Boolean Channel..................................................... 36
deactivating ..........................................282 Channel..................................................... 37
moves...................................................282 Channel..................................................... 38
printing .................................................336 Channel..................................................... 39
Boolean....................................................281 Channel..................................................... 40
Boolean....................................................282 Channel................................................... 106
Boolean....................................................332 Character Delay .............. 423, 426, 465, 480
Boolean....................................................336 Checked/Proved For ............................... 313
Boolean....................................................392 Chromatograph ............................... 255, 266
Boolean Block Control Points ..................336 Chronometry ............................................. 39
Boolean Blocks Clear All Totals.......................................... 13
Nesting .................................................336 Clear Daily Total ..................................... 321
Boolean Blocks ........................................332 Clear Log ................................................ 452
Boolean Blocks ........................................336 COM port ........................ 397, 423, 465, 467
Boolean False Blocks’ .............................332 Combo Modules... 30, 31, 36, 37, 38, 39, 40,
Boolean Points 1025 ...............................23 41, 42, 44, 106
Boolean Statements ......2, 27, 106, 282, 306 Comm ............................................. 139, 423
Boolean Trigger Comm Port...................................... 360, 480
sets.......................................................306 Command Block.............................. 308, 309
Boolean Trigger .......................................306 Command Inputs................................. 19, 27
Boolean True Blocks’...............................332 Command Point ...................................... 273
Boolean True/False Block .......................336 Common Batch Stack .... 140, 141, 319, 321,
Boolean Variables 345, 349, 351
Including...............................................287 Comms Log............................. 385, 421, 451
Boolean Variables....................................287 comms statistics...................................... 454
Brooks..............................................160, 186 Communication LEDs ............................. 489
Brooks compact prover Communications
using.....................................................159 modem ................................................ 425
Brooks compact prover............................159 Communications ..................................... 425
Brooks compact prover............................186 Communications Log ...... 385, 421, 451, 452
Brooks prover ..........................................106 Communications Log dialog ................... 452
Browser....................................................340 communications parameters.. 397, 398, 422,
Browser Button 423, 425
use .......................................................340 Communications Screen................. 465, 467
Browser Button ........................................340 Compact Prover /Run ............................. 23
Browser printer ........................................340 Company Name .......................................... 4
BS&W ................................................54, 106 Component Order Setup......................... 268
BTSF..........................................................97 Component Overrides..................... 263, 264
BTU..........................................................255 Compressibility................................ 189, 215

496
Index

Compressibility factor .....189, 204, 215, 230, Constants..... 3, 10, 106, 135, 136, 137, 138,
238, 242, 246, 250 153, 154, 155, 156, 176, 178, 179, 180,
Computer ID ....................................313, 361 186, 287
Condensed Mode String..........................313 Contact Us ...................................... 462, 473
Conditional Printing Data Context Help
Report ..................................................332 Use ...................................................... 450
Conditional Printing Data.........................332 Context Help ........................................... 450
Conditions/Ratio Control ... 19, 23, 27, 89, 106, 144, 270, 271,
Specific Heats ......................136, 154, 178 273, 275, 279, 282, 319, 325, 332, 336,
Conditions/Ratio ......................................136 338, 340, 341, 343, 344, 354, 401, 411,
Conditions/Ratio ......................................154 442, 467, 474, 475, 477, 483
Conditions/Ratio ......................................178 Control output percentage ...................... 271
CONFIGURABLE USER ENTRIES.........287 Control Output Tag ................................. 271
Configuration Print ...........................330, 492 Control Outputs................................... 19, 23
configure ................. 396, 397, 398, 423, 425 Control Value .......................................... 275
Configure PID ..........................................271 Control Variable ...................................... 271
configure site ...........................................422 convert numbers ..................................... 391
connect Convertor
Ethernet port ..........................................60 pressing............................................... 385
connect ......................................................60 Convertor ................................................ 385
connect ....................................................102 Coriolis .......................... 31, 79, 99, 106, 170
connect ....................................................106 Coriolis flowmeters.................................. 123
connect ....................................................379 Coriolis Meter............................................ 99
connect ....................................................395 Corrected GSV................................ 347, 349
connect ....................................................401 Corrected NSV................................ 347, 349
connect ....................................................402 Correction Factors .................................... 15
Connect - Connect...................................485 Cp ........................................................... 255
Connect Screen ...............................395, 402 Cp/Cv ...................................................... 255
connect wait.....................................398, 425 Cpl.... 15, 189, 204, 215, 230, 238, 242, 246,
Connect Wait Time ..................................467 250
Connect’...................................................402 Cpl factor......................................... 189, 215
connection Cplm.......................................................... 15
To Make ...............................................395 Cplp........................................................... 15
connection 20, 36, 38, 39, 40, 41, 42, 44, 56, CPSP
60, 75, 77, 360, 379 calculate .............................................. 160
connection ...............................................395 CPSP ........................................................ 15
connection ...............................................402 CPSP ...................................................... 160
connection ...............................................422 CRC Detection Enabled............................ 56
connection ...............................................423 CRC/LRC ................................................ 385
connection ...............................................425 Critical applications ................................. 325
connection ...............................................426 Critical Temperature ............................... 255
connection ...............................................428 Cst............................................................. 31
connection ...............................................440 Ctl
connection ...............................................462 calculate ...................................... 189, 215
connection ...............................................463 limits ............................................ 215, 230
connection ...............................................465 Ctl.............................................................. 15
connection ...............................................467 Ctl............................................................ 189
connection ...............................................470 Ctl............................................................ 204
connection ...............................................480 Ctl............................................................ 215
connection ...............................................485 Ctl............................................................ 230
Connection problem ................................467 Ctl............................................................ 238
Connection Screen ..................................395 Ctl............................................................ 242
connection timeout ..................................423 Ctl............................................................ 246
CONSTANT Operators ............................287 Ctl............................................................ 250
Ctl factor.......................... 189, 204, 215, 230
Ctlm........................................................... 15

497
OmniCom Help

Ctlp ............................................................15 Delay Off .......................................... 23, 282


Ctpl ..........................................................189 Delay On .......................................... 23, 282
Ctrl Delayed Rate Of Change ........................ 23
PC ........................................................452 Delete Site .............................................. 422
Ctrl ...........................................................452 Delete Unit .............................................. 423
Ctrl ...........................................................490 Delete’ ..................................................... 332
CTRL+Z ...................................................415 Denisty Pressure Override Value ........... 134
CTSP Densitometer
calculate ...............................................160 type...................................................... 148
CTSP .........................................................15 Densitometer.... 10, 31, 34, 37, 54, 106, 128,
CTSP .......................................................160 135, 136
CTSP .......................................................162 Densitometer........................................... 148
Cumulative MSCF....................................329 Densitometer........................................... 153
Current Assignments ...........................17, 46 Densitometer........................................... 154
Current Reports ...............332, 343, 356, 361 Densitometer........................................... 172
Custom Packets.......... 2, 293, 295, 299, 302 Densitometer........................................... 173
D Densitometer........................................... 175
Daily...................................15, 306, 335, 370 Densitometer........................................... 176
Daily Report .... 306, 314, 321, 332, 361, 366 Densitometer........................................... 178
Daily Report Active ..................................314 Densitometer........................................... 188
Daily Report Time....................................314 Densitometer........................................... 189
Danalyzer ASCII ........................................56 Densitometer........................................... 215
Danalyzer GC ..........................................268 Densitometer........................................... 238
Danalyzer Modbus ASCII ........................266 Densitometer........................................... 242
Danalyzer RTU ..........................................56 Densitometer........................................... 246
Daniel...................... 31, 43, 44, 79, 100, 266 Densitometer........................................... 318
Daniel Danalyzer .....................................266 Densitometer calibration constants 135, 153,
Daniel Danalyzer chromatograph ............266 176
Daniel Ultrasonic Densitometers................... 40, 128, 173, 175
SV ........................................................100 Densitometers/gravitometers
Daniel Ultrasonic......................31, 43, 44, 79 Alarm Limits........................................... 31
Daniel Ultrasonic......................................100 Densitometers/gravitometers.................... 31
Daniel Ultrasonic flowmeter Density / Gravity Type ............................ 129
Modbus ID............................................100 Density Correction Factors ..................... 172
Daniel Ultrasonic flowmeter.....................100 Density Pressure Override Value ........... 175
Daniel Ultrasonic Meter Density Pulse ............................................ 31
K-Factor Curve.....................................100 Density Stability Time ............................. 164
Daniel Ultrasonic Meter ...........................100 Density Temperature
data bits ...........................................397, 423 input..................................................... 173
Data Types .... 310, 312, 327, 338, 385, 391, Density Temperature ................................ 34
392 Density Temperature .............................. 173
data value ................................................385 Density Temperature High Alarm.......... 23
Data Values Density Temperature Low Alarm........... 23
requests ...............................................385 Density Temperature Override Value ..... 173
Data Values .............................................385 Density/gravity
Data Values .............................................392 selecting .............................................. 130
Database Point ................................332, 338 Density/gravity .................................. 27, 31
Database Point’ .......................................338 Density/gravity ........................................ 157
Database Variables Density/gravity ........................................ 170
Adding ..................................................338 Density/gravity ........................................ 172
Database Variables .................................338 Density/Gravity Override Value .............. 172
Date Format Entry .......................................4 Density/Gravity Pressure ........................ 175
Daylight Savings Time.................................4 Density/Gravity Settings ......................... 140
Deadband ........................................186, 275 Density/Gravity Setup ............................. 172
Decimal Resolution................................3, 15 Density/Gravity Temperature.................. 173
delay ........................................................423 Density/Gravity Type............................... 148

498
Index

Detailed Analysis .....................................263 Edit menu 396, 397, 398, 399, 414, 421, 452
Detailed Daily Report Edit Modem............................................. 425
activate.................................................314 Edit Serial Passwords ..................... 400, 490
Detailed Daily Report...............................306 Edit Sites ......................... 397, 398, 399, 422
Detailed Daily Report...............................314 Edit Undo ................................................ 415
diagnostic.................................................379 Edit Unit .................................. 399, 423, 426
Diagnostics 1, 377, 378, 379, 385, 391, 401, Elasticity
470, 485 Modulus ............................................... 160
dial ...........................................................402 Elasticity.................................................. 160
Digital Channels.........................................19 Electromechanical................................... 277
Digital I/O Element................................................... 332
configuration...........................................20 Element’ .......................................... 332, 342
Digital I/O .............................................17, 19 end .......................................................... 379
Digital I/O ...................................................20 Energy Flow..................................... 21, 277
Digital I/O .................................................282 Energy Flowrate...................... 295, 299, 302
DIGITAL I/O MODULE ..............................20 Epson ...................................................... 313
DIGITAL I/O OUTPUTS.............................20 EQUAL Operators................................... 287
Digital Input Assignments ..........................51 Equimeter AAT.................................... 79, 97
Digital Input No ........................................102 Equimeter Auto-Adjust Turbine Meter ...... 97
Digital IO ..............................................19, 20 Equipment List .. 3, 8, 56, 126, 127, 172, 265
direct ................................397, 402, 422, 423 Error Check Threshold............................ 106
Direct connections ...................................426 Error Select ............................................. 275
Direct, Modem .................................423, 426 ESC......................................................... 340
Direct/Modem/Satellite ............................360 Ethernet ... 18, 55, 60, 61, 62, 64, 65, 67, 69,
Disable NIST14 Flowing Density Calculation 70, 71, 73, 77, 463, 468
.............................................................106 EXACT COMPARE......................... 282, 287
Disconnect’ ..............................................402 Exception code ....................................... 470
display..............................................379, 381 Exit command ......................................... 442
display message ......................................383 EXOR...................................................... 282
Dissolved Air....................................238, 246 Export Template...................................... 439
DIVIDE Operators....................................287 Export User Displays .............................. 279
double ......................................................392 Exporting Report Templates ................... 332
DP F
type ........................................................44 Factor Acceptability Criteria.................... 164
DP ..................................................31, 41, 42 Factor Calculation Resolution................. 164
DP ..............................................................44 Factor Curve ................................... 187, 253
DP ............................................................105 Factors3, 10, 15, 89, 97, 106, 123, 136, 137,
DP ............................................................106 138, 139, 154, 155, 156, 160, 164, 172,
DP ............................................................279 178, 179, 180, 187, 188, 189, 204, 215,
DP ............................................................282 230, 238, 242, 246, 250, 253, 255, 275,
DP High Range........................................106 279, 287, 325, 347, 349, 359, 426
DP I/O Point.....................................105, 106 FALLING EDGE.............................. 282, 287
DP Mid Range .........................................106 False ............................................... 282, 336
DP Setup .........................................105, 106 File | Save Template As.......................... 435
DP Switchover .........................................105 File Application................................ 394, 429
DP Units.....................................................10 File Close command ............................... 433
DP/Orifice ................................................282 File Export Template............................... 439
Dry Air ........................................................10 File Import ............................... 394, 437, 438
Dual Error Alarm ......................................106 File Import OmniCom DOS File .............. 394
DZ/dT.........................................................81 File Import Template ............................... 438
E File Menu Commands............................. 428
E Combo Modules ...............................30, 39 File Name........................................ 361, 432
E/D Combo Modules ...........................30, 40 File New .................................................. 394
Edge Triggered Commands....................27 File New command ................................. 431
Edit Communications.......................396, 423 File Open ........................................ 394, 457
Edit Log Communications........................421 File Open command................................ 432

499
OmniCom Help

File Open Template .................................438 FMC MPU 1200 ............................ 43, 44, 79
File Open’ control dialog..................432, 485 FMC MPU 1200 ........................................ 95
File Print Setup command .......................440 Folder/Archives ....................................... 419
File Save As command............................436 folders ..................................................... 419
File Save command.................................434 Force Multiple Coils ................................ 392
File Save Template..................................435 Force One Coil........................................ 392
float ..........................................................392 Form Feed .............................................. 332
Floating Point Variables...........................282 Formatted view ....................................... 332
Flow Averaging Method.............................10 Front Panel Counters.......................... 2, 277
Flow Coefficient .........................................94 Full Scale ... 31, 54, 126, 127, 172, 173, 175,
Flow Coefficient Cf 181, 182, 262, 271
remaining ...............................................94 function code........................................... 385
values .....................................................94 G
Flow Coefficient Cf.....................................94 Gain Factor ............................................. 275
Flow Deviation Gallons Conversion
exceeds........................................100, 102 Cubic Feet ............................................. 10
Flow Deviation ...........................................95 Gallons Conversion................................... 10
Flow Deviation .........................................100 Gas Chromatograph 1, 2, 56, 106, 263, 265,
Flow Deviation .........................................102 266, 268
Flow Direction ......................89, 95, 100, 102 Gas Chromatograph Components.. 265, 268
Flow High Limit ................................106, 141 Gateway.............................................. 61, 62
Flow I/O Point ..........................................106 GC Alarm ................................................ 266
Flow Low Limit .................................106, 141 GC Components ..................................... 268
Flow Meter .................................................31 GC Fail Code .......................................... 266
Flow Minutes GC Protocol ............................................ 266
See ...............................................100, 102 GC Setup ................................................ 266
Flow Minutes............................................100 GC Stream .............................................. 106
Flow Minutes............................................102 GC2......................................................... 266
Flow Pulse .................................................31 General Setup.. 1, 2, 3, 4, 8, 10, 13, 15, 126,
Flow Rate Change ...................................167 127, 172, 265, 308
Flow Stable Time .....................................167 GOTO ............................................. 282, 287
Flow Tube Expansion Coefficient ..............92 GPA 2145-92 ............................................ 10
Flow Tube Inside Diameter........................92 GPA 2172-96 .......................................... 255
Flow Tube Reference Temperature...........92 GPA 27 ........................................... 189, 215
Flow Weighted ...........................................10 GPA 27 53/54E ....................................... 215
Flowmeter DP Setup ...............................105 GPA RR133 EP Mix................ 189, 204, 215
Flowmeter Flow Coefficient Cf...................94 GPA TP15...... 189, 204, 215, 230, 238, 242,
Flowmeter linearization............................123 246, 250
Flowmeter– Pulse Signal.....................86, 99 GPA TP16............................... 189, 204, 215
Flowmeter Setup........................................79 GPA TP16M.................................... 215, 230
Flowmeter Type .........................................78 GPA TP27....................... 189, 204, 215, 230
Flowrate Average Factor ...........................10 GPA-TP15....................... 238, 242, 246, 250
Flowrate High Alarm................................23 GPA-TP16............................... 238, 242, 250
Flowrate High High Alarm.......................23 GPA-TP16M............................................ 246
Flowrate Low Alarm ................................23 GPA-TP27....................... 238, 242, 246, 250
Flowrate Low Low Alarm ........................23 Gravitometer ... 148, 170, 172, 238, 242, 318
Flowrates ........ 141, 144, 253, 295, 299, 302 Gravity Change ....................................... 143
FLOWSIC 600 Ultrasonic Gravity Rate Of Change ......................... 23
SV ........................................................102 Gravity/Density High Alarm ................... 23
FLOWSIC 600 Ultrasonic ..........................79 Gravity/Density Low Alarm .................... 23
FLOWSIC 600 Ultrasonic ........................102 GREEN LED ................................... 480, 489
Fluid Products....................................81, 254 Gross BBL Accumulator ......................... 310
Fluid Setup.................. 89, 95, 100, 102, 255 Gross Flow ...................................... 21, 277
Fluid Type ................................................255 Gross Flowrate........ 287, 295, 299, 302, 310
FMC MPU 1200 Gross Flowrate Full Scale....................... 141
SV ..........................................................95 Gross Full Scale...................................... 106

500
Index

Gross Volume ..................................189, 215 number . 54, 126, 127, 148, 173, 175, 181,
H 182, 185, 262
H Combo Modules ...............................30, 41 reserves................................................ 27
Hardware Setup...................................55, 58 type................................................ 18, 378
Heating I/O ............................................................... 2
Value ..............................................34, 255 I/O ............................................................... 8
Heating ......................................................34 I/O ............................................................. 18
Heating ....................................................255 I/O ............................................................. 19
Heating Value Method .............................255 I/O ............................................................. 20
Heavy Hydraulic.......................................146 I/O ............................................................. 21
Helical Turbine Meters.............................139 I/O ............................................................. 23
Help I/O ............................................................. 27
screen ..................................................448 I/O ............................................................. 31
Help .........................................................448 I/O ............................................................. 45
Help .........................................................449 I/O ............................................................. 46
Help .........................................................450 I/O ............................................................. 54
Help About .......................................331, 447 I/O ............................................................. 77
Help menu commands.............................443 I/O ........................................................... 100
Help Release Notes.................................444 I/O ........................................................... 102
Help Topics..............................................443 I/O ........................................................... 106
Help User Notes ......................................445 I/O ........................................................... 126
Help Using Help Command .....................450 I/O ........................................................... 127
hexadecimal.....................................391, 392 I/O ........................................................... 148
High %DP ................................................144 I/O ........................................................... 173
High alarm .........................................31, 106 I/O ........................................................... 175
High Filter DP ..........................................282 I/O ........................................................... 181
High High Alarm...............................106, 141 I/O ........................................................... 182
High/low alarm ...................................10, 282 I/O ........................................................... 185
Historical ..........................363, 365, 366, 367 I/O ........................................................... 262
Historical Alarm........................................362 I/O ........................................................... 271
Historical Average....................................164 I/O ........................................................... 277
Historical Reports ............................343, 361 I/O ........................................................... 282
Historical Text Reports ....................306, 370 I/O ........................................................... 378
home........................................................379 I/O Allocations........................................... 18
Honeywell 31, 41, 42, 79, 88, 105, 106, 295, I/O module ..... 19, 20, 55, 75, 126, 127, 130,
299, 302 173, 175, 181, 182, 185, 262, 282
Honeywell APM .......................295, 299, 302 I/O Overview ........................... 378, 401, 485
Honeywell DE ......................................41, 42 I/O Point 21, 23, 27, 54, 126, 127, 148, 173,
Honeywell DE Protocol ..............................31 175, 181, 182, 185, 262
Honeywell SMV-3000 ..............................106 I/O ports ............................................ 58, 325
Honeywell SMV3000 DP ...........................79 IBM.......................................................... 313
Honeywell SMV3000 DP Meter .................88 ID
Honeywell SMV-3000 multivariable...........42 accept.................................................. 426
Host ...................................................64, 463 batch.................................................... 351
hotspots ...................................................379 ID................................................. 4, 141, 266
HP Laser Jet ............................................313 ID............................................................. 351
HV ID............................................................. 379
value.....................................................255 ID............................................................. 426
HV ............................... 42, 54, 126, 173, 181 ID Tag ..................................... 295, 299, 302
HV ............................................................255 Ideal Gas Calculation.............................. 255
HV ............................................................262 IF Operator.............................................. 287
HV Combo Modules ............................30, 42 Import
Hydraulic Alarms..............................146, 355 use....................................................... 485
I Import...................................................... 332
I/O Import...................................................... 485
Assign ......................................................8 Import Data ............................................. 428

501
OmniCom Help

Import User Displays ...............................279 Pulse Signal .................................... 86, 99


Import/Export ...........................................279 Ultrasonic FMC Kongsberg Meter......... 95
Import/Export User Displays....................279 Ultrasonic Instromet .............................. 89
Inactive Meter...........................................23 K-Factor Curve.......................................... 86
Inactivity Timer.........................................164 K-Factor Curve.......................................... 89
Independent Batch Stacks.......319, 345, 351 K-Factor Curve.......................................... 95
INDIRECT Operators...............................287 K-Factor Curve.......................................... 99
Initial Character Delay K-Factor Curve........................................ 100
Increase ...............................................465 K-Factor Curve........................................ 102
Initial Character Delay .............................465 Kongsberg MPU 1200 Ultrasonic Gas
Initial Character Delay .............................480 Flowmeter
initialization string ............................398, 425 configuring............................................. 95
Inlet/Outlet Pressure ........................157, 182 Kongsberg MPU 1200 Ultrasonic Gas
Inlet/Outlet Temperature Flowmeter.............................................. 95
input .....................................................181 Krohne Ethylene ..................................... 255
Inlet/Outlet Temperature..........................157 Kwong Method ........................................ 255
Inlet/Outlet Temperature..........................181 L
Input Scaling ..............................................31 Last Local Snapshot ....................... 361, 364
Input Type..................................................31 Last Master ............................................. 325
Input/Output Calibration.............................34 LCF ......................................................... 139
Insert Boolean Block................................336 LEDs ....................................................... 480
Insert Database Point ..............................338 Line Pack Delay ...................................... 143
Insert Printer Code...................................340 Line Pressure/Plenum Constant ............. 186
Insert/Over-type .......................................332 Linearization Coefficients........................ 139
Instromet Ultrasonic Linearization Method .............................. 254
SV ..........................................................89 Listen Only .............................................. 266
Instromet Ultrasonic.................43, 44, 79, 85 Literal Text
Instromet Ultrasonic...................................89 Adding ................................................. 332
Instromet Ultrasonic...................................92 Literal Text .............................................. 332
integer ......................................................392 Little Endian ............................................ 391
Inter-character ...................................56, 465 log communications ........................ 421, 452
Interface Detection ..........................143, 318 Log Off ............................................ 401, 405
Interface Switching ..................................140 Log On ............................................ 401, 404
Invalid CRC..............................................465 Logical address
IO Overview .............................................377 setpoint data block .............................. 312
IP address........... 61, 62, 360, 423, 426, 480 start ..................................................... 309
Isentropic Expansion .................................81 Logical address....................................... 309
Isentropic Exponent .. 81, 106, 189, 215, 255 Logical address....................................... 310
Isentropic Temperature Correction............81 Logical address....................................... 312
ISO 6976............................................10, 255 Long Integers .......................... 295, 299, 302
ISO5167 Version .......................................81 Low %DP ................................................ 144
IUPAC88..........................................189, 215 Low alarm ......................................... 31, 106
J Low Flow Cutoff
Joules Thompson ....................................255 set........................................................ 105
K Low Flow Cutoff ...................................... 105
K3 Thermodynamic Constant ..................106 Low Flow Cutoff ...................................... 282
keypad .............................................379, 381 Low Low Alarm ............................... 106, 141
K-Factor LRC ........................................................... 56
determining ..........................................123 LSB
K-Factor ...................................................123 containing ............................................ 282
K-Factor ...................................................295 holding................................................. 282
K-Factor ...................................................299 LSB ......................................................... 282
K-Factor ...................................................302 M
K-Factor Curve Main Rotor ................................................ 97
Daniel Ultrasonic Meter........................100 Maintenance Ticket................................. 353
flowmeter..............................................102 Manipulate

502
Index

PID permissives ...................................273 Meter Run Setup.... 78, 81, 87, 88, 106, 107,
Manipulate ...............................................273 111, 114, 118, 215, 254, 282
Manual .....................................................275 Meter Run Temperature ........... 78, 106, 126
Manual Implement MF Time Limit ...........164 Meter Setup ... 106, 107, 111, 114, 118, 319,
Manually Override Strategy .......................31 351
Mass ..................................................10, 123 Meter Station Run Switching dialog........ 144
Mass Calculation .............................189, 215 Meter Type79, 81, 86, 87, 89, 93, 95, 97, 99,
Mass Flow.........................................21, 277 100, 102
Mass Flowrate .................295, 299, 302, 310 Mild Carbon Steel ................................... 160
Mass Flowrate Full Scale ........................141 mimic beeper .......................................... 380
Mass Fraction ..........................215, 246, 255 Mimic OMNI Panel Beeper ..... 380, 382, 384
Mass Full Scale .......................................106 Min Acceptable Primary Setpoint............ 271
Mass Percent...........................215, 246, 255 Minimize command ......................... 477, 483
Master Meter............................159, 162, 164 Minimum Flow Rate Change .................. 167
MATHEMATICAL.....................................287 Minimum Percent Sample Ratio ............... 89
Max Acceptable Primary Setpoint ...........271 Minimum Performance.............................. 89
Max Error Counts Per ..............................106 Minimum Ramp
Max Good Pulses ....................................106 set................................................ 273, 275
Max Records............................................306 Minimum Ramp....................................... 273
Maximize..................................................477 Minimum Ramp....................................... 275
Maximum Deviation .................................164 Minimum Ramp Down Limit.................... 273
Maximum Down Time................95, 100, 102 Minimum Ramp Down To ....................... 273
Maximum Flow Between Proves .............167 Modbus
Maximum Flow Deviation ..........................89 includes ............................................... 363
Maximum Gain...........................................95 Selecting................................................ 56
Measurement Algorithm .106, 187, 189, 204, Sends.................................................... 27
215, 230, 238, 246 use....................................................... 287
Mechanical Output.....................................97 Modbus .................................................... 27
media type .......................................397, 423 Modbus ..................................................... 55
menu_actions ..........................................401 Modbus ..................................................... 56
menu_edit ................................................414 Modbus ..................................................... 75
menu_help ...............................................443 Modbus ................................................... 106
menu_view...............................................451 Modbus ................................................... 141
menu_window..........................................458 Modbus ................................................... 143
message ..................................................383 Modbus ................................................... 144
message timeout .....................................423 Modbus ................................................... 268
Meter Density/Gravity dialog ...................148 Modbus ................................................... 273
Meter Density/Gravity Pressure dialog ....175 Modbus ................................................... 282
Meter Density/Gravity Temperature dialog Modbus ................................................... 287
.............................................................173 Modbus ................................................... 293
Meter Factor Modbus ................................................... 325
Auto Implement ....................................164 Modbus ................................................... 327
Meter Factor ............................................164 Modbus ................................................... 363
Meter factor curve....................................253 Modbus ................................................... 385
Meter ID ...................................................106 Modbus ................................................... 452
Meter Manufacturer .................................114 Modbus ................................................... 490
Meter Run 1, 2, 8, 21, 23, 27, 31, 34, 54, 78, Modbus ................................................... 491
79, 81, 85, 86, 87, 88, 89, 92, 93, 95, 97, Modbus ASCII................. 102, 295, 299, 302
99, 100, 102, 106, 126, 127, 128, 129, Modbus data point number
132, 134, 135, 136, 137, 138, 140, 141, boolean bit which................................. 306
144, 157, 172, 187, 215, 253, 254, 271, Modbus data point number ..................... 306
277, 279, 282, 287, 293, 306, 310, 318, Modbus ID
319, 321, 329, 345, 347, 349, 351, 358 Daniel Ultrasonic flowmeter ................ 100
Meter Run Density UGC ..................128, 138 FLOWSIC 600 Ultrasonic flowmeter ... 102
Meter Run Density/Gravity dialog............172 Omni...................................................... 60
Meter Run Pressure ..........................78, 127 Modbus ID........................................... 31, 44

503
OmniCom Help

Modbus ID .................................................60 Mole Fraction .......................................... 238


Modbus ID ...............................................100 Mole Fraction .......................................... 246
Modbus ID ...............................................102 Mole Fraction .......................................... 255
Modbus ID ...............................................325 Mole Percent........................... 215, 246, 255
Modbus ID ...............................................327 Mole percentages ................................... 263
Modbus ID ...............................................360 Molecular Weight
Modbus ID ...............................................379 Air .......................................................... 10
Modbus ID ...............................................385 Molecular Weight ...................................... 10
Modbus ID ...............................................426 Monel .................................................. 81, 92
Modbus ID ...............................................463 Motorola .................................................. 391
Modbus ID ...............................................480 MOV ........................................................ 144
Modbus ID number MOVE ..................................... 282, 287, 475
slave.....................................................327 MOVE RANGE................................ 282, 287
Modbus ID number ..................................327 MPMS 12.2 ............................................... 15
Modbus index number MSB ........................................................ 282
first data point.......................................293 MULTIPLY .............................................. 287
Modbus index number .............................293 Multivariable........................................ 43, 44
Modbus Mux ..............................................60 N
Modbus Packet 001 .................................295 Nagle Algorithm ........................................ 69
Modbus Packet 201 .................................299 NBS 1045........................................ 189, 215
Modbus Packet 401 .................................302 Negative Energy Flow .................... 21, 277
Modbus RTU Modem ................................56 Negative Gross Flow ...................... 21, 277
Modbus RTU Modicon Compatible............56 Negative Mass Flow........................ 21, 277
Modbus tester ..........................................385 Negative Net Flow ........................... 21, 277
Modbus Tester Screen ............................385 Nesting
Modbus Type ...................360, 397, 423, 426 Boolean Blocks.................................... 336
Modbus/TCP............................................426 Nesting.................................................... 336
Modbus™ ..................................................55 Net .................................... 10, 106, 246, 250
modem.............................397, 402, 422, 423 Net Flow ........................................... 21, 277
Modem connection Net Flowrate.................... 295, 299, 302, 310
RTU using ..............................................56 Net Volume ..................................... 189, 215
Modem connection ....................................56 Netmask.............................................. 61, 62
Modem Initialization String Network Identifier
Check ...................................................467 contain................................................... 60
Modem Initialization String ......................467 Network Identifier ...................................... 60
Modem Screen ........................................467 New Configuration .................................. 431
modem settings ...............397, 398, 423, 425 Next Master............................................. 325
modem setup ...........................................422 NGL. 189, 204, 215, 230, 238, 242, 246, 250
Modicon .. 295, 299, 302, 360, 391, 392, 397 NGL Equilibrium Pressure ...................... 246
Modicon 984 Mode ..................295, 299, 302 NGL K0 Coefficient ................................. 246
Modicon 984 PLC ....................295, 299, 302 NGL K1 Coefficient ................................. 246
Modicon Compatibility .............................385 NIST 1045....................................... 189, 215
Modicon Compatible .. 56, 60, 370, 385, 392, NIST 1048............................................... 255
423, 426, 470 NIST14
Modules ... 17, 18, 19, 20, 30, 36, 37, 38, 39, analyzed ...................................... 246, 255
40, 41, 42, 43, 44, 55, 60, 75, 77, 89, 95, NIST14............................................ 106, 215
100, 102, 106, 126, 127, 130, 173, 175, NIST14.................................................... 246
181, 182, 185, 262, 282, 378, 413, 463 NIST14.................................................... 255
Modulus NIST14.................................................... 264
Elasticity ...............................................160 NIST14 Analysis Basis ................... 246, 255
Modulus ...................................................160 NIST14 Component ................................ 264
Mole Deviation .........................................266 NIST14 Component Analysis.. 215, 254, 264
Mole Fraction NIST14 Reference Pressure................... 246
Propylene .....................189, 215, 238, 246 NMI Gross Volume.................................. 123
Mole Fraction ...........................................189 Nmi K-Factor........................................... 123
Mole Fraction ...........................................215 Non-Master Meter Proving...................... 162

504
Index

Normal Mode String.................................313 Online...................................................... 487


NOT Online...................................................... 490
denoting ...............................................282 Online menu.................................... 395, 402
NOT ...........................................................10 Online Toolbar ........................................ 485
NOT .........................................................282 Open
NOT .........................................................287 want ..................................................... 432
Nuisance Alarm Timer ...............................10 Open ....................................................... 432
number convertor.....................................391 Operate
Numeric’...................................................336 made ................................................... 325
O plenum pressure needed .................... 186
Observed Density Operate ............. 1, 31, 75, 97, 140, 141, 144
Table 53D Generalized Lubricating Oils Operate ................................................... 186
Correction .........................................215 Operate ................................................... 189
Observed Density ....................................215 Operate ................................................... 204
OFF..............................................21, 23, 282 Operate ................................................... 215
Official Ticket ...........................................353 Operate ................................................... 266
Official, Unofficial .....................................164 Operate ................................................... 275
Offline .... 330, 332, 335, 360, 361, 401, 402, Operate ................................................... 293
403, 413, 485 Operate ................................................... 306
Offline Toolbar .........................................485 Operate ................................................... 319
OKI DATA ................................................313 Operate ................................................... 325
OMNI beeper ...........................................380 Operate ................................................... 338
OMNI display ...................................381, 383 Operate ................................................... 343
Omni Flow Computer... 60, 89, 95, 100, 102, Operate ................................................... 401
473, 488 Operate ................................................... 411
Omni I/O .... 1, 2, 17, 19, 30, 31, 45, 46, 126, Operate ................................................... 485
127, 130, 173, 175, 181, 182, 185, 262 Operate Menu ......................................... 306
Omni Keypad Operators ........................................ 282, 287
Show/Hide....................................382, 384 OR................................................... 282, 306
Omni Keypad ...........................................381 Order
Omni Keypad ...........................................382 Precedence ......................................... 287
Omni Keypad ...........................................384 Order ....................................................... 287
OMNI LED ...............................................379 Orifice..... 10, 27, 78, 79, 81, 85, 87, 88, 105,
OMNI Panel .....................380, 381, 383, 384 106, 144, 279
OmniCom DOS...... 357, 358, 359, 361, 362, Orifice Applications ........................... 78, 106
363, 364, 365, 366, 367, 437 Orifice DP............................................ 79, 85
OmniCom DOS file ..................394, 437, 485 Orifice DP Meter ........................... 81, 87, 88
OmniCom Help ............................................1 Orifice Inside Diameter ............................. 81
OmniCom Logo Bar .................................488 Orifice Plate Meter .................................. 27
ONE SHOT ......................................282, 287 Orifice Plate Taps ..................................... 81
Online Orifice Reference Temperature ................ 81
Apply button .........................................487 Orifice/Venturi Expansion Coefficients ..... 81
Omni 3000/6000...................................330 Override .................................... 31, 238, 242
Online ..........................................3, 279, 314 Override Code.. 54, 126, 127, 172, 173, 175,
Online ......................................................330 181, 182, 185, 262
Online ......................................................332 Override Value . 54, 126, 127, 172, 173, 175,
Online ......................................................335 181, 182, 185, 262
Online ......................................................361 Overtravel ............................................... 162
Online ......................................................378 Overtravel Forward Direction ................ 23
Online ......................................................385 Overtravel Reverse Direction ................ 23
Online ......................................................391 P
Online ......................................................400 Packed Coils ........................................... 327
Online ......................................................401 Packet Point Count ................................. 293
Online ......................................................402 Packet Point Number .............................. 293
Online ......................................................406 Packets ............................................. 69, 306
Online ......................................................452 page down .............................................. 379

505
OmniCom Help

page up....................................................379 Point Number .................. 27, 309, 310, 312


Panasonic ................................................313 Points
panel ........................................................381 Num ..................................................... 327
parity ..................................58, 360, 397, 423 Points .............................. 282, 295, 299, 302
Partial Counter.........................................355 Points ...................................................... 327
Partial Status ...........................................355 Points ...................................................... 385
Partial Toggle...........................................355 port
Passes Special Settings..................................... 56
Number ................................................164 port ............................ 1, 2, 18, 31, 43, 44, 55
Passes .....................................................164 port ............................................................ 56
password .................................400, 490, 491 port ............................................................ 58
Paste Command ......................................418 port ............................................................ 59
PC beeper................................................380 port ............................................................ 60
PC Keyboard port ............................................................ 75
Use.......................................................379 port ............................................................ 77
PC Keyboard ...........................................379 port ............................................................ 89
PD Meters................................................139 port ............................................................ 95
PD meters flow pulses .............................106 port .......................................................... 100
Peer port .......................................................... 102
Peer......................................................324 port .......................................................... 266
Peer Setup ...........................................325 port .......................................................... 293
Peer .......................................................2, 75 port .......................................................... 295
Peer .........................................................324 port .......................................................... 299
Peer .........................................................325 port .......................................................... 302
Peer .........................................................327 port .......................................................... 308
Peer/Peer Active Flag ..............................23 port .......................................................... 313
Phone Number.........................................423 port .......................................................... 324
Physical ...................... 81, 85, 87, 88, 92, 93 port .......................................................... 325
Physical Digital I/O Points .......................282 port .......................................................... 360
Physical input channel port .......................................................... 363
Select ...................................................106 port .......................................................... 397
Physical input channel .............................106 port .......................................................... 401
PID Control ... 2, 27, 270, 271, 273, 275, 325 port .......................................................... 404
PID deadband..........................................275 port .......................................................... 423
PID Functions port .......................................................... 426
chart .....................................................273 port .......................................................... 463
PID Functions ..........................................273 port .......................................................... 465
PID Loop Configuration ...................270, 271 port .......................................................... 467
PID Loop Ramp Control ..........270, 273, 275 port .......................................................... 480
PID Loop Tuning..............................270, 275 port .......................................................... 490
PID Permissive Port ethernet ............................................. 60
manipulate............................................273 Port number .............................................. 31
PID Permissive.........................................27 Port Options ............................................ 313
PID Permissive ........................................273 POWER .................................................. 287
PID Setpoint...............................................31 Precedence
PID Start ..................................................273 Order ................................................... 287
Ping..........................................................463 Precedence............................................. 287
Pipe Expansion Coefficients......................81 preferences ............................................. 419
Pipe Inside Diameter .................................81 Premium Billing ....................................... 329
Pipe Reference Temperature ....................81 Pressure... 10, 23, 27, 31, 34, 41, 42, 44, 46,
PLC ................. 295, 299, 302, 310, 324, 325 54, 81, 87, 88, 93, 105, 106, 127, 129,
Plenum Charge Command......................23 135, 137, 138, 144, 153, 155, 156, 157,
Plenum Deadband ...................................186 160, 162, 164, 170, 175, 176, 179, 180,
Plenum Pressure .....................157, 185, 186 182, 185, 186, 189, 204, 215, 230, 238,
Plenum Vent Command ..........................23 242, 246, 250, 255, 270, 287, 295, 299,
Point Count ..............................309, 310, 312 302, 306, 310

506
Index

Pressure Compensation ..189, 204, 215, 230 230, 238, 242, 246, 250, 253, 254, 255,
Pressure High Alarm ...............................23 262, 266, 273, 275, 279, 318, 319, 321,
Pressure limits 332, 345, 347, 349, 351, 354, 356, 359,
API 11.3.2 ............................................189 361
Pressure limits .........................................189 program................................................... 379
Pressure limits .........................................287 Program Mode ........................................ 379
Pressure Low Alarm ................................23 program version ...................................... 444
Pressure Override ...................................23 Programmable ................................ 281, 287
Pressure Override Value ...54, 127, 182, 185 Programmable Variable .......................... 277
Pressure Pe .....................189, 204, 215, 230 protocol .... 31, 41, 42, 43, 44, 55, 56, 58, 60,
Pressure signal 102, 266, 327, 385, 392, 426, 452, 470
prover ...................................................182 Protocol Format ...................................... 426
Pressure signal ........................................106 protocol tester ......................................... 385
Pressure signal ........................................182 Protocol Type............................................ 56
Pressure Units ...........................................10 PROVE ..................................................... 15
Primary Element ................81, 87, 88, 92, 93 Prove Report.... 15, 106, 164, 169, 332, 361,
Primary Measurement Source.........100, 102 367
Primary Setpoint ......................................271 Prove Report Decimal Places................... 15
Print Buffer Full Flag ...............................23 Prover
Print Interval.............................................313 Plenum Pressure signal ...................... 185
Print Interval In Minutes ...........................313 pressure signal .................................... 182
Print Interval Start Time...........................313 Prover .. 1, 2, 8, 23, 27, 31, 34, 38, 106, 157,
Print Priority .............................................313 159, 160, 162, 164, 167, 169, 170, 171,
Printer .... 2, 8, 55, 56, 58, 75, 313, 330, 332, 172, 173, 175, 176, 178, 179, 180, 181
340, 360, 428, 440 Prover ..................................................... 182
Printer Code.............................................332 Prover ..................................................... 185
Printer Code’............................................340 Prover ..................................................... 186
Printer Condensed...................................313 Prover ..................................................... 282
Printer Type .............................................313 Prover ..................................................... 310
Printing Prover ..................................................... 313
Boolean ................................................336 Prover ..................................................... 314
Printing.....................................................336 Prover ..................................................... 344
Printing.....................................................440 Prover ..................................................... 354
Process I/O Prover ..................................................... 485
modify. 126, 127, 130, 134, 150, 181, 182, Prover Auto Prove Setup ........................ 167
185 Prover Characteristics .................... 158, 160
Process I/O ........................17, 30, 31, 45, 46 Prover Control................................. 354, 485
Process I/O ..............................................126 Prover Counts ......................................... 310
Process I/O ..............................................127 Prover densitometer.......................... 31, 170
Process I/O ..............................................130 Prover Density - Sarasota Pulse............. 179
Process I/O ..............................................134 Prover Density - Solartron Gas Pulse..... 178
Process I/O ..............................................150 Prover Density - UGC Pulse ................... 180
Process I/O ..............................................181 Prover Density Configuration dialog ...... 176,
Process I/O ..............................................182 178, 179, 180
Process I/O ..............................................185 Prover Density Sarasota ......................... 179
Process Input Assignments .......................47 Prover Density Solartron Gas ................. 178
Process Inputs30, 31, 36, 37, 38, 39, 40, 41, Prover Density Solartron Liquid .............. 176
42, 44, 47, 238, 246 Prover Density UGC ............................... 180
Process IO .................................................30 Prover Inlet/Outlet Pressure dialog......... 182
Product File......................164, 356, 359, 361 Prover Inlet/Outlet Temperature dialog .. 181
Product Name..........................188, 347, 349 Prover Internal Diameter......................... 160
Product number .......................................318 Prover Manufacturer ............................... 169
Product running .......................................106 Prover Material........................................ 169
Product Type ...................................189, 215 Prover Meter Ticket Report..................... 313
Products1, 2, 23, 27, 81, 106, 139, 140, 141, Prover Operational Setup ....................... 164
143, 164, 172, 187, 188, 189, 204, 215, Prover Run Setup ................................... 164

507
OmniCom Help

Prover Serial Number ..............................169 Redlich-Kwong........................................ 255


Prover Setup................................8, 157, 158 Redundancy Mode.................................. 325
Prover Tag Number .................................169 Reference conditions ...................... 238, 242
Prover tube Reference Density
inside diameter measurement..............160 use....................................................... 246
Prover tube ..............................................160 Reference Density .................................. 246
Prover Tube Cubical Coefficient Reference Density Override ........... 246, 250
Thermal Expansion ..............................160 Reference Density Range kg/m3.... 215, 230
Prover Tube Cubical Coefficient..............160 Reference temperature ............. 81, 246, 250
Prover Type .....................................158, 159 Register List ............................................ 388
Prover Volume/Mass .......................158, 162 Relative Density ........ 34, 189, 204, 215, 230
Prover Wall Thickness.............................160 release notes .................................. 443, 444
Pulse Fidelity ...........................................106 Remote Inputs....................................... 8, 48
Pulse Input Remote Setpoint I/O Assignment ........... 271
Pulse - Select ...............................100, 102 Remote UP Arrow Function ................... 27
Pulse Input...............................................100 Repeat Delay .......................................... 388
Pulse Input...............................................102 Repeat/Min.............................................. 275
Pulse Outputs ......................................19, 21 Report Formatting Controls .................... 332
Pulse Signal Report Setup....................................... 2, 314
K-factor Curve ..................................86, 99 Report String........................................... 313
Pulse Signal...............................................86 Report Template Editor...... 1, 332, 435, 437,
Pulse Signal...............................................99 438, 439
Pulse Width ..............................................21 Report template files ............................... 485
Pulse/unit..........................................21, 277 Report Templates ...... 1, 314, 332, 335, 336,
Pulses per unit 338, 341, 342, 435, 437, 438, 439, 485
number .................................................123 Report View .................................... 332, 341
Pulses per unit .........................................123 Reports
Pulses/unit........................................21, 277 Conditional Printing Data .................... 332
Pycnometer..............................................172 Time Span ........................................... 332
Q Reports ..................................... 60, 255, 321
Q-Sonic Ultrasonic Gas Flowmeter ...........89 Reports ................................................... 332
R Reports ................................................... 360
Ramp Hold...............................................273 Reports ................................................... 361
Ramp Up Reports folder
Setpoint ................................................273 file under.............................................. 330
Ramp Up..................................................273 Reports folder ......................................... 330
RANGE CHECKING ................................287 Reports/Archive ...................................... 361
Raw Report..............................................342 Results Interval ....................................... 266
Raw view .........................................332, 342 Retransmit................................................. 69
RAZ..........................................................355 Retrieve Archive Data ..................... 343, 368
READ.......................................295, 299, 302 retry count ............................... 100, 102, 423
Read Blocks 1-3 ..............................308, 310 Retry Timer ............................. 100, 102, 325
Read Coil Status......................................392 Reverse............................... 89, 95, 100, 102
Read configuration ..........................401, 407 Reverse GOTOs ..................................... 282
READ ONLY ..............................................13 Reynolds Number
Read/Write.......................295, 299, 302, 327 remaining............................................... 94
readme.....................................................444 values .................................................... 94
Receipt Ticket ..........................................353 Reynolds Number ..................................... 94
receive .....................................385, 407, 485 RISING EDGE ................................ 282, 287
Receive Message ....................................385 RJ45.......................................................... 77
RED LED .........................................480, 489 Roll All Totalizers ...................................... 13
redial wait.........................................398, 425 Rosemount................ 31, 43, 44, 79, 87, 105
Redialing..................................................425 Rosemount 3095FB DP Meter.................. 87
Redlich-Kwong Rosemount 3095FB multivariable............. 31
inputs....................................................255 Rotor
Redlich-Kwong...........................................10 Sensing ................................................. 97

508
Index

Rotor ..........................................................97 SeniorSonic............................................. 100


RS-232 Sensing
shows .....................................................75 Rotor...................................................... 97
RS-232.......................................................75 Sensing ..................................................... 97
RS-232.......................................................77 Sequence........................................ 279, 325
RS-232.....................................................465 Serial - Select Serial Data............... 100, 102
RS-232/RS-485 .........................................55 Serial Communications ........................... 462
RS-232/RS-485 port ..................................77 Serial Modules .............................. 60, 75, 77
RS-485 Serial Password .............................. 405, 470
jumpered ................................................75 Serial Port ................. 56, 293, 308, 313, 324
RS-485.................................................43, 44 Serial/Ethernet .......................................... 18
RS-485.......................................................75 Setpoint
RS-485.....................................................465 Ramp Up ............................................. 273
RS-485 2-wire..........................................465 Setpoint................................................... 271
RS-485 4-wire..........................................465 Setpoint................................................... 273
Rtd .............................. 31, 54, 126, 173, 181 Setpoint Blocks ............................... 308, 312
RTU .......... 56, 266, 295, 299, 302, 392, 426 Setup Communications Screen ..... 385, 396,
RTU protocol..............................................56 397, 398, 399, 422, 423
Run Repeatability ....................................164 Setup menu............................................. 396
Run Switching..................................140, 144 Setup Modem Screen ............. 398, 423, 425
S Setup PC beeper .................................... 380
S&W.....................................................31, 34 Setup Screen .............. 6, 238, 242, 246, 250
S/N ...........................................................106 Setup Sites.............. 414, 422, 423, 465, 467
Sample Time....................................143, 164 Setup Sites Screen ......... 396, 397, 398, 399
Sarasota ..............................31, 40, 148, 170 Setup Unit ....................................... 426, 465
Sarasota Densitometer ............137, 155, 179 Setup Unit Screen........................... 399, 423
Sarasota Pulse ........................................148 SHIFT+F1 ............................................... 450
Satellite .. 397, 398, 401, 402, 422, 423, 425, Shutdown Ramp ..................................... 273
426, 480, 485 Signal Type ............................................... 31
Save site .......................................... 395, 396, 402
use .......................................................436 Site name
Save.........................................................436 Shows.................................................. 360
Save.........................................................485 Site name................................................ 360
Save As ...................................428, 436, 485 Site Screen ............................................. 467
Save As Command..........................434, 436 sites......................................... 397, 422, 423
Save As dialog.................433, 434, 436, 485 Slave
scan rate ..................................423, 426, 480 Modbus ID number.............................. 327
Scratch Pad Booleans .............................282 Slave ....................................................... 327
Scroll bars................................................478 Snapshot...... 15, 23, 27, 282, 287, 306, 314,
scrollbars .................................................478 332, 335, 356, 357, 361, 364, 370
SE Firmware ............................................463 Snapshot Report ..................................... 356
SE Modules .....................55, 60, 69, 77, 463 software version...................................... 444
Secondary Setpoint .................................271 Solartron .... 31, 40, 135, 136, 148, 153, 154,
Sediment & Water......................................34 176, 178, 262
Send Solartron Density Pulse . 135, 136, 153, 154,
ASCII....................................................313 176, 178
CRC .....................................................385 Solartron Gas.......................................... 170
Modbus .................................................27 Solartron Gas Densitometer Constants . 154,
Omni.....................................................489 178
Send ..........................................................27 Solartron Gas Densitometer Factors ...... 136
Send ........................................................313 Solartron Liquid....................................... 170
Send ........................................................385 Solartron Liquid Densitometer Constants
Send ........................................................408 ............................................. 135, 153, 176
Send ........................................................489 Solartron Pulse ....................................... 148
SeniorSonic Source Index........................................... 327
compared .............................................100 Special Billing Threshold ........................ 329

509
OmniCom Help

Specific Gravity Station End Batch ................................... 27


value.............................................189, 204 Station High Flow Alarm ......................... 141
Specific Gravity..........................................34 Station Information.................................. 141
Specific Gravity........................................189 Station Low Flow Alarm .......................... 141
Specific Gravity........................................204 Station Setup .. 140, 141, 319, 345, 349, 351
Specific Gravity........................................238 Station Setup Totals ....................... 345, 349
Specific Gravity........................................242 Station Totals .................. 140, 141, 319, 351
Specific Gravity........................................255 statistics .................................................. 454
Stability Check .........................................164 status bar ........................ 332, 451, 456, 480
Stainless ............................................92, 160 Status flags ............................................. 282
Stainless Steel ...................................81, 160 stop bits
Start Up....................................................273 Number................................................ 480
Startup Mode ...........................................275 stop bits............................. 58, 360, 397, 423
Startup Permissive ..................................27 stop bits................................................... 480
Startup Ramp...........................................273 Stop' Ramp Down
Startup/shutdown ....................................27 Fully Closed......................................... 273
Statements...............................................281 Stop' Ramp Down ................................... 273
Station String
alarm limits ...........................................140 sent...................................................... 425
Batch Preset Warning ..........................141 Size ..................................................... 385
Station......................... 1, 2, 8, 21, 23, 27, 31 String....................................... 295, 299, 302
Station......................................................140 String....................................................... 385
Station......................................................141 String....................................................... 425
Station......................................................143 Subnet Mask ............................................. 60
Station......................................................144 SUBTRACT............................................. 287
Station......................................................148 Sugar Land ..................................... 473, 488
Station......................................................150 SV
Station......................................................152 Daniel Ultrasonic ................................. 100
Station......................................................153 FLOWSIC 600 Ultrasonic .................... 102
Station......................................................154 FMC MPU 1200..................................... 95
Station......................................................155 Instromet Ultrasonic .............................. 89
Station......................................................156 SV ................................................. 31, 43, 44
Station......................................................170 SV ............................................................. 89
Station......................................................172 SV ............................................................. 95
Station......................................................277 SV ........................................................... 100
Station......................................................282 SV ........................................................... 102
Station......................................................310 SV ........................................................... 106
Station......................................................313 SV combo module provides ...................... 43
Station......................................................318 SV Combo Modules ... 30, 31, 43, 44, 54, 89,
Station......................................................319 95, 106, 126, 173, 181
Station......................................................329 SV Modbus ID................................. 100, 102
Station......................................................345 SV module .............................................. 463
Station......................................................347 SV Port.......................... 31, 89, 95, 100, 102
Station......................................................349 SV Port Number........................................ 31
Station......................................................351 switch bar temperature ........................... 183
Station......................................................379 System Date ........................................... 3, 6
Station Alarms/Status Points .................23 System Maximize Command .................. 482
Station Density - Sarasota Pulse.............155 System Minimize Command ................... 483
Station Density - Solartron Gas Pulse .....154 System Time ........................................... 3, 7
Station Density - UGC Pulse ...................156 T
Station Density Configuration dialog ......153, TAB ......................................................... 379
154, 155, 156 Tab’ ......................................................... 332
Station Density Sarasota .........................155 Table 23A
Station Density Solartron Gas .................154 limits .................................................... 189
Station Density Solartron Liquid ..............153 Table 23A................................................ 189
Station Density UGC ...............................156 Table 23A................................................ 204

510
Index

Table 23A Generalized Crude Oils..189, 204 Target Slave ID ....................................... 327
Table 23A Modified..................................189 TCP................................................. 360, 426
Table 23A/24A .................................189, 204 TCP Port ......................................... 423, 480
Table 23B ........................................189, 204 TCP/IP ..... 69, 360, 397, 401, 402, 422, 423,
Table 23B Refined Products............189, 204 426, 480, 485
Table 23B/24B .................................189, 204 TCP/IP Connections ....................... 423, 426
Table 24A TCP/IP initial character delay ................. 423
selecting .......................................189, 204 Techsupport@omniflow.com .......... 473, 488
Table 24A ................................................189 Telnet ...................................................... 463
Table 24A ................................................204 Temperature 41, 42, 44, 126, 189, 204, 215,
Table 24A Generalized Crude Oils..189, 204 230, 295, 299, 302
Table 24A Modified..................................189 Temperature High Alarm........................ 23
Table 24B ........................................189, 204 Temperature Low Alarm......................... 23
Table 24B Refined Products............189, 204 Temperature Override Value .......... 126, 181
Table 24C ........................189, 204, 238, 242 Temperature Range........ 189, 204, 215, 230
Table 24E ................................................189 Temperature, deg.C........................ 215, 230
Table 53 Crude Oil...........................215, 230 Temperature, deg.F ........................ 189, 204
Table 53/54A ...................................215, 230 Template Editor....................................... 332
Table 53A Terminal .................................................... 53
limits .....................................................215 Test Comms Screen ....................... 391, 392
Table 53A ................................................215 test communications ....................... 377, 385
Table 53A ................................................230 Test Communications Screen................. 385
Table 53A Generalized Crude Oils..215, 230 Test message ......................................... 385
Table 53A Modified..................................215 Text Archive .................................... 368, 369
Table 53B ........................................215, 230 Thermal........................................... 189, 215
Table 53B Refined Products............215, 230 Thermal Expansion
Table 53B/54B .................................215, 230 prover Tube Cubical Coefficient.......... 160
Table 53D Generalized Lubricating Oils Thermal Expansion ................................... 81
Correction Thermal Expansion ................................. 160
Observed Density.................................215 Threshold ........................................ 167, 329
Table 53D Generalized Lubricating Oils Threshold %DP....................................... 144
Correction.............................................215 Threshold Settings .................................. 329
Table 53D/54D.........................................215 Ticket number
Table 54 Crude Oil...........................215, 230 appended ............................................ 353
Table 54A Ticket number ......................................... 353
selecting .......................................215, 230 Tile command ......................................... 459
Table 54A ................................................215 time difference ........................................ 452
Table 54A ................................................230 Time Span
Table 54A Generalized Crude Oils..215, 230 Reports ................................................ 332
Table 54A Modified..................................215 Time Span............................................... 332
Table 54B ........................................215, 230 Time Weighted.......................................... 10
Table 54B Refined Products............215, 230 Timed Out ............................................... 465
Table 54C ........................215, 230, 246, 250 Timeout ................................................... 425
Table 54D ................................................215 TIMER COMPARE.................................. 282
Table 54D Generalized Lubricating Oils TIMER FUNCTION ................................. 282
Correction timing .............................................. 397, 423
Volume .................................................215 Title Bar................................... 482, 483, 484
Table 54D Generalized Lubricating Oils To Edit Serial Passwords........................ 400
Correction.............................................215 toolbar
Table 54E ................................................215 File’ menu............................................ 332
Table Range ....................189, 204, 215, 230 toolbar ..................................................... 332
Table Select.....................189, 204, 215, 230 toolbar ..................................................... 415
Tables 23E...............................................189 toolbar ..................................................... 416
Tables 53E...............................................215 toolbar ..................................................... 417
Tag ID ........................................................31 toolbar ..................................................... 418
Tag number using....................................169 toolbar ..................................................... 431

511
OmniCom Help

toolbar ......................................................432 Trouble Shooting Serial Communications


toolbar ......................................................434 ............................................................. 465
toolbar ......................................................450 True................................................. 282, 336
toolbar ......................................................451 Turbine/PD.......................................... 79, 86
toolbar ......................................................456 U
toolbar ......................................................457 UGC .......................................... 40, 148, 170
toolbar ......................................................485 UGC densitometer constants.. 138, 156, 180
Total Counts ............................................164 UGC Densitometers.................................. 31
TOTALIZE................................................287 UGC Density Pulse ................. 138, 156, 180
Totalizer Ultrasonic flowmeter tube ......................... 92
position.................................................287 Ultrasonic FMC Kongsberg....................... 95
Totalizer .....................................................13 Ultrasonic Instromet
Totalizer ...................................................287 K-Factor Curve ...................................... 89
Totalizer ...................................................329 Ultrasonic Instromet .................................. 89
Totalizer Decimal Places ...........................13 Un-Adj Set................................................. 97
Totalizers 3, 13, 95, 100, 102, 141, 287, 321, Un-Adjust Selection .................................. 97
329, 345, 347, 349 Un-Adjusted
TP 27 ...............................189, 204, 215, 230 Disable .................................................. 97
TP15 Enable ................................................... 97
Refer ............................189, 204, 215, 230 Un-Adjusted .............................................. 97
TP15 ........................................................189 Uncorrected IV ................................ 347, 349
TP15 ........................................................204 Unidirectional Reports ............................ 164
TP15 ........................................................215 Unit Name ....................................... 426, 480
TP15 ........................................................230 Units
TP15 ........................................................238 description ........................................... 426
TP15 ........................................................242 following .............................................. 123
TP15 ........................................................246 Units ........................................................ 123
TP15 ........................................................250 Units ........................................................ 426
TP16 ................................................189, 204 Unpacking Booleans ............................... 282
TP16M .............................................215, 230 UP/DOWN............................................... 271
Transaction Group ...........................324, 327 updates ................................................... 444
Transducer.................................................31 US Robotics ............................................ 467
Transducer Density .................................106 Use BS&W .............................................. 106
Transmit Use Common Batch Stack...................... 319
Omni.....................................264, 335, 406 Use Default ............................................. 314
Transmit...................................................264 Use Default Precision’ ............................ 338
Transmit...................................................293 Use Downstream Pressure....................... 81
Transmit...................................................335 Use GC2 on GC1.................................... 266
Transmit...................................................385 Use LCF.................................................. 139
Transmit...................................................406 Use Live Density ............................. 106, 215
Transmit...................................................408 Use Meter Factor .................................... 106
Transmit...................................................485 Use Observed Density.................... 238, 246
Transmit Message ...................................385 Use Upstream Temperature ..................... 81
Transmit Omni Configuration...................376 User ........................................................ 404
Trapil Alarms & Traning ...........................146 User Defined ........................................... 385
Trapil Control ...........................................355 USER DEFINED ALARM MESSAGES .. 282
Trigger User Displays...................................... 2, 279
500ms ..................................................287 user message ......................................... 383
archive save event ...............................306 User Messages ....................... 379, 383, 384
Trigger .....................................................287 User Notes ...................................... 443, 445
Trigger .....................................................306 User Programmable Accumulators....... 21
Trouble Shooting .............................462, 473 User Variable .......................................... 287
Trouble Shooting Ethernet Communications Using Help command ............................. 449
.............................................................463 V
Trouble Shooting Modem Connections ...467 Value @ 20mA.......................................... 34
Value @ 4mA............................................ 34

512
Index

Van-der-Waals EOS ................................255 Band High Limit ..................................... 97


Variable....................................................281 Band Low Limit...................................... 97
Variable Assignment................................271 WARNING................................................. 58
Variable Statements ............................2, 287 WARNING................................................. 97
VCF 106, 189, 204, 215, 230, 238, 242, 246, WARNING............................................... 376
250 WARNING............................................... 423
V-Cone.............................79, 85, 93, 94, 105 Water
V-Cone Flow Coefficients ..........................94 measuring.................................... 238, 246
V-Cone meter ......................................93, 94 Weight ................................................. 189
Venturi .......................................................81 Water ........................................................ 10
version .....................................................444 Water ...................................................... 189
Version 2003..............................................81 Water ...................................................... 238
View Communications Log ......382, 384, 452 Water ...................................................... 246
View Omni Keypad ..................................381 Water Content......................................... 255
View RS-232 Connections.........................75 Welcome ..................................................... 1
View RS-485 Connections.........................75 West Airport Blvd ............................ 473, 488
View Toolbar command...........................457 Width’ ...................................................... 338
Viewing Options.......................................332 Window menu
Virtual Inputs..............................................45 Use ...................................................... 432
Viscosity Linearization .......................86, 139 Window menu ......................................... 432
Volume Correction Factor189, 204, 215, 230 Window menu ......................................... 458
Volume Units .............................................10 WINDOW TILE........................................ 459
Volume/Mass ...........................................162 WinPanel......... 377, 379, 382, 384, 401, 485
Volumetric................................................123 WinPanel Menu....................................... 382
VOS .....................................89, 95, 100, 102 WinPanel User Menu .............................. 384
VOS Deviation ...........................95, 100, 102 Write................................ 287, 295, 299, 302
VSAT communications ..............................69 WRITE ASCII STRING ........................... 287
VSAT Systems.........................................293 WRITE ASCII STRING Operator ............ 287
W Z
WARNING Zero Scale.. 31, 54, 126, 127, 172, 173, 175,
Band.......................................................97 181, 182, 262, 271

513

Potrebbero piacerti anche