Reference Guide
D301521X412
24-Feb-2010
OpenEnterprise Schema
Bristol OpenEnterprise Reference Guide
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 2
OpenEnterprise Schema
Contents
1 OpenEnterprise Schema.......................................................................................................13
Hint:............................................................................................................................................. 13
2 Tables......................................................................................................................................14
abcomplex................................................................................................................................... 14
abdevice...................................................................................................................................... 15
abdevicehealthalarmcondition ....................................................................................................19
abdigital....................................................................................................................................... 20
abdriver ....................................................................................................................................... 21
abintegeranalog .......................................................................................................................... 24
abnetwork ................................................................................................................................... 25
abpolllist...................................................................................................................................... 27
abrealanalog ............................................................................................................................... 30
accessarea.................................................................................................................................. 31
accessareaconfig........................................................................................................................ 33
accessareaconfigforuser............................................................................................................. 34
adminuser ................................................................................................................................... 35
alarmcondition ............................................................................................................................ 36
alarmconditionlookup.................................................................................................................. 44
alarminhibitalarmcondition .......................................................................................................... 45
alarminhibitstatealarmcondition .................................................................................................. 46
alarmmailformat .......................................................................................................................... 47
alarmpagingformat...................................................................................................................... 48
alarmpagingrecipient ..................................................................................................................49
alarmpattern................................................................................................................................ 50
alarmpriorityblock........................................................................................................................ 53
alarmrecipient .............................................................................................................................58
alarmredirection .......................................................................................................................... 60
alarmredirectiontimer .................................................................................................................. 64
alarmresponseaction .................................................................................................................. 65
alarmresponseactionemail.......................................................................................................... 66
alarmresponseactiongroup ......................................................................................................... 67
alarmsummary ............................................................................................................................ 68
alarmsuppressiontimer ............................................................................................................... 80
arbitrator...................................................................................................................................... 81
archivebackupitem...................................................................................................................... 82
archivebackupset........................................................................................................................ 84
archivecatalogue......................................................................................................................... 86
archivefile.................................................................................................................................... 90
archiveindex................................................................................................................................ 92
attributes ..................................................................................................................................... 94
attributetrigger............................................................................................................................. 97
autologouttimer ......................................................................................................................... 100
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 3
OpenEnterprise Schema
backupline................................................................................................................................. 103
backuplinestats .........................................................................................................................109
binarysignal............................................................................................................................... 112
breakpoint .................................................................................................................................114
bsapline..................................................................................................................................... 116
calculation ................................................................................................................................. 121
calculationcallbacktimer............................................................................................................ 125
calculationstatusalarmcondition................................................................................................ 126
calendarevents ......................................................................................................................... 127
calendareventsfordiary .............................................................................................................129
clcontrol..................................................................................................................................... 131
column_privileges .....................................................................................................................132
connection_config..................................................................................................................... 134
controlcurve .............................................................................................................................. 135
currentuser................................................................................................................................ 136
databasereplication................................................................................................................... 137
databasetimestatus................................................................................................................... 139
dataconnection ......................................................................................................................... 141
dataquery.................................................................................................................................. 146
dataquerymonitor...................................................................................................................... 148
dataservice................................................................................................................................ 149
datetimearchiveindex................................................................................................................150
dbcontrol ...................................................................................................................................151
devicestatscallbacktimer........................................................................................................... 152
diary .......................................................................................................................................... 153
digital......................................................................................................................................... 159
digitalalarmcondition ................................................................................................................. 161
digitalchangetonullalarmcondition ............................................................................................ 162
digitaldelayalarmcondition ........................................................................................................163
digitaldelaytimer........................................................................................................................ 164
digitalsignaltrigger..................................................................................................................... 165
digitalstatealarmcondition ......................................................................................................... 166
dstinformation ........................................................................................................................... 167
dsttimer ..................................................................................................................................... 169
dvi_datum ................................................................................................................................. 171
dvi_device................................................................................................................................. 174
dvi_driver ..................................................................................................................................178
dvi_network............................................................................................................................... 181
dvi_region ................................................................................................................................. 183
dvi_remote_driver ..................................................................................................................... 184
dvi_schedule............................................................................................................................. 186
emailserver ............................................................................................................................... 188
eventhistory .............................................................................................................................. 191
eventlog .................................................................................................................................... 201
eventperiods ............................................................................................................................. 211
eventreplication......................................................................................................................... 213
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 4
OpenEnterprise Schema
exception................................................................................................................................... 216
exceptionhandler ...................................................................................................................... 217
exclusions ................................................................................................................................. 218
expirywarningtime..................................................................................................................... 219
ftpserver .................................................................................................................................... 220
groups ....................................................................................................................................... 222
indexattrs .................................................................................................................................. 224
indexes...................................................................................................................................... 226
integeranalog ............................................................................................................................ 228
integeranalogalarmcondition..................................................................................................... 230
integeranalogchangetonullalarmcondition................................................................................ 231
integeranalogchangevaluealarmcondition ................................................................................ 232
integeranalogdeviationalarmcondition ...................................................................................... 233
integeranalogequalsalarmcondition.......................................................................................... 234
integeranaloglimitalarmcondition .............................................................................................. 235
integeranalograteofchangealarmcondition ...............................................................................236
integeranalogsignalalarmcondition ........................................................................................... 238
integeranalogsignaltrigger ........................................................................................................ 239
integerarchiveindex................................................................................................................... 240
ipline.......................................................................................................................................... 241
journalalarmcondition................................................................................................................ 243
journalcontrol ............................................................................................................................ 244
journalequalalarmcondition....................................................................................................... 246
journalrangealarmcondition ......................................................................................................247
journaltask................................................................................................................................. 248
klaxon........................................................................................................................................ 251
line ............................................................................................................................................254
localdigital ................................................................................................................................. 257
localintegeranalog..................................................................................................................... 259
localmultidigital2 ....................................................................................................................... 261
localmultidigital3 ....................................................................................................................... 263
localmultidigital4 ....................................................................................................................... 264
localrealanalog.......................................................................................................................... 265
localstringsignal ........................................................................................................................ 267
localtimesignal ..........................................................................................................................269
lockouttimer............................................................................................................................... 271
logaccess.................................................................................................................................. 272
logarchive.................................................................................................................................. 275
logcolumn.................................................................................................................................. 278
logcontrol .................................................................................................................................. 281
logdata ...................................................................................................................................... 285
logextract .................................................................................................................................. 290
loghistory...................................................................................................................................293
loghistory...................................................................................................................................295
logobject.................................................................................................................................... 297
logworker .................................................................................................................................. 298
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 5
OpenEnterprise Schema
mailformat
memoryalarmcondition .............................................................................................................301
memorymonitor......................................................................................................................... 302
memorymonitorcallbacktimer.................................................................................................... 304
multidigital2............................................................................................................................... 305
multidigital3............................................................................................................................... 307
multidigital4............................................................................................................................... 308
multistatedigitalalarmcondition.................................................................................................. 309
notes ......................................................................................................................................... 310
notesalarmcondition.................................................................................................................. 315
nw3000alarmprioritymap ..........................................................................................................316
nw3000analogpolllist ................................................................................................................317
nw3000archive.......................................................................................................................... 318
nw3000audit .............................................................................................................................320
nw3000device........................................................................................................................... 322
nw3000devicecommunicationalarmcondition........................................................................... 342
nw3000devicestatusalarmcondition.......................................................................................... 343
nw3000deviceversionalarmcondition........................................................................................ 344
nw3000digital............................................................................................................................ 345
nw3000digitalalarmcondition ....................................................................................................350
nw3000digitalpolllist.................................................................................................................. 351
nw3000driver ............................................................................................................................ 352
nw3000network......................................................................................................................... 363
nw3000polllist ........................................................................................................................... 364
nw3000questionablealarmcondition ......................................................................................... 368
nw3000realanalog ....................................................................................................................369
nw3000realanalogalarmcondition............................................................................................. 379
nw3000rollingscantimer ............................................................................................................ 380
nw3000string ............................................................................................................................ 381
nw3000stringpolllist ..................................................................................................................383
objectnotes................................................................................................................................ 384
objects....................................................................................................................................... 385
objectsextension .......................................................................................................................391
objectsuppressiongroup............................................................................................................ 392
oelogaccess.............................................................................................................................. 393
oelogarchive ............................................................................................................................. 394
oelogcolumn ............................................................................................................................. 395
oelogcontrol .............................................................................................................................. 397
oelogdata .................................................................................................................................. 398
oelogdataextension................................................................................................................... 402
oelogextract .............................................................................................................................. 404
oelogworker .............................................................................................................................. 405
oeprinter.................................................................................................................................... 406
oeprinteralarmcondition ............................................................................................................ 409
oeprintergroup .......................................................................................................................... 410
oeprintergroupalarmcondition................................................................................................... 413
................................................................................................................................. 300
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 6
OpenEnterprise Schema
oeprinterrelati
oeprinterrelationship ................................................................................................................. 416
oetimer ...................................................................................................................................... 418
opcdevice.................................................................................................................................. 419
opcdriver ................................................................................................................................... 420
opcgroup................................................................................................................................... 422
opcitemdigital............................................................................................................................ 425
opcitemintegeranalog ...............................................................................................................427
opcitemrealanalog ....................................................................................................................429
opcitemstring ............................................................................................................................ 431
opcserver .................................................................................................................................. 433
Pattern ......................................................................................................................................436
patterngroup ............................................................................................................................. 437
plantarea................................................................................................................................... 438
publishedreport ......................................................................................................................... 439
publishedreporttoaliaslookup.................................................................................................... 443
questionablealarmcondition ...................................................................................................... 444
questionableequalsalarmcondition ........................................................................................... 445
questionablerangealarmcondition............................................................................................. 446
realanalog ................................................................................................................................. 447
realanalogalarmcondition.......................................................................................................... 449
realanalogchangetonullalarmcondition ..................................................................................... 450
realanalogchangevaluealarmcondition ..................................................................................... 451
realanalogdeviationalarmcondition ........................................................................................... 452
realanalogequalsalarmcondition............................................................................................... 453
realanaloglimitalarmcondition ................................................................................................... 454
realanalograteofchangealarmcondition ....................................................................................455
realanalogsignalalarmcondition ................................................................................................ 456
realanalogsignaltrigger .............................................................................................................457
realarchiveindex........................................................................................................................ 458
recipient .................................................................................................................................... 459
recipientassociations ................................................................................................................ 461
recipientgroup ........................................................................................................................... 462
recipientusernotes ....................................................................................................................463
redundancy ............................................................................................................................... 474
redundancyalarmconditiona...................................................................................................... 478
redundancyalarmconditionb...................................................................................................... 479
remotedataservice .................................................................................................................... 480
remotedataservicealarmcondition............................................................................................. 482
remotedataservicetimer ............................................................................................................ 483
remotedigital ............................................................................................................................. 484
remoterealanalog...................................................................................................................... 485
report......................................................................................................................................... 486
reportalarmcondition ................................................................................................................. 491
reportcreation............................................................................................................................ 492
reportequalsalarmcondition ......................................................................................................495
onship ................................................................................................................. 414
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 7
OpenEnterprise Schema
reportformat
reportformatalarmcondition....................................................................................................... 501
reportformatequalsalarmcondition ............................................................................................ 502
reportformatrangealarmcondition .............................................................................................503
reportformattorecipientlookup................................................................................................... 504
reportrangealarmcondition........................................................................................................ 506
reportrecipient........................................................................................................................... 507
reportrecipientalarmcondition ...................................................................................................509
reportrecipientemail .................................................................................................................. 510
reportrecipientequalsalarmcondition......................................................................................... 511
reportrecipientfilecopy............................................................................................................... 512
reportrecipientftpcopy ............................................................................................................... 514
reportrecipientrangealarmcondition .......................................................................................... 516
reportschedule ..........................................................................................................................517
reportschedulealarmcondition................................................................................................... 520
reportscheduleequalsalarmcondition........................................................................................ 521
reportscheduler......................................................................................................................... 522
reportschedulerangealarmcondition ......................................................................................... 525
reportscheduletimed ................................................................................................................. 526
reportschedulevaluechange...................................................................................................... 530
reporttemplate........................................................................................................................... 532
reporttoaliaslookup ...................................................................................................................534
reporttoformatlookup................................................................................................................. 536
reporttoschedulelookup ............................................................................................................537
rocacinputoutputmodule ........................................................................................................... 538
rocadvancedpulsemodule......................................................................................................... 545
rocalarmcondition .....................................................................................................................561
rocalarmlog ...............................................................................................................................562
rocbasedatum ........................................................................................................................... 567
rocblmuserlistparameters .........................................................................................................569
rocchannel ................................................................................................................................ 571
rocchannelalarmcondition......................................................................................................... 580
rocchannelset ........................................................................................................................... 581
rocchannelsetalarmcondition .................................................................................................... 583
rocchannelsetallocation ............................................................................................................ 584
rocchanneltypes........................................................................................................................ 586
rocchartuserlistparameters ....................................................................................................... 587
roccheckconfiguration............................................................................................................... 589
rocdatatypes ............................................................................................................................. 594
rocdevice................................................................................................................................... 596
rocdevicealarmcondition ........................................................................................................... 612
rocdevicechannelcomms .......................................................................................................... 613
rocdevicecommsroute............................................................................................................... 615
rocdeviceipcomms .................................................................................................................... 624
rocdigital.................................................................................................................................... 626
rocdriver .................................................................................................................................... 630
.............................................................................................................................. 496
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 8
OpenEnterprise Schema
rocdriveralarmc
rocds800configuration ..............................................................................................................638
rocenhancedcommmoduleconfiguration................................................................................... 645
rocenumeratedvaluedescriptions.............................................................................................. 648
rocenumeratedvaluedescriptions2............................................................................................ 651
rocenumeratedvaluedescriptions3............................................................................................ 652
rocerrorcodelog......................................................................................................................... 653
roceventlog ............................................................................................................................... 655
rocexpandedioinformation ........................................................................................................ 661
rochartparameters ....................................................................................................................664
rochistorylog ............................................................................................................................. 702
rochistorypoint .......................................................................................................................... 705
rochistorysegmentconfiguration................................................................................................ 711
rocinformationforuserdefinedpoints .......................................................................................... 714
rocinternetconfigurationparameters.......................................................................................... 715
rocjournaltypes .........................................................................................................................718
rocjournaltypes .........................................................................................................................720
roclicensekeyinformation .......................................................................................................... 722
roclinkparameterroctypeversion ............................................................................................... 725
roclogon .................................................................................................................................... 727
roclogonparameters.................................................................................................................. 728
rocmodbuseventalarmandhistory ............................................................................................. 735
rocmodbusmastermodemconfiguration .................................................................................... 755
rocmodbusmastertable ............................................................................................................. 758
rocmodbusregistertotlpmapping ...............................................................................................781
rocnetwork ................................................................................................................................ 803
rocoedbfieldtypes...................................................................................................................... 804
rocorificemeterrunconfiguration ................................................................................................ 805
rocorificemeterrunvalues ..........................................................................................................813
rocparameterpattern ................................................................................................................. 820
rocparameterpatternpoint .........................................................................................................821
rocparameters........................................................................................................................... 822
rocplusanaloginputs.................................................................................................................. 827
rocplusanalogoutputs................................................................................................................ 834
rocplusclock .............................................................................................................................. 837
rocpluscommports ....................................................................................................................840
rocplusconfigurableopcode....................................................................................................... 850
rocplusdiscreteinputs ................................................................................................................ 876
rocplusdiscreteoutputs.............................................................................................................. 879
rocplusfstparameters ................................................................................................................ 884
rocplusfstregistertags................................................................................................................ 890
rocplushistorypoint.................................................................................................................... 892
rocplusmodbusconfigurationparameters ..................................................................................895
rocplusmultivariablesensor ....................................................................................................... 901
rocpluspidcontrolparameters ....................................................................................................912
rocpluspowercontrolparameters ...............................................................................................925
ondition ............................................................................................................637
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 9
OpenEnterprise Schema
rocpluspulsei
rocplusrtd .................................................................................................................................. 934
rocplussoftpointparameters ......................................................................................................941
rocplussystemanaloginputs ......................................................................................................948
rocplussystemvariables ............................................................................................................952
rocplusthermocouple ................................................................................................................963
rocplususerdefineddatatypes.................................................................................................... 967
rocpoint .....................................................................................................................................968
rocpointalarmcondition.............................................................................................................. 973
rocpointtypes ............................................................................................................................ 974
rocpointwritetimeout.................................................................................................................. 977
rocportparameters ....................................................................................................................978
rocprotocoltypes .......................................................................................................................983
rocreadalarmdata...................................................................................................................... 984
rocreadclock ............................................................................................................................. 989
rocreadconfigurableopcodedata ............................................................................................... 992
rocreadeventdata...................................................................................................................... 993
rocreadhistorydata .................................................................................................................... 998
rocreadhistorypointsconfig...................................................................................................... 1000
rocreadpointparameters.......................................................................................................... 1003
rocreadspecifiedparameters ................................................................................................... 1005
rocreadusertemplatedata........................................................................................................ 1006
rocrealanalog ..........................................................................................................................1009
rocrequest............................................................................................................................... 1013
rocrequesttypes ...................................................................................................................... 1016
rocsamplerodorizorparameters............................................................................................... 1018
rocschedule ............................................................................................................................ 1021
rocschedulestatistics............................................................................................................... 1023
rocsecuritygroupconfiguration................................................................................................. 1026
rocsmartiomoduleinformation800 ........................................................................................... 1030
rocstandardagaflowcalculationvalues..................................................................................... 1033
rocstandardagaflowparameters .............................................................................................. 1044
rocstandardanaloginputcalibrationparameters .......................................................................1054
rocstandardanaloginputs ........................................................................................................1057
rocstandardanalogoutputs ......................................................................................................1063
rocstandardbatteryparameters ............................................................................................... 1065
rocstandardclock..................................................................................................................... 1068
rocstandardcommports ........................................................................................................... 1070
rocstandardconfigurableopcode .............................................................................................1077
rocstandarddiscreteinputs....................................................................................................... 1103
rocstandarddiscreteoutputs ....................................................................................................1107
rocstandardextrarunparameters .............................................................................................1110
rocstandardflags ..................................................................................................................... 1115
rocstandardfstparameters....................................................................................................... 1122
rocstandardhistorypoint ..........................................................................................................1127
rocstandardlocaldisplaypanel .................................................................................................1128
nputs .................................................................................................................... 929
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 10
OpenEnterprise Schema
rocstandardlogonsecuritiesparameters
rocstandardmetercalibrationandsampler ................................................................................ 1133
rocstandardmeterconfigurationparameters............................................................................. 1136
rocstandardmeterflowvalues................................................................................................... 1153
rocstandardmodbusconfigurationparameters......................................................................... 1166
rocstandardmodbusfunctiontables.......................................................................................... 1170
rocstandardmodbusspecialfunctiontable ................................................................................ 1186
rocstandardmoduleinformation ............................................................................................... 1202
rocstandardmultivariablesensor.............................................................................................. 1207
rocstandardpidcontrolparameters ........................................................................................... 1215
rocstandardpidparameters...................................................................................................... 1224
rocstandardpowercontrolparameters...................................................................................... 1233
rocstandardpulseinputs........................................................................................................... 1236
rocstandardreadgeneralupdate .............................................................................................. 1240
rocstandardreadpointers......................................................................................................... 1241
rocstandardreadsysteminformation ........................................................................................1244
rocstandardrevisioninformation .............................................................................................. 1247
rocstandardrunparameters .....................................................................................................1248
rocstandardsoftpointparameters............................................................................................. 1267
rocstandardsystemvariables ................................................................................................... 1271
rocstandardtankparameters.................................................................................................... 1276
rocstandarduserdefineddatatypes .......................................................................................... 1280
rocstandarduserlistparameters ............................................................................................... 1281
rocstationparameters .............................................................................................................. 1296
rocstationparameters .............................................................................................................. 1307
rocstring .................................................................................................................................. 1318
rocsystemparameters ............................................................................................................. 1320
rocsystemparametersaccessarea........................................................................................... 1321
rocsystemparametersalarmpriority .........................................................................................1322
rocsystemparametersbool ......................................................................................................1323
rocsystemparametersdriver .................................................................................................... 1324
rocsystemparametersinteger .................................................................................................. 1325
rocsystemparametersplantarea ..............................................................................................1326
rocsystemparametersportparameters..................................................................................... 1327
rocsystemparametersschedule............................................................................................... 1328
rocsystemparametersstring ....................................................................................................1329
roctime .................................................................................................................................... 1330
rocturbinemeterrunconfiguration............................................................................................. 1332
rocturbinemeterrunvalues....................................................................................................... 1342
roctypes ..................................................................................................................................1349
rocusercconfiguration .............................................................................................................1351
rocuserdefinedpoint ................................................................................................................ 1354
rocuserprogramconfiguration.................................................................................................. 1355
rocversion ............................................................................................................................... 1357
rocwriteclock ...........................................................................................................................1358
routine..................................................................................................................................... 1359
.................................................................................. 1131
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 11
OpenEnterprise Schema
runsqlscript.............................................................................................................................. 1360
runsqlscripterroralarmcondition .............................................................................................. 1362
runtimeexception .................................................................................................................... 1363
scheduleevents....................................................................................................................... 1364
schedulepattern ...................................................................................................................... 1366
schemahelp ............................................................................................................................ 1368
securityreplication ...................................................................................................................1370
selfusernotes .......................................................................................................................... 1372
senderusernotes .....................................................................................................................1383
signal....................................................................................................................................... 1394
signalattributetrigger ............................................................................................................... 1405
signalextension .......................................................................................................................1406
signalnotes.............................................................................................................................. 1407
signalsuppressiongroup.......................................................................................................... 1408
sqlprocedure ...........................................................................................................................1409
stringsignal.............................................................................................................................. 1410
stringsignaltrigger ...................................................................................................................1412
suppressiongroup ................................................................................................................... 1413
suppressiongroupdelaytimer................................................................................................... 1415
suppressiongrouplookup......................................................................................................... 1416
suspendedthread ....................................................................................................................1418
table_privileges....................................................................................................................... 1420
tablegroups .............................................................................................................................1424
tables ......................................................................................................................................1425
tcpconnection.......................................................................................................................... 1427
tcpserver ................................................................................................................................. 1428
telephonenumber.................................................................................................................... 1429
time ......................................................................................................................................... 1431
timedarchive ...........................................................................................................................1433
timer ........................................................................................................................................ 1437
timezones................................................................................................................................ 1439
tobescheduled ........................................................................................................................ 1440
token ....................................................................................................................................... 1443
tokenaccess ............................................................................................................................ 1445
tokengroup.............................................................................................................................. 1447
tokengroupaccess................................................................................................................... 1449
triggersqlprocedure................................................................................................................. 1451
triggersqlprocedureerroralarmcondition.................................................................................. 1454
triggersqlproceduretimer......................................................................................................... 1455
udpmsg ...................................................................................................................................1456
udpport.................................................................................................................................... 1457
useraccess.............................................................................................................................. 1458
userconfig ............................................................................................................................... 1469
usergroups.............................................................................................................................. 1478
userlockout.............................................................................................................................. 1479
usernotes ................................................................................................................................1480
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 12
OpenEnterprise Schema
users ....................................................................................................................................... 1481
usersnameonly ....................................................................................................................... 1491
views ....................................................................................................................................... 1492
workstation.............................................................................................................................. 1493
3 Appendices ........................................................................................................................1496
Appendix B – Security Enabled Views ...................................................................................1496
Appendix A – Auto-IDPrimary Keys........................................................................................ 1497
4 Glossary .............................................................................................................................1498
5 Index ...................................................................................................................................1499
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 13
OpenEnterprise Schema
1 OpenEnterprise Schema
This document includes details of all of the tables that are shipped as part of the OpenEnterprise
product. Where a project might want to add its own tables (either derived or base) it is recommended
that a unique project identifier is included before the name of the table, e.g. xxxTable where xxx can
be uniquely identified with the project.
The OpenEnterprise database has both Relational and Object-Oriented features. This means that as
well as the more usual relationships between tables implemented by the use of foreign keys, there is
also an extra dimension of relationships made possible by the 'object-oriented' aspect of the
database. This uses table inheritance to enforce a relationship between tables. Table inheritance
means that some tables may be derived from other tables. Derived tables inherit the parent table's
attributes, and may add their own new attributes. This is the ideal solution for creating classes of
objects that bear an "IS A TYPE OF" relationship. An object added or deleted from the derived table is
automatically added or deleted from the parent table also, so there is no database programming
overhead required to guard the integrity of such tables.
A good example of the use of derived tables is seen in the dvi_datum derived tables. A datum is a
value obtained from a logging/controller device. The datum may represent a digital, integer, string or
realanalog signal value. It may also represent a signal from a Bristol or Allen-Bradley RTU/controller,
or even be a signal collected from an OPC Server. The object-oriented design of the OpenEnteprise
database enables us to depict all these complex relationships with ease.
In order to demonstrate this aspect of the OpenEnteprise database, the Contents tab on the left of the
Help window displays the tables as a tree, in a similar way to the Database Explorer. Parent tables
(i.e. those having tables derived from them) are shown as books. Tables which are not parents to
other tables are shown as pages. Base tables (those which are not derived from any other table) are
displayed on the extreme left of the tree, and the 'depth' of each table is indicated by how far it is from
the left of the tree. A base table may or may not be a parent for other tables.
Note that for the purpose of readability, some table or attribute descriptions on the actual topics may
capitalize and place spaces in table names. For instance the digitalalarmcondition_table may be
referred to as the Digital Alarm Condition table. Also note that the '_table' extension has been
removed from the table names for the same purpose.
Hint:
All signal tables are derived from the dvi_datum table, all alarmcondition tables are derived from the
alarmcondition table, the users table is derived from the objects table. Select the tables of interest
from the Contents tab pane, or select the Index tab to see the tables displayed in alphabetical order.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 14
2 Tables
abcomplex
OpenEnterprise Schema
Derived From:
Description:
Attributes:
binarysignal
This table maintains information about complex signals specifically for
Allen Bradley devices.
A complex signal is used to handle Allen Bradley specific 'structured data
types e.g. Counters and Timers. The length of the data will vary depending
on the data type specified in the FileAddress. The ABComplex signal types
allows read and write access to AB structured data items.
fileaddress : char
The PLC data file address.
readquestionable : integer
This value indicates the last read value of the questionable status of the
readvalue from the device.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 15
abdevice
OpenEnterprise Schema
Derived From:
Description:
Attributes:
dvi_device
The ABDevice table defines the Allen Bradley PLCs configured for data
collection and control by the OpenEnterprise database. A single ABDevice
object can describe a single standalone PLC or a redundant PLC pair.
The AB Configuration Tool will insert all the ABDevice entries, with the
information sourced from user input entered via the configuration tool. Like
ABNetwork entries, if it's possible to browse the configured RSLINX PLCs
then this should be considered as an option if it aids OE configuration.
accessarea : char
The access area to which this object belongs. Used with security
enabled views to restrict access for unauthorised users.
ahealthy : bool
Set to TRUE if the 'A' PLC is currently healthy. The 'A' PLC is identified
by the deviceaddress attribute.
Used for monitoring purposes only.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 16
alarmcondition : array of AlarmCondition
This attribute is an array of Alarm Condition object. They are defined
within the ABDeviceHealthAlarmCondition table. Alarm conditions for
generating alarms based on the PLC health are automatically generated
when the device object is created.
alastconfigerror : integer
Set to the last configuration error value for the 'A' PLC.
Used for monitoring purposes only.
amainplc : bool
Set to TRUE if the A PLC is currently the Master. The A PLC is the PLC
specified by the devicename attribute.
OpenEnterprise Schema
Used for monitoring purposes only.
backupdeviceaddress : char
Identifies the back-up AB RSLINX Port ID and station number. Used for
redundant systems only. Same format as deviceaddress. This PLC is
also known as the B PLC.
Optional.
bhealthy : bool
Set to TRUE if the B PLC is currently healthy.
Used for monitoring purposes only.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 17
blastconfigerror : integer
Set to the last configuration error value for the B PLC.
Used for monitoring purposes only.
bmainplc : bool
Set to TRUE if the B PLC is currently the Master. The B PLC is the PLC
specified by the BackupDeviceAddress attribute.
Used for monitoring purposes only.
defaultscheduleinterval : datetime
The default time interval for polling data from this device.
OpenEnterprise Schema
Optional.
description : char
An arbitrary string used to describe the PLC. The Description will be
automatically set if the user does not supply one.
Optional.
heartbeataddress : char
The address within the PLC used by the ABRDI to send heartbeats (e.g.
update with value 1) to act as a RDI to PLC heartbeat. The specified
PLC address must be a bit address e.g. B3:0/0 or N30:0/0.
Optional.
heartbeatrate : integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 18
The rate at which the ABRDI will update the Heartbeat value. Specified
in seconds.
Optional.
mainindicatoraddress : char
The address within the PLC used to indicate if the PLC is Master or
Standby. Only used for redundant systems.
Mandatory for a redundant PLC. The PLC file address must be a bit
address. e.g. N31:0/0
redundant : bool
Set to TRUE if this is a redundant PLC. Otherwise set to FALSE.
OpenEnterprise Schema
Mandatory for all PLCs.
redundantpair : bool
This is TRUE if the device is configured as a redundant pair.
Used for monitoring purposes only.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 19
abdevicehealthalarmcondition
OpenEnterprise Schema
Derived From:
Description:
Attributes:
devicename : char references ABDevice
This is a reference to the device that is being monitored.
alarmcondition
This is the Alarm Condition associated with Allen Bradley devices. When
the ahealthy or bhealthy values of an Allen Bradley device change this
condition is checked to see whether an alarm should be generated,
updated or removed.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 20
abdigital
OpenEnterprise Schema
Derived From:
Description:
Attributes:
fileaddress : char
The PLC data file address. The address must be a bit address e.g.
digital
This table maintains information about digital signals specifically for Allen
Bradley devices.
N101:0/0 or B1:0/0
readquestionable : integer
This value indicates the last read value of the questionable status of the
readvalue from the device.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 21
abdriver
OpenEnterprise Schema
Derived From:
Description:
Attributes:
accessarea : char
The access area to which this object belongs. Used with security
dvi_remote_driver
The ABDriver table consists mostly of static data. When configuring the
ABRDI the ABDriver table will be populated with defaults using an SQL file
supplied by the OE installation (ABDef.sql).
enabled views to restrict access for unauthorised users.
alarmcondition : array of AlarmCondition
This attribute is an array of Alarm Condition object. They are defined
within the ABDeviceHealthAlarmCondition table.
Internal use only.
cachesizehigh : integer
Count of cached DTL_C_DEFINES.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 22
Used for monitoring purposes only.
cachesizeinuse : integer
Count of cached DTL_C_DEFINES currently in use.
Used for monitoring purposes only.
defaultplctimeout : integer default 2000
Default timeout value used when communicating with AB PLCs.
description : char
An arbitrary string used to describe the driver object.
OpenEnterprise Schema
Optional.
eventnumber : integer
This is a value that is used by the alarm condition to check if the journal
task is a valid event.
Internal use only.
eventtext : char
This describes the task to be journalled.
Internal use only.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 23
eventtimestamp : datetime
This is the time at which the event is to be journalled at. This should be
identical to the occurencetime attribute of the alarmsummary object
associated with one of the alarmcondition entries.
Internal use only.
eventtrigger : integer
This integer is used to trigger journal event handling.
Internal use only.
maximumdataitems : integer default 1
Maximum number of data items. Range 1 to 500. Passed to the
DTL_INIT call. ABRDI adds 120 to the value.
OpenEnterprise Schema
plcfailcount : integer default 3
The number of consecutive I/O failures for a PLC that will result in the
PLC being marked as offline. This will result in all signals for that PLC
being marked as questionable and a PLC health alarm to be generated.
signalnameseparator : char default _
This is the character that is used to split a signal name.
unmappeddatumdelay : integer default 100
The amount of time after abrdi start-up until all devices are checked for
having registered signals that are not being collected by any poll lists.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 24
abintegeranalog
OpenEnterprise Schema
Derived From:
Description:
Attributes:
fileaddress : char
The PLC data file address. The specified address must be a word
integeranalog
This table maintains information about Integer signals specifically for Allen
Bradley devices.
address e.g. N101:0.
readquestionable : integer
This value indicates the last read value of the questionable status of the
readvalue from the device.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 25
abnetwork
OpenEnterprise Schema
Derived From:
Description:
dvi_network
A single ABNetwork entry is required for each configured RSLINX driver.
E.g. If RSLINX is configured with a single Ethernet driver there will be one
corresponding object in the ABNetwork table. The
ABNetwork.RSLINXDrivername must match exactly the name of the
configured RSLINX driver.
ABNetwork entries are inserted by ABConfig from user entered input.
However, ABConfig should provide a browse facility that will display to the
user all configured RSLINX drivers for ease of selection.
Attributes:
accessarea : char
The access area to which this object belongs. Used with security
enabled views to restrict access for unauthorised users.
alarmcondition : array of AlarmCondition
This attribute is an array of Alarm Condition object.
Internal use only.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 26
description : char
An arbitrary string used to describe the driver object.
Optional.
rslinxdriverid : integer
Arbitrary number between 1 - 15. AB network interface ID
(DTL_C_CONNECT() call).
Mandatory.
rslinxdrivername : char
Identifies the RSLINX driver. This must exactly match the name of a
configured RSLINX driver.
OpenEnterprise Schema
Mandatory. E.g. 'AB_ETH-1'.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 27
abpolllist
OpenEnterprise Schema
Derived From:
Description:
dvi_datum
Poll lists are used to control what PLC data is collected and when. The
StartAddress and EndAddress determine the range of PLC data to read
and the dvi_schedule reference determines the frequency at which data is
read.
If a poll list is created with a valid StartAddress but no end address, then
the CL will attempt to auto-configure the EndAddress based on the
configured signals in the database. The latter may need to be triggered by
ABConfig if a suitable CL trigger cannot be found. I.e. The insert of a new
signal or the update of an existing address should cause an autoreconfigure.
Attributes:
accessarea : char
The access area to which this object belongs. Used with security
enabled views to restrict access for unauthorised users.
alarmcondition : array of AlarmCondition
This attribute is an array of Alarm Condition object. They are defined
within the ABDeviceHealthAlarmCondition table.
Internal use only.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 28
autoendaddress : bool default FALSE
If set to TRUE then the ABRDI will automatically assign the EndAddress
to reflect the highest word address configured for signals within this PLC
file. If set to FALSE then the setting of the EndAddress will be the
responsibility of the system configurer.
description : char
An arbitrary string used to describe the Poll List.
Optional.
OpenEnterprise Schema
endaddress : integer default 1
The last address in the address range to be polled by this poll list.
endaddressinuse : integer
The last PLC file offset being actively polled by ABRDI.
Used for monitoring purposes only.
file : char
The PLC File. E.g. B3 or N100.
startaddress : integer default 0
The first address in the address range to be polled by this poll list.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 29
startaddressinuse : integer
The first PLC file offset being actively polled by ABRDI. Used for
monitoring purposes only.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 30
abrealanalog
OpenEnterprise Schema
Derived From:
Description:
Attributes:
fileaddress : char
The PLC data file address. E.g. F100:0 or N101:0.
readquestionable : integer
This value indicates the last read value of the questionable status of the
This table maintains information about floating-point signals specifically for
Allen Bradley devices.
realanalog
Mandatory.
readvalue from the device.
span : real default 1
The m in y = mx + c. Where y is the database value and x is the PLC
value. Used to adjust an integer value to a float.
zero : real default 0
The c in y = mx + c. Where y is the database value and x is the PLC
value. Used to adjust an integer to a float.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 31
accessarea
OpenEnterprise Schema
Derived From:
Description:
Attributes:
<Base Table>
This is a table that only exists when security is enabled on the system. It
contains objects that are made up of a users name and an area. An entry
in the table allows that user access to the associated area.
For example, an object may contain the accessarea of 'Site14' and a user
of 'J. Smith'. This will allow the user 'J. Smith' to view any Objects in the
database whose accessarea attribute has the value of 'Site14'.
Used with security enabled views to restrict access for unauthorised
users.
accessarea : char references Ac cessAreaConfig
When security is enabled, objects in the database will contain
expressions in their accessarea attributes that match entries in this
attribute. These are cross-referenced with the users associated with the
match to determine who may view the objects.
source : integer8
Indicates whether the Access Area was added through Group
membership or individually to the User or Group. Valid values are:
0 = IS_USER
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 32
1 = IS_GROUP
2 = IS_DEFAULTGROUP
Used to create and delete AccessArea table entries for Users of a
Security Group if AccessArea entries are created or deleted for that
Group. This script will also ensure that if an Access Area is allocated to
the Default Group, that the Access Area is then allocated to all Users
and Groups defined within the database.
username : char references users
An entry in this attribute will allow the referenced user to view objects
whose accessarea attribute is the same as that in the corresponding
accessarea attribute of this object.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 33
accessareaconfig
OpenEnterprise Schema
Derived From:
Description:
Attributes:
accessarea : char
This attribute is the primary key that is referenced from the AccessArea
<Base Table>
This table is a look up table that is used to provide a full description of the
security area. It is referenced from access area objects when security is
enabled.
Used with security enabled views to restrict access for unauthorised
users.
table.
description : char
This is a text description of the area designated as a security region.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 34
accessareaconfigforuser
OpenEnterprise Schema
Derived From:
Description:
Attributes:
View onto accessareaconfig
This view onto accessareaconfig is security enabled so that the currently
logged in user can only see objects that are in accessareas granted to that
user.
This view is provided for use in configuration tools, so that only valid
accessareas can be selected.
Used with security enabled views to restrict access for unauthorised
users.
accessarea : char
This attribute is the primary key that is referenced from the AccessArea
table.
description : char
This is a text description of the area designated as a security region.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 35
adminuser
OpenEnterprise Schema
Derived From:
Description:
Attributes:
encryptedpassword : char
An encrypted version of the password. This is used by the OE Security
View onto users
This view contains username and password information about
administrative users on the system. An administrator user is distinguished
from a non-administrator user by the attribute isadminuser in the users
table.
Manager in its maintenance of the security system.
name : char
This is the username assigned to the administrator.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 36
alarmcondition
OpenEnterprise Schema
Derived From:
Description:
Attributes:
<Base Table>
This table is the base table from which all alarm generating objects must
inherit. It contains information common to all open enterprise alarm
generation. Each object in the table references an alarmpriorityblock object
and optionally an alarmsummary object and a suppressiongroup object.
If the alarmcondition entry references an alarmsummary object, then the
alarm is currently active. Any single object (journal, event, signal, etc.) may
have more than one alarm condition associated with it.
accessarea : char
The access area to which this object belongs. Used with security
enabled views to restrict access for unauthorised users.
alarmaction : char
This is an FK reference to the calculation table. The calculation
(process) is executed when an alarm is generated assuming that
alarmactionenable is set to true.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 37
alarmactionacknowledged : char
This is an FK reference to the calculation table. When an alarm is
acknowledged the alarmActionAcknowledged calculation is run. If the
alarm is currently cleared and the same calculation is specified in
alarmActionCleared, then alarmActionAcknowledged is not run.
Alarmactionenable must be set to true.
alarmactioncleared : char
This is an FK reference to the calculation table. When the alarm is
cleared the alarmActionCleared calculation is run. If alarmActionCleared
is NULL the alarmAction is run if BIT 0 (zero) of alarmActionOptions is
set. If the alarm has already been acknowledged and the same
calculation is specified in alarmActionAcknowledged, then
alarmActionCleared is not run. Alarmactionenable must be set to true.
OpenEnterprise Schema
alarmactionenable : bool default TRUE
If this value is true and an alarm is generated, the alarmactiontrigger is
set to true. Setting this to false disables any alarm action.
alarmactionoptions : integer default 0
Currently only one option is available. Setting BIT0 (zero) will result in
the calculation specified by alarmAction being run when the alarm
condition updates or clears an alarm.
alarmactiontrigger : bool
This attribute no longer used.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 38
alarminhibit : bool
Setting this to TRUE will prevent any of the Alarm Conditions
associated with this object from generating an entry in the Alarm
Summary table when the condition is met.
alarmsummary : integer
This is a reference to an object in the alarmsummary table. If the
reference is NULL, the condition is not in an alarm state. If the reference
exists, an alarm has been generated for this condition and is currently
uncleared or/and unacknowledged.
OpenEnterprise Schema
audiblesound : char
The name and location of a .WAV file. If this value is NULL, or contains
an empty string then no sound is configured for the database object.
audiblesoundrepeats : integer
The number of times that the .WAV file is to be played. A value of -1
would indicate that the .WAV file is to be played infinitely, and 0 (zero)
would indicate that the .WAV file shouldnt be played.
condition : integer
The condition attribute the table can be matched against a value in the
alarmconditionlookup table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 39
groupsuppresscount : integer (hidden)
A count of the number of Suppression Groups to which the Alarm
Condition belongs which are currently in their in-alarm state. Read only.
helptext : char
This string may be used by clients to provide extra information upon the
alarmcondition object.
OpenEnterprise Schema
id : integer
This is a unique value set internally by the alarmcondition CL. It is also
the primary key. See Appendix A for more information.
lastacknowledged : datetime
When the acknowledgement of an alarm changes within the
alarmsummary table, the associated alarmcondition object is called to
update this attribute to the time of the acknowledgement.
lastacknowledgeddstoffset : integer
This attribute is used to describe the number of minute should be
adjusted in the time in order to cater for local Daylight Saving Time.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
p
D301521X412
24-Feb-2010 - Page 40
lastalarmduration : datetime
The lastalarmduration is updated each time an alarm is cleared, and
gives a textual representation of the duration in the following form:
D HH:MM:SS.mmm
where:
D = number of days for which the alarm was uncleared
HH = number of hours
MM = number of minutes
SS = number of seconds
OpenEnterprise Schema
mmm = number of milliseconds.
lastcleared : datetime
When the cleared state of the alarm changes this attribute is updated
with the time of that event.
lastcleareddstoffset : integer
This attribute is used to describe the number of minute should be
adjusted in the time in order to cater for local Daylight Saving Time.
lastoccurence : datetime
The time that the alarm most recently occurred is maintained in this
attribute. It is u
dated when an alarm is updated or created.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 41
attribute. It is updated when an alarm is updated or created.
lastoccurencedstoffset : integer
This attribute is used to describe the number of minute that should be
adjusted in the date time in order to cater for local Daylight Saving Time.
numberofoccurences : integer
This is a count of the total number of times that an alarm has been
generated for this condition.
OpenEnterprise Schema
objectindex : integer8
The objectindex is used to indicate which attribute of a table, an alarm
condition is supposed to act upon. Currently, it may be the readvalue.
acknowledged or nw3000alarm attribute.
precedence : integer
The precedence attribute is used to provide a level of importance of an
alarm. Each signal may have multiple conditions associated with it, and
each condition has a precedence. The highest (if any) of these is
displayed in the signal's precedence attribute.
printer : char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 42
Name of printer that alarms should be logged to.
priority : integer
The priority attribute is a reference to the alarmpriorityblock table. The
reference must exist and will supply information about how to display the
alarm. See the alarmpriorityblock table.
suppress : bool
OpenEnterprise Schema
This attribute describes if the alarmcondition object is currently
suppressed or not.
suppressedtimer : integer (hidden)
References an object in the alarmsuppressiontimer table.
suppressiongroup : integer
This is a foreign key reference to an object in the suppressiongroup
table. If the value is NULL, no suppressiongroup is associated with the
alarm condition. If the value is not NULL, the alarm condition is part of a
suppression group and is subject to, in effect, being disabled, if the
suppressiongroup as a whole is suppressed.
totaltimeinalarm : datetime
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 43
When the cleared state changes in the alarmsummary object associated
with this alarmcondition attribute, this datetime is updated. It reflects the
total time, since creation of the alarm condition, that this condition has
had an alarm in the alarmsummary table.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 44
alarmconditionlookup
OpenEnterprise Schema
Derived From:
Description:
Attributes:
accessarea : char
The access area to which this object belongs. Used with security
<Base Table>
This table is used to cross reference alarm condition values to some text
associated with them. Different values in the condition attribute refer to text
strings such as Change To True, Journal Message, Greater Than, etc.
enabled views to restrict access for unauthorised users.
condition : integer
This is the primary key used to uniquely identify each string in this table.
text : char
This is a piece of text used to describe the type of alarmcondition object
being used. The alarmcondition object maintains a condition integer that
is resolved against the values in this table and the appropriate text string
returned.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 45
alarminhibitalarmcondition
OpenEnterprise Schema
Derived From:
Description:
Attributes:
name : char references Signal
This is a foreign key reference to the signal table.
alarmcondition
This table defines the functionality common to all alarm inhibit alarm
conditions.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 46
alarminhibitstatealarmcondition
OpenEnterprise Schema
Derived From:
Description:
Attributes:
No attributes extend this table.
alarminhibitalarmcondition
This table defines the state change alarm conditions associated with the
alarm inhibit attribute of the signal table. For instance: change of state
change to true and change to false.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 47
alarmmailformat
OpenEnterprise Schema
Derived From:
Description:
Attributes:
body : char
Contains the definition of the text to appear in the message body.
mailformat
This table contains templates to be used for formatting alarm notification
messages.
subject : char
Contains the definition of the text to appear in the message text.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 48
alarmpagingformat
OpenEnterprise Schema
Derived From:
Description:
Attributes:
message : char
Contains the template definition of the text to appear in the message
mailformat
This table contains templates to be used for formatting alarm notification
messages.
body.
postsenddelay:integer
number of milliseconds to wait after sending the message. Default =
1000
presenddelay : integer
number of milliseconds to wait before sending the message. Default =
1000
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 49
alarmpagingrecipient
OpenEnterprise Schema
Derived From:
Description:
Attributes:
disable:bool
Disables this alarm paging recipient object.
objects
This table contains information regarding alarm paging recipients. This
information enables the Paging Server to page them.
messages: integer
References alarmpagingformat. References the desired format of the
paging message.
pagingnumber : char
References telephonenumber. The paging device number of the alarm
paging recipient.
timezoneref:char
References timezones. The timezone of the alarm paging recipient.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 50
alarmpattern
OpenEnterprise Schema
Derived From:
Description:
Attributes:
alarmsaccessarea : char
Template to compare against the accessarea attribute in the
pattern
Provides the rules to determine if a new alarm should be sent by email to
the appropriate recipients.
AlarmSummary table. NULL indicates that this attribute should be
ignored.
alarmsattribute : char
Template to compare against the attribute attribute in the
AlarmSummary table. NULL indicates that this attribute should be
ignored.
alarmsbase : char
Template to compare against the base attribute in the AlarmSummary
table. NULL indicates that this attribute should be ignored.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 51
alarmscondition : char
Template to compare against the condition attribute in the
AlarmSummary table. NULL indicates that this attribute should be
ignored.
alarmsdevicename : char
Template to compare against the devicename attribute in the
AlarmSummary table. NULL indicates that this attribute should be
ignored.
alarmsextension : char
Template to compare against the extension attribute in the
AlarmSummary table. NULL indicates that this attribute should be
ignored.
OpenEnterprise Schema
alarmsname : char
Template to compare against the name attribute in the AlarmSummary
table. NULL indicates that this attribute should be ignored.
alarmsplantarea : char
Template to compare against the plantarea attribute in the
AlarmSummary table. NULL indicates that this attribute should be
ignored.
alarmspriority : char
Template to compare against the priority attribute in the AlarmSummary
table. NULL indicates that this attribute should be ignored.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 52
sendonoutofalarm : bool
Indicates whether a message should be sent when a matched alarm
clears.
status : char
Updated by OEMail to indicate if the template attributes in this
alarmpattern contain valid expressions.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 53
alarmpriorityblock
OpenEnterprise Schema
Derived From:
Description:
Attributes:
accessarea : char
The access area to which this object belongs. Used with security
<Base Table>
This table is used to hold information relevant to an alarm/event priority. It
will supply information to the alarm client such as the colour it should be
displayed when it is acknowledged but not cleared whether it should blink
in this state etc.
enabled views to restrict access for unauthorised users.
audible : bool
This boolean indicates whether a sound is associated with this alarm
priority. If the value is TRUE, the file used to create the sound will be
supplied in the audiblesound attribute.
audiblesound : char
This attribute provides the name of the file that is to be used when the
alarm is generated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 54
autoacknowledged : bool
This attribute determines if the alarm should be automatically
acknowledge when it becomes an alarm. A value of TRUE indicates this
to be the case.
autocleared : bool
This attribute determines if the alarm should be automatically cleared
when it becomes and alarm. A value of TRUE indicates this to be the
case.
clearedunackedbg : integer
This is the colour to display the background of the alarm within the
Alarm Client application when the alarm has been cleared but not
acknowledged.
OpenEnterprise Schema
clearedunackedblink : bool
This indicates whether the alarm should blink or not within the Alarm
Client application when the alarm has been cleared but not
acknowledged
clearedunackedfg : integer
This is the colour to display the foreground of the alarm within the Alarm
Client application when the alarm has been cleared but not
acknowledged
description : char
Description of this alarm priority.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 55
eventlogged : bool
This indicates whether the alarms of this priority are historically logged
or not.
printcolour : integer
This is the colour that the alarm was printed.
printed : bool
This indicates whether the alarms of this priority should be printed or
not.
OpenEnterprise Schema
printer : char
This is the name given to allow access to a printer to which print outs of
alarms should be sent for this priority.
priority : integer
This is the primary key of the alarmpriorityblock table.
totalacknowledged : integer
This is the total number of alarms, for this priority block, that have been
acknowledged but not cleared yet.
totalalarms : integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 56
This is the total number of alarms, currently outstanding, for this priority.
totalcleared : integer
This is the total number of alarms, for this priority, that have been
cleared but not acknowledged.
totalunacknowledged : integer
This is the total number of alarms that have neither been cleared or
acknowledge, within the priority object.
OpenEnterprise Schema
unclearedackedbg : integer
This is the colour to display the background of the alarm within the
Alarm Client application when the alarm has been acknowledged but not
cleared.
unclearedackedblink : bool
This indicates whether the alarm should blink within the Alarm Client
application when the alarm has been acknowledged but not cleared.
unclearedackedfg : integer
This is the colour to display the foreground of the alarm within the Alarm
Client application when the alarm has been acknowledged but not
cleared.
unclearedunackedbg : integer
This is the colour to display the background of the alarm within the
Alarm Client application when the alarm has not been acknowledged or
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 57
cleared.
unclearedunackedblink : bool
This indicates whether the alarm should blink within the Alarm Client
application when the alarm has not been acknowledged or cleared.
unclearedunackedfg : integer
This is the colour to display the foreground of the alarm within the Alarm
Client application when the alarm has not been acknowledged or
cleared.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 58
alarmrecipient
OpenEnterprise Schema
Derived From:
Description:
Attributes:
acknowledgementkey : char
The key that must be specified by the recipient in order to acknowledge
objects
The Alarm Recipient table is derived from the Recipient table and is
specifically aimed at recipients receiving and acknowledging alarm details.
an alarm. A value of NULL indicates that this recipient cannot
acknowledge alarms.
acknowledgementmode : integer default 0
Indicates the acknowledgement rights of this recipient.
0 = Use OEMails optimisitic/pessimistic setting.
1 = Pessimistic, the occurrence time of the alarm
acknowledgement has to match the alarms occurrence time for the
acknowledgement to succeed.
2 = Optimistic, the alarm will be acknowleged irrespective of its
occurrence time.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 59
alarmmailformatref : char not null references alarmmailformat
Indicates which alarmmailformat object is to be used when formatting
messages to send to this recipient.
manualtest : bool
Flag used to trigger the sending of a dummy message to this recipient.
To test that this recipient can be mailed set this attribute to TRUE.
timezoneref : char references timezones
Indicates the timezone in which this recipient resides.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 60
alarmredirection
OpenEnterprise Schema
Derived From:
Description:
Attributes:
alarmcondition : integer references
A reference to the parent alarm condition object.
<Base Table>
This table contains all the configuration and management information
required to provide alarm redirection functionality.
alarmsummary : integer references AlarmSummary
A (transient) reference to the associated alarm summary object.
enableaccessarea : bool default FALSE
If set to TRUE, then on the redirection timer expiring the access area of
the associated alarm will be set to the value of the
RedirectionAccessArea attribute.
enableplantarea : bool default FALSE
If set to TRUE, then on the redirection timer expiring the plant area of
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 61
the associated alarm will be set to the value of the RedirectionPlantArea
attribute.
enablepriority : bool default FALSE
If set to TRUE, then on the redirection timer expiring the priority of the
associated alarm will be set to the value of the RedirectionPriority
attribute.
id : integer Primary Key
A unique identifier for each entry in the table, the value of which will be
generated automatically using CL.
OpenEnterprise Schema
name : char References digital
The name of a digital signal, (remote or local), which when the alarm
redirection occurs for the object will be set to a value of TRUE. (Note, no
internal logic will be provided for resetting the attribute to FALSE)
nextalarmredirection : integer references AlarmRedirection
If cascaded redirection is configured for the parent alarm condition, then
this will contain a reference to the next alarm redirection object in the
cascaded sequence.
overridehigherpriority : bool default FALSE
If the value of the priority attribute of the standing alarm is higher than
that of the redirectionpriority attribute, then this attribute can be used to
control whether the priority attribute of the alarm should be overridden.
This is predominantly for use with Network3000 alarms.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 62
previousalarmredirection : integer references AlarmRedirection
If cascaded redirection is configured for the parent alarm condition, then
this will contain a reference to the previous alarm redirection object in
the cascaded sequence.
redirectionaccessarea : char
The value to which the AccessArea attribute of the associated alarm will
be set, when redirection occurs.
redirectionplantarea : char
The value to which the PlantArea attribute of the associated alarm will
be set, when redirection occurs.
OpenEnterprise Schema
redirectionpriority : integer references
The value to which the priority attribute of the associated alarm will be
set, when redirection occurs.
redirectiontimeout : integer not null
The timeout period, in seconds, after which the associated alarm will be
updated with the configured redirection values.
redirectiontimer : integer references AlarmRedirectionTimer
A (transient) reference to the associated alarm redirection timer.
triggercolumn : integer default 0
This attribute will be incremented each time an alarm redirection occurs
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 63
for this object. It can then be used to trigger external calculations etc.
updateoccurrencetime : bool default FALSE
If set to TRUE, then on the redirection timer expiring the
OccurrenceTime attribute of the associated alarm will be updated to
contain the time the redirection occurred.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 64
alarmredirectiontimer
OpenEnterprise Schema
Derived From:
Description:
Attributes:
alarmredirection : integer
This is an integer value that triggers a paging alarm redirection.
oetimer
A timer used to trigger redirection of alarm messages after a configurable
period allowed for a response from alarm recipients.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 65
alarmresponseaction
OpenEnterprise Schema
Derived From:
Description:
Attributes:
alarmactiongroup:char
References alarmresponseactiongroup
delay : integer
The amount of time to wait before sending messages to recipients once
objects
This table is used by the Paging Server to determine how to act on Alarms.
an Alarm Pattern is recognized.
nextaction:char
References alarmresponseaction
repeat: integer
The number of times a message should be sent to recipients, should the
alarm continue in an unacknowledged state.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 66
alarmresponseactionemail
OpenEnterprise Schema
Derived From:
Description:
Attributes:
recipientgroup : integer
References recipientgroup associated with the alarmresponseactionemail
alarmresponseaction
This table is used by the Paging Server to determine how to act on Alarms.
object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 67
alarmresponseactiongroup
OpenEnterprise Schema
Derived From:
Description:
Attributes:
disable : bool
Disables the alarmresponseactiongroup.
objects
This table is used by the Paging Server to determine how to act on Alarms.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 68
alarmsummary
OpenEnterprise Schema
Derived From:
Description:
Attributes:
accessarea : char
The access area to which this object belongs. Used with security
<Base Table>
This table is used to store all current alarms and events. An entry in the
alarmsummary table is generated when an alarmcondition object carries
out a check upon the value of the object associated with it and finds it is
now in a position where it should alert the system, of the change in this
value, by generating an alarm.
enabled views to restrict access for unauthorised users.
acknowledged : bool
If this value is TRUE, the alarm has been acknowledged and may as a
consequence act differently. How the alarm acts depend upon the
alarmcondition reference.
acknowledgedtime : datetime
This is a timestamp of when the alarm was acknowledged by an
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 69
operator.
acknowledgedtimedstoffset : integer
This attribute is used to describe the number of minute that should be
adjusted in the date time in order to cater for local Daylight Saving Time.
alarmcondition : integer references AlarmCondition
The referenced AlarmCondition object would have been responsible for
generating this alarm summary entry.
OpenEnterprise Schema
alarmlimit : char
This is the conditional limit imposed, in text form, that created the alarm.
alarmtext : char
This is text used to describe the alarm generated in greater detail.
attribute : char
This is a component of the signal name used to communicate to remote
devices. The format for NW3000 signals is:
devicename:base.extention.attribute.
Other systems may vary.
audiblesound : char
The name and location of a .WAV file. If this value is NULL, or contains
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 70
an empty string then no sound is configured for the database object.
audiblesoundrepeats : integer
The number of times that the .WAV file is to be played. A value of -1
would indicate that the .WAV file is to be played infinitely, and 0 (zero)
would indicate that the .WAV file shouldnt be played.
base : char
This is a component of the signal name used to communicate to remote
devices. The format for NW3000 signals is:
devicename:base.extention.attribute.
OpenEnterprise Schema
Other systems may vary.
calloutarea : char
This attribute is dependent upon the system being worked upon. This
could be a geographical location, similar to plantarea. It is used, in
conjunction with calloutdisplay, to provide information on how to respond
to an alarm.
calloutdisplay : char
This is a workstation display that will supply response data for an
operator in order to deal with a alarm.
cleared : bool
This indicates if the alarm has been cleared.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 71
clienttype : char
This is a brief description of the client. E.g. OPC Server, DBB, etc.
condition : integer
This is the integer associated with a string in the alarmconditionlookup
table.
currenteventindex : integer
This value is used to define and maintain event log entries used to log
alarms, events and journal messages.
OpenEnterprise Schema
description : char
This is description of the object that the alarm in the alarmsummary
table has been created for.
devicename : char
This is a component of the signal name used to communicate to remote
devices. The format for NW3000 signals is:
devicename:base.extention.attribute.
Other systems may vary.
display : char
This attribute is used to store the name of a display associated with the
signal generating this alarm.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 72
dstoffset : integer
This is the daylight saving time offset, in minutes. It is used when
calculating times over different time zones.
eventtype : char
This is used to indicate the type of event e.g. operator action etc.
extension : char
This is a component of the signal name used to communicate to remote
devices. The format for NW3000 signals is:
OpenEnterprise Schema
devicename:base.extention.attribute.
Other systems may vary.
hasnotes : bool
If the alarm has one or more notes objects associated with it, this
attribute is TRUE.
helptext : char
The helptext can provide a meaningful diagnosis of the cause of the
alarm and potentially advise the operator upon how it should be dealt
with.
id : integer
This is the primary key attribute of the table and is automatically
allocated by the internal CL. See Appendix A for more information.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 73
lastacknowledged : datetime
This is the time at which the alarm was last acknowledged. If the alarm
has not been acknowledged this attribute remains NULL.
lastacknowledgeddstoffset : integer
This attribute is used to describe the number of minute that should be
adjusted in the date time in order to cater for local Daylight Saving Time.
lastalarmduration : char
The lastalarmduration is updated each time an alarm is cleared, and
gives a textual representation of the duration in the following form:
OpenEnterprise Schema
D HH:MM:SS.mmm
where:
D = number of days for which the alarm was uncleared
HH = number of hours
MM = number of minutes
SS = number of seconds
mmm = number of milliseconds.
lastalarmstate : integer8
This is the most recent state that the alarm has been known to be in.
Such states are: uncleared and unacknowledged uncleared but
acknowledged cleared but unacknowledged or cleared and
acknowledged.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 74
lastcleared : datetime
This is the date and time at which this alarm last went out-of-alarm.
lastcleareddstoffset : integer
This attribute is used to describe the number of minute that should be
adjusted in the date time in order to cater for local Daylight Saving Time.
lastoccurence : datetime
This is the date and time that this alarm last appeared in the
alarmsummary table.
OpenEnterprise Schema
lastoccurencedstoffset : integer
This attribute is used to describe the number of minute that should be
adjusted in the date time in order to cater for local Daylight Saving Time.
loggedtime : datetime
This is the time at which the alarm was created or updated.
loggedtimedstoffset : integer
This attribute is used to describe the number of minute that should be
adjusted in the date time in order to cater for local Daylight Saving Time.
name : char
This is the name of the signal that this alarmsummary object has been
created for.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 75
numberofeventlogs : integer default 100
This is the total number of event log entries associated with an individual
alarmsummary object.
numberofoccurences : integer
This attribute is used to keep a total count of how many times this alarm
has gone into alarm.
objectdatatype : char
This describes which one of the available data types, from the database,
the primary key of the object is. For signal generated alarms, the type is
a string.
OpenEnterprise Schema
objectname : char
The objectname attribute contains the primary key value of the object
that has been the cause of the alarm. This is given as a string even if the
primary key is an integer.
occurencetime : datetime
This is the time when the alarm was originally generated or last updated.
occurencetimedstoffset : integer
This attribute is used to describe the number of minutes that should be
adjusted in the date time in order to cater for local Daylight Saving Time.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 76
operator : char
This is the name of the operator that this alarm has been associated
with. It is optionally used as a way of providing further information on an
alarm.
operatortext : char
The operator text is an attribute that may be used on a per-system
basis. Some systems may insist that operators insert a message before
acknowledging an alarm. In these cases displays can be used to force
the operator to enter a description.
plantarea : char
The plantarea describes the geographical location of the signal. A site
may be split in smaller areas and this attribute would contain the
description of that area.
OpenEnterprise Schema
printer : char
This string determines which printer the alarm should be directed to.
priority : integer
This is a reference to an alarmpriorityblock object that describes how the
alarm should be displayed within the alarm client.
questionabletime : bool
If this flag is set to TRUE, the occurrencetime given is indicated to be
possibly inaccurate. If FALSE, the time can be relied upon to be
accurate.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 77
resetalarmstatistics : bool
This attribute will reset all the alarm statistic attributes that are
associated with the alarm condition. These are lastoccurence,
lastcleared, lastacknowledged, numberofoccurences, lastalarmduration
and totaltimeinalarm. A journal message is generated.
silenced : bool
This is set to TRUE if the alarm has been silenced, FALSE if it has not.
sourcetable : char
This is the name of the table that the object that has caused this alarm
has come from. For example, this could be one of the derived tables
from signal (i.e. RealAnalog, Digital, etc.)
OpenEnterprise Schema
status : integer
This is the current error status of the alarm. A non-zero value indicates
an error with it.
suppressed : bool
Setting this attribute to true will suppress an alarm. Setting this to false
will unsuppress the alarm and delete any suppression timer if one has
been created.
suppressedinterval : integer
This is the number of seconds that the timer will be set for when it is
initiated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 78
suppressedtimer : integer references AlarmSuppressionTimer
If an alarm summary entry is suppressed it may optionally be a timed
suppression. This will prevent further notification of the alarm from being
generated at the database. Hence, all clients will be affected.
timezone : char
This attribute is the equivalent of an entry in the timezones table. It
indicates the time zone that the alarm has been generated in and allows
the date and time to be stored in GMT.
OpenEnterprise Schema
totalacknowledged : integer
This is the total number of alarms that have been acknowledged but not
cleared yet.
totalalarms : integer
This is the total number of alarms, currently active.
totalcleared : integer
This is the total number of alarms that have been cleared but not
acknowledged.
totalnotes : integer
This is the total number of notes associated with this alarm.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 79
totaltimeinalarm : char
This string stores the number of days and the time that this object has
been in alarm. For example: 3 16:34:28.123 means the object has been
in alarm for 3 days, 16 hours 34 minutes and 28 seconds. (excluding the
milliseconds)
totalunacknowledged : integer
This is the total number of alarms that have neither been cleared or
acknowledge.
units : char
This is a description of the units that are associated with the alarm. (E.g.
litres, metres, etc.)
OpenEnterprise Schema
value : char
This attribute describes, in string format, the value of the object that
caused the alarm. For instance, this may be 54.33, if a real analog
signal has just increased above an alarm limit of 50.0.
version : integer
This is the version of the remote load that generated this alarm.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 80
alarmsuppressiontimer
OpenEnterprise Schema
Derived From:
Description:
Attributes:
oetimer
The Alarm Suppression Timer table is used to determine the period of time
that an alarm will remain suppressed.
There are various types of alarm suppression, a timed suppression
generates this timer. Once the timer expires, the alarm is unsuppressed.
A timed suppression may be generated from such client components as
the Alarm Client.
alarmref : integer references AlarmSummary
This attribute maintains a link to the alarm summary object that initiated this
timer.
alarmcondition : integer references AlarmCondition
This attribute maintains a link to the alarmcondition object that initiated this
timer.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 81
arbitrator
OpenEnterprise Schema
Derived From:
Description:
Attributes:
redundantsession : char references Redundancy
This is a link back to the redundancy object that communicates to this
dataservice
This table is used to connect to the Arbitrator (a server redundancy
component) and is utilised by the Redundancy table.
arbitrator dataservice.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 82
archivebackupitem
OpenEnterprise Schema
Derived From:
Description:
Attributes:
accessarea : char
The access area to which this object belongs. Used with security
<base_table>
Descibes archive(s) that are to be backed up as part of a backup set by the
Archive File Manager.
enabled views to restrict access for unauthorised users.
backupset : char not null references archivebackupset
A reference to the backup set that this item belongs to.
control : integer
The id of a control from the oelogcontrol table. Archives belonging to this
control will be backed up.
description : char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 83
A user specified description of this object.
id : integer
Automatically generated ID number for this object.
rate : char
The name of a rate from the oelogdata table. Archives belonging to this
rate will be backed up.
OpenEnterprise Schema
sourcedirectory : char
The directory from which archive files are to be copied.
targetdirectory : char
The directory where archive files are to be copied to.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 84
archivebackupset
OpenEnterprise Schema
Derived From:
Description:
Attributes:
accessarea : char
The access area to which this object belongs. Used with security
<base_table>.
The details of when to backup archives. Which archive files are to be
backed up are described by associated entries in the archivebackupitem
table
enabled views to restrict access for unauthorised users.
description : char
A user specified description of this object.
diary : char references diary
A diary that will be used to trigger when a backup should take place. If
this attribute is NULL then regular backups will not be performed.
dobackup : bool
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 85
Trigger variable that is used to trigger an immediate backup.
name : char
The name of this backup set.
scheme : integer
Indicates how backups are to be triggered and what the backup action
is.
OpenEnterprise Schema
tobescheduled : integer references tobescheduled
A reference to the Scheduler trigger item that will be used to trigger
backups.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 86
archivecatalogue
OpenEnterprise Schema
Derived From:
Description:
Attributes:
<Base Table>
The archivecatalogue table is used to build up and manage a catalogue of
the archive files created by an OpenEnterprise Historian.
An entry is created in this table for any archive file created by historical
data set for which the oelogdata archivecatalogue attribute is set to TRUE.
The catalogue can then be used to manage archive files within an
OpenEnterprise system, including providing the ability to bring archives on
and offline.
accessarea : char
The access area to which this object belongs. Used with security
enabled views to restrict access for unauthorised users.
archiveindex : array of archiveindex
This array of archiveindices maintains a list of all the indexes that have
been placed upon an archive file.
bringonline : bool default FALSE
If set to TRUE then this attribute will cause the archive file to which the
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 87
catalogue entry corresponds to be brought on line.
control : integer not null
This is the historical group, (i.e. the oelogcontrol entry), to which the
archive file associated with this catalogue entry belongs.
creationdate : datetime
The time of creation, in UCT, of the archive file to which this catalogue
entry relates.
OpenEnterprise Schema
creationdatedstoffset : integer
The DST Offset applicable to the value of the creationdate attribute.
currentstate : integer
Indicates the current state of the archive file associated with the
catalogue entry. The following values are supported:
0 = indicates that the archive file is on-line and was brought online automatically.
1 = the archive file is off-line, i.e. an entry exists for the archive
file in the oelogarchive table, but the offline attribute for that entry has
been set to FALSE.
2 = the archive file is not on-line, and no entry currently exists in
the oelogarchive table.
3 = indicates that the archive file is on-line and was brought on
line manually.
4 = the archive file is unavailable, i.e. the archive file cannot be
found in the directory indicated by the catalogue.
A Value of 0 or 3 indicates that the archive file is available to the system
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
A
D301521X412
24-Feb-2010 - Page 88
for historical data access.
currentstatetext : char
currentstatetime : datetime
The UCT time at which the last change of state occurred for the archive
textual representation of the current state of the archive file associated
with the catalogue entry.
file associated with the catalogue entry.
OpenEnterprise Schema
currentstatetimedstoffset : integer
The DST Offset applicable to the value of the currentstatetime attribute.
description : char
A textual description of the archive catalogue instance. On creation this
contains the name of the source table, and all attributes logged by the
historical data set, from which the archive file was generated.
directory : char
The current physical location of the archive file.
endtime : datetime
The most recent generation of data within the archive file associated
with this catalogue entry, in UCT.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 89
endtimedstoffset : datetime
The DST Offset associated with the value of the endtime attribute value.
filename : char
The name of the archive file to which the catalogue entry relates.
lastaction : integer
This attribute states whether the archive file was last brought on-line or
taken off line manually or automatically. 0: auto, 1: manual.
OpenEnterprise Schema
rate : char
The collection rate of the historical data set from which the archive file
associated with this catalogue entry was created.
starttime : datetime
The earliest generation of data within the archive file associated with this
catalogue entry, in UCT.
starttimedstoffset : integer
The DST Offset associated with the value of the starttime attribute value.
takeoffline : bool default FALSE
If set to TRUE, then this allows the archive file associated with the
catalogue entry to be taken off-line. (This operation will fail if the archive
file was brought on-line automatically).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 90
archivefile
OpenEnterprise Schema
Derived From:
Description:
Attributes:
accessarea : char
The access area to which this object belongs. Used with security
<Base Table>
This table is used within the oelogdata table to store the names of all the
archive files that are supposed to be on-line for that object. It is used to
automatically bring archive files on-line on start-up of the database.
enabled views to restrict access for unauthorised users.
archive : char
This is a reference to an object in the oelogarchive. When the database
starts up the oelogarchive object is created and this reference
maintained.
control : integer
This is a reference to the oelogcontrol table that contains the stream
information for the archive file associated with this.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 91
directory : char
The physical directory in which the archive file resides.
filename : char
This is the name of the archive file that this object has been created to
keep on-line.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 92
archiveindex
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The archive index table is a generic table used to hold the values of any
indexes contained within an archive file. It is derived from in order to hold
the specific values. See datetimearchiveindex, integerarchiveindex and
realarchiveindex table definitions.
Each archivecatalogue table maintains an array of references to the
minimum and maximum values of the indexed fields within the associated
archive file.
Indexes are currently only available for datetime, integer and real attributes
of raw datasets, (i.e. those with a rate of 0s).
Attributes:
accessarea : char
The access area to which this object belongs. Used with security
enabled views to restrict access for unauthorised users.
description : char
A textual description of the archive index entry.
filename : archivecatalogue
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 93
A reference back to the archive catalogue table entry to which the
archive index entry relates.
indexdatatype : integer8
The data type of the archive index entry. This can be one of the
following three values:
0 = indicates that this is a datetime index.
1 = indicates that this is an integer index.
2 = indicates that this is a real index.
OpenEnterprise Schema
indexname : char
This defines the name of the attribute, in the source table for the data
set, on which the index is defined. This will hold the oelogcolumn name
attribute value, for the associated data set.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 94
attributes
OpenEnterprise Schema
Derived From:
Description:
Attributes:
default_value : char
Attributes within tables may be assigned a default value. If this is the
<Base Table>
This system table is used to store all the attributes of all the tables in the
system. It is automatically inserted into by the database when a user
creates a new table with one or more attributes.
case, then the string representation of this value is stored in the
default_value attribute.
isarray : bool
If the attribute is an array this column will be TRUE. Arrays may not be
viewed in SQL because they are not a relational concept.
ishidden : bool
If the attribute is hidden from the select statement this value will be set
to TRUE. Otherwise, it will be FALSE. Explicitly specifying the column in
a select statement will return the column and associated value(s).
However, using the * wildcard will fail to return this column. Arrays are
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 95
always hidden.
isprimary : bool
This column determines if the attribute is a primary key attribute of the
table specified in the table name column.
length : integer
This is an internal attribute, used to maintain information on an individual
attribute.
OpenEnterprise Schema
name : char
This is a primary key of the attributes table. The other primary key is the
table_name column. The name attribute describes the text used to
categorise the column.
not_null : bool
This boolean value will determine if a value of NULL is acceptable for
this column or not. If not_null is TRUE, an insertion of an object in this
table will not be allowed unless a not-null value for this attribute has
been specified. Thereafter, the value may never return to NULL either.
persistence : bool
A tables persistent functionality, determined by the persistence attribute
of the tables table, may be overwritten by this value, for this individual
attribute, by specifying TRUE to store the value to disk or FALSE to
prevent writing to disk.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 96
table_name : char
This is a primary key of the attributes table. The other primary key is the
name attribute. The table_name attribute is a reference to the table that
this attribute is a member of.
type : char
The type attribute is a reference to the tables table. This will be the data
type of the attribute and can be a built-in type a domain or a table.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 97
attributetrigger
OpenEnterprise Schema
Derived From:
Description:
Attributes:
accessarea : char
The access area to which this object belongs. Used with security
<Base Table>
This table is used to define all calculation attribute triggers. A single
calculation can have none, one or more entries in this table.
From this table, specific attribute triggers are generated:
SignalAttributeTrigger, RealAnalogAttributeTrigger, IntegerAttributeTrigger,
etc.
enabled views to restrict access for unauthorised users.
calculationname : char references Calculation
This is a link to the calculation that will be executed when the trigger is
activated.
dataservice : char
Not Implemented
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 98
disable : bool
Disable the attribute trigger.
id : integer
The unique identifier for this object. See Appendix A for more details.
linkerrortext : char
Display a meaningful error message corresponding to the status
attribute.
OpenEnterprise Schema
objectname : char
This attribute can be used (in the derived versions of this table) to link to
attributes other than the default for that individual implementation. For
instance the SignalAttributeTrigger table implements name as the
default attribute to link to. This attribute would be used to override this.
objecttype : char
This is the primitive type of the attribute being linked to. E.g. char,
integer, etc.
objectvalue : char
This is the value that is within the table determined by tablename and
the attribute determined by objecttype. For instance: if we have a
SignalAttributeTrigger then we shall be linking to the Signal table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 99
status : integer
Error status of the object. 0 indicated no error. A negative value
indicates an error. See Calculation Guide for up-to-date list of error
codes.
tablename : char
This is the name of the table that the derived instances of this table will
be linking to.
triggername : char
This is the actual attribute that will be monitored for changes. When this
attribute changes within the linked object, the object is said to have
triggered.
OpenEnterprise Schema
usingpk : bool
This attribute is used internally to determine the type of SQL query that
should be created upon the target table (specified in tablename).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 100
autologouttimer
OpenEnterprise Schema
Derived From:
Description:
Attributes:
accessarea : char
The access area to which this object belongs. Used with security
oetimer
This table is a timer class that will drive the auto logout functionality within
the database. When the timer expires (defaults to every second) all
workstation connections are checked and all data connections are checked
to determine if the connection requires timing out.
enabled views to restrict access for unauthorised users.
calculationname : char references Calculation
This is a link to the calculation that will be executed when the trigger is
activated.
dataservice : char
Not Implemented
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Loading...