advertisement
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
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 3
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 4
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 5
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 6
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 7
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 8
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 9
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 10
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 11
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 12
OpenEnterprise Schema
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: 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.
Attributes: 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
OpenEnterprise Schema
abdevice
Derived From:
Description: 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.
Attributes: 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
OpenEnterprise Schema 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.
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
OpenEnterprise Schema blastconfigerror : integer
Set to the last configuration error value for the B PLC. bmainplc : bool
Used for monitoring purposes only.
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.
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
OpenEnterprise Schema
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.
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: 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.
Attributes: devicename : char references ABDevice
This is a reference to the device that is being monitored.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 20
abdigital
OpenEnterprise Schema
Derived From:
Description: digital
This table maintains information about digital signals specifically for Allen
Bradley devices.
Attributes: fileaddress : char
The PLC data file address. The address must be a bit address e.g.
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: 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).
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. 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.
OpenEnterprise Schema 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.
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
OpenEnterprise Schema 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. 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: integeranalog
This table maintains information about Integer signals specifically for Allen
Bradley devices.
Attributes: fileaddress : char
The PLC data file address. The specified address must be a word 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
OpenEnterprise Schema
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.
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: dvi_datum
Description: 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
OpenEnterprise Schema 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. 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
OpenEnterprise Schema startaddressinuse : integer
The first PLC file offset being actively polled by ABRDI. Used for monitoring purposes only.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 30
abrealanalog
OpenEnterprise Schema
Derived From:
Description:
This table maintains information about floating-point signals specifically for
Allen Bradley devices. realanalog
Attributes: fileaddress : char
The PLC data file address. E.g. F100:0 or N101:0.
Mandatory. readquestionable : integer
This value indicates the last read value of the questionable status of the 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:
<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.
Attributes: accessarea : char references AccessAreaConfig
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
OpenEnterprise Schema
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.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 33
accessareaconfig
OpenEnterprise Schema
Derived From:
Description:
<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.
Attributes: 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 34
accessareaconfigforuser
OpenEnterprise Schema
Derived From: View onto accessareaconfig
Description: 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.
Attributes: 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:
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.
Attributes: encryptedpassword : char
An encrypted version of the password. This is used by the OE Security
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
OpenEnterprise Schema
alarmcondition
Derived From:
Description:
<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.
Attributes: accessarea : char alarmaction : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users.
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
OpenEnterprise Schema 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. 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
OpenEnterprise Schema 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. 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
OpenEnterprise Schema 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. 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
D301521X412
24-Feb-2010 - Page 40
OpenEnterprise Schema 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 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 updated when an alarm is updated or created.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 41
OpenEnterprise Schema 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. 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
OpenEnterprise Schema
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
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
OpenEnterprise Schema
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.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 44
alarmconditionlookup
OpenEnterprise Schema
Derived From: <Base Table>
Description: 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.
Attributes: accessarea : char
The access area to which this object belongs. Used with security 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: alarmcondition
This table defines the functionality common to all alarm inhibit alarm conditions.
Attributes: name : char references Signal
This is a foreign key reference to the signal table.
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
Derived From:
Description:
OpenEnterprise Schema mailformat
This table contains templates to be used for formatting alarm notification messages.
Attributes: body : char subject : char
Contains the definition of the text to appear in the message body.
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: mailformat
This table contains templates to be used for formatting alarm notification messages.
Attributes: message : char
Contains the template definition of the text to appear in the message 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: objects
This table contains information regarding alarm paging recipients. This information enables the Paging Server to page them.
Attributes: disable:bool
Disables this alarm paging recipient object. 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: pattern
Provides the rules to determine if a new alarm should be sent by email to the appropriate recipients.
Attributes: alarmsaccessarea : char
Template to compare against the accessarea attribute in the
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
OpenEnterprise Schema 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. 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
OpenEnterprise Schema 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.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 53
alarmpriorityblock
OpenEnterprise Schema
Derived From:
Description:
<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.
Attributes: accessarea : char
The access area to which this object belongs. Used with security 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
OpenEnterprise Schema 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. 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
OpenEnterprise Schema 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 printer : char priority : integer
This indicates whether the alarms of this priority should be printed or not.
This is the name given to allow access to a printer to which print outs of alarms should be sent for this priority.
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
OpenEnterprise Schema
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. 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.
OpenEnterprise Schema 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.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 58
alarmrecipient
OpenEnterprise Schema
Derived From:
Description: objects
The Alarm Recipient table is derived from the Recipient table and is specifically aimed at recipients receiving and acknowledging alarm details.
Attributes: acknowledgementkey : char
The key that must be specified by the recipient in order to acknowledge 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
OpenEnterprise Schema 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.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 60
alarmredirection
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table contains all the configuration and management information required to provide alarm redirection functionality.
Attributes: alarmcondition : integer references
A reference to the parent alarm condition object. 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
OpenEnterprise Schema 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. 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
OpenEnterprise Schema 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. 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
OpenEnterprise Schema 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.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 64
alarmredirectiontimer
OpenEnterprise Schema
Derived From:
Description: oetimer
A timer used to trigger redirection of alarm messages after a configurable period allowed for a response from alarm recipients.
Attributes: alarmredirection : integer
This is an integer value that triggers a paging alarm redirection.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 65
alarmresponseaction
OpenEnterprise Schema
Derived From:
Description: objects
This table is used by the Paging Server to determine how to act on Alarms.
Attributes: alarmactiongroup:char
References alarmresponseactiongroup delay : integer
The amount of time to wait before sending messages to recipients once 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
OpenEnterprise Schema
alarmresponseactionemail
Derived From:
Description: alarmresponseaction
This table is used by the Paging Server to determine how to act on Alarms.
Attributes: recipientgroup : integer
References recipientgroup associated with the alarmresponseactionemail object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 67
alarmresponseactiongroup
Derived From:
Description:
OpenEnterprise Schema objects
This table is used by the Paging Server to determine how to act on Alarms.
Attributes: disable : bool
Disables the alarmresponseactiongroup.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 68
alarmsummary
OpenEnterprise Schema
Derived From:
Description:
<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.
Attributes: accessarea : char
The access area to which this object belongs. Used with security 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.
OpenEnterprise Schema 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. alarmlimit : char alarmtext : char attribute : char
This is the conditional limit imposed, in text form, that created the alarm.
This is text used to describe the alarm generated in greater detail.
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
OpenEnterprise Schema 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.
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
OpenEnterprise Schema
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. 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
OpenEnterprise Schema
This is the daylight saving time offset, in minutes. It is used when calculating times over different time zones. eventtype : char extension : char
This is used to indicate the type of event e.g. operator action etc.
This is a component of the signal name used to communicate to remote devices. The format for NW3000 signals is:
devicename:base.extention.attribute. hasnotes : bool helptext : char id : integer
Other systems may vary.
If the alarm has one or more notes objects associated with it, this attribute is TRUE.
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.
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
OpenEnterprise Schema 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:
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
OpenEnterprise Schema 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. 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
OpenEnterprise Schema 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. 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
OpenEnterprise Schema
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 printer : char priority : integer
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.
This string determines which printer the alarm should be directed to.
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
OpenEnterprise Schema 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.) 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
OpenEnterprise Schema 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. 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
OpenEnterprise Schema 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.) 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
OpenEnterprise Schema
alarmsuppressiontimer
Derived From:
Description: 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.
Attributes: 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: dataservice
This table is used to connect to the Arbitrator (a server redundancy component) and is utilised by the Redundancy table.
Attributes: redundantsession : char references Redundancy
This is a link back to the redundancy object that communicates to this arbitrator dataservice.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 82
archivebackupitem
OpenEnterprise Schema
Derived From:
Description:
<base_table>
Descibes archive(s) that are to be backed up as part of a backup set by the
Archive File Manager.
Attributes: accessarea : char
The access area to which this object belongs. Used with security 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
OpenEnterprise Schema
A user specified description of this object. id : integer rate : char
The name of a rate from the oelogdata table. Archives belonging to this rate will be backed up. sourcedirectory : char
The directory from which archive files are to be copied. targetdirectory : char
The directory where archive files are to be copied to.
Automatically generated ID number for this object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 84
archivebackupset
OpenEnterprise Schema
Derived From: <base_table>.
Description: The details of when to backup archives. Which archive files are to be backed up are described by associated entries in the archivebackupitem table
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 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
OpenEnterprise Schema
Trigger variable that is used to trigger an immediate backup. name : char scheme : integer
The name of this backup set.
Indicates how backups are to be triggered and what the backup action is. 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:
<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.
Attributes: 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
OpenEnterprise Schema 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. 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
D301521X412
24-Feb-2010 - Page 88 for historical data access.
OpenEnterprise Schema currentstatetext : char
A textual representation of the current state of the archive file associated with the catalogue entry. currentstatetime : datetime
The UCT time at which the last change of state occurred for the archive file associated with the catalogue entry. 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
OpenEnterprise Schema 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. 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
OpenEnterprise Schema
archivefile
Derived From: archive : char control : integer
<Base Table>
Description: 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.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users.
This is a reference to an object in the oelogarchive. When the database starts up the oelogarchive object is created and this reference maintained.
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
OpenEnterprise Schema
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.
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
OpenEnterprise Schema
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. 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:
<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.
Attributes: default_value : char
Attributes within tables may be assigned a default value. If this is the 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 length : integer name : char not_null : bool
OpenEnterprise Schema
This column determines if the attribute is a primary key attribute of the table specified in the table name column.
This is an internal attribute, used to maintain information on an individual attribute.
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.
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
OpenEnterprise Schema 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.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 97
attributetrigger
OpenEnterprise Schema
Derived From:
Description:
<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.
Attributes: accessarea : char
The access area to which this object belongs. Used with security 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.
OpenEnterprise Schema 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. 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
OpenEnterprise Schema
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. 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: 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.
Attributes: accessarea : char
The access area to which this object belongs. Used with security 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 101 disable : bool
Disable the attribute trigger.
OpenEnterprise Schema 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. 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. status : integer
Error status of the object. 0 indicated no error. A negative value
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 102
OpenEnterprise Schema 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. 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 103
backupline
OpenEnterprise Schema
Derived From:
Description: objects
Table for use with OpenBSI comm stats.
Attributes: acktimeouts:Integer
Total number of acknowledgement timeouts on line. backupname:Char
Name of backup line. broaddialfailure:Integer
Number of comms failures when slave dialled in. broadtimeouts:Integer
Number of timeouts when slave dialled in.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 104 bufferoverflow:Integer
Byte stream overflowed buffer.
OpenEnterprise Schema consecutivemessages:Integer
Received two copies of message. crcreceived:Integer
Number of CRC errors received. crcsent:Integer dialerror:Integer
Number of CRC errors sent.
0: OK;
1: No Carrier;
2: Timeout;
3: Dial Fail dialerrortext:Char
Textual representation of dialerror.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 105
OpenEnterprise Schema dialfailures:Integer
Total number of dial failures on line. dialstate:Integer
0: Idle;
1: Slave Dial;
2: Start Dial;
3: Connect;
4: Hang-up dialstatetext:Char
Textual representation of dial state. dialsuccesses:Integer
Total number of dial successes on line. invalidack:Integer
Invalid ACK message. invaliddle:Integer
Invalid DLE sequence.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 106 linedirection:Integer
0: not;
1: In;
2: Out
OpenEnterprise Schema linedirectiontext:Char
Textual representation of line direction. linestate:Integer
0: Free;
1: In Use;
2: Stopped;
3: Suspended;
4: Failed linestatetext:Char
Textual representation of line state. messagesreceived:Integer
Number of messages received. messagessent:Integer
Number of messages sent.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 107
OpenEnterprise Schema missedend:Integer
End sequence missed. naksreceived:Integer
Number of NAKS received. nakssent:Integer nobuffer:Integer
Number of NAKS sent.
Buffer not available for next message. pollssent:Integer rtuindex: rtuname:Char
Total number of polls sent.
Reserved for future use.
Reserved for future use.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 108 timeoutsreceived:Integer
Number of timeouts received. timeoutssent:Integer
Number of timeouts sent.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 109
backuplinestats
OpenEnterprise Schema
Derived From:
Description: objects
Table for use with OpenBSI comm stats.
Attributes: dialindisabled:Integer
Total number of dial-in lines disabled dialinfailed:Integer
Total number of dial-in lines failed to start dialinfree:Integer
Total number of dial-in lines available dialininuse:Integer
Total number of dial-in lines in use
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 110
OpenEnterprise Schema dialinstarted:Integer
Total number of dial-in lines started successfully dialinstopped:Integer
Total number of dial-in lines stopped successfully dialintotal:Integer
Total number of dial-in lines configured dialoutdisabled:Integer
Total number of dial-out lines disabled dialoutfailed:Integer
Total number of dial-out lines failed to start dialoutfree:Integer
Total number of dial-out lines available dialoutinuse:Integer
Total number of dial-out lines in use
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 111
OpenEnterprise Schema dialoutstarted:Integer
Total number of dial-out lines started successfully dialoutstopped:Integer
Total number of dial-out lines stopped successfully dialouttotal:Integer
Total number of dial-out lines configured
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 112
binarysignal
OpenEnterprise Schema
Derived From:
Description: signalextension
This table defines the binary signals. Device specific fields should be defined in the derived tables.
Attributes: defaultvalue : binary
This value will be used at database start-up to set the associated signals value and readvalue. No default value. lastoverridevalue : binary
The last override value set by the user (or the value existing when an override was enabled). Used to restore the override value following a database restart. lastreadvalue : binary
The last value read from the RTU. This will be updated using the readvalue attribute whilst an override is enabled. This value will be copied into value and readvalue when an override is cancelled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 113 readvalue : binary
OpenEnterprise Schema
This is the binary value of the signal most recently received from the device. value : binary
This is the binary value that is accessible to client processes. They will set this value.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 114
breakpoint
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
This table is used to control the execution of CL. By specifying the class, routine and line number, the execution of the code may be halted. This is used for debugging the code. Objects may be inserted or deleted and enabled or disabled while the database is running.
Attributes: active : bool class : char counter : integer
Determines if the breakpoint object is enable or disabled.
This is the name of the class for which this breakpoint is configured.
This is the incremented count of the number of times this breakpoint has been passed while it is active. id : integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 115
OpenEnterprise Schema
This is a unique identifier for the breakpoint object. line : integer routine : char
This is the line number within the routine that the breakpoint is configured for.
This is the name of the routine within the class that the breakpoint will occur in.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 116
bsapline
OpenEnterprise Schema
Derived From:
Description: line
Used by the OpenBSI Comm Stats component. A table that represents all
BSAP lines that have been configured.
Attributes: acktimeouts:Integer
Total number of acknowledgement timeouts on line. backpad:integer
Reserved for future use. baudrate:char
Baudrateindex:integer
0 = None
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 117
1 = 300
2 = 1200
3 = 2400
4 = 4800
5 = 9600
6 = 19200
7 = 38400
8 = 57600
9 = 115200 broaddialfailure:integer
Reserved for future use broadtimeout:integer
Reserved for future use currentdialledrtu:char
Reserved for future use. dial:Boolean
If TRUE this port is a dial-up port.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 118 dialerror:Integer
Last error on the dial line
OpenEnterprise Schema dialfailures:Integer
Total number of dial failures on line. dialparamdtrsupport:bool
Reserved for future use. dialparamhangdelay:integer
Reserved for future use. dialparamhangretries:integer
Reserved for future use. dialparamhangstr1:char
Reserved for future use. dialparamhangstr2:char
Reserved for future use. dialparamhangtimeout:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 119
Reserved for future use.
OpenEnterprise Schema dialparaminitstr:char
Reserved for future use. dialparamnodatatimeout:integer
Reserved for future use. dialparamretries:integer
Reserved for future use. dialparamtimeout:integer
Reserved for future use. dialstate:Integer
State of the dial line dialsuccesses:Integer
Total number of dial successes on line. firstslaveindex:Integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 120
Reserved for future use.
OpenEnterprise Schema frontpad:integer modem:Boolean
Reserved for future use.
If TRUE this port requires RTS/CTS. outqueue:Integer
Number of messages outstanding for write pollperiod:integer
Line’s poll period pollssent:Integer timeout:integer
Total number of polls sent.
Reserved for future use.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 121
calculation
OpenEnterprise Schema
Derived From:
Description: objectsextension
An entry within this table is used to launch one of several operations. It can execute an external command file (CMD, BAT, etc.) or and executable
(.EXE). Also it may launch an ActiveX DLL.
The operation is instigated by setting the calculate attribute to true. This is turn can be triggered by other objects in the database like AttributeTrigger derived instances.
See the Calculation Server User Guide for further extensive details on this, and other associated, tables.
Attributes: affinitymask : integer
The affinitymask is only applicable to multi-processor computers and can be used to specify which processors the calculation is allowed to run on. args : char
The arguments that should be passed to the application launched by this calculation.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 122
OpenEnterprise Schema attributetriggers : array of AttributeTrigger
This attribute is an array of one or more calculation triggers. calculate : bool
Setting this to true starts the calculation now. This attribute ignores the current state of the disable flag and minimum interval. callbacktimer : integer references CalculationCallBackTimer
This attribute maintains a reference to the callback table. It is used when a minimalinterval has been specified for calculation executions. completiontime : datetime
The time when the calculation last completed. Specified in GMT. diary : char due : bool disable : bool
FK reference to the diary that is used to invoke this calculation.
Disables this calculation.
Setting this attribute to true starts the calculation. Setting this attribute will only take affect if the calculation is not disabled and the minimum interval has not been breached.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 123
OpenEnterprise Schema ignorecompletionstatus : bool default FALSE
Used when chaining calculations to allow the next calculation to be started irrespective of the completion status of the current calculation. interactive : bool
Determines if the application launched by this calculation interacts with the Windows NT desktop, i.e. does the application display a user interface. lastcalculatetime : datetime
The time that this calculation was last triggered. lastduetime : datetime
The last time that this calculation was required to be run. This time will differ from the lastcalculatetime if the calculation was disabled, already running or the minimum interval was not achieved. minimuminterval : datetime
Controls the minimum period between this calculation being run and then run again. Use this attribute to stop a calculation from being run too often. nextcalculation : char
When chaining calculations this is the FK reference to the next calculation to be started.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 124
OpenEnterprise Schema programid : char serverid : char startin : char
The programid field specifies the calculation component to be executed.
This can be an ActiveX DLL, an executable or Windows command file.
The name of the Calculation Server that will run this calculation. It is possible to run multiple Calculation Servers on the same or different computers.
The working directory that the application started by this calculation should be launched in. status : integer statustext : char
The current status of this calculation.
A textual description of the status of this calculation. tobescheduled : integer reference ToBeScheduled
Here a link to the ToBeScheduled table is internally available. A link is only created when the object is being deleted and need to ensure no
ToBeScheduled object exists for this object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 125
calculationcallbacktimer
Derived From:
Description:
OpenEnterprise Schema oetimer
The callback timer is used when the calculation has been prompted to execute twice within the minimalinterval number of seconds, specified in the Calculation object.
Attributes: calculation : char
References the name of the calculation that this call back timer belongs to.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 126
calculationstatusalarmcondition
OpenEnterprise Schema
Derived From:
Description: alarmcondition
This alarm condition is specific to Calculations. When the status value changes an alarm can be generated.
Attributes: laststatus : integer default 0
The last status of the calculation. Used when determining if a new alarm should be generated on a calculation status change. monitoralarm : bool default FALSE
When set to TRUE all calculation status changes will result in the creation of a new alarm or the updating of an existing alarm. By default only error conditions will generate a new alarm or an existing alarm to be updated. name : char
The name of the calculation for which this alarm condition belongs.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 127
OpenEnterprise Schema
calendarevents
Derived From:
Description:
<Base Table>
Calendar events are used to group individual days into blocks where the user might want to override the normal behaviour for a diary. A typical use of a calendar event might be to mark holidays. The eventperiods table is used to associate days with a calendar event.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. backcolor : integer
Colour used in configuration tools when representing or highlighting this calendar event.
Currentlocker : char
Override user name that allows a locked object to be unlocked.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 128 description : char
OpenEnterprise Schema
An optional description of this calendar event. locked : bool locker : char name : char priority : integer
This attribute will be set to true if any of the configuration tools are currently editing this object.
The name of the user who is currently editing this object.
The unique name used to identify this object.
Priority associated with this calendar event. 1 is the highest priority, as this values increases the priority decreases. 0 and NULL are special cases indicating the lowest priority of all and would only normally be used for the standard calendar event.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 129
calendareventsfordiary
OpenEnterprise Schema
Derived From: <Base Table>
Description: This table associates diaries and calendars and selects which pattern will be effective for the given diary when the calendar is current.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. caleventref : char
The name of the calendar event that this object applies to. diaryref : char
The name of the diary that this object applies to. name : char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 130
OpenEnterprise Schema
The unique name used to identify this object. schedpatternref : char
The name of the schedule pattern that should be used when for the diary diaryref when the current day is of type caleventref.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 131
clcontrol
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
This table always contains one object. No more and no less. Its purpose is to enable or disable the execution of CL within the database. This is achieved by setting the disable attribute.
Attributes: disable : bool id : integer
A value of TRUE will disable any execution of CL within the database. A value of FALSE will re-enable it.
This is the primary key of the clcontrol table. No objects may be inserted or deleted from the table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 132
column_privileges
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The column_privileges table is a system table that is used to display the column security settings of the database. This security feature allows a user to one security privilege upon a whole table and a different one upon an individual column in that table.
Attributes: column_name : char
This is the name of the attribute within a table (specified by table_name) that these privileges have been set against. grantee : char
This is the name of the user that received these privileges. grantor : char
This is the name of the user that set these privileges. insert_grantable : bool
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 133
OpenEnterprise Schema
Setting this to TRUE allows this user to pass the insert privilege to other users upon this table. insert_priv : bool
Setting this to TRUE gives the user the ability to create initial values for this attribute when inserting an object into the table with commands such as INSERT INTO. table_name : char
This is the name of the table whose attribute has these security settings upon it. update_grantable : bool
Setting this to TRUE allows this user to pass the update privilege to other users upon this table. update_priv : bool
Setting this to TRUE gives the user the ability to update this attribute of the table with commands such as UPDATE.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 134
connection_config
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
This table will contain a record for each currently connected client and resolves the client to a time zone.
This table is currently not used within OpenEnterprise.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. port_id : integer timezone : char
This is the IP port address upon the machine.
This is a reference to the timezones table. It will describe the time zone that the client is set-up within.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 135
OpenEnterprise Schema
controlcurve
Derived From:
Description: scheduleevents
Not used provided for computability with earlier schema versions.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. port_id : integer
This is the IP port address upon the machine. timezone : char
This is a reference to the timezones table. It will describe the time zone that the client is set-up within.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 136
currentuser
OpenEnterprise Schema
Derived From:
Description: view onto users
This view shows the username and password information for the currently logged on user. This view will only ever contain one object.
Attributes: encryptedpassword : char
This is an encrypted version of the password attribute. name : char password : char
This Primary Key is the username assigned to the logged on user.
This is the password assigned to the user. This attribute is not encrypted. This is not a problem since the only user who can see the object in this view is the current user.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 137
databasereplication
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The DatabaseReplication table is used to define, generally, what static configuration information should be replicated (copied) to other databases in a distributed database system.
Currently this table is unused, but its future intended use is to provide an external client with the information it needs to determine what information within the database should be replicated to other distributed databases.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. attributelist : char
A list of the attributes within the table identified by the tablename attribute value, for which replication is required. databaselist : char
A list of databases to which replication is to occur for the table, attribute and object lists specified for this entry.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 138
OpenEnterprise Schema id : integer
Primary Key. Unique identifier. Created by CL. See Appendix A for more details.
Used internally to keep track of the next valid id number. nextid : integer objectslist : integer
The list of objects within the tablename table for which information is to be replicated. primarykey : char
The primary key column(s) for the tablename table. quantity : integer tablename : char
Used internally to keep track of the number of objects in the table.
The name of the table for which replication of information to other distributed databases is required.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 139
databasetimestatus
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Derived From: <Base Table>
Description: This table contains the timezone and daylight saving time (DST) information relevant to the locale that the database is running in. The table will only contain a maximum of one entry.
Remember that some countries or regions do not adjust for DST. Such as
Colombia and Arizona. Most often those regions situated closer to the equator will not adjust for DST.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. currentdstoffset : integer
This is the number of minutes adjustment that is required to any datetime generated in the database at this moment. This figure will be found stored alongside the datetime in any particular table that adheres to DST.
Reference Guide
D301521X412
24-Feb-2010 - Page 140 id : integer
Primary Key. Unique identifier.
OpenEnterprise Schema lastdstchange : datetime
This is the date and time at which the last DST adjustment occurred.
This date is usually in May or October. Dates vary depending upon which timezone you are in. nextdstchange : datetime
This is the date and time at which the next DST adjustment occurs. previousdstoffset : integer
The number of minutes adjustment required for the times before the current DST settings. timezone : char references TimeZones
This is a textual description of the timezone that the database is running within. timezoneoffset : integer
This is the number of minutes that the timezone is offset from GMT
(UTC)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 141
dataconnection
OpenEnterprise Schema
Derived From: <Base Table>
Description: This table is used to describe the current connections to the database from clients.
Attributes: autodisconnect : bool
Currently unused attribute, sourced from the fifth item in the environment string. client_type : char clienthost : char
Indicates the type of connection to the database. This is generally CAPI
(a ClientAPI connection), RTRDB, ODBC, or SQLC.
This is the second item in the comma-separated env attribute, and indicates the name of the workstation from which the connection occurred.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 142 clientid : char
OpenEnterprise Schema
This is the first item in the comma-separated env attribute. It is used for journalling within the system. It specified the type of client connection.
For example: SQLC Client, AlarmClientServer, etc. connectiontime : datetime
The UCT time at which the database connection occurred. connectiontimedstoffset : integer
The DST offset applicable to the value of the connectiontime attribute value. env : char
An application specific string passed in through the login operation. This string is used to populate the clientid, clienthost, oeversion, timezone and the unused autodisconnect attributes. id : integer
The string is a comma-separated list or up to 5 items, of the form:
'DatabaseExplorer,VOYAGER,2.12 Build 34,GMT,FALSE'
Unique identifier of this object in the table. lastusername : char hidden
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 143
OpenEnterprise Schema
The previous user of the socket connection. Used for journalling. machine : integer
The IP address as a 4 byte integer of the machine that the client is running from. For example an SQL client connected locally would have a machine number of 2130706433. Converted to Hex this number is
7F000001. To arrive at the IP address, use the four pairs of hex numbers from left to right, which gives 7F,00,00,01. These resolve to an
IP address of 127.0.0.1 (the local host address). oeversion : char
This is the third item obtained from the (optional) environment string, when a user logs on to a database connection, and indicates the version of OE for the component performing the connection. offsetfromuct : integer
The number of minutes from UCT for the time zone specified in the timezone attribute value. query_max_rows_default : integer
Reserved for future use. query_max_rows_limit : integer
Reserved for future use. query_memory_limit : integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 144
Reserved for future use.
OpenEnterprise Schema query_processed_rows : integer
Reserved for future use. query_timeout_default : integer
Reserved for future use. query_timeout_limit : integer
Reserved for future use. timezone : char
This is the third item in the comma-separated env attribute. It relates to a value in the timezones table and allows the client to retrieve information in the clients local time. It is used in conjunction with views. tran_modified_rows_limit : integer
Reserved for future use. tran_rollback_limit : integer
Reserved for future use. userchangetime : datetime
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 145
OpenEnterprise Schema
The UCT time at which the last change of user, log on OR log off) occurred for the database connection. userchangetimedstoffset : integer
The DST offset applicable to the value of the userchangetime attribute. username : char
This is the name of the current user logged in on this connection. A
NULL value maintains the connection without a logged in user. workstation : char references workstation
A reference to the workstation table entry with which this socket connection is associated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 146
dataquery
Derived From:
Description:
OpenEnterprise Schema
Base Table
Contains entries generated by the rtrdb for active queries initiated on the tables specified in the DataQueryMonitor table. Cannot be modified by the user.
Attributes: id:integer
A unique integer for each entry in the table (normally generated by CL). invalid:bool maxrows:integer
Indicates whether the active query being monitored is currently invalid. A value of false or null indicates the active query is valid and operating correctly. A value of true indicates the query is invalid (i.e. a schema change has occurred that has invalidated the query) and is suspended.
The maximum row count set for the active query that is being monitored.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 147 pollperiod:integer
OpenEnterprise Schema
The poll-period, in milliseconds, set for the active query that is being monitored. querytype:char session:integer
The type of active query being monitored by the rtrdb. The only two options are ‘sql’ (for SQL queries) or ‘object’ (for object queries).
The client session that issued the active query that is being monitored.
References the appropriate record in the DataConnection table. sourcetable:char text:char
The name of the table or derived view being monitored by the rtrdb for active queries.
This is the text of the query. For object queries it will have the form,
<column name>=<value>,<column name>=<value> ... where the
<value> is the literal constant representation of the value. For example, the text for an object query could be 'name=North:SINE.VALUE.001'.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 148
dataquerymonitor
Derived From:
Description:
OpenEnterprise Schema
Base Table
The DataQueryMonitor table is used to instruct the rtrdb as to which tables should be monitored for active queries. An entry in the DataQueryMonitor table will cause the rtrdb to monitor active sql or object queries in the named table and its derived tables and views.
Attributes: id:integer
A unique integer for each entry in the table (normally generated by CL). querytype:char sourcetable:char
The type of active query to be monitored by the rtrdb. The only two options are ‘sql’ (for SQL queries) or ‘object’ (for object queries).
The name of the table to be monitored for active queries. This entry must be a table (views are not allowed). However, the rtrdb will also monitor tables and views derived from the source table. For instance, if an entry was created for the 'realanalog_table', the rtrdb would also monitor the nw3000realanalog view for any active queries.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 149
dataservice
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
The dataservice table allows connections to extra alternative or extra data services.
Attributes: ftmode : integer isopen : bool name : char
The fault tolerant mode of the table.
This attribute indicates whether the connection is currently open or closed.
This is the string that describes the protocol, host and service that a client application (i.e. Alarm View, Trend View) attempting to connect to the database will need to use. The protocol and host values are optional.
This is the format used:
[<protocol>/][<hostname>:]<service>
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 150
datetimearchiveindex
OpenEnterprise Schema
Derived From:
Description: archiveindex
This table is used to store the minimum and maximum values of a datetime index for the associated archive file.
See also archivecatalogue, integerarchiveindex and realarchiveindex.
Attributes: maximumvalue : datetime
The maximum value, in UCT, of the datetime index for the associated archive file. maximumvaluedstoffset: integer
The DST Offset applicable to the value of the minimumvalue attribute. minimumvalue : datetime
The minimum value, in UCT, of the datetime index for the associated archive file.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 151
dbcontrol
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The use of this table should be avoided until a descriptive account of its used can be obtained.
Attributes: checksum : datetime
This attribute is currently undocumented. Do not use. id : integer
This attribute is currently undocumented. Do not use. restart : integer
This attribute is currently undocumented. Do not use.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 152
OpenEnterprise Schema
devicestatscallbacktimer
Derived From:
Description: oetimer
A timer table created for handling device communications percentage statistics
Attributes:
No attributes extend this table
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 153
diary
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table defines the diary entries used to control the behaviour of the
OpenEnterprise Scheduler component.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. currentlocker : char
Override user name that allows a locked object to be unlocked. diarytime : datetime
The time at which this diary becomes effective. For a single shot diary, this is also the time that the diary expires at. diarytimedstoffset : integer
The number of minutes that the value in diarytime needs to be adjusted
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 154 by to get to DST.
OpenEnterprise Schema enabled : bool default TRUE
Controls whether the Scheduler should trigger events for this diary. True indicates that events should be scheduled, false that they should not. A null value is treated as a false value. endtime : datetime
The time at which the diary itself should next trigger. See the starttime attribute for more information. endtimedstoffset : integer
The number of minutes that the value in endtime needs to be adjusted by to get to DST. lastscheduletime : datetime
The actual time that this diary last triggered an event. The event may have been due to the diary expiring or an event in the associated pattern, if there is one. lastscheduletimedstoffset : integer
The number of minutes that the value in lastscheduletime needs to be adjusted by to get to DST. locked : bool
This attribute will be set to true if any of the configuration tools are
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 155 currently editing this object.
OpenEnterprise Schema locker : char
The name of the user who is currently editing this object. name : char
The unique name used to identify this diary object. nextscheduletime : datetime
The time when this diary is next expected to trigger an event. The event may be due to the diary expiring or an event in the associated pattern, if there is one. nextscheduletimedstoffset : integer
The number of minutes that the value in nextscheduletime needs to be adjusted by to get to DST. offsetday : integer
The daily offset within the repeatinterval at which the diary is triggered.
This is applicable to any scheduled diary greater than daily. Permitted values for a weekly schedule are 1 (Sunday) to 7 (Saturday), and for a monthly or yearly schedule they are 1 to 31. offsethour : integer
The hourly offset within the repeatinterval at which the diary is triggered.
This is applicable to any scheduled diary greater than hourly. Permitted
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 156 values are 1 to 24.
OpenEnterprise Schema offsetminute : integer
The minute offset within the repeatinterval at which the diary is triggered.
This is applicable to any scheduled diary greater than a minute.
Permitted values are 1 to 60. offsetmonth : integer
The monthly offset within the repeatinterval at which the diary is triggered. This is applicable to a yearly archive schedule only. Permitted values are 1, (indicating January) to 12 (indicating December) offsetsecond : integer
The seconds offset within the repeatinterval at which the diary is triggered. Applicable to all archive schedules, with a permitted range of
1 to 60. patterntype : integer
The type of pattern attached to this diary.
0 = None.
1 = Trigger.
2 = Control curve.
3 = On/Off pattern.
All other values are invalid.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 157 repeatfor : integer
OpenEnterprise Schema
Number of times that the diary should be repeated. This value in this attribute is decremented each time the diary is repeated until it reaches zero. A value of 1 indicates repeat indefinitely. repeatinterval : integer
Indicates how this diary will repeat.
0 = No repeat.
1 = Daily.
2 = Weekly.
3 = Monthly.
4 = Annually.
5 = Every weekday.
6 = Every weekend day.
7 = At the end of each month.
8 = Every minute.
9 = Every five minutes. source : char
10 = Hourly.
All other values are invalid
This is the name of the client application that was used to generate this diary object. If a value is specified in this attribute, then only that application specified may change the diary object. If the attribute value is
NULL the Diary Configuration Tool may alter the object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 158
OpenEnterprise Schema starttime : datetime
The time at which the diary should last have triggered. starttime and endtime provide an envelope during which any attached pattern will run.
If the length of the pattern exceeds endtime starttime then the pattern will be truncated. starttimedstoffset : integer
The number of minutes that the value in starttime needs to be adjusted by to get to DST. triggeraction : integer
Type of action to take when a diary or pattern event is triggered
0 = On action a set operation is performed in the target object.
1 = Toggle the Scheduler attempts to toggle between two values in the target object. The last state being remembered in the tobescheduled object. type : integer
Use of toggle mode is not recommended. In general on/off schedules will provide much better results.
Not used reserved for backward compatibility.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 159
digital
OpenEnterprise Schema
Derived From: signal
Description: The digital table is used to store details of logical signals. It derives from the signal table and adds the extra attributes to handle logical values.
Attributes: currentstate : char
This value is either the same as the ontext or offtext attribute. Whichever it is, notcurrentstate is the opposite. defaultvalue : bool
This value will be used at database start-up to set the associated signals value and readvalue. No default value. lastoverridevalue : bool
The last override value set by the user (or the value existing when an override was enabled). Used to restore the override value following a database restart.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 160
OpenEnterprise Schema lastreadvalue : bool
The last value read from the RTU. This will be updated using the readvalue attribute whilst an override is enabled. This value will be copied into value and readvalue when an override is cancelled. notcurrentstate : char
This value is either the same as the ontext or offtext attribute. Whichever it is, currentstate is the opposite. offtext : char
This string is used to hold the text that will describe a digital value of 0.
For example: False. ontext : char
This string is used to hold the text to display for a digital value of 1. For example: True. readvalue : bool value : bool
The boolean state of the digital value. That is, either True or False or
NULL. The value is transient will therefore initially be NULL. This value is not directly altered by a client. It is linked to by the RDI which will update it.
This boolean attribute will be read and written to by clients. When the value is set the readvalue attribute is updated. This functionality may, however, be overwritten by the derived classes of the digital table. They would carry out specific checks before writing the value to the readvalue
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 161 attribute.
OpenEnterprise Schema
digitalalarmcondition
Derived From:
Description: alarmcondition
This is the base digital alarm condition table from which all alarm condition definitions associated with digital alarm generation must be derived.
Attributes: name : char
This is a foreign key reference to the digital table. It determines the signal to associate with the condition.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 162
digitalchangetonullalarmcondition
OpenEnterprise Schema
Derived From:
Description: digitalalarmcondition
This table defines the DigitalChangeToNullAlarmCondition table that is used to perform internal alarm generation for digital signals. This table will support change to NULL alarm conditions.
Attributes: name : char
This is a foreign key reference to the digital table. It determines the signal to associate with the condition.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 163
digitaldelayalarmcondition
OpenEnterprise Schema
Derived From: digitalalarmcondition
Description: This table defines the DigitalDelayAlarmCondition, which is used to perform delayed alarm generation for digital signals. Two types of alarm conditions are handled by this table delayed on, and delayed off.
Attributes: delayperiod : integer
This is the time, in seconds, that a digital signal value must remain at a certain value before it is deemed as meeting the condition. delaytimer : integer
This is a reference to a digitaldelaytimer object that is used to determine how long a digital state has been maintained.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 164
digitaldelaytimer
OpenEnterprise Schema
Derived From:
Description: oetimer
This timer class is used to generate digital delay alarms.
Attributes: delayalarm : integer
This is a reference to a digitaldelayalarmcondition object that would have set up this timer.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 165
digitalsignaltrigger
Derived From:
Description:
OpenEnterprise Schema signalattributetrigger
This table implements an Attribute Trigger that executes a calculation when the readvalue attribute within an object in the digital signal changes.
Attributes: readvalue : bool
This is the attribute that is linked to the readvalue attribute of the Digital table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 166
digitalstatealarmcondition
Derived From:
Description:
OpenEnterprise Schema digitalalarmcondition
This table defines the DigitalStateAlarmCondition table, which is used to perform internal alarm generation for digital signals. This table will support change of state, change to True, change to False conditions.
Attributes: readvalue : bool
This is the attribute that is linked to the readvalue attribute of the Digital table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 167
dstinformation
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This is a lookup table containing past and future DST changes.
An SQL script is supplied with your installation of OpenEnterprise which will determine the correct DST and timezone information for your particular region. The SQL scripts are typically named after the short name for the timezone (GMT.sql, EST.sql, etc.)
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. changetime : datetime
This is the date and time at which the DST adjustments will be incorporated. There are usually two daylight saving time changes each year. dstoffset : integer
This is the offset associated with the DST change. Usually the values
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 168
OpenEnterprise Schema alternate between say: 0 and 60. When this value is 0 no DST is being used to adjust the time. At 60 an hour is added to the time. id : integer locked : bool
Primary Key and unique identifier. Auto-generated by CL, please refer to
Appendix A for more information.
This attribute will lock the whole table and prevent other modifications while it is locked.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 169
dsttimer
OpenEnterprise Schema
Derived From:
Description: oetimer
This table is a timer that is used to ensure that DST changes are catered for and all necessary tables are updated when a timezone experiences a change in time.
The timer works by increasingly reducing the time between checks. As the expected time for DST change grows closer, the timer reduces the amount of time between checks.
The timer is a continuous timer.
Attributes: dstchangetrigger : integer
This is a trigger value that is changed in order to notify the database that a Daylight Saving Time change has occurred. timecount : integer
This attribute is incremented each time the timer expires. Each time this attribute is incremented the next change in DST is compared against the current time. If the attribute reaches a value of 6, the timer period is recalculated to smaller intervals and it is set back to 0.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 170
OpenEnterprise Schema timetable : integer references DatabaseTimeStatus
This is a reference to the DatabaseTimeStatus table which contains the current DST information such as the date and time of the last DST change and the date and time of the next DST change.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 171
dvi_datum
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The dvi_datum table contains 3 foreign key references, to a dvi_region object a dvi_device object and a dvi_schedule object. A dvi_datum entry is a point of access to device signals. Information is usually read or written using this connection.
Attributes: datumaddress : char
The datumaddress is device specific. It will describe where the signal is located. devicename : char
This is a foreign key reference to an object in the dvi_device table. It determines which physical device the datum is situated upon. disable : bool
Whether an individual datum is enabled or disabled is determined by the value of this attribute. TRUE indicates that is disabled FALSE indicates that it is enabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 172
OpenEnterprise Schema forcepoll : bool default FALSE
The forcepoll attribute will instigate the polling of the datum at the location specified in this object. The polling is instigated by setting the attribute to TRUE. Once the poll has finished, the forcepoll attribute is set to FALSE.
This attribute is now supported for nw3000 devices. To force a template to be collected manually send the query:
UPDATE nw3000polllist SET forcepoll = true WHERE devicename =
<devicename> AND scheduleid = <timeclass> forcewrite : bool default FALSE
If this attribute is set to TRUE after a poll then any writable values in the driver are send to the device. name : char
This is the primary key of the dvi_datum table and must therefore be assigned a unique name when it is created. private : integer
This is for internal use. regionname : char
This is a reference to the dvi_region table. It is used in OpenEnterprise to signify the datum type (e.g. 'realanalog', 'digital', 'pollist' etc.). The reference must be specified. scheduleid : integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 173
OpenEnterprise Schema
This is a reference to the dvi_schedule table. If the value is NULL, no automatic polling will take place for the datum. Otherwise, the rate of polling is indicated in the dvi_schedule object. status : integer
This is the current status of the datum. A value of 0 indicates that everything is ok. Other values indicate that the datum is writing to a device, or reading from a device, etc. timestamp : datetime
This datetime value is reset to the current time every time a value is written to the dvi_datum. timestampdstoffset : integer
The number of minutes that the value in timestamp needs to be adjusted by to get to DST.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 174
OpenEnterprise Schema
dvi_device
Derived From:
Description:
<Base Table>
This table stores all the device information such as device name a network name and a foreign key reference to the dvi_network table. Other information such as statistical accounting is also stored here. Each object in this table represents a single RTU to communicate to.
Attributes: checkperiod : datetime
This datetime is the length of time that the database will wait, during no communications between the device and database, before it checks the state of the device. dailycachedcommsdone : integer (hidden) Default 0
Used internally for communication statistics. dailycachedcommsfailed : integer (hidden) Default 0
Used internally for communication statistics. dailycommsdeltasuccess : float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 175
OpenEnterprise Schema
Successful communications expressed as a percentage of all communications within the current day. The start of the current day is determined by the value of dailyStatsResetHour. Includes polls and write messages. Default 0.0. dailystatsresethour : integer
The hour of the day when the daily percentage statistics will be cleared.
Specified as a local-time hour.
Default 0 (midnight) dailystatstrigger : integer
A counter that will be incremented immediately prior to the dailyCommsDeltaSuccess being cleared.
Default 0 deviceaddress : char
The address of the device is dependent upon the device driver. devicename : char
The device name is the primary key of the dvi_device table. It will describe the name given to individual devices. disable : bool
This boolean will instruct the DVI to ignore this object in the table and all other objects that reference it. hourlycachedcommsdone : integer (hidden)
Used internally for communication statistics.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 176
OpenEnterprise Schema hourlycachedcommsfailed : integer (hidden)
Used internally for communication statistics. hourlycommsdeltasuccess : float
Successful communications expressed as a percentage of all communications within the current hour. Includes polls and write messages. Default 0.0. hourlystatstrigger : integer
A counter that will be incremented immediately prior to the hourlyCommsDeltaSuccess being cleared.
Default 0 lastheardfrom : datetime
This is updated when the dvi_network reference, networkname, refreshes its values from the device. networkname : char
This is a foreign key reference to the dvi_network device. noscheduler : bool
Setting this to TRUE will disable any polling on the dvi_datum objects associated with this device. This is the equivalent to setting all the dvi_datum objects scheduleids attributes to NULL. oldstatstimestamp : datetime (hidden, transient)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 177
OpenEnterprise Schema
Used internally for communication statistics. pollsdone : integer
This is a count of the total number of polling attempts made to the device. pollsfailed : integer
This is the total number of times a poll attempt to the dvi_device table has failed to be carried out successfully. private : integer
Reserved. statstimestamp : datetime
This is updated when the dvi_network reference, networkname, refreshes its values from the device. status : integer
A status value of 0 indicates that everything is working fine with the device. writesdone : integer
This is the total number of write and polls the device has carried out upon its dvi_device objects. writesfailed : integer
This is the total number of writes or polls that have failed to between the device and datums.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 178
dvi_driver
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table stores the name of a driver that will communicate with an external device along with a description of driver a driver type field and a status value. This could contain an entry to the network 3000 driver. A driver may provide the means to communicate with many devices.
Attributes: currentdstoffset : integer
This is the number of minutes that times from the remote should be adjusted in order to cater for DST. disable : bool
If set to TRUE the device driver will be disable and the database will not collect any data from devices linked to this driver. driverinfo : char
Description of the driver configured. It contains information such as version number and date once the driver is successfully initialised.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 179 drivername : char
OpenEnterprise Schema
This is the readable name of the driver. For example, nw3000, etc. drivertype : char
This is an attribute that describes the driver type. If the driver is local and has been initialised automatically, the value of this attribute will be the same as the drivername attribute. lastdstchange : datetime
This is the date and time at which the last DST adjustment occurred.
This date is usually in May or October. Dates vary depending upon which timezone you are in. nextdstchange : datetime
This is the date and time at which the next DST adjustment occurs. previousdstoffset : integer
The number of minutes adjustment required for the times before the current DST settings. private : integer status : integer
Internal use.
A non-zero value indicates an error has occurred with the driver.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 180
OpenEnterprise Schema timezone : char timezoneoffset : integer
This is the number of minutes that the timezone is offset from GMT
(UTC)
This is a textual description of the timezone that the database is running within.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 181
dvi_network
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
Specifies the means of communication for the device that is referenced. It also determines how often sanity of communications should be carried out during periods of inactivity.
Attributes: disable : bool
The disable flag is used to halt DVI communications on this network configuration. Whilst disabled, entries in other tables that reference this table may be added or deleted. drivername : char
This is a reference to the dvi_driver table to indicate the driver that this network configuration is set up for. networkaddress : char
This address is dependent upon the driver referenced within drivername.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 182
OpenEnterprise Schema networkname : char
This is the primary key of this table, describing the network being used. private : integer
Internal use. statsfrequency : datetime
This value describes how often data is passed from the device to the database. A value of 0 means upon the change of data while a value of
NULL indicated data will never be collected. status : integer
A non-zero value indicates an error with the network connection.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 183
dvi_region
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The dvi_region table can be used to categorise dvi_datum entries. This is generally up to the implementer of the database. The categories could be geographical, although this is not necessary.
Attributes: regionname : char
This is the primary key of the dvi_region table. It can describe a concrete or abstract geographical region. In OpenEnterprise it is used to describe dvi_datum types (e.g. ‘realanalog’, ‘digital’ ‘string’)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 184
dvi_remote_driver
Derived From:
Description:
OpenEnterprise Schema dvi_driver
This table will contain extra attributes, in order to specify a driver that is not situated locally.
Attributes: address : char
The address describes the socket connection for the driver. It is in the form: [protocol/][hostname:]portname
An example of an address could be: tcp/101.140.32.19:3353 or tcp/server1:db checkperiod : datetime
This is the time period that the driver should be checked to see if it is working fine when no other activities are going on. connectattempts : integer
This is the total number of times the database has tried to connect to the remote driver.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 185
OpenEnterprise Schema connecttimeout : datetime
This is the length of time that the database will wait when it attempts to connect to the remote driver before timing out. filename : char
Currently not used. Reserved. retryperiod : datetime
This is the length of time between connection attempts. scheduler : bool
Currently not used. Reserved. timeout : datetime
Currently not used. Reserved.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 186
dvi_schedule
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The dvi_schedule table is used to create an object that determines the poll rate. The objects in this table are referenced by objects in the dvi_datum table. So each datum for every device may poll at different rates.
Attributes: disable : bool
This will, if set to TRUE, disable any polling of devices that reference this object. A value of FALSE will re-enable polling. maxinterval : datetime
A value of 0 or NULL will poll a device when it goes live and not again after that. Any other value will force a poll at that given interval. mininterval : datetime
This attribute is currently not used. Reserved. offset : datetime
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 187
OpenEnterprise Schema
This attribute is now used by the nw3000 rdi at server start-up to offset one-shot template collection by the specified offset seconds. This is used to stop low bandwidth networks being swamped with template requests causing lots of time-outs to occur. Once the initial one-shot template collection has completed, the offset value will have no effect. scheduleid : integer
This is the primary key of the dvi_schedule table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 188
emailserver
Derived From:
Description:
OpenEnterprise Schema objects
The EmailServer table allows SMTP and POP3 mail server configuration
(such as host name and port) to be stored in the database. It will be derived from Objects to allow alarms to be generated against it.
Attributes: pop3host:Char
The IP address or host name of the POP3 server. pop3password:Char
Password to log onto the POP3 server with. pop3pollinterval:Char
Frequency in seconds that the POP3 server will be polled for new mails. pop3port:Char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 189
The POP3 port number.
OpenEnterprise Schema pop3username:Char
User name to log onto the POP3 server with. smtpauthtype:Integer8 default 0
Specifies the type of authorisation used to log onto the SMTP server.
0 = None
1 = AUTH LOGIN smtpfromaddress:Char
The ‘from’ email address that emails sent from this server will be given. smtpfromname:Char
The name that will appear in emails sent via SMTP from this server smtphost:Char
The IP address or host name of the SMTP server. smtppassword:Char
Password to log onto the SMTP server with.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 190
OpenEnterprise Schema smtpport:Char
The SMTP port number. smtpusername:Char
User name to log onto the SMTP server with.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 191
eventhistory
OpenEnterprise Schema
Derived From:
Description: loghistory
This is the history table used to store all the events generated upon the system. Obviously, this table should be treated with caution when queried from since it can be huge, depending upon whether archive files are being used in conjunction with the event history and how many.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. acknowledged : bool
If this value is FALSE, the object is in a state of not being acknowledged. acknowledgedtime : datetime
This is a timestamp of when the alarm was acknowledged by an operator.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 192
OpenEnterprise Schema acknowledgedtimedstoffset : 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. alarmlimit : char alarmtext : char attribute : char
This is the conditional limit imposed, in text form, that created the alarm.
This is text used to describe the alarm generated in greater detail.
This is a component of the signal name used to communicate to remote devices. The format for NW3000 signals is:
devicename:base.extention.attribute. base : char
Other systems may vary.
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. 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
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 193 to an alarm.
OpenEnterprise Schema calloutdisplay : char
This is a workstation display that will supply response data for an operator in order to deal with a alarm. cleared : bool
If this value is FALSE, the object is in a state of not being cleared. clienttype : char
This is a brief description of the client. E.g. OPC Server, DBB, etc. condition : integer
The condition attribute the table can be matched against a value in the alarmconditionlookup table. dataset : char
This is a misnamed attribute that, in fact, contains a list of id values from the logcontrol table. The list is, actually, a set of historical streams
(rather than data sets). These are required in order to implement stream management. The list of streams controls which historical streams this object is enabled with. Those streams not listed in the string will have this signal object disabled.
When this attribute is set, the old list of logcontrol references are disabled. These are contained in the lastdataset attribute. Then the new lists references are enabled (stored in dataset). And finally, the dataset attribute is copied to the lastdataset attribute.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 194 description : char
This is a description of the event.
OpenEnterprise Schema 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. display : char
Other systems may vary.
This is a display associated with the event. dstoffset : integer
This is used to calculate daylight saving time. It is stored in minutes. eventtype : char extension : char
This is used to indicate the type of event e.g. operator action etc.
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.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 195 hasnotes : bool helptext : char id : integer
OpenEnterprise Schema
This determines if the event has any not attached to it.
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.
This is the primary key of the eventlog table entry. 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:
D HH:MM:SS.mmm
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 196
OpenEnterprise Schema 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. 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. lastdataset : char
This is a misnamed attribute that, in fact, contains a list of id values from the logcontrol table. The list is, actually, a set of streams. These are required in order to implement stream management. The list of streams controls which streams this signal is enabled with.
When this attribute is set, the old list of logcontrol references are disabled. These are contained in the lastdataset attribute. Then the new list are enabled (stored in dataset). And finally, the dataset attribute is copied to the lastdataset attribute. lastoccurence : datetime
This is the date and time that this alarm last appeared in the
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 197 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 that the event was recognised and logged into the database. 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 associated with the event. This, in the case of an alarm, could be the name of a signal. numberofoccurences : integer
This attribute is used to keep a total count of how many times this alarm has gone into alarm. occurencetime : datetime
This is the time that the event occurred.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 198
OpenEnterprise Schema occurencetimedstoffset : 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. operator : char
This is the name of the operator who is associated with this event. 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
This is the geographical location that the event occurred in. printer : char priority : integer
This string determines which printer the alarm should be directed to.
This is the priority level. From this value the colours and other behaviour of the event can be determined. questionabletime : bool
A value of TRUE indicates that the time that the event occurred,
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 199 occurrencetime, is not safe.
OpenEnterprise Schema silenced : bool
A value of TRUE indicates no audible sound is associated with the event. status : integer
This is a status value of the event. A non-zero value indicates an error with it. suppressed : bool
This indicates if the event is suppressed or not. timezone : char
This is the time zone in which the event occurred. totalnotes : integer
This is the total number of notes associated with this event. 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)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 200
OpenEnterprise Schema triggervalue : integer
This is a rolling count used to ensure that the event is logged. units : char
These are the units that the event is measured in. value : char
This is the value of the event.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 201
eventlog
OpenEnterprise Schema
Derived From: <Base Table>
Description: This table is used as the source table for the logging of alarms and events within the OpenEnterprise system. It will only ever contain 100 entries, plus one entry with a negative id number, which is used to insert custom messages into the eventlog. When a new alarm or event action occurs, the oldest event will be over-written. All entries in the eventlog are automatically inserted into to the eventhistory table, where they will eventually be stored within an archive file, so no alarm or event is ever lost.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. acknowledged : bool
If this value is FALSE, the object is in a state of not being acknowledged. acknowledgedtime : datetime
This is a timestamp of when the alarm was acknowledged by an operator.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 202
OpenEnterprise Schema acknowledgedtimedstoffset : 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. alarmlimit : char
This is the conditional limit imposed, in text form, that created the alarm. alarmtext : char attribute : char base : char
This is text used to describe the alarm generated in greater detail.
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.
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.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 203 calloutarea : char
OpenEnterprise Schema
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
If this value is FALSE, the object is in a state of not being cleared. clienttype : char
This is a brief description of the client. E.g. OPC Server, DBB, etc. condition : integer
The condition attribute the table can be matched against a value in the alarmconditionlookup table. dataset : char
This is a misnamed attribute that, in fact, contains a list of id values from the logcontrol table. The list is, actually, a set of historical streams
(rather than data sets). These are required in order to implement stream management. The list of streams controls which historical streams this object is enabled with. Those streams not listed in the string will have this signal object disabled.
When this attribute is set, the old list of logcontrol references are disabled. These are contained in the lastdataset attribute. Then the new lists references are enabled (stored in dataset). And finally, the dataset
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 204
OpenEnterprise Schema attribute is copied to the lastdataset attribute. description : char
This is a description of the event. 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 is a display associated with the event. dstoffset : integer
This is used to calculate daylight saving time. It is stored in minutes. eventtype : char extension : char
This is used to indicate the type of event e.g. operator action etc.
This is a component of the signal name used to communicate to remote devices. The format for NW3000 signals is:
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 205
OpenEnterprise Schema
devicename:base.extention.attribute. hasnotes : bool helptext : char id : integer
Other systems may vary.
This determines if the event has any not attached to it.
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.
This is the primary key of the eventlog table. 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:
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 206
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. 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. lastdataset : char
This is a misnamed attribute that, in fact, contains a list of id values from the logcontrol table. The list is, actually, a set of streams. These are required in order to implement stream management. The list of streams controls which streams this signal is enabled with.
When this attribute is set, the old list of logcontrol references are disabled. These are contained in the lastdataset attribute. Then the new list are enabled (stored in dataset). And finally, the dataset attribute is copied to the lastdataset attribute.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 207
OpenEnterprise Schema lastoccurence : datetime
This is the date and time that this alarm last appeared in the alarmsummary table. 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 that the event was recognised and logged into the database. 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 associated with the event. This, in the case of an alarm, could be the name of a signal. numberofoccurences : integer
This attribute is used to keep a total count of how many times this alarm has gone into alarm. occurencetime : datetime
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 208
OpenEnterprise Schema
This is the time that the event occurred. occurencetimedstoffset : 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. operator : char
This is the name of the operator who is associated with this event. 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 printer : char priority : integer
This is the geographical location that the event occurred in.
This string determines which printer the alarm should be directed to.
This is the priority level. From this value the colours and other behaviour of the event can be determined.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 209
OpenEnterprise Schema questionabletime : bool
A value of TRUE indicates that the time that the event occurred, occurrencetime, is not safe. silenced : bool
A value of TRUE indicates no audible sound is associated with the event. status : integer
This is a status value of the event. A non-zero value indicates an error with it. suppressed : bool
This indicates if the event is suppressed or not. timezone : char
This is the time zone in which the event occurred. totalnotes : integer
This is the total number of notes associated with this event. 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
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 210 milliseconds)
OpenEnterprise Schema triggervalue : integer
This is a rolling count used to ensure that the event is logged. units : char
These are the units that the event is measured in. value : char
This is the value of the event.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 211
eventperiods
OpenEnterprise Schema
Derived From:
Description:
This table is used to construct limiting time periods that are used by the
CalendarEvent table to build up events.
<Base Table>
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. currentlocker : char
Override user name that allows a locked object to be unlocked. eventname : char references CalendarEvents
This maintains the link between the event period and the actual calendar event. eventyear : integer
The event year is used internally to distinguish events that occur every
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 212 year, e.g. Christmas.
OpenEnterprise Schema locked : bool
This attribute will be set to true if any of the configuration tools are currently editing this object. locker : char
The name of the user who is currently editing this object. periodfrom : datetime
This is the start date and time for this particular event period. It is complimented by the periodto attribute. periodname : char
This is the Primary Key of this table. periodto : datetime
This is the end date and time for this particular event period. It is complimented by the periodfrom attribute.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 213
eventreplication
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table is used by the Event Replication component
(OEEventReplication.exe) to manage Event Replication between
OpenEnterprise Servers across an IP network.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. backfill : bool
Used to invoke the backfill process. If this attribute value is set to TRUE, then whenever reconnection is obtained to a target OE Server, the event
Replication component will attempt to backfill that server with any
Events that have occurred while the target OE Server was not available.
The default value is FALSE. copyinitialevents : bool
Allows the user to configure whether on connection to the source OE
Server the current standing events of the system are replicated to the
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 214
OpenEnterprise Schema target OE Server. The default value is FALSE. dataservice : char Primary Key
The data service of the target OE Server to which events will be copied. disable : bool latency : integer
If set to TRUE then real-time Event replication will be disabled for this table entry. The default value is FALSE.
A value, in seconds that is added to the start and end of the query range, in order to allow for the delay between an OE Server becoming available/unavailable and the ERC being informed of that change of state. Default value is 30 seconds. minimumdisconnectionperiod : integer
The minimum time, in seconds, between a disconnection and reconnection to the target OE Database, before a backfill will be performed. Default value is 0. priority : char
A CSV list that contains the list of those priorities of alarms/events that will be copied to the target OE Server. A NULL value for this attribute will indicate that all alarms/events should be copied. queryperiod : integer
A value, in seconds, that indicates the period of time covered by each
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 215
OpenEnterprise Schema query on the source OE Servers EventHistory, when performing a backfill operation. Default value is 300 seconds. If this value is 0 or
NULL then this indicates that a single query will be used to obtain all event history records. transactionpackagesize : integer
While performing a backfill operation this will define the number of updates of the Event Log table to be packaged in a single transaction to the target OE Server. Default value is 1.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 216
exception
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
This class is used to create a user exception. The class is derived from to produce a class runtimeexception. Exception objects are activated by using the CL throw command.
Attributes: code : integer
The code attribute of the exception domain
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 217
exceptionhandler
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
The exceptionhandler class is used to deal with CL exceptions. The class is not used within OpenEnterprise currently. It would be derived from in order to provide controlled handling of exception errors, such as dividing by zero.
Attributes: id : integer
This is the primary key of the exceptionhandler class. The processing of exceptions is carried out within handlers of this class.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 218
exclusions
Derived From:
Description:
<Base Table>
RESERVED FOR FUTURE USE
OpenEnterprise Schema
Attributes: id : integer
This is the primary key of the exceptionhandler class. The processing of exceptions is carried out within handlers of this class.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 219
expirywarningtime
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table is for internal use only.
Attributes: expirywarningtime : integer
The time in days before the user's password is due to expire. name : char Primary Key
The name of the user.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 220
ftpserver
OpenEnterprise Schema
Derived From:
Description: objects
The FTPServer table allows FTPServer configuration (such as number of retries and wait timeouts) to be stored in the database. The default load adds a dummy FTPServer object with no IPAddress. This provides default retry and timeout information.
Attributes: activemode:Bool default FALSE
Whether to connect to the FTPServer if active mode (TRUE) or passive mode (FALSE). address:Char
The IP address or host name of the FTPServer. controlsocket:Integer default 21
The socket to connect to on the server to communicate the FTP control protocol.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 221
OpenEnterprise Schema datasocket:Integer default 20
The socket to connect to on the server to communicate the FTP data protocol. retries:Integer8 default 3
Number of times to retry responses when errors are returned with the format 4xx. retrywaitperiod:Integer default 1000
Number of milliseconds to wait between retries. timeout:Integer default 10000
Time in milliseconds to wait after issuing a command before that command is deemed to have failed.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 222
groups
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
RESERVED FOR FUTURE USE
Attributes: activemode:Bool default FALSE
Whether to connect to the FTPServer if active mode (TRUE) or passive mode (FALSE). address:Char
The IP address or host name of the FTPServer. controlsocket:Integer default 21
The socket to connect to on the server to communicate the FTP control protocol. datasocket:Integer default 20
The socket to connect to on the server to communicate the FTP data
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 223 protocol.
OpenEnterprise Schema retries:Integer8 default 3
Number of times to retry responses when errors are returned with the format 4xx. retrywaitperiod:Integer default 1000
Number of milliseconds to wait between retries. timeout:Integer default 10000
Time in milliseconds to wait after issuing a command before that command is deemed to have failed.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 224
indexattrs
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table contains a record for each attribute included in an index.
Attributes: attr_name : char attr_table : char
This is the name of the attribute within the attr_table table that has an index upon it.
The is the name of the table that has an index upon it. indexname : char
The is the name given to an index. This attribute make up part of a multiple primary key with indexorder. Examples of indexname entries are: 'PK-archivefile', 'FK-users-lockouttimer', etc. indexorder : integer
This attribute combines with indexname in order to create the primary
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 225
OpenEnterprise Schema key for this table. This value is always 0 unless there are two (or more) attributes within indexes on them from the same table. Then the order is decided by this value. 0 is highest.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 226
indexes
OpenEnterprise Schema
Derived From:
Description: is_unique : bool
<Base Table>
Indexes are created upon tables in order to search against certain attributes more quickly. This table, along with the indexattrs table maintain the index information.
Attributes: contraint_type : integer
Undefined Attribute foreign_table : char
If the index is a foreign key this is the name of that table.
Does the index enforce uniqueness. name : char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 227
OpenEnterprise Schema
This is the Primary Key and identifier this record. table_name : char
This is the name of the table that the index is being applied to. type : integer
If this value is 1 then the index is structured as a hash table. If this value is 0 then it is a foreign key.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 228
integeranalog
OpenEnterprise Schema
Derived From: signalextension
Description: The integeranalog table extends the functionality of the signal table by handling integer values that represent signal values. It also provides high and low limit values.
Attributes: defaultvalue : integer
This value will be used at database start-up to set the associated signal's value and readvalue. No default value. highlimit : integer
This is a limit imposed upon the object that prevents a client from increasing the value of the signal above a certain level. If this attribute is
NULL, no limit is imposed. This attribute must be greater than the lowlimit attribute or the transaction to change it will fail. lastoverridevalue : integer
The last override value set by the user (or the value existing when an override was enabled). Used to restore the override value following a database restart.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 229
OpenEnterprise Schema lastreadvalue : integer
The last value read from the RTU. This will be updated using the readvalue attribute whilst an override is enabled. This value will be copied into value and readvalue when an override is cancelled. lowlimit : integer
This is a limit imposed upon the object that prevents a client from reducing the value of the signal below a certain level. If this attribute is
NULL, no limit is imposed. This attribute must be less than the highlimit attribute or the transaction to change it will fail. readvalue : integer
The readvalue attribute of the table specifies the last received value from the device for this signal. This is not modified by client connections.
It is updated by making request to the device for signal values or through reporting values by exception (RBE). units : char
These are the units associated with the signal. value : integer
This attribute is linked to and updated by the clients. Changing this value may alter the actual value of the signal. Whether this is altered or not is determined by the handler of the device-specific table, derived from this table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 230
integeranalogalarmcondition
Derived From:
Description:
OpenEnterprise Schema alarmcondition
This is the base integer analogue signal, alarm condition table from which all alarm condition definitions associated with integer analogue alarm generation must be derived.
Attributes: alarmstate : bool name : char
The alarm state may be one of two values: In Alarm or Out of Alarm. A value of FALSE means the condition is out of alarm.
This is a foreign key reference to the integeranalog table. The reference signal has this alarm condition applied to it.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 231
OpenEnterprise Schema
integeranalogchangetonullalarmcondition
Derived From:
Description: integeranalogalarmcondition
This table defines the IntegerAnalogChangeToNullAlarmCondition table that is used to perform internal alarm generation for integer signals. This table will support change to NULL alarm conditions.
Attributes: alarmstate : bool name : char
The alarm state may be one of two values: In Alarm or Out of Alarm. A value of FALSE means the condition is out of alarm.
This is a foreign key reference to the integeranalog table. The reference signal has this alarm condition applied to it.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 232
OpenEnterprise Schema
integeranalogchangevaluealarmcondition
Derived From:
Description:
Attributes:
No attributes extend this table.
integeranalogalarmcondition
This table defines the IntegerAnalogChangeValueAlarmCondition table that is used to perform internal alarm generation for integer signals. This table will support change of value alarms.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 233
OpenEnterprise Schema
integeranalogdeviationalarmcondition
Derived From:
Description: integeranalogalarmcondition
This table defines the IntegerAnalogDeviationSignalAlarmCondition table that is used to perform percentage deviation alarm generation for
IntegerAnalog signals.
Attributes: lastvalue : integer
This is the last reported value change for the integer signal. percentdeviation : float
This attribute gives the amount that the value may change before it is considered to meet the condition to generate an alarm.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 234
integeranalogequalsalarmcondition
OpenEnterprise Schema
Derived From:
Description: integeranalogalarmcondition
This table defines the IntegerAnalogEqualsAlarmCondition table that is used to perform internal alarm generation for integer signals. This table will support value equals alarm conditions.
Attributes: limit : integer
This attribute gives the value that the integer signal must be before it meets the condition to generate an alarm.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 235
integeranaloglimitalarmcondition
OpenEnterprise Schema
Derived From:
Description: integeranalogalarmcondition
This table defines the IntegerAnalogLimitAlarmCondition table that is used to perform internal alarm generation for integer signals. This will support
HIHIHI, HIHI, HI, LO, LOLO, LOLOLO, and change to NULL alarm processing.
Attributes: deadbandinto : integer
The deadbandinto attribute will determine the number by which the value of the integer must cross over the limit before an alarm may be triggered. deadbandoutof : integer
The deadbandoutof attribute will determine the number by which the value of the integer must recover over the limit set before an alarm may be declared no longer in alarm.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 236
OpenEnterprise Schema
integeranalograteofchangealarmcondition
Derived From:
Description: integeranalogalarmcondition
This table defines the IntegerAnalogRateOfChangeSignalAlarmCondition table that is used to perform simple rate of change alarm generation for
IntegerAnalog signals.
Attributes: changepersecond : float
This is the allowed change of value per second that will not cause an alarm to be generated. lastchange : datetime
This is the time when the value was last changed. lastchangedstoffset : 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.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 237 lastvalue : integer
OpenEnterprise Schema
This is the value that the integer signal was at when it last changed. It is used, in conjunction with the lastchange attribute, to calculate if the rate of change is too fast.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 238
integeranalogsignalalarmcondition
OpenEnterprise Schema
Derived From:
Description: integeranalogalarmcondition
This table defines the IntegerAnalogSignalAlarmCondition table that is used to perform internal alarm generation for integer signals. This will support HIHIHI, HIHI, HI, LO, LOLO, LOLOLO, and change to NULL alarm processing in the same manner as the IntegerAnalogAlarmCondition, except that the alarm condition limit value is sourced from a IntegerAnalog signal read value.
Attributes: alarmname : char
This is a foreign key reference to the integeranalog signal that will be used to determine the limit that the condition must be compared against. deadbandinto : integer
The deadbandinto attribute will determine the number by which the value of the integer must cross over the limit before an alarm may be triggered. deadbandoutof : integer
The deadbandoutof attribute will determine the number by which the value of the integer must recover over the limit set before an alarm may be declared no longer in alarm.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 239
integeranalogsignaltrigger
OpenEnterprise Schema
Derived From:
Description: signalattributetrigger
This table is used to monitor integer signal values. When a change occurs, a trigger is set and a calculation may be executed.
Attributes: readvalue : integer
This is the linked attribute to the IntegerAnalog table. Any value changes in the IntegerAnalog object will be reflecting in the instance here.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 240
integerarchiveindex
OpenEnterprise Schema
Derived From:
Description: archiveindex
This table is used to provide the minimum and maximum values of an integer index for an archive file.
See also archivecatalogue, datetimearchiveindex and realarchiveindex.
Attributes: maximumvalue : integer
The maximum value of the index within the associated archive file. minimumvalue : integer
The maximum value of the index within the associated archive file.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 241
ipline
OpenEnterprise Schema
Derived From:
Description: line
Used by the OpenBSI Comm Stats component. A table that represents all
IP lines that have been configured.
Attributes: acktimeout:Integer link level timeout period (msec.) ipmask:Integer
Representation of IP mask as integer value. ipvalue:Integer maxretries:Integer
Representation of IP value as integer value.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 242
OpenEnterprise Schema
Number of retries without an acknowledgement. throttledelay:Integer
Time period (msec.) to wait before sending message while throttling the
NHP. writedelay:Integer
Time period (msec.) to wait before sending message.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 243
journalalarmcondition
Derived From:
Description:
OpenEnterprise Schema alarmcondition
This is the base table for alarm conditions associated with journal messages. All journal condition tables must derive from this one.
Attributes: journaltask : char
This is a foreign key reference to an object in the journaltask table. It is used to retrieve information from the journal task.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 244
journalcontrol
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The journalcontrol table is used to view the journalling to the journal file. It is maintained by the database and will only ever maintain one object. The only attribute that may be modified is the disabled attribute. All the others are read-only. No objects may be deleted or inserted into the table, by a client, either.
Attributes: created : datetime
The date and time that the database load file was created. current_transaction : integer
This is the id of the current transaction. disable : bool
A value of TRUE indicates that journalling has been disabled. file_size : integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 245
OpenEnterprise Schema
This is the current size of the load file in bytes. filename : char
This is the name of the current load file. first_transaction : integer
Transaction ID of the snapshot written to the load. id : integer
This is the primary key for this table. last_transaction : integer
This is the id of the previous transaction.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 246
journalequalalarmcondition
OpenEnterprise Schema
Derived From:
Description: journalalarmcondition
This table will provide the equality condition. So when the journal task matches the task of the condition an alarm is generated.
Attributes: errornumber : integer
This is the value that is checked against the eventnumber attribute of the journaltask object. If a match is found an alarm is generated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 247
journalrangealarmcondition
OpenEnterprise Schema
Derived From:
Description: journalalarmcondition
This table provides a way of checking to see if a journal task being monitored has entered a range of journal task values. If this is the case, an alarm is generated.
Attributes: lowerrange : integer
This is the low end of a range of values that will instigate an alarm if the eventnumber attribute of the journaltask object is higher than or equal to the lowrange value and less than or equal to the upperrange. upperrange : integer
This is the high end of a range of values that will instigate an alarm if the eventnumber attribute of the journaltask object is higher than or equal to the lowrange value and less than or equal to the upperrange.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 248
journaltask
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table is used to allow any database client to insert journal messages into the Database. All attribute values with the exception of the alarmcondition array will be copied to the alarm summary object created when the alarm condition(s) is satisfied.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. alarmcondition : alarmcondition
This is an array of references to the alarmcondition table. These alarms are associated with this journal task. clienttype : char
This is a brief description of the client. E.g. OPC Server, DBB, etc.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 249
OpenEnterprise Schema devicename : char
This is the name of the device to which the journal message relates. eventnumber : integer
This is a value that is used by the alarm condition to check if the journal task is a valid event. eventtext : char
This describes the task to be journalled. 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. eventtimestampdstoffset : 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. eventtrigger : integer
This boolean is used to trigger alarm condition handling. eventusertext : char
Copied to the alarmtext attribute of the alarmsummary object generated with this journal task.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 250
OpenEnterprise Schema name : char nexttrigger : integer
This is a rolling count of the value of the next eventnumber to assign.
This is optional. objectname : char
If the event being logged occurred upon a database object, its name will be shown here. operator : char printer : char
This, if relevant will display the user who is logged on through the client.
This is the name of the printer that the journal tasks should be logged to.
This is the primary key of the journaltask table and therefore is the unique description of the journal task.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 251
klaxon
OpenEnterprise Schema
Derived From: <Base Table>
Description: A klaxon can be configured based upon the priority and plant area of an alarm. When the alarm occurs, the totalalarms count is incremented. If the total number of alarms increases above the lasttotalalarms attribute value, then the klaxon is switched on.
The klaxon may be switched on or off by setting the sounding attribute to true (sound on) or false (sound off.)
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. disable : bool default FALSE
Setting this to true will prevent the klaxon from being set through the klaxonsignal reference. klaxonname : char
A required character field that displays a readable name for an individual
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 252 klaxon object. This is NOT the PK.
OpenEnterprise Schema klaxonsignal : char references Digital
This is the signal that the klaxon is driven from. If no signal is set then obviously no klaxon will be started if the totalalarms increases beyond the lasttotalalarms limit. lasttotalalarms : integer
Threshold at which the klaxon device is set off. If the total number of alarms exceeds this value, the klaxon is triggered. plantarea : char
Makes up part of the PK along with the priority attribute. priority : integer
Makes up part of the PK along with the plantarea attribute.
SilenceOnAcknowledge:bool
If this attribute value is set to TRUE then if any alarm currently causing the klaxon to sound is acknowledged, then the klaxon itself will also be silenced regardless of whether other unacknowledged alarms are causing the klaxon to sound. The default value will be FALSE, meaning that acknowledgements will not cause the klaxon to silence. soundacknowledged:bool
Indicates whether the klaxon will sound for acknowledged alarms. The default value will be TRUE, indicating that the klaxon will sound
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 253
OpenEnterprise Schema regardless of the acknowledged state of the alarm. soundcleared:bool
Indicates whether the klaxon will sound for cleared alarms. The default value will be TRUE, indicating that the klaxon will sound regardless of the cleared state of the alarm. sounding : bool
This attribute is used to overwrite the value of the digital signal used to control the klaxon. Set this value to true or false and you shall set the digital signal indicated by the klaxonsignal attribute to true or false. soundsuppressed:bool
Indicates whether the klaxon will sound for suppressed alarms. The default value will be FALSE to indicate that the klaxon will not be sounded by suppressed alarms. totalalarms : integer
This is the total number of alarms associated with a particular plant area and priority within the AlarmSummary table. As relevant entries in the
AlarmSummary table are created and deleted this count is incremented and decremented.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 254
line
OpenEnterprise Schema
Derived From:
Description: objects
Used by the OpenBSI Comm Stats component. A table that represents all
OpenBSI lines that have been configured.
Attributes: backupname:Char
The name of the backup line. highslave:Integer
0-127 lastreadstatistics:DateTime
Reserved for future use. linename:Char
The name of the OpenBSI line.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 255
OpenEnterprise Schema lowslave:Integer portflagid:Integer
0-127
Reserved for future use portflagtext:Char
Reserved for future use readstatisticscount:Integer
Reserved for future use. resetstatistics:Bool
Reserved for future use. retrycount:Integer
Current number of retries for this message. status:Integer
Reserved for future use.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 256 statustext:Char typeid:Integer typetext:Char
OpenEnterprise Schema
BSAP
EBSAP
IP
LOCAL
Reserved for future use.
0 = illegal;
1 = BSAP;
2 = IP;
3 = EBSAP;
4 = LOCAL
A textual representation of the Line type. Values are
ILLEGAL
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 257
localdigital
OpenEnterprise Schema
Derived From:
Description: digital
This table acts very similarly to its base table: Digital, except certain attributes have been extended in order to make these values persistent.
Signals in this table are not directly associated to any remote devices that may be running on the OpenEnterprise System.
Attributes: persistentalarminhibit : bool
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the alarminhibit attribute of the base table. persistentmanualinhibit : bool
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the manualinhibit attribute of the base table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 258
OpenEnterprise Schema persistentquestionable : integer
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the questionable attribute of the base table. persistentvalue : bool
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the value attribute of the base table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 259
localintegeranalog
OpenEnterprise Schema
Derived From:
Description: integeranalog
This table acts very similarly to its base table: IntegerAnalog except certain attributes have been extended in order to make these values persistent.
Signals in this table are not directly associated to any remote devices that may be running on the OpenEnterprise System.
Attributes: persistentalarminhibit : bool
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the alarminhibit attribute of the base table. persistentmanualinhibit : bool
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the manualinhibit attribute of the base table. persistentquestionable : integer
This attribute is used to store a value when the database is shut down.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 260
OpenEnterprise Schema
When the database restarts, this value is copied back to the questionable attribute of the base table. persistentvalue : integer
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the value attribute of the base table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 261
localmultidigital2
OpenEnterprise Schema
Derived From:
Description: multidigital2
This table acts very similarly to its base table: MultiDigital2, except certain attributes have been extended in order to make these values persistent.
Signals in this table are not directly associated to any remote devices that may be running on the OpenEnterprise System.
Attributes: persistentalarminhibit : bool
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the alarminhibit attribute of the base table. persistentmanualinhibit : bool
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the manualinhibit attribute of the base table. persistentquestionable : integer
This attribute is used to store a value when the database is shut down.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 262
OpenEnterprise Schema
When the database restarts, this value is copied back to the questionable attribute of the base table. persistentvalue : integer
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the value attribute of the base table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 263
localmultidigital3
OpenEnterprise Schema
Derived From:
Description: multidigital3
This table acts very similarly to its base table: MultiDigital3, except certain attributes have been extended in order to make these values persistent.
Signals in this table are not directly associated to any remote devices that may be running on the OpenEnterprise System.
Attributes:
No attributes extend this table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 264
localmultidigital4
OpenEnterprise Schema
Derived From:
Description:
Attributes:
No attributes extend this table.
multidigital4
This table acts very similarly to its base table: MultiDigital4, except certain attributes have been extended in order to make these values persistent.
Signals in this table are not directly associated to any remote devices that may be running on the OpenEnterprise System.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 265
localrealanalog
OpenEnterprise Schema
Derived From:
Description: realanalog
This table acts very similarly to its base table: RealAnalog, except certain attributes have been extended in order to make these values persistent.
Signals in this table are not directly associated to any remote devices that may be running on the OpenEnterprise System.
Attributes: persistentalarminhibit : bool
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the alarminhibit attribute of the base table. persistentmanualinhibit : bool
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the manualinhibit attribute of the base table. persistentquestionable : integer
This attribute is used to store a value when the database is shut down.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 266
OpenEnterprise Schema
When the database restarts, this value is copied back to the questionable attribute of the base table. persistentvalue : real
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the value attribute of the base table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 267
localstringsignal
OpenEnterprise Schema
Derived From:
Description: stringsignal
This table acts very similarly to its base table: StringSignal, except certain attributes have been extended in order to make these values persistent.
Signals in this table are not directly associated to any remote devices that may be running on the OpenEnterprise System.
Attributes: persistentalarminhibit : bool
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the alarminhibit attribute of the base table. persistentmanualinhibit : bool
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the manualinhibit attribute of the base table. persistentquestionable : integer
This attribute is used to store a value when the database is shut down.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 268
OpenEnterprise Schema
When the database restarts, this value is copied back to the questionable attribute of the base table. persistentvalue : char
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the value attribute of the base table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 269
localtimesignal
OpenEnterprise Schema
Derived From:
Description: time
This table acts very similarly to its base table: Time, except certain attributes have been extended in order to make these values persistent.
Signals in this table are not directly associated to any remote devices that may be running on the OpenEnterprise System.
Attributes: persistentalarminhibit : bool
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the alarminhibit attribute of the base table. persistentmanualinhibit : bool
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the manualinhibit attribute of the base table. persistentquestionable : integer
This attribute is used to store a value when the database is shut down.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 270
OpenEnterprise Schema
When the database restarts, this value is copied back to the questionable attribute of the base table. persistentvalue : datetime
This attribute is used to store a value when the database is shut down.
When the database restarts, this value is copied back to the value attribute of the base table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 271
lockouttimer
OpenEnterprise Schema
Derived From:
Description: oetimer
This table is used to manage any account lockout duration functionality associated with user accounts.
Optionally a user can be configured such that following successive failures to log in that users account can be locked out. A time period can then be optionally defined, specifying the length of time for which the account lockout will last. The lockouttimer table is used to manage that functionality.
Attributes: username : char references users
A reference to the users table entry on which lockout duration functionality is to be applied.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 272
logaccess
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table allows the retrieval of historical data from a history stream. The data is returned in a binary format that must be expanded before it can be read.
Attributes: columns : integer
This is the number of columns that are in the data extracted. This value is set internally, after the data has been retrieved and placed in a binary format. control : integer
This is a foreign reference to a logcontrol object. It is used to determine the description of the stream to extract. data : binary
This is the result of a historical access. It is supplied in binary format and will have to be extracted using the utility routine available -
UnpackHistory(). If the logaccess entry is an active query (i.e. endtime =
NULL) then this attribute will initially be filled with the data from the query and thereafter updated, along with the samples attribute,
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 273
OpenEnterprise Schema whenever new data is written to the history stream. disable : bool
If this value if TRUE, the query will not be carried out. When it is set to
FALSE, the query is attempted. endtime : datetime
This is the time of the last data item to be searched for. If the attribute remains NULL, an active query will be activated upon the historical data. granularity : char
The granularity specifies the time of collection for the historical data.
This is as a character string and is a value followed by either an s, to specify seconds, or a m, to specify months. For example, 5s will be a historical stream collected every 5 seconds. id : integer name : char
This is the primary key of the logaccess table. It will uniquely identify the object in the table.
This attribute will describe the primary key attribute name. This should be the same as the namecolumn of the logcontrol table. samples : integer
This is the number of samples within the binary data attribute. After new historical data is written to the historical stream, the attribute is updated
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 274
OpenEnterprise Schema to reflect the number of items in the newly updated data attribute. starttime : datetime
The starttime stipulates the earliest timestamp of data to search for. This must be less than or equal to the endtime. If the value of this attribute is
NULL, the earliest entry in the history file will be searched for. status : integer
This is the status value, after a query has been attempted, of the history file associated with the query. A non-zero value indicates an error.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 275
logarchive
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table brings files on-line and takes files off-line. A file that is on-line may be queries by the database. A file that is not cannot be queried.
Attributes: buffercount : integer
This read-only attribute specifies the number of blocks within the archive file brought on-line. buffersize : integer
This is the size of the blocks, making up the archive file, in bytes. control : integer
This is a foreign key reference to the logcontrol object that specifies the make-up of the stream. Failure to match this stream correctly with the stream of the archive file can create spurious results. From the name of the archive file, details of the stream may be extracted.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 276
OpenEnterprise Schema creationdate : datetime
This is the date and time of when the archive file was initially created by a historian. endtime : datetime
This is the time of the last entry in the archive file. filename : char
The filename attribute describes the complete name and directory of the archive file that should be brought on-line by this entry in the logarchive table. namecolumn : char
This attribute describes the primary key column name of the table used, originally, to collect data. The table is described in the source attribute. namecount : integer
This is the number of object logged in this archive file. online : bool
If this value is TRUE, the archive file is described as being on-line and therefore able to be accessed by the historian. If FALSE the file is currently off-line and not directly accessible. rate : char
This is the granularity of the data in the archive file. This follows the syntax of a value followed by an s or m, for seconds or minutes. A value
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 277 of 0s indicates exception collection.
OpenEnterprise Schema source : char
This is the name of the table that would have originally have been sourced for data in order to produce the archive file. starttime : datetime
This is the time of the first entry in the archive file i.e. the oldest data in the archive file. status : integer
This is the status of the archive file. A non-zero value indicates an error.
0 = Valid archive, correct stream, online true
1 = Valid archive, correct stream, online false
2 = Valid archive, incorrect stream, online defaulted to false
3 = Invalid archive, online defaulted to false valuecolumn : char
This is a comma-separated list of the columns that were sourced for data from the source table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 278
logcolumn
OpenEnterprise Schema
Derived From:
Description:
For each stream defined there must be one or more corresponding entries in the logcolumn table. These define the columns to be collected from the source table and determine the names of the columns in the destination table. If the stream is using compressed collection, different types of compression algorithms may be used on the data between collections.
These are specified in the type attribute.
<Base Table>
Attributes: control : integer
This is a primary key of this table, along with the name attribute. It is also a foreign key reference to the logcontrol table that defines the stream. indexmethod : integer
Indexes can be created on archive files for logged column types of datetime, real and integer. Only columns from raw datasets may be used at the moment. Possible values for this attribute are: -
0 = No indexing on this column
1 = Indexing required on this column
For indexing to occur on archive files created for this logged column and
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 279
OpenEnterprise Schema dataset the following attributes all need to be set: name : char
1. This attribute must be set to 1.
2. The CL should make a valid entry into the IndexDataType attribute for the same column/dataset in the oelogcolumn table.
3. The ArchiveCatalogue attribute in the oelogdata table for the datastream must be set to TRUE.
When a raw log file marked as above for indexing is archived, the archive is indexed on the columns specified. Maximum and minimum values for the indexes created are stored in the relevant archiveindex table.
This is the name of the column that will be viewed through the loghistory derived table that is created upon the successful completion of a historical stream. sourcecolumn : char
The sourcecolumn will either be the name of a column in the table that is being sourced or the name of a previously defined name entry in this table.
If the string describes the name of a column in the source table, raw collection will be established and the type attribute will have to be 0.
If the string describes a name column in a previously defined logcolumn entry and the control reference matches that of the previous entry, the object will set up the stream to collect compressed data. Exactly, how the data is compressed is determined by the type attribute. type : integer
This attribute will describe the compression technique (if any) to carry out upon the column from the source table being stored by the stream associated with the object. These enumerated types are explained
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 280 below.
0
ID Type
Raw field
4
5
6
7
8
First
Last
Maximum
Minimum
Average
11 Integral
12 AND
13 OR
14 ON count
15 ON per cent
16 Duration
19 Total
OpenEnterprise Schema
Description
Unprocessed data from the source table
The first not NULL input value
The last not NULL input value
The maximum input value
The minimum input value
The time-weighted average of input values
Estimated area bound by input values
The logical AND of input values
The logical OR of input values
The number of times a boolean is switched to ON
The percentage time a boolean spent ON
The period of time used to calculate other compression values (i.e. when the source field had a not NULL value in the database)
The total of the input values
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 281
logcontrol
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
This table is used to define a stream. From this stream data may be logged. This stream only supplies a single set of values. A data set must be defined (an instance of oelogdata) in order to log historic data. This table specifies the source table and the rate at which to retrieve values from this table.
Attributes: compressed : char
This is the name of the table that will be created to allow SQL access to the historical data. The table will be derived from loghistory. This table will contain the compressed values of the stream. If NULL, historical collection can still continue. It just cannot be accessed through SQLC. description : char
This attribute is optional and can be used to describe the stream. enable : bool
This will either allow or disable any historical collection for this stream. If collection is enabled, the collection of data for individual objects may be
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 282
OpenEnterprise Schema disabled using the enablecolumn attribute. enablecolumn : char
If specified, the string must match a boolean column in the source table that will enable or disable logging of each individual object in that table.
Value of NULL or TRUE will enable logging while a value of FALSE will disable it. This facility allows logging on an object-by-object basis. id : integer
This is a unique value for each object in the logcontrol table. It is also the primary key. namecolumn : char
The namecolumn attribute must be used to describe the primary key column of the source table. It is a NOT NULL attribute. rate : integer
This is the collection rate of data from the source table to the stream. It is specified in seconds. A value of NULL forces collection by exception
(that is, collection only when the source value changes.) ratecolumn : char
This column is used to override the collection rate specified in rate by specifying an integer column in the source table. This column will be used to determine the collection rate of each individual object. If the rate column is NULL then this attribute will be ignored. This attribute may not be used in conjunction with the triggercolumn facility.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 283
OpenEnterprise Schema rateorigin : datetime
Often data collection is more useful if the collection can be made exactly on the second or on the minute. This column enables this by allowing a datetime to be specified that will determine the offset of collection from time 00/00/00 00:00:00. Therefore, a datetime value of 12:00:00 will start collection for the stream twelve hours at the completion of the next twelve hour cycle since time: 00/00/00 00:00:00. raw : char source : char
This is the name of the table that will be created to allow SQL access to the historical data. The table will be derived from loghistory. This table will contain the raw values of the stream. If NULL, historical collection can still continue. It just cannot be accessed through SQLC.
This is the name of the table within the database that data is to be sourced from. timestampcolumn : char
This attribute can be used to specify a datetime attribute in the source table that will be used to define the timestamp value to place within the historical stream. triggercolumn : char
The triggercolumn is used to define a boolean attribute in the source table. This attribute will be used to start or stop logging of data on an object basis. usercompression : char
This attribute allows a stream to carry out a compression technique of its
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 284
OpenEnterprise Schema own upon the data by specifying the name of a handler within the CL code that will be used. This functionality is currently not available. userenabling : bool
If this attribute is set to True then all the objects in the source table are disabled. usersampling : bool
If this attribute is set to TRUE the rate, ratecolumn and triggercolumn attributes of the object are ignored. This is intended to be used with streams that do not wish to use the automatic sampling mechanisms but to define their own collection via the sample CL handler. A value of
NULL of FALSE will result in the automatic data sampling being enabled. worker : integer
The worker attribute is a foreign key reference to the logworker table.
This entry is used to associate this stream with a log worker task that will prevent the blocking of the database during historical reads and writes, to and from disk. If the value is NULL no worker task is used.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 285
logdata
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table defines the data to be collected for each stream. This is known as the data set. Here, the frequency of collection how it is sourced and general archiving are defined. Instance of this table should not be created for logging data though. oelogdata is derived from this and will give greater control to archiving.
Attributes: archbuffercount : integer
The archbuffercount attribute dictates the maximum number of buffers that can be written from the historical stream to an archive file during an archive operation. archdirectory : char
This attribute specifies the absolute path of the directory to place the archive files produced for this data set. If the historian is unable to write to the directory, an error is produced at the database console and no archive file created. archfilename : char
This is the name of the archive file to write to. This is constructed of the following information is order for client processes to be able interpret the
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 286
OpenEnterprise Schema name and determine the stream and data set details of the archive file.
<control><rate><start time><file time><count>.arch where:
Control - is the id of the logcontrol reference
Rate - is the rate attribute of the logdata object
Start time - is the timelogged for the first item in the archive file
File time - is the number of seconds between the first item and last item in the archive file archiving : bool
Count - is a rolling count.
Setting this attribute to TRUE will instigate the writing of an archive file to disk. When the I/O operation is complete, the value of the boolean is reset to FALSE. If the archbuffercount is less than 1 or the archfilename is NULL, the transaction to set the archiving flag will fail. archstatus : integer
This attribute indicates the error status of the archive operation. A nonzero value indicates an error. A zero indicates that an archive file has been created. buffercount : integer
This is the maximum number of buffers that can be held by this data set in the historical file. As more data is inserted into the data set the buffers will be filled up. If the limit is reached, the oldest buffer will be overwritten by new data.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 287
OpenEnterprise Schema buffersize : integer
This is the size in bytes of each buffer within the historical file. compressionorigin : datetime
The compressionorigin attribute allows the compressed data to be stored exactly on the hour or minute by specifying that duration within the field. For example, 00/00/00 1:00:00 will cause compression to occur on the hour and thereafter every rate interval. control : integer
This is a foreign key reference to the logcontrol table. It determines the stream that data should be sought from. directory : char
If specified, this attribute will override the default file location described in the database configuration file. This is the placement of the historical file rather than the archive file, which is placed in the directory specified by archdirectory. fedfromrate : char
If this data set is collecting raw data a value of NULL or 0s will suffice. If the data set wishes to collect compressed data and also wishes to use an existing data set to extract its data from, the rate of this data set can be specified here. For example, specifying 5s here will source its data from another, existing, data set that is already sourcing from the stream every 5 seconds.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 288
OpenEnterprise Schema feedcount : integer
This is an internally used attribute that should not be changed. filename : char rate : char
This is the name of the current history file name that is being used to store the buffers of data. The attribute is hidden. magicnumber : integer
This is internal, hidden and must not be changed. percentfree : integer
This is the amount of space still available within the history file. The value is updated every time a buffer is written from memory to this file.
Archiving is triggered when this value reaches a designated value determined in the derived table, oelogdata. This functionality is only available if the instance of oelogdata was created, instead of logdata.
This value describes the collection rate of the data set. A value of 0s will cause the data set to collect data from the stream (specified in the control attribute) whenever the values in the stream change. starttime : datetime
The starttime attribute describes the timestamp of the oldest item in the history file. The value is updated upon each write of a buffer to the history file.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 289 status : integer
OpenEnterprise Schema
This is the error status of the history files writes. A non-zero value indicates an error. unarchivedblockcount : integer
This is the number of blocks in the historical stream which are currently unarchived. usercompression : char
This attribute, if specified, will give the name of the CL handler, within the logcontrol table, that shall be used to calculate the compression technique upon the data set. This will override any handler specified in the logcontrol objects usercompression table. This attribute, however, is currently ignored.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 290
logextract
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
This table is used to extract data from a historical stream and place it in an archive file. Specific times must be stipulated as well as the stream to be sourced and a destination file. It allows for the extraction of specific data and is used when reporting of a particular time period is required. Archiving is otherwise carried out automatically by the oelogdata table.
Attributes: completed : bool control : integer directory : char
The completed flag is set to TRUE once the data from the history file has been written to an archive file. This is a read-only attribute.
This is a foreign key reference to the logcontrol table. It is a not null column that allows the details of the stream to be extracted from the reference.
This is the directory in which to extract the historic files. If the attribute remains NULL, the default historic files directory will be used.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 291
OpenEnterprise Schema disable : bool
This may be set to disable any writing of historic data to an archive file.
The process of creating an archive file will start when the attribute is set to FALSE. endtime : datetime
The endtime attribute will specify the datetime of the most recent entry in the history file to archive. If NULL is specified, the data extracted will be up to the most recent entry in the history file. filename : char id : integer granularity : char
The filename attribute will determine the name of the archive file to create. If a file already exists, it will be overwritten.
This attribute must be specified in order to determine the data set to extract to the archive file. This value should match a rate attribute within the logdata table associated with the stream, specified by the control reference.
This is a unique value and primary key of the logextract table. name : char
This attribute is used to identify the objects from the history file to extract. The objects are specified using a comma-separated list of primary key values from the source table of the stream. If the attribute is
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 292
OpenEnterprise Schema
NULL, all the objects in the data set will be written to the archive file. starttime : datetime
This is the earliest timestamp to extract from the history file. If it is not specified (i.e. the value is NULL) then the earliest time in the history file will be sought as the start of the archive file. status : integer
This is the error status of the extraction attempt. After, initially being set to NULL at the start of the extraction, the value is set to 0 when the extraction is successfully complete or any other value if the extraction has failed. This is a read-only attribute.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 293
loghistory
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
This table is derived from, by the database, internally. In order for historical data to be viewed a table is created, derived from loghistory. Its name is determined by either the raw or the compressed attributes of the logcontrol table. Its columns are determined by the name attribute of objects in the logcolumn table that reference the appropriate logcontrol entry.
Attributes: deleted : bool id : integer
This is set to TRUE if the value in the data set as been deleted. If the data set is a raw collection, the value will be NULL. If the data set is a compressed collection, the compressed values will only be NULL if all the values in the compression period were set to NULL or the compression value was NULL anyway.
This is a unique identifying number for the objects returned by an SQL query. name : char
This attribute reflects the primary key column of the sourced table. When querying historical data, this attribute must be specified as a condition
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 294
(i.e. where name = signal1 ).
OpenEnterprise Schema timestamp : datetime
This is the time at which the data set logged the associated value.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 295
loghistory
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
This table is derived from, by the database, internally. In order for historical data to be viewed a table is created, derived from loghistory. Its name is determined by either the raw or the compressed attributes of the logcontrol table. Its columns are determined by the name attribute of objects in the logcolumn table that reference the appropriate logcontrol entry.
Attributes: deleted : bool id : integer
This is set to TRUE if the value in the data set as been deleted. If the data set is a raw collection, the value will be NULL. If the data set is a compressed collection, the compressed values will only be NULL if all the values in the compression period were set to NULL or the compression value was NULL anyway.
This is a unique identifying number for the objects returned by an SQL query. name : char
This attribute reflects the primary key column of the sourced table. When
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 296
OpenEnterprise Schema querying historical data, this attribute must be specified as a condition
(i.e. where name = signal1 ). timestamp : datetime
This is the time at which the data set logged the associated value.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 297
logobject
Derived From:
Description:
<Base Table>
This is for internal uses only.
Attributes: id : integer
Primary key value of logobject.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 298
logworker
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The logworker table is used to maintain connections to log worker tasks that carry out the I/O for historical logging and retrieval.
Attributes: address : char
This is the data service name, where the worker task will be. The format is host:port. checkperiod : datetime
Undocumented connectattempts : integer
The number of times that a connection to the worker task has been made since the database started. connecttimeout : datetime
This is the length of time that the database will wait after attempting to
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 299
OpenEnterprise Schema start the worker task before it will declare it as timed out, if the connection has not been made. id : integer
This is the primary key of the worker task. retryperiod : datetime
This is the length of time between connection attempts to the worker task. status : integer
This is the status of the connection to the worker task. timeout : datetime
This is the timeout period between the database and the worker task. If communications is not recovered in this time period, the connection is declared to have timed out.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 300
mailformat
Derived From:
Description:
Attributes:
No attributes extend this table.
objects
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 301
memoryalarmcondition
Derived From:
Description:
OpenEnterprise Schema alarmcondition
This alarm condition is applied to values in the memorymonitor table.
Attributes: level : integer name : char
The percentage of memory used that will cause the alarm.
This is a foreign key reference to the MemoryMonitor table .
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 302
memorymonitor
OpenEnterprise Schema
Derived From:
Description: objects
This table can be used to monitor persistent memory usage. The values within the table will be updated periodically e.g. once every 60 seconds. A high alarm will be generated when 75% of total memory is allocated. A high-high alarm will be generated when 90% of total memory is allocated.
Attributes: highmemorymark : integer
The highest recorded memoryUsed value. highMemoryMarkTimestamp: integer
The timestamp associated with the highMemoryMark value. memoryavailable : integer
Number of bytes currently not allocated. memoryused : integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 303
OpenEnterprise Schema
Number of bytes currently allocated. . percentageMemoryUsed: integer
Number of bytes currently allocated, expressed as a percentage of total memory.
Refresh: bool
When set to TRUE, the memory statistics will be updated with the current values. This is intended to provide a manual refresh facility. totalmemory : integer
Approximate size of the persistent memory pool. This value should be approximately the value specified by the s rtrdb command line parameter.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 304
memorymonitorcallbacktimer
OpenEnterprise Schema
Derived From:
Description: oetimer
This table is used to manage the memory monitor call back timer functionality.
Attributes: memorymonitorobject : char
A reference to the memory monitor object referenced.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 305
multidigital2
OpenEnterprise Schema
Derived From:
Description: signalextension
This table will collect 2 multi state digital alarm conditions together.
Depending upon the value of the two digital signals, one of the four states will be reached, and the appropriate alarm generated.
Attributes: currentstate : char
The current state of the multidigital signal. defaultstate : char
If no alarm conditions are satisfied in order to generate a value, this default text is used instead. defaultvalue : bool
This value will be used at database start-up to set the associated signals value and readvalue. No default value. lastoverridevalue : bool
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 306
OpenEnterprise Schema
The last override value set by the user (or the value existing when an override was enabled). Used to restore the override value following a database restart. lastreadvalue : bool
The last value read from the RTU. This will be updated using the readvalue attribute whilst an override is enabled. This value will be copied into value and readvalue when an override is cancelled. readvalue : integer8
This is the digital value, last read from the device. value : integer8
This is the digital value that client applications have access to and may change.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 307
multidigital3
OpenEnterprise Schema
Derived From:
Description:
Attributes:
No attributes extend this table.
multidigital2
This table will collect 3 multi state digital alarm conditions together.
Depending upon the value of the three digital signals, one of the eight states will be reached, and the appropriate alarm generated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 308
multidigital4
OpenEnterprise Schema
Derived From:
Description:
Attributes:
No attributes extend this table.
multidigital3
This table will collect 4 multi state digital alarm conditions together.
Depending upon the value of the four digital signals, one of the sixteen states will be reached, and the appropriate alarm generated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 309
multistatedigitalalarmcondition
OpenEnterprise Schema
Derived From:
Description: alarmcondition
This alarm condition is applied to multi state digital alarms. A set of these objects will be applied to a multi state signal.
Attributes: name : char statetext : char
This is a foreign key reference to an attribute in the multidigit2 table.
This is the string representation of the digital signal value (i.e. ON, OFF,
True, False, etc.) statevalue : integer8
This is the value of the digital signal.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 310
notes
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Derived From:
Description: objects
The notes table is used to contain a set of objects that will be used like post-it notes. They will be used for any purpose they are seen fit for.
Derived from this table are the objectnotes, signalnotes and the usernotes tables.
Each individual note must also hold one of three states: Standard Expiry and Alarm. A Standard note will be created and remain a note until it is deleted from the table. An Expiry note has a time limit associated with it - once this runs out the note is automatically deleted. An Alarm note also has a timer associated with it, but once the timer expires an alarm is generated and the note remains in the notes table.
Attributes: alarmpriority : integer
This is the alarm priority of an alarmed note. alarmtime : datetime
This is the time at which an alarm will be generated in the
AlarmSummary corresponding to this note.
Reference Guide
D301521X412
24-Feb-2010 - Page 311
OpenEnterprise Schema alarmtimedstoffset : 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. createtime : datetime
This is the date and time at which this note was created. createtimedstoffset : 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. emergencyprocedures : char
This is a description of what procedures should be carried out to resolve a problem on the system. This is associated with alarm notes. expirytime : datetime
This is the time when the note will automatically be removed. This is relevant for the Expiry notes and Alarm notes. expirytimedstoffset : 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. lastnotetype : integer8
This is a reserved attribute. Do not use.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 312
OpenEnterprise Schema message : char nextid : integer
This is the message that is to be conveyed.
This is an internal value used to automatically generate a primary key value for new notes objects. notesdiary : char
For either an Alarmed Note or an Expiry Note, a diary entry is generated in order to deal with the timing of when the alarm should be generated or when the note should be removed (expired). notetype : integer8
The notetype attribute will describe whether the note is a standard note an expiry note or an alarm note. personnel : char recipient : char
This is a string describing the people that this message is relevant to.
This is the name of the person who will receive this note. sender : char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 313
OpenEnterprise Schema
This is the name of the person who sent this note. subject : char
This is the subject of the note that should briefly summarise the contents of the note. tobescheduled : array of ToBeScheduled
This is an array of references to the ToBeScheduled table. They are used in conjunction with the notesdiary attribute.to connect this note object with the scheduling system. totalalarmednotes : integer
This is the total number of notes that are of type alarm. An alarm note will be given a time period, during which it is just a standard note. When this time runs out, it generates an alarm and still remains a note. totalallnotes : integer
This is the total number of notes on the system. totalexpirynotes : integer
This is the number of notes on the system that are of type expiry. These will be removed from the system after a stipulated period of time. totalstandardnotes : integer
This is the total number of notes on the system that are of type standard.
They have to be manually deleted from the system.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 314
OpenEnterprise Schema triggeralarm : bool
Setting this value to TRUE causes an alarm to be generated for the note, if notetype is of type expiry. triggerexpiry : bool
Setting this value to TRUE causes the timer associated with the note to expire. A subsequent action will depend upon how the alarm is generated. type : integer8
The type is, currently, one of three types. It can be either user notes signal notes or object notes. unread : bool worktype : char
If this value is true, then the note has not been read by anybody on the system. The Notes Client application will set this to false when it deems that a user has read a note. worklocation : char
This is a description of the area this note is associated with.
This is a description of the type of work being carried out that this note is referring to.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 315
notesalarmcondition
OpenEnterprise Schema
Derived From:
Description:
AlarmCondition
This table is used to enable notes to generate alarms. When an Alarm
Note is configured on the system a NotesAlarmCondition instance is created as well. When the alarmed note is determined to be in alarm, this alarm condition is triggered, creating an entry in the AlarmSummary table.
Attributes: name : char references Notes
This is the link back to the Notes table. It is used to update or pulled values from the Notes object when generating, updating or deleting an entry in the
AlarmSummary table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 316
nw3000alarmprioritymap
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table is used to map an alarm priority received from a Bristol RTU to a different priority within the OpenEnterprise database.
Attributes: localpriority : integer references
The priority that the nw3000alarm is mapped to within the
OpenEnterprise database. remotepriority : integer Primary Key
The nw3000 alarm priority.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 317
nw3000analogpolllist
OpenEnterprise Schema
Derived From:
Description:
Attributes:
No attributes extend this table.
nw3000polllist
Network 3000 specific analog poll list datum.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 318
nw3000archive
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
Stores all the information needed by OEBFill to write Archive data into the database. That is, the name of the files used for the archive, the names and types of the signals within each archive and their position within the archive. Populated by the NW3000Archive Configuration Tool.
Attributes: columnid : integer Primary Key
The column id within the Archive. filename : char Primary Key
The name that will be passed into the OpenArrayFile in OEBFill. signalname : char Not Null
The signal at the specified column id. type : integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 319
The signal type:
0 = Analog
1 = Digital
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 320
nw3000audit
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
Used by OEBFill to back fill audit data from Bristol RTUs to the Event
History table of the OpenEnterprise database. A single object is inserted into the nw3000Audit table. All Audit records update this single record.
Once this single record is updated, CL inserts a record into the Event
History table with an EventType of 'Audit'.
Attributes: devicename : char
The name of the device from which the Audit data is being imported. eventtext : char
A description of the event. This will go into the description field of the
Event History table id : integer Primary Key
The unique id. Since there is only one entry, this will have the value of 1.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 321
OpenEnterprise Schema journalinfo : char logtrigger : integer
The last part of the update will increment the logTrigger value. The CL script associated with the table causes an appropriate eventHistory message to be logged, using an on set logTrigger handler. occurrencetime : datetime
The occurrencetime of the original alarm/event. signalname : char
The name of the signal which caused or was affected by the event.
Internal reference to the journaltask table. Hidden attribute.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 322
nw3000device
OpenEnterprise Schema
Derived From:
Description: dvi_device
This is device specific information for a network 3000 RTU. It contains information about events at the RTU and statistical information on the data collection.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. acktimeout: integer
The number of times that a message's ACK has not returned within the time interval allowed. alarmcondition : array of AlarmCondition
This is an array of NW3000DeviceStatusAlarmConditions associated with the
Device. There is usually only one Alarm Condition applied to each device.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 323
OpenEnterprise Schema alarminitialise : bool
Setting this flag to TRUE re-initialises data collection by purging the alarms in the
AlarmSummary table and prompting the RDI to re-collect the alarms. alarmpurge : bool
Setting this value to TRUE clears the AlarmSummary table of any entries relating to this device. alarmreports:integer
Count of the number of Remote Alarm Reports received since the NW3000 RDI started. alarms : array of AlarmSummary
This is an array of alarms that have been generated off of this device and are currently active within the AlarmSummary table. backupname: char
Device name for standby connection; not currently used. backupstatus: integer
Current status for backup line. baudrate: char
String representation of baudrateindex.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 324
OpenEnterprise Schema baudrateindex: integer
0 = None
1 = 300
2 = 1200
3 = 2400
4 = 4800
5 = 9600
6 = 19200
7 = 38400
8 = 57600
9 = 115200 bufferoverflow: integer
Input character buffer was overflowed before the end of message sequence was received. buildsigs : bool
This is a trigger that is monitored by DBB (NW3000 Database Builder). When set to TRUE, the DBB (if running in monitor mode), will create a database from the
ACCOL signals. It is recommended, therefore, that if it is desirable to manually trigger the nw3000 Database Builder from a remote location that the DBB is started in monitor mode as part of the OE session. collecthistory: bool
In PSTN systems, the CCM will update the collectTemplates and/or collectHistory attributes in response to an operatorRequest change. TRUE = collect, FALSE =
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 325 no collection.
OpenEnterprise Schema collecthistorystatus: integer
When a collectHistory request is completed, the collectHistoryStatus attribute will be updated to reflect the archive collection status. A value of zero indicates success. All other values indicate an error. collecthistorytimestamp: datetime
When collectHistory request is completed, the collectTemplatesTimestamp will be updated with the date and time when the request completed. collecttemplates : bool default FALSE
Enables the manual triggering of all templates owned by the device referenced.
The attribute is monitored by rdi3000. When set to TRUE, rdi3000 will initiate a template request. Once the request is initiated the value of this attribute will be reset to FALSE. collecttemplatesstatus: integer
When collectTemplates returns to FALSE, the collectTemplatesStatus attribute will be updated to reflect the template collection status. A value greater than or equal to zero indicates the number of templates collected. A value of less than zero indicates an error. collecttemplatestimeclass: integer
The collectTemplatesTimeclass attribute is handled as followed:
<= 0 or NULL All templates will be collected.
> 0 Only the specified timeclass will be collected.
When a collectTemplates request has completed, the collectTemplatesTimeclass
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 326 attribute will be reset to NULL.
OpenEnterprise Schema collecttemplatestimestamp: datetime
When a collectTemplates request has been issued, the collectTemplatesTimestamp will be updated with the date and time when the request completed. consecutivemessages: integer
Number of times that a message with a duplicate sequence number was received.
This can occur when an ACK message is missed by the remote system. debugoptions : integer
This attribute is used by rdi3000 to generate runtime debug information. It is also used to enable manual poll functionality for older OE Schemas, which do not have the collecttemplates attribute. It is a four byte integer for which bits 0 to7 are reserved for runtime debug support. The debugoptions value has been extended to allow commands to be sent to the rdi3000, as follows:-
Bit 19 Command. If set to 1 then a command is being issued.
Bit 18 Reserved for future use.
Bit 17 Reserved for future use.
Bit 16 Collect templates command. defaultpollperiod:integer
Temporary attribute used by the DBB. Internal use only. description : char
A description of the device. Copied from the description assigned to a device within OpenBSI.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 327
OpenEnterprise Schema devicetype:char
Textual name of the Bristol device type. See devicetypeid for a list of the names against their devicetypeid number. devicetypeid:integer
The ID number of the Bristol device type. The deviceType ID values and their corresponding textual names are as follows:
1 = "3305"
2 = "3308"
3 = "3310"
4 = "3330"
5 = "3335"
6 = "3508"
7 = "3530"
8 = "VIRTUAL"
9 = "ControlWave"
10= "CWave_LP"
11 = "CWave_RIO"
12 = "CWave_Micro"
13 = "CWave_EFM"
14 = "CWave_CFG"
15 = "CWave_XFC"
16 = "CW_10"
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 328
17 = "CW_30"
OpenEnterprise Schema
8 = "3808" dialfail: integer
This is only available on systems which support dial-up. It is the number of times which a dial operation failed to the current RTU. dialock: integer
This is only available on systems which support dial-up. It is the number of times which this RTU has been successfully been connected via a dial operation. disableactivepolling: bool
When set to True active polling is disabled. disableautopurge : bool default FALSE
Setting this attribute to TRUE will disable the automatic alarm summary purge that occurs when an RTU ACCOL load version change is detected. disablemonitor : bool
Setting this flag to TRUE disables sanity checking for this device. This does not effect RBE collection. disablepolling:bool default FALSE
When set to True polling for the device is disabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 329
OpenEnterprise Schema display : char
A text attribute provided for entering the file name of any OEGraphics display that contains the network 3000 device referenced. enablealarmdescriptor:bool
Controls whether the the signals alarmDescriptor attribute is used to update the
AlarmSummary.When set to true, the alarmDescriptor (if set) will be used to update the AlarmSummary (new and updated AlarmSummary enableondemand : bool default FALSE
When set to TRUE, the rdi3000 will initiate Archive and Audit collection from the
RTU when the RTU comes back online. This value will be overridden unless the
DisableOnDemand attribute of the nw3000Driver table is set to FALSE. NW3000
Archiving and Auditing requires OpenBSI Harvester and Converter to be running, and also requires configuration in the ACCOL load and the OpenEnterprise database. Refer to the NW3000 Archiving Overview help file for more details. enablepollcontrol:bool default FALSE
When set to TRUE, RDI3000 will attempt to turn-off polling for the RTU when no outstanding communication requests exist. enablepolling:bool default FALSE
When set to TRUE, RDI3000 will enable polling for the RTU. RDI3000 will immediately reset the value back to FALSE. enablerollingscan: bool
When set to True, all templates belonging to the device will be collected by rolling scan. eventnumber : integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 330
OpenEnterprise Schema
When a network 3000 device generates an event, the eventnumber is filled with a value identifying this event. eventtext : char
This attribute describes the last event that occurred on the network 3000 device. eventtimestamp : datetime
The time that the last event occurred upon a network 3000 device is recorded within the eventtimestamp attribute. eventtimestampdstoffset : 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. eventtrigger : integer
This attribute records an incrementing count of events. invalidack: integer
An ACK message has been recevied when one was not expected or the message contained an invalid message identifier. invaliddle: integer
An invalid DLE sequence was received, the DLE (10 Hex) was not followed by a
ETX (03 Hex), STX (02 Hex), SOH (01 Hex), or DLE.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 331
OpenEnterprise Schema lastalarmtimestamp:datetime
The time when the last remote alarm report message was received. lastoffline: datetime
The last time the device came offline. lastonline: datetime
The last time the device came online. lastpollduration:integer default NULL
The number of seconds for which the RTU was online to complete the last communication. This will be calculated from when the RTU goes online to when communication was stopped by RDI3000. lastpolldurationtimestamp:DateTime default NULL
The timestamp (in UTC) of the current LastPollDuration value. lastrsnreceived : integer
This is the id of the last RSN (report sequence number) message that was acknowledged by the server. The attribute is treated with respect to the device. So a message received is relevant for the device. The value of the message goes from 1 to 127 and starts again at 1. lastrsnsent : integer
This attribute contains the id of the message last sent from the RTU to the server.
The value of the message goes from 1 to 127 and starts again at 1.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 332
OpenEnterprise Schema lastrsntimestamp:datetime
The time when the last RBE report message was received. lastrtuversion : integer
This attribute stores the last ACCOL load version received from the RTU. It is used internally for managing the automatic alarm summary purge that occurs when ACCOL load version changes are detected. missend: integer
A start message sequence was detected before the corresponding end codes were received. msdversion : integer
The Master signal Directory version number of the RTU. nobuffer: integer
A buffer was not available to load in an incoming message. num_rbe_ana : integer
This is the total number of analog signals collected using RBE. num_rbe_log : integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 333
OpenEnterprise Schema
This is the total number of digital signals collected using RBE. online : bool
Reflects the online status of the device, TRUE = online, FALSE = offline. A device will be marked as online within the database when a COMM.STATUS alarm is received for the device with a units text of ONLINE or whene any message is received from the RTU. operatorrequest: integer
For PSTN systems, the CCM will monitor the OperatorRequest attribute within the nw3000Device table to determine when an action is required. The following table details the possible values for OperatorRequest and an indication of how the CCM should process the request.
Action
OpenLine (IP only)
CloseLine (IP only)
One Shot
Request
Attribute
OperatorRequest
Bit 0
OperatorRequest
Bit 1
OperatorRequest
Bit 2
Target Attribute collectHistory, collectTemplates, set to TRUE
Completion
Attribute
Online = TRUE
Online = FALSE collectHistory, collectTemplates, return to FALSE
Interrogate
Write *
Continuous
Scan
OperatorRequest
Bit 3
OperatorRequest
Bit 4
CollectTemplates CollectTemplates,
Return to FALSE
Appropriate signal attribute e.g. Value
Forcewrite return to
FALSE to
EnableRollingScan to FALSE. outqueue: integer
The number of messages waiting to be sent to this RTU. Note: when using direct connect BSAP, this field is only maintained for the first slave on the communication line.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 334
OpenEnterprise Schema plantarea : char
This attribute describes a specific area that the device is maintained within. This is dependent upon the plant layout and can be used to determine what devices are within a specific location on a site. pollperiod: integer
The number of .050 second intervals between poll passes on this port. portflags: integer
Flags indicating the options used for the current RTU: portname: char
The device name for the current communication port. portstatus: integer
Flags indicating current state of the current RTU port.
Bit Name Description
0x01 PORT_OFFLINE Indicates that the RTU is not configured into system.
0x02 PORT_TSRNEED
0x04 PORT_DEAD
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
0x08 PORT_CON_ERR
Set when the RTU is due to receive a time synch message.
Set when the current RTU will not accept messages.
Set when an RTU is declared in-active due to a configuration error on the current
Reference Guide
D301521X412
24-Feb-2010 - Page 335
0x20 PORT_NEEDPOLL
OpenEnterprise Schema
0x40
0x40
0x80
0x80
PORT_NEEDIPNRT
PORT_MANUALSW
PORT_FALLBACK
PORT_BACKUP
The attached RTU requires a poll on the next poll pass. Used to implement a preferred poll pass of only those nodes which responded to the previous poll pass.
IP RTU needs Node routing and network routing info.
On Backup status word - Indicates a manual switch to backup line.
Indicates which IP line communications is occurring.
On Backup status word - set to indicate backup present. porttype: integer
Specifies the protocol being used to connect to the current RTU range. The following are currently supported: rbe : bool
Bit
0x01
Name
BSI_COMT_BSAP
Description
The RTUs are directly connected to this workstation (which is the network master), using ASYNC, connected
BSAP. for these RTUs are sent to another workstation for processing.
0x03 BSI_COMT_EBSAP The RTUs are directly connected to this workstations (which is the network master), using ASYNC, connected
Expanded BSAP. Note: Local connections are not allowed with this option.
0x04 BSI_COMT_IP Port is running IP protocol.
If set to TRUE the device will report by exception. That is, only send data when values change. Otherwise, values will be polled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 336
OpenEnterprise Schema rbeformat : integer
The format may be either 1 - Short Format or 2 - Long Format. Short Format uses the MSD number to resolve signal changes while Long Format uses the signal name and is therefore less efficient. rbeinitialise : bool
Setting this attribute to 1 causes all the signals to be re-read and RBE collection to be resumed. rbemessages:integer
Count of the total number of RBE report messages received. The value can be manually reset. rbereports:integer
Count of the total number of RBE reports received. Each RBE message holds one or more RBE reports. The value can be manually reset. rbescanrate : integer
The scan rate is the minimum delay between successive starts of the RBE scans.
The value is in tenths of a second and may range from 0.1 seconds to 6553.5 seconds. rbescanslice : integer
This value is used to divide the work done during a scan session into an equal number of blocks known as slices so that the lower priority tasks are able to gain some processing time between each slice. It can range from 1 to the value of the rbescanrate field. If this value is set to 1 or 0, then slicing is inactive. It is normally set to 1 unless RBE is causing performance related problems.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 337
OpenEnterprise Schema rbestopxmit : integer
This parameter is used by the RBE task as a limit to temporarily stop sending
Exception Report Messages (ERMs). It refers to the difference between the current Report Sequence Number (RSN) and the RSN in the last Report
Acknowledged (REPORT_ACK) message from the RBE Manager. When this difference exceeds the StopXmit value, then the RBE task suspends the scan process and waits for a valid REPORT_ACK where the RSN difference drops lower than the value specified in this field. The valid range for this field is an integer between 0 (no suspension of ERMs), and 127. rbetimeout : integer
This is the amount of time, in tenths of a second that the server will wait before it acknowledges communication loss between itself and the RTU. readcrcs: integer
Statistic obtained during read operations. CRCs read. readmessages: integer
Statistic obtained during read operations. Messages read. readnaks: integer
Statistic obtained during read operations. NAKs read. readtimeouts: integer
Statistic obtained during read operations. Timeouts read.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 338
OpenEnterprise Schema resolvesigs : bool
This trigger updates the signals in the database to those in the RTU. retrycount: integer
Number of attempts which have been made to send the current message out the communication port. For direct connect BSAP, only maintained on first slave on the communication line. rollingscancomplete: datetime
The timestamp of the last rolling scan completion. Read only. rollingscandelta: datetime
The time period, in milliseconds, between initiating a collection request and receiving the last template response. Read only. rollingscangroup:integer Default = NULL (no group)
The optional group number for the device. Set to zero or NULL for no group.
Group numbers should be greater than zero. rollingscaninterval: datetime
The timer period, in milliseconds, between consecutive rolling scan requests for a device. Read only.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 339
OpenEnterprise Schema rollingscanmaxduration: integer
This value overrides the rollingScanMaxDuration value specified within the nw3000Driver table. rollingscansleep: integer
This value overrides the rollingScanSleep value specified within the nw3000Driver table. rollingscantimer:integer
Internal reference to the rollingscantimer table, set when rollingscan is enabled for a limited time period. Internal use only. rtuversion : integer
This is the version of the signals in the RTU device. The version is retrieved from the ACCOL file that had been used to download signals to the device. signalversion : integer
This is the version number of the database signals. It is obtained from the ACCOL file used to populate the database. timeclass : integer
This is the timeclass that has been assigned to all signals in this device (except for digital alarms and any other signal which has been individually assigned to another timeclass). Details about the timeclass can be looked up in the dvi_schedule table where data collection rates are stipulated. A 0 (zero) or NULL value indicates that no timeclass has been assigned to this device. The timeclass assigned here may be overridden on an individual signal level.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 340
OpenEnterprise Schema timeout: integer
Specified in 0.1 second intervals, this is the amount of time which the communication processor will wait before receiving the first character in a response to any one data link transaction.
Setting this value to zero will cause the data link layer to use the default value for the baud rate specified.
Note:
Some implementations of the BSI will perform time-out logic on only the complete message return; while some will time-out based on the start of the return text.
Versions which only use the complete message will wait longer to time-out a message which is not coming back.
The final resolution of time-out depends on which implementation of the BSI is used. tpbactive : bool
This attribute is set to true when the Poll List Builder (Template Builder) is actively running and generating templates on the server. This is required in order to guard against two Poll List Builders running at the same time. tplpollsdone:integer
Count of the total number of successful template requests. The value can be manually reset. tplpollsfailed:integer
Count of the total number of failed template requests. The value can be manually reset. writecrcs: integer
Statistic obtained during write operations. CRCs written.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 341
OpenEnterprise Schema writemessages: integer
Statistic obtained during write operations. Messages written. writenaks: integer
Statistic obtained during write operations. NAKs written. writesdone: integer
The number of writes attempted to the NW3000 device. This number will only be incremented if statistics is enabled in the nw3000driver table by setting the templatestats attribute to a value of less than 4. writesfailed: integer
An integer value which increases when a write to the device (i.e. an Alarm
Acknowledge or signal update) fails. The update on this attribute only occurs if statistics are enabled in the nw3000driver table by setting the templatestats attribute to a value of less than 4. This value is also used to generate a nw3000devicecommunication alarm, when configured. See nw3000devicecommunicationalarmcondition. writetimeouts: integer
Statistic obtained during write operations. Timeouts written.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 342
OpenEnterprise Schema
nw3000devicecommunicationalarmcondition
Derived From:
Description: alarmcondition
This table holds nw3000 device communication alarm conditions. A communication alarm will be generated following a communication failure with an RTU. The alarm can occur following a poll failure, write failure or any failure.
Attributes: devicename : char References nw3000device
The name of the nw3000 device. This is a foreign key reference to the nw3000Device table devicename attribute. type: char
The communication failure type that will generate an alarm. Can be one of POLLS, WRITES or ANY. The default value is ANY.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 343
nw3000devicestatusalarmcondition
OpenEnterprise Schema
Derived From:
Description: alarmcondition
This table contains instances of Alarm Conditions placed upon nw3000device objects. When the status value of the nw300device table changes the alarm condition is met and an alarm is generated.
Attributes: devicename : char
The name of the nw3000 RTU that the status alarm condition is associated with.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 344
nw3000deviceversionalarmcondition
OpenEnterprise Schema
Derived From:
Description: alarmcondition
This table contains instances of Alarm Conditions placed upon nw3000device objects. When the ACCOL version running in the nw300device changes the alarm condition is met and an alarm is generated.
Attributes: devicename : char
The name of the nw3000 RTU that the status alarm condition is associated with.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 345
nw3000digital
OpenEnterprise Schema
Derived From:
Description: digital
This table contains attributes specific to a network 3000 digital signal.
Attributes: alarmdescriptor:Char persistent
The alarm descriptor read from the BSAP remote alarm report. The column will be locked by RDI3000 and updated for every remote alarm report regardless of whether the remote alarm report contains a descriptor. When no descriptor is present, the attribute will be updated with an empty string. alarmpriority : integer
This integer value describes the alarm priority or, in effect, how the alarm should act. alarmreportstate : integer
This attribute provides further information about the alarm. It corresponds to a value that is either No Report, Single, Momentary or
Multiple. These descriptions map to values 0 to 3, respectively. Single indicates that the alarm has been generated once Multiple indicates it has occurred twice or more between RTU polls Momentary means the signal entered and left the alarm state briefly and No Report is used to
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 346 describe no alarm occurring.
OpenEnterprise Schema alarmtimestamp : datetime
This is the time when the alarm was generated. It is set by the device. alarmtimestampdstoffset : integer
The daylight savings offset for the alarmtimestamp value. Specified in minutes. alarmtimestampstatus : bool
This is the questionable status of the timestamp provided in the attribute alarmtimestamp. True indicates the time could be wrong. alarmtype : integer
The alarm type describes if the digital value has either: changed to true changed to false or just changed state. It does not, however, report a change to NULL. alarmvalue : bool
This value is set by the device and describes the value of the alarm. It is placed into an AlarmSummary instance. alarmversion : integer
The ACCOL load version of the RTU associated with the remote alarm report.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 347
OpenEnterprise Schema archivetimestamp : datetime
Archive Timestamp, set when importing Archive data collected by
OpenBSI. The OpenBSI converter DLL (OEBFILL) updates the archiveTimestamp attribute with data sourced from the Archive module.
Used when NW3000 Archiving is enabled. archivevalue : float
Archive Value, set when importing Archive data collected by OpenBSI.
The OpenBSI converter DLL (OEBFILL) updates the archiveValue attribute with data sourced from the Archive module. Used when
NW3000 Archiving is enabled. logtime : datetime
Log Time, set to the current time when a value is collected from the
RTU, whether from real-time collection (Template, RBE, Alarm) or from
Archive collection (OEBFill). The value is used to update the timestamp attribute logged by the historian. logtrigger : integer
Log Trigger, set when a value is collected from the RTU, whether from real-time collection (Template, RBE, Alarm) or from Archive collection
(OEBFill). The CL increments the logTrigger value of the signal by 1.
This prompts the historian to log the updated value. logvalue : float
Log Value, set when a value is collected from the RTU, whether from real-time collection (Template, RBE, Alarm) or from Archive collection
(OEBFill). The CL copies the updated value to the logValue attribute,
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 348
OpenEnterprise Schema which is then logged by the historian. msd : integer rbe : bool
When the MSD value changes a write to the device is made. MSD is the
Master Signal Directory
This is set to true if the signal value is updated every time it changes
(i.e. report by exception) readalarminhibit : bool
This value indicates the last read value of the alarm inhibit status from the device. readcontrolinhibit : bool
This value indicates the last read value of the control inhibit status from the device. readmanualinhibit : bool
This value indicates the last read value of the manual inhibit status from the device. readquestionable : integer
This value indicates the last read value of the questionable status from the device.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 349
OpenEnterprise Schema remotealarm : bool
This is set to true if the object refers to a remote alarm. timeclass : integer
This is the id of a timeclass, defined in the dvi_schedule table. It defines the rate of collection from the RTU. A timeclass may be assigned to all signals in a device by assigning the timeclass id to the device, or to individual signals within the device by assigning the timeclass id to individual signals within the device. All NW3000 digital alarm signals will be assigned to the default timeclass of 254 unless a different timeclass is set here.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 350
nw3000digitalalarmcondition
OpenEnterprise Schema
Derived From:
Description: digitalalarmcondition
This is the table definition that allows Network 3000 digital alarm report messages to generate alarms in the Open Enterprise system.
Attributes:
No attributes extend this table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 351
nw3000digitalpolllist
OpenEnterprise Schema
Derived From:
Description:
Attributes:
No attributes extend this table.
nw3000polllist
Network 3000 specific logical poll list datum.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 352
nw3000driver
OpenEnterprise Schema
Derived From:
Description: dvi_remote_driver
This table is a driver specific to network 3000.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. activepollingincluderbe: bool
When set to TRUE, RBE signals may be included in active polling. A value of NULL or FALSE will exclude RBE signals. The default is
FALSE. activescheduleid: integer (references dvi_schedule)
A reference to the dvi_schedule entry used for active polling. A value of
NULL will disable active polling. The default value will be 255 (unless already in-use).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 353
OpenEnterprise Schema activetemplateenabledigital: bool
Enable or disable the building of active templates for nw3000digital signals. The default value is enabled (TRUE). activetemplateenablerealanalog: bool
Enable or disable the building of active templates for nw3000realanalog signals. The default value is enabled (TRUE). activetemplateenablestring: bool
Enable or disable the building of active templates for nw3000string signals. The default value is disabled (FALSE). activetemplaterebuildminimuminterval: integer
The minimum number of seconds between successive template rebuilds. This value is applied either globally or on a per client basis.
The default value is 15 seconds. The value cannot be less than 0 (zero). defaultactivepollingperiod: integer
The default poll period for active polling. The default value will be 10 seconds. defaultbackgroundpollperiod: integer
The default poll period for background polling. The default value will be
60 seconds. disablealarm : bool default FALSE
Setting disablealarm to TRUE will result in all nw3000 remote alarm
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 354 collection stopping.
OpenEnterprise Schema disableondemand : bool default TRUE
NW3000 Archiving is a process that enables Bristol RTUs to be configured to collect Audit and Archive data, and then to insert this data into the OpenEnterprise historical event and signal tables. When
NW3000 Archiving and Auditing is set up, this attribute is used to globally disable NW3000 Archive and Audit collection for all NW3000
Devices. The default value of TRUE disables all NW3000 Archive collection. To enable it, set this value to FALSE. Then set the
EnableOnDemand attribute to TRUE for each NW3000 Device that you wish to collect Archive Data for. disablerbe : bool default FALSE
Setting disablerbe to TRUE will result in all nw3000 RBE data collection stopping. disablerollingscan:bool default FALSE
When set to True, all rolling scan functionality will be disabled within rdi3000. It will not disable any rolling scan specific CL. disabletplfilter : bool default FALSE
When using template data collection, response messages are filtered such that only data changes are sent from rdi3000 to the database.
Setting disabletplfilter to TRUE results in this filtering being turned off. display : char
Primarily, this text attribute is for entering the file name of any OE
Graphics display associated with the network 3000 driver.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 355
OpenEnterprise Schema eventnumber : integer
When an event is generated at the driver this value will represent that event number. eventtext : char
This is a textual description of the event that has taken place. eventtimestamp : datetime
This is the time at which an event has occurred. eventtimestampdstoffset : integer
The daylight savings offset for the eventtimestamp value. Specified in minutes. eventtrigger : integer
Setting this value journals the event details. forcetimesynch: bool
When set to True, RDI3000 will request a time synch by calling the
BSIForceTimeSynch API function.
The forceTimeSynch attribute value will be automatically reset to False after the time synch has been requested.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 356
OpenEnterprise Schema logicalalarmscheduleid: integer (references dvi_schedule)
A reference to the dvi_schedule entry used for logical alarm collection.
The default value will be 254. maxiofails : integer
This is the number of failed polls that are allowed before an RTU is determined to be off-line. numthrottled : integer
This is the total number of BSAP request messages that have been throttled by rdi3000. Throttling occurs when rdi3000 determines there are too many pending BSAP requests. The totalrequests value determines the total allowable pending BSAP requests. The numthrottled value is only updated if the nw3000.statsfrequency attribute is set. obsiretries : integer
This is the number of attempts allowed to start Open BSI before it is declared as failed. obsishutdown : bool
This attribute determines if Open BSI is shutdown. obsistartndf : char
The absolute name of the OpenBSI configuration that rdi3000 will attempt to start if obsistartup is set to 1 (one).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 357
OpenEnterprise Schema obsistartup : integer
If obsistartup is set to 1 (one) then rdi3000 will attempt to start OpenBSI if OpenBSI is not already running. obsitimeout : integer
This is the length of time, in seconds, that Open BSI is allowed to start up before a retry occurs. ondemandexclusion : integer
This attribute is used by rdi3000 to determine whether to initiate
NW3000 Archive and Audit collection after a period when an RTU has been offline. It represents the number of seconds that the Device has to have been offline before Archive and Audit collection should be initiated from the RTU. oneshotretries : integer default 3
This attribute is used by rdi3000 at server or rdi3000 start-up time to govern retries for one-shot templates that may have timed out during the start-up process. This value may be updated at runtime without needing to stop and restart rdi3000. For backwards compatibility, the rdi3000 will automatically use a value of 3 if it does not find this attribute in the OE
Database Schema. options : integer
The design philosophy of rdi3000 is that RTUs are permanently connected and hence all RTU communication is scheduled and controlled by rdi3000.
In a PSTN dial-up system, there are a few communication channels that can be used to communicate with a large number of RTUs. Therefore, each RTU may only be online for a few minutes each day. During each communication session with an RTU, rdi3000 must perform the appropriate data collection or operator action. This will include collecting
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 358
OpenEnterprise Schema archives; current values; remote alarm reports and user write requests.
For such systems, OpenEnterprise employs a separate application, the
CCM (Communications Control Manager). This is responsible for scheduling and requesting data collection. Therefore, in such systems, rdi3000 supports CCM requests. The options parameter determines what rdi3000 does when a previously dead outstation comes online. The options parameter is a bit value attribute.
Bit
0
1
2
3
4
5
6
7
8
9
Meaning
When set, the collection of templates will be disabled.
When set, the collection of RBE will be disabled (not applicable to CWMicro).
When set, the collection of archive and audit files will be disabled.
When set, alarm acknowledges will be discarded (not sent to RTU)
When set, the receipt of a #PWRUP alarm will not result in an RBE re-initialise.
When set, the receipt of a #PWRUP alarm will not result in a template collection.
When set, rdi3000 will use Passive sanity checking. No sanity check messages are sent to an RTU. Instead, if no messages are received from the RTU for maxIOFails consecutive number of check periods, the RTU is marked as offline.
When set, an offline RTUs signals are not marked as questionable.
When set, OpenBSI local alarms are journalled to the event history.
When set, sanity checking will use the OpenBSI API to check the RTU status. This can be used in conjunction with
Bit 6 but will only use passive sanity checking if the
OpenBSI API call fails. passiveofflineperiod : integer if no messages are received from the device after this number of seconds, it is marked as being offline. pollcontroloffdelay:integer default 0
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 359
OpenEnterprise Schema
A time period, specified in milliseconds, after communication with an
RTU has completed, before RDI3000 will attempt to turn-off polling. reqperdevice : integer
This is the maximum number of outstanding requests that are permitted to any device through this driver. Once this limit is reached, no further requests will be made of the device. rollingscandeadsleep:integer Default = 300 seconds
The maximum number of seconds to wait for all rolling scan template requests to complete before the current scan is cancelled. This timer prevents devices from hanging rolling scan collection due to template responses not being received. Under normal circumstances, responses will be received for all requests, including communication errors and time-outs. Therefore, this value should be set to a relatively large value. rollingscandevices:integer
The current number of devices with rolling scan enabled. Read only value. rollingscanmaxdevices:integer default = -1
The maximum number of devices with rolling scan enabled at any given time. Set to 1 to allow an unlimited number of rolling scan devices. A value of zero will effectively disable rolling scan. rollingscanmaxduration: integer
Specifies the maximum number of seconds that rolling scan should be enabled for all devices. When the time period expires, rolling scan for the appropriate device will be automatically cancelled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 360
OpenEnterprise Schema rollingscansleep:integer
The number of seconds to sleep following the successful receipt of all templates. This value cannot be less than 1 second. rollingscanstartupsleep:integer Default = 15 (seconds)
The number of seconds to delay rolling scan collection (for all devices) at rdi3000 start-up. This prevents initial template collection from occurring at rdi3000 start-up when RBE and alarms will be collected. rollingscantype: integer
Specifies the maximum number of seconds that rolling scan should be enabled for all devices. When the time period expires, rolling scan for the appropriate device will be automatically cancelled sanityperiod : integer default 60
This is the number of seconds that will elapse before the driver will check to see if any RTUs are alive. That is, every minute sanityslice
RTUs will be checked to see if they are on-line. sanityslice : integer default -1
This indicates which RTUs should be checked every sanityperiod. A value of -1 indicates all RTUs should be checked. templatestats : integer
Controls how the statistics attributes in the nw3000pollist table are updated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 361
The following values apply:
OpenEnterprise Schema
Partial statistics. This setting updates all nw3000pollist statistics attributes except for pollsdone, pollsfailed and pollsdeltasuccess.
Full statistics. This setting includes the pollsdone and pollsfailed stats.
Full statistics with history This setting includes the above plus pollsdeltasuccess stats.
Exception only. Reports full statistics but only when the collection status changes.
None. templatestatsreset : bool default FALSE
When set to TRUE will reset the template statistics (templatestats attribute). totalrequests : integer
This specifies the maximum number of pending BSAP requests that rdi3000 can have at any one time. The default value is 75% of the total wait packets configured within OpenBSI. tplinitpastdue : integer
Specifies the number of seconds that a timeclass can slip by before a recalculation of the next timeclass collection will occur. writepackingperiod: integer default 0
The period of time after receiving a signal write, which the RDI will wait for any further writes. When the timer expires, any pending writes will be packed and sent to the RTU. A value of zero disables write packing functionality. Specified in milliseconds.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 362
OpenEnterprise Schema writepackingrestart: bool
A value of TRUE indicates the write pack timer will be restarted upon receipt of an individual signal write. A value of FALSE indicates the timer will not be restarted, ensuring that a write to the RTU will occur a maximum (and predictable) period of time after the first write occurs.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 363
nw3000network
OpenEnterprise Schema
Derived From:
Description: dvi_network
This table contains additional information for network 3000 network setups.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. display : char
Primarily, this text attribute is for entering the file name of any OE
Graphics display associated with the network 3000 network referenced. statsreset : bool default FALSE
When set to TRUE, the rdi3000 will reset the device statistics.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 364
nw3000polllist
OpenEnterprise Schema
Derived From:
Description: dvi_datum
This table is the base table used to store constructed lists of signals that will be collected by polled reads. These are a replacement for the old style template data collection. Entries in this table will be created by the Poll List
Builder task (TPB).
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. fieldselector : integer
Bit field, indicating the signal properties to be collected via template data collection. Used internally by rdi3000 to construct BSAP template requests. forcepoll: bool
When set to TRUE the rdi3000 will perform a forced poll of all poll lists.
This can be filtered by applying a 'WHERE' clause in the SQL update which references a specific device (e.g. 'where devicename =
<devicename>'), and/or a scheduleid filter (e.g. 'where scheduleid =
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 365
<timeclass>')
OpenEnterprise Schema lasterror : integer
The error code for the last non-successful request. lasterrortimestamp : Datetime
The timestamp of the last non-successful request. msds : char
This is a space-separated list of MSDs. msdversion : integer
The Master Signal Directory version number. pollsdeltasuccess : integer
Statistic attribute. A percentage success rate for template collection.
This is a rolling % value for template collection within the last hour. E.g.
If the value is 57%, then 57% of template requests within the last one hour have been successful. pollsdone : integer
The total number of successful requests.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 366
OpenEnterprise Schema pollsfailed : integer
The total number of failed requests. This attribute is used to generate nw3000devicecommunication alarms, when configured. See nw3000devicecommunicationalarmcondition. requestid : integer
This is the id of the last request made. requeststatus : integer
This is the status of the last request made. Possible values and their meaning are as follows:-
0 = OK - Data collected.
3 = Rebuilding - a Template rebuild is in progress
8 = RTU Dead.
9 = ACCOL version mismatch detected.
11 = Invalid MSD detected.
13 = Timeclass slippage detected.
14 = Request time-out.
15 = NME mismatch.
28 = Request time-out - retrying. responsedelta : integer
The number of milliseconds between the template request being sent and the template response being received. This value is only valid when nw3000Driver.templateStats is set to 2.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 367 signals : integer
OpenEnterprise Schema
This is the number of signals in the msds attribute. statustext : char
This is the status of the last request made in text format.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 368
nw3000questionablealarmcondition
OpenEnterprise Schema
Derived From:
Description: questionablealarmcondition
This table allows the user to define a bitwise value for which an alarm will be generated if it matches the bitwise value of the questionable attribute of nw3000 signals.
Attributes: bitmask : integer not NULL
The range of bit settings that would constitute an alarm being generated. In order to provide more information to the user, the value of the alarm generated will contain a textual description of the value of the questionable attribute based on those values currently supported by the RDI3000 device driver. On a return to normal for the alarm condition, the value of the alarm will display the text “Good”.
Bit
Bit 0 (0x01)
Bit 1 (0x02)
Bit 2 (0x04)
Bit 3 (0x08)
All other bit settings
Setting Text
Questionable in Device
Data Collection Failure
Device Offline
Not a Number
Questionable
A range of values can be specified by adding the numbers together (i.e. raise alarms for Bit 0 to Bit 2 = a value of 7).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 369
nw3000realanalog
OpenEnterprise Schema
Derived From: realanalog
Description: This table contains additional information specific to a network 3000 real analog signal.
Attributes: alarmdescriptor:Char persistent
The alarm descriptor read from the BSAP remote alarm report. The column will be locked by RDI3000 and updated for every remote alarm report regardless of whether the remote alarm report contains a descriptor. When no descriptor is present, the attribute will be updated with an empty string. alarmlimit : float
The alarm limit associated with the remote alarm report. This value is only filled in if the RTU is configured to generate long format alarm reports. alarmpriority : integer
This integer value describes the alarm priority or, in effect, how the alarm should act. Priorities are Critical, Non-Critical, Operator Guide and
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 370
Event.
OpenEnterprise Schema alarmqbit : bool
This is the questionable status of the alarm timestamp. alarmreportstate : integer
This attribute provides further information about the alarm. It corresponds to a value that is either No Report, Single, Momentary or
Multiple. These descriptions map to values 0 to 3, respectively. Single indicates that the alarm has been generated once Multiple indicates it has occurred twice or more between RTU polls Momentary means the signal entered and left the alarm state briefly and No Report is used to describe no alarm occurring. alarmtimestamp : datetime
This is the time when the alarm was generated. It is set by the device. alarmtimestampdstoffset : integer
The daylight savings offset for the alarmtimestamp value. Specified in minutes. alarmtimestampstatus : bool
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 371
OpenEnterprise Schema
This is the questionable status of the timestamp provided in the attribute alarmtimestamp. True indicates the time could be wrong. alarmtype : integer
The alarm type describes if the alarm is HIHI, HI, LO, LOLO and
NORMAL.
The enumerated values for these alarm types are:-
LO = 0
HI = 1
LOLO = 2
HIHI = 3
NORMAL = 8 alarmvalue : float
This is the alarm value set by the device. If the device is not reporting by exception (RBE) then this value may be used to update the signal value. alarmversion : integer
The ACCOL load version of the RTU associated with the remote alarm report. archivetimestamp : datetime
Archive Timestamp, set when importing Archive data collected by
OpenBSI. The OpenBSI converter DLL (OEBFILL) updates the archiveTimestamp attribute with data sourced from the Archive module.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 372
OpenEnterprise Schema
Used when NW3000 Archiving is enabled. archivevalue : float
Archive Value, set when importing Archive data collected by OpenBSI.
The OpenBSI converter DLL (OEBFILL) updates the archiveValue attribute with data sourced from the Archive module. Used when
NW3000 Archiving is enabled. hiaudiblesound:Char
The name of a .WAV file that will be used when a Hi alarm appears in the Alarm Client for the signal. hiaudiblesoundrepeats:Integer
The number of times that the Hi alarm audible sound will occur. highacknowledged : bool
The unacknowledged state of the analog high alarm. Corresponds to the
HiAck Hi Alarm Ack Status value of the OpenBSI OPC Server.
On (TRUE) unacknowledged.
Off (FALSE) acknowledged.
This property cannot be used to manually acknowledge just the high alarm. Read only.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 373
OpenEnterprise Schema highhighacknowledged : bool
The unacknowledged state of the analog high high alarm. Corresponds to the HHAck HiHi Alarm Ack Status value of the OpenBSI OPC Server.
On (TRUE) unacknowledged.
Off (FALSE) acknowledged.
This property cannot be used to manually acknowledge just the high high alarm. Read only. hihiaudiblesound:Char
The name of a .WAV file that will be used when a HiHi alarm appears in the Alarm Client for the signal. hihiaudiblesoundrepeats:Integer
The number of times that the HiHi alarm audible sound will occur. inhighalarm : bool
Indicates if the current signal value is in high alarm. Corresponds to the
HiAlm Hi Alarm Status value of the OpenBSI OPC Server.
On (TRUE) in-alarm.
Off (FALSE) not in-alarm.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 374
OpenEnterprise Schema inhighhighalarm : bool
Indicates if the current signal value is in high high alarm. Corresponds to the HHAlm Hi Hi Alarm Status value of the OpenBSI OPC Server.
On (TRUE) in-alarm.
Off (FALSE) not in-alarm. inlowalarm : bool
Indicates if the current signal value is in low alarm. Corresponds to the
LoAlm Lo Alarm Status value of the OpenBSI OPC Server.
On (TRUE) in-alarm.
Off (FALSE) not in-alarm. inlowlowalarm : bool
Indicates if the current signal value is in low low alarm. Corresponds to the LLAlm LoLo Alarm Status value of the OpenBSI OPC Server.
On (TRUE) in-alarm.
Off (FALSE) not in-alarm. loaudiblesound:Char
The name of a .WAV file that will be used when a Lo alarm appears in the Alarm Client for the signal.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 375
OpenEnterprise Schema loaudiblesoundrepeats:Integer
The number of times that the Lo alarm audible sound will occur. logtime : datetime logtrigger : integer
Log Trigger, set when a value is collected from the RTU, whether from real-time collection (Template, RBE, Alarm) or from Archive collection
(OEBFill). The CL increments the logTrigger value of the signal by 1.
This prompts the historian to log the updated value. logvalue : float
Log Time, set to the current time when a value is collected from the
RTU, whether from real-time collection (Template, RBE, Alarm) or from
Archive collection (OEBFill). The value is used to update the timestamp attribute logged by the historian.
Log Value, set when a value is collected from the RTU, whether from real-time collection (Template, RBE, Alarm) or from Archive collection
(OEBFill). The CL copies the updated value to the logValue attribute, which is then logged by the historian. loloaudiblesound:Char
The name of a .WAV file that will be used when a LoLo alarm appears in the Alarm Client for the signal.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 376
OpenEnterprise Schema loloaudiblesoundrepeats:Integer
The number of times that the LoLo alarm audible sound will occur. lowacknowledged : bool
The unacknowledged state of the analog low alarm.
On (TRUE) unacknowledged.
Off (FALSE) acknowledged.
This property cannot be used to manually acknowledge just the low alarm. Corresponds to the LoAck Lo Alarm Ack Status value of the
OpenBSI OPC Server. lowlowacknowledged : bool
The unacknowledged state of the analog low low alarm.
On (TRUE) unacknowledged.
Off (FALSE) acknowledged.
This property cannot be used to manually acknowledge just the low alarm. Corresponds to the LLAck Lo Lo Alarm Ack Status value of the
OpenBSI OPC Server. msd : integer
When the MSD value changes a write to the device is made. MSD is the
Master Signal Directory.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 377
OpenEnterprise Schema rbe : bool
This boolean attribute indicates if the signals value is being updated by exception (report by exception). readalarminhibit : bool
This value indicates the last read value of the alarm inhibit status from the device. readcontrolinhibit : bool
This value indicates the last read value of the control inhibit status from the device. readmanualinhibit : bool
This value indicates the last read value of the manual inhibit status from the device. 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 378
OpenEnterprise Schema remotealarm : bool
This is set to true if the object refers to a remote alarm. rocaudiblesound:Char
The name of a .WAV file that will be used when a Rate of Change alarm appears in the Alarm Client for the signal. rocaudiblesoundrepeats:Integer
The number of times that the Rate of Change alarm audible sound will occur. timeclass : integer
This is the id of a timeclass, defined in the dvi_schedule table. It defines the rate of collection from the RTU. A timeclass may be assigned to all signals in a device by assigning a timeclass id to the device, or to individual signals within the device by assigning the timeclass id to the individual signals within the device. A 0 (zero), or NULL value indicates no timeclass is assigned
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 379
nw3000realanalogalarmcondition
OpenEnterprise Schema
Derived From:
Description: realanalogalarmcondition
This table contains network 3000 specific information for alarm conditions upon real analog signals.
Attributes:
No attributes extend this table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 380
nw3000rollingscantimer
OpenEnterprise Schema
Derived From:
Description: oetimer
This table is used to manage the maxinterval setting for rolling scan polling functionality.
Attributes: deviceref : char references nw3000device
A reference to the nw3000device table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 381
nw3000string
Derived From:
Description:
OpenEnterprise Schema realanalog
This table contains additional information specific to a network 3000 string signal.
Attributes: length:Char
The length of the string. msd:Integer rbe:Bool
MSD stands for Master Signal Directory. It represents the address of the signal in the controller's memory. It is used when creating polling templates. When the MSD value changes a write to the device is made.
This boolean attribute indicates if the signals value is being updated by exception (report by exception).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 382
OpenEnterprise Schema readalarminhibit:Bool
This value indicates the last read value of the alarm inhibit status of the signal from the device. readcontrolinhibit:Bool
This value indicates the last read value of the control inhibit status of the signal from the device. readmanualinhibit:Bool
This value indicates the last read value of the manual inhibit status of the signal from the device. readquestionable:Bool
This value indicates the last read value of the questionable status of the signal from the device. remotealarm:Bool
This is set to true if the object refers to a remote alarm. timeclass:Integer
This is the id of a timeclass, defined in the dvi_schedule table. It defines the rate of collection from the RTU. A timeclass may be assigned to all signals in a device by assigning a timeclass id to the device, or to individual signals within the device by assigning the timeclass id to the individual signals within the device. A 0 (zero), or NULL value indicates no timeclass is assigned
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 383
nw3000stringpolllist
OpenEnterprise Schema
Derived From:
Description:
Attributes:
No attributes extend this table.
nw3000polllist
Network 3000 specific string poll list datum.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 384
objectnotes
Derived From:
Description:
OpenEnterprise Schema notes
This table will create a note that will be associated with any object derived from the objects table.
Attributes: objectref : char
This is a foreign key reference to an objects object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 385
objects
OpenEnterprise Schema
Derived From: <Base Table>
Description: This table is the base Object table, from which all database objects other than signals should be derived. It contains attributes common to the functionality of all objects within the Open Enterprise system.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. acknowledged : bool default TRUE
If this value is FALSE, the object is in a state of not being acknowledged. addtodataset : char
Reserved for internal use. alarmcondition : alarmcondition
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 386
OpenEnterprise Schema
This is an array of alarmcondition objects that are applied to this object. 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. 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. 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 default TRUE
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 387
OpenEnterprise Schema
If this value is FALSE, the object has not been cleared from the alarmsummary table. currentalarmprecedence : integer default -1
This attribute takes the highest precedence from the current set of alarms associated with this object. If no alarms are active, the attribute is set to 1. currentdstoffset : 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. currentlocker : char
Override user name that allows a locked object to be unlocked. dataset : char
This is a misnamed attribute that, in fact, contains a list of id values from the logcontrol table. The list is, actually, a set of streams. These are required in order to implement stream management. The list of streams controls which historical streams this object is enabled with. Those streams not listed in the string will have this signal object disabled.
When this attribute is set, the old list of logcontrol references are disabled. These are contained in the lastdataset attribute. Then the new lists references are enabled (stored in dataset). And finally, the dataset attribute is copied to the lastdataset attribute. description : char
The description field should be used to meaningfully describe the purpose of this object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 388
OpenEnterprise Schema display : char
This is the name of a display that is associated with this object in the objects table. dstoffset : integer
This is the daylight saving time offset, in minutes, applicable to the timestamp attribute value. hasnotes : bool default FALSE
Determines whether notes are supported by this object. lastdataset : char
This is a misnamed attribute that, in fact, contains a list of id values from the logcontrol table. The list is, actually, a set of historical streams.
These are required in order to implement stream management. The list of streams controls which historical streams this signal is enabled with. locked : bool
When this attribute is set, the old list of logcontrol references are disabled. These are contained in the lastdataset attribute. Then the new list are enabled (stored in dataset). And finally, the dataset attribute is copied to the lastdataset attribute
This attribute will be set to true if any of the configuration tools are currently editing this object. locker : char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 389
OpenEnterprise Schema
The name of the user who is currently editing this object. name : char
The name of the object. The name attribute is the primary key of the table. occurrencetime : datetime
This is the date and time at which an alarm was generated upon this object. occurrencetimedstoffset : 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. plantarea: char
This attribute will usually be used to describe the physical location of whatever the derived class references. printer : char
This is the name of the printer to which the alarms associated with this object will be printed to. questionable : integer
Details if the data associated with the object is questionable.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 390
OpenEnterprise Schema 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. suppress : bool
When set to TRUE all alarm conditions associated with the object are suppressed. suppressed : bool Default FALSE
An indication that one or more of the object's alarm conditions is currently suppressed. Read only. suppressiongroup : integer
This is an integer reference to the suppression group table. totalnotes : integer default 0
If the object supports notes this will describe the number of notes associated with the object. workstation : char
The workstation from which the last database update on this object was performed.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 391
objectsextension
OpenEnterprise Schema
Derived From:
Description:
Attributes:
No attributes extend this table.
objects
This is a special database table that has been introduced in order to allow the objects table to be expanded upon on a per system basis.
Before the initial step on including the alltables.sql file during the database build process, you may modify the objectsextension.sql file and append any extra attributes that you believe are necessary for your system.
Remember, once you include the alltables.sql file, the database structure has been created and should not be modified.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 392
objectsuppressiongroup
OpenEnterprise Schema
Derived From: suppressiongroup
Description: This table defines an object that will be used as an anchor to trigger the suppression of all the conditions in the list of alarmconditions in suppressiongroup.
Attributes: name : char references objects
A foreign key reference to the Master Object for the Suppression Group.
References the objects table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 393
oelogaccess
Derived From:
Description:
OpenEnterprise Schema logaccess
The OpenEnterprise extended version of the standard logaccess table.
Currently this table enjoys limited use.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 394
oelogarchive
OpenEnterprise Schema
Derived From: logarchive
Description: The OpenEnterprise extended version of the standard historian logarchive table that is used to bring archive files on line for access by historical clients.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. currentusecount : integer
This is a reference count that is used to determine when an archive file should be taken off-line. filenameonly : char
The name of the archive file to which the table entry relates, minus the directory path. Used in conjunction with the functionality available from the archive catalogue tables, See archivecatalogue.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 395
oelogcolumn
OpenEnterprise Schema
Derived From:
Description: logcolumn
The OpenEnterprise extended version of the standard historian logcolumn table, which is used to define the columns, to be logged by a historical group.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. description : char
An optional description of this object. indexdatatype : integer
Indexes can be created on archive files for logged column types of datetime, real and integer. Only columns from raw datasets may be used at the moment. Possible values for this attribute are:
0 = DateTime Index DataType
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 396
1 = Integer Index DataType
OpenEnterprise Schema
2 = Real Index DataType
-1 = Invalid Index DataType (eg No Index)
For indexing to occur on archive files created for this logged column and dataset the following attributes all need to be set: -
The indexmethod attribute should be set to 1 in the logcolumn table for the logged column. The CL should make a valid entry into the
IndexDataType attribute for the same column/dataset in the oelogcolumn table. The ArchiveCatalogue attribute in the (oe)logdata table for the datastream must be set to TRUE.
When a raw log file marked as above for indexing is archived, the archive is indexed on the columns specified. Maximum and minimum values for the indexes created are stored in the relevant archiveindex table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 397
oelogcontrol
OpenEnterprise Schema
Derived From:
Description: logcontrol
This is the extended OpenEnterprise version of the standard historical logcontrol table.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. numobjects : integer
The user estimated number of objects to be logged in a configured historical stream. The number is set in the 'Estimated number of objects to log' field on the initial 'Logging Group' page of the Historical
Configuration Editor wizard.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 398
oelogdata
OpenEnterprise Schema
Derived From: logdata
Description: The oelogdata table contains entries for a set of logged values from a single stream at a specified rate. There may be many oelogdata instances to a stream. An entry in the oelogdata table is known as a dataset.
The extra columns within oelogdata allow the automatic extraction of historical files to disk (i.e. creating archive file) and the retrieval of archive files from disk on database start-up and immediately after archiving.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. archivecatalogue : bool
If set to TRUE, then any archive file created for the data set will result in archive catalogue and indexing information being obtained from the archive file. See the archivecatalogue table for more details. archivefilecount : integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 399
OpenEnterprise Schema
This attribute keeps a rolling count of the number of archive file created for the historical archive files. archivefilenamesarray : archivefile
This is an array of archivefile objects. They contain the archive files that are kept on-line for historical access. archivenumber : integer
This value is the maximum number of archive files that may be brought on-line, for a single data set, in order to carry out historical data retrieval. archivenumberonline : integer
This is the current number of archive files that are on-line for this data set. archiveonline : bool
If this attribute is set to FALSE, no extra buffers of information, in the form of on-line archive files, will be maintained. archivepercent : integer
This attribute describes when the dataset should automatically create an archive file for the data in the historical file. autoarchive : bool
This attribute, if set to TRUE, will bring archive file automatically on-line, when the database starts up.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 400
OpenEnterprise Schema columnindexes : array of OELogColumn
This array contains all the OELogColumn entries that make up this Data
Set. description : char
An optional description containing information about this dataset. doarchive : bool
Setting this attribute to TRUE will result in the attempted creation of an archive file for the data set. oldesttime : datetime
This is the time when logging of historic data began for the next archive file. timedarchives : array of TimedArchive
This is an array of all the timed archiving objects that have been created against this log data instance. viewname : char
The name of the database view that should be used to access data for this dataset.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 401
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 402
oelogdataextension
OpenEnterprise Schema
Derived From: <Base_Table>
Description: The oelogdataextension table contains extensions to the oelogdata table.
This table is required to overcome upgrade issues between the schema used in different versions of the software.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. archofflinedirectory : char
The directory where offline archive files will be stored. A NULL values indicates that offline archive files will be kept in the archive directory indicated by the oelogdata archdirectory attribute. control : integer logcontrol that this object relates to. Together with the rate attribute this attribute forms the primary key for this table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 403 description : char
Description of this entry.
OpenEnterprise Schema maxarchivefiles : integer
The maximum number of manual archive files allowed online at any given time. A value of NULL indicates that there is no limit on the number of archive files that can be brought online manually for this stream. rate : char
Rate of logging, used in conjunction with the control attribute this attribute identifies the entry in the logdata table that this object is extending. Together with the control attribute this attribute forms the primary key for this table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 404
oelogextract
Derived From:
Description:
OpenEnterprise Schema logextract
An extended OpenEnterprise version of the standard historian logextract table, used to create extract files from historical data sets.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 405
oelogworker
Derived From:
Description:
OpenEnterprise Schema logworker
An extended OpenEnterprise version of the standard historian logworker table. This table is currently unused.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 406
oeprinter
OpenEnterprise Schema
Derived From:
Description: objectsextension
This table maintains a list of the printers on the system and various pieces of information about their configuration, location and status.
Attributes: alarmpriority : integer references AlarmPriorityBlock
This is a reference to an AlarmPriorityBlock object. Exactly how to output the alarms is determined by this reference. comment : char
Comment as obtained from the General property page of the printer in the Windows NT Printers folder. This is often used to describe who is responsible for the printer which department it is in and who should be contacted if maintenance is required. currentstatus : char
Textual description of the printer status.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 407 driver : char
OpenEnterprise Schema
The name of the driver as obtained described in the General property page of the printer in the Windows NT Printers folder. getstatus : bool default FALSE
Setting this to TRUE will force the OE Printer Spooler component to read the current status of the printer. This may be manually triggered or triggered by a scheduled task. id : integer
This unique value is the primary key of this table. Its value is generated by CL. See Appendix A for more details. lastmodified : datetime
This is the date and time that either an error occurred, the status attribute changed, the port name changed or the name of the printer changed. location : char
This is the location as read from the General property page of the printer in the Windows NT Printers folder. logerror : bool default FALSE
If set to TRUE all errors concerning this printer will be logged. networkname : char
This is the name of the network that the printer is on as well as the name
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 408
OpenEnterprise Schema of the machine that the printer is attached to. port : char reference : integer
This is a reference count to the number of database objects that have a reference to this object. server : char
This the name of the server that the printer is linked to. status : integer timeout : integer username : char
This is the current status of the printer.
This is the number of seconds that the client application will wait until it declares the printer off-line.
This is the username that last modified the table.
This is the server port to which the printer is attached.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 409
oeprinteralarmcondition
OpenEnterprise Schema
Derived From:
Description: alarmcondition
The OEPrinterAlarmCondition is used to monitor for changes in the status attribute of the OEPrinter object.
Attributes: alarmstate : bool default FALSE
A value of TRUE indicates that this alarm condition is in alarm. A value of FALSE indicates that it is out of alarm. name : char references OEPrinter
This is a reference back to the OEPrinter object, allowing communication between the two objects for the creation, deletion and updating of alarms.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 410
oeprintergroup
OpenEnterprise Schema
Derived From:
Description: objectsextension
Printers can be grouped together in order to further define the relationship of printers to each other. Within a group of printers there may be a primary printer. In order to define that primary printer a relationship is generated between the group and the printer.
Attributes: alarmpriority : integer references AlarmPriorityBlock
This is a reference to an AlarmPriorityBlock object. Exactly how to output the alarms is determined by this reference. comment : char
Comment as obtained from the General property page of the printer in the Windows NT Printers folder. This is often used to describe who is responsible for the printer which department it is in and who should be contacted if maintenance is required. currentstatus : char
Textual description of the printer status.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 411
OpenEnterprise Schema driver : char
The name of the driver as obtained described in the General property page of the printer in the Windows NT Printers folder. id : integer
This unique value is the primary key of this table. Its value is generated by CL. See Appendix A for more details. lastmodified : datetime
This is the date and time that either an error occurred, the status attribute changed, the port name changed or the name of the printer changed. logerror : bool default FALSE
If set to TRUE all errors concerning this printer will be logged. reference : integer
This is a reference count to the number of database objects that have a reference to this object. server : char
This the name of the server that the printer is linked to.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 412 status : integer
OpenEnterprise Schema
This is the current status of the printer. systemprinter : char
This is the name of the default printer in the group. systemprinterid : integer
This is the ID of the default printer in the group. This ID should appear within the OEPrinter table. username : char
This is the username that last modified the table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 413
oeprintergroupalarmcondition
OpenEnterprise Schema
Derived From:
Description: alarmcondition
The OEPrinterGroupAlarmCondition is used to monitor for changes in the status attribute of the OEPrinterGroup object.
Attributes: alarmstate : bool default FALSE
A value of TRUE indicates that this alarm condition is in alarm. A value of FALSE indicates that it is out of alarm. name : char references OEPrinterGroup
This is a reference to the OEPrinterGroup object that has the condition placed against it. The reference is used to update the printer group object when alarm states change.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 414
oeprinterrelationship
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table has been designed to cater for two special types of relationships between printers.
The first type of relationship is between a group of printers and a single printer. This single printer is known as the Primary Printer of the group.
The second type of relationship is between a Parent Printer and its
Fallback Printer.
The printergroup attribute determines which one of these types of relationships is in use.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. id : integer
This unique value is the primary key of this table. Its value is generated
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 415
OpenEnterprise Schema by CL. See Appendix A for more details. parentid : integer
This is the ID of either a printer group or an individual printer (depending upon the value of the printergroup attribute) printergroup : bool
A value of TRUE indicates that the parent ID is a printer group object. A value of FALSE indicates that the parent ID is a printer object. printerid : integer
This is the ID of the second printer that this relationship is based upon.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 416
oeprinterrelationship
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table has been designed to cater for two special types of relationships between printers.
The first type of relationship is between a group of printers and a single printer. This single printer is known as the Primary Printer of the group.
The second type of relationship is between a Parent Printer and its
Fallback Printer.
The printergroup attribute determines which one of these types of relationships is in use.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. id : integer
This unique value is the primary key of this table. Its value is generated
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 417
OpenEnterprise Schema by CL. See Appendix A for more details. parentid : integer
This is the ID of either a printer group or an individual printer (depending upon the value of the printergroup attribute) printergroup : bool
A value of TRUE indicates that the parent ID is a printer group object. A value of FALSE indicates that the parent ID is a printer object. printerid : integer
This is the ID of the second printer that this relationship is based upon.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 418
oetimer
OpenEnterprise Schema
Derived From: timer
Description: This is derived from the timer base table to automatically allocate a primary key to any OpenEnterprise timer.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. next_id : integer quantity : integer
This attribute is used in the automatic generation of the primary key value for a timer object.
This attribute is used in the automatic generation of the primary key value for a timer object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 419
opcdevice
OpenEnterprise Schema
Derived From:
Description:
A logical device used to group signals. The logical device will normally be mapped to a physical device. dvi_device
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. alarmpurge : bool
When set to true all alarms for this device will be deleted. substatus : integer
Further status information for the device. The value in substatus will only be initialised if the status value is negative, and not all status values have substatus information.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 420
opcdriver
OpenEnterprise Schema
Derived From:
Description:
Details of an OPC Client RDI. This table defines the TCP/IP socket used to communicate with the OPC Client RDI and settings relating to that instance of the Client RDI. dvi_remote_driver
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. converttimestamps : bool
Indicates to the OPC Client RDI instance whether it should convert timestamps sourced from the OPC Server into UTC based on the timezoneoffset and currentdstoffset attributes of this table. description : char
A user provided description of this object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 421
OpenEnterprise Schema substatus : integer
Further status information for the device. The value in substatus will only be initialised if the status value is negative, and not all status values have substatus information.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 422
opcgroup
OpenEnterprise Schema
Derived From:
Description:
This table defines groups of OPC items OPC items in the same group will be treated in the same way with the same updates, deadbands, etc. dvi_datum
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. active : bool default TRUE
Indicates if this OPC Group is active or not. initialrefresh : bool default FALSE
This attribute is not currently used. locale : integer default 2048
Idnicates the locale in which data for this group will be returned. The default value indicates that data should be returned using the default
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 423 system locale.
OpenEnterprise Schema percentdeadband : real default 0
Specifies the percentage change in value within the update period wich is required for a data value change to be reported to the OPC Client
RDI. Only applicable to real analog items within the group. polltype : integer8 default 0
Indicates whether the source of item values when performing a force poll. Permitted values are:
0 = FORCEPOLL_CACHE, data is collected from the cache.
1 = FORCEPOLL_DEVICE, data is collected from the device. requestedupdaterate : integer not null
The period, in milliseconds, at which the OPC Client RDI requires any changes in data or quality for OPC items within the group to be reported. revisedupdaterate : integer
The period, in milliseconds, at which the OPC Server is able to supply changes in data or quality for the OPC items within the group. substatus : integer default 0
Further status information for the device. The value in substatus will only be initialised if the status value is negative, and not all status values have substatus information.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 424
OpenEnterprise Schema timebias : integer default 0
Indicates a difference in timezone between the physical devices and the
OPC Server and OPC Client. This delta is provided in minutes.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 425
opcitemdigital
OpenEnterprise Schema
Derived From:
Description:
Defines the properties and value of digital OPC signals. digital
Attributes: active : bool default TRUE
Controls whether the item is enabled or disable. opcaccesspath : char
An optional attributes, which is used to specify to the OPC Server a preferred access path by which the value for the OPC Item should be obtained. opcaccessrights : integer8
The access rights applicable to this item, as returned by the OPC
Server. Values can be:
1 = Read access only.
2 = Write access only.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 426
OpenEnterprise Schema
3 = Both read and write access. opccanonicaldatatype : integer8
The data format in which the OPC Server will return the data to the OPC
Client. This is not necessarily the same as the data format specified by the opcrequesteddatatype attribute. opcgroup : char not null references opcgroup
A reference to the OPC Group to which this OPC Item belongs. opcquality : integer transient
The OPC Quality associated with the value valud of this OPC item. opcrequesteddatatype : integer8 not null
The data format which the OPC Client RDI requests the value from the
OPC Server. The opccanonicaldatatype attribute indicates the data format actually returned by the OPC Server. polltype : integer8 default 0
Indicates whether the source of item values when performing a force poll. Permitted values are:
0 = FORCEPOLL_CACHE, data is collected from the cache.
1 = FORCEPOLL_DEVICE, data is collected from the device. substatus : integer
Further status information for the device. The value in substatus will only be initialised if the status value is negative, and not all status values have substatus information.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 427
OpenEnterprise Schema
opcitemintegeranalog
Derived From:
Description:
Defines the properties and value of integer OPC signals. integeranalog
Attributes: active : bool default TRUE
Controls whether the item is enabled or disable. opcaccesspath : char
An optional attributes, which is used to specify to the OPC Server a preferred access path by which the value for the OPC Item should be obtained. opcaccessrights : integer8
The access rights applicable to this item, as returned by the OPC
Server. Values can be:
1 = Read access only.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 428
2 = Write access only.
OpenEnterprise Schema
3 = Both read and write access. opccanonicaldatatype : integer8
The data format in which the OPC Server will return the data to the OPC
Client. This is not necessarily the same as the data format specified by the opcrequesteddatatype attribute. opcgroup : char not null references opcgroup
A reference to the OPC Group to which this OPC Item belongs. opcquality : integer transient
The OPC Quality associated with the value valud of this OPC item. opcrequesteddatatype : integer8 not null
The data format which the OPC Client RDI requests the value from the
OPC Server. The opccanonicaldatatype attribute indicates the data format actually returned by the OPC Server. polltype : integer8 default 0
Indicates whether the source of item values when performing a force poll. Permitted values are:
0 = FORCEPOLL_CACHE, data is collected from the cache.
1 = FORCEPOLL_DEVICE, data is collected from the device.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 429
OpenEnterprise Schema substatus : integer
Further status information for the device. The value in substatus will only be initialised if the status value is negative, and not all status values have substatus information.
opcitemrealanalog
Derived From:
Description:
Defines the properties and value of real OPC signals. realanalog
Attributes: active : bool default TRUE
Controls whether the item is enabled or disable. opcaccesspath : char
An optional attributes, which is used to specify to the OPC Server a preferred access path by which the value for the OPC Item should be obtained. opcaccessrights : integer8
The access rights applicable to this item, as returned by the OPC
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 430
Server. Values can be:
OpenEnterprise Schema
1 = Read access only.
2 = Write access only.
3 = Both read and write access. opccanonicaldatatype : integer8
The data format in which the OPC Server will return the data to the OPC
Client. This is not necessarily the same as the data format specified by the opcrequesteddatatype attribute. opcgroup : char not null references opcgroup
A reference to the OPC Group to which this OPC Item belongs. opcquality : integer transient
The OPC Quality associated with the value valud of this OPC item. opcrequesteddatatype : integer8 not null
The data format which the OPC Client RDI requests the value from the
OPC Server. The opccanonicaldatatype attribute indicates the data format actually returned by the OPC Server. polltype : integer8 default 0
Indicates whether the source of item values when performing a force poll. Permitted values are:
0 = FORCEPOLL_CACHE, data is collected from the cache. substatus : integer
1 = FORCEPOLL_DEVICE, data is collected from the device.
Further status information for the device. The value in substatus will only be initialised if the status value is negative, and not all status values have substatus information.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 431
opcitemstring
OpenEnterprise Schema
Derived From:
Description:
Defines the properties and value of string OPC signals. stringsignal
Attributes: active : bool default TRUE
Controls whether the item is enabled or disable. opcaccesspath : char
An optional attributes, which is used to specify to the OPC Server a preferred access path by which the value for the OPC Item should be obtained. opcaccessrights : integer8
The access rights applicable to this item, as returned by the OPC
Server. Values can be:
1 = Read access only.
2 = Write access only.
3 = Both read and write access.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 432
OpenEnterprise Schema opccanonicaldatatype : integer8
The data format in which the OPC Server will return the data to the OPC
Client. This is not necessarily the same as the data format specified by the opcrequesteddatatype attribute. opcgroup : char not null references opcgroup
A reference to the OPC Group to which this OPC Item belongs. opcquality : integer transient
The OPC Quality associated with the value valud of this OPC item. opcrequesteddatatype : integer8 not null
The data format which the OPC Client RDI requests the value from the
OPC Server. The opccanonicaldatatype attribute indicates the data format actually returned by the OPC Server. polltype : integer8 default 0
Indicates whether the source of item values when performing a force poll. Permitted values are:
0 = FORCEPOLL_CACHE, data is collected from the cache. substatus : integer
1 = FORCEPOLL_DEVICE, data is collected from the device.
Further status information for the device. The value in substatus will only be initialised if the status value is negative, and not all status values have substatus information.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 433
opcserver
OpenEnterprise Schema
Derived From:
Description:
Defines which OPC Servers a particular instance of the OPC Client will communicate with. This table also defines parameters that control the communication between the OPC Client and the OPC Server. dvi_network
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 user specified description of this object. dorestart : bool default FALSE
Indicates if the OPC Client RDI should attempt to restart or reconnect to the OPC Server following a program or network failure. dostatuscheck : bool default TRUE
Used to enable/disable the status check functionality.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 434
OpenEnterprise Schema locale : integer default 2048
The locale with which we wish the OPC Server to return data. The default value indicates that the system default locale should be used. opcserver : char not null
The PROG ID of the OPC Server which the OPC Client RDI is to communicate with. opcversion : integer8 default 1
Identifies the Data Access standard to be used when communicating with the OPC Server. Permitted values are:
0 = OPC_DATA_ACCESS_10A
1 = OPC_DATA_ACCESS_204 restartperiod : integer default 30000
The restart period, in milliseconds, that indicates how often the OPC
Client RDI will attempt to reconnect or restart the OPC Server following a failure. statuscheck : integer default 30000
Specifies how frequently, in milliseconds, the OPC Client RDI checks that the OPC Server is still alive. This heartbeat is used to determine if a restart of the OPC Server is required. statuschecktimeout : integer default 10000
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 435
OpenEnterprise Schema
Specifies how long the OPC Client RDI waits for a response from the
OPC Server to a status check heartbeat before assuming that the OPC
Server is no longer available. substatus : integer default 0
Further status information for the device. The value in substatus will only be initialised if the status value is negative, and not all status values have substatus information.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 436
Pattern
Derived From:
Description:
OpenEnterprise Schema objects
This table contains Alarm Pattern objects, which the Paging Server uses as a template for Alarm messaging.
Attributes: disable : bool
When set to true, the Pattern is disabled. patterngroupref : char not null references patterngroup
A reference to the Pattern Group to which the Pattern belongs.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 437
patterngroup
Derived From:
Description:
OpenEnterprise Schema objects
This table contains Patterns which enable the Pager to determine if a message should be sent out as a result of a specific alarm.
Attributes: disable : bool
When set to true, the Pattern Group is disabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 438
plantarea
OpenEnterprise Schema
Derived From:
Description: objects
This table is used to store alarm statistics on a plant area basis.
Attributes: totalacknowledged : integer
This is the total number of active alarms that have been acknowledged within this plant area. totalalarms : integer
This is the total number of active alarms within this plant area. totalcleared : integer
This is the total number of active alarms that have been cleared but have not been acknowledged within this plant area. totalunacknowledged : integer
This is the total number of unacknowledged alarms that are currently active within this plant area.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 439
publishedreport
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The PublishedReport table provides a configuration archive of all reports published for an OpenEnterprise system.
Attributes: accessarea:Char
The standard access area attribute definition, used to provide object based security in OpenEnterprise. aliases:Char hidden
A CSV list of the alias values that were defined for the associated
Report Template when the report was generated. aliasvalues:Char hidden
A CSV list of the Alias Values used to resolve the aliases defined for the associated Report Template when the report was generated. basedate:DateTime
If non-null then this defines the value of the BASEDATE Report alias
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 440
OpenEnterprise Schema value, in UTC, for the published Report. basetime:DateTime
If non-null then this defines the value of the BASETIME Report alias value, in UTC, for the published Report. creationdate:Datetime not null
The date and time at which the published report was created. dataservice:Char
The dataservice used by the published Report. If the dataservice is the default local database (rtrdb1), then this value is left blank. directory:Char
The directory in which the published report can be found. enddtime:DateTime
The latest end time of all Queries configured in the Report in UTC. filename:Char not null
The filename of the published report. format:Integer8 not null
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 441
OpenEnterprise Schema
The format of the published report. See the reportformat table for more information on Format types. formatname:Char
The name of the Report Format. id:Integer Primary Key
An automatically generated integer primary key value for this record. nextid:Integer shared hidden
Used in the generation of the primary key value. quantity:Integer shared hidden
Used in the generation of the primary key value. reportname:Char
The name of the parent Report table entry used to generate the report. schedulename:Char
The name of the Report Schedule used to generate the published report. starttime:DateTime
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 442
OpenEnterprise Schema
The earliest start time of all Queries configured in the Report in UTC. status:Integer
Used to indicate the current availability of the published report. 0 indicates that the report is available; 1 indicates that is has been purged and is therefore not available. Note, further values may be added as the implementation of OpenEnterprise Reporting proceeds. templateversion:Char
The version number of the associated ReportTemplate used to generate the report, if any.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 443
publishedreporttoaliaslookup
OpenEnterprise Schema
Derived From:
Description:
The PublishedReportToAliasLookup table stores all alias names and values apart from the default ones (BASEDATE, BASETIME,
DATASERVICE) that are applicable to a published Report.
PublishedReport, AliasName
Attributes: aliasname: Char Not Null
The name of the Report alias. aliasvalue: Char
The value defined for the alias name, if any. Note if this value is null then the alias value within the associated published report is undefined publishedreport: Integer references PublishedReport Not Null
A foreign key reference to the PublishedReport table entry to which the alias name and value apply.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 444
OpenEnterprise Schema
questionablealarmcondition
Derived From: alarmcondition
Description: This is the parent table, from which specific questionable alarm conditions will be derived, and which will encapsulate the common functionality applicable to all such questionable alarm conditions.
Attributes: name : char references signal
A reference to the parent signal to which the questionable alarm condition applies
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 445
questionableequalsalarmcondition
OpenEnterprise Schema
Derived From:
Description: questionablealarmcondition
This table allows the user to define a specific questionable attribute value for which an alarm will be generated.
Attributes: value : integer not NULL
The value of the questionable attribute for which an alarm will be generated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 446
questionablerangealarmcondition
OpenEnterprise Schema
Derived From: questionablealarmcondition
Description: This table provides the user with the ability to define a range of
Questionable values for which an alarm will be generated.
Attributes: lowerrange: integer not NULL
The Lower limit of the questionable value range for which an alarm will be generated. upperrange : integer not NULL
The upper limit of the questionable value range for which an alarm will be generated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 447
realanalog
OpenEnterprise Schema
Derived From:
Description: signalextension
This table is for storing real analog signals. Device specific information will be in a separate table and should be derived from this table.
Attributes: defaultvalue : float
This value will be used at database start-up to set the associated signals value and readvalue. No default value. highlimit : float
This is a limit imposed upon the object that prevents a client from increasing the value of the signal above a certain level. If this attribute is
NULL, no limit is imposed. This attribute must be greater than the lowlimit attribute or the transaction to change it will fail. lastoverridevalue : float
The last override value set by the user (or the value existing when an override was enabled). Used to restore the override value following a database restart.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 448
OpenEnterprise Schema lastreadvalue : float
The last value read from the RTU. This will be updated using the readvalue attribute whilst an override is enabled. This value will be copied into value and readvalue when an override is cancelled. lowlimit : float readvalue : float units : char value : float
This is a limit imposed upon the object that prevents a client from reducing the value of the signal below a certain level. If this attribute is
NULL, no limit is imposed. This attribute must be less than the highlimit attribute or the transaction to change it will fail.
The readvalue attribute of the table specifies the last received value from the device for this signal. This is not modified by client connections.
It is updated by making request to the device for signal values or through reporting values by exception (RBE).
This specifies the units of the signal.
This attribute is linked to and updated by the clients. Changing this value may alter the actual value of the signal. Whether it is changed or not is determined by the handler of the device-specific table, derived from this table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 449
realanalogalarmcondition
Derived From:
Description:
OpenEnterprise Schema alarmcondition
This is the base RealAnalogAlarmCondition table from which all real analog signal generated alarm condition objects are derived.
Attributes: alarmstate : bool name : char
When this value is set to TRUE, the condition object has created an alarm. If it is set to FALSE, no alarm currently exists.
This is a foreign key reference to an object in the realanalog table. This signals value is referenced and compared against within the derived tables from realanalogalarmcondition.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 450
OpenEnterprise Schema
realanalogchangetonullalarmcondition
Derived From:
Description:
Attributes:
No attributes extend this table.
realanalogalarmcondition
This table defines the RealAnalogChangeToNullAlarmCondition table that is used to perform internal alarm generation for real analog signals. This table will support change to NULL alarm conditions.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 451
OpenEnterprise Schema
realanalogchangevaluealarmcondition
Derived From:
Description:
Attributes:
No attributes extend this table.
realanalogalarmcondition
This table defines the RealAnalogChangeValueAlarmCondition table that is used to perform internal alarm generation for real signals. This table will support change of value alarms.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 452
realanalogdeviationalarmcondition
OpenEnterprise Schema
Derived From:
Description: realanalogalarmcondition
This table defines the RealAnalogDeviationAlarmCondition table that is used to perform percentage deviation alarm generation for RealAnalog signals.
Attributes: lastvalue : float
This is the value at which the signal was last read at. It is used to compare against the new value being read in to determine if the change warrants an alarm generation. percentdeviation : float
This is the percentage of deviation allowed between value changes.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 453
realanalogequalsalarmcondition
Derived From:
Description:
OpenEnterprise Schema realanalogalarmcondition
This table defines the RealAnalogEqualsAlarmCondition table that is used to perform internal alarm generation for real signals. This table will support value equals alarm conditions.
Attributes: limit : float
This is the value at which a signal must reach in order for an alarm to be generated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 454
realanaloglimitalarmcondition
OpenEnterprise Schema
Derived From:
Description: realanalogalarmcondition
This table defines the RealAnalogLimitAlarmCondition table that is used to perform internal alarm generation for real signals. This will support HIHIHI,
HIHI, HI, LO, LOLO, LOLOLO, and change to NULL alarm processing.
Attributes: deadbandinto : float
The deadbandinto attribute will determine the number by which the value of the analog must cross over the limit before an alarm may be triggered. deadbandoutof : float
The deadbandoutof attribute will determine the number by which the value of the analog must recover over the limit set before an alarm may be declared no longer in alarm. limit : float
This is the value that is used, along with the deadbands, to determine if the alarm condition has been violated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 455
OpenEnterprise Schema
realanalograteofchangealarmcondition
Derived From:
Description: realanalogalarmcondition
This table defines the RealAnalogRateOfChangeAlarmCondition table that is used to perform simple rate of change alarm generation for RealAnalog signals.
Attributes: changepersecond : float
This is the allowed change of value per second that will not cause an alarm to be generated. lastchange : datetime
This is the time when the value was last changed. lastchangedstoffset : 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. lastvalue : float
This is the value that the real analog signal was at when it last changed.
It is used, in conjunction with the lastchange attribute, to calculate if the rate of change is too fast.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 456
realanalogsignalalarmcondition
OpenEnterprise Schema
Derived From:
Description: realanalogalarmcondition
This table defines the RealAnalogSignalAlarmCondition table that is used to perform internal alarm generation for real signals. This will support
HIHIHI, HIHI, HI, LO, LOLO, LOLOLO, and change to NULL alarm processing in the same manner as the RealAnalogAlarmCondition, except that the alarm condition limit value is sourced from a RealAnalog signal read value.
Attributes: alarmname : char
This is a foreign key reference to the realanalog signal that will be used to determine the limit that the condition must be compared against. deadbandinto : float
The deadbandinto attribute will determine the number by which the value of the analog must cross over the limit before an alarm may be triggered. deadbandoutof : float
The deadbandoutof attribute will determine the number by which the value of the integer must recover over the limit set before an alarm may be declared no longer in alarm.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 457
realanalogsignaltrigger
Derived From:
Description:
OpenEnterprise Schema signalattributetrigger
This table is similar to the other trigger tables in the database, except this one specifically links to the RealAnalog table. Changes to this value will activate the trigger. Consequently, the trigger will start a calculation.
Attributes: readvalue : real
This attribute is an active link back to the RealAnalog table. When the value in the RealAnalog table changes, this value changes as well. This change is detected by the underlying CL and the trigger is activated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 458
realarchiveindex
OpenEnterprise Schema
Derived From:
Description: archiveindex
This table is used to provide the minimum and maximum values of any real indexes defined on an associated archive file.
See also archivecatalogue, datetimearchiveindex and integerarchiveindex
Attributes: maximumvalue : real
The maximum value of the real index defined on the associated archive file. minimumvalue : real
The minimum value of the real index defined on the associated archive file.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 459
recipient
OpenEnterprise Schema
Derived From:
Description: objects
This table will represent each e-mail recipient known throughout the system. A recipient is defined as a particular e-mail address that can be sent messages. A recipient is a separate entity from an Open Enterprise user but there is an optional user field in the table, which references users.
This structure allows several e-mail addresses to be set up for one Open
Enterprise user (e.g. a workplace e-mail address and an out-of-office email address). In conjunction with the disable flag it will be easy to re-direct alarms to a different recipient and therefore a different e-mail address
Attributes: disable : bool
When set to true, the recipient is disabled, and cannot receive emails. email : char not null
The email address of the recipient. patterngroupref : char not null references patterngroup
References a Pattern Group in the Pattern Group table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 460
OpenEnterprise Schema userref : char references users
References a user in the users table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 461
recipientassociations
Derived From:
Description:
OpenEnterprise Schema
This table links Recipient Groups with Recipients.
<Base Table>
Attributes: accessarea:char disabled:bool
The accessarea of this Recipient Association
A value of TRUE disables this Recipient Association. recipientgroup:char
The name of the Recipient Group associated with the Recipient. recipientname:char
The name of the Recipient associated with the Recipient Group.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 462
OpenEnterprise Schema
recipientgroup
Derived From:
Description: objects
Describes Groups of Recipients who will receive messages from the
Paging Server
Attributes: disable : bool
If set to TRUE, disables this recipient group
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 463
recipientusernotes
OpenEnterprise Schema
Derived From:
Description: usernotes
This table shows all of the user notes that are addressed to the currently logged on user. Therefore, this is always a subset of the usernotes table.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. acknowledged : bool default TRUE
If this value is FALSE, the object is in a state of not being acknowledged. addtodataset : char
Reserved for internal use. alarminhibit : bool
Setting this to TRUE will prevent any of the Alarm Conditions associated
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 464
OpenEnterprise Schema with this object from generating an entry in the Alarm Summary table when the condition is met. alarmpriority : integer
This is the alarm priority of an alarmed note. alarmtime : datetime
This is the time at which an alarm will be generated in the
AlarmSummary corresponding to this note. alarmtimedstoffset : 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. 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. 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
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 465 to an alarm.
OpenEnterprise Schema calloutdisplay : char
This is a workstation display that will supply response data for an operator in order to deal with a alarm. cleared : bool default TRUE
If this value is FALSE, the object has not been cleared from the alarmsummary table. createtime : datetime
This is the date and time at which this note was created. createtimedstoffset : 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. currentalarmprecedence : integer default -1
This attribute takes the highest precedence from the current set of alarms associated with this object. If no alarms are active, the attribute is set to 1. currentdstoffset : 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.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 466
OpenEnterprise Schema currentlocker : char
Override user name that allows a locked object to be unlocked. dataset : char
This is a misnamed attribute that, in fact, contains a list of id values from the logcontrol table. The list is, actually, a set of streams. These are required in order to implement stream management. The list of streams controls which historical streams this object is enabled with. Those streams not listed in the string will have this signal object disabled.
When this attribute is set, the old list of logcontrol references are disabled. These are contained in the lastdataset attribute. Then the new lists references are enabled (stored in dataset). And finally, the dataset attribute is copied to the lastdataset attribute. description : char
The description field should be used to meaningfully describe the purpose of this object. display : char
This is the name of a display that is associated with this object in the objects table. dstoffset : integer
This is the daylight saving time offset, in minutes, applicable to the timestamp attribute value.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 467
OpenEnterprise Schema emergencyprocedures : char
This is a description of what procedures should be carried out to resolve a problem on the system. This is associated with alarm notes. expirytime : datetime
This is the time when the note will automatically be removed. This is relevant for the Expiry notes and Alarm notes. expirytimedstoffset : 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. hasnotes : bool default FALSE
Determines whether notes are supported by this object. lastdataset : char
This is a misnamed attribute that, in fact, contains a list of id values from the logcontrol table. The list is, actually, a set of historical streams.
These are required in order to implement stream management. The list of streams controls which historical streams this signal is enabled with.
When this attribute is set, the old list of logcontrol references are disabled. These are contained in the lastdataset attribute. Then the new list are enabled (stored in dataset). And finally, the dataset attribute is copied to the lastdataset attribute lastnotetype : integer8
This is a reserved attribute. Do not use.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 468 locked : bool
OpenEnterprise Schema
This attribute will be set to true if any of the configuration tools are currently editing this object. locker : char message : char name : char nextid : integer notesdiary : char
The name of the user who is currently editing this object.
This is the message that is to be conveyed.
The name of the object. The name attribute is the primary key of the table.
This is an internal value used to automatically generate a primary key value for new notes objects.
For either an Alarmed Note or an Expiry Note, a diary entry is generated in order to deal with the timing of when the alarm should be generated or when the note should be removed (expired). notetype : integer8
The notetype attribute will describe whether the note is a standard note
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 469 an expiry note or an alarm note.
OpenEnterprise Schema occurrencetime : datetime
This is the date and time at which an alarm was generated upon this object. occurrencetimedstoffset : 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. operator : char
The operator who performed the last database transaction on this object. personnel : char plantarea: char printer : char
This is a string describing the people that this message is relevant to.
This attribute will usually be used to describe the physical location of whatever the derived class references.
This is the name of the printer to which the alarms associated with this object will be printed to.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 470
OpenEnterprise Schema questionable : integer
Details if the data associated with the object is questionable. recipient : char
This is the name of the person who will receive this note. 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. sender : char
This is the name of the person who sent this note. subject : char suppress : bool
This is the subject of the note that should briefly summarise the contents of the note.
When set to True, the object’s alarm condition is suppressed. suppressed : bool Default FALSE
An indication that one or more of the object's alarm conditions is
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 471 currently suppressed. Read only.
OpenEnterprise Schema suppressiongroup : integer
This is an integer reference to the suppression group table. timezone : char
The timezone refers to an entry in the timezones table. Using this allows the logging of time values across time zones. tobescheduled : array of ToBeScheduled
This is an array of references to the ToBeScheduled table. They are used in conjunction with the notesdiary attribute.to connect this note object with the scheduling system. totalalarmednotes : integer
This is the total number of notes that are of type alarm. An alarm note will be given a time period, during which it is just a standard note. When this time runs out, it generates an alarm and still remains a note. totalallnotes : integer
This is the total number of notes on the system. totalexpirynotes : integer
This is the number of notes on the system that are of type expiry. These will be removed from the system after a stipulated period of time.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 472
OpenEnterprise Schema totalnotes : integer default 0
If the object supports notes this will describe the number of notes associated with the object. totalstandardnotes : integer
This is the total number of notes on the system that are of type standard.
They have to be manually deleted from the system. triggeralarm : bool
Setting this value to TRUE causes an alarm to be generated for the note, if notetype is of type expiry. triggerexpiry : bool
Setting this value to TRUE causes the timer associated with the note to expire. A subsequent action will depend upon how the alarm is generated. type : integer8 unread : bool
The type is, currently, one of three types. It can be either user notes signal notes or object notes.
If this value is true, then the note has not been read by anybody on the system. The Notes Client application will set this to false when it deems that a user has read a note.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 473
OpenEnterprise Schema userref : char worktype : char
This is a foreign key reference to a users object. worklocation : char
This is a description of the area this note is associated with. workstation : char
The workstation from which the last database update on this object was performed.
This is a description of the type of work being carried out that this note is referring to.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 474
redundancy
OpenEnterprise Schema
Derived From:
Description: objectsextension
The Redundancy table will contain up to date information regarding the state of the redundant system. The table can be used to monitor redundancy, generate redundancy alarms and request manual failovers.
Attributes: arbitratordataservice : char
The data service offered by the Arbitrator. This will be used if the realtime database needs to connect to the Arbitrator to issue a failover request. arbitratortable : char
The name of the table within the Arbitrator to update with a failover request. failovercount : integer
The consecutive number of failovers that have occurred.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 475
OpenEnterprise Schema failoverrequest : bool
If set to TRUE by the user the realtime database will request a failover from the Arbitrator. The failover request will only be successful if the system is running as master standby. failovertimestamp : datetime
The time of the last failover. failovertimestampdstoffset : integer
The daylight savings offset applicable to the failovertimestamp. iammaster : char
The name of the server that is currently Master. iamservera : char
The name of the A server. iamserverb : char
The name of the B server. iamstandby : char
The name of the server that is currently Standby.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 476 serverastate : integer
The numeric state of server A.
OpenEnterprise Schema serverastatetext : char
The textual state of server A. serveratimestamp : datetime
The time of the last state change for server A. serveratimestampdstoffset : integer
The daylight savings offset applicable to the serveratimestamp. serverbstate : integer
The numeric state of server B. serverbstatetext : char
The textual state of server B. serverbtimestamp : datetime
The time of the last state change for server B.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 477
OpenEnterprise Schema serverbtimestampdstoffset : integer
The daylight savings offset applicable to the serverbtimestamp.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 478
redundancyalarmconditiona
OpenEnterprise Schema
Derived From:
Description: alarmcondition
The RedundancyAlarmConditionA table is used to generate redundancy alarms for Server A.
Attributes: name : char references Redundancy
This provides a link back to the Redundancy table in order to enable alarm creation, deletion and updating information to be passed back and forth.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 479
redundancyalarmconditionb
OpenEnterprise Schema
Derived From:
Description: alarmcondition
The RedundancyAlarmConditionB table is used to generate redundancy alarms for Server B.
Attributes: name : char references Redundancy
This provides a link back to the Redundancy table in order to enable alarm creation, deletion and updating information to be passed back and forth.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 480
remotedataservice
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
Derived from the DataService table, which provides functionality to allow
OpenEnterprise databases to connect and communicate with each other.
The table is used to manage any remote signals defined to connect to the associated data service.
Attributes: alarmcondition:Integer references RemoteDataServiceAlarmCondition
A reference to the alarm condition associated with the remote data service. password:Char Hidden
The password to be used to login to the remote database. remotedigitals:Array of RemoteDigital
A transient array of the digital remote signals that are connecting to the remote database.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 481
OpenEnterprise Schema remoterealanalogs:Array of RemoteRealAnalog
A transient array of the real analog remote signals that are connecting to the remote database. remotetimer:Integer references RemoteDataServiceTimer
A reference to the watchdog timer table entry for the remote data service. statussignal:Char references LocalRealAnalog
A reference to the status signal for the remote data service. timestamp_lastupdate:DateTime
The time at which the last update from the remote database occurred. updatecount:Integer
The number of updates from the remote database. username:Char
If specified then this is the name of the user that will be used to login to the remote database.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 482
remotedataservicealarmcondition
OpenEnterprise Schema
Derived From:
Description: alarmcondition
This table is used to generate and manage alarms relating to failures of connection to a remote database.
Attributes: remotedataservice:Char
Char references RemoteDataService.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 483
remotedataservicetimer
OpenEnterprise Schema
Derived From: oetimer
Description: The RemoteDataServiceTimer table is used to trigger reconnection attempts whenever the connection to a remote database is lost, or if the host database itself is restarted.
Attributes: remotedataservice:Char references RemoteDataService
A reference to the remote data service with which the timer entry is associated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 484
remotedigital
OpenEnterprise Schema
Derived From:
Description: localdigital
The RemoteDigital table hosts the digital signals that are to be linked to digital signals in a remote database.
Attributes: remotedataservice:Char not null
The name of the RemoteDataService table entry, specifying the remote database to which this signal will be linked. remotename:Char
The name of the signal in the remote database to which the signal will be linked. If this value is null, then the signal will attempt to link with a signal in the remote database that has the same name as that of the remote signal table entry.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 485
remoterealanalog
OpenEnterprise Schema
Derived From:
Description: localrealanalog
The RemoteRealAnalog table hosts the real analog signals that are to be linked to real analog signals in a remote database.
Attributes: remotedataservice:Char not null
The name of the RemoteDataService table entry, specifying the remote database to which this signal will be linked. remotename:Char
The name of the signal in the remote database to which the signal will be linked. If this value is null, then the signal will attempt to link with a signal in the remote database that has the same name as that of the remote signal table entry.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 486
report
OpenEnterprise Schema
Derived From:
Description: objects
The Report table is at the core of the OpenEnterprise Reporting schema and links together templates, alias values, schedules, formats, and recipients, in order to define how a published report is produced and distributed within the Reporting system.
The Report table is derived from the base Objects_Table in order to provide standard OpenEnterprise alarm functionality.
Attributes: aliasvalues: Array of ReportToAliasLookup hidden
The array of ReportToAliasLookup table entries that will be used to resolve the aliases defined within the Reports associated Report
Template. The array will be automatically maintained based on entries being inserted and deleted from the ReportAliasValues table. delay: Integer32
Specifies a delay in milliseconds before the report is run. Also produces a delay between multiple reports running as a result of a query or CSV alias. The delay can be used to throttle database loading
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 487
OpenEnterprise Schema deletepublishedreportentry: Bool default FALSE
This attribute is associated with the Purge functionality, and if set to
TRUE indicates that if a published report is purged, then the associated
PublishedReport table entry should also be deleted. This can be overridden on a per Report Format basis. directory: Char
Defines a default location to which all published reports generated as a result of this Report configuration will be created. This can be overridden on a per Report Format basis. disable:Bool default FALSE
Allows the report to be disabled. This will disable any schedules that are defined to use the Report table instance. disabledistribution:Bool default FALSE
This attribute, if set to TRUE disables the distribution of any published report(s), resulting from the Report instance. purgeperiod: Integer8 default 0
Used in conjunction with the PurgePeriodType to determine the length of time to wait when purging on a timed basis. purgeperiodtype: Integer8 default 0
Used to define the type of period to wait for when purging on a timed basis.-
1 = Not set
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 488
0 = Hours
OpenEnterprise Schema
1 = Days
2 = Weeks
3 = Months
4 = Years purgetype: Integer8 default 0
Used to define how any published report associated with the Report is to be purged.
0 = Not set.
1 = Purge when the published report has been successfully distributed.
2 = Purge when the published report has been distributed, regardless of any errors.
3 = Use Purge Time. This can be overridden on a per Report Format basis.
4 = Do Not Purge. removeplugin: Bool default true
Flag indicating whether the plug in will be removed from the master report.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 489 status: Integer
OpenEnterprise Schema
This attribute will be updated by the Report Scheduler and will be used to generate alarms and events relating to a Report table entry. Positive numbers indicate in progress codes. Zero means completed successfully. Negative numbers indicate errors: -
1 = Started
2 = Opening Template
3 = Setting Aliases
4 = Resolving Data
5 = Report Created
6 = Publishing
7 = Distributing
0 = Success
-1 = Failed to open Template
-2 = Duplicate multi-value alias found
-3 = Failed to run
-4 = Failed to publish
-5 = Timed out
-6 = Stopped
-7 = Unable to set alias statustext: Char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 490
OpenEnterprise Schema
A textual representation of the Status attribute value. templatename: Char references ReportTemplate not null
A reference to the Report Template that will be used when generating the published report. testreport: Bool transient hidden
Setting this flag will start a test of the report. This allows a report to be tested outside of a Schedule. username: Char
If non-NULL then this defines the name of the OpenEnterprise user that will be used to generate the contents of the report, (i.e. the user with which the Report plug-ins log in to the OpenEnterprise database(s)). If the value is NULL then this informs the plug-ins to use Server Security to obtain the user credentials.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 491
reportalarmcondition
OpenEnterprise Schema
Derived From:
Description: alarmcondition
This is the base table for all Report applicable alarm conditions.
Attributes: description: Char
An optional field to provide a more detailed description for each Report
Alarm Condition. reportname: Char references Report not null
A reference to the applicable Report object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 492
reportcreation
OpenEnterprise Schema
Derived From: <Base Table>
Description: The ReportCreation table enables both the Report Configuration Tool and the Report Selector to generate or regenerate Reports through the Report
Scheduler.
Attributes: aliasnames: Char
CSV list of any other report alias names that are to be overridden when performing the report creation. aliasvalues: Char
A CSV list of the overridden Report alias values. basedate: Char
If non-null then this defines the value of the BASEDATE report alias value, in UTC. basetime: Char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 493
OpenEnterprise Schema
If non-null then this defines the value of the BASETIME report alias value, in UTC. createmethod: Integer8
Indicates the action to be performed by the Report Scheduler:
0 = Run and Publish Report
1 = Run Report doaction: Bool transient
Setting this attribute to TRUE will inform the Report Scheduler to perform the requested report creation action. enabledformats: Char
This attribute is used in conjunction with the generation of a report and defines a CSV list of the formats that are enabled for inclusion in the report generation. If this value is NULL then all formats are enabled. enabledrecipients: Char
This attribute is used in conjunction with the generation of a report and defines a CSV list of the recipients that are enabled for inclusion in the report generation. If this value is NULL then all recipients are enabled. formattype: Integer
The format type to be created. The values of this attribute will match those permitted for the FormatType attribute of the existing Format table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 494
OpenEnterprise Schema
Id: Integer Primary Key
An auto generated primary key for the table entry. outputfile: Char
The name and location of the new report file. Only set when
CreateMethod is set to 0 or 1. publishedreport: Integer references Report
A reference to the associated PublishedReport table entry. reportname: Char references Report Not Null
A reference to the associated Report table entry. status: Integer default 0
Used to indicate the success or otherwise of the action. 0 indicates success, a negative value indicates a failure, and a positive value indicates work in progress.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 495
reportequalsalarmcondition
OpenEnterprise Schema
Derived From:
Description: reportalarmcondition
The ReportEqualsAlarmCondition table is used to define an alarm condition that will occur if the status value of the applicable Report table entry is set to a specific value.
Attributes: statusvalue: Integer not null
The status value that will constitute an alarm condition.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 496
reportformat
OpenEnterprise Schema
Derived From: objects
Description: The ReportFormat table is used to define the format in which one or more reports will be published, and is derived from the standard Objects table.
Attributes: createdirectory: Bool
If set to true, a new output directory for the Report Format will be created with the name specified in the location attribute. deletepublishedreportentry: Bool default FALSE
This attribute is associated with the Purge functionality, and if set to
TRUE indicates that if a published report is purged, then the associated
PublishedReport table entry should also be deleted. This overrides the value of the DeletePublishedReportEntry attribute value of any associated Report table entry. disable: Bool default FALSE
Setting this attribute to TRUE will disable the ReportFormat entry and inform the Report Scheduler not to generate a report in the format
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 497 defined by the table entry. filename: Char
OpenEnterprise Schema
This is an optional value, and allows the user to override the base name of the published report file for this particular format. (Not relevant for
FormatType = 1). formattype: Integer8 default 0
The format type, which may be one of the following:-
0 = Excel (.xls).
1 = Paper, i.e. a networked or local printer
2 = PDF
3 = RTF
4 = CSV location: Char
5 = TSV
6 = XML
7 = HTML
If FormatType = 1 then this will hold the identity of the local or network printer to which the report will be sent. For all other values of
FormatType this is the directory to which the published report will be written. Note, that this overrides the value of the Directory attribute of the parent Report table entry.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 498
OpenEnterprise Schema purgeperiod: Integer8 default 0
Used in conjunction with the PurgePeriodType to determine the length of time to wait when purging on a timed basis. purgeperiodtype: Integer8 default 0
Used to define the type of period to wait for when purging on a timed basis.
-1 = Not set – The settings for the parent report will be used.
0 = Hours
1 = Days
2 = Weeks
3 = Months
4 = Years purgetype: Integer8 default 0
Used to define how any published report associated with the Report is to be purged.
0 = Not set – The settings for the parent report will be used.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 499
OpenEnterprise Schema
1 = Purge when the published report has been successfully distributed.
2 = Purge when the published report has been distributed, regardless of any errors.
3 = Use Purge Time.
4 = Do not purge.This can be overridden on a per Report Format basis. removeplugin: Bool default FALSE
Not currently used as plug-in will always be removed when the master report is published to Excel format. status: Integer
This attribute will be updated by the Report Scheduler and will be used to generate alarms and events relating to a ReportFormat table entry.
Positive numbers indicate in progress codes. Zero means completed successfully. Negative numbers indicate errors: -
1 = Started
0 = Success
-1 = Invalid configuration
-2 = Publishing failed statustext: Char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 500
OpenEnterprise Schema
A textual representation of the Status attribute value. uniquefilename: Bool default FALSE
Specifies that the Report Scheduler must create a unique file name for each report that is generated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 501
reportformatalarmcondition
Derived From:
Description:
OpenEnterprise Schema alarmcondition
This is the base table for all ReportFormat applicable alarm conditions.
Attributes: description: char
An optional field for providing extra descriptive information about the
Report Format alarm condition. reportformatname: Char references ReportFormat not null
A reference to the applicable ReportFormat object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 502
reportformatequalsalarmcondition
OpenEnterprise Schema
Derived From:
Description: reportformatalarmcondition
The ReportFormaEqualstAlarmCondition table is used to define an alarm condition that will occur if the Status attribute value of the applicable
ReportFormat table entry is set to a specific value.
Attributes: statusvalue: Integer not null
The status value that will constitute an alarm condition.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 503
reportformatrangealarmcondition
OpenEnterprise Schema
Derived From:
Description: reportformatalarmcondition
The ReportFormatRangeAlarmCondition is used to define an alarm condition that will occur if the status value of the applicable ReportFormat table entry lies within the specified range.
Attributes: statusvaluelower: Integer not null
The lower status value of the range. statusvalueupper: Integer not null
The upper status value of the range.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 504
reportformattorecipientlookup
OpenEnterprise Schema
Derived From:
Description:
FormatName, RecipientName
The ReportFormatToRecipientLookup table allows ReportRecipients to be associated with specific ReportFormat objects. Using a lookup table allows the same ReportRecipient table entries to be associated with multiple
ReportFormat objects and vice versa.
Attributes: accessarea: Char
The standard access area attribute definition used to provide object based security in OpenEnterprise formatname: Char references ReportFormat not null
The name of the applicable ReportFormat object. recipientname: Char references ReportRecipient not null
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 505
OpenEnterprise Schema
A reference to the applicable ReportRecipient object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 506
reportrangealarmcondition
OpenEnterprise Schema
Derived From:
Description: reportalarmcondition
The ReportRangeAlarmCondition is used to define an alarm condition that will occur if the status value of the applicable Report table entry lies within the specified range.
Attributes: statusvaluelower: Integer not null
The lower status value of the range. statusvalueupper: Integer not null
The upper status value of the range.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 507
reportrecipient
OpenEnterprise Schema
Derived From:
Description: objects
This is the base recipient table definition from which the type specific recipient tables will be derived. It is derived from the base Objects table in order to provide OpenEnterprise alarming.
Attributes: disable: Bool default false
Disables this recipient. status: Integer
This attribute will be updated by the Report Scheduler and will be used to generate alarms and events relating to a ReportRecipient table entry.
Positive numbers indicate in progress codes. Zero means completed successfully. Negative numbers indicate errors: -
1 = Started
0 = Success
-1 = Invalid configuration
-2 = Distribution failed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 508
OpenEnterprise Schema statustext: Char
A textual representation of the Status attribute value. type: Integer8 not null
The type of Report recipient. Initial values will be:
0 = Email
1 = FTP
2 = File Copy
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 509
reportrecipientalarmcondition
OpenEnterprise Schema
Derived From:
Description: alarmcondition
This is the base table for all ReportRecipient applicable alarm conditions.
Attributes: description: Char
An optional attribute for providing more information about the alarm condition. reportrecipientname: Char references ReportRecipient not null
A reference to the applicable ReportRecipient object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 510
reportrecipientemail
OpenEnterprise Schema
Derived From:
Description: reportrecipient
The ReportRecipientEmail table is used to define the email credentials of a
Report Recipient.
Attributes: email: char not null
The email address of the intended report recipient.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 511
reportrecipientequalsalarmcondition
OpenEnterprise Schema
Derived From:
Description: reportrecipientalarmcondition
The ReportRecipientAlarmCondition table is used to define an alarm condition that will occur if the Status attribute value of the applicable
ReportRecipient table entry is set to a specific value.
Attributes: statusvalue: Integer not null
The status value that will constitute an alarm condition.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 512
reportrecipientfilecopy
OpenEnterprise Schema
Derived From:
Description: reportrecipient
This ReportRecipientFileCopy table allows the target of any file copy action to be defined, and would, for instance be used to copy the report to a Web
Server or remote file server.
Attributes: location:Char not null
The location to which the published report will be copied. netdomain: Char
The name of the domain controller through which the username and password attribute values, if defined, will be used to log on (note:
Domain cannot be used as it is a reserved word in SQL). password: Char hidden
The password associated with the username attribute value. Note that this will not be stored in an encrypted form.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 513 username: Char
OpenEnterprise Schema
The identification of a user who has the privileges to perform the requested file copy operation.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 514
reportrecipientftpcopy
OpenEnterprise Schema
Derived From: reportrecipient
Description: The ReportRecipientFTPCopy table provides additional configuration applicable to an FTP file copy action and is derived from the
ReportRecipient table.
Attributes: ftpserver: Char references FTPServer not null
A reference to the applicable FTPServer table entry, which defines how the FTP action will be performed. location: Char not null
The location to which the published report will be copied. netdomain: Char
The name of the domain controller through which the username and password attribute values, if defined, will be used to log on (note:
Domain cannot be used as it is a reserved word in SQL).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 515
OpenEnterprise Schema password: Char hidden
The password associated with the username attribute value. Note that this will not be stored in an encrypted form. username: Char
The identification of a user who has the privileges to perform the requested file copy operation.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 516
reportrecipientrangealarmcondition
OpenEnterprise Schema
Derived From:
Description: reportrecipientalarmcondition
The ReportRecipientRangeAlarmCondition is used to define an alarm condition that will occur if the status value of the applicable
ReportRecipient table entry lies within the specified range.
Attributes: statusvaluelower: Integer not null
The lower status value of the range. statusvalueupper: Integer not null
The upper status value of the range.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 517
reportschedule
Derived From:
Description:
OpenEnterprise Schema objects
The ReportSchedule table contains configuration that is common to all types of report scheduling.
Attributes: disable: Bool
This attribute can be used to disable the Report Schedule. doreport: Bool default FALSE
If set to TRUE triggers the schedule to run in on-demand mode (this decrements the StartRequests value). lastfinished: Datetime
The date and time at which the schedule last finished. lastrun: Datetime
The date and time at which the schedule was last triggered.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 518
OpenEnterprise Schema scheduletype: Integer8
Indicates the type of scheduling to be used with the table entry.
0 = on demand or command line activation;
1 = time-based scheduling;
2 = value-change based scheduling. startrequests: Integer default 0
Causes the Report Scheduler to generate reports based on the current configuration of the ReportSchedule table entry,If incremented, a normal schedule will be triggered. If decrement the schedule will be triggered using the ondemand aliases (if they are set). status: Integer
The status returned by the Report Scheduler when the report is scheduled. Positive numbers indicate in progress codes. Zero means completed successfully. Negative numbers indicate errors: -
1 = Started
0 = Success
-1 = Invalid configuration
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 519 statustext: Char
OpenEnterprise Schema
A textual representation of the Status attribute value.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 520
reportschedulealarmcondition
OpenEnterprise Schema
Derived From:
Description: alarmcondition
This is the base table for all ReportSchedule applicable alarm conditions.
Attributes: description: Char
A more detailed description of the alarm condition can be provided here. reportschedulename: Char references ReportSchedule not null
A reference to the applicable ReportSchedule object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 521
reportscheduleequalsalarmcondition
OpenEnterprise Schema
Derived From:
Description: reportschedulealarmcondition
The ReportScheduleEqulasAlarmCondition table is used to define an alarm condition that will occur if the Status attribute value of the applicable
ReportSchedule table entry is set to a specific value.
Attributes: statusvalue:Integer not null
The status value that will constitute an alarm condition.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 522
reportscheduler
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The ReportScheduler table allows the configuration settings for the Report
Scheduler (such as report timeouts) to be stored in the and therefore be available across the entire OpenEnterprise system.
Attributes: allowsimultaneousreports: Bool Default TRUE
When set to TRUE, multiple reports can run concurrently. When set to
FALSE, only one report can run at any one time. catchupmissedschedules: Bool default false
When set to TRUE, the Report Scheduler will catch up any timed schedules that should have been run while the Report Scheduler was not running. If FALSE, the Report Scheduler will move all the timed schedules to the next scheduled time in the future. description: Char
Description of the settings
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 523
OpenEnterprise Schema emailserver: Char references EmailServer_Table
A reference to an EmailServer_Table object where the ReportScheduler will get its e-mail configuration from. filetransferportid:Char
The name or port number through which the File Transfer components will communicate. id: integer not null Primary Key
The name of the ReportScheduler configuration. This is most likely to be the data service of the database. logfiledays: Integer Default 7
Number of days to keep the log files for. Only applies when LogFileType is set to 2. logfiletype: Integer Default 0
The type of file logging selected.
0 = None
1 = To a single file
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 524
2 = To a new file every day
OpenEnterprise Schema maximumevents: Integer Default 1000
Number of Report Scheduler events kept in memory at a time. reportservername: Char
The name of the machine on which the Report Server resides. reporttimeout: Integer Default 2
Time in minutes before a report is deemed to have timed out. showreportsduringpublishing: Bool Default FALSE
Whether reports run visibly. startupcustomisationoption: Integer default 2
Represents the Report Scheduler's Report Template customisation options at start up. Defaults to 2, but can be modified from the Report
Scheduler's 'Properties' Dialog. Implemented to give users a choice of options regarding the upgrading of Report Templates from
OpenEnterprise V2.7 onwards. Report Templates created before
OpenEnterprise V2.7 need to be upgraded for compatibility. The available options are:-
0 - “Do not check versions and do not customise”
1 - "Check versions but do not customise”
2 - “Check versions and customise if necessary”
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 525
OpenEnterprise Schema
reportschedulerangealarmcondition
Derived From:
Description: reportschedulealarmcondition
The ReportScheduleRangeAlarmCondition is used to define an alarm condition that will occur if the Status attribute value of the applicable
ReportSchedule table entry lies within the specified range.
Attributes: statusvaluelower: Integer not null
The lower status value of the range. statusvalueupper: Integer not null
The upper status value of the range.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 526
reportscheduletimed
OpenEnterprise Schema
Derived From: reportschedule
Description: The ReportScheduleTimed table is derived from the base ReportSchedule table, and provides configuration applicable to the time based triggering of report generation.
Attributes: nextscheduled:DateTime
The UTC date and time at which the timed report schedule is next expected to trigger. offset:Integer not null
The Offset within the Period. The interpretation of this value is dependent upon the value of the OffsetType attribute value. offsettime: Integer not null
Specifies the number of seconds from midnight into the days that the schedule will trigger. (0 to 86399)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 527
OpenEnterprise Schema offsettype:Integer8 not null
Indicates how the Offset attribute value is to be interpreted.
0 = Days
1 = Weeks
2 = Months
3 = Years
4 = Sunday
5 = Monday
6 = Tuesday
7 = Wednesday
8 = Thursday
9 = Friday
10 = Saturday
11 = January
12 = February
13 = March
14 = April
15 = May
16 = June
17 = July
18 = August
19 = September
20 = October
21 = November
22 = December
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 528
OpenEnterprise Schema period:Integer not null
The repeat period for the report schedule. How this is interpreted is dependent upon the value of the PeriodType attribute. periodtype:Integer8 not null
Indicates how the Period attribute value is to be interpreted.
0 = Minutes
1 = Hours
2 = Days
3 = Weeks
4 = Months
5 = Years repeating:Bool default TRUE
Indicates whether this is a one-shot or repeating schedule. FALSE = one-shot,
TRUE = repeating. summary:Char
A textual summary of the chosen configuration. This will be set by the
Reporting configuration tool on any configuration change. timebase:Integer8 not null
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 529
OpenEnterprise Schema
Specifies how the time will be interpreted by the Report Scheduler in terms of the offset from UTC.
0 = Local Time DST adjusted. I.e. standard local time.
1 = Local Time Non DST adjusted. That is, the local time zone but with no DST adjustment.
2 = UTC. The schedule will be triggered when UTC reaches the specified time, not when local time reaches it.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 530
reportschedulevaluechange
Derived From:
Description:
OpenEnterprise Schema reportschedule
The ReportScheduleValueChange table is derived from the base
ReportSchedule table and provides additional configuration information applicable to reports being generated due to value changes.
Attributes: delay:Integer
Time in milliseconds to delay running a Schedule after it has been triggered. This can be used to allow historical data to filter through to historical tables. minimumfrequency:Integer default 60
The minimum frequency, in seconds, at which the report will be triggered. This is used to prevent the report from being triggered too frequently if the OPCTag value is changing rapidly. opctag:Char not null
An OPC Data Access Tag definition that identifies the OPC Item value that will be used to trigger the report.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 531 type:Integer8
OpenEnterprise Schema
Defines how the schedule is triggered
0 = on any value change value:Char value2:Char
1 = a change to a specific value
2 = a change to a value in the defined range
3 = a change to a value outside the defined range
If Type = 1, then this indicates the value to which the object identified by the OPCTag attribute value must change in order to trigger the schedule.
If Type = 2 or 3 then this is the lower range value
If Type = 2 or 3 then this is the upper range value.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 532
reporttemplate
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The ReportTemplate table will have the following definition, and will contain the name of a pre-formatted report template or bespoke report that will be used within the OpenEnterprise Reporting system.
Attributes: accessarea: Char hidden
The standard access area attribute definition used to provide object based security in OpenEnterprise. description: Char
Allows a more meaningful description to be defined for the Report
Template. directory: Char
The location of the Report Template file. This may be any fixed or network drive. If this value is NULL then the working directory of the
Report Scheduler will be assumed.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 533
OpenEnterprise Schema filename: Char not null
The actual file name of the Report Template. name: Char primary key
A unique name for the Report Template or bespoke report.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 534
reporttoaliaslookup
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The ReportTemplate table will have the following definition, and will contain the name of a pre-formatted report template or bespoke report that will be used within the OpenEnterprise Reporting system.
Attributes: accessarea: Char hidden
The standard Access Area attribute definition. aliasname: Char not null
The name of the Alias that is to be resolved when the schedule is triggered. aliastype: Integer8 not null
Used to indicate the type of Alias:-
0 = Alias is undefined
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 535
1 = Alias is a constant value
OpenEnterprise Schema aliasvalue: Char
2 = Alias is a CSV list
3 = Alias is an SQL Query
The alias value which will either take the form of a constant, a CSV list or an SQL Query. If the value is NULL then the alias value is unresolved. dataservice: Char
This attribute defines what dataservice the Report Scheduler should connect to to run an SQL Query. If null it will simply use its main database connection demandvalue: Char hidden transient
This attribute is used in conjunction with ‘on demand’ report generation to override the AliasValue attribute value. This attribute should be updated prior to an on demand report being generated. Setting the value to NULL indicates that the AliasValue attribute value, if defined, should be used instead. demandvaluetype: Integer8 not null
Used to indicate the format of the DemandValue attribute. The permitted values are the same as for the AliasType attribute. reportname: Char not null references Report
A foreign key reference to the Report table entry to which the alias value will be applied.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 536
reporttoformatlookup
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The ReportToFormatLookup table is used to associate Report table entries with the appropriate ReportFormat table entries, thus allowing the same
ReportFormat table entry to be shared by multiple Reports.
Attributes: accessarea: Char
The standard Access Area attribute definition. formatname: Char not null references ReportFormat
A foreign key reference to the ReportFormat table with which the Report will be associated. reportname: Char not null references Report
A foreign key reference to the Report table entry with which the
ReportFormat will be associated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 537
OpenEnterprise Schema
reporttoschedulelookup
Derived From:
Description:
<Base Table>
In order to associate Report objects with the ReportSchedule objects that will be used to trigger the generation of those reports, a lookup table is required. The use of a lookup table allows multiple Report objects to be associated with the same ReportSchedule object, and similarly, multiple
ReportSchedule objects to be associated with the same Report object.
Attributes: accessarea:Char
The standard access area attribute definition, used to provide object based security in OpenEnterprise. reportname:Char not null references Report
The name of the applicable Report object. schedulename:Char not null references ReportSchedule
The name of the applicable ReportSchedule object
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 538
rocacinputoutputmodule
Derived From:
Description:
To be completed
To be completed
Attributes: acfrequency:float
To be completed actualscantime:float
To be completed autooutput:integer
To be completed channelmode:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 539 cumulativeofftime:float
To be completed
OpenEnterprise Schema cumulativeontime:float
To be completed cycletime:float
To be completed euvalue:float
To be completed failsafeonresetmode:integer
To be completed failsafeoutput:integer
To be completed failureaction:integer
This parameter decides the action to be taken when a “failure condition” is detected.
0 = Channel is automatically shutdown, alarm is logged
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 540
1 = No action taken, alarm logged
OpenEnterprise Schema faultreset:integer
2 = No action taken, alarm not logged
WARNING!!! Changing this parameter can cause relay protection to be disabled.
To be completed filter:float
To be completed highreadingeu:float
To be completed highreadingtime:float
To be completed holdingcurrent:float
To be completed inputaccumulatedvalue:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 541
To be completed inputalarmcode:integer
To be completed inputalarming:integer
To be completed inputinvertmode:integer
To be completed inputsrbxonclear:integer
To be completed inputsrbxonset:integer
To be completed inrushtime:float
To be completed invertoutputmode:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 542
To be completed latchmode:integer
To be completed lowreadingeu:float
To be completed lowreadingtime:float
To be completed manualoutput:integer
To be completed momentaryactive:integer
To be completed momentarymode:integer
To be completed outputaccumulatedvalue:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 543
To be completed outputalarmcode:integer
To be completed outputalarming:integer
To be completed outputsrbxonclear:integer
To be completed outputsrbxonset:integer
To be completed physicalinput:integer
To be completed physicaloutput:integer
To be completed powerin:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 544
To be completed scanninginput:integer
To be completed scanningoutput:integer
To be completed scanperiod:float
To be completed statusinput:integer
To be completed timeddiscreteoutputtdomode:integer
To be completed timeon:float togglemode:integer unitstag:char
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 545
rocadvancedpulsemodule
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: apiforwardpulsecountspair1:integer
To be completed apiforwardpulsecountspair2:integer
The accumulated number of forward pulses through the API level checks for pulse pair 2. This will be updated only when the API Level
Check Pair 2 (parameter #2) is set to either Level A, B, or C. apilevelcheckpair1:integer
The user can select which API level they wish to perform. The output of the API Chapter 5.5 level checks will always be written to the API Pulse
Counts Pair 1 (parameter #17)
0 - Level A
1 - Level B
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 546
2 - Level C
3 - Level D
4 - Level E
OpenEnterprise Schema apilevelcheckpair2:integer
The user can select which API level they wish to perform. The output of the API Chapter 5.5 level checks will always be written to the API Pulse
Counts Pair 2 (parameter #19).
0 - Level A
1 - Level B
2 - Level C
3 - Level D
4 - Level E apipair1alarmstatus:integer
API Level Alarm Status (Pair 1)
Note: These are updated in real time apipair2alarmstatus:integer
API Level Alarm Status (Pair 2)
Note: These are updated in real time
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 547
OpenEnterprise Schema apiphasealarmcountpair1:integer
The total number of phase alarms apiphasealarmcountpair2:integer
The total number of phase alarms apipulsecountspair1:integer
The accumulated number of pulses through the API level checks for pulse pair 1. This will be updated only when the API Level Check Pair 1
(parameter #1) is set to either Level A, B, or C. apipulsecountspair2:integer
The accumulated number of pulses through the API level checks for pulse pair 2. This will be updated only when the API Level Check Pair 2
(parameter #2) is set to either Level A, B, or C. apireversepulsecountspair1:integer
To be completed apireversepulsecountspair2:integer
The accumulated number of reverse pulses through the API level checks for pulse pair 2. This will be updated only when the API Level
Check Pair 2 (parameter #2) is set to either Level A, B, or C.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 548
OpenEnterprise Schema apisamechannelalarmcountpair1:integer
The total number of same channel alarms apisamechannelalarmcountpair2:integer
The total number of same channel alarms bufferwarningalarmsetpoint:integer
The max buffered pulses allowed before the buffer warning alarm is triggered.
Note: This must be less than the max buffered pulses allowed. detectorreset:integer
This essentially notifies the APM of the start of a prove. All accumulated pulse values shall be cleared. All alarms shall be cleared.
Accumulation of pulses will start at the first detector switch transition and will stop at the 2nd detector switch transition.
0 – Idle
1 – Reset detectorswitch1status:integer
The physical detector switch status is either open or closed.
1 – Open
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 549
0 – Closed
OpenEnterprise Schema detectorswitch2status:integer
The physical detector switch status is either open or closed.
1 – Open
0 - Closed detectorswitchfiltertime:integer
This is the time allotted after a detector switch is triggered and before the next trigger is to occur. This shall provide a de-bounce filter for the detector switches. The time shall be given in milliseconds. detectorswitchstate:integer
Gives the state of the detector switches
0 - Reset, a reset has been received and the APM is expecting a detector switch transition.
1 - Counting, a detector switch transition has occurred and the APM is currently counting whole pulses.
2 - Complete, another detector switch transition has occurred and the
Prove Run is complete. All values will be stored until the next reset.
3 - Invalid, the accumulator does not contain good values. This can be either at a power up or if we have lost communication during a prove
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 550
OpenEnterprise Schema and the accumulators have been reset to zero. flowdirectionpair1:integer
This will give the direction of flow based on 180 degrees out of phase for first pair of pulses. Level A or B API checks must be used (parameter
#1).
0 - Forward (< 180 degrees)
1 - Reverse (> 180 degrees)
Note: Forward/Reverse designators assume 90 degrees out of phase flowdirectionpair2:integer
This will give the direction of flow based on 180 degrees out of phase for the second pair of pulses. Level A or B API checks must be used
(parameter #2).
0 - Forward (< 180 degrees)
1 - Reverse (> 180 degrees)
Note: Forward/Reverse designators assume 90 degrees out of phase frequencypair1:float
Frequency of incoming pulses on Pair One in pulses/second.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 551
OpenEnterprise Schema frequencypair2:float
Frequency of incoming pulses on Pair Two in pulses/second. frequencypifour:float
Frequency of incoming pulses on PI Four in pulses/second. frequencypione:float
Frequency of incoming pulses on PI One in pulses/second. frequencypithree:float
Frequency of incoming pulses on PI Three in pulses/second. frequencypitwo:float
Frequency of incoming pulses on PI Two in pulses/second. inputtlp:char inputtlp_l:integer
Input to be used in calculating output pulses
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 552 inputtlp_p:integer
To be completed inputtlp_t:integer
To be completed
OpenEnterprise Schema mastermeterinputonprove:integer
Indicates which pulse to use for the Master Meter Prove.
0 - Pulse Input 1
1 - Pulse Input 2
2 - Pulse Input 3
3 - Pulse Input 4
Note: This is only valid if Software Detector Switch Enabled (parameter
#42) is enabled. mastermeterinterpolatedpulsecount:float
Actual Number of interpolated pulses accumulated between software detector switches for a given master meter pulse input. mastermeterinterpolationtimert1:float
Time interval over which the whole flowmeter pulses were accumulated on the master meter. Value is in seconds
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 553
OpenEnterprise Schema mastermeterinterpolationtimert2:float
Time interval between the first and second detector switch being triggered for the master meter. Value is in seconds. mastermeterwholepulsecount:integer
Actual number of whole pulses accumulated between detector switches for a Master Meter Input (parameter #4)
Note: This is only valid if Software Detector Switch Enabled (parameter
#42) is enabled. Detector Reset will clear this value. maximumbufferedpulses:integer
The max buffered pulses allowed. maximumpulseoutputfrequency:integer
The maximum number of pulses per second which can be output by the
PO (in Hz). If the calculated number of pulses exceeds this value then those pulses shall be placed in the buffer. meterinputonprove:integer
Indicates which pulse to use for the Meter Prove.
0 - Pulse Input 1
1 - Pulse Input 2
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 554
2 - Pulse Input 3
3 - Pulse Input 4
OpenEnterprise Schema meterinterpolatedpulsecount:float
Actual Number of interpolated pulses accumulated between detector switches for a given meter pulse input. meterinterpolatedtimert1:float
Time interval over which the whole flowmeter pulses were accumulated.
Value is in seconds. meterinterpolatedtimert2:float
Time interval between the first and second detector switch being triggered. Value is in seconds. meterwholepulsecount:integer
Actual number of whole pulses accumulated between detector switches for a Meter Input (parameter #3). Note: Detector Reset will clear this value. modulealarmcode:integer
Defines the alarms for the APM modulealarming:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 555
OpenEnterprise Schema modulesrbxonclear:integer
Indicates an SRBX alarm is desired if an alarm condition clears.
0 – SRBX on Clear Disabled
1 – SRBX on Clear Enabled modulesrbxonset:integer
Indicates an SRBX alarm is desired if an alarm condition occurs.
0 – SRBX on Set Disabled
1 – SRBX on Set Enabled outputscalingvalue:float
The value that is applied to the accumulated pulse value. pi4poconfiguration:integer
Gives the configuration of the PI4/PO terminal of the APM. A hardware switch is used to configure this.
0 – Configured for a Pulse Input
1 – Configured for a Pulse Output
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 556 pialarming:integer
OpenEnterprise Schema
Displays whether alarms may be generated and sent to the alarm log for a pulse input.
0 – Alarming Disabled
1 – Alarming Enabled pisrbxonclear:integer
Indicates an SRBX alarm is desired if an alarm condition clears for a pulse input.
0 – SRBX on Clear Disabled
1 – SRBX on Clear Enabled pisrbxonset:integer
API Level Alarm Status (Pair 1)
Note: These are updated in real time poaccumulator:integer
Gives the accumulated number of pulses sent out. poalarmcode:integer
Defines the alarms for a pulse output
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 557
OpenEnterprise Schema poalarming:integer
Displays whether alarms may be generated and sent to the alarm log for a pulse output.
0 – Alarming Disabled
1 – Alarming Enabled poinputmode:integer
Gives the interpretation of the Input TLP (parameter #46).
0 – Input TLP is a rate
1 – Input TLP is an accumulation poscanperiod:float
Time period in seconds in which the parameters associated with the pulse output are evaluated.
0 – disabled
All other output pulses will be at a 50% duty cycle posrbxonclear:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 558
OpenEnterprise Schema posrbxonset:integer
Indicates an SRBX alarm is desired if an alarm condition occurs for a pulse output.
0 – SRBX on Set Disabled
1 – SRBX on Set Enabled pulseinput1tag:char
A 20 character identification name for a specific APM Pulse Input.
Values must be printable ASCII characters. pulseinput2tag:char
A 20 character identification name for a specific APM Pulse Input.
Values must be printable ASCII characters. pulseinput3tag:char
A 20 character identification name for a specific APM Pulse Input.
Values must be printable ASCII characters. pulseinput4tag:char
A 20 character identification name for a specific APM Pulse Input.
Values must be printable ASCII characters. rawpulsecountpifour:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 559
OpenEnterprise Schema
The raw accumulated number of pulses for PI Four rawpulsecountpione:integer
The raw accumulated number of pulses for PI One rawpulsecountpithree:integer
The raw accumulated number of pulses for PI Three rawpulsecountpitwo:integer
The raw accumulated number of pulses for PI Two scanperiodpifour:float
Time period in seconds in which the parameters associated with the pulse input are evaluated. scanperiodpione:float
Time period in seconds in which the parameters associated with the pulse input are evaluated. scanperiodpithree:float
Time period in seconds in which the parameters associated with the pulse input are evaluated.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 560
OpenEnterprise Schema scanperiodpitwo:float
Time period in seconds in which the parameters associated with the pulse input are evaluated. softwaredetectorswitch:integer
A 1 “triggers” the start/stop of counting pulses for a master meter or tank prove. Once the APM receives a trigger, it will set this back to Idle.
0 - Idle
1 – Detector Switch Triggered
Note: This is only valid if Software Detector Switch Enabled (parameter
#42) is enabled. softwaredetectorswitchenabled:integer
Displays whether a master meter or tank prover is to be proved.
0 – Disabled
1 – Enabled
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 561
rocalarmcondition
Derived From:
Description:
Attributes:
No attributes extend this table.
To be completed
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 562
rocalarmlog
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char
To be completed alarmcodeparameterid:integer
To be completed alarmdescription:char
To be completed alarmindex:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 563 alarmlimitvalue:float
To be completed alarmlogcode:integer
To be completed alarmlogdescription:char
To be completed alarmlogtype:integer
To be completed alarmparamabbrev:char
To be completed alarmparamdescription:char
To be completed alarmpointtypeabbrev:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 564 alarmtag:char
To be completed alarmtime:datetime
To be completed alarmtimedstoffset:integer
To be completed alarmtimeraw:integer
To be completed alarmtlp:char
To be completed alarmtlp_l:integer
To be completed alarmtlp_p:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 565 alarmtlp_t:integer
To be completed alarmunits:char alarmvalue:float
To be completed
To be completed currentalarmindex:integer
To be completed deviceid:char
To be completed devicename:char
To be completed lastlogindex:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 566 name:char
To be completed newalarmtrigger:integer
To be completed rocisplusprotocol:bool
To be completed rxtimestamp:datetime
To be completed rxtimestampdstoffset:integer
To be completed setorclear:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 567
rocbasedatum
OpenEnterprise Schema
Derived From:
Description: dvi_datum
The base table for the RocDeviceCommsRoute and RocRequest tables.
Attributes: accessarea:char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. clearstatistics:bool
When set to TRUE, clears the statistics fields. datumtype:integer8
The type of datum. description:char
String which provides a fuller description of the object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 568
OpenEnterprise Schema deviceid:char
The DeviceId field from the Device. internalflags:integer
Used internally by OpenEnterprise. logtrigger:integer
Log Trigger, set when a Request is sent to the Device. The CL increments the LogTrigger value of the RocDatum by 1. This prompts the OpenEnterprise Historian to log any updated RocBaseDatuml values that are marked for historical collection. statslastcleared:datetime
The time when the statistics fields were last cleared. statslastcleareddstoffset:integer
An offset applied to the lastcleared value.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 569
rocblmuserlistparameters
Derived From:
Description:
To be completed
To be completed
Attributes: data:char data_l:integer data_p:integer data_t:integer
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 570 text:char
To be completed units:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 571
rocchannel
OpenEnterprise Schema
Derived From:
Description: dvi_network.
Represents communication channels that can be used by the rdi for communicating with ROC Devices. One entry should be configured for each Direct-Serial or Dial-Up Comms port that is to be used by the Roc
RDI.
Attributes: accessarea:char
To be completed alarmcondition:alarmcondition_table
To be completed answerunknowndeviceaddress:integer
DeviceAddress of last call from unrecognized device Dialup channels only answerunknowndevicegroup:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 572
OpenEnterprise Schema
GroupNumber of last call from unrecognized device. Dialup channels only answerunknownstationname:char
StationName of last call from unrecognized device Dialup channels only associatedchannelsets:char
Hidden attribute. A list of ChannelSets (SetId) that this Channel belongs to. This is maintained by CL (n.b. RocChannelSet and
RocChannelSetAllocation tables are not mapped by the RDI). channelmodemavailable:bool
To be completed channelquestionable:bool
To be completed channeltype:char
Reference to ChannelTypes_Table
(‘ROC_DIALUP’ or ‘ROC_SERIAL’) clearstatistics:bool
Clears Channel Statistics fields
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 573
OpenEnterprise Schema closedelay:integer
See above. Default is 2000. closewhennotused:bool
Tells the rdi to release the port when not being used, after
‘CloseDelay’milliseconds of inactivity. Allows other utilities (e.g.
ROCLINK) to access the port. Default is true. currentcommsstatus:integer
UNAVAILABLE,AVAILABLE,IN_USE,RINGING,DISABLED currentcommsstatustext:char
To be completed debugon:bool
Hidden attribute. Set true to turn on CL debugs for this channel delayafterpoll:integer
The delay (ms) after accessing each outstation on a Direct Serial channel.Default is 0. description:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 574 arbitrary description
OpenEnterprise Schema display:char
To be completed hayesmodemaliveperiodsecs:integer
To be completed hayesmodemalivestring:char
This is the Hayes AT string used to ‘sanity’ check an attached modem
(where ChannelType is ROC_DIALUP). Default is ATHE0V1S0=0 internalflags:integer
Hidden attribute. Internal CL use only lastdeviceaddress:integer
Hidden attribute. The RocAddress for the last device to use this channel lastdevicegroup:integer
Hidden attribute. The RocGroup for the last device to use this channel lastdeviceid:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 575
OpenEnterprise Schema
Hidden attribute. The DeviceId for the last device to use this channel numfailuresbeforealarm:integer
To be completed plantarea:char
To be completed portname:char serial port name eg COM20. Used as part of the networkaddress (RDI does not this monitor directly) portparameters:char reference to ‘PortParameters’ used when setting up channel to receive dial-ins. statsanswerunknowndevicecount:integer
Number if good incoming calls, but from unrecognized device. Dialup channels only statsbadconnectcount:integer
Number of connection failures (Dial-Up)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 576
OpenEnterprise Schema statsbadincomingcallcount:integer
Number if bad incoming calls Dialup channels only statsbadmessagecount:integer
Number of bad messages received on this channel (unreliable due to the way a valid message is hunted). statsbadsessioncount:integer
To be completed statsconnectexcessivetimecount:integer
Total number of connection timeouts (Dial-Up) statscrcerrorcount:integer
Number of d messages received with CRC errors on this channel
(unreliable due to the way a valid message is hunted). statsdiscardedcharactercount:integer
Number of discarded charaters. statsframingerrorcount:integer
Number of framing errors
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 577
OpenEnterprise Schema statsgoodconnectcount:integer
Number of good connections (Dial-Up) statsgoodincomingcallcount:integer
Number if good incoming calls Dialup channels only statsgoodmessagecount:integer
Number of good messages received on this channel statsgoodsessioncount:integer
Number of good completed sessions (calls) (Dial-Up) statsgoodunsolicitedmessagecount:integer
Number of good unsolicited messages received on this channel statslastattemptedcomms:datetime
Time of last attempted comms on this channel statslastattemptedcommsdstoffset:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 578
OpenEnterprise Schema statslastcleared:datetime
Time that the statistics were last cleared statslastcleareddstoffset:integer
To be completed statslastsuccessfulcomms:datetime
Time of last successful comms on this channel statslastsuccessfulcommsdstoffset:integer
To be completed statsmessagenumretriescount:integer
To be completed statsmessageresponsetimeoutcount:integer
Number of timeouts occurred when waiting for response message statsoverrunerrorcount:integer
Number of Overrun errors statsparityerrorcount:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 579
Number of Parity Errors
OpenEnterprise Schema statstotalconnectattemptcount:integer
Total number of connection attempts (Dial-Up) statsuarterrorcount:integer
Number of other Uart-related errors (e.g. failing to open Serial Device) statsunknownerrorcount:integer
Count of various internal errors detected in rdi (diagnostic) usedisable:bool set to stop the RDI using this channel. Default false.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 580
rocchannelalarmcondition
Derived From:
Description:
To be completed
To be completed
Attributes: networkname:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 581
rocchannelset
OpenEnterprise Schema
Derived From:
Description:
Objectsextension_table
Used to group together a set of dial-up channels.
Attributes: drivername:char
To be completed internalflags:integer
For Internal CL use only nextid:integer
To be completed numberallocatedchannels:integer
Count of usable (not disabled) channels in the set
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 582
OpenEnterprise Schema numberavailablechannels:integer
Count of healthy channels in channelset. quantity:integer
To be completed setid:integer
Identifier Name that is set up by CL on create (using an auto-id). For example, ‘SET000003’.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 583
rocchannelsetalarmcondition
Derived From:
Description:
To be completed
To be completed
Attributes: name:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 584
rocchannelsetallocation
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
Used to cross reference between channels and sets
Attributes: accessarea:char
To be completed channelname:char reference to RocChannel_table disable:bool enables/disables use of this channel for this set. If Null, then defaulted to
False in the CL. internalflags:integer
Internal use by the CL only
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 585 setname:char reference to channelset_table
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 586
rocchanneltypes
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char name:char
To be completed
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 587
rocchartuserlistparameters
Derived From:
Description:
To be completed
To be completed
Attributes: charttype:integer
To be completed dynamicdatatlp:char
Dynamic point data TLP dynamicdatatlp_l:integer
To be completed dynamicdatatlp_p:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 588 dynamicdatatlp_t:integer
To be completed highscalevalue:float
User defined High Scale Value
OpenEnterprise Schema historypointnumber:integer
Standard or Extended history point number lowscalevalue:float
User defined Low Scale Value scalingoption:integer
Scaling option: 0=Auto, 1=User text:char text string units:char data units string
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 589
OpenEnterprise Schema
roccheckconfiguration
Derived From:
Description:
RocRequest_Table
Used by the Roc RDI to read some Roc system configuration data, and check that it is consistent with the OE database. A single entry in this table will be automatically created for each RocDevice. No additional entries are allowed.
Attributes: alarmstatus:integer
Offset 21 of the Roc Standard response backplanetype:integer
Offset 87 of the Roc Standard response commsportwhichreceivedrequest:integer
Offset 85 of the Roc Standard response
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 590
OpenEnterprise Schema customername:char
Offset 26 of the Roc Standard response fstpresent:integer
Offset 18 of the Roc Standard response logicalcompatibilitystatus:integer
Offset 10 of the Roc Plus response logicalpositions:char
The logical positions for each Point type. manualstatus:integer
Offset 20 of the Roc Standard response maxnumberofalarms:integer
The maximum number of alarms set for the Device. maxnumberofevents:integer
The maximum number of events set for the Device.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 591
OpenEnterprise Schema numberofhistorypoints0:integer
Offset 14 of the Roc Standard response numberofhistorypoints1:integer
Offset 15 of the Roc Standard response numberofhistorypoints2:integer
Offset 16 of the Roc Standard response numberoflogicalarms:integer
Offset 17 of the Roc Standard response numberofuseranalogvalues:integer
The number of user defined analog values in the Device. numberofuserdiscretevalues:integer
The number of user defined discrete values in the Device. numbersofpoints:char
List of point-types:numbers-of-points for that type, from various offsets of the Roc response
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 592 opcode6revision:integer
Offset 11 of the Roc Plus response
OpenEnterprise Schema operatingmode:integer
Offset 86 of the Roc Standard response rocdevicetype:char
The Roc Device Type. rocisplusprotocol:bool
Set to TRUE if the Device is Roc Plus Protocol. rocmdbtypeid:integer
The Type Id of the Roc Device. rocopcode6type:integer
Offset 24 of the Roc response rocspecifictype:integer
The specific Type of Roc Device.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 593 rocstationname:char
The name of the Roc Device.
OpenEnterprise Schema rocversion:float
The Roc version number. rocversionstring:char
A string signifying the Roc version number. securityaccessmode:integer
Offset 9 of the Roc Plus response systemmode:integer
Offset 6 of the Roc Plus response utilities:integer
Offset 19 of the Roc Standard response
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 594
rocdatatypes
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char bitnum:integer
To be completed
To be completed defaultfieldtype:char
To be completed length:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 595 name:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 596
rocdevice
OpenEnterprise Schema
Derived From:
Description: dvi_device
Each entry represents a Roc Device
Attributes: accessarea:char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. ackonreceiptofsrbx:bool
Ack SRBX if received (if not null, overrides default in the
RocDriver_Table). adddefaultsignals:bool
When set instructs the RDI to add default set of signals to Device on creation.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 597
OpenEnterprise Schema alarmcondition:alarmcondition_table
An array of alarm conditions referencing the alarmcondition table for this
Device. commsintermediatedevice:char
The device through which comms to this outstation is directed (via passthru or store-and-forward) commsnextdeviceidinqueue:char
DeviceId of next device in queue of devices waiting for comms resources commstimeinitiallyqueued:datetime
The time the device was placed on the queue commstimeinitiallyqueueddstoffset:integer
DST for comms time when on RDI internal queue. confignumdatums:integer
Used to keep the number of ‘dvi_datum’ entries attached to the device
(CL updates on add/delete/disable a datum entry). On registration, when this number have been successfully registered with the RDI, then the RDI sets the field RdiRegistrationComplete to TRUE. configurationmismatch:bool
Defaulted to TRUE. Set following an update configuration or check
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 598 configuration request.
OpenEnterprise Schema copiedfromdevice:char
If this Device was copied from another Device, specifies the original
Device that this Device was copied from. currentcommsroute:char
IP_PRIMARY,IP_SECONDARY,DIREAT_SERIAL or DIAL_UP currentcommsstatus:integer
CS_NONE=0,
CS_FAILED=0x01,
CS_OK=0x02,
CS_IN_USE=0x04,
CS_DISABLED=0x08,
CS_DIALUP_QUEUED=0x10 currentcommsstatustext:char
Text version of above datums:rocbasedatum_table
An array of datums referencing the rocbasedatum table for this Device.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 599 debugon:bool
OpenEnterprise Schema
Used to turn CL debugs on/off for this device entry. deletedpoints:char
Points that have been deleted after an update. description:char
An arbitrary description deviceid:char
Identifier Name that is set up by CL on create (using an auto-id). For example, ‘OS000003:RC’. display:char
A text attribute provided for the file name of any OEGraphics display that contains the ROC Driver. forcecommsroute:char
Force use of a particular comms route for diagnostic purposes
IP_PRIMARY,IP_SECONDARY,DIRECT_SERIAL or DIAL_UP, or nothing if none forced. historypoints:rochistorypoint_table
An array of Roc History Points referencing the rochistorypoints table for
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 600 this Device.
OpenEnterprise Schema hostaddress:integer
Host address to be used when communicating with this device (if NULL then use driver HostAddress) hostgroup:integer
Host group to be used when communicating with this device (if NULL then use driver HostGroup) importhistorypoints:bool
When set to TRUE the ROC RDI imports history points from the Device. infonumdatumsregistered:integer
The number of datums registered with the RDI for the Device. internalflags:integer
For Internal CL use only ipalternate:bool
Alternate between IP Primary and Secondary if the costs of the routes are the same. Default false.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 601
OpenEnterprise Schema logicalcompatibilitystatus:integer
Relevant for RocPlus Protocol only (read from Opcode 6, offset 10).
Used to specify 8 or 16 points per slot. logicalpositions:char
Logical positions for each point type. logicalpositionsmismatch:bool
Defaulted to FALSE. Set following a check configuration request logonaccesslevel:integer
The logon access level of the log on operator for the Device. logonoperatorid:char
The Id of the log on operator for the Device. logonpassword:char
The password of the log on operator for the Device. logonsendaccesslevel:bool
When set to TRUE the RDI will send the access level of the logon user to the Device.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 602
OpenEnterprise Schema maxnumberofalarms:integer
From the Roc device. Number of alarms in the Circular Roc Device
Alarm Buffer. maxnumberofevents:integer
From the Roc device. Number of alarms in the Circular Roc Device
Event Buffer. nextid:integer
Used by CL to create unique id numbers. numberofhistorypoints0:integer
The number of history points in segment 0 for the Device. numberofhistorypoints1:integer
The number of history points in segment 1 for the Device. numberofhistorypoints2:integer
The number of history points in segment 2 for the Device. numbersofpoints:char
Number of points for each type.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 603
OpenEnterprise Schema pendingtemplateversion:integer
The next Device Template version number. phonenumber:char
Dial-up phone-number (can include AT commands) (without the ‘AT’ – string is appended onto the ModemDialString in
RocPortParameters_table) plantarea:char
The plant area to which this object belongs. points:rocpoint_table
An array of Roc Points referencing the rocpoint table for this Device. quantity:integer
Used by CL to create unique id numbers. rdierrorcode:integer
Error code (updated on increment of RdiErrorCount). rdierrorcodeadditional:integer
Additional error code (updated on increment of RdiErrorCount).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 604
OpenEnterprise Schema rdierrorcodemessage:char
Error message (updated on increment of RdiErrorCount). rdierrorcodetext:char
Text description of error code. rdierrorcount:integer
Incremented to flag RDI reported errors. rdiregistrationcomplete:bool
Set when device fully registered on the ROC RDI. readfromfileinprogress:bool
Set to TRUE when the ROC RDI is reading from the specified ROC 800 file. retryonotherhealthycommsroutes:bool
If set to TRUE the RDI will attempt to establish a connection with the
Device using another healthy comms route. roc800file:char
The path and file name for a ROC 800 file that can be used to create this type of Device.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 605 rocaddress:integer
The Roc Address for the Device.
OpenEnterprise Schema rocdevicetype:char
The device type description. Set via CL from the RocMdbTypeId
(lookup from the RocTypes_Table field RocDescription). rocerrorcode:integer
Errorcode from Roc Errorcode reply (updated on increment of
RocErrorCodeCount). For details, refer to the Roc Protocol document rocerrorcodebyteoffset:integer
Byte offset from RocErrorcode reply (updated on increment of
RocErrorCodeCount). rocerrorcodecount:integer
Incremented on receipt of ROC errorcode reply rocerrorcodetext:char
Text description of Roc error code. rocerroropcode:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 606
OpenEnterprise Schema rocgroup:integer
The Roc Group to which the Device belongs. rocisplusprotocol:bool
Set for RocPlus protocol, otherwise RocStandard rocmdbtypeid:integer
Roc.mdb type id in table tRocTypes.RocTypeId field in the Oe
RocTypes_Table. rocopcode6type:integer
Roc type, (from the Roc device, Opcode 6 , offset 24 type) rocpointsmismatch:bool
Defaulted to FALSE. Set following a check configuration request rocspecifictype:integer
Additional type required for some standard roc types (where
RocOpcode6Type does not uniquely identify the RocMdbTypeId) rocstationname:char
StationName from the Roc device
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 607
OpenEnterprise Schema roctimesdstadjusted:bool
If set, then the timestamps read from the Roc device will be assumed to be DST adjusted, and the RDI will adjust to GMT prior to writing to the
Oe database. (If not null, overrides default in the RocDriver_Table) rocversion:float
Roc version (from device) eg 2.01 rocversionstring:char
A string describing the Roc version. selectedpoints:char
Points that have been selected by user in Roc Tools interface. storeandforwardaddress1:integer
Store and forward Address 1. storeandforwardaddress2:integer
Store and forward Address 2. storeandforwardaddress3:integer
Store and forward Address 3.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 608
OpenEnterprise Schema storeandforwardgroup1:integer
Store and forward Group1. storeandforwardgroup2:integer
Store and forward Group2. storeandforwardgroup3:integer
Store and forward Group3 templatechangedflags:integer
To be completed templatelastupdateoptionsflags:integer
To be completed templatelastupdatetime:datetime
The last time the Device Template (if used) was updated. templatename:char
If the Device was created from a Device Template, this is the name of the Device that was used as a Template.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 609
OpenEnterprise Schema templateoptionsflags:integer
To be completed templateupdatetrigger:bool
To be completed templateversion:integer
The current Device Template version number. timezone:char
Reference to timezones_table (if not null, overrides timezone in dvi_remote_driver table). Timezones can be configured to be different for different devices; but DST settings are assumed to be the same for all devices (based on the DST OE fields in dvi_remote_driver) timezoneoffset:integer
Timezone offset triggerupdatefromcheckconfiguration:bool
When set to TRUE, triggers a check configuration request to update the
Device. tryrequestevenifallroutesfailed:bool
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 610
OpenEnterprise Schema
If set to TRUE the Roc RDI will try a request even if all routes have already failed. updateconfigurationstatus:char
Set by the RDI. updatehistorypointwithalarmvalues:bool
Used to specify that the RDI should update HistoryValue in
RocHistoryPoint_Table (if entry exists for that TLP and ArchiveType is
‘current vaues’) on receipt of an alarm record. (If not null, overrides default in the RocDriver_Table) updatehistorypointwithcurrentvalues:bool
Used to specify that the RDI should update HistoryValue in
RocHistoryPoint_Table (if entry exists for that TLP and ArchiveType is
‘current vaues’) on receipt of a new Current Parameter Value. (If not null, overrides default in the RocDriver_Table) updaterocpointwithalarmvalues:bool
Used to specify that the RDI should update the relevant parameter in
RocPoint_Table with an AlarmValue on receipt of an alarm record. (If not null, overrides default in the RocDriver_Table). updaterocsignalwithalarmvalues:bool
Used to specify that the RDI should update AlarmValue in
RocRealAnalog_Table or RocDigital_Table (if entry exists for that TLP) on receipt of an alarm record. (If not null, overrides default in the
RocDriver_Table)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 611
OpenEnterprise Schema userdefinedpointtypemismatch:bool
Defaulted to FALSE. Set following a check configuration request
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 612
rocdevicealarmcondition
Derived From:
Description:
To be completed
To be completed
Attributes: commsroute:char
To be completed deviceid:char
To be completed devicename:char
To be completed request:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 613
OpenEnterprise Schema
rocdevicechannelcomms
Derived From:
Description:
RocDeviceCommsRoute_Table
Entries in this table define a serial comms route for a Device.
Attributes: channelset:char
Reference to ChannelSet table (used to define the group of channels to be used for DialUp comms to this device) channelsetid:integer
The SetId of the ChannelSet (set up by CL, and used by the RDI). portname:char
Port name (e.g. COM11) for DirectSerial statsframingerrorcount:integer
Number of framing errors
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 614
OpenEnterprise Schema statsgoodincomingcallcount:integer
Dialup channels only statsoverrunerrorcount:integer
Number of overrun errors statsparityerrorcount:integer
Number of parity errors statsuarterrorcount:integer
Number of other Uart-related errors (e.g. can’t open port)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 615
rocdevicecommsroute
Derived From:
Description:
OpenEnterprise Schema
RocBaseDatum_table
Entries in this table specify a Comms Route for a Single Device.
Attributes: commstype:char
Either IP_PRIMARY,I_SECONDARY,DIRECT_SERIAL,DIAL_UP connecttimeout:integer
(ms) Time to allow for IP connection establishment cost:integer
Cost of route, 1,2,3,4 (1 is lowest cost/preferred route) currentcommsroutestatus:integer
CS_NONE=0,
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 616
CS_FAILED=0x01,
OpenEnterprise Schema
CS_OK=0x02,
CS_IN_USE=0x04,
CS_DISABLED=0x08,
CS_DIALUP_QUEUED=0x10 currentcommsroutestatustext:char
Text version of above. messagedelaybetweenretries:integer
Delay in milliseconds before attempting retry. Default is 0. messagenumretries:integer
Number of retire to be performed of each Roc message. Default 1. messageresponsetimeout:integer
(ms) Time to allow for IP response message recoverymethod:char
Either (in all cases only if comms in failed state for this route)
IF_NO_LOWER_COST_ROUTE _HEALTHY (default).
ALWAYS
DEADLIST_TYPE (failed devices on a round-robin deadlist using dead-
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 617
OpenEnterprise Schema time on channel) Direct Serial route only. recoveryschedule:char
To be completed recoveryscheduleid:integer
ScheduleId of schedule used for Comms Recovery. sanitymethod:char
Either
NONE – no sanity check performed
ALWAYS – on every period
IF_NO_GOOD_COMMS_IN_PERIOD –(default) sanityschedule:char
To be completed sanityscheduleid:integer
ScheduleId of schedule used for Sanity Checks to device over this route statsavgconnecttimetaken:datetime
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 618
Average time taken to connect
OpenEnterprise Schema statsavgmessageresponsetimetaken:datetime
Average response time. statsavgsessionduration:datetime
Average session/call duration time since stats cleared statsbadconnectcount:integer
Number of failed connections or calls statsbadmessagecount:integer
Number of bad messages received on this route (unreliable due to the way a valid message is hunted). statsbadsessioncount:integer
To be completed statsconnectexcessivetimecount:integer
Number of connect timeouts. statscrcerrorcount:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 619
To be completed
OpenEnterprise Schema statsdiscardedcharactercount:integer
Number of discarded characters statsgoodconnectcount:integer
Number of good connections or calls statsgoodmessagecount:integer
Number of good messages received on this route. statsgoodsessioncount:integer
Number of good completed sessions/calls statsgoodunsolicitedmessagecount:integer
Number of good messages received on this route statslastattemptedcomms:datetime
Time of last attempted comms (on this route for this device – for all following stats) statslastattemptedcommsdstoffset:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 620
To be completed
OpenEnterprise Schema statslastconnecttimetaken:datetime
Time taken to connect (last attempt) statslastmessageresponsetimetaken:datetime
Time device to respond to last message (subject to Windows timing resolution, as are all following times) statslastsessionduration:datetime
Elapse time of last connection statslastsuccessfulcomms:datetime
Time of last successful comms on this route for this device statslastsuccessfulcommsdstoffset:integer
To be completed statsmaxconnecttimetaken:datetime
Longest time taken to connect. statsmaxmessageresponsetimetaken:datetime
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 621
Longest response time.
OpenEnterprise Schema statsmaxsessionduration:datetime
Longest session/call duration time since stats cleared statsmessagenumretriescount:integer
To be completed statsmessageresponsetimeoutcount:integer
Number of messages response timeouts statsminconnecttimetaken:datetime
Shortest time taken to connect. statsminmessageresponsetimetaken:datetime
Shortest response time since stats reset. statsminsessionduration:datetime
Shortest session/call duration time since stats cleared statstotalconnectattemptcount:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 622
Number of connect attempts
OpenEnterprise Schema statstotalconnects:integer
Total number of connects (used to calculate average) statstotalconnecttimetaken:datetime
Total connect time (used to calculate average) statstotalmessageresponses:integer
Number of responses used to calculate average) statstotalmessageresponsetimetaken:datetime
Total response time (used to calculate average) statstotalsessionduration:datetime
Total session time (used to calculate average, but useful anyway statstotalsessions:integer
Total Sessions statsunknownerrorcount:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 623
OpenEnterprise Schema
Diagnostic count of number of internal rdi errors. usedisable:bool
Disables this comms route for this device and any pass-thru/store-andforward devices using this device. Default is false.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 624
rocdeviceipcomms
OpenEnterprise Schema
Derived From:
Description:
RocDeviceCommsRoute_Table
Entries in this table define an IP connection route for a specific ROC
Device.
Attributes: closedelay:integer
See above. Default is 2000 (s) closewhennotused:bool
Tells the rdi to close/release the socket when not being used, after
‘CloseDelay’milliseconds of inactivity. Allows other utilities (e.g.
ROCLINK) to get in. Default is true. ipaddress:char
The IP address of the connection.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 625 ipport:char
OpenEnterprise Schema
A specific IP port that is used for the connection to this Device.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 626
rocdigital
OpenEnterprise Schema
Derived From: Digital_table
Description: Each entry represents a Value Parameter (specified TLP format) of a Roc
Point. These entries are required (in addition to the Roc Point) for
OpenEnterprise Reports, Historical logging and Calculations.
Attributes: alarmtimestamp:datetime
AlarmTimestamp from an Alarm record for this TLP (updated by the
RDI, optional on a per device basis) alarmtimestampdstoffset:integer
Offset applied to alarm timestamp when in Daylight Saving Time. alarmvalue:bool
AlarmValue from an Alarm record for this TLP (updated by the RDI, optional on a per device basis) archivebackfillgapmins:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 627
OpenEnterprise Schema
Use to attempt to ‘backfill’ a gap in current values (see overview section for details) archivetimestamp:datetime
History Timestamp from a Read History for this TLP (updated by the
RDI) archivetimestampdstoffset:integer
Offset applied to archive timestamp when in Daylight Saving Time. archivevalue:bool
History Value from a Read History for this TLP (updated by the RDI) archivevaluedisableupdate:bool
If TRUE, then ArchiveValue and ArchiveTimestamp not updated deviceid:char
The DeviceId field of the device logtime:datetime
Use for exception-driver historical logging of
ReadValue/ArchiveValue/AlarmValue
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 628 logtimedstoffset:integer
To be completed
OpenEnterprise Schema logtrigger:integer logtype:integer logvalue:bool
Use for exception-driver historical logging of
ReadValue/ArchiveValue/AlarmValue
Use for exception-driver historical logging of
ReadValue/ArchiveValue/AlarmValue
Use for exception-driver historical logging of
ReadValue/ArchiveValue/AlarmValue nameoverride:bool
To be completed parameternumber:integer
Roc ParameterNumber pointinalarm:bool
Planned to use to indicate if the RocPoint is in alarm. Details to be defined
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 629 pointnumber:integer
Roc PointNumber pointtype:integer pushvalue:bool
Roc PointType
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 630
rocdriver
Derived From:
Description: dvi_remote_driver
The table specific to ROC drivers.
OpenEnterprise Schema
Attributes: accessarea:char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. alarmcondition:alarmcondition_table
Foreign key reference to the alarmcondition table. ccnum:integer
Rdi entry number. Required on create, and must be unique. commsfirstdeviceidinqueue:char
The deviceid of the first device on the queue waiting for comms.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 631
OpenEnterprise Schema commsqueuethrottlingperiodsecs:integer
Number of seconds that devices are allowed to be held on a queue waiting for comms. If this period is exceeded, the outstanding requests for this devices are completed with an error code. A value of 0 disables the checking. Default is 1200. confignumtoregisterforstartup:integer
Used to keep the number of ‘dvi_network’ entries attached to the driver
(CL updates on add/delete/disable a network entry). On registration, when this number have been successfully registered with the RDI, then the RDI sets the field RdiStartupComplete to TRUE. defaultackonreceiptofsrbx:bool
Default for devices (can be overridden for each device) defaulthostaddress:integer
Default for devices (can be overridden for each device) defaulthostgroup:integer
Default for devices (can be overridden for each device) defaultlogonaccesslevel:integer
Default for devices (can be overridden for each device)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 632
OpenEnterprise Schema defaultlogonoperatorid:char
Default for devices (can be overridden for each device) defaultlogonpassword:char
Default for devices (can be overridden for each device) (encrypted) defaultroctimesdstadjusted:bool
Default for devices (can be overridden for each device) defaultupdatehistorypointwithalarmvalues:bool
Default for devices (can be overridden for each device) defaultupdatehistorypointwithcurrentvalues:bool
Default for devices (can be overridden for each device) defaultupdaterocpointwithalarmvalues:bool
Default for devices (can be overridden for each device) defaultupdaterocsignalwithalarmvalues:bool
Default for devices (can be overridden for each device)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 633 description:char
Arbitrary description
OpenEnterprise Schema display:char
A text attribute provided for the file name of any OEGraphics display that contains the ROC Driver. heapcheckingon:bool
Diagnostic facility to increase chances of trapping a heap corruption within the rdi process. Only works with ‘debug’ executable, and should not be used in normal operation. Default is false. infonumchannelregistered:integer
Diagnostic: number of RocChannel entries registered with rdi infonumothernetworkregistered:integer
Diagnostic: number of other entries registered with rdi (should be the 2
RocNetwork entries) infonumportparametersregistered:integer
Diagnostic: number of RocPortParameters entries registered with rdi internalflags:integer
Internal CL use only
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 634
OpenEnterprise Schema numrocalarmlog:integer
Shared field. Specifies the number of entries in RocAlarmLog_Table to be auto-created. numrocerrorcodelog:integer
Shared field. Specifies the number of entries in
RocErrorCodeLog_Table to be auto-created. numroceventlog:integer
Shared field. Specifies the number of entries in RocEventLog_Table to be auto-created. numrochistorylog:integer
Shared field. Specifies the number of entries in RocHistoryLog_Table to be auto-created. plantarea:char
The plant area to which this object belongs. rdierrorcode:integer
Error code (updated on increment of RdiErrorCount) rdierrorcodeadditional:integer
Additional error code (updated on increment of RdiErrorCount)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 635
OpenEnterprise Schema rdierrorcodemessage:char
Error message (updated on increment of RdiErrorCount) rdierrorcodetext:char
Text description of error code rdierrorcount:integer
Incremented to flag an rdi error rdilogcloseafterupdate:bool
Diagnostic option which if set true will cause the rdi to close the log file after every write to it. Default is false (recommended for normal operation) rdilogdebuglevel:integer
Governs the amount of debug information stored in the rdi log files.Loqest is 1, highest is 10. Default is 5 (recommended) rdilogdirectory:char
The directory where the rdi log files are written. Default is ‘rdilog’ rdirequestdiagnosticdump:integer
Set this manually to cause rdi to dump its diagnostic display buffers to
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 636
OpenEnterprise Schema disk. Set to a ‘port number’ to dump an individual port file, or 255 to dump all windows RDI resets it back to 0. rdistartupcomplete:bool
Set by rdi when it has completed initialization (ie all datums registered).
Prior to this, CL will abort any requests. rdithreadwatchdogcheckseconds:integer
Frequency of watchdog thread in rdi, checking normal operation.
Default is 60. Value of 0 switches off check. socketmonitoringon:bool
Diagnostic facility that enables a snapshot summary of GDIP protocol messages in comms to/from the rtrdb. Default false. telnetlisteningport:char
Service on which the rdi listens for Telnet debug connections. Default is
‘roctelnet’. Empty string disables.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 637
rocdriveralarmcondition
Derived From:
Description:
To be completed
To be completed
Attributes: drivername:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 638
rocds800configuration
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: cleanstoredresources:integer
Setting this parameter to '1' removes all stored resources from file system. This does NOT stop resources that may be running, but running resources will not be reloaded when the Power Switch is toggled cleards800kernel:integer
To be completed etcpenable:integer
Enables/Disables the DS800 TCP/IP task. Changes to this parameter take affect when DS800 is stopped and started again.
0 - Disable
1 - Enable
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 639
OpenEnterprise Schema etcprunning:integer
Indicates whether the DS800 TCP/IP task is currently running.
0 - Not running.
1 - Running. ixdenable:integer
Enables/Disables the DS800 IXD task. Changes to this parameter take affect when DS800 is stopped and started again.
0 - Disable
1 - Enable ixdrunning:integer
Indicates whether or not the DS800 IXD task is currently running.
0 - Not running.
1 - Running. kernelstatus:integer
Kernel Status:
0=Not Loaded, Not Running
1=Loaded, Not Enabled
2=Loaded, No License
3=Loaded, Running Normal
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 640 powerswitch:integer
To be completed programdatetimestamp:datetime
To be completed programdatetimestampdstoffset:integer
To be completed
OpenEnterprise Schema programdescription:char
To be completed programversionstring:char
To be completed resource1currentcycletime:integer
The current cycle time for the resource in milliseconds. resource1name:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 641
OpenEnterprise Schema resource1programmedcycletime:integer
The defined cycle time for the resource in milliseconds. resource1status:integer
-1 - Fatal error
0 - No Resource available
1 - Stored resource available
2 - Ready to run
3 - Run in Real time
4 - Run in Cycle by cycle
5 - Run with Breakpoint encountered (Not Supported) resource2currentcycletime:integer
The current cycle time for the resource in milliseconds. resource2name:char
Name defined for the resource. resource2programmedcycletime:integer
The defined cycle time for the resource in milliseconds. resource2status:integer
-1 - Fatal error
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 642
0 - No Resource available
OpenEnterprise Schema
1 - Stored resource available
2 - Ready to run
3 - Run in Real time
4 - Run in Cycle by cycle
5 - Run with Breakpoint encountered (Not Supported) resource3currentcycletime:integer
The current cycle time for the resource in milliseconds. resource3name:char
To be completed resource3programmedcycletime:integer
The defined cycle time for the resource in milliseconds. resource3status:integer
-1 - Fatal error
0 - No Resource available
1 - Stored resource available
2 - Ready to run
3 - Run in Real time
4 - Run in Cycle by cycle
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 643
OpenEnterprise Schema
5 - Run with Breakpoint encountered (Not Supported) resource4currentcycletime:integer
The current cycle time for the resource in milliseconds. resource4name:char
Name defined for the resource. resource4programmedcycletime:integer
The defined cycle time for the resource in milliseconds. resource4status:integer
-1 - Fatal error rsienable:integer
0 - No Resource available
1 - Stored resource available
2 - Ready to run
3 - Run in Real time
4 - Run in Cycle by cycle
5 - Run with Breakpoint encountered (Not Supported)
Enables/Disables the DS800 serial task. Changes to this parameter take affect when DS800 is stopped and started again.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 644
0 - Disable
OpenEnterprise Schema
1 - Enable rsirunning:integer
Indicates whether the DS800 serial task is currently running.
0 - Not running.
1 - Running.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 645
OpenEnterprise Schema
rocenhancedcommmoduleconfiguration
Derived From:
Description:
To be completed
To be completed
Attributes: currentmodbusconnections:integer
This parameter shows the number of active modbus TCP/IP connections. gatewayaddress:char
To be completed ipaddress:char
To be completed macaddress:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 646
OpenEnterprise Schema modbusinactivitytime:float
Time, in seconds, that the ROC809 will wait, without receiving a valid modbus message, before it closes the connection.
0 disables. Occurs in the Application Layer. modbusipportnumber:integer
The IP port number that the ROC will listen on for modbus connections. modbuskeepalivetime:integer
Specifies the amount of idle time (in seconds) before the first keep-alive message is sent for the modbus connection. Nine more keep-alive messages will be sent at an interval of 64 seconds before a connection is considered broken. Occurs in the Transport Layer.
0 disables modbusovertcpaddresstouse:integer
Selects which address (roc address or modbus over IP slave address) modbus over IP should use.
0 = Roc Address (TLP: 91,0,0)
1 = Modbus over IP Slave Address (TLP: 138,0,15)
2 = Either Roc Address or Modbus TCP Address modbusovertcpslaveaddress:integer
Specifies the Slave Address for Modbus over IP
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 647
OpenEnterprise Schema numactiverocprotocolconnections:integer
This parameter shows the number of active Roc Protocol TCP/IP connections. (NOTE: Not available until release 1.1) resetmodbusconnections:integer
Writing a 1 to this parameter will close all modbus TCP/IP connections. resetrocprotocolconnections:integer
Writing a 1 to this parameter will close all Roc Protocol TCP/IP connections. (NOTE: Not available until release 1.1) rocprotocolinactivitytime:float
Time in seconds that the ROC809 will wait, without receiving a valid message, before it closes the connection.
0 disables. (NOTE: Not available until release 1.1) rocprotocolipportnumber:integer
The IP port number the ROC will listen on for Roc Protocol connections.
(NOTE: Not available until release 1.1) rocprotocolkeepalivetime:integer
Time in seconds between each periodic transmission of a message
(probes). (NOTE: Not available until release 1.1) subnetmask:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 648
rocenumeratedvaluedescriptions
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char dojournal:bool id:integer nextid:integer
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 649 numvalues:integer
To be completed oefieldname:char
To be completed oetablename:char
To be completed quantity:integer
To be completed stringvalue:char type:char value:float
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 650 valuedescription:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 651
rocenumeratedvaluedescriptions2
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: oefieldname2:char
To be completed oetablename2:char
To be completed stringvalue2:char
To be completed value2:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 652
rocenumeratedvaluedescriptions3
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: oefieldname3:char
To be completed oetablename3:char
To be completed stringvalue3:char
To be completed value3:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 653
rocerrorcodelog
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char deviceid:char
To be completed
To be completed devicename:char
To be completed lastlogindex:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 654 name:char
To be completed rocerrorcode:integer
To be completed rocerrorcodebyteoffset:integer
To be completed rocerrorcodetext:char
To be completed rocerrorcodetrigger:integer
To be completed rocerroropcode:integer
To be completed rxtimestamp:datetime
To be completed rxtimestampdstoffset:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 655
roceventlog
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char
To be completed currenteventindex:integer
To be completed deviceid:char
To be completed devicename:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 656 eventcalibrationtype:integer
To be completed eventcodedescription:char
To be completed eventdatatype:integer
To be completed eventdescription:char
To be completed eventindex:integer
To be completed eventlogcode:integer
To be completed eventlogdescription:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 657 eventlogtype:integer
To be completed eventmessagetime:datetime
To be completed eventmessagetimedstoffset:integer
To be completed eventoldvalue:float
To be completed eventoperatorid:char
To be completed eventparamabbrev:char
To be completed eventparamdescription:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 658 eventpointtypeabbrev:char
To be completed eventtime:datetime
To be completed eventtimedstoffset:integer
To be completed eventtimeraw:integer
To be completed eventtlp:char
To be completed eventtlp_l:integer
To be completed eventtlp_p:integer
To be completed eventtlp_t:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 659
To be completed eventvalue:float
To be completed lastlogindex:integer
To be completed name:char
To be completed neweventtrigger:integer
To be completed oldvalue:char
To be completed rocisplusprotocol:bool
To be completed rxtimestamp:datetime
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 660
To be completed rxtimestampdstoffset:integer
To be completed type:char
To be completed value:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 661
rocexpandedioinformation
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: boardhealth:integer
Indicates the health of the board.
0: Board is OK
1: Communications to board has been lost. bootpartnumber:char
Part number of boot firmware bootversion:char
Software Version of Boot Image
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 662 flashpartnumber:char
Flash number of boot firmware
OpenEnterprise Schema flashversion:char
Software Version of Flash Image installedactive:integer
State whether or not the backplane is physically installed and running following a startup.
0: Not Connected
1: Connected module12v:float
Voltage at the modules in volts. moduleincoming12v:float
Incoming voltage to board in volts. moduleslotsaddressable:integer
Based on the 8/16 points per slot. Indicates the number of slots for board that are available.
0: No Modules available
1 – 6: Actual number of slots available
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 663
OpenEnterprise Schema
Ex. 5. This would indicate that slots 1 – 5 are available. Slot 6 is not. onboardtemperature:float
Temperature of the board in ËšC. systemmode:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 664
rochartparameters
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: analogmode:integer
Analog Input: 0:Disabled 1:Enabled 3:Calibration – EU Value not longer updates and freezes at this value. 4:Cancel Calibration (restore previous calbiration) Analog Output: 0:Disabled 1:Enabled (Auto) 2:Manual autovalue:float
The EU value used as an output when Scanning is in auto mode. cabribrationlivevalue:float
The manual value copied to the EU Value if the Analog Mode is set to
Manual. Also used in calibration as the real-time value. (AI Mode)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 665 channelio:integer
OpenEnterprise Schema
Indicates if a channel is an analog input or output. 0 = Input, 1 = Output channelversion:char
To be completed device1activealarms:integer
Active alarms reported by device 1. device1actualscanperiod:float
Period at which device 1 is being updated. device1currentma:float
Current in milliamps reported by device 1. device1dampingvalue:float
Device 1 damping value. device1descriptor:char
Device 1 descriptor. device1failsafeonresetenable:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 666
OpenEnterprise Schema
Enable the use of fail safe values for the dynamic variables when the unit is reset for device 1. device1fv:float
Value of fourth variable of device 1. device1fvfailsafeonresetvalue:float
Fourth fail safe on reset value of device 1. device1fvunits:integer
Units code for fourth variable reported by device 1. device1idnumber:integer
Device 1 ID number. device1loweroutputlimit:float
Device 1 lower output limit. device1lowersensorlimit:float
Device 1 lower sensor limit. device1manufacturesidanddeviceid:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 667
OpenEnterprise Schema
Device 1 manufacture's ID and device's ID device1message:char
Device 1 message. device1minimumspan:float
Device 1 minimum sensor span. device1outputunits:integer
Device 1 Output Units device1percentofrange:float
Percent of range reported by device 1. device1pollingaddress:integer
Polling address for device 1. device1pollmode:integer
Polling mode for device 1. 0 = Skip This Device, 1 = Primary Variable
Only, 2 = All Dynamic Variables, 3 = All Slot Variables, 4 = Full Update,
5 = Pass Thru device1pv:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 668
OpenEnterprise Schema
Value of primary variable of device 1. device1pvfailsafeonresetvalue:float
Primary fail safe on reset value for device 1. device1pvunits:integer
Units code for primary variable reported by device 1. device1responsecodestatus:integer
Response code and status received from device 1. device1sensorunits:integer
Device 1 sensor units. device1serialnumber:integer
Device 1 serial number. device1slot0assignment:integer
Slot 0 variable to request from device 1. device1slot0units:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 669
OpenEnterprise Schema
Units of slot 0 variable requested from device 1. device1slot0variable:float
Value of slot 0 variable requested from device 1. device1slot1assignment:integer
Slot 1 variable to request from device 1. device1slot1units:integer
Units of slot 1 variable requested from device 1. device1slot1variable:float
Value of slot 1 variable requested from device 1. device1slot2assignment:integer
Slot 2 variable to request from device 1. device1slot2units:integer
Units of slot 2 variable requested from device 1. device1slot2variable:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 670
OpenEnterprise Schema
Value of slot 2 variable requested from device 1. device1slot3assignment:integer
Slot 3 variable to request from device 1. device1slot3units:integer
Units of slot 3 variable requested from device 1. device1slot3variable:float
Value of slot 3 variable requested from device 1. device1status:integer
Communication status of device 1. device1sv:float
Value of secondary variable of device 1. device1svfailsafeonresetvalue:float
Secondary fail safe on reset value for device 1. device1svunits:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 671
OpenEnterprise Schema
Units code for secondary variable reported by device 1. device1tag:char
Tag that resides in device 1. device1tv:float
Value of tertiary variable of device 1. device1tvfailsafeonresetvalue:float
Tertiary fail safe on reset value for device 1. device1tvunits:integer
Units code for tertiary variable reported by device 1. device1upperoutputlimit:float
Device 1 upper output limit. device1uppersensorlimit:float
Device 1 upper sensor limit. device2activealarms:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 672
Active alarms reported by device 2.
OpenEnterprise Schema device2actualscanperiod:float
Period at which device 2 is being updated. device2currentma:float
Current in milliamps reported by device 2. device2dampingvalue:float
Device 2 damping value. device2descriptor:char
Device 2 descriptor. device2failsafeonresetenable:integer
Enable the use of fail safe values for the dynamic variables when the unit is reset for device 2. device2fv:float
Value of fourth variable of device 2. device2fvfailsafeonresetvalue:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 673
OpenEnterprise Schema
Fourth fail safe on reset value of device 2. device2fvunits:integer
Units code for fourth variable reported by device 2. device2idnumber:integer
Device 2 ID number. device2loweroutputlimit:float
Device 2 lower output limit. device2lowersensorlimit:float
Device 2 lower sensor limit. device2manufacturesidanddeviceid:integer
Device 2 manufacture's ID and device's ID device2message:char
Device 2 message. device2minimumspan:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 674
Device 2 minimum sensor span.
OpenEnterprise Schema device2outputunits:integer
Device 2 Output Units device2percentofrange:float
Percent of range reported by device 2. device2pollingaddress:integer
Polling address for device 2. device2pollmode:integer
Polling mode for device 2. 0 = Skip This Device, 1 = Primary Variable
Only, 2 = All Dynamic Variables, 3 = All Slot Variables, 4 = Full Update,
5 = Pass Thru device2pv:float
Value of primary variable of device 2. device2pvfailsafeonresetvalue:float
Primary fail safe on reset value for device 2. device2pvunits:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 675
OpenEnterprise Schema
Units code for primary variable reported by device 2. device2responsecodestatus:integer
Response code and status received from device 2. device2sensorunits:integer
Device 2 sensor units. device2serialnumber:integer
Device 2 serial number. device2slot0assignment:integer
Slot 0 variable to request from device 2. device2slot0units:integer
Units of slot 0 variable requested from device 2. device2slot0variable:float
Value of slot 0 variable requested from device 2. device2slot1assignment:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 676
OpenEnterprise Schema
Slot 1 variable to request from device 2. device2slot1units:integer
Units of slot 1 variable requested from device 2. device2slot1variable:float
Value of slot 1 variable requested from device 2. device2slot2assignment:integer
Slot 2 variable to request from device 2. device2slot2units:integer
Units of slot 2 variable requested from device 2. device2slot2variable:float
Value of slot 2 variable requested from device 2. device2slot3assignment:integer
Slot 3 variable to request from device 2. device2slot3units:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 677
OpenEnterprise Schema
Units of slot 3 variable requested from device 2. device2slot3variable:float
Value of slot 3 variable requested from device 2. device2status:integer
Communication status of device 2. device2sv:float
Value of secondary variable of device 2. device2svfailsafeonresetvalue:float
Secondary fail safe on reset value for device 2. device2svunits:integer
Units code for secondary variable reported by device 2. device2tag:char device2tv:float
Tag that resides in device 2.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 678
OpenEnterprise Schema
Value of tertiary variable of device 2. device2tvfailsafeonresetvalue:float
Tertiary fail safe on reset value for device 2. device2tvunits:integer
Units code for tertiary variable reported by device 2. device2upperoutputlimit:float
Device 2 upper output limit. device2uppersensorlimit:float
Device 2 upper sensor limit. device3activealarms:integer
Active alarms reported by device 3. device3actualscanperiod:float
Period at which device 3 is being updated. device3currentma:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 679
OpenEnterprise Schema
Current in milliamps reported by device 3. device3dampingvalue:float
Device 3 damping value. device3descriptor:char
Device 3 descriptor. device3failsafeonresetenable:integer
Enable the use of fail safe values for the dynamic variables when the unit is reset for device 3. device3fv:float
Value of fourth variable of device 3. device3fvfailsafeonresetvalue:float
Fourth fail safe on reset value of device 3. device3fvunits:integer
Units code for fourth variable reported by device 3. device3idnumber:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 680
Device 3 ID number.
OpenEnterprise Schema device3loweroutputlimit:float
Device 3 lower output limit. device3lowersensorlimit:float
Device 3 lower sensor limit. device3manufacturesidanddeviceid:integer
Device 3 manufacture's ID and device's ID device3message:char
Device 3 message. device3minimumspan:float
Device 3 minimum sensor span. device3outputunits:integer
Device 3 Output Units device3percentofrange:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 681
OpenEnterprise Schema
Percent of range reported by device 3. device3pollingaddress:integer
Polling address for device 3. device3pollmode:integer
Polling mode for device 3. 0 = Skip This Device, 1 = Primary Variable
Only, 2 = All Dynamic Variables, 3 = All Slot Variables, 4 = Full Update,
5 = Pass Thru device3pv:float
Value of primary variable of device 3. device3pvfailsafeonresetvalue:float
Primary fail safe on reset value for device 3. device3pvunits:integer
Units code for primary variable reported by device 3. device3responsecodestatus:integer
Response code and status received from device 3. device3sensorunits:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 682
Device 3 sensor units.
OpenEnterprise Schema device3serialnumber:integer
Device 3 serial number. device3slot0assignment:integer
Slot 0 variable to request from device 3. device3slot0units:integer
Units of slot 0 variable requested from device 3. device3slot0variable:float
Value of slot 0 variable requested from device 3. device3slot1assignment:integer
Slot 1 variable to request from device 3. device3slot1units:integer
Units of slot 1 variable requested from device 3. device3slot1variable:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 683
OpenEnterprise Schema
Value of slot 1 variable requested from device 3. device3slot2assignment:integer
Slot 2 variable to request from device 3. device3slot2units:integer
Units of slot 2 variable requested from device 3. device3slot2variable:float
Value of slot 2 variable requested from device 3. device3slot3assignment:integer
Slot 3 variable to request from device 3. device3slot3units:integer
Units of slot 3 variable requested from device 3. device3slot3variable:float
Value of slot 3 variable requested from device 3. device3status:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 684
Communication status of device 3.
OpenEnterprise Schema device3sv:float
Value of secondary variable of device 3. device3svfailsafeonresetvalue:float
Secondary fail safe on reset value for device 3. device3svunits:integer
Units code for secondary variable reported by device 3. device3tag:char
Tag that resides in device 3. device3tv:float
Value of tertiary variable of device 3. device3tvfailsafeonresetvalue:float
Tertiary fail safe on reset value for device 3. device3tvunits:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 685
OpenEnterprise Schema
Units code for tertiary variable reported by device 3. device3upperoutputlimit:float
Device 3 upper output limit. device3uppersensorlimit:float
Device 3 upper sensor limit. device4activealarms:integer
Active alarms reported by device 4. device4actualscanperiod:float
Period at which device 4 is being updated. device4currentma:float
Current in milliamps reported by device 4. device4dampingvalue:float
Device 4 damping value. device4descriptor:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 686
Device 4 descriptor.
OpenEnterprise Schema device4failsafeonresetenable:integer
Enable the use of fail safe values for the dynamic variables when the unit is reset for device 4. device4fv:float
Value of fourth variable of device 4. device4fvfailsafeonresetvalue:float
Fourth fail safe on reset value of device 4. device4fvunits:integer
Units code for fourth variable reported by device 4. device4idnumber:integer
Device 4 ID number. device4loweroutputlimit:float
Device 4 lower output limit. device4lowersensorlimit:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 687
Device 4 lower sensor limit.
OpenEnterprise Schema device4manufacturesidanddeviceid:integer
Device 4 manufacture's ID and device's ID device4message:char
Device 4 message. device4minimumspan:float
Device 4 minimum sensor span. device4outputunits:integer
Device 4 Output Units device4percentofrange:float
Percent of range reported by device 4. device4pollingaddress:integer
Polling address for device 4. device4pollmode:integer
Polling mode for device 4. 0 = Skip This Device, 1 = Primary Variable
Only, 2 = All Dynamic Variables, 3 = All Slot Variables, 4 = Full Update,
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 688
5 = Pass Thru
OpenEnterprise Schema device4pv:float
Value of primary variable of device 4. device4pvfailsafeonresetvalue:float
Primary fail safe on reset value for device 4. device4pvunits:integer
Units code for primary variable reported by device 4. device4responsecodestatus:integer
Response code and status received from device 4. device4sensorunits:integer
Device 4 sensor units. device4serialnumber:integer
Device 4 serial number. device4slot0assignment:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 689
OpenEnterprise Schema
Slot 0 variable to request from device 4. device4slot0units:integer
Units of slot 0 variable requested from device 4. device4slot0variable:float
Value of slot 0 variable requested from device 4. device4slot1assignment:integer
Slot 1 variable to request from device 4. device4slot1units:integer
Units of slot 1 variable requested from device 4. device4slot1variable:float
Value of slot 1 variable requested from device 4. device4slot2assignment:integer
Slot 2 variable to request from device 4. device4slot2units:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 690
OpenEnterprise Schema
Units of slot 2 variable requested from device 4. device4slot2variable:float
Value of slot 2 variable requested from device 4. device4slot3assignment:integer
Slot 3 variable to request from device 4. device4slot3units:integer
Units of slot 3 variable requested from device 4. device4slot3variable:float
Value of slot 3 variable requested from device 4. device4status:integer
Communication status of device 4. device4sv:float
Value of secondary variable of device 4. device4svfailsafeonresetvalue:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 691
OpenEnterprise Schema
Secondary fail safe on reset value for device 4. device4svunits:integer
Units code for secondary variable reported by device 4. device4tag:char
Tag that resides in device 4. device4tv:float
Value of tertiary variable of device 4. device4tvfailsafeonresetvalue:float
Tertiary fail safe on reset value for device 4. device4tvunits:integer
Units code for tertiary variable reported by device 4. device4upperoutputlimit:float
Device 4 upper output limit. device4uppersensorlimit:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 692
Device 4 upper sensor limit.
OpenEnterprise Schema device5activealarms:integer
Active alarms reported by device 5. device5actualscanperiod:float
Period at which device 5 is being updated. device5currentma:float
Current in milliamps reported by device 5. device5dampingvalue:float
Device 5 damping value. device5descriptor:char
Device 5 descriptor. device5failsafeonresetenable:integer
Enable the use of fail safe values for the dynamic variables when the unit is reset for device 5. device5fv:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 693
Value of fourth variable of device 5.
OpenEnterprise Schema device5fvfailsafeonresetvalue:float
Fourth fail safe on reset value of device 5. device5fvunits:integer
Units code for fourth variable reported by device 5. device5idnumber:integer
Device 5 ID number. device5loweroutputlimit:float
Device 5 lower output limit. device5lowersensorlimit:float
Device 5 lower sensor limit. device5manufacturesidanddeviceid:integer
Device 5 manufacture's ID and device's ID device5message:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 694
Device 5 message.
OpenEnterprise Schema device5minimumspan:float
Device 5 minimum sensor span. device5outputunits:integer
Device 5 Output Units device5percentofrange:float
Percent of range reported by device 5. device5pollingaddress:integer
Polling address for device 5. device5pollmode:integer
Polling mode for device 5. 0 = Skip This Device, 1 = Primary Variable
Only, 2 = All Dynamic Variables, 3 = All Slot Variables, 4 = Full Update,
5 = Pass Thru device5pv:float
Value of primary variable of device 5. device5pvfailsafeonresetvalue:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 695
OpenEnterprise Schema
Primary fail safe on reset value for device 5. device5pvunits:integer
Units code for primary variable reported by device 5. device5responsecodestatus:integer
Response code and status received from device 5. device5sensorunits:integer
Device 5 sensor units. device5serialnumber:integer
Device 5 serial number. device5slot0assignment:integer
Slot 0 variable to request from device 5. device5slot0units:integer
Units of slot 0 variable requested from device 5. device5slot0variable:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 696
OpenEnterprise Schema
Value of slot 0 variable requested from device 5. device5slot1assignment:integer
Slot 1 variable to request from device 5. device5slot1units:integer
Units of slot 1 variable requested from device 5. device5slot1variable:float
Value of slot 1 variable requested from device 5. device5slot2assignment:integer
Slot 2 variable to request from device 5. device5slot2units:integer
Units of slot 2 variable requested from device 5. device5slot2variable:float
Value of slot 2 variable requested from device 5. device5slot3assignment:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 697
OpenEnterprise Schema
Slot 3 variable to request from device 5. device5slot3units:integer
Units of slot 3 variable requested from device 5. device5slot3variable:float
Value of slot 3 variable requested from device 5. device5status:integer
Communication status of device 5. device5sv:float
Value of secondary variable of device 5. device5svfailsafeonresetvalue:float
Secondary fail safe on reset value for device 5. device5svunits:integer
Units code for secondary variable reported by device 5. device5tag:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 698
Tag that resides in device 5.
OpenEnterprise Schema device5tv:float
Value of tertiary variable of device 5. device5tvfailsafeonresetvalue:float
Tertiary fail safe on reset value for device 5. device5tvunits:integer
Units code for tertiary variable reported by device 5. device5upperoutputlimit:float
Device 5 upper output limit. device5uppersensorlimit:float
Device 5 upper sensor limit. eucalibrationvaluespan:float
EU calibration span value. eucalibrationvaluezero:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 699
EU calibration zero value.
OpenEnterprise Schema eurawcalibrationspan:integer
Raw calibration span value. eurawcalibrationzero:integer
Raw calibration zero value. eurawvalue:integer
Raw EU value of analog input or output euvalue:float
EU value of analog input or output failsafeonreset:integer
0 = Use last EU Value on reset1 = Use Failsafe value on ResetIf enabled (1), the raw D/A Output will be set to the Failsafe value on a restart of any kind. If disabled, the last EU Value or the last saved EU failsafevalue:float
This is the value that will be outputted when the unit is started and the
Failsafe on Reset Parameter is set to 1, Use Failsafe value on reset.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 700
OpenEnterprise Schema hartcommunicationmode:integer
If disabled, all HART communication stops and no changes will occur unless manually entered. 0 = Disabled, 1 = Point to Point, 2 = Multidrop hartcommunicationstatus:integer
0:Not Scanning 1:Scanning 2:Dual Master 3:Pass thru manualvalue:float
The EU value used as an output when Scanning is in manual mode. numberofdevicesconnected:integer
Number of devices connected in multidrop mode. physicalrawdaoutput:integer
Calculated Digital-to-Analog value based upon The EU value that is currently being outputed EU Value. physicalvalue:float
Indicates the current value of the output in Engineering Units. rocprotocolpassthruenable:integer
Enables ROC protocol pass thru communication. 0 = Disabled, 1 =
Enabled 0: Disable 1: Strip all bytes, including preambles, before message
2: Don’t alter the message, return all bytes.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 701
OpenEnterprise Schema rocprotocolpassthrutimeout:integer
Timeout in milliseconds to resume polling of HART device after receiving
ROC protocol pass thru communication.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 702
rochistorylog
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char
To be completed archivetype:integer
To be completed averagingorratetype:integer
To be completed deviceid:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 703 devicename:char
To be completed historylogpoint:char
To be completed historytimestamp:datetime
To be completed historytimestampdstoffset:integer
To be completed historyvalue:float
To be completed historyvaluetype:integer
To be completed lastlogindex:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 704 name:char pointtagid:char
To be completed newhistorytrigger:integer
To be completed parameterdescription:char
To be completed
To be completed rxtimestamp:datetime
To be completed rxtimestampdstoffset:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 705
rochistorypoint
OpenEnterprise Schema
Derived From:
Description: dvi_datum
Base history-point table used for Plus and Standard History points
Attributes: accessarea:char
The access area to which this object belongs. Used with security enabled views to restrict access to objects for unauthorised users. archivetype:integer
Plus: defined in history segment point config (types 125-135).
Standard: Roc Parameter 1 (point-type 19) or relevant ‘Extended
History Archive Type’ parameter (point-type 86) averagingorratetype:integer
The averaging or rate type of the history point. deviceid:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 706
OpenEnterprise Schema
The Id of the Device to which the history point belongs. historylogpoint:char
TLP of point being historised historylogpoint_l:integer
LogicalPosition from TLP historylogpoint_p:integer
ParameterNumber from TLP historylogpoint_t:integer
PointType from TLP historypointnumber:integer
The history point number historypointtype:integer
Plus: Point type 125 to 135, depending on the segment. Standard:
PointType=19 or PointType=86 (‘extended’ points) historyramarea:integer
Plus: this is the segment number 0 to 11. Standard: this is the Ram area
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 707
OpenEnterprise Schema
(for device types with ‘extended’ history, 0 = ‘normal’ history, 1 =
‘extended’ history) historytimestamp:datetime
HistoryTimestamp from Roc device historytimestampdstoffset:integer
The DST offset to be applied to the historytimestamp historyvalue:float
The HistoryValue of the ROC History Point. If this value is sourced from the ROC device, the source attribute is set to 0 (zero). If the current
HistoryValue has been modified using the History Editor, the source attribute is set to 1. historyvaluedeleted:bool
For internal use only.This value will always be FALSE in this, the source table of the configured OpenEnterprise historical stream which can be configured using the Historian configuration tool. Used by the ROC
History Editor to mark a historical sample as deleted.
If the HistoryValueDeleted attribute is not present in the historical stream, records can still be edited but all ‘delete’ functionality will be disabled in the Editor. historyvaluetype:integer
This is a ROC specific bitmask and identifies the type of data being logged (daily, minute or periodic). The following bits identify the data type:
Bit 18 = Daily
Bit 17 = Periodic
Bit 16 = Minute
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 708 internalflags:integer
Used internally by OpenEnteprise.
OpenEnterprise Schema logtrigger:integer
Incremented by the CL when a new history value is available for logging.
This includes all history values types collected from the ROC and manual edits. logtriggerdaily:integer
Incremented by the CL when a new daily history value is available for logging. This includes daily history values collected from the ROC and manual edits. logtriggerminute:integer
Incremented by the CL when a new minute history value is available for logging. This includes minute history values collected from the ROC and manual edits. logtriggerperiodic:integer
Incremented by the CL when a new periodic history value is available for logging. This includes periodic history values collected from the ROC and manual edits. manualhistorytrigger:integer
This attribute is incremented by the Editor when a new historical value is to be logged.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 709
OpenEnterprise Schema newhistorytrigger:integer
This attribute is incremented by the RDI when a new historical value is to be logged. parameterdescription:char
Plus: defined in history segment point config (types 125-135).
Standard: ‘Point Tag Identification TLP’ from point-type 8 or point-type
86 pointtagid:char
Plus: defined in history segment point config (types 125-135).
Standard: RDI to identify from point-type 8 or point-type 86 ‘TLP for
Point Tag Identification’ (if possible) readhistorytimestamp:datetime
Used internally by the ROC RDI to store the timestamp of a historical value read from the ROC. This value is copied to historyTimestamp.
A single historical sample read from the ROC is defined by readHistoryTimestamp, readHistoryValue and readHistoryValueType. readhistoryvalue:float
Used internally by the ROC RDI to store a historical value read from the
ROC. This value is copied to historyValue.
A single historical sample read from the ROC is defined by readHistoryTimestamp, readHistoryValue and readHistoryValueType. readhistoryvaluetype:integer
Used internally by the ROC RDI to store the type of a historical value read from the ROC. This value is copied to historyValueType.
A single historical sample read from the ROC is defined by readHistoryTimestamp, readHistoryValue and readHistoryValueType.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 710
OpenEnterprise Schema reportattribute:char
A string which defines the "attribute" part of a ROC History Point. The field can be used together with the reportbase and reportextension fields instead of the TLP type definition within the historylogpoint field when defining history report columns in the ROC History Editor. reportbase:char
A string which defines the "base" part of a ROC History Point. The field can be used together with the reportextension and reportattribute fields reportextension:char instead of the TLP type definition within the historylogpoint field when defining history report columns in the ROC History Editor.
A string which defines the "extension" part of a ROC History Point. The field can be used together with the reportbase and reportattribute fields instead of the TLP type definition within the historylogpoint field when defining history report columns in the ROC History Editor. source:integer
The reportExtension is intended to represent a flow or meter number and must be set to a string representation of a numerical value e.g. “01”.
Identifies the source of the update. 0 = ROC RDI, 1 = Manual update.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 711
rochistorysegmentconfiguration
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: contracthour:integer
Hour that indicates the beginning of a new day. dailyentries:integer
Number of daily entries per history point in the history segment. dailyindex:integer
Location in each history point for the segment where the next daily entry will be saved. forceendofday:integer
Allows the user to force an end of day for the history segment. 0 = No
Force, 1 = Force End of Day
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 712
OpenEnterprise Schema freespace:integer
Specifies the number of history entries that are unaccounted for and may be added to history points in various segments. This value applies to all history segments. maximumsegmentsize:integer
Specifies the maximum number of history points that may be configured for the history segment. numberofconfiguredpoints:integer
Number of history points that are configured in the segment. onoffswitch:integer
Switch that controls history logging for the history segment. Logging is suspended while the switch is off.
0 – OFF
1 – ON periodicentries:integer
Number of periodic entries per history point in the history segment.
Actual upper range is limited by available free space. periodicindex:integer
Location in each history point for the segment where the next periodic
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 713 entry will be saved.
OpenEnterprise Schema periodicsamplerate:integer
The number of minute intervals that pass before an entry is made in the periodic history.
The periodic sample rate for meter run history can only be set to the same value as the integral multiplier period for the meter run, or 60. segmentdescription:char
To be completed segmentsize:integer
Specifies how many history points are in the history segment.
Parameter is R/O for Logic 0.
Parameter can not be modified from an FST.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 714
rocinformationforuserdefinedpoints
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: numberofparameters:integer
To be completed pointtypedescription:char
To be completed templatepointernotused:integer
To be completed userprogramtype:integer
User Program Type: 0=Old Style, <> 0 = New Style
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 715
OpenEnterprise Schema
rocinternetconfigurationparameters
Derived From:
Description:
To be completed
To be completed
Attributes: currentmodbusconnections:integer
This parameter shows the number of active modbus TCP/IP connections. gatewayaddress:char
To be completed ipaddress:char
To be completed macaddress:char
Unique MAC address set by the factory.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 716
OpenEnterprise Schema modbusinactivitytime:float
Time, in seconds, that the ROC809 will wait, without receiving a valid modbus message, before it closes the connection.
0 disables. Occurs in the Application Layer. modbusipportnumber:integer
To be completed modbuskeepalivetime:integer
Specifies the amount of idle time (in seconds) before the first keep-alive message is sent for the modbus connection. Nine more keep-alive messages will be sent at an interval of 64 seconds before a connection is considered broken. Occurs in the Transport Layer.
0 disables modbusovertcpaddresstouse:integer
To be completed modbusovertcpslaveaddress:integer
Specifies the Slave Address for Modbus over IP numactiverocprotocolconnections:integer
This parameter shows the number of active Roc Protocol TCP/IP connections. (NOTE: Not available until release 1.1)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 717
OpenEnterprise Schema resetmodbusconnections:integer
Writing a 1 to this parameter will close all modbus TCP/IP connections. resetrocprotocolconnections:integer
Writing a 1 to this parameter will close all Roc Protocol TCP/IP connections. (NOTE: Not available until release 1.1) rocprotocolinactivitytime:float
Time in seconds that the ROC809 will wait, without receiving a valid message, before it closes the connection.
0 disables. (NOTE: Not available until release 1.1) rocprotocolipportnumber:integer
To be completed rocprotocolkeepalivetime:integer
Time in seconds between each periodic transmission of a message
(probes). (NOTE: Not available until release 1.1) subnetmask:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 718
rocjournaltypes
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char
To be completed dodebugmessage:bool
To be completed errornumber:integer
To be completed eventtext:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 719 journalinhibit:bool
To be completed journaltablename:char
To be completed journaltask:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 720
rocjournaltypes
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char
To be completed dodebugmessage:bool
To be completed errornumber:integer
To be completed eventtext:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 721 journalinhibit:bool
To be completed journaltablename:char
To be completed journaltask:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 722
roclicensekeyinformation
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: applicationcode:integer
An application specific code (dictated by the application provider). applicationname:char
The application name for the SW license. expirationdate:datetime
The date that the license expires. Value represents the number of seconds elapsed since 12:00 a.m. Jan. 1, 1970. expirationdatedstoffset:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 723
OpenEnterprise Schema licensecodeswlicense:integer
This is the SW license located on the HW Key # (PT 132; Parameter 0). licensekeyslothardwareslotnumber:integer
To be completed providername:char
A text description of the application provider. quantityremaining:integer
The number of licenses remaining to be allocated. quantitytotal:integer
The number of licenses contained in the code. swlicensevalidity:integer
States the validity of this License Code. timecreated:datetime
Time license was created. If license is a result of a merge, time represents when the merge was performed.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 724
OpenEnterprise Schema timecreateddstoffset:integer
To be completed version:char
A combination of the Major, Minor, and Letter portion of the version. Ex:
“255.255A “
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 725
roclinkparameterroctypeversion
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char
To be completed
OpenEnterprise Schema linkparameterroctypeversionid:integer
To be completed parameterid:integer
To be completed roctypeid:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 726 rocversionid:integer
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 727
roclogon
OpenEnterprise Schema
Derived From:
Description:
Attributes:
No attributes extend this table.
RocRequest
Used by the Roc RDI to Log on to the Roc device (via Roc Opcode 17). A single entry in this table will be automatically created for each RocDevice.
No additional entries are allowed.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 728
roclogonparameters
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: accesslevel:integer
A value that is used to limit access to parameters when parameter (95, x, 44) is set to 2 (Security by User Access Level) where x = to the logical of the port that the request is being made on. group1:integer
To be completed group10:integer
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0 group11:integer
States the first group the user is a member. The Group is then mapped
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 729
OpenEnterprise Schema to PT123 Logical 19.(1, Parameters 0 group12:integer group13:integer group14:integer group15:integer group16:integer group17:integer
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 730 group18:integer group19:integer group2:integer group20:integer group3:integer
OpenEnterprise Schema
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parame19.(ters 0
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0 group4:integer
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 731 group5:integer
OpenEnterprise Schema
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0 group6:integer
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0 group7:integer group8:integer group9:integer
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0
States the first group the user is a member. The Group is then mapped to PT123 Logical 19.(1, Parameters 0 keypadsecuritylevelreadenable:integer
Controls what menus the user is able to access for read purposes. The user will still have read access to a menu if the menu’s bit is not set, but is set for write access in the write enable parameter.
0 = Read access not allowed.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 732
1 = Read access allowed.
OpenEnterprise Schema
0 – Calibrate
1 – FST
2 – Control (PID)
3 – System
4 – Logs
5 – Meter Runs
6 – I/O
7 – Reserved keypadsecuritylevelwriteenable:integer
Controls what menus the user is able to access for write purposes.
0 = Write access not allowed.
1 = Write access allowed.
0 – Calibrate
1 – FST
2 – Control (PID)
3 – System
4 – Logs (Ignored – Read Only)
5 – Meter Runs
6 – I/O
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 733
7 - Reserved
OpenEnterprise Schema listsecurity:integer
Controls access to the User Lists through the LCD.
Lower 4 bits: 0 = Read access not allowed
1 = Read access allowed
0 – User List 1 – 2 operatorid:char
1 – User List 3 – 4
2 – User List 5 – 6
3 – User List 7 – 8
Upper 4 bits: 0 = Write access not allowed
1 = Write access allowed
4 – User List 7 – 8
5 – User List 5 – 6
6 – User List 3 – 4
7 – User List 1 - 2
To be completed password:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 734
OpenEnterprise Schema
A numerical value that is used as a password for the Operator Identifier
(i.e. 1000)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 735
rocmodbuseventalarmandhistory
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: conversioncode1:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode10:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode11:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. §
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 736
OpenEnterprise Schema conversioncode12:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode13:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode14:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode15:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode16:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode17:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode18:integer
Contains the conversion code to convert the ROC809 data into a format
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 737
OpenEnterprise Schema that is compatible to a Modbus device. § conversioncode19:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode2:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode20:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode3:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode4:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode5:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. §
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 738
OpenEnterprise Schema conversioncode6:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode7:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode8:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode9:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § currentdateregister:integer
Contains a unique register that allows a Modbus read/write command to access the current date in MMDDYY format currenttimeregister:integer
Contains a unique register that allows a Modbus read/write command to access the current time in HHMMSS format
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 739
OpenEnterprise Schema dailyhistoryregister1:integer
Contains a unique register number that indicates the request is for daily values for the first range of history points. dailyhistoryregister10:integer
Contains a unique register number that indicates the request is for daily values for the tenth range of history points. dailyhistoryregister11:integer
Contains a unique register number that indicates the request is for daily values for the eleventh range of history points. dailyhistoryregister12:integer
Contains a unique register number that indicates the request is for daily values for the twelfth range of history points. dailyhistoryregister13:integer
Contains a unique register number that indicates the request is for daily values for the thirteenth range of history points. dailyhistoryregister14:integer
Contains a unique register number that indicates the request is for daily values for the fourteenth range of history points. dailyhistoryregister15:integer
Contains a unique register number that indicates the request is for daily
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 740
OpenEnterprise Schema values for the fifteenth range of history points. dailyhistoryregister16:integer
Contains a unique register number that indicates the request is for daily values for the sixteenth range of history points. dailyhistoryregister17:integer
Contains a unique register number that indicates the request is for daily values for the seventeenth range of history points. dailyhistoryregister18:integer
Contains a unique register number that indicates the request is for daily values for the eighteenth range of history points. dailyhistoryregister19:integer
Contains a unique register number that indicates the request is for daily values for the nineteenth range of history points. dailyhistoryregister2:integer
Contains a unique register number that indicates the request is for daily values for the second range of history points. dailyhistoryregister20:integer
Contains a unique register number that indicates the request is for daily values for the twentieth range of history points.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 741
OpenEnterprise Schema dailyhistoryregister3:integer
Contains a unique register number that indicates the request is for daily values for the third range of history points. dailyhistoryregister4:integer
Contains a unique register number that indicates the request is for daily values for the fourth range of history points. dailyhistoryregister5:integer
Contains a unique register number that indicates the request is for daily values for the fifth range of history points. dailyhistoryregister6:integer
Contains a unique register number that indicates the request is for daily values for the sixth range of history points. dailyhistoryregister7:integer
Contains a unique register number that indicates the request is for daily values for the seventh range of history points. dailyhistoryregister8:integer
Contains a unique register number that indicates the request is for daily values for the eighth range of history points.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 742
OpenEnterprise Schema dailyhistoryregister9:integer
Contains a unique register number that indicates the request is for daily values for the ninth range of history points. endhistorypoint1:integer
Contains the ending history point number for range 1. endhistorypoint10:integer
Contains the ending history point number for range 10. endhistorypoint11:integer
Contains the ending history point number for range 11. endhistorypoint12:integer
Contains the ending history point number for range 12. endhistorypoint13:integer
Contains the ending history point number for range 13. endhistorypoint14:integer
Contains the ending history point number for range 14.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 743
OpenEnterprise Schema endhistorypoint15:integer
Contains the ending history point number for range 15. endhistorypoint16:integer
Contains the ending history point number for range 16. endhistorypoint17:integer
Contains the ending history point number for range 17. endhistorypoint18:integer
Contains the ending history point number for range 18. endhistorypoint19:integer
Contains the ending history point number for range 19. endhistorypoint2:integer
Contains the ending history point number for range 2. endhistorypoint20:integer
Contains the ending history point number for range 20.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 744
OpenEnterprise Schema endhistorypoint3:integer
Contains the ending history point number for range 3. endhistorypoint4:integer
Contains the ending history point number for range 4. endhistorypoint5:integer
Contains the ending history point number for range 5. endhistorypoint6:integer
Contains the ending history point number for range 6. endhistorypoint7:integer
Contains the ending history point number for range 7. endhistorypoint8:integer
Contains the ending history point number for range 8. endhistorypoint9:integer
Contains the ending history point number for range 9. eventalarmregister:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 745
To be completed
OpenEnterprise Schema historyindexmode:integer
0: EFM Extensions Mode: History Indexes (mapped to TLP[124,X,5] and [124,X,6]) will be returned as one less - accounting for roll-over - corresponding to last entry location
1: Override mode: Do not modify the values - Return the indexes unmodified (pointing to the next entry location historysegment1:integer
Contains the history segment for range 1. historysegment10:integer
Contains the history segment for range 10. historysegment11:integer
Contains the history segment for range 11. historysegment12:integer
Contains the history segment for range 12. historysegment13:integer
Contains the history segment for range 13.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 746
OpenEnterprise Schema historysegment14:integer
Contains the history segment for range 14. historysegment15:integer
Contains the history segment for range 15. historysegment16:integer
Contains the history segment for range 16. historysegment17:integer
Contains the history segment for range 17. historysegment18:integer
Contains the history segment for range 18. historysegment19:integer
Contains the history segment for range 19. historysegment2:integer
Contains the history segment for range 2.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 747
OpenEnterprise Schema historysegment20:integer
Contains the history segment for range 20. historysegment3:integer
Contains the history segment for range 3. historysegment4:integer
Contains the history segment for range 4. historysegment5:integer
Contains the history segment for range 5. historysegment6:integer
Contains the history segment for range 6. historysegment7:integer
Contains the history segment for range 7. historysegment8:integer
Contains the history segment for range 8.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 748
OpenEnterprise Schema historysegment9:integer
Contains the history segment for range 9. periodichistoryregister1:integer
Contains a unique register number that indicates the request is for periodic values for the first range of history points. periodichistoryregister10:integer
Contains a unique register number that indicates the request is for periodic values for the tenth range of history points. periodichistoryregister11:integer
Contains a unique register number that indicates the request is for periodic values for the eleventh range of history points. periodichistoryregister12:integer
Contains a unique register number that indicates the request is for periodic values for the twelfth range of history points. periodichistoryregister13:integer
Contains a unique register number that indicates the request is for periodic values for the thirteenth range of history points.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 749
OpenEnterprise Schema periodichistoryregister14:integer
Contains a unique register number that indicates the request is for periodic values for the fourteenth range of history points. periodichistoryregister15:integer
Contains a unique register number that indicates the request is for periodic values for the fifteenth range of history points. periodichistoryregister16:integer
Contains a unique register number that indicates the request is for periodic values for the sixteenth range of history points. periodichistoryregister17:integer
Contains a unique register number that indicates the request is for periodic values for the seventeenth range of history points. periodichistoryregister18:integer
Contains a unique register number that indicates the request is for periodic values for the eighteenth range of history points. periodichistoryregister19:integer
Contains a unique register number that indicates the request is for periodic values for the nineteenth range of history points. periodichistoryregister2:integer
Contains a unique register number that indicates the request is for
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 750
OpenEnterprise Schema periodic values for the second range of history points. periodichistoryregister20:integer
Contains a unique register number that indicates the request is for periodic values for the twentieth range of history points. periodichistoryregister3:integer
Contains a unique register number that indicates the request is for periodic values for the third range of history points. periodichistoryregister4:integer
Contains a unique register number that indicates the request is for periodic values for the fourth range of history points. periodichistoryregister5:integer
Contains a unique register number that indicates the request is for periodic values for the fifth range of history points. periodichistoryregister6:integer
Contains a unique register number that indicates the request is for periodic values for the sixth range of history points. periodichistoryregister7:integer
Contains a unique register number that indicates the request is for periodic values for the seventh range of history points.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 751
OpenEnterprise Schema periodichistoryregister8:integer
Contains a unique register number that indicates the request is for periodic values for the eighth range of history points. periodichistoryregister9:integer
Contains a unique register number that indicates the request is for periodic values for the ninth range of history points. starthistorypoint1:integer
Contains the starting history point number for range 1. starthistorypoint10:integer
Contains the starting history point number for range 10. starthistorypoint11:integer
Contains the starting history point number for range 11. starthistorypoint12:integer
Contains the starting history point number for range 12. starthistorypoint13:integer
Contains the starting history point number for range 13.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 752
OpenEnterprise Schema starthistorypoint14:integer
Contains the starting history point number for range 14. starthistorypoint15:integer
Contains the starting history point number for range 15. starthistorypoint16:integer
Contains the starting history point number for range 16. starthistorypoint17:integer
Contains the starting history point number for range 17. starthistorypoint18:integer
Contains the starting history point number for range 18. starthistorypoint19:integer
Contains the starting history point number for range 19. starthistorypoint2:integer
Contains the starting history point number for range 2.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 753
OpenEnterprise Schema starthistorypoint20:integer
Contains the starting history point number for range 20. starthistorypoint3:integer
Contains the starting history point number for range 3. starthistorypoint4:integer
Contains the starting history point number for range 4. starthistorypoint5:integer
Contains the starting history point number for range 5. starthistorypoint6:integer
Contains the starting history point number for range 6. starthistorypoint7:integer
Contains the starting history point number for range 7. starthistorypoint8:integer
Contains the starting history point number for range 8.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 754
OpenEnterprise Schema starthistorypoint9:integer
Contains the starting history point number for range 9.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 755
OpenEnterprise Schema
rocmodbusmastermodemconfiguration
Derived From:
Description:
To be completed
To be completed
Attributes: connectcommand1:char
A 30-character modem command typically used to represent the telephone number of the slave RTU. connectcommand2:char
A 30-character modem command typically used to represent the telephone number of the slave RTU. connectcommand3:char
A 30-character modem command typically used to represent the telephone number of the slave RTU. connectcommand4:char
A 30-character modem command typically used to represent the
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 756
OpenEnterprise Schema telephone number of the slave RTU. connectcommand5:char
A 30-character modem command typically used to represent the telephone number of the slave RTU. connectcommand6:char
A 30-character modem command typically used to represent the telephone number of the slave RTU. rtuaddress1:integer
Associates an RTU address to the Connect Command. rtuaddress2:integer
Associates an RTU address to the Connect Command. rtuaddress3:integer
Associates an RTU address to the Connect Command. rtuaddress4:integer
Associates an RTU address to the Connect Command. rtuaddress5:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 757
OpenEnterprise Schema
Associates an RTU address to the Connect Command. rtuaddress6:integer
Associates an RTU address to the Connect Command.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 758
rocmodbusmastertable
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: communicationstatus1:integer
Displays the status of the master query. ‡ communicationstatus10:integer
Displays the status of the master query. ‡ communicationstatus11:integer
Displays the status of the master query. ‡ communicationstatus12:integer
Displays the status of the master query. ‡
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 759
OpenEnterprise Schema communicationstatus13:integer
Displays the status of the master query. ‡ communicationstatus14:integer
Displays the status of the master query. ‡ communicationstatus15:integer
Displays the status of the master query. ‡ communicationstatus16:integer
Displays the status of the master query. ‡ communicationstatus17:integer
Displays the status of the master query. ‡ communicationstatus18:integer
Displays the status of the master query. ‡ communicationstatus19:integer
Displays the status of the master query. ‡
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 760
OpenEnterprise Schema communicationstatus2:integer
Displays the status of the master query. ‡ communicationstatus20:integer
Displays the status of the master query. ‡ communicationstatus21:integer
Displays the status of the master query. ‡ communicationstatus22:integer
Displays the status of the master query. ‡ communicationstatus23:integer
Displays the status of the master query. ‡ communicationstatus24:integer
Displays the status of the master query. ‡ communicationstatus25:integer
Displays the status of the master query. ‡
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 761
OpenEnterprise Schema communicationstatus3:integer
Displays the status of the master query. ‡ communicationstatus4:integer
Displays the status of the master query. ‡ communicationstatus5:integer
Displays the status of the master query. ‡ communicationstatus6:integer
Displays the status of the master query. ‡ communicationstatus7:integer
Displays the status of the master query. ‡ communicationstatus8:integer
Displays the status of the master query. ‡ communicationstatus9:integer
Displays the status of the master query. ‡
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 762
OpenEnterprise Schema functioncodenumber1:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 1. † functioncodenumber10:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 10. † functioncodenumber11:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 11. † functioncodenumber12:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 12. † functioncodenumber13:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 13. † functioncodenumber14:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 14. †
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 763
OpenEnterprise Schema functioncodenumber15:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 15. † functioncodenumber16:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 16. † functioncodenumber17:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 17. † functioncodenumber18:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 18. † functioncodenumber19:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 19. † functioncodenumber2:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 2. † functioncodenumber20:integer
Specifies the Modbus Function Code to be sent to the slave device on
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 764
RTU 20. †
OpenEnterprise Schema functioncodenumber21:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 21. † functioncodenumber22:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 22. † functioncodenumber23:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 23. † functioncodenumber24:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 24. † functioncodenumber25:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 25. † functioncodenumber3:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 3. †
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 765
OpenEnterprise Schema functioncodenumber4:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 4. † functioncodenumber5:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 5. † functioncodenumber6:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 6. † functioncodenumber7:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 7. † functioncodenumber8:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 8. † functioncodenumber9:integer
Specifies the Modbus Function Code to be sent to the slave device on
RTU 9. †
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 766
OpenEnterprise Schema masterregisternumber1:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber10:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber11:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber12:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber13:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber14:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber15:integer
The starting Modbus register number on the Master device (ROC809)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 767
OpenEnterprise Schema where the data will either be stored for a read, or provided for a write. masterregisternumber16:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber17:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber18:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber19:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber2:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber20:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 768
OpenEnterprise Schema masterregisternumber21:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber22:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber23:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber24:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber25:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber3:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 769
OpenEnterprise Schema masterregisternumber4:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber5:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber6:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber7:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber8:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. masterregisternumber9:integer
The starting Modbus register number on the Master device (ROC809) where the data will either be stored for a read, or provided for a write. numberofregisters1:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 770
OpenEnterprise Schema
The number of registers for the master to either read or write. numberofregisters10:integer
The number of registers for the master to either read or write. numberofregisters11:integer
The number of registers for the master to either read or write. numberofregisters12:integer
The number of registers for the master to either read or write. numberofregisters13:integer
The number of registers for the master to either read or write. numberofregisters14:integer
The number of registers for the master to either read or write. numberofregisters15:integer
The number of registers for the master to either read or write. numberofregisters16:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 771
OpenEnterprise Schema
The number of registers for the master to either read or write. numberofregisters17:integer
The number of registers for the master to either read or write. numberofregisters18:integer
The number of registers for the master to either read or write. numberofregisters19:integer
The number of registers for the master to either read or write. numberofregisters2:integer
The number of registers for the master to either read or write. numberofregisters20:integer
The number of registers for the master to either read or write. numberofregisters21:integer
The number of registers for the master to either read or write. numberofregisters22:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 772
OpenEnterprise Schema
The number of registers for the master to either read or write. numberofregisters23:integer
The number of registers for the master to either read or write. numberofregisters24:integer
The number of registers for the master to either read or write. numberofregisters25:integer
The number of registers for the master to either read or write. numberofregisters3:integer
The number of registers for the master to either read or write. numberofregisters4:integer
The number of registers for the master to either read or write. numberofregisters5:integer
The number of registers for the master to either read or write. numberofregisters6:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 773
OpenEnterprise Schema
The number of registers for the master to either read or write. numberofregisters7:integer
The number of registers for the master to either read or write. numberofregisters8:integer
The number of registers for the master to either read or write. numberofregisters9:integer
The number of registers for the master to either read or write. rtu10address:integer
Contains RTU 10 Address the Modbus Query is destined for rtu11address:integer
Contains RTU 11 Address the Modbus Query is destined for rtu12address:integer
Contains RTU 12 Address the Modbus Query is destined for rtu13address:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 774
OpenEnterprise Schema
Contains RTU 13 Address the Modbus Query is destined for rtu14address:integer
Contains RTU 14 Address the Modbus Query is destined for rtu15address:integer
Contains RTU 15 Address the Modbus Query is destined for rtu16address:integer
Contains RTU 16 Address the Modbus Query is destined for rtu17address:integer
Contains RTU 17 Address the Modbus Query is destined for rtu18address:integer
Contains RTU 18 Address the Modbus Query is destined for rtu19address:integer
Contains RTU 19 Address the Modbus Query is destined for rtu1address:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 775
OpenEnterprise Schema
Contains RTU 1 Address the Modbus Query is destined for rtu20address:integer
Contains RTU 20 Address the Modbus Query is destined for rtu21address:integer
Contains RTU 21 Address the Modbus Query is destined for rtu22address:integer
Contains RTU 22 Address the Modbus Query is destined for rtu23address:integer
Contains RTU 23 Address the Modbus Query is destined for rtu24address:integer
Contains RTU 24 Address the Modbus Query is destined for rtu25address:integer
Contains RTU 25 Address the Modbus Query is destined for rtu2address:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 776
OpenEnterprise Schema
Contains RTU 2 Address the Modbus Query is destined for rtu3address:integer
Contains RTU 3 Address the Modbus Query is destined for rtu4address:integer
Contains RTU 4 Address the Modbus Query is destined for rtu5address:integer
Contains RTU 5 Address the Modbus Query is destined for rtu6address:integer
Contains RTU 6 Address the Modbus Query is destined for rtu7address:integer
Contains RTU 7 Address the Modbus Query is destined for rtu8address:integer
Contains RTU 8 Address the Modbus Query is destined for rtu9address:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 777
OpenEnterprise Schema
Contains RTU 9 Address the Modbus Query is destined for slaveregisternumber1:integer
The starting Modbus register number on the slave device for the query on RTU 1. slaveregisternumber10:integer
The starting Modbus register number on the slave device for the query on RTU 10. slaveregisternumber11:integer
The starting Modbus register number on the slave device for the query on RTU 11. slaveregisternumber12:integer
The starting Modbus register number on the slave device for the query on RTU 12. slaveregisternumber13:integer
The starting Modbus register number on the slave device for the query on RTU 13. slaveregisternumber14:integer
The starting Modbus register number on the slave device for the query on RTU 14.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 778
OpenEnterprise Schema slaveregisternumber15:integer
The starting Modbus register number on the slave device for the query on RTU 15. slaveregisternumber16:integer
The starting Modbus register number on the slave device for the query on RTU 16. slaveregisternumber17:integer
The starting Modbus register number on the slave device for the query on RTU 17. slaveregisternumber18:integer
The starting Modbus register number on the slave device for the query on RTU 18. slaveregisternumber19:integer
The starting Modbus register number on the slave device for the query on RTU 19. slaveregisternumber2:integer
The starting Modbus register number on the slave device for the query on RTU 2.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 779
OpenEnterprise Schema slaveregisternumber20:integer
The starting Modbus register number on the slave device for the query on RTU 20. slaveregisternumber21:integer
The starting Modbus register number on the slave device for the query on RTU 21. slaveregisternumber22:integer
The starting Modbus register number on the slave device for the query on RTU 22. slaveregisternumber23:integer
The starting Modbus register number on the slave device for the query on RTU 23. slaveregisternumber24:integer
The starting Modbus register number on the slave device for the query on RTU 24. slaveregisternumber25:integer
The starting Modbus register number on the slave device for the query on RTU 25. slaveregisternumber3:integer
The starting Modbus register number on the slave device for the query
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 780 on RTU 3.
OpenEnterprise Schema slaveregisternumber4:integer
The starting Modbus register number on the slave device for the query on RTU 4. slaveregisternumber5:integer
The starting Modbus register number on the slave device for the query on RTU 5. slaveregisternumber6:integer
The starting Modbus register number on the slave device for the query on RTU 6. slaveregisternumber7:integer
The starting Modbus register number on the slave device for the query on RTU 7. slaveregisternumber8:integer
The starting Modbus register number on the slave device for the query on RTU 8. slaveregisternumber9:integer
The starting Modbus register number on the slave device for the query on RTU 9.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 781
rocmodbusregistertotlpmapping
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: commport1:integer
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
= Comm Port 5, 255 = All Comm Ports commport10:integer
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
= Comm Port 5, 255 = All Comm Ports commport11:integer
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
= Comm Port 5, 255 = All Comm Ports commport12:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 782
OpenEnterprise Schema
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
= Comm Port 5, 255 = All Comm Ports commport13:integer
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
= Comm Port 5, 255 = All Comm Ports commport14:integer
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
= Comm Port 5, 255 = All Comm Ports commport15:integer
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
= Comm Port 5, 255 = All Comm Ports commport2:integer
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
= Comm Port 5, 255 = All Comm Ports commport3:integer
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
= Comm Port 5, 255 = All Comm Ports
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 783
OpenEnterprise Schema commport4:integer
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
= Comm Port 5, 255 = All Comm Ports commport5:integer
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
= Comm Port 5, 255 = All Comm Ports commport6:integer
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
= Comm Port 5, 255 = All Comm Ports commport7:integer
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
= Comm Port 5, 255 = All Comm Ports commport8:integer
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
= Comm Port 5, 255 = All Comm Ports commport9:integer
Communication port the first range of registers map to. 0 = LOI, 1 =
Comm Port 1, 2 = Comm Port 2, 3 = Comm Port 3, 4 = Comm Port 4, 5
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 784
OpenEnterprise Schema
= Comm Port 5, 255 = All Comm Ports conversioncode1:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode10:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode11:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode12:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode13:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode14:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. §
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 785
OpenEnterprise Schema conversioncode15:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode2:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode3:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode4:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode5:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode6:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. §
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 786
OpenEnterprise Schema conversioncode7:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode8:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § conversioncode9:integer
Contains the conversion code to convert the ROC809 data into a format that is compatible to a Modbus device. § endregister1:integer
The ending register number for the first range of Modbus registers that map to ROC Protocol TLP(s). endregister10:integer
The ending register number for the tenth range of Modbus registers that map to ROC Protocol TLP(s). endregister11:integer
The ending register number for the 11th range of Modbus registers that map to ROC Protocol TLP(s). endregister12:integer
The ending register number for the 12th range of Modbus registers that
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 787 map to ROC Protocol TLP(s).
OpenEnterprise Schema endregister13:integer
The ending register number for the 13th range of Modbus registers that map to ROC Protocol TLP(s). endregister14:integer
The ending register number for the 14th range of Modbus registers that map to ROC Protocol TLP(s). endregister15:integer
The ending register number for the 15th range of Modbus registers that map to ROC Protocol TLP(s). endregister2:integer
The ending register number for the second range of Modbus registers that map to ROC Protocol TLP(s). endregister3:integer
The ending register number for the third range of Modbus registers that map to ROC Protocol TLP(s). endregister4:integer
The ending register number for the fourth range of Modbus registers that map to ROC Protocol TLP(s).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 788
OpenEnterprise Schema endregister5:integer
The ending register number for the fifth range of Modbus registers that map to ROC Protocol TLP(s). endregister6:integer
The ending register number for the sixth range of Modbus registers that map to ROC Protocol TLP(s). endregister7:integer
The ending register number for the seventh range of Modbus registers that map to ROC Protocol TLP(s). endregister8:integer
The ending register number for the eighth range of Modbus registers that map to ROC Protocol TLP(s). endregister9:integer
The ending register number for the ninth range of Modbus registers that map to ROC Protocol TLP(s). indexing1:integer
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
1 = Parameter indexing.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 789
OpenEnterprise Schema indexing10:integer
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
1 = Parameter indexing. indexing11:integer
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
1 = Parameter indexing. indexing12:integer
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
1 = Parameter indexing. indexing13:integer
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
1 = Parameter indexing. indexing14:integer
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
1 = Parameter indexing. indexing15:integer
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 790
1 = Parameter indexing.
OpenEnterprise Schema indexing2:integer
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
1 = Parameter indexing. indexing3:integer
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
1 = Parameter indexing. indexing4:integer
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
1 = Parameter indexing. indexing5:integer
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
1 = Parameter indexing. indexing6:integer
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
1 = Parameter indexing.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 791 indexing7:integer
OpenEnterprise Schema
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
1 = Parameter indexing. indexing8:integer
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
1 = Parameter indexing. indexing9:integer
Indicates whether multiple registers access consecutive logical numbers or consecutive parameters from the starting TLP. 0 = Logical indexing,
1 = Parameter indexing. rocparameters1:char
The starting ROC Protocol TLP that maps to the first range of Modbus registers. rocparameters10:char
The starting ROC Protocol TLP that maps to the first range of Modbus registers. rocparameters10_l:integer
To be completed rocparameters10_p:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 792
To be completed
OpenEnterprise Schema rocparameters10_t:integer
To be completed rocparameters11:char
The starting ROC Protocol TLP that maps to the first range of Modbus registers. rocparameters11_l:integer
To be completed rocparameters11_p:integer
To be completed rocparameters11_t:integer
To be completed rocparameters12:char
The starting ROC Protocol TLP that maps to the first range of Modbus registers. rocparameters12_l:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 793
To be completed
OpenEnterprise Schema rocparameters12_p:integer
To be completed rocparameters12_t:integer
To be completed rocparameters13:char
The starting ROC Protocol TLP that maps to the first range of Modbus registers. rocparameters13_l:integer
To be completed rocparameters13_p:integer
To be completed rocparameters13_t:integer
To be completed rocparameters14:char
The starting ROC Protocol TLP that maps to the first range of Modbus
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 794 registers.
OpenEnterprise Schema rocparameters14_l:integer
To be completed rocparameters14_p:integer
To be completed rocparameters14_t:integer
To be completed rocparameters15:char
The starting ROC Protocol TLP that maps to the first range of Modbus registers. rocparameters15_l:integer
To be completed rocparameters15_p:integer
To be completed rocparameters15_t:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 795
To be completed
OpenEnterprise Schema rocparameters1_l:integer
To be completed rocparameters1_p:integer
To be completed rocparameters1_t:integer
To be completed rocparameters2:char
The starting ROC Protocol TLP that maps to the first range of Modbus registers. rocparameters2_l:integer
To be completed rocparameters2_p:integer
To be completed rocparameters2_t:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 796
To be completed
OpenEnterprise Schema rocparameters3:char
The starting ROC Protocol TLP that maps to the first range of Modbus registers. rocparameters3_l:integer
To be completed rocparameters3_p:integer
To be completed rocparameters3_t:integer
To be completed rocparameters4:char
The starting ROC Protocol TLP that maps to the first range of Modbus registers. rocparameters4_l:integer
To be completed rocparameters4_p:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 797
To be completed
OpenEnterprise Schema rocparameters4_t:integer
To be completed rocparameters5:char
The starting ROC Protocol TLP that maps to the first range of Modbus registers. rocparameters5_l:integer
To be completed rocparameters5_p:integer
To be completed rocparameters5_t:integer
To be completed rocparameters6:char
The starting ROC Protocol TLP that maps to the first range of Modbus registers. rocparameters6_l:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 798
To be completed
OpenEnterprise Schema rocparameters6_p:integer
To be completed rocparameters6_t:integer
To be completed rocparameters7:char
The starting ROC Protocol TLP that maps to the first range of Modbus registers. rocparameters7_l:integer
To be completed rocparameters7_p:integer
To be completed rocparameters7_t:integer
To be completed rocparameters8:char
The starting ROC Protocol TLP that maps to the first range of Modbus
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 799 registers.
OpenEnterprise Schema rocparameters8_l:integer
To be completed rocparameters8_p:integer
To be completed rocparameters8_t:integer
To be completed rocparameters9:char
The starting ROC Protocol TLP that maps to the first range of Modbus registers. rocparameters9_l:integer
To be completed rocparameters9_p:integer
To be completed rocparameters9_t:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 800
To be completed
OpenEnterprise Schema startregister1:integer
The starting register number for the first range of Modbus registers that map to ROC Protocol TLP(s). startregister10:integer
The starting register number for the tenth range of Modbus registers that map to ROC Protocol TLP(s). startregister11:integer
The starting register number for the 11th range of Modbus registers that map to ROC Protocol TLP(s). startregister12:integer
The starting register number for the 12th range of Modbus registers that map to ROC Protocol TLP(s). startregister13:integer
The starting register number for the 13th range of Modbus registers that map to ROC Protocol TLP(s). startregister14:integer
The starting register number for the 14th range of Modbus registers that map to ROC Protocol TLP(s).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 801
OpenEnterprise Schema startregister15:integer
The starting register number for the 15th range of Modbus registers that map to ROC Protocol TLP(s). startregister2:integer
The starting register number for the second range of Modbus registers that map to ROC Protocol TLP(s). startregister3:integer
The starting register number for the third range of Modbus registers that map to ROC Protocol TLP(s). startregister4:integer
The starting register number for the fourth range of Modbus registers that map to ROC Protocol TLP(s). startregister5:integer
The starting register number for the fifth range of Modbus registers that map to ROC Protocol TLP(s). startregister6:integer
The starting register number for the sixth range of Modbus registers that map to ROC Protocol TLP(s).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 802
OpenEnterprise Schema startregister7:integer
The starting register number for the seventh range of Modbus registers that map to ROC Protocol TLP(s). startregister8:integer
The starting register number for the eighth range of Modbus registers that map to ROC Protocol TLP(s). startregister9:integer
The starting register number for the ninth range of Modbus registers that map to ROC Protocol TLP(s).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 803
rocnetwork
OpenEnterprise Schema
Derived From:
Description: dvi_network
This table contains information that is specific to ROC Networks.
Attributes: accessarea:char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. infonumdeviceregistered:integer
Number of devices for this network that the RDI has successfully registered.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 804
rocoedbfieldtypes
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char name:char
To be completed
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 805
rocorificemeterrunconfiguration
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: alarmcode:integer
To be completed alarmdeadband:float
The value that the Flow Rate Per Day (Point Type 114, parameter #0) must be above the low alarm value (parameter #8) or below the high alarm value (parameter #9) before the associated alarm will clear. alarming:integer
If enabled, alarms may be generated and sent to the Alarm Log. 0 =
Disabled, 1 = Enabled. calibrationweightsgravitationalacceleration:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 806
OpenEnterprise Schema
Used to calculate Fpwl. Entered in ft/sec2 or m/sec2. (@) differentialmetertype:integer
Indicates the type of primary differential metering device. 0 = Flange tapped orifice, 1 = User defined device. differentialpressuredeadweightcalibrator:integer
Expand the volume flow equation to include the local gravitational correction for the deadweight calibrator on Differential Pressure
(Fpwl(differential)). 0 = Do Not Use, 1 = Use. (@) dpdifferentialpressurehw:float
This is the differential pressure in inches of H2O or kPa. (()(() dptlp:char
This indicates what is being used to get the DP (parameter #26). dptlp_l:integer dptlp_p:integer
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 807 dptlp_t:integer
To be completed
OpenEnterprise Schema highalarmflow:float
Alarm value for High Alarm in mft3/day or km3/day. highdpsetpoint:float
If a stacked differential pressure is enabled, this is the differential pressure value, in inches of H2O or kPa, which indicates to start reading from the DP TLP (parameter #25). lowalarmflow:float
Alarm value for Low Alarm in mft3/day or km3/day. lowdpcutoff:float
This is the cutoff point for the differential pressure, in inches of H2O or kPa, to determine whether the meter run is flowing or not. (() lowdpsetpoint:float
If a stacked differential pressure is enabled, this is the differential pressure value, in inches of H2O or kPa, which indicates to start reading from the Low DP TLP (parameter #24). lowdptlp:char
Indicates what is being used to get the DP (parameter #26) if the stacked differential pressure says to use the lower DP.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 808
OpenEnterprise Schema lowdptlp_l:integer
To be completed lowdptlp_p:integer
To be completed lowdptlp_t:integer
To be completed orificediameter:float
Orifice plate bore diameter in inches or millimeters. Must be greater than 0.0 and less than Pipe Diameter (parameter #7). (() orificematerial:integer
Indicates what the orifice plate is made of. This is for determining the linear coefficient of thermal expansion for the orifice plate. 0 = Type 304 or 316 Stainless Steel, 1 = Monel, 2 = Carbon Steel. (() orificereferencetemp:float
Reference temperature of the orifice plate bore diameter in (F or (C. (() pipediameter:float
Meter tube internal diameter in inches or millimeters. Must be greater
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 809 than 0.0. (()
OpenEnterprise Schema pipematerial:integer
Indicates what the meter tube is made of. This is for determining the linear coefficient of thermal expansion for the meter tube. 0 = Type 304 or 316 Stainless Steel, 1 = Monel, 2 = Carbon Steel. (() pipereferencetemp:float
Reference temperature of the meter tube inside diameter in (F or (C. (() pointdescription:char
Description for specific Meter Run. Values must be printable ASCII characters. specificheatratio:float
Isentropic exponent for natural gas. Must be greater than 0.0. (() spstaticpressurepf:float
Static pressure in psi (lb/in2) or kPa.(()(() sptlp:char
Indicates what is being used to get the SP (parameter #28).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 810 sptlp_l:integer
To be completed
OpenEnterprise Schema sptlp_p:integer
To be completed
To be completed sptlp_t:integer srbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled. srbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled. stackeddp:integer
Indicates a stacked differential pressure for the meter run is being used.
0 = Disabled, 1 = Enabled. staticpressuredeadweightcalibrator:integer
Expand the volume flow equation to include the local gravitational correction for the deadweight calibrator on Static Pressure (Fpwl(static)).
0 = Do Not Use, 1 = Use. (@)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 811
OpenEnterprise Schema staticpressuretap:integer
Indicates if the static pressure is an upstream or downstream reading. 0
= Downstream, 1 = Upstream. staticpressureunits:integer
Indicates whether the static pressure is in gauge or absolute pressure units. 0 = Gauge, 1 = Absolute. stationnumber:integer
Indicates what station meter run is a part of. tmptemperaturetf:float
Temperature in (F or (C.(()(() tmptlp:char
Indicates what is being used to get the TMP (parameter #30). tmptlp_l:integer tmptlp_p:integer
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 812
OpenEnterprise Schema tmptlp_t:integer
To be completed usercorrectionfactor:float
Variable multiplied through the volume flow equation to allow the user to modify the flow (Fuc). viscosity:float
Absolute viscosity of flowing fluid in cP. (()
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 813
rocorificemeterrunvalues
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: cdft:float density:float
Represents the Coefficient of discharge at a specified pipe Reynolds number for flange-tapped orifice meter. (()
Represents the density of a fluid at flowing conditions in lbm/ft3 or kg/m3. (() diameterratiobeta:float
Ratio of orifice plate bore diameter to meter tube internal diameter calculated at the average flowing temperature over the imp. (() energyaccumulated:float
Total accumulation of energy for the meter run in mmBtu or GJ. The
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 814
OpenEnterprise Schema
1,000,000.0 rollover is to ensure that energy accuracy is not lost due to the significant digits of a float data type. energymonth:float
Total accumulation of energy for the current month in mmBtu or GJ. energyprevmonth:float
Total accumulation of energy for the previous month in mmBtu or GJ. energyrateperday:float
Energy rate at base conditions in mmBtu/day or GJ/day. energyrateperhour:float
Energy rate at base conditions in Btu/hour or MJ/hour. energytoday:float
Total accumulation of energy for the current contract day in mmBtu or
GJ. energyyesterday:float
Total accumulation of energy for the previous contract day in mmBtu or
GJ.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 815
OpenEnterprise Schema expansionfactory1:float
Represents the Expansion factor based on upstream absolute static pressure. (()(() flowaccumulated:float
Total accumulation of flow for the meter run in mft3 or km3. The
1,000,000.0 rollover is to ensure that flow accuracy is not lost due to the significant digits of a float data type. flowmonth:float
Total accumulation of flow for the current month in mft3 or km3. flowprevmonth:float
Total accumulation of flow for the previous month in mft3 or km3. flowrateperday:float
To be completed flowrateperhour:float
Volume flow rate at base conditions in ft3/hour or m3/hour. (() flowtoday:float
Total accumulation of flow for the current contract day in mft3 or km3.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 816
OpenEnterprise Schema flowyesterday:float
Total accumulation of flow for the previous contract day in mft3 or km3. fpb:float fpwl:float
Represents the base pressure factor. (()(()
Represents the local gravitational correction for the deadweight tester.
When a deadweight calibrator is used for both the differential and static pressure, this factor is used twice. (@) ftb:float
Represents the base temperature factor. (()(() massaccumulated:float
Total accumulation of mass for the meter run in mlb or tonnes. The
1,000,000.0 rollover is to ensure that accuracy is not lost due to the significant digits of a float data type. massmonth:float
Total accumulation of mass for the current month in mlb or tonnes. masspreviousmonth:float
Total accumulation of mass for the previous month in mlb or tonnes.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 817
OpenEnterprise Schema massrateperday:float
To be completed massrateperhour:float
Mass flow rate in lb/hr or kg/hr. masstoday:float
Total accumulation of mass since the last contract hour in mlb or tonnes. massyesterday:float
Total accumulation of mass for the previous contract day in mlb or tonnes. metertubeinternaldiameterd:float
Meter tube internal diameter calculated at the average flowing temperature over the imp in inches. (() minutesaccumulated:float
Total accumulation of flowing minutes for the meter run. The
1,000,000.0 rollover is to ensure that flow minutes accuracy is not lost due to the significant digits of a float data type. minutesmonth:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 818
OpenEnterprise Schema
Total accumulation of flowing minutes for the current month. minutesprevmonth:float
Total accumulation of flowing minutes for the previous month. minutestoday:float
Total accumulation of flowing minutes for the current contract day. minutesyesterday:float
Total accumulation of flowing minutes for the previous contract day. multipliervalue:float
Represents the value multiplied by the square root of the product of differential and static pressure to calculate instantaneous flow rate. (() orificeplateborediameterd:float
Orifice plate bore diameter calculated at the average flowing temperature over the imp in inches. (() pressureextensionhwpf:float
Represents the square root of Differential Pressure times Static
Pressure ((hw * Pf). (()(()
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 819
OpenEnterprise Schema reynoldsnumber:float
Represents the pipe Reynolds number. (() upstreamstaticpressure:float
Represents the instantaneous upstream static pressure in psia or kPa. velocityofapproachev:float
Represents the velocity of approach factor. (() zf1:float
Represents the compressibility at upstream flowing conditions. (~)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 820
rocparameterpattern
OpenEnterprise Schema
Derived From:
Description: dvi_device
A template that defines a group of Roc parameters that are to be read together for a Device. In addition, a ‘Parameter Pattern’ can be used to define which signals (in RocRealAnalog and RocDigital tables) to automatically create.
Attributes: accessarea:char nextid:integer
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users.
Used internally by OpenEnterprise. parameterpatternid:integer
A unique id number for the Pattern. parameterpatternname:char
The unique name of the Pattern.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 821
rocparameterpatternpoint
OpenEnterprise Schema
Derived From:
Description: dvi_datum
Defines a group of Roc parameters that are to be read together.
Attributes: accessarea:char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. parameterlist:char
List of parameter numbers for this point type that are to be read for this
ParameterCollectionPattern. pointtype:integer
Roc Point Type userdefinedpointtypeid:integer
The id number of a user defined point type.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 822
rocparameters
Derived From:
Description:
To be completed
To be completed
Attributes: abbrev:char access:char
To be completed
To be completed accessarea:char
To be completed additionalnextid:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 823 additionalquantity:integer
To be completed alarmlogalarmcode:integer
To be completed alarmlogassociatedparameter:integer
To be completed alarmlogassociatedpointtype:integer
To be completed conversionid:integer
To be completed datatype:char
To be completed defaultaddsignal:bool
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 824 defaulttext:char
To be completed isalarmcodeparameter:bool
To be completed length:integer
To be completed limitparameter:integer
To be completed mainentry:bool name:char nameid:char
To be completed
To be completed
To be completed oealarmcondition:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 825
To be completed oedbfieldname:char
To be completed oedbfieldtype:char
To be completed oedbsignaltype:char
To be completed oedbtablename:char
To be completed parameter:float pointtype:integer
To be completed parameterid:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 826
To be completed rangecheckid:integer
To be completed rocdatatype:char
To be completed sequence:integer
To be completed systemoruserupdate:char
To be completed unitsimperial:integer
To be completed unitsmetric:integer
To be completed unitsparameter:float
To be completed userdefinedpointtypeid:integer
To be complete
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 827
rocplusanaloginputs
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: actualscantime:float
Actual number of seconds between updates of the AI. aitype:integer
Indicates the type of AI module (12 or 16 bit).
0 = AI 12 Bit
1 = AI 16 Bit alarmcode:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 828
OpenEnterprise Schema alarmdeadband:float
Provides a range (() that the EU Value (parameter #21) may move between without causing another alarm. alarming:integer
If enabled, alarms may be generated and sent to the Alarm Log. 0 =
Disabled, 1 = Enabled. averaging:integer
If enabled, the filtered raw A/D value is averaged over the Scan Period.
If disabled, the current filtered raw A/D value is used when the Scan
Period is reached. 0 = Disabled, 1 = Enabled. calibrationmode:integer
Indicates what the calibration for the AI is doing. 0 = Use Current
Calibration, 1 = Start Calibration, 2 = Calibrate, 3 = Restore Previous
Calibration, 4 = Stop Calibration. Note: No event is logged for this parameter and should possibly labeled as R/O in any external Roc
Protocol Specification calibrationtimer:float
Number of seconds until a calibration timeout occurs. calibrationtype:integer
During calibration, determines what the Set Value (parameter #19) is replacing. 0 = Nothing, 1 = Set Zero, 2 = Set Span, 3 = Set Mid Point
#1, 4 = Set Mid Point #2, 5 = Set Mid Point #3, 6 = Set Offset (Zero
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 829
OpenEnterprise Schema
Shift). Note: No event is logged for this parameter and should possibly labeled as R/O in any external Roc Protocol Specification clipping:integer
If enabled, then the EU Value (parameter #21) cannot be less than the
Low Low Alarm EU (parameter #23) or greater than the High High Alarm
EU (parameter #26). If disabled, no limiting of the EU Value (parameter
#21) takes place. 0 = Disabled, 1 = Enabled. euvalue:float
Value in Engineering Units. failsafemode:integer
To be completed failsafevalue:float
The AI’s EU Value will be set to the Failsafe Value if Failsafe Mode is
Enabled and the AI is in Point Fail. filter:integer
Percentage of last raw A/D reading to be weighted with the new raw A/D reading. highalarmeu:float
Alarm value for High Alarm.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 830
OpenEnterprise Schema highhighalarmeu:float
Alarm value for High High Alarm and maximum EU Value (parameter
#21) if Clipping (parameter #22) is enabled. lowalarmeu:float
Alarm value for Low Alarm. lowlowalarmeu:float
Alarm value for Low Low Alarm and minimum EU Value (parameter #21) if Clipping (parameter #22) is enabled. manualvalue:float
Current EU Value of AI while performing calibration. midpointeu1:float
Second lowest calibrated EU value. midpointeu2:float
Third lowest or highest calibrated EU value. midpointeu3:float
Second highest calibrated EU value.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 831
OpenEnterprise Schema midpointraw1:integer
Second lowest calibrated raw A/D input. midpointraw2:integer
Third lowest or highest calibrated raw A/D input. midpointraw3:integer
Second highest calibrated raw A/D input. offsetzeroshift:float
Value to be added to all calculated EU values. ratealarmeu:float
Alarm value for maximum change of EU Value (parameter #21) between
Scan Periods. rawadinput:integer
Raw A/D reading used to calculate the EU Value (parameter #21). scanning:integer
If disabled, field inputs are ignored and no changes will occur unless manually entered. 0 = Disabled, 1 = Enabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 832
OpenEnterprise Schema scanperiod:float
Number of seconds between updates of the AI. setvalue:float spaneu:float
Desired EU value for a calibration point. Note: No event is logged for this parameter and should possibly labeled as R/O in any external Roc
Protocol Specification
Highest calibrated EU value. spanraw:integer
Highest calibrated raw A/D input. srbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled. srbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled. unitstag:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 833
OpenEnterprise Schema
Describes the units used by the AI. Values must be printable ASCII characters. zeroeu:float zeroraw:integer
Lowest calibrated EU value.
Lowest calibrated raw A/D input.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 834
rocplusanalogoutputs
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: alarmcode:integer
To be completed alarming:integer
If enabled, alarms may be generated and sent to the Alarm Log. 0 =
Disabled, 1 = Enabled. euvalue:float
Value in Engineering Units. failsafeonreset:integer
If enabled, the Raw D/A Output (parameter #13) will be set to the
Failsafe value (parameter #22) on a restart of any kind. If disabled, the last EU Value (parameter #13) or the last saved EU Value will be used
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 835
OpenEnterprise Schema to determine the Raw D/A Output (parameter #13) after a restart. 0 =
Use last EU Value on reset, 1 = Use Failsafe value on Reset. failsafevalue:float
This is the value that will be outputted when the unit is started and the
Failsafe on Reset Parameter (Parameter 7) is set to 1, Use Failsafe value on reset. manualvalue:float
Manual Value used when Scanning (parameter #2) is in manual mode physicalvalue:float
Indicates the current value of the output in Engineering Units. rawdaoutput:integer
Calculated Digital-to-Analog value based upon EU Value (parameter
#12). scanning:integer spaneu:float
If disabled, no changes to the output will occur. If in Manual, only the user can change the values of the AO. If in Automatic, anything can change the values of the AO.
0 = Disabled, 1 = Automatic , 2 = Manual
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 836
OpenEnterprise Schema
Maximum EU Value (parameter #12) possible. spanraw:integer
Maximum D/A count the calculated Raw D/A Output (parameter #13) will be when the entered EU Value (parameter #12) is greater than or equal to the entered Span EU (parameter #11). srbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled. srbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled. unitstag:char zeroeu:float zeroraw:integer
Describes the units used by the AO. Values must be printable ASCII characters.
Minimum EU Value (parameter #12) possible.
Minimum D/A count the calculated Raw D/A Output (parameter #13) will be when the entered EU Value (parameter #12) is less than or equal to the entered Zero EU (parameter #10).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 837
rocplusclock
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: day:integer
The day. daylightsavingsenable:integer
Indicates if daylight savings time is enabled. 0 = Disabled, 1 = Enabled dayofweek:integer
The day of the week.
1 = Sunday
2 = Monday
3 = Tuesday
4 = Wednesday
5 = Thursday
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 838
6 = Friday
OpenEnterprise Schema hours:integer
7 = Saturday
The hours. microseconds:integer
The microseconds. minutes:integer month:integer
The minutes.
The month. seconds:integer time:datetime
To be completed
Number of seconds elapsed since 12:00 a.m. Jan. 1, 1970.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 839 timedstoffset:integer
To be completed year:integer
The year.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 840
rocpluscommports
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: baudrategeneratorused:integer
The baud rate generator used by this com port. Each port may use a different generator, however, only 4 generators exist. See Point Type
91, System Variables, Parameter 31-34. commtype:integer
0 = No Comm Module Installed
9 = MVS
10 = RS-232
11 = RS-485
12 = Modem
13 = HART
This parameter is updated when a module insertion or removal is detected by the system.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 841
OpenEnterprise Schema configurationcommand:char
The commands needed to initialize a modem. connectcommand:char
The Hayes compatible modem command needed to dial out for SRBX communications. connecttime:float
The amount of time in seconds the ROC809 waits after initiating a call to receive a connect message before terminating a call. databits:integer
The number of data bits in a character. disconnecttime:float
Time in seconds that the ROC809 will wait before disconnecting if there is no activity. 0 disables. enablesrbx:integer
If this is enabled all SRBX messages will be sent out this port. If is disabled, none will be sent.
0 = Disable SRBX for this port
1 = Enable SRBX for this port
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 842
OpenEnterprise Schema inactivitytime:float
Time in seconds that the ROC809 will wait, without receiving a signal, before it resets the modem. The inactivity timer looks at the valid receive counter to determine if the signal has been received. 0 disables. invalidmessagebytetime:datetime
The time of the last unsuccessful message byte was received by the
ROC809. Indicated by the number of seconds since midnight Jan 1,
1970. invalidmessagebytetimedstoffset:integer
To be completed keyoffdelay:float
The period to delay turning the RTS signal off after a message has been sent. This value is in seconds. keyondelay:float
The period to wait after turning the RTS signal on before a message can be sent. This value is in seconds. modbussuccessfulmessagetime:datetime
The time of the last successful function code received by the ROC809.
Indicated by the number of seconds since midnight Jan 1, 1970.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 843 modbussuccessfulmessagetimedstoffset:integer
To be completed
OpenEnterprise Schema modbusvalidreceivecounter:integer
The number of valid Modbus messages received by the ROC for this port. It can be cleared by the user. modemdisconnectcommand:char
The user can use a different disconnect string for a modem. modemstatus:integer
This is the numeric response from the modem. A non-Hayes compatible modem will not provide this information.
0 = OK. modemtype:integer
The type of modem. This will not be detected when the card is plugged in. 0 = None, 1 = External, 2 = Internal. Note 2 can not be written by the user. numberofinvalidmessagebytes:integer
The number of invalid Roc Protocol or Modbus bytes received. parity:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 844
OpenEnterprise Schema
For parity error checking, the host adds a 1 or 0 bit to the character to make it even or odd. The receiver then decodes this. An error occurs if the sum of the bits is not the way it was sent out.
None = 0, Odd = 1, Even = 2. portowner:integer
The program that currently owns the port. Messages will be routed directly to the owner, bypassing the ROC protocol.
0 = ROC Protocol / Modbus Slave
1 = Modbus Master (Comm 1 – 5)
2 = DS800
3 = LCD (Comm 1)
4 = I/O Module (Comm 3 – 5)
5 = User C Program 1
6 = User C Program 2
7 = User C Program 3
8 = User C Program 4
9 = User C Program 5
10 = User C Program 6
11 = User C Program 7
12 = User C Program 8
255 = DMMI (FAS use only) reserved1:integer
Address of the 4th destination for the store and forward path. SRBX
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 845
OpenEnterprise Schema must be enabled for this to function. reserved2:integer
Group number of the 4th destination for store and forward. SRBX must be enabled for this to function. reserved3:integer
Used to test communications. The RTS line will be toggle on for the number of seconds specified and then be off for the number of seconds specified (above 0). reserved4:integer
Used to set the response delay time for individual ports. Delay in
Milliseconds. rocprotocolsecuritystatus:integer
Enables security for the communications port 1. Disabled = 0, Enabled
= 1. rocprotocolsuccessfulmessagetime:datetime
The time of the last successful Opcode received by the ROC809.
Indicated by the number of seconds since midnight Jan 1, 1970. rocprotocolsuccessfulmessagetimedstoffset:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 846
OpenEnterprise Schema rocprotocolvalidreceivecounter:integer
The number of valid ROC Protocol messages received by the ROC for this port. It can be cleared by the user. srbxalarmindex:integer
The index into the alarm table that corresponds to the alarm that caused an SRBX. srbxhostaddress:integer
Used to identify the SRBX host. srbxhostgroup:integer
Used to identify the SRBX host. srbxretrycount1:integer
The number of retries for the 1st SRBX to use. 0 = disable, 255 = continuous. srbxretrycount2:integer
The number of retries for the 1st SRBX to use. 0 = disable, 255 = continuous. srbxretrycount3:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 847
OpenEnterprise Schema
The number of retries for the 1st SRBX to use. 0 = disable, 255 = continuous. srbxstatus:integer
0 = SRBX is currently inactive
1 = SRBX is currently active for this port srbxtimebase1:float
Time in seconds that the ROC809 will use as the 1st SRBX delay. srbxtimebase2:float
Time in seconds that the ROC809 will use as the 2nd SRBX delay. srbxtimebase3:float
Time in seconds that the ROC809 will use as the 3rd SRBX delay. stopbits:integer
The number of stop bits in a character. storeandforwardport:integer
If this is enabled all store and forward messages will be sent out this port. If it is disabled, none will be sent.
0 = Do Not store and forward for this port
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 848
1 = Store and forward for this port.
OpenEnterprise Schema storeforwardaddress1:integer
Address of the 1st destination for the store and forward path. SRBX must be enabled for this to function. storeforwardaddress2:integer
Address of the 2nd destination for the store and forward path. SRBX must be enabled for this to function. storeforwardaddress3:integer
Address of the 3rd destination for the store and forward path. SRBX must be enabled for this to function. storeforwardgroup1:integer
Group number of the 1st destination for the store and forward path.
SRBX must be enabled for this to function. storeforwardgroup2:integer
Group number of the 2nd destination for the store and forward path.
SRBX must be enabled for this to function. storeforwardgroup3:integer
Group number of the 3rd destination for store and forward. SRBX must be enabled for this to function.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 849 transmitcounter:integer
Number of messages sent.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 850
rocplusconfigurableopcode
Derived From:
Description:
To be completed
To be completed
Attributes: data1:char data10:char data10_l:integer data10_p:integer
User configurable
User configurable
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 851 data10_t:integer data11:char data11_l:integer data11_p:integer data11_t:integer data12:char data12_l:integer
To be completed
User configurable
To be completed
To be completed
To be completed
User configurable
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 852 data12_p:integer data12_t:integer data13:char data13_l:integer data13_p:integer data13_t:integer data14:char
To be completed
To be completed
User configurable
To be completed
To be completed
To be completed
User configurable
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 853 data14_l:integer data14_p:integer data14_t:integer data15:char data15_l:integer data15_p:integer data15_t:integer
To be completed
To be completed
To be completed
User configurable
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 854 data16:char data16_l:integer data16_p:integer data16_t:integer data17:char data17_l:integer data17_p:integer
User configurable
To be completed
To be completed
To be completed
User configurable
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 855 data17_t:integer data18:char data18_l:integer data18_p:integer data18_t:integer data19:char data19_l:integer
To be completed
User configurable
To be completed
To be completed
To be completed
User configurable
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 856 data19_p:integer data19_t:integer data1_l:integer data1_p:integer data1_t:integer data2:char data20:char
To be completed
To be completed
To be completed
To be completed
To be completed
User configurable
User configurable
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 857 data20_l:integer data20_p:integer data20_t:integer data21:char data21_l:integer data21_p:integer data21_t:integer
To be completed
To be completed
To be completed
User configurable
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 858 data22:char data22_l:integer data22_p:integer data22_t:integer data23:char data23_l:integer data23_p:integer
User configurable
To be completed
To be completed
To be completed
User configurable
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 859 data23_t:integer data24:char data24_l:integer data24_p:integer data24_t:integer data25:char data25_l:integer
To be completed
User configurable
To be completed
To be completed
To be completed
User configurable
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 860 data25_p:integer data25_t:integer data26:char data26_l:integer data26_p:integer data26_t:integer data27:char
To be completed
To be completed
User configurable
To be completed
To be completed
To be completed
User configurable
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 861 data27_l:integer data27_p:integer data27_t:integer data28:char data28_l:integer data28_p:integer data28_t:integer
To be completed
To be completed
To be completed
User configurable
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 862 data29:char data29_l:integer data29_p:integer data29_t:integer data2_l:integer data2_p:integer data2_t:integer
User configurable
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 863 data3:char data30:char data30_l:integer data30_p:integer data30_t:integer data31:char data31_l:integer
User configurable
User configurable
To be completed
To be completed
To be completed
User configurable
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 864 data31_p:integer data31_t:integer data32:char data32_l:integer data32_p:integer data32_t:integer data33:char
To be completed
To be completed
User configurable
To be completed
To be completed
To be completed
User configurable
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 865 data33_l:integer data33_p:integer data33_t:integer data34:char data34_l:integer data34_p:integer data34_t:integer
To be completed
To be completed
To be completed
User configurable
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 866 data35:char data35_l:integer data35_p:integer data35_t:integer data36:char data36_l:integer data36_p:integer
User configurable
To be completed
To be completed
To be completed
User configurable
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 867 data36_t:integer data37:char data37_l:integer data37_p:integer data37_t:integer data38:char data38_l:integer
To be completed
User configurable
To be completed
To be completed
To be completed
User configurable
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 868 data38_p:integer data38_t:integer data39:char data39_l:integer data39_p:integer data39_t:integer data3_l:integer
To be completed
To be completed
User configurable
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 869 data3_p:integer data3_t:integer data4:char data40:char data40_l:integer data40_p:integer data40_t:integer
To be completed
To be completed
User configurable
User configurable
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 870 data41:char data41_l:integer data41_p:integer data41_t:integer data42:char data42_l:integer data42_p:integer
User configurable
To be completed
To be completed
To be completed
User configurable
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 871 data42_t:integer data43:char data43_l:integer data43_p:integer data43_t:integer data44:char data44_l:integer
To be completed
User configurable
To be completed
To be completed
To be completed
User configurable
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 872 data44_p:integer data44_t:integer data4_l:integer data4_p:integer data4_t:integer data5:char data5_l:integer
To be completed
To be completed
To be completed
To be completed
To be completed
User configurable
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 873 data5_p:integer data5_t:integer data6:char data6_l:integer data6_p:integer data6_t:integer data7:char
To be completed
To be completed
User configurable
To be completed
To be completed
To be completed
User configurable
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 874 data7_l:integer data7_p:integer data7_t:integer data8:char data8_l:integer data8_p:integer data8_t:integer
To be completed
To be completed
To be completed
User configurable
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 875 data9:char data9_l:integer data9_p:integer data9_t:integer
User configurable
To be completed
To be completed
To be completed sequencerevision:float
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 876
rocplusdiscreteinputs
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: accumulatedvalue:integer
Number of times the Status (parameter #3) goes from OFF to ON. actualscantime:float
Actual Scan Time alarmcode:integer
To be completed alarming:integer
If enabled, alarms may be generated and sent to the Alarm Log. 0 =
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 877
Disabled, 1 = Enabled.
OpenEnterprise Schema cumulativeofftime:float
Number of seconds when the Status (parameter #3) is in the OFF state. cumulativeontime:float
Number of seconds when the Status (parameter #3) is in the ON state. filter:float
Number of seconds that a DI must remain in the ON state before it is recognized as valid and the Status (parameter #3) is changed. invertstatus:integer
If enabled, the field input will be inverted in the Status (parameter #3 -
ON becomes OFF and vice-versa). 0 = Invert Status Disabled, 1 =
Invert Status Enabled. latchstatus:integer
If enabled, then, on an active transition of the input, the Status
(parameter #3) will change to ON and remain in the ON state until it is cleared manually. 0 = Latch Status Disabled, 1 = Latch Status Enabled. modulescanperiod:float
Scan Period in mS.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 878
OpenEnterprise Schema physicalstatus:integer
Indicates the current state of the hardware. pointstatus:integer
Indicates what state the DI is currently in, ON (1) or OFF (0). scanning:integer
If disabled, field inputs are ignored and no changes will occur unless manually entered. 0 = Disabled, 1 = Enabled. srbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled. srbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 879
rocplusdiscreteoutputs
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: accumulatedvalue:integer
Number of times the Status (parameter #8) goes from OFF to ON. alarmcode:integer
To be completed alarming:integer
If enabled, alarms may be generated and sent to the Alarm Log. 0 =
Disabled, 1 = Enabled. cycletime:float
Number of seconds for when TDO Mode (parameter #13) and Toggle
Mode (parameter #12) are selected. The Status (parameter #8) will be
ON for the calculated Time On (parameter #14) based upon the entered
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 880
OpenEnterprise Schema
EU Value (parameter #20). The Status will then be turned OFF based upon the Cycle Time minus the Time On. dotype:integer euvalue:float
To be completed
Value in Engineering Units. failsafeonreset:integer
If enabled, the Status (parameter #8) will be set to the status indicated in
‘Failsafe Status Value’ (Parameter #22) on a restart of any kind. If disabled, the last Status before the restart will be used. 0 = Output Last
Status on Reset, 1 = Use Failsafe value on Reset. faultvalue:integer
This is the status the output will be placed in when the unit is started and the Failsafe on Reset Parameter (Parameter 7) is set to 1, Use Failsafe value on reset. highreadingeu:float
Maximum EU Value (parameter #20) possible. highreadingtime:float
Maximum number of seconds the calculated Time On (parameter #14) will be when the entered EU Value (parameter #20) is greater than or
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 881
OpenEnterprise Schema equal to the entered High Reading EU (parameter #19). invertoutputmode:integer
DL8000 lowreadingeu:float
Minimum EU Value (parameter #20) possible. lowreadingtime:float
Minimum number of seconds the calculated Time On (parameter #14) will be when the entered EU Value (parameter #20) is less than or equal to the entered Low Reading EU (parameter #18). manualvalue:integer
Manual Value used when Scanning (parameter #2) is in manual mode momentaryactive:integer
Indicates that the DO currently has the Momentary ability active. 0 =
Momentary Not Active, 1 = Momentary Active. momentarymode:integer
If enabled, the Status (parameter #8) will be turned ON for the entered
Time On (parameter #14) and then be turned OFF. 0 = Momentary
Disabled, 1 = Momentary Enabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 882
OpenEnterprise Schema physicaloutput:integer
Indicates what state the DO is currently in, ON (1) or OFF (0). pointstatus:integer
Indicates what state the DO is currently in, ON (1) or OFF (0). reserved1:float scanning:integer
RESERVED
If disabled, no changes to the output will occur. If in Manual, only the user can change the values of the AO. If in Automatic, anything can change the values of the AO.
0 = Disabled, 1 = Automatic , 2 = Manual srbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled. srbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled. timeddiscreteoutputtdomode:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 883
OpenEnterprise Schema
If enabled, the Status (parameter #8) will be turned ON for a calculated
Time On (parameter #14) based upon the entered EU Value (parameter
#20). After the Time On has expired, the Status will be turned OFF and remain that way until a new EU Value is entered. 0 = TDO Disabled, 1 =
TDO Enabled. timeon:float
Number of seconds the Status (parameter #8) will be turned ON for if in
TDO, Toggle, or Momentary Mode. togglemode:integer
If enabled, the Status (parameter #8) will be turned ON for the entered
Time On (parameter #14) and then turned OFF for the same Time On.
The Status will continue to cycle between the ON and OFF states. 0 =
Toggle Disabled, 1 = Toggle Enabled. unitstag:char
Describes the units used by the DO. Values must be printable ASCII characters.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 884
rocplusfstparameters
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: actualstepspertaskcycle:integer
Actual Instructions completed this cycle codesize:integer
Size, in bytes, of the FST code. This size does not include storage needed for register names, description, or version. compareflagsvd:integer
Stores the result of a Boolean expression.
0 – FALSE
1 – TRUE
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 885
OpenEnterprise Schema executiondelay:integer
Execution delay between FST instructions. Resolution is tenths of a second. fstcycletime:float
Duration – defined as the time expired from the beginning of this FST and the beginning of its previous execution fstdescription:char
Contains a short description about the FST that is running. The user sets this before the FST is uploaded to the ROC809. fstversion:char
Stores information about the version of the FST code. The user sets this before the FST is uploaded to the ROC809. instructionpointer:integer
Contains the location of the FST function to be executed next. If an error occurs, the Instruction Pointer will be set to the location of the parameter that caused the error. This parameter may also be called a program counter. message1:char
Text string to be output onto display. String is associated with Message
Data. Written to by FST. message2:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 886
OpenEnterprise Schema
Generic text field. This field is not used by any FST. It is only used as a storage space for user input. messagedata:char
Text string used to output value to LCD. messagedata2:char
Text string used to output value to LCD. miscellaneous1:integer
Single byte register that may be used by an FST. miscellaneous2:integer
Single byte register that may be used by an FST. miscellaneous3:integer
To be completed miscellaneous4:integer
Single byte register that may be used by an FST. register1:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 887
OpenEnterprise Schema
Register used as an input to an FST or as a location to store FST data. register10:float register2:float register3:float register4:float register5:float register6:float register7:float
Register used as an input to an FST or as a location to store FST data.
Register used as an input to an FST or as a location to store FST data.
Register used as an input to an FST or as a location to store FST data.
Register used as an input to an FST or as a location to store FST data.
Register used as an input to an FST or as a location to store FST data.
Register used as an input to an FST or as a location to store FST data.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 888
OpenEnterprise Schema
Register used as an input to an FST or as a location to store FST data. register8:float
Register used as an input to an FST or as a location to store FST data. register9:float
Register used as an input to an FST or as a location to store FST data. resultregister:float
Register used to store result of last FST operation. runstatus:integer
This parameter stores the run state of the FST.
0 – FST is not running.
1 – FST is running.
5 – Indicates FST has shut down due to an invalid point reference.
8 – FST Editor initiates the Trace mode.
9 – Indicates that the FST in ROC809 is processing. stepspertaskcycle:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 889 timer1:integer
OpenEnterprise Schema
Time left for count down timer. Timer resolution is 100ms. timer2:integer timer3:integer timer4:integer
Time left for count down timer. Timer resolution is 100ms.
Time left for count down timer. Timer resolution is 100ms.
Time left for count down timer. Timer resolution is 100ms.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 890
rocplusfstregistertags
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: registertag1:char
To be completed registertag10:char
Text string used as a label for Register 10 (R10). registertag2:char registertag3:char
Text string used as a label for Register 2 (R2).
Text string used as a label for Register 3 (R3).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 891 registertag4:char
OpenEnterprise Schema
Text string used as a label for Register 4 (R4). registertag5:char registertag6:char registertag7:char registertag8:char registertag9:char
Text string used as a label for Register 5 (R5).
Text string used as a label for Register 6 (R6).
Text string used as a label for Register 7 (R7).
Text string used as a label for Register 8 (R8).
Text string used as a label for Register 9 (R9).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 892
rocplushistorypoint
OpenEnterprise Schema
Derived From:
Description:
RocHistoryPoint_Table
Additional fields for Roc Plus History Point Parameter data. There will normally be one entry in this table for each history point within the Roc device.
Attributes: currentvalue:float
Plus: Roc Parameter 5 (history segment point config) lastdailyvalue:float
Plus: Roc Parameter 6 (history segment point config) todaymaxtime:datetime
Plus: Roc Parameter 9 (history segment point config) todaymaxtimedstoffset:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 893
To be completed
OpenEnterprise Schema todaymaxvalue:float
Plus: Roc Parameter 10 (history segment point config) todaymintime:datetime
Plus: Roc Parameter 7 (history segment point config) todaymintimedstoffset:integer
To be completed todayminvalue:float
Plus: Roc Parameter 8 (history segment point config) ydaymaxtime:datetime
Plus: Roc Parameter 13 (history segment point config) ydaymaxtimedstoffset:integer
To be completed ydaymaxvalue:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 894
OpenEnterprise Schema
Plus: Roc Parameter 14 (history segment point config) ydaymintime:datetime
Plus: Roc Parameter 11 (history segment point config) ydaymintimedstoffset:integer
To be completed ydayminvalue:float
Plus: Roc Parameter 12 (history segment point config)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 895
OpenEnterprise Schema
rocplusmodbusconfigurationparameters
Derived From:
Description:
To be completed
To be completed
Attributes: byteorder:integer
Controls which byte is sent out first for floats, short integers, and long integers.
0 = LSB first (Associated with little endian processors)
1 = MSB first (Associated with big endian processors) eventlogenable:integer
Controls if changes to Modbus registers are logged to the event log or not (Slave mode only).
0 = No Logging
1 = Log to Event Log highfloatscale1:float
Contains the upper limit in float range 1 when converting integers to
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 896 floats and vice-versa.
OpenEnterprise Schema highfloatscale2:float
Contains the upper limit in float range 2 when converting integers to floats and vice-versa. highfloatscale3:float
Contains the upper limit in float range 3 when converting integers to floats and vice-versa. highfloatscale4:float
Contains the upper limit in float range 4 when converting integers to floats and vice-versa. highfloatscale5:float
Contains the upper limit in float range 5 when converting integers to floats and vice-versa. highfloatscale6:float
Contains the upper limit in float range 6 when converting integers to floats and vice-versa. highfloatscale7:float
Contains the upper limit in float range 7 when converting integers to floats and vice-versa.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 897
OpenEnterprise Schema highfloatscale8:float
Contains the upper limit in float range 8 when converting integers to floats and vice-versa. highintegerscale:integer
Contains the upper limit value when scaling floating-point data. lowfloatscale1:float
Contains the lower limit in float range 1 when converting integers to floats and vice-versa. lowfloatscale2:float
Contains the lower limit in float range 2 when converting integers to floats and vice-versa. lowfloatscale3:float
Contains the lower limit in float range 3 when converting integers to floats and vice-versa. lowfloatscale4:float
Contains the lower limit in float range 4 when converting integers to floats and vice-versa.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 898
OpenEnterprise Schema lowfloatscale5:float
Contains the lower limit in float range 5 when converting integers to floats and vice-versa. lowfloatscale6:float
Contains the lower limit in float range 6 when converting integers to floats and vice-versa. lowfloatscale7:float
Contains the lower limit in float range 7 when converting integers to floats and vice-versa. lowfloatscale8:float
Contains the lower limit in float range 8 when converting integers to floats and vice-versa. lowintegerscale:integer
Contains the lower limit value when scaling floating-point data. mastercontinuouspollingenable:integer
Controls whether the Modbus master poll request sequence specified is executed on a continuous basis (Master mode only).
0 = Continuous polling disabled
1 = Continuous polling enabled
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 899
OpenEnterprise Schema masternumberofrequests:integer
Contains the total number of Modbus requests to be made when the
Modbus master poll request trigger (parameter #4) is set (Master mode only). masterpollnumberofretries:integer
Number of retries Modbus Master will attempt on a particular request number in the Master Poll Table before giving-up and going to the next request number. (Master mode only). masterpollrequestdelay:float
Contains the delay time in seconds between continuous master poll requests (Continuous poll mode only). masterpollrequesttrigger:integer
Controls the initiation of a Modbus master polling sequence (Master mode only).
0 = No polling
1 = Begin polling with the entry in the Modbus master table indicated by the master starting request number (parameter #5) and continue through the table for the number of master requests (parameter #6). This parameter will be reset by the system when the polling sequence has been completed. masterpolltimeout:integer
To be completed masterstartingrequestnumber:integer
Contains the request number in the Modbus master table to begin with
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 900
OpenEnterprise Schema when the Modbus master poll request trigger (parameter #4) is set
(Master mode only). reserved1:integer
Contains the status of the Modbus master transmission (Master mode only).
0 = Inactive
1 = Transmission in progress slaveexceptionstatus:integer
Contains the error code for the last Modbus message received (Slave mode only).
0 = No Error
1 = Illegal Function
2 = Illegal Data Address
3 = Illegal Data Value transmissionmode:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 901
rocplusmultivariablesensor
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: actiononfailure:integer
Indicates whether the DP Reading, SP Reading, TMP Reading, and DP
Reverse Reading should retain last value or be set to the Fault Value parameters when a 485 or Sensor Communication Failure occurs. 0 =
Retain Last Value, 1 = Use Fault Value parameters. calibratecommand:integer
Tells the MVS Interface what process variable is being calibrated. 0 =
No Action, 1 = Calibrate DP, 2 = Calibrate SP, 3 = Calibrate TMP, 4 =
Calibrate Pressure Effect, 5 = Save MVS Calibration, 6 = Set Defaults. calibratesetvalue:float
Desired value for a calibration point.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 902
OpenEnterprise Schema calibratetype:integer
Tells the MVS Interface what point is being calibrated. 0 = None, 1 =
Set Zero, 2 = Set Span, 3 = Set Mid Point #1, 4 = Set Mid Point #2, 5 =
Set Mid Point #3, 6 = Sensor Setup, 7 = Sensor Restore. dpalarmcode:integer
To be completed dpalarmdeadband:float
Provides a range (() that the DP Reading (parameter #19) may move between without causing another alarm in inches of H2O or kPa. dpalarming:integer
If enabled, DP alarms may be generated and sent to the Alarm Log. 0 =
DP Alarming Disabled, 1 = DP Alarming Enabled. dpcalibrationmidpoint1:float
Second lowest calibrated DP Reading value in inches of H2O or kPa. dpcalibrationmidpoint2:float
Third lowest or highest calibrated DP Reading value in inches of H2O or kPa. dpcalibrationmidpoint3:float
Second highest calibrated DP Reading value in inches of H2O or kPa.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 903
OpenEnterprise Schema dpfaultvalue:float
Value that the DP Reading (parameter #19) will be set to if a 485
Communication Failure or Sensor Communication Failure occurs in inches of H2O or kPa. The DP Reverse Reading (parameter #20) will be set to the same value of the opposite sign. dphighalarmeu:float
DP Alarm value for DP High Alarm in inches of H2O or kPa. dplowalarmeu:float
DP Alarm value for DP Low Alarm in inches of H2O or kPa. dpreading:float
Current Differential Pressure in inches of H2O or kPa. dpreversereading:float
Current Differential Pressure Reversed in inches of H2O or kPa. dpspancalibrationpoint:float
Highest calibrated DP Reading value in inches of H2O or kPa. dpsrbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 904
OpenEnterprise Schema
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled. dpsrbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled. dpzerocalibrationpoint:float
Lowest calibrated DP Reading value in inches of H2O or kPa. inchesh2o:integer
Indicates the reference temperature for calculating pressure properly. 0
= Inches H2O at 60 (F, 1 = Inches H2O at 68 (F. manualdp:float
Current DP Reading while performing calibration in inches of H2O or kPa. manualsp:float manualtmp:float
Current SP Reading while performing calibration in psi or kPa.
Current TMP Reading while performing calibration in (F or (C.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 905 pollmode:integer
OpenEnterprise Schema
Sets the operation for the MVS Module. 0 = Off Scan Mode, 1 = Normal
Poll Mode, 2 = Input Freeze Mode, 4 = Configuration Poll Mode, 5 = Set
Tag and Address Mode. pressureoffset:float
Calibrated Static Pressure Offset pressuretaplocation:integer
Indicates if the static pressure is an upstream or downstream reading. 0
= Downstream, 1 = Upstream. sensoraddress:integer
Unique address of MVS to allow for multi-drop communications. sensoralarmcode:integer
To be completed sensoralarming:integer
If enabled, alarms may be generated and sent to the Alarm Log. 0 =
Disabled, 1 = Enabled. sensorrangestatus:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 906
OpenEnterprise Schema sensorsrbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled.
Note: For 485 and Sensor Communication Failures only. sensorsrbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled.
Note: For 485 and Sensor Communication Failures only. sensortype:integer
0=Std MVS, 1=Smart MVS, 2=Smart 3095 sensorvoltage:float
Current voltage of MVS in volts. softwarerevisionmvsinterface:integer
Current software revision of the MVS Interface software. spalarmcode:integer
To be completed spalarmdeadband:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 907
OpenEnterprise Schema
Provides a range (() that the SP Reading (parameter #35) may move between without causing another alarm in psi or kPa. spalarming:integer
If enabled, SP alarms may be generated and sent to the Alarm Log. 0 =
SP Alarming Disabled, 1 = SP Alarming Enabled. spcalibrationmidpoint1:float
Second lowest calibrated SP Reading value in psi or kPa. spcalibrationmidpoint2:float
Third lowest or highest calibrated SP Reading value in psi or kPa. spcalibrationmidpoint3:float
Second highest calibrated SP Reading value in psi or kPa. spfaultvalue:float
Value that the SP Reading (parameter #35) will be set to if a 485
Communication Failure or Sensor Communication Failure occurs in psi or kPa. sphighalarmeu:float
SP Alarm value for SP High Alarm in psi or kPa.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 908
OpenEnterprise Schema splowalarmeu:float
SP Alarm value for SP Low Alarm in psi or kPa. spreading:float
Current Static Pressure in psi or kPa. spspancalibrationpoint:float
Highest calibrated SP Reading value in psi or kPa. spsrbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled. spsrbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled. spzerocalibrationpoint:float
Lowest calibrated SP Reading value in psi or kPa. staticpressureeffect:float
Calibrated Zero Shift for DP in inches of H2O or kPa.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 909 tmpalarmcode:integer
To be completed
OpenEnterprise Schema tmpalarmdeadband:float
Provides a range (() that the TMP Reading (parameter #50) may move between without causing another alarm in (F or (C. tmpalarming:integer
If enabled, TMP alarms may be generated and sent to the Alarm Log. 0
= TMP Alarming Disabled, 1 = TMP Alarming Enabled. tmpcalibrationmidpoint1:float
Second lowest calibrated TMP Reading value in (F or (C. tmpcalibrationmidpoint2:float
Third lowest or highest calibrated TMP Reading value in (F or (C. tmpcalibrationmidpoint3:float
Second highest calibrated TMP Reading value in (F or (C. tmpfaultvalue:float
Value that the TMP Reading (parameter #50) will be set to if a 485
Communication Failure or Sensor Communication Failure occurs in (F or
(C.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 910
OpenEnterprise Schema tmphighalarmeu:float
TMP Alarm value for TMP High Alarm in (F or (C. tmplowalarmeu:float
TMP Alarm value for TMP Low Alarm in (F or (C. tmpreading:float
Current Temperature in (F or (C. tmpspancalibrationpoint:float
Highest calibrated TMP Reading value in (F or (C. tmpsrbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled. tmpsrbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled. tmpzerocalibrationpoint:float
Lowest calibrated TMP Reading value in (F or (C.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 911 units:integer
OpenEnterprise Schema
Indicates what engineering units the process variables will be. 0 =
English Units, 1 = Metric Units.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 912
rocpluspidcontrolparameters
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: actiononprocessvariablefailure:integer
Indicates whether in Manual or Automatic mode for PID Control. 0 =
Manual, 1 = Automatic. actionwaittime:float
To be completed actualloopperiod:float
Actual frequency of execution of the PID algorithm in seconds. controloutputtype:integer
Indicates whether discrete outputs are being used to control the PID. 0
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 913
OpenEnterprise Schema
= Analog Control, 1 = Discrete Control, 2=Brooks Control(DL8000) currentoutputofpid:float
Value that is sent to current output. discreteclosepidoutputpoint:char
To be completed discreteclosepidoutputpoint_l:integer
To be completed discreteclosepidoutputpoint_p:integer
To be completed discreteclosepidoutputpoint_t:integer
To be completed discreteopenpidoutputpoint:char
The parameter assigned to write the decrease/closed output to. Only used if DO Control (parameter #5) is On. discreteopenpidoutputpoint_l:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 914
To be completed
OpenEnterprise Schema discreteopenpidoutputpoint_p:integer
To be completed discreteopenpidoutputpoint_t:integer
To be completed downstreamoutputpoint:char
The parameter assigned to write the increase/open output to. Only used if Brooks Control (parameter #5) is selected. downstreamoutputpoint_l:integer
To be completed downstreamoutputpoint_p:integer
To be completed downstreamoutputpoint_t:integer
To be completed loopperiod:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 915
OpenEnterprise Schema
Desired frequency of execution of the PID algorithm in seconds. loopswitchselect:integer
Indicates when to switch to the Override Loop based upon whether the
Primary change in output is less than or greater than the Override change in output. 0 = Low Override, 1 = High Override. manualtracking:integer
If enabled and in Manual Mode, the Primary Setpoint is set equal to the current Primary Process Variable. If disabled, nothing occurs. 0 =
Disable Manual Tracking, 1 = Enable Manual Tracking. outputhighlimit:float
To be completed outputhighlimitstatus:integer
To be completed outputlowlimit:float
To be completed outputlowlimitstatus:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 916
OpenEnterprise Schema outputofpidpoint:char
The parameter assigned to write the control output of the PID loop to. If
DO Control (parameter #5) is On, then this is the parameter assigned to write the increase/open output to. outputofpidpoint_l:integer
To be completed outputofpidpoint_p:integer
To be completed outputofpidpoint_t:integer
To be completed overridechangeinoutput:float
Calculated change in output from the Override Loop. overridecontroldeadband:float
Range (() that the error at time t (et) must be greater than or equal to for the Override Loop to include the KI term for the change in output calculation. overridederivativegain:float
Derivative gain (KD) of the Override Loop.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 917
OpenEnterprise Schema overrideinputpoint:char
The parameter assigned to read the Override Process Variable
(parameter #24) from. overrideinputpoint_l:integer
To be completed overrideinputpoint_p:integer
To be completed overrideinputpoint_t:integer
To be completed overrideintegralgain:float
Integral gain (KI) of the Override Loop. overrideloopmode:integer
Indicates whether an Override Loop is active for the PID. 0 = Primary
Loop Only, 1 = Primary and Override Loop. overrideprocessvariable:float
Input value for the Override Loop.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 918
OpenEnterprise Schema overrideprocessvariablestatus:integer
To be completed overrideproportionalgain:float
Proportional gain (KP) of the Override Loop. overridescalefactor:float
Scale factor (FS) of the Override Loop. overridesetpoint:float
Desired value of the Override Process Variable (parameter #24). overridesetpointhighlimit:float
Highest allowed value for the override setpoint (parameter #26). overridesetpointhighlimitstatus:integer
To be completed overridesetpointlowlimit:float
Lowest allowed value for the override setpoint (parameter #26).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 919
OpenEnterprise Schema overridesetpointlowlimitstatus:integer
To be completed overridesetpointmaximumchangerate:float
Maximum rate of change allowed for the actual setpoint used by the
Override Loop in engineering units per minute (EU/minute). overridesetpointpoint:char
The parameter assigned to read the override setpoint (parameter #26) from overridesetpointpoint_l:integer
To be completed overridesetpointpoint_p:integer
To be completed overridesetpointpoint_t:integer
To be completed overridesetpointratelimited:integer
Indication that the override setpoint currently being used by the PID calculation is currently being limited by the maximum setpoint change
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 920 rate (parameter #29).
OpenEnterprise Schema overridethresholdvalue:float
The override function will only be allowed to take control if the override process variable is within the threshold value of the override setpoint. pidmode:integer
Indicates whether the PID is active or not. 0 = PID Disabled, 1 = PID
Enabled. primarychangeinoutput:float
Calculated change in output from the Primary Loop. primarycontroldeadband:float
Range (() that the error at time t (et) must be greater than or equal to for the Primary Loop to include the KI term for the change in output calculation. primaryderivativegain:float
Derivative gain (KD) of the Primary Loop. primaryinputpoint:char
The parameter assigned to read the Primary Process Variable
(parameter #9) from.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 921 primaryinputpoint_l:integer
To be completed
OpenEnterprise Schema primaryinputpoint_p:integer
To be completed primaryinputpoint_t:integer
To be completed primaryintegralgain:float
Integral gain (KI) of the Primary Loop. primaryprocessvariable:float
Input value for the Primary Loop. primaryprocessvariablestatus:integer
To be completed primaryproportionalgain:float
Proportional gain (KP) of the Primary Loop.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 922
OpenEnterprise Schema primaryscalefactor:float
Scale factor (FS) of the Primary Loop. primarysetpoint:float
Desired value of the Primary Process Variable (parameter #9). primarysetpointhighlimit:float
Highest allowed value for the primary setpoint (parameter #11). primarysetpointhighlimitstatus:integer
To be completed primarysetpointlowlimit:float
Lowest allowed value for the primary setpoint (parameter #11). primarysetpointlowlimitstatus:integer
To be completed primarysetpointmaximumchangerate:float
Maximum rate of change allowed for the actual setpoint used by the
Primary Loop in engineering units per minute (EU/minute).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 923
OpenEnterprise Schema primarysetpointpoint:char
The parameter assigned to read the primary setpoint (parameter #11) from. primarysetpointpoint_l:integer
To be completed primarysetpointpoint_p:integer
To be completed primarysetpointpoint_t:integer
To be completed primarysetpointratelimited:integer
Indication that the primary setpoint currently being used by the PID calculation is currently being limited by the maximum setpoint change rate (parameter #14). resetmode:integer
If disabled, the PID will be disabled on a restart of any kind. If enabled, the PID will be enabled after a restart. 0 = Disable after Reset, 1 =
Enable after Reset. switchstatus:integer
Indicates what loop is currently being used to control the process
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 924
OpenEnterprise Schema variable. 0 = Neither, 1 = Primary Loop, 2 = Override Loop. upstreamoutputpoint:char
The parameter assigned to write the decrease/closed output to. Only used if Brooks Control (parameter #5) is selected. upstreamoutputpoint_l:integer
To be completed upstreamoutputpoint_p:integer
To be completed upstreamoutputpoint_t:integer
To be completed valvedeadtime:float
An amount of time added to every TDO EU value passed to the AC I/O to account for extra time to break valve seal
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 925
rocpluspowercontrolparameters
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: activetimezone:integer
This parameter is the current active power zone. cumulativeofftime:integer
This counter shows how many seconds the radio power control has been off (in seconds). cumulativeontime:integer
The counter shows how many seconds the radio power control has been on (in seconds). discreteoutputnumber:char
The logical discrete output number.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 926
OpenEnterprise Schema discreteoutputnumber_l:integer
To be completed discreteoutputnumber_p:integer
To be completed discreteoutputnumber_t:integer
To be completed enable:integer
The enabled mode for the power control on this port. 0 = Disabled, 1 =
Enabled holdtime:integer lowbattery:float
Time in seconds that the output is held on after detection of communications.
The radio will not be turned on if the voltage drops below this value. It is stored in volts. lowbatterydeadband:float
This is a dead-band for the low battery level in power control. This is
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 927
OpenEnterprise Schema used to keep from the radio continuously turning on and off. offtime1:integer offtime2:integer offtime3:integer ontime1:integer ontime2:integer
On time for Zone 1. The amount of time for this cycle, the DO associated with this power control will be in the off state (following the on state).
On time for Zone 2. The amount of time for this cycle, the DO associated with this power control will be in the off state (following the on state).
On time for Zone 3. The amount of time for this cycle, the DO associated with this power control will be in the off state (following the on state).
On time for Zone 1. The amount of time for this cycle, the DO associated with this power control will be in the on state
On time for Zone 2. The amount of time for this cycle, the DO associated with this power control will be in the on state ontime3:integer
On time for Zone 3. The amount of time for this cycle, the DO
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 928
OpenEnterprise Schema associated with this power control will be in the on state pointstatus:integer
Status of power control on this port.
0 = Power Disabled, 1 = Power Enabled powertimer:integer
Counts down the amount of time, in seconds, (On Time, Off Time, Hold
Time) that the power control is currently using. starttime1:integer
Zone 1 start time. starttime2:integer
Zone 2 start time. starttime3:integer
Zone 3 start time.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 929
rocpluspulseinputs
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: accumulatedvalue:integer
Total number of pulses that the PI has received. alarmcode:integer
To be completed alarmdeadband:float
Provides a range (() that the EU Value (parameter #13) may move between without causing another alarm when the EU Value Mode
(parameter #11) is setup for Rate. alarming:integer
If enabled, alarms may be generated and sent to the Alarm Log. 0 =
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 930
Disabled, 1 = Enabled.
OpenEnterprise Schema contracthour:integer
Hour, in military time, that represents the end of the day for the PI. conversion:integer
Determines if Conversion Value (parameter #9) will be multiplied or divided by the accumulated pulses to determine the units for the Current
Rate (parameter #10). 0 = EUs/pulse, 1 = pulses/EU. conversionvalue:float
Used to calculate the units of the Current Rate (parameter #10). correctedpulseaccumulation:float
Running accumulation of Pulses * X. Where X is = Conversion Value when Parameter 8 is set to EU/Pulse or X is set to 1/Conversion Value if
Pulses/EU. Rolls over at 1,000,000.0 currentrate:float
Calculated rate of the pulses. currentrateperiod:integer
Used to determine the calculation of the Current Rate (parameter #10).
0 = EU/second, 1 = EU/minute, 2 = EU/hour, 3 = EU/day.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 931 euvalue:float
Value in Engineering Units.
OpenEnterprise Schema euvaluemode:integer
Used to determine what the EU Value (parameter #13) will represent. 0
= Rate, 1 = Accumulator with Maximum Rollover, 2 = Accumulator with
Entered Rollover. frequency:float
Frequency of incoming pulses in pulses/second. highalarmeu:float
Alarm value for High Alarm when the EU Value Mode (parameter #11) is setup for Rate. highhighalarmeu:float
Alarm value for High High Alarm when the EU Value Mode (parameter
#11) is setup for Rate. lowalarmeu:float
Alarm value for Low Alarm when the EU Value Mode (parameter #11) is setup for Rate. lowlowalarmeu:float
Alarm value for Low Low Alarm when the EU Value Mode (parameter
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 932
#11) is setup for Rate.
OpenEnterprise Schema pulsesforday:integer
Total number of pulses that the PI has received for the contract day. ratealarmeu:float
Alarm value for maximum change of EU Value (parameter #13) between
Scan Periods when the EU Value Mode (parameter #11) is setup for
Rate. rollovermaximum:float
This is the Entered Rollover Maximum for the EU Value Mode
(parameter #11) when it is setup for Accumulator with Entered Rollover. scanning:integer
If disabled, field inputs are ignored and no changes will occur unless manually entered. 0 = Disabled, 1 = Enabled. scanperiod:float
Number of seconds between updates of the PI. srbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 933 srbxonset:integer
OpenEnterprise Schema
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled. todaystotal:float unitstag:char
Calculated value of the accumulated pulses for the contract day multiplied by the Conversion Value (parameter #9).
Describes the units used by the PI. Values must be printable ASCII characters. yesterdaystotal:float
Previous contract day’s total.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 934
rocplusrtd
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: actualscantime:float
Actual number of seconds between updates of the RTD. alarmcode:integer
To be completed alarmdeadband:float
Provides a range (() that the EU Value (parameter #22) may move between without causing another alarm. alarming:integer
If enabled, alarms may be generated and sent to the Alarm Log. 0 =
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 935
Disabled, 1 = Enabled.
OpenEnterprise Schema alphaofrtd:integer
Indicates what the alpha (() of the RTD. 0 = Alpha of 0.00385, 1 = Alpha of 0.00392. averaging:integer
If enabled, the filtered raw A/D value is averaged over the Scan Period.
If disabled, the current filtered raw A/D value is used when the Scan
Period is reached. 0 = Disabled, 1 = Enabled. calibrationmode:integer
Describes what the calibration for the RTD is doing. 0 = Use Current
Calibration, 1 = Start Calibration, 2 = Calibrate, 3 = Restore Previous
Calibration, 4 = Stop Calibration. Note: No event is logged for this parameter and should possibly labeled as R/O in any external Roc
Protocol Specification calibrationtimer:float
Number of seconds until a calibration timeout occurs. calibrationtype:integer
During calibration, determines what the Set Value (parameter #20) is replacing. 0 = Nothing, 1 = Set Zero, 2 = Set Span, 3 = Set Mid Point
#1, 4 = Set Mid Point #2, 5 = Set Mid Point #3, 6 = Set Offset (Zero
Shift). Note: No event is logged for this parameter and should possibly labeled as R/O in any external Roc Protocol Specification
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 936 clipping:integer
OpenEnterprise Schema
If enabled, then the EU Value (parameter #22) cannot be less than the
Low Low Alarm EU (parameter #24) or greater than the High High Alarm
EU (parameter #27). If disabled, no limiting of the EU Value (parameter
#22) takes place. 0 = Disabled, 1 = Enabled. euvalue:float
Value in Engineering Units. filter:integer
Percentage of last raw A/D reading to be weighted with the new raw A/D reading. highalarmeu:float
Alarm value for High Alarm. highhighalarmeu:float
Alarm value for High High Alarm and maximum EU Value (parameter
#22) if Clipping (parameter #23) is enabled. lowalarmeu:float
Alarm value for Low Alarm. lowlowalarmeu:float
Alarm value for Low Low Alarm and minimum EU Value (parameter #22)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 937
OpenEnterprise Schema if Clipping (parameter #23) is enabled. manualvalue:float
Current EU Value of RTD while performing calibration. midpointeu1:float
Second lowest calibrated EU value. midpointeu2:float
Third lowest or highest calibrated EU value. midpointeu3:float
Second highest calibrated EU value. midpointraw1:integer
Second lowest calibrated raw A/D input. midpointraw2:integer
Third lowest or highest calibrated raw A/D input. midpointraw3:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 938
OpenEnterprise Schema
Second highest calibrated raw A/D input. ratealarmeu:float
Alarm value for maximum change of EU Value (parameter #22) between
Scan Periods. rawadinput:integer
Raw A/D reading used to calculate the EU Value (parameter #22). reserved1:float
Value to be added to all calculated EU values. scanning:integer scanperiod:float setvalue:float
If disabled, field inputs are ignored and no changes will occur unless manually entered. 0 = Disabled, 1 = Enabled.
Number of seconds between updates of the RTD.
Desired EU value for a calibration point. Note: No event is logged for this parameter and should possibly labeled as R/O in any external Roc
Protocol Specification
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 939 spaneu:float
Highest calibrated EU value.
OpenEnterprise Schema spanraw:integer
Highest calibrated raw A/D input. srbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled. srbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled. units:integer unitstag:char zeroeu:float
Indicates what units the TC will be. 0 = (F, 1 = (C, 2 = (K, 3 = (R.
Describes the units used by the RTD. Values must be printable ASCII characters.
Lowest calibrated EU value.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 940 zeroraw:integer
Lowest calibrated raw A/D input.
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 941
rocplussoftpointparameters
Derived From:
Description:
To be completed
To be completed
Attributes: byte1:integer byte10:integer byte2:integer byte3:integer
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 942 byte4:integer
Miscellaneous storage. byte5:integer byte6:integer byte7:integer byte8:integer byte9:integer float1:float
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 943 float10:float
Miscellaneous storage. float11:float float12:float float13:float float14:float float15:float float16:float
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 944 float17:float
Miscellaneous storage. float18:float float19:float float2:float float20:float float3:float float4:float
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage. float5:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 945
Miscellaneous storage. float6:float float7:float float8:float float9:float long1:integer long2:integer short1:integer
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 946
Miscellaneous storage. short10:integer short2:integer short3:integer short4:integer short5:integer short6:integer short7:integer
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Miscellaneous storage.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 947
Miscellaneous storage. short8:integer
Miscellaneous storage. short9:integer
Miscellaneous storage. softpointdescription:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 948
rocplussystemanaloginputs
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: actualscantime:float
Actual number of seconds between updates of the System AI. alarmcode:integer
To be completed alarmdeadband:float
Provides a range (() that the EU Value (parameter #12) may move between without causing another alarm. alarming:integer
If enabled, alarms may be generated and sent to the Alarm Log. 0 =
Disabled, 1 = Enabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 949
OpenEnterprise Schema averaging:integer
If enabled, the filtered raw A/D value is averaged over the Scan Period.
If disabled, the current filtered raw A/D value is used when the Scan
Period is reached. 0 = Disabled, 1 = Enabled. clipping:integer
If enabled, then the EU Value (parameter #12) cannot be less than the
Low Low Alarm EU (parameter #14) or greater than the High High Alarm
EU (parameter #17). If disabled, no limiting of the EU Value (parameter
#12) takes place. 0 = Disabled, 1 = Enabled. euvalue:float
Value in Engineering Units. filter:integer
Percentage of last raw A/D reading to be weighted with the new raw A/D reading. highalarmeu:float
Alarm value for High Alarm. highhighalarmeu:float
Alarm value for High High Alarm and maximum EU Value (parameter
#12) if Clipping (parameter #13) is enabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 950 lowalarmeu:float
Alarm value for Low Alarm.
OpenEnterprise Schema lowlowalarmeu:float
Alarm value for Low Low Alarm and minimum EU Value (parameter #12) if Clipping (parameter #13) is enabled. ratealarmeu:float
Alarm value for maximum change of EU Value (parameter #12) between
Scan Periods. rawadinput:integer
Raw A/D reading used to calculate the EU Value (parameter #21). scanning:integer scanperiod:float spaneu:float
If disabled, field inputs are ignored and no changes will occur unless manually entered. 0 = Disabled, 1 = Enabled.
Number of seconds between updates of the System AI.
Highest EU value.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 951
OpenEnterprise Schema spanraw:integer
Highest raw A/D input. srbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled. srbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled. units:integer unitstag:char zeroeu:float zeroraw:integer
3:0 =(Indicates what units the EU value will be. Logic 0 R.(K, 3 = (C, 2 =
(F, 1 = (Volts, 1 = milliVolts. Logic 4: 0 =
Describes the units used by the System AI. Values must be printable
ASCII characters.
Lowest EU value.
Lowest raw A/D input.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 952
OpenEnterprise Schema
rocplussystemvariables
Derived From:
Description:
To be completed
To be completed
Attributes: activeorificemeterruns:integer
Number of active orifice meter runs. activepids:integer
Number of active PIDs activesamplers:integer
To be completed activestations:integer
Number of active stations.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 953
OpenEnterprise Schema activeturbinemeterruns:integer
Number of active turbine meter runs. alarmindex:integer
Indicates the current alarm index in the Alarm Log. autologoutperiod:integer
The time out period for the keypad auto logout. This is in minutes. baudrategenerator0rate:integer
The baud rate that baud rate generator #0 is to be set to. baudrategenerator1rate:integer
The baud rate that baud rate generator #1 is to be set to. baudrategenerator2rate:integer
The baud rate that baud rate generator #2 is to be set to. baudrategenerator3rate:integer
The baud rate that baud rate generator #3 is to be set to.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 954
OpenEnterprise Schema bootfirmwaretimecreated:char
Contains the time and date stamp the boot firmware was created. bootpartnumberandversion:char
Contains the boot software part number and version number string. clearconfigurationmemory:integer
Used to clear the internal configuration memory stored in flash ROM.
0 = Do nothing
1 = Enable clearing of Configuration Memory clearhistoryconfiguration:integer
To be completed coldstart:integer
Used to re-start the system. A cold start always includes starting from the boot sector and performing power-on-self tests, plus the following options.
0 = Do nothing
1 = Restore Configuration from Flash
2 = Clear Alarms
3 = Clear Events
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 955
4 = Clear FSTs
OpenEnterprise Schema
5 = Clear History & Meter Runs
6 = Restore Configuration from Flash, Clear
Alarms/Events/FST’s/History/Meter Runs
7 = Restore Configuration from Defaults configurationmemorywritecomplete:integer
Used to indicate that the system is the process of writing the configuration to flash ROM
0 = Currently Performing the Write
1 = Completed the Write crccheck:integer
The CRC check flag. If this flag is enabled, a CRC will be appended to all messages and a CRC will be expected on all received messages.
Disabled = 0, Enabled = 1. eventindex:integer
Indicates the current event index in the Event Log. flashdiskspacefree:integer
The amount of disk space that is available. flashdiskspaceused:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 956
To be completed
OpenEnterprise Schema fstclear:integer
Setting this parameter clears FST code from Flash ROM.
0 – Does nothing.
1 – Initiates clearing of FST code. ioscanning:integer
Used to enable or disable scanning of all I/O in the system. 0 =
Disabled, 1 = Enabled. lastpowerdowntime:datetime
To be completed lastpowerdowntimedstoffset:integer
To be completed lastpoweruptime:datetime
Contains the last power-up time in the number of seconds elapsed since
12:00 a.m. Jan. 1, 1970. lastpoweruptimedstoffset:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 957 lcdonoff:integer lcdstatus:integer
OpenEnterprise Schema
Turns the LCD on or off
0 – Off (screens cleared, no menus)
1 – On (screens on, menus visible)
Note: Turning off does not shut off power
0: Ok
1: Invalid Display Configuration File
2: Display Configuration File CRC Error
3: LCD Not Installed
4: Unknown Error lcdvideomode:integer
Select between dark text on light background, or light text on dark background for the Display.
0 = Dark on light
1 = Light on dark
Note: Redefined in version 1.50 ledenable:integer
Indicates the number of minutes the LEDs will be on before automatically turning themselves off. (The LED button will active the
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 958
LEDs for the configured time).
OpenEnterprise Schema
0 = LEDs always on
1 - 60 = Number of minutes LEDs will be on logicalcompatibilitymode:integer
Indicates the logical compatibility mode.
0 = 16 points per slot [Opcode 50 information and logical indexing for I/O is used in the same way as with version 1.XX of firmware]
1 = 8 points per slot [Opcode 50 information and logical indexing for I/O is based on 8 points per module and allows for up to 27 modules to be accessed.]
See Opcode 50 for more information. manufacturerid:char
Contains manufacturing identification string. maximumalarms:integer
Contains the maximum number of alarms that the Alarm Log may contain. maximumevents:integer
Contains the maximum number of events that the Event Log may contain. maximumfsts:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 959
OpenEnterprise Schema
Contains the maximum number of FSTs that may run on the system maximummeterruns:integer
Contains the maximum number of Meter Runs that may run on the system maximumpids:integer
Contains the maximum number of PID loops that may run on the system mpuloading:float
Contains the current percentage of time the CPU is being loaded, updated every 5 seconds. numberofcoldstarts:integer
The number of cold starts. numberofpowercycles:integer
The number of power cycle. numberofsysteminitializations:integer
To be completed numberofwarmstarts:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 960
The number of warm starts.
OpenEnterprise Schema partnumberandversion:char
Contains the software part number and version number string. powersavetime:integer
Enables or disables the power saving feature of the LCD.
0 – Disable Power Saving,
>0 Enable Power Saving. When set to anything greater than 0, it is the number of minutes of inactivity are required before placing the LCD into sleep. The first key press will wakeup the display. productdescription:char
Contains manufacturing description of product. rocaddress:integer
One-byte unit code of the station address. The unit code for a ROC address is configurable by the user. A 0 is used for broadcast. rocgroup:integer rocseries:char
Group code of the station address.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 961
Indicates revision of harware.
OpenEnterprise Schema serialnumber:integer
Contains the serial number for the unit. stationname:char
A 20-character ASCII field for the station name. timecreated:char
Contains the time and date stamp the firmware was created. warmstart:integer
Used to re-start the system. A warm start is a reboot of the system without performing all the power-on-self tests.
0 = Do nothing
1 = Perform Warm Start weightsandmeasureseventindex:integer
The current event index for the Weights and Measures Event Log weightsandmeasuresmaximumevents:integer
The maximum number of events that the Weights and Measures Event
Log may store
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 962
OpenEnterprise Schema weightsandmeasuresswitch:integer
To be completed writetoconfigurationmemory:integer
Used to command the ROC to store certain point types (indicated throughout this document) to flash configuration memory
0 = Do nothing
1 = Perform Write to Configuration Memory
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 963
rocplusthermocouple
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: actualscantime:float
Actual number of seconds between updates of the TC. alarmcode:integer
To be completed alarmdeadband:float
Provides a range (() that the EU Value (parameter #22) may move between without causing another alarm. alarming:integer
If enabled, alarms may be generated and sent to the Alarm Log. 0 =
Disabled, 1 = Enabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 964
OpenEnterprise Schema averaging:integer
If enabled, the filtered EU value is averaged over the Scan Period. If disabled, the current filtered EU value is used when the Scan Period is reached. 0 = Disabled, 1 = Enabled. euoffset:float
Value to be added to EU value (parameter #9). euvalue:float filter:integer
Value in Engineering Units.
Percentage of last raw A/D reading to be weighted with the new raw A/D reading. highalarmeu:float
Alarm value for High Alarm. highhighalarmeu:float
Alarm value for High High Alarm and maximum EU Value (parameter
#22) if Clipping (parameter #23) is enabled. lowalarmeu:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 965
Alarm value for Low Alarm.
OpenEnterprise Schema lowlowalarmeu:float
Alarm value for Low Low Alarm and minimum EU Value (parameter #22) if Clipping (parameter #23) is enabled. ratealarmeu:float
Alarm value for maximum change of EU Value (parameter #22) between
Scan Periods. scanning:integer
If disabled, field inputs are ignored and no changes will occur unless manually entered. 0 = Disabled, 1 = Enabled. scanperiod:float
Number of seconds between updates of the TC. srbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled. srbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 966
OpenEnterprise Schema typeofthermocouple:integer
Indicates which type of thermocouple is attached. 0 = Type J, 1 = Type
K. units:integer
Indicates what units the TC will be. 0 = (F, 1 = (C, 2 = (K, 3 = (R. unitstag:char
Describes the units used by the TC. Values must be printable ASCII characters.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 967
rocplususerdefineddatatypes
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char length:integer rocdatatype:char
To be completed
To be completed
To be completed
To be completed type:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 968
OpenEnterprise Schema
rocpoint
Derived From:
Description:
Signal_table
Each entry defines a Roc Point in a specific Roc Device. Entries can exist in the Roc device, but not in the OE database (data is not requested for entries not configured in OE). If entries exist in the OE database that are not in the Roc device, then this will cause Roc ErrorCode replies if any data is requested. In addition, the field ‘RocPointsMismatch’ will be set
TRUE in the RocDevice_Table, following a ‘RocCheckConfiguration’ request.
Attributes: applypointwritechanges:bool
Set by the user from the Roc Tools interface. applypointwritepattern:bool
Set by the user from the Roc Tools interface. cancelpointwrite:bool
Set by the user from the Roc Tools interface.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 969 deviceid:char
OpenEnterprise Schema
The Id of the Device to which the Roc Point belongs. internalflags:integer
Used internally by OpenEnterprise. lockpoint:bool
Set by the RDI. logicalposition:integer
Roc LogicalPosition
for non-I/O points = (PointNumber-1)
for I/O points = Physical location (the ‘L’ of TLP) pointnumber:integer
Roc PointNumber pointtagid:char pointtype:integer
The name of the point.
Roc PointType
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 970
OpenEnterprise Schema pointwritepattern:char
To be completed pointwritepatternid:integer
To be completed readcompletioncount:integer
Incremented by the RDI on receipt of Roc Parameter values for this datum. The following 3 fields are also updated. readcompletionerrorcode:integer
ErrorCode on parameter read update (0=success), readcompletionerrorcodetext:char
Text description of error code readcompletionparameters:char
List of Parameters updated readcompletiontimestamp:datetime
Time of Parameters read update
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 971
OpenEnterprise Schema readcompletiontimestampdstoffset:integer
To be completed signals:signal_table
An array of Roc signals that have been created for various Parameters of the Roc Point. userdefinedpointtypeid:integer
The Id of a user defined point. writecompletioncount:integer
Incremented by the RDI on completion of write of Roc Parameter values.
The following 3 fields are also updated. writecompletionerrorcode:integer
ErrorCode on parameter write completion (0=success), writecompletionerrorcodetext:char
Text description of error code writecompletionparameters:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 972
List of Parameters written writecompletiontimestamp:datetime
Time of Parameters written writecompletiontimestampdstoffset:integer
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 973
rocpointalarmcondition
Derived From:
Description:
To be completed
To be completed
Attributes: alarmcodebitnum:integer
To be completed alarmcodeparameter:integer
To be completed alarmcodepointtype:integer
To be completed name:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 974
OpenEnterprise Schema
rocpointtypes
Derived From:
Description:
<base table>
Each row defines a specific ROC Point Type.
Attributes: abbrev:char accessarea:char
The access area to which any object in the table belongs. Used with security enabled views to restrict access to objects for unauthorised users. Objects in this table are assigned an accessarea of 'ALL' by default, meaning all users can access them. defaultaddpoints:bool
To be completed
An abbreviated string used to identify the ROC Point Type. For instance, the abbreviation for an Analog Input type Point is "AIN".
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 975 description:char
To be completed
OpenEnterprise Schema eventformat:integer
To be completed isuserdefinedpointtype:bool
To be completed numberofparameters:integer
To be completed parametertypes:char
To be completed pointtype:integer
An integer from 0 - 141 representing the ROC Point Type number.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 976 pointtypegroup:char
To be completed protocoltype:char
To be completed tablename:char
To be completed tagnamepointtype:integer
To be completed userdefinedpointtypeid:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 977
rocpointwritetimeout
Derived From:
Description:
To be completed
To be completed
Attributes: rocpoint:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 978
rocportparameters
Derived From:
Description:
OpenEnterprise Schema dvi_network
Default parameters to use for Serial and Dialup ports.
Attributes: accessarea:char baudrate:integer
To be completed
Baudrate. Default 19200 connectreadinterval:integer
Timeout 2 interval (ms) (This and the following 4 parameters relate to a
Windows time structure used to specify the low–level timeout used in character comms). Default 500 connectreadtotalconst:integer
Timeout 2 Read constant (ms) Default 1000
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 979
OpenEnterprise Schema connectreadtotalmult:integer
Timeout 2 Read message length dependent (ms) Default 0 connectwritetotalconst:integer
Timeout 2 Write constant (ms)Default 2000 connectwritetotalmult:integer
Timeout 2 Write message length dependent (ms) Default 0 databits:integer
7 or 8 databits. Default 8 delayafterconnect:integer
Delay in milliseconds after connection before a Roc message is sent.
Default 0. description:char arbitrary description internalflags:integer
Internal use by the CL only
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 980
OpenEnterprise Schema modemautoanswerstring:char
Hayes AT string used to initialize modem to auto answer (generally contains e.g. S0=2 for two rings before answer). Default is
ATS0=2Q0M0 modemdialstring:char
Hayes AT string used to precede phone number in dial-out attempt.
Default is ATQ0M0S0=0DT modeminitialisationstring1:char
To be completed modeminitialisationstring2:char
To be completed modemreadinterval:integer
Timeout 1 interval (ms) (This and the following 4 parameters relate to a
Windows time structure used to specify the low –level timeout used in
Hayes command comms to the modem) Default 1000 modemreadtotalconst:integer
Timeout 1 Read constant (ms) Default 30000
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 981
OpenEnterprise Schema modemreadtotalmult:integer
Timeout 1 Read message length dependent (ms) Default 0 modemwritetotalconst:integer
Timeout 1 Write constant (ms) Default 2000 modemwritetotalmult:integer
Timeout 1 Write message length dependent (ms) Default 0 numendff:integer numff:integer parity:char
Number of FFs put on end of Roc message. Default is 0.
Number of FFs put on start of Roc message. Default is 0.
Parity NONE,EVEN,ODD,MARK,SPACE default NONE. portparametername:char
The PortParameter Name (this is the networkname (PK) of the entry on the ‘dummy’ driver).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 982
OpenEnterprise Schema rtsassertdelay:integer ms between asserting RTS and sending message (approx: subject to
Windows timing) Default 0. Value of -1 indicates use of ‘auto-enables’ mode, where RTS handling is carried out automatically by Win32. rtsdeassertdelay:integer ms between end of message and de-asserting RTS (approx: subject to
Windows timing) Default 0 stopbits:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 983
rocprotocoltypes
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char name:char
To be completed
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 984
rocreadalarmdata
OpenEnterprise Schema
Derived From:
Description:
RocRequest_Table
Roc alarm data will be streamed through fields in this datum. A single entry in this table will be automatically created for each RocDevice. No additional entries are allowed.
Attributes: alarmcodeparameterid:integer
To be completed alarmdescription:char
Text field similar to Description column in RocLink alarm list. Set up via
CL. alarmindex:integer
Roc alarmindex for alarm alarmisrbx:bool
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 985
Set by the Roc RDI. alarmisset:bool
Set by the Roc RDI. alarmlimitvalue:float
The value that will cause the Alarm. alarmlogcode:integer
The Alarm type code. alarmlogdescription:char
A description of the Alarm. alarmlogtype:integer
The type of Alarm. alarmparamabbrev:char
Abbreviation of the AlarmTLP_P
OpenEnterprise Schema alarmparamdescription:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 986
Description of the AlarmTLP_P
OpenEnterprise Schema alarmpointtypeabbrev:char
Set up via CL from the AlarmTLP_T alarmtag:char
Tagname of point alarmtime:datetime
Time of alarm (from Roc alarm report, converted to UTC) alarmtimedstoffset:integer
An offset applied to the alarm time. alarmtimeraw:integer
Raw time for alarm (from Roc alarm report) alarmtlp:char alarmtlp_l:integer
Roc Point (TLP ) that caused the alarm
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 987
LogicalPosition of AlarmTLP
OpenEnterprise Schema alarmtlp_p:integer
ParameterNumber of AlarmTLP alarmtlp_t:integer
Point Type of AlarmTLP alarmunits:char
The units of the Alarm. alarmunitslookup:integer
The alarm units expressed as an integer. alarmunitsstring:char
The alarm units expressed as a string. alarmvalue:float
Value of the alarm. currentalarmindex:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 988
Current alarmindex in Roc device
OpenEnterprise Schema maxnumberofalarmlogstoread:integer
The RDI will normally read all alarm records since the last index read. If this Maximum is greater than 0, then the RDI will only read a restricted number of records (or all since the last index, if that is less than the
Maximum). newalarmtrigger:integer incremented by RDI to indicate new alarm setorclear:char
Text field similar to Set/Clear column in RocLink larm list. Indicates if
Alarm is Set or Clear, and if it was an RBX. Set up via CL.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 989
rocreadclock
OpenEnterprise Schema
Derived From: RocRequest _Table
Description: Used by the Roc RDI to read the current time for the Roc device. A single entry in this table will be automatically created for each RocDevice. No additional entries are allowed.
Attributes: autoupdateclockmininterval:integer
Time difference to restrict frequency of clock writes (configured in seconds) autoupdateclocktimedifference:integer
Time difference to trigger a clock write (configured in seconds) currentday:integer
Offset 9 of the Roc response currentdayofweek:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 990
Offset 60 of the Roc response
OpenEnterprise Schema currenthour:integer
Offset 8 of the Roc response currentminute:integer
Offset 7 of the Roc response currentmonth:integer
Offset 10 of the Roc response currentsecond:integer
Offset 6 of the Roc response currentyear:integer
Offset 11 of the Roc response lastautoupdateclocktimestamp:datetime
Last time that the Roc clock was auto-updated lastautoupdateclocktimestampdstoffset:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 991
To be completed
OpenEnterprise Schema leapyearparam:integer
To be completed optionautoupdateclock:bool
If TRUE then the auto-update of the Clock in the Roc device is enabled outstationtime:datetime datetime field for the time (converted to UTC by the RDI) outstationtimedstoffset:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 992
rocreadconfigurableopcodedata
OpenEnterprise Schema
Derived From:
Description:
RocRequest_Table
Used by the Roc RDI to reads Roc Point Parameter current values (via
Roc Opcode 10). Values are written to the appropriate fields in the relevant
RocPoint datum. A single entry in this table will be automatically created for each RocDevice. Additional entries can be configured, as required.
Attributes: numberoftablelocations:integer
Output data offset 8 starttablelocation:integer
Output data offset 7 tablenumber:integer
Output data offset 6 tableversionnumber:float
Offset 9 of the Roc response
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 993
rocreadeventdata
OpenEnterprise Schema
Derived From:
Description:
RocRequest_Table
Roc event data will be streamed through fields in this datum. A single entry in this table will be automatically created for each RocDevice. No additional entries are allowed.
Attributes: currenteventindex:integer
Current alarmindex in Roc device eventcalibrationtype:integer
The event calibration type. eventcodedescription:char
Set up via CL. eventdatatype:integer
Event datatype
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 994
OpenEnterprise Schema eventdescription:char
Description of event. eventindex:integer
Roc Index for event eventlogcode:integer
The event type code. eventlogdescription:char
A description for the event log. eventlogtype:integer
The type of event. eventmessagetime:datetime
Event message time eventmessagetimedstoffset:integer
The DST offset for an event. Will be 0 or 60 depending on DST status.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 995
OpenEnterprise Schema eventoldvalue:float
Old value of event eventoperatorid:char
Event Operator id eventparamabbrev:char
Abbreviation of the AlarmTLP_P eventparamdescription:char
Description of the AlarmTLP_P eventpointtypeabbrev:char
Set up via CL from the AlarmTLP_T eventtime:datetime
Time of event (from Roc event report, converted to UTC) eventtimedstoffset:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 996
OpenEnterprise Schema eventtimeraw:integer
Raw time for event eventtlp:char
Roc Point (TLP ) that caused the event eventtlp_l:integer
LogicalPosition of EventTLP eventtlp_p:integer
ParameterNumber of EventTLP eventtlp_t:integer
Point Type of EventTLP eventvalue:float
Value of event maxnumberofeventlogstoread:integer
The RDI will normally read all event records since the last index read. If this Maximum is greater than 0, then the RDI will only read a restricted number of records (or all since the last index, if that is less than the
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 997
Maximum).
OpenEnterprise Schema neweventtrigger:integer incremented by RDI to indicate new alarm oldvalue:char
Text field similar to OldValue column in RocLink alarm list. type:char value:char
Text field similar to Type column in RocLink alarm list. Set up via CL.
Text field similar to NewValue column in RocLink alarm list.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 998
rocreadhistorydata
OpenEnterprise Schema
Derived From:
Description:
Roc_Request
History values are streamed through the relevant entry in
RocHistoryPoint_Table. A single entry in this table will be automatically created for each RocDevice. Additional entries can be configured, as required.
Attributes: currenthistorysegmentindex:integer
Current index from the ROC device. historypoints:char
A string that defines the history points to be collected. Can be ‘all’ or list of history point numbers (eg ‘3-5 9’). historyramarea:integer
Plus: History segment number. Standard: RAM area historytype:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 999
OpenEnterprise Schema
0=minute, 1= hourly/periodic, 2=daily. lasthistorysegmentindex:integer
Last index read for this segment/history-type. maxnumberoftimeperiods:integer
Restriction on total number of time-periods retrieved numberofpoints:integer
The number of points to be collected.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1000
rocreadhistorypointsconfig
OpenEnterprise Schema
Derived From:
Description:
To be completed
Used by the Roc RDI to read Roc history point configuration, and optionally create points in the RocHistoryPoint_Table. A single entry in this table will be automatically created for each RocDevice. Additional entries can be configured, as required
Attributes: extendedhistorypointsloginterval:integer
The loginterval for extended history points. extendedhistorypointsmaxnumber:integer
The maximum number of extended history points. historypoints:char
A string that defines the history points to be collected. Can be ‘all’ or list of history point numbers (eg ‘3-5 9’). historyramarea:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1001
OpenEnterprise Schema
Plus: History segment number. Standard: RAM area. newarchivetype:integer
The Archive Type of a new history point found. newaveragingorratetype:integer
The averaging or rate type of a new history point found. newhistorylogpoint_l:integer
The Logical number of a new history point found. newhistorylogpoint_p:integer
The Parameter number of a new history point found. newhistorylogpoint_t:integer
The Type number of a new history point found. newhistorypointtrigger:integer
Used by the Roc RDI to trigger CL functionality for creating new Roc history points found. newparameterdescription:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1002
OpenEnterprise Schema
The new parameter description found. newpointnumber:integer
The new point number found. newpointtagid:char
The new point tag Id. newpointtype:integer
The new point type, if found. newramarea:integer
The new ram area, if found. numberofhistorypointsread:integer
The number of points read. optionautocreate:bool
If set to True the Roc RDI will auto create History Points found in the
Device that are not in the OE database.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1003
rocreadpointparameters
OpenEnterprise Schema
Derived From:
Description:
RocRequest_Table
Is used by the Roc RDI to read Roc Point Parameter current values
(general-purpose). Values are written to the appropriate fields in the relevant RocPoint datum. A single entry in this table will be automatically created for each RocDevice. Additional entries can be configured, as required.
Attributes: parameternumbers:char
List of Parameter Numbers, or ‘all’ parameterpattern:char
Reference to RocParameterCollectionPattern parameterpatternid:integer
To be completed pointnumbers:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1004
List of point-numbers, or ‘all’ pointtypes:char
List of point-types, or ‘all’
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1005
rocreadspecifiedparameters
Derived From:
Description:
OpenEnterprise Schema
RocRequest_Table
Used by the RDI to read Roc Point Parameter current values (via Roc
Opcode 180). Values are written to the appropriate fields in the relevant
RocPoint datum. A single entry in this table will be automatically created for each RocDevice. Additional entries can be configured, as required.
Attributes: listoftlps:char
List of TLP parameters to be read
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1006
rocreadusertemplatedata
Derived From:
Description:
RocRequest
To be completed
Attributes: newaccessflag:bool
To be completed newdatatype:integer
To be completed newlabeltext:char
To be completed newparameternumber:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1007 newparametertag:char
To be completed newparametertrigger:integer
To be completed newuserdefinedpointtypeid:integer
To be completed numberofparameters:integer
To be completed numberofpoints:integer
To be completed optionautocreate:bool
To be completed parametertypes:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1008 pointtype:integer
To be completed pointtypeabbrev:char
To be completed pointtypedescription:char
To be completed pointtypematch:bool
To be completed readtemplatecheckonly:bool
To be completed readtemplatetrigger:integer
To be completed triggeredforupdate:bool
To be completed userdefinedpointtypeid:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1009
rocrealanalog
OpenEnterprise Schema
Derived From: Realanalog_table
Description: Each entry represents a Value Parameter (specified TLP format) of a Roc
Point. These entries are required (in addition to the Roc Point) for
OpenEnterprise Reports, Historical logging and Calculations.
Attributes: alarmtimestamp:datetime
AlarmTimestamp from an Alarm record for this TLP (updated by the
RDI, optional on a per device basis) alarmtimestampdstoffset:integer
Offset applied to alarm timestamp when in Daylight Saving Time. alarmvalue:float
AlarmValue from an Alarm record for this TLP (updated by the RDI, optional on a per device basis) archivebackfillgapmins:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1010
OpenEnterprise Schema
Use to attempt to ‘backfill’ a gap in current values (see overview section for details) archivetimestamp:datetime
History Timestamp from a Read History for this TLP (updated by the
RDI) archivetimestampdstoffset:integer
Offset applied to archive timestamp when in Daylight Saving Time. archivevalue:float
History Value from a Read History for this TLP (updated by the RDI) archivevaluedisableupdate:bool
If TRUE, then ArchiveValue and ArchiveTimestamp not updated deviceid:char
The DeviceId field of the device logtime:datetime
Use for exception-driver historical logging of
ReadValue/ArchiveValue/AlarmValue
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1011 logtimedstoffset:integer
To be completed
OpenEnterprise Schema logtrigger:integer logtype:integer logvalue:float
Use for exception-driver historical logging of
ReadValue/ArchiveValue/AlarmValue
Use for exception-driver historical logging of
ReadValue/ArchiveValue/AlarmValue
Use for exception-driver historical logging of
ReadValue/ArchiveValue/AlarmValue nameoverride:bool
To be completed parameternumber:integer
Roc ParameterNumber pointinalarm:bool
Indicates if the RocPoint is in alarm.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1012 pointnumber:integer
Roc PointNumber pointtype:integer pushvalue:bool
Roc PointType
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1013
rocrequest
OpenEnterprise Schema
Derived From:
Description:
RocBaseDatum
The base table for all ROC Requests. Used to trigger all requests to the
ROC device.
Attributes: completionerrorcode:integer
ErrorCode set up on completion of a request (successful or failed). completionerrorcodetext:char
Text description of error code completionfailedcount:integer
Incremented by RDI to indicate failed completion of request. Cleared to
0 on ClearStatistics. completionrequesttype:integer
The type of request that was completed.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1014
OpenEnterprise Schema completionsuccesscount:integer
Incremented by RDI to indicate successful completion of request.
Cleared to 0 on ClearStatistics. completiontimestamp:datetime
Timestamp of completion of request (successful or failed) completiontimestampdstoffset:integer
An offset for DST applied to the Request completion time stamp. lastsuccessfulcompletion:datetime
The date/time of the last successful completion of the Roc Request. lastsuccessfulcompletiondstoffset:integer
A DST offset applied to the date/time of the last successful completion of the Roc Request. rdirequesttodevicecount:integer
A count of the number of times that the RDI has sent a Request to the
Device. rocschedule:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1015
OpenEnterprise Schema
A reference to any Roc Schedule associated with this Roc Request. rocscheduleid:integer
References the unique Id of any Roc Schedule associated with this Roc
Request. triggerrequest:bool
Used to manually trigger the Request. triggerrequestoptionsflags:integer
Used to determine under what circumstances the request will be done automatically by the RDI (other than schedules) - eg on receipt of SRBX
. userdescription:char
A lengthier description of the Roc Request.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1016
rocrequesttypes
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char
To be completed configrownum:integer
To be completed defaultschedule:char
To be completed defaulttriggerrequestoptionsflags:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1017 regionname:char
To be completed requestname:char
To be completed type:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1018
rocsamplerodorizorparameters
Derived From:
Description:
To be completed
To be completed
Attributes: duration:float inputratetlp:char
OpenEnterprise Schema
Amount of time, in seconds, for sampler to collect gas or odorizor to inject odor.
Rate input being used for sampler or odorizor. inputratetlp_l:integer
To be completed inputratetlp_p:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1019
OpenEnterprise Schema inputratetlp_t:integer
To be completed inputratevalue:float
Rate input value. mode:integer outputtlp:char
To be completed
Indicates what DO is being used to control a sampler or odorizor. outputtlp_l:integer
To be completed outputtlp_p:integer
To be completed outputtlp_t:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1020
OpenEnterprise Schema timebasisforrate:integer
States what rate the input value is. 0 = Per Second, 1 = Per Minute, 2 =
Per Hour, 3 = Per Day. unitaccumulation:float
Amount of units allowed past before activating sampler or odorizor.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1021
rocschedule
OpenEnterprise Schema
Derived From:
Description:
RocDevice
Common schedules set up for Roc Devices. They can be associated with
Roc Requests for scheduling data collection from Roc Devices.
Attributes: accessarea:char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. internalflags:integer
Values used internally by OpenEnterprise. maxinterval:datetime
Forces a poll at the given interval. mininterval:datetime
This attribute is currently not used. Reserved.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1022
OpenEnterprise Schema nextid:integer
Used to ensure unique Id numbers. offset:datetime
An offset that can be applied to a Schedule to stop it from running on the hour, minute etc.. May be helpful if network bandwidth is an issue. rocscheduleid:integer
The unique Id number of the Schedule schedulename:char
The unique name of the Schedule. usedisable:bool
When set to TRUE the Schedule is disabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1023
rocschedulestatistics
OpenEnterprise Schema
Derived From:
Description:
RocBaseDatum_Table
Statistics for Roc Schedules. One entry for each ScheduleId used on each
Roc device.
Attributes: completionfailedcount:integer
Number of failed completions (including ‘partial’ fails) for this device/schedule. Cleared to 0 on ClearStatistics. completionsuccesscount:integer
Number of successful completions for this device/schedule. Cleared to 0 on ClearStatistics. lasterrorcode:integer
Error Code of the last failure lasterrorcodetext:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1024
Text description of error code
OpenEnterprise Schema lasterrortimestamp:datetime
Timestamp of the last Failure lasterrortimestampdstoffset:integer
To be completed lastscheduleduration:integer
The duration of the last Schedule. lastsuccessfulcompletion:datetime
The time of the last successful Schedule completion. lastsuccessfulcompletiondstoffset:integer
To be completed lasttriggeredtimestamp:datetime
The time when the Schedule was last triggered. lasttriggeredtimestampdstoffset:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1025
To be completed
OpenEnterprise Schema numrequestsfailed:integer
Total Number of Failed ‘requests’ the last time this schedule was triggered. numrequestssuccess:integer
Total Number of Successful ‘requests’ the last time this schedule was triggered. rocschedule:char
The name of the Roc Schedule. rocscheduleid:integer
The Id of the Roc Schedule. scheduleslippedcount:integer
Number of times that this schedule has ‘slipped’ on this device (ie not triggered when it was due as the previous one was not completed, or less than MinInterval since it was completed). MinInterval is defined in dvi_schedule table. Cleared to 0 on ClearStatistics. scheduletriggeredcount:integer
Number of times this schedule has been triggered. Cleared to 0 on
ClearStatistics.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1026
rocsecuritygroupconfiguration
Derived From:
Description:
To be completed
To be completed
Attributes: group1:char group10:char group11:char group12:char
To be completed
Group identifier
Group identifier
Group identifier
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1027 group13:char
Group identifier group14:char group15:char group16:char group17:char group18:char group19:char
Group identifier
Group identifier
Group identifier
Group identifier
Group identifier
Group identifier
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1028 group2:char
Group identifier group20:char group3:char group4:char group5:char group6:char group7:char
Group identifier
Group identifier
Group identifier
Group identifier
Group identifier
Group identifier
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1029 group8:char
Group identifier group9:char
Group identifier
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1030
rocsmartiomoduleinformation800
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: boardhealth:integer
Indicates the health of the module.
0: OK
1: Module not Installed
2: Communications lost bootbuilddate:char
The time and date stamp the boot firmware was created. bootpartnumber:char
Part number of boot firmware
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1031 bootversion:char
Software Version of Boot Image
OpenEnterprise Schema flashbuilddate:char
The time and date stamp the flash firmware was created. flashdescription:char
Description that is specific for each module type flashpartnumber:char
Part number off flash firmware flashversion:char
Software Version of Flash Image modulespecificdata:char
General data that is specific for each module type. moduletype:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1032 serialnumber:char
Serial Number
OpenEnterprise Schema systemmode:integer
States the run mode of the module.
0: Boot Mode – Extremely limited functionality is available
1: Run Mode
Note: If in Boot Mode then only parameters 0 – 4, 8,9 are valid.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1033
OpenEnterprise Schema
rocstandardagaflowcalculationvalues
Derived From:
Description:
To be completed
To be completed
Attributes: basedensity:float cdorftm:float density:float
To be completed
To be completed
To be completed differentialpressureoruncorrectedflow:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1034 energycontinuousaccum:integer
To be completed energytoday:float
To be completed energyyesterday:float
To be completed ev:float
To be completed fgr:float
To be completed flowcontinuousaccum:integer
To be completed flowingminuterocpaconly:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1035 flowtoday:float
To be completed flowyesterday:float
To be completed fpb:float
To be completed fpvors:float ftb:float ftforftm:float
To be completed
To be completed
To be completed hwpforuncorrectedflowrate:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1036 imvorbmv:float
To be completed instantaneousenergy:float
To be completed instantaneousflow:float
To be completed patm:float recalczs:integer
To be completed
To be completed reserved1:float reserved10:float
To be completed
To be completed reserved11:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1037
To be completed reserved12:float reserved13:float reserved14:float reserved15:float reserved16:float reserved17:float reserved18:float
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1038
To be completed reserved19:float reserved2:float reserved20:float reserved21:float reserved22:float reserved23:float reserved24:float
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1039
To be completed reserved25:float reserved26:float reserved27:float reserved28:float reserved29:float reserved3:float reserved30:float
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1040
To be completed reserved31:float reserved32:float reserved33:float reserved34:float reserved35:float reserved36:float reserved37:float
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1041
To be completed reserved38:float reserved39:float reserved4:float reserved40:float reserved41:float reserved5:float reserved6:float
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1042
To be completed reserved7:float
To be completed
To be completed reserved8:float reserved9:float
To be completed reynoldsnumber:float
To be completed sampletime:float
To be completed staticpressure:float
To be completed temperature:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1043
To be completed yorfpm:float zb:float zf:float
To be completed
To be completed
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1044
rocstandardagaflowparameters
Derived From:
Description:
To be completed
To be completed
Attributes: agaconfiguration:integer
To be completed alarmcode:integer
To be completed c10h22ndecane:float
To be completed c2h6ethane:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1045 c3h8propane:float
To be completed c4h10ibutane:float
To be completed c4h10nbutane:float
To be completed c5h12ipentane:float
To be completed c5h12npentane:float
To be completed c6h14nhexane:float
To be completed c7h16nheptane:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1046 c8h18noctane:float
To be completed c9h20nnonane:float
To be completed calculationmethod:integer
To be completed ch4methane:float
To be completed co2carbondioxide:float
To be completed cocarbonmonoxide:float
To be completed contractorbasepressure:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1047 contractorbasetemperature:float
To be completed elevation:float
To be completed flowunits:integer
To be completed fpwlgravitationalusercorrectionfactor:float
To be completed gravityaccelerationcorrection:float
To be completed h2hydrogen:float h2owater:float
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1048 h2shydrogensulfide:float
To be completed heatingvalue:float
To be completed hehelium:float highalarm:float
To be completed
To be completed highdifferentialpressuresetpoint:float
To be completed latitude:float lowalarm:float
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1049 lowdifferentialpressureinput:char
To be completed lowdifferentialpressureinput_l:integer
To be completed lowdifferentialpressureinput_p:integer
To be completed lowdifferentialpressureinput_t:integer
To be completed lowdifferentialpressuresetpoint:float
To be completed lowdpcutofformeterfactor:float
To be completed meterinput:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1050 meterinput_l:integer
To be completed meterinput_p:integer
To be completed meterinput_t:integer
To be completed metervalue:float n2nitrogen:float
To be completed
To be completed o2oxygen:float
To be completed orificediameter:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1051 orificematerial:integer
To be completed orificereferencetemperature:float
To be completed pipediameter:float
To be completed pointdescription:char
To be completed scanperiod:integer
To be completed specificgravity:float
To be completed specificheatratio:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1052 stackeddifferentialpressure:integer
To be completed staticpressure:float
To be completed staticpressureinput:char
To be completed staticpressureinput_l:integer
To be completed staticpressureinput_p:integer
To be completed staticpressureinput_t:integer
To be completed temperature:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1053 temperatureinput:char
To be completed temperatureinput_l:integer
To be completed temperatureinput_p:integer
To be completed temperatureinput_t:integer
To be completed viscosity:float
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1054
OpenEnterprise Schema
rocstandardanaloginputcalibrationparameters
Derived From:
Description:
To be completed
To be completed
Attributes: euvalue1:float euvalue2:float euvalue3:float euvalue4:float
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1055 euvalue5:float
To be completed manualeu:float mode:integer
To be completed
To be completed presseffect:float
To be completed rawvalue1:integer
To be completed rawvalue2:integer
To be completed rawvalue3:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1056 rawvalue4:integer
To be completed rawvalue5:integer
To be completed seteuvalue:float
To be completed timer:integer type:integer
To be completed
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1057
rocstandardanaloginputs
Derived From:
Description:
To be completed
To be completed
Attributes: actualscantime:integer
To be completed adjustedad0:integer
To be completed adjustedad100:integer
To be completed alarmcode:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1058 alarmdeadband:float
To be completed
OpenEnterprise Schema calibrationmode:integer
Indicates what the calibration for the AI is doing. 0 = Use Current
Calibration, 1 = Start Calibration, 2 = Calibrate, 3 = Restore Previous
Calibration, 4 = Stop Calibration. Note: No event is logged for this parameter. calibrationtimer:integer
Number of seconds until a calibration timeout occurs. calibrationtype:integer
During calibration, determines what the Set Value (parameter #19) is replacing. 0 = Nothing, 1 = Set Zero, 2 = Set Span, 3 = Set Mid Point
#1, 4 = Set Mid Point #2, 5 = Set Mid Point #3, 6 = Set Offset (Zero
Shift). faultvalue:float filter:integer
Fault value to use when point is failed and bit 0 of parameter 15 = 1.
To be completed filteredeuvalue:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1059
To be completed highalarmeu:float
To be completed highreadingeu:float
To be completed hihialarmeu:float
To be completed lowalarmeu:float
To be completed lowlowalarmeu:float
To be completed lowreadingeu:float
To be completed manualvalue:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1060
OpenEnterprise Schema
Current EU Value of AI while performing calibration. midpointeu1:float
Second lowest calibrated EU value. midpointeu2:float
Third lowest or highest calibrated EU value. midpointeu3:float
Second highest calibrated EU value. midpointraw1:integer
Second lowest calibrated raw A/D input. midpointraw2:integer
Third lowest or highest calibrated raw A/D input. midpointraw3:integer
Second highest calibrated raw A/D input. mode:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1061
To be completed
OpenEnterprise Schema offsetzeroshift:float
Value to be added to all calculated EU values. ratealarmeu:float
To be completed rawadinput:integer
To be completed scanperiod:integer
To be completed setvalue:float spaneu:float
Desired EU value for a calibration point. Note: No event is logged for this parameter and should possibly labeled as R/O in any external Roc
Protocol Specification
Highest calibrated EU value. spanraw:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1062
Highest calibrated raw A/D input.
OpenEnterprise Schema units:char zeroeu:float zeroraw:integer
To be completed
Lowest calibrated EU value.
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1063
rocstandardanalogoutputs
Derived From:
Description:
To be completed
To be completed
Attributes: adjustedda0:integer
To be completed adjustedda100:integer
To be completed alarmcode:integer
To be completed euvalue:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1064 highreadingeu:float
To be completed lowreadingeu:float
To be completed mode:integer
To be completed rawdaoutput:integer
To be completed units:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1065
rocstandardbatteryparameters
Derived From:
Description:
To be completed
To be completed
Attributes: batteryactivity:integer
To be completed batterytemperature:float
To be completed batteryturnonvoltage:float
To be completed batteryvoltage:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1066 dutycycle:integer
To be completed lowbatterydropout:float
To be completed metricenglishunitsflag:integer
To be completed pointstatus:integer
To be completed referencevoltage:float
To be completed sleepflag:integer task:integer
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1067 voltageinput:float
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1068
rocstandardclock
Derived From:
Description:
To be completed
To be completed
Attributes: century:integer day:integer
To be completed
To be completed daylightsavingsenable:integer
To be completed dayofweek:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1069 hours:integer
To be completed leapyear:integer minutes:integer
To be completed
To be completed month:integer
To be completed seconds:integer
To be completed time:datetime
To be completed timedstoffset:integer
To be completed year:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1070
rocstandardcommports
Derived From:
Description:
To be completed
To be completed
Attributes: alarmpointer:integer
To be completed baudrate:integer
To be completed configurationcommand:char
To be completed connectcommand:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1071
To be completed connecttime:float
To be completed databits:integer
To be completed disconnecttime:float
To be completed hostretrytimemodbus:integer
To be completed
OpenEnterprise Schema idletime:integer
The number of milliseconds to wait between characters to determine
EndOfMessage inactivitytime:float
To be completed keyoffdelay:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1072
To be completed keyondelay:integer
To be completed modbushosttablestart:integer
To be completed mode:integer
To be completed modemstatus:integer
To be completed modemtype:integer
To be completed parity:integer pointstatus:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1073
To be completed portowner:integer
To be completed rbxaddress:integer
To be completed rbxextrakeyondelay:integer
To be completed rbxgroup:integer
To be completed rbxretrycount1:integer
To be completed rbxretrycount2:integer
To be completed rbxretrycount3:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1074
To be completed
OpenEnterprise Schema rbxtimebase1:float
To be completed rbxtimebase2:float
To be completed rbxtimebase3:float
To be completed receivebufferaddress:integer
Receive Buffer Address – Used for debugging purposes. receivecountercopy:integer
To be completed retrycounter:integer
To be completed stopbits:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1075
To be completed storeforwardaddress1:integer
To be completed storeforwardaddress2:integer
To be completed storeforwardaddress3:integer
To be completed storeforwardgroup1:integer
To be completed storeforwardgroup2:integer
To be completed storeforwardgroup3:integer
To be completed transmitbufferaddress:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1076
OpenEnterprise Schema
Transmit Buffer Address – Used for debugging purposes. validreceivecounter:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1077
rocstandardconfigurableopcode
Derived From:
Description:
To be completed
To be completed
Attributes: data1:char data10:char data10_l:integer data10_p:integer
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1078 data10_t:integer data11:char data11_l:integer data11_p:integer data11_t:integer data12:char data12_l:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1079 data12_p:integer data12_t:integer data13:char data13_l:integer data13_p:integer data13_t:integer data14:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1080 data14_l:integer data14_p:integer data14_t:integer data15:char data15_l:integer data15_p:integer data15_t:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1081 data16:char data16_l:integer data16_p:integer data16_t:integer data17:char data17_l:integer data17_p:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1082 data17_t:integer data18:char data18_l:integer data18_p:integer data18_t:integer data19:char data19_l:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1083 data19_p:integer data19_t:integer data1_l:integer data1_p:integer data1_t:integer data2:char data20:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1084 data20_l:integer data20_p:integer data20_t:integer data21:char data21_l:integer data21_p:integer data21_t:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1085 data22:char data22_l:integer data22_p:integer data22_t:integer data23:char data23_l:integer data23_p:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1086 data23_t:integer data24:char data24_l:integer data24_p:integer data24_t:integer data25:char data25_l:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1087 data25_p:integer data25_t:integer data26:char data26_l:integer data26_p:integer data26_t:integer data27:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1088 data27_l:integer data27_p:integer data27_t:integer data28:char data28_l:integer data28_p:integer data28_t:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1089 data29:char data29_l:integer data29_p:integer data29_t:integer data2_l:integer data2_p:integer data2_t:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1090 data3:char data30:char data30_l:integer data30_p:integer data30_t:integer data31:char data31_l:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1091 data31_p:integer data31_t:integer data32:char data32_l:integer data32_p:integer data32_t:integer data33:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1092 data33_l:integer data33_p:integer data33_t:integer data34:char data34_l:integer data34_p:integer data34_t:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1093 data35:char data35_l:integer data35_p:integer data35_t:integer data36:char data36_l:integer data36_p:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1094 data36_t:integer data37:char data37_l:integer data37_p:integer data37_t:integer data38:char data38_l:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1095 data38_p:integer data38_t:integer data39:char data39_l:integer data39_p:integer data39_t:integer data3_l:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1096 data3_p:integer data3_t:integer data4:char data40:char data40_l:integer data40_p:integer data40_t:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1097 data41:char data41_l:integer data41_p:integer data41_t:integer data42:char data42_l:integer data42_p:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1098 data42_t:integer data43:char data43_l:integer data43_p:integer data43_t:integer data44:char data44_l:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1099 data44_p:integer data44_t:integer data4_l:integer data4_p:integer data4_t:integer data5:char data5_l:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1100 data5_p:integer data5_t:integer data6:char data6_l:integer data6_p:integer data6_t:integer data7:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1101 data7_l:integer data7_p:integer data7_t:integer data8:char data8_l:integer data8_p:integer data8_t:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1102 data9:char data9_l:integer data9_p:integer data9_t:integer
To be completed
To be completed
To be completed
To be completed sequencerevision:float
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1103
rocstandarddiscreteinputs
Derived From:
Description:
To be completed
To be completed
Attributes: accumulatedvalue:integer
To be completed alarmcode:integer
To be completed alarmdeadband:float
To be completed euvalue:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1104 filter:integer
To be completed highalarmeu:float
To be completed highreadingeu:float
To be completed hihialarmeu:float
To be completed lowalarmeu:float
To be completed lowlowalarmeu:float
To be completed lowreadingeu:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1105 maxtimebetweenpulsesmaxcount:integer
To be completed mode:integer
To be completed offcounter:integer
To be completed oncounter:integer
To be completed pointstatus:integer
To be completed pulsewidth0:integer
To be completed pulsewidth100:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1106 ratealarmeu:float
To be completed scanperiod:integer
To be completed tdicount:integer units:char
To be completed
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1107
rocstandarddiscreteoutputs
Derived From:
Description:
To be completed
To be completed
Attributes: accumulatedvalue:integer
To be completed alarmcode:integer
To be completed alarmmode:integer
To be completed count0:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1108 count100:integer
To be completed cycletime:integer
To be completed euvalue:float
To be completed highreadingeu:float
To be completed lowreadingeu:float
To be completed mode:integer
To be completed pointstatus:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1109 reserved1:integer
To be completed timeon:integer units:char
To be completed
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1110
rocstandardextrarunparameters
Derived From:
Description:
To be completed
To be completed
Attributes: betadiameterratio:float
To be completed cdcoefficientofdischargeaga1992:float
To be completed energyaccumulated:float
To be completed energymonth:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1111 energypreviousmonth:float
To be completed energytoday:float
To be completed energyyesterday:float
To be completed evvelocityofapproachaga1992:float
To be completed flowaccumulated:float
To be completed flowmonth:float
To be completed flowpreviousmonth:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1112 flowtoday:float
To be completed flowyesterday:float
To be completed minutesaccumulated:float
To be completed minutesmonth:float
To be completed minutespreviousmonth:float
To be completed minutestoday:float
To be completed minutesyesterday:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1113 molecularweight:float
To be completed orificeplateborediameterd:float
To be completed pipeinternaldiameterd:float
To be completed reynoldsnumber:float
To be completed uncorrectedaccumulated:float
To be completed uncorrectedmonth:float
To be completed uncorrectedpreviousmonth:float
To be completed uncorrectedtoday:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1114
To be completed uncorrectedyesterday:float
To be completed upstreamstaticpressure:float
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1115
rocstandardflags
Derived From:
Description:
To be completed
To be completed
Attributes: auxiliaryoutput1on:integer
To be completed auxiliaryoutput2on:integer
To be completed clearconfigmemory:integer
To be completed coldstart:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1116 commport1security:integer
To be completed commport2security:integer
To be completed commport3security:integer
To be completed commportpassthroughmode:integer
To be completed configmemorywritecomplete:integer
To be completed crccheck:integer
To be completed dipifor306312:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1117 eventlogflag:integer
To be completed flag1:integer flag2:integer flag24:integer flag25:integer flag26:integer flag27:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1118 flag28:integer
To be completed flag29:integer flag3:integer
To be completed
To be completed flag5:integer
To be completed
To be completed flag6:integer flag7:integer
To be completed fstdisplayclear:integer
To be completed historyarchiveoption:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1119
OpenEnterprise Schema
Archive history logs upon meter run configuration changes. historytimestampoption:integer
0=End of Period, 1=Beginning of Period ioscanenable:integer
To be completed lcdportsecurity:integer
To be completed loiportsecurity:integer
To be completed powermode:integer
FB103 Power Control. Bit 7 - 0 = Enabled, 1 = Disabled readio:integer rtscommport1:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1120
To be completed rtscommport2:integer
To be completed rtscommport3:integer
To be completed rtsloiport:integer
To be completed terminationtypeinstalled:integer
To be completed usercalc1enable:integer
To be completed usercalc2enable:integer
To be completed usercalcenable:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1121
To be completed usercom1enable:integer
To be completed usercom2enable:integer
To be completed userlcdenable:integer
To be completed useroperatorportenable:integer
To be completed warmstart:integer
To be completed writetoconfigmemory:integer
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1122
rocstandardfstparameters
Derived From:
Description:
To be completed
To be completed
Attributes: codesize:integer
To be completed compareflagsvd:integer
To be completed executiondelay:integer
To be completed instructionpointer:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1123 message1:char message2:char
To be completed
To be completed messagedata:char
To be completed miscellaneous1:integer
To be completed miscellaneous2:integer
To be completed miscellaneous3:integer
To be completed miscellaneous4:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1124 register1:float register10:float register2:float register3:float register4:float register5:float register6:float
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1125 register7:float register8:float
To be completed
To be completed register9:float
To be completed resultregister:float
To be completed runstatus:integer timer1:integer timer2:integer
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1126 timer3:integer timer4:integer
To be completed
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1127
rocstandardhistorypoint
OpenEnterprise Schema
Derived From:
Description:
RocHistoryPoint_Table
Additional fields for Roc Standard History Point Parameter data. There will normally be one entry in this table for each history point within the Roc device.
Attributes: lastdailyvalue:float
Standard: Roc Parameter 5 (point-type 19) lasthourstotal:float
Standard: Roc Parameter 6 (point-type 19) pointertotag:float
Standard: Roc Parameter 0 (point-type 19)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1128
rocstandardlocaldisplaypanel
Derived From:
Description:
To be completed
To be completed
Attributes: dataforline1:char
To be completed dataforline1_l:integer
To be completed dataforline1_p:integer
To be completed dataforline1_t:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1129 dataforline2:char
To be completed dataforline2_l:integer
To be completed dataforline2_p:integer
To be completed dataforline2_t:integer
To be completed dataforline3:char
To be completed dataforline3_l:integer
To be completed dataforline3_p:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1130 dataforline3_t:integer
To be completed textforline1:char textforline2:char textforline3:char
To be completed
To be completed
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1131
OpenEnterprise Schema
rocstandardlogonsecuritiesparameters
Derived From:
Description:
To be completed
To be completed
Attributes: accesslevel:integer
A value that is used to limit access to parameters when parameter (95, x, 44) is set to 2 (Security by User Access Level) where x = to the logical of the port that the request is being made on. keypadsecurity:integer
To be completed listsecurity:integer
To be completed operatorid:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1132 password:integer
To be completed spare:integer
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1133
OpenEnterprise Schema
rocstandardmetercalibrationandsampler
Derived From:
Description:
To be completed
To be completed
Attributes: airtemperaturewhencalibrating:float
To be completed ambienttemperatureofmercury:float
To be completed calculatedweightsgravitationalacceleration:float
To be completed calibrationoptions:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1134 integritylevelturbine:integer
To be completed samplerduration:float
To be completed samplerenable:integer
To be completed samplerouputpoint:char
To be completed samplerouputpoint_l:integer
To be completed samplerouputpoint_p:integer
To be completed samplerouputpoint_t:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1135 samplervolumeaccumulation:float
To be completed smalarmcontrol:integer
To be completed smintegrityalarmcode:integer
To be completed smintegrityalarmdeadbandtime:integer
To be completed temperatureofmercurywhencalibrated:float
To be completed usercorrectionfactor:float
To be completed watertemperaturewhencalibrated:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1136
OpenEnterprise Schema
rocstandardmeterconfigurationparameters
Derived From:
Description:
To be completed
To be completed
Attributes: alarmcode:integer
To be completed alarmdeadband:float
Alarm deadband, in mlb/day, lb/hr, mft3/day, ft3/hr, or the metric equivalent arargon:float
Argon (Ar) composition, mole %. atmosphericpressure:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1137 averagingtechnique:integer
To be completed baseorcontractpressure:float
To be completed baseorcontracttemperature:float
To be completed c10h22ndecane:float
To be completed c2h6ethane:float
To be completed c3h8propane:float
To be completed c4h10ibutane:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1138 c4h10nbutane:float
To be completed c5h12ipentane:float
To be completed c5h12npentane:float
To be completed c6h14nhexane:float
To be completed c7h16nheptane:float
To be completed c8h18noctane:float
To be completed c9h20nnonane:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1139
OpenEnterprise Schema calculationmethod:integer
To be completed calculationmethodii:integer
To be completed ch4methane:float
To be completed co2carbondioxide:float
To be completed cocarbonmonoxide:float
To be completed configurationstatuses:integer
Configuration statuses byte 4:
Bits 2-7 – Not Used
Bit 1 – Flow rate time basis for alarming
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1140
0: Daily flow rate
1: Hourly flow rate
Bit 0 – Phase of fluid
0: Gas
1: Liquid contracthour:integer
To be completed deadbandformultiplekfactorcalculation:float
To be completed elevation:float
To be completed enablestackedhw:integer
To be completed euvalue1:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1141 euvalue10:float
OpenEnterprise Schema
10th EU value when multiple K factors are specified. euvalue11:float euvalue12:float euvalue2:float euvalue3:float euvalue4:float euvalue5:float
11th EU value when multiple K factors are specified.
Highest EU value when multiple K factors are specified.
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1142 euvalue6:float
OpenEnterprise Schema
6th EU value when multiple K factors are specified. euvalue7:float
7th EU value when multiple K factors are specified.
8th EU value when multiple K factors are specified. euvalue8:float euvalue9:float
9th EU value when multiple K factors are specified. fullrecalculationflag:integer
To be completed h2hydrogen:float h2owater:float
To be completed
To be completed h2shydrogensulfide:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1143
To be completed heatingvalue:float
To be completed hehelium:float
To be completed highalarmflow:float
To be completed highhwsetpoint:float
To be completed highhwsetpointorlowflowratecutoff:float
To be completed hworuncorrectedflowrate:float
To be completed hwtlporuncorrectedflowratetlp:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1144
To be completed hwtlporuncorrectedflowratetlp_l:integer
To be completed hwtlporuncorrectedflowratetlp_p:integer
To be completed hwtlporuncorrectedflowratetlp_t:integer
To be completed imporbmp:float
To be completed inputtlpformultiplekfactorcalculation:char
To be completed inputtlpformultiplekfactorcalculation_l:integer
To be completed inputtlpformultiplekfactorcalculation_p:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1145
To be completed
OpenEnterprise Schema inputtlpformultiplekfactorcalculation_t:integer
To be completed joulethomsoncoefficient:float
Joule-Thomson coefficient, in deg F/psi or deg C/kPa. (ISO5167 only.) kfactor1:float kfactor10:float
To be completed
10th K factor when multiple K factors are specified. kfactor11:float kfactor12:float kfactor2:float
11th K factor when multiple K factors are specified.
Highest K factor when multiple K factors are specified.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1146
To be completed kfactor3:float kfactor4:float kfactor5:float kfactor6:float kfactor7:float kfactor8:float kfactor9:float
OpenEnterprise Schema
To be completed
To be completed
To be completed
To be completed
7th K factor when multiple K factors are specified.
8th KfFactor when multiple K factors are specified.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1147
OpenEnterprise Schema
9th K factor when multiple K factors are specified. latitude:float
To be completed localgravitationalacceleration:float
To be completed lowalarmflow:float
To be completed lowhwcutofforstatickfactor:float
To be completed lowhwsetpoint:float
To be completed lowhwtlp:char lowhwtlp_l:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1148
To be completed
OpenEnterprise Schema lowhwtlp_p:integer
To be completed lowhwtlp_t:integer
To be completed n2nitrogen:float
To be completed noflowtime:integer
If the flow input is from a differential meter: o2oxygen:float
Not used.
If the flow input is from a linear meter using a PI point for the flow input:
User specified number of seconds that
must elapse without pulses to consider
currently there is no flow.
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1149 options:integer
To be completed orificediameter:float
To be completed orificematerial:integer
To be completed orificereferencetemperature:float
To be completed pfstaticpressure:float
To be completed pftlp:char pftlp_l:integer
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1150 pftlp_p:integer pftlp_t:integer
To be completed
To be completed pipediameter:float
To be completed pipematerial:integer
To be completed pipereferencetemperature:float
To be completed pointdescription:char
To be completed pressureloss:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1151
OpenEnterprise Schema primaryelementtype:integer
If the flow input is from a differential meter and the ISO 5167 standard is selected , this parameter is the type of primary element as follows:
0: Orifice with flange taps
1: Orifice with corner taps
2: Orifice with D and D/2 taps
10: Venturi tube
All other meter cases:
Not used specificgravity:float
To be completed specificheatratio:float
To be completed tftemperature:float
To be completed tftlp:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1152 tftlp_l:integer tftlp_p:integer tftlp_t:integer venturicdft:float viscosity:float
OpenEnterprise Schema
To be completed
To be completed
To be completed
If the flow input is from a differential meter, the ISO 5167 standard is selected, and the primary element is a venturi:
User defineable coefficient of discharge
(CdFT); dimensionless.
All other meter cases:
Not used
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1153
rocstandardmeterflowvalues
Derived From:
Description:
To be completed
To be completed
Attributes: averagehwortotalcounts:float
To be completed averagepf:float
To be completed averagetf:float basedensity:float
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1154
OpenEnterprise Schema betadiameterratio:float
To be completed calculatedstatuses:integer
Calculated statuses:
Bit 2 – Units of flow calculations. This is
gets set or cleared by the flow
calculation program.
0: Volumetric
1: Mass
Bit 1 – Source of properties calculations. This is set by the user C program. It is cleared during every restart.
0: Firmware
1: User C program
Bit 0 – Source of flow calculations. This is set by the user C program. It is cleared during every restart.
0: Fimware
1: User C program cdft:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1155
To be completed
OpenEnterprise Schema compressibilitymultiplier:float
Applies only if the calculation standard is AGA7. Compressibility
Multiplier = Zb/Zf density:float
To be completed dmetertubeinternaldiameter:float
To be completed dorificeplateborediameter:float
To be completed energyaccumulated:float
To be completed energymonth:float
To be completed energypreviousmonth:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1156
To be completed energyrateperday:float
To be completed energyrateperhour:float
To be completed energytoday:float
To be completed energyyesterday:float
To be completed evvelocityofapproach:float
To be completed expansionfactororfpm:float
To be completed fam:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1157
To be completed
OpenEnterprise Schema fgr:float
To be completed
To be completed fhgm:float fhgt:float
To be completed flowaccumulated:float
To be completed flowcalculationstandard:char
To be completed flowingstatus:integer
Status of flow passing through the meter during the current second:
0: Not currently flowing
1: Currently flowing
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1158 flowmonth:float
To be completed flowpreviousmonth:float
To be completed flowrateperday:float
To be completed flowrateperhour:float
To be completed flowtoday:float
To be completed flowyesterday:float
To be completed fnorftm:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1159 fpb:float
To be completed fpv:float
To be completed fpwldifferential:float
To be completed fpwlstatic:float ftb:float
To be completed
To be completed ftf:float fwl:float
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1160 fwt:float
To be completed
OpenEnterprise Schema imvorbmv:float
To be completed massaccumulated:float
Mass flow accumulated since the last reset; mlb or tonnes massmonth:float
Mass flow this month; mlb or tonnes masspreviousmonth:float
Mass flow the previous month; mlb or tonnes massrateperday:float
Daily mass flow rate; mlb/day or tonnes/day massrateperhour:float
Hourly mass flow rate; lb/hr or kg/hr masstoday:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1161
Mass flow today; mlb or tonnes
OpenEnterprise Schema massyesterday:float
Mass flow yesterday; mlb or tonnes minutesaccumulated:float
To be completed minutesmonth:float
To be completed minutespreviousmonth:float
To be completed minutestoday:float
To be completed minutesyesterday:float
To be completed molecularweight:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1162
To be completed
OpenEnterprise Schema partialrecalculationflag:integer
To be completed pressureextension:float
To be completed pressureextensionoruncorrectedflowrate:float
To be completed pressuremultiplier:float
To be completed propertiescalculationstandard:char
To be completed pulsesaccumulated:integer
If the flow input is from a differential meter:
Not used.
If the flow input is from a linear meter:
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1163
Raw pulses. If the flow input is
OpenEnterprise Schema
from a pulse input, this value is
equal to TLP=5,Pt No,16. If the
flow input is not a pulse input, this
value is calculated based on the reserved1:float
rate and K-factor.
To be completed reserved2:float
Redundant Total Counts - Turbine reynoldsnumber:float
To be completed temperaturemultiplier:float
Applies only if the calculation standard is AGA7. Temperature Multiplier
= Tb/Tf uncorrectedaccumulated:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1164 uncorrectedmonth:float
To be completed
OpenEnterprise Schema uncorrectedpreviousmonth:float
To be completed uncorrectedtoday:float
To be completed uncorrectedyesterday:float
To be completed upstreamflowingtemperature:float
Upstream flowing temperature, in feg F or deg C.(ISO5167 only.) upstreamstaticpressure:float
To be completed zb:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1165 zf1:float
To be completed zs:float
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1166
OpenEnterprise Schema
rocstandardmodbusconfigurationparameters
Derived From:
Description:
To be completed
To be completed
Attributes: highfloatscale1:float
To be completed highfloatscale2:float
To be completed highfloatscale3:float
To be completed highfloatscale4:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1167 highfloatscale5:float
To be completed highfloatscale6:float
To be completed highfloatscale7:float
To be completed highfloatscale8:float
To be completed highintegerscale:integer
To be completed lowfloatscale1:float
To be completed lowfloatscale2:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1168 lowfloatscale3:float
To be completed lowfloatscale4:float
To be completed lowfloatscale5:float
To be completed lowfloatscale6:float
To be completed lowfloatscale7:float
To be completed lowfloatscale8:float
To be completed lowintegerscale:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1169 options:integer
To be completed pointstatus:integer
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1170
rocstandardmodbusfunctiontables
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: conversioncode1:integer
To be completed conversioncode10:integer
To be completed conversioncode11:integer
To be completed conversioncode12:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1171 conversioncode13:integer
To be completed conversioncode14:integer
To be completed conversioncode15:integer
To be completed conversioncode2:integer
To be completed conversioncode3:integer
To be completed conversioncode4:integer
To be completed conversioncode5:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1172 conversioncode6:integer
To be completed conversioncode7:integer
To be completed conversioncode8:integer
To be completed conversioncode9:integer
To be completed endregister1:integer
To be completed endregister10:integer
To be completed endregister11:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1173 endregister12:integer
To be completed endregister13:integer
To be completed endregister14:integer
To be completed endregister15:integer
To be completed endregister2:integer
To be completed endregister3:integer
To be completed endregister4:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1174 endregister5:integer
To be completed endregister6:integer
To be completed endregister7:integer
To be completed endregister8:integer
To be completed endregister9:integer
To be completed rocparameters1:char
To be completed rocparameters10:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1175 rocparameters10_l:integer
To be completed rocparameters10_p:integer
To be completed rocparameters10_t:integer
To be completed rocparameters11:char
To be completed rocparameters11_l:integer
To be completed rocparameters11_p:integer
To be completed rocparameters11_t:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1176 rocparameters12:char
To be completed rocparameters12_l:integer
To be completed rocparameters12_p:integer
To be completed rocparameters12_t:integer
To be completed rocparameters13:char
To be completed rocparameters13_l:integer
To be completed rocparameters13_p:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1177 rocparameters13_t:integer
To be completed rocparameters14:char
To be completed rocparameters14_l:integer
To be completed rocparameters14_p:integer
To be completed rocparameters14_t:integer
To be completed rocparameters15:char
To be completed rocparameters15_l:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1178 rocparameters15_p:integer
To be completed rocparameters15_t:integer
To be completed rocparameters1_l:integer
To be completed rocparameters1_p:integer
To be completed rocparameters1_t:integer
To be completed rocparameters2:char
To be completed rocparameters2_l:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1179 rocparameters2_p:integer
To be completed rocparameters2_t:integer
To be completed rocparameters3:char
To be completed rocparameters3_l:integer
To be completed rocparameters3_p:integer
To be completed rocparameters3_t:integer
To be completed rocparameters4:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1180 rocparameters4_l:integer
To be completed rocparameters4_p:integer
To be completed rocparameters4_t:integer
To be completed rocparameters5:char
To be completed rocparameters5_l:integer
To be completed rocparameters5_p:integer
To be completed rocparameters5_t:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1181 rocparameters6:char
To be completed rocparameters6_l:integer
To be completed rocparameters6_p:integer
To be completed rocparameters6_t:integer
To be completed rocparameters7:char
To be completed rocparameters7_l:integer
To be completed rocparameters7_p:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1182 rocparameters7_t:integer
To be completed rocparameters8:char
To be completed rocparameters8_l:integer
To be completed rocparameters8_p:integer
To be completed rocparameters8_t:integer
To be completed rocparameters9:char
To be completed rocparameters9_l:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1183 rocparameters9_p:integer
To be completed rocparameters9_t:integer
To be completed startregister1:integer
To be completed startregister10:integer
To be completed startregister11:integer
To be completed startregister12:integer
To be completed startregister13:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1184 startregister14:integer
To be completed startregister15:integer
To be completed startregister2:integer
To be completed startregister3:integer
To be completed startregister4:integer
To be completed startregister5:integer
To be completed startregister6:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1185 startregister7:integer
To be completed startregister8:integer
To be completed startregister9:integer
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1186
OpenEnterprise Schema
rocstandardmodbusspecialfunctiontable
Derived From:
Description:
To be completed
To be completed
Attributes: conversioncode1:integer
To be completed conversioncode10:integer
To be completed conversioncode11:integer
To be completed conversioncode12:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1187 conversioncode13:integer
To be completed conversioncode14:integer
To be completed conversioncode15:integer
To be completed conversioncode16:integer
To be completed conversioncode17:integer
To be completed conversioncode18:integer
To be completed conversioncode19:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1188 conversioncode2:integer
To be completed conversioncode20:integer
To be completed conversioncode3:integer
To be completed conversioncode4:integer
To be completed conversioncode5:integer
To be completed conversioncode6:integer
To be completed conversioncode7:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1189
OpenEnterprise Schema conversioncode8:integer
To be completed conversioncode9:integer
To be completed dailyhistoryindexregister:integer
To be completed dateregister:integer
To be completed efmmodbusmode:integer
EFM extension mode 0=Disabled, 1=Enabled endhistorypoint1:integer
To be completed endhistorypoint10:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1190 endhistorypoint11:integer
To be completed endhistorypoint12:integer
To be completed endhistorypoint13:integer
To be completed endhistorypoint14:integer
To be completed endhistorypoint15:integer
To be completed endhistorypoint16:integer
To be completed endhistorypoint17:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1191 endhistorypoint18:integer
To be completed endhistorypoint19:integer
To be completed endhistorypoint2:integer
To be completed endhistorypoint20:integer
To be completed endhistorypoint3:integer
To be completed endhistorypoint4:integer
To be completed endhistorypoint5:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1192 endhistorypoint6:integer
To be completed endhistorypoint7:integer
To be completed endhistorypoint8:integer
To be completed endhistorypoint9:integer
To be completed eventalarmregister:integer
To be completed extendedhistoryindexregister:integer
To be completed historyarchiveregister1:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1193 historyarchiveregister10:integer
To be completed historyarchiveregister11:integer
To be completed historyarchiveregister12:integer
To be completed historyarchiveregister13:integer
To be completed historyarchiveregister14:integer
To be completed historyarchiveregister15:integer
To be completed historyarchiveregister16:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1194 historyarchiveregister17:integer
To be completed historyarchiveregister18:integer
To be completed historyarchiveregister19:integer
To be completed historyarchiveregister2:integer
To be completed historyarchiveregister20:integer
To be completed historyarchiveregister3:integer
To be completed historyarchiveregister4:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1195 historyarchiveregister5:integer
To be completed historyarchiveregister6:integer
To be completed historyarchiveregister7:integer
To be completed historyarchiveregister8:integer
To be completed historyarchiveregister9:integer
To be completed historyformat:integer
To be completed periodichistoryindexregister:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1196 starthistorypoint1:integer
To be completed starthistorypoint10:integer
To be completed starthistorypoint11:integer
To be completed starthistorypoint12:integer
To be completed starthistorypoint13:integer
To be completed starthistorypoint14:integer
To be completed starthistorypoint15:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1197 starthistorypoint16:integer
To be completed starthistorypoint17:integer
To be completed starthistorypoint18:integer
To be completed starthistorypoint19:integer
To be completed starthistorypoint2:integer
To be completed starthistorypoint20:integer
To be completed starthistorypoint3:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1198
OpenEnterprise Schema starthistorypoint4:integer
To be completed starthistorypoint5:integer
To be completed starthistorypoint6:integer
To be completed starthistorypoint7:integer
To be completed starthistorypoint8:integer
To be completed starthistorypoint9:integer
To be completed timeregister:integer
Register containing current ROC time (hhmmss)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1199 typeofhistoryarchive1:integer
To be completed typeofhistoryarchive10:integer
To be completed typeofhistoryarchive11:integer
To be completed typeofhistoryarchive12:integer
To be completed typeofhistoryarchive13:integer
To be completed typeofhistoryarchive14:integer
To be completed typeofhistoryarchive15:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1200 typeofhistoryarchive16:integer
To be completed typeofhistoryarchive17:integer
To be completed typeofhistoryarchive18:integer
To be completed typeofhistoryarchive19:integer
To be completed typeofhistoryarchive2:integer
To be completed typeofhistoryarchive20:integer
To be completed typeofhistoryarchive3:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1201 typeofhistoryarchive4:integer
To be completed typeofhistoryarchive5:integer
To be completed typeofhistoryarchive6:integer
To be completed typeofhistoryarchive7:integer
To be completed typeofhistoryarchive8:integer
To be completed typeofhistoryarchive9:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1202
rocstandardmoduleinformation
Derived From:
Description:
To be completed
To be completed
Attributes: actualscanmoduletype:integer
To be completed bootbuilddate:char
To be completed bootrevisionstring:char
To be completed builddate:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1203 compositealarmsummary:integer
To be completed compositeintegritystatus:integer
To be completed installedmoduledescription:char
Installed SAM Description installedmoduletype:integer
To be completed modulealarmstatus:integer
To be completed moduleconfiguration11:integer
To be completed moduleconfiguration12:integer
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1204 moduleconfiguration13:integer
To be completed moduleconfiguration14:integer
To be completed moduleconfiguration15:integer
To be completed moduleconfiguration16:integer
To be completed moduledescription:char
Description of module. modulediagnostic17:float
To be completed modulediagnostic18:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1205 modulediagnostic19:float
To be completed modulediagnostic20:integer
To be completed modulediagnostic21:integer
To be completed modulediagnostic22:integer
To be completed modulediagnostic23:integer
To be completed modulediagnostic24:integer
To be completed modulediagnostic25:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1206 modulediagnostic26:char
To be completed modulediagnostic27:char
To be completed moduleintegritystatus:integer
To be completed partnumber:char
To be completed revisionstring:char
To be completed serialnumberstring:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1207
rocstandardmultivariablesensor
Derived From:
Description:
To be completed
To be completed
Attributes: apalarmcode:integer
To be completed apalarmfaultvalue:float
To be completed apcalibrationmidpoint1:float
To be completed apcalibrationmidpoint2:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1208 apcalibrationmidpoint3:float
To be completed apdeadband:float
To be completed aphighalarm:float
To be completed aplowalarm:float
To be completed apmaximumcalibrationvalue:float
To be completed apminimumcalibrationvalue:float
To be completed apmode:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1209 calibratecommand:integer
To be completed calibratesetvalue:float
To be completed calibratetype:integer
To be completed differentialpressurereading:float
To be completed dpalarmcode:integer
To be completed dpalarmfaultvalue:float
To be completed dpcalibrationmidpoint1:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1210 dpcalibrationmidpoint2:float
To be completed dpcalibrationmidpoint3:float
To be completed dpdeadband:float
To be completed dphighalarm:float
To be completed dplowalarm:float
To be completed dpmaximumcalibrationvalue:float
To be completed dpminimumcalibrationvalue:float
To be completed dpmode:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1211
To be completed dpreverseflow:float
To be completed interfacerevision:integer
To be completed manualap:float manualdp:float
To be completed
To be completed manualpt:float
To be completed pollmode:integer pressureoffset:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1212
Static pressure offset. ptalarmcode:integer
To be completed ptcalibrationmidpoint1:float
To be completed ptcalibrationmidpoint2:float
To be completed ptcalibrationmidpoint3:float
To be completed ptdeadband:float
To be completed ptfaultvalue:float pthighalarm:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1213
To be completed ptlowalarm:float
To be completed ptmaximumcalibrationvalue:float
To be completed ptminimumcalibrationvalue:float
To be completed ptmode:integer
To be completed rtdbias:float
RTD Bias. sensoraddress:integer
To be completed sensoralarming:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1214
To be completed sensorconfiguration:integer
To be completed sensorstatus:integer
To be completed sensorvoltage:float
To be completed staticpressureeffect:float
To be completed staticpressurereading:float
To be completed temperaturereading:float
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1215
rocstandardpidcontrolparameters
Derived From:
Description:
To be completed
To be completed
Attributes: actualloopperiod:float
To be completed controltype:integer
To be completed
OpenEnterprise Schema currentoutputofpid:float
To be completed loopperiod:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1216
OpenEnterprise Schema loopswitchselect:integer
Control loop from which to select all changes. Only used if the control scheme is specified to use the primary and override loops.
0: Select changes from either loop
1: Select only changes from the primary loop
2: Select only changes from the override loop outputhighlimit:float
If the output is specified to be an analog output:
High limit of the value written to
the analog output.
If the output is specified to be two (2) discrete outputs:
High limit of the magnitude of
the change written to the
increase of decrease discrete
output. outputlowlimit:float
To be completed outputofpid:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1217
To be completed outputofpid_l:integer
To be completed outputofpid_p:integer
To be completed outputofpid_t:integer
To be completed overridechangeinoutput:float
To be completed overridehigheu:float
To be completed overrideinputpoint:char
To be completed overrideinputpoint_l:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1218
To be completed overrideinputpoint_p:integer
To be completed overrideinputpoint_t:integer
To be completed overrideintegraldeadband:float
To be completed overrideloweu:float
To be completed overrideprocessvariable:float
To be completed overrideproportionalgain:float
To be completed overrideratederivativegain:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1219
To be completed
OpenEnterprise Schema overrideresetintegralgain:float
To be completed overridescalefactor:float
To be completed overridesetpoint:float
To be completed overridesetpointchangemaximum:float
To be completed overridethreshold:float
If the control scheme is specified to use the primary and override loops:
Threshold of the error of the
override loop which when
exceeded in the safe direction
results in only the changes of
the primary loop to be
selected by the high/low
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1220
selector. Otherwise, the
OpenEnterprise Schema
high/low selector selects the
appropriate change. A
threshold of 0.0 deactivates
this feature.
If the control scheme is specified to use only one of the primary or override loops:
Not used. primarychangeinoutput:float
To be completed primaryhigheu:float
To be completed primaryinputpoint:char
To be completed primaryinputpoint_l:integer
To be completed primaryinputpoint_p:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1221
To be completed primaryinputpoint_t:integer
To be completed primaryintegraldeadband:float
To be completed primaryloweu:float
To be completed primaryprocessvariable:float
To be completed primaryproportionalgain:float
To be completed primaryratederivativegain:float
To be completed primaryresetintegralgain:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1222
To be completed primaryscalefactor:float
To be completed primarysetpoint:float
To be completed primarysetpointchangemaximum:float
To be completed secondoutputofpid:char
To be completed secondoutputofpid_l:integer
To be completed secondoutputofpid_p:integer
To be completed secondoutputofpid_t:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1223
To be completed
OpenEnterprise Schema switchstatus:integer
To be completed unitsofoutput:char
Units of the output. unitsofoverridepv:char
Units of the setpoint and process variable of the override loop. unitsofprimaypv:char
Units of the setpoint and process variable of the primary loop.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1224
rocstandardpidparameters
Derived From:
Description:
To be completed
To be completed
Attributes: actualloopperiodscantime:integer
To be completed controltype:integer
To be completed loopstatus:integer
To be completed minimumcontroltime:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1225 overrideinputpoint:char
To be completed overrideinputpoint_l:integer
To be completed overrideinputpoint_p:integer
To be completed overrideinputpoint_t:integer
To be completed overrideintegraldeadband:float
To be completed overrideloopperiod:integer
To be completed overrideoutputeucurrentoutputofpid:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1226 overrideoutputpointsecondoutputofpid:char
To be completed overrideoutputpointsecondoutputofpid_l:integer
To be completed overrideoutputpointsecondoutputofpid_p:integer
To be completed overrideoutputpointsecondoutputofpid_t:integer
To be completed overrideprocessvariable:float
To be completed overrideproportionalgain:float
To be completed overrideratederivativegain:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1227 overrideresetintegralgain:float
To be completed overridescalefactor:float
To be completed overridesetpoint:float
To be completed overridesetpointeuminimumchangemaximum:float
To be completed overrideswitchmode:char
To be completed overrideswitchprocessvariable:char
To be completed overrideswitchprocessvariable_l:integer
To be completed
OpenEnterprise Schema overrideswitchprocessvariable_p:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1228
To be completed overrideswitchprocessvariable_t:integer
To be completed overrideswitchprocessvariablechangeinoutput:float
To be completed overrideswitchsetpoint:float
To be completed primaryinputpoint:char
To be completed primaryinputpoint_l:integer
To be completed primaryinputpoint_p:integer
To be completed
OpenEnterprise Schema primaryinputpoint_t:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1229
To be completed primaryintegraldeadband:float
To be completed primaryloopperiod:integer
To be completed primaryoutputeucurrentoutputofpid:float
To be completed primaryoutputoutputofpid:char
To be completed primaryoutputoutputofpid_l:integer
To be completed primaryoutputoutputofpid_p:integer
To be completed primaryoutputoutputofpid_t:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1230
To be completed primaryprocessvariable:float
To be completed primaryproportionalgain:float
To be completed primaryratederivativegain:float
To be completed primaryresetintegralgain:float
To be completed primaryscalefactor:float
To be completed primarysetpoint:float
To be completed primarysetpointeuminimumchangemaximum:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1231
To be completed primaryswitchmode:char
To be completed primaryswitchprocessvariable:char
To be completed primaryswitchprocessvariable_l:integer
To be completed primaryswitchprocessvariable_p:integer
To be completed primaryswitchprocessvariable_t:integer
To be completed primaryswitchprocessvariablechangeinoutput:float
To be completed
OpenEnterprise Schema primaryswitchsetpoint:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1232
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1233
rocstandardpowercontrolparameters
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: activetimezone:integer
To be completed discreteoutputnumber:integer
To be completed enable:integer
To be completed holdtime:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1234 lowbattery:float
To be completed offcounter:integer
To be completed offtime1:integer offtime2:integer
To be completed
To be completed offtime3:integer
To be completed oncounter:integer
To be completed ontime1:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1235 ontime2:integer
To be completed ontime3:integer
To be completed pointstatus:integer
To be completed powertimer:integer
To be completed starttime1:integer
To be completed starttime2:integer
To be completed starttime3:integer validreceive:integer
To be completed
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1236
rocstandardpulseinputs
Derived From:
Description:
To be completed
To be completed
Attributes: accumulatedvalue:integer
To be completed alarmcode:integer
To be completed alarmdeadbandrollovermaximum:float
To be completed continuousaccumulatorindustrycanadaonly:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1237
OpenEnterprise Schema conversion:float currentrate:float euunits:integer euvalue:float
To be completed
To be completed
Units designator.
To be completed filtertime:integer frequency:float
To be completed
Frequency of incoming pulses in pulses/second. highalarmeu:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1238 hihialarmeu:float lowalarmeu:float
To be completed
To be completed lowlowalarmeu:float
To be completed mode:integer
To be completed pulsesforday:integer
To be completed ratealarmeu:float rateflag:integer
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1239 rateperiod:integer
To be completed reserved1:integer
To be completed scanperiod:integer
To be completed todaystotal:float
To be completed units:char
To be completed yesterdaystotal:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1240
rocstandardreadgeneralupdate
OpenEnterprise Schema
Derived From:
Description:
RocOpcode_Table
(Standard protocol only, via Roc Opcode 0). A single entry in this table will be automatically created for each RocDevice. Additional entries can be configured, as required.
Attributes: currentalarmlogindex:integer
Current alarm log index, from the reply message (Input data offset 16) currenteventlogindex:integer
Current event log index, from the reply message (Input data offset 18) hourlyhistoryindex:integer
Current hourly history log index, from the reply message (Input data offset 20) pointtypeselection:integer
Output data offset 7
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1241
OpenEnterprise Schema
rocstandardreadpointers
Derived From:
Description:
RocRequest _Table
(Standard protocol only, via Roc Opcode 120). A single entry in this table will be automatically created for each RocDevice. No additional entries are allowed.
Attributes: currentalarmlogindex:integer
Offset 6 of the Roc response currentdayhistoryindex0:integer
Offset 18 of the Roc response (some devtypes) currentdayhistoryindex1:integer
Offset 19 of the Roc response (some devtypes)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1242
OpenEnterprise Schema currentdayhistoryindex2:integer
Offset 20 of the Roc response (some devtypes) currenteventlogindex:integer
Offset 8 of the Roc response currentperiodhistoryindex0:integer
Offset 10 of the Roc response currentperiodhistoryindex1:integer
Offset 12 of the Roc response currentperiodhistoryindex2:integer
Offset 14 of the Roc response (some devtypes) maxnumberofalarms:integer
Offset 22 of the Roc response maxnumberofevents:integer
Offset 24 of the Roc response (not RegFlo) numberofdailyhistorydays0:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1243
To be completed
OpenEnterprise Schema numberofexthistorylogs:integer
Offset 14 of the Roc response (some devtypes) numberofhistorydays0:integer
Offset 26 of the Roc response (some devtypes) numberofhistorydays1:integer
Offset 27 of the Roc response (some devtypes) numberofhistorydays2:integer
Offset 28 of the Roc response (some devtypes) numberofminutelogs:integer
Offset 30 of the Roc response
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1244
rocstandardreadsysteminformation
OpenEnterprise Schema
Derived From:
Description:
RocRequest _Table
(Standard protocol only, via Roc Opcode 103). A single entry in this table will be automatically created for each RocDevice. No additional entries are allowed.
Attributes: alarmstatus:integer
Offset 19 of the Roc response currenttime:datetime
Offset 102 of the Roc response currenttimedstoffset:integer
To be completed firmwareproducedtime:char
Offset 60 of the Roc response
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1245
OpenEnterprise Schema hardwareidentification:char
Offset 40 of the Roc response (RegFlo) lastpowerdowntime:datetime
Offset 6 of the Roc response lastpowerdowntimedstoffset:integer
To be completed lastpoweruptime:datetime
Offset 12 of the Roc response lastpoweruptimedstoffset:integer
To be completed manualstatus:integer
Offset 18 of the Roc response productidentification:char
Offset 20 of the Roc response (not RegFlo)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1246
OpenEnterprise Schema rocaddress:integer
Offset 80 of the Roc response rocgroup:integer
Offset 81 of the Roc response stationname:char
Offset 82 of the Roc response versionname:char
Offset 20 of the Roc response (RegFlo)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1247
rocstandardrevisioninformation
Derived From:
Description:
To be completed
To be completed
Attributes: devicefirmwaredescription:char
To be completed informationpresentflag:integer
To be completed partnumber:char version:char
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1248
rocstandardrunparameters
Derived From:
Description:
To be completed
To be completed
Attributes: atmosphericpressure:float
To be completed calculationmethodii:integer
To be completed cdorftm:float
To be completed conversion1:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1249
To be completed conversion10:float
To be completed conversion11:float
To be completed conversion12:float
To be completed conversion13:float
To be completed conversion14:float
To be completed conversion15:float
To be completed conversion16:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1250
To be completed conversion2:float
To be completed conversion3:float
To be completed conversion4:float
To be completed conversion5:float
To be completed conversion6:float
To be completed conversion7:float
To be completed conversion8:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1251
To be completed conversion9:float
To be completed fgrfactor:float
To be completed
To be completed fpbfactor:float fpvfactor:float
To be completed frreynoldsnumberfactoraga1985only:float
To be completed ftbfactor:float ftffactor:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1252
To be completed historypoint1:integer
To be completed historypoint10:integer
To be completed historypoint11:integer
To be completed historypoint12:integer
To be completed historypoint13:integer
To be completed historypoint14:integer
To be completed historypoint15:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1253
To be completed historypoint16:integer
To be completed historypoint2:integer
To be completed historypoint3:integer
To be completed historypoint4:integer
To be completed historypoint5:integer
To be completed historypoint6:integer
To be completed historypoint7:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1254
To be completed historypoint8:integer
To be completed historypoint9:integer
To be completed pipematerial:integer
To be completed pipereferencetemperature:float
To be completed rollup1:integer rollup10:integer rollup11:integer
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1255
To be completed rollup12:integer rollup13:integer rollup14:integer rollup15:integer rollup16:integer rollup2:integer rollup3:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1256
To be completed rollup4:integer rollup5:integer rollup6:integer rollup7:integer rollup8:integer rollup9:integer spare:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1257
To be completed spare2:integer spare_l:integer spare_p:integer spare_t:integer tlp1:char tlp10:char tlp10_l:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1258
To be completed tlp10_p:integer tlp10_t:integer tlp11:char tlp11_l:integer tlp11_p:integer tlp11_t:integer tlp12:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1259
To be completed tlp12_l:integer tlp12_p:integer tlp12_t:integer tlp13:char tlp13_l:integer tlp13_p:integer tlp13_t:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1260
To be completed tlp14:char tlp14_l:integer tlp14_p:integer tlp14_t:integer tlp15:char tlp15_l:integer tlp15_p:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1261
To be completed tlp15_t:integer tlp16:char tlp16_l:integer tlp16_p:integer tlp16_t:integer tlp1_l:integer tlp1_p:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1262
To be completed tlp1_t:integer tlp2:char tlp2_l:integer tlp2_p:integer tlp2_t:integer tlp3:char tlp3_l:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1263
To be completed tlp3_p:integer tlp3_t:integer tlp4:char tlp4_l:integer tlp4_p:integer tlp4_t:integer tlp5:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1264 tlp5_l:integer tlp5_p:integer tlp5_t:integer tlp6:char tlp6_l:integer tlp6_p:integer tlp6_t:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1265 tlp7:char tlp7_l:integer tlp7_p:integer tlp7_t:integer tlp8:char tlp8_l:integer tlp8_p:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1266 tlp8_t:integer tlp9:char tlp9_l:integer tlp9_p:integer tlp9_t:integer yorfpm:float
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1267
rocstandardsoftpointparameters
Derived From:
Description:
To be completed
To be completed
Attributes: data1:float data10:float data11:float
To be completed
To be completed
To be completed
To be completed data12:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1268 data13:float
To be completed data14:float data15:float data16:float data17:float data18:float data19:float
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1269 data2:float
To be completed data20:float data3:float data4:float data5:float data6:float data7:float
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed data8:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1270
To be completed data9:float
To be completed integerflag:integer
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1271
rocstandardsystemvariables
Derived From:
Description:
To be completed
To be completed
Attributes: activemeterruns:integer
To be completed activepids:integer
To be completed activetanks:integer
To be completed basedatabasepointshistory1:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1272 contracthour:integer
To be completed customername:char
To be completed deviceaddress:integer
To be completed devicegroup:integer
To be completed devicetype:integer
To be completed forceendofday:integer
To be completed
OpenEnterprise Schema fstinstructionspercycle:integer
FST instructions to execute per FST cycle.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1273 fstspossible:integer
To be completed manufacturingid:char
To be completed maximummeterruns:integer
To be completed maximumpids:integer
To be completed maximumtanks:integer
To be completed mpuloading:float
To be completed ram1databasepointshistory2:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1274 ram2databasepointshistory3:integer
To be completed raminstalled:integer
To be completed rominstalled:integer
To be completed romserialnumber:char
To be completed stationname:char
To be completed timecreated:char unitsflag:integer
To be completed
To be completed utilities:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1275
To be completed versionnamepartnumber:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1276
rocstandardtankparameters
Derived From:
Description:
To be completed
To be completed
Attributes: alarmcode:integer
To be completed bblsbarrelsunitsdischarged:float
To be completed contracthourlevel:float
To be completed correctedbasepulseinputpi:float
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1277 currentfluidlevel:float
To be completed lastscanlevel:float
To be completed leveldeadband:float
To be completed manualentrybblsbarrels:float
To be completed meteroutputpulseinput:char
To be completed meteroutputpulseinput_l:integer
To be completed meteroutputpulseinput_p:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1278 meteroutputpulseinput_t:integer
To be completed ratealarmeus:float
To be completed reserved1:integer
To be completed scanperiod:integer
To be completed specificgravity:float
To be completed strappingvalue:float
To be completed tanklevelinput:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1279 tanklevelinput_l:integer
To be completed tanklevelinput_p:integer
To be completed tanklevelinput_t:integer
To be completed todaysvolume:float
To be completed totalunitshauled:float
To be completed units:char
To be completed yesterdaysvolume:float
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1280
rocstandarduserdefineddatatypes
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char length:integer rocdatatype:char
To be completed
To be completed
To be completed
To be completed type:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1281
rocstandarduserlistparameters
Derived From:
Description:
To be completed
To be completed
Attributes: data1:char data10:char data10_l:integer data10_p:integer
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1282 data10_t:integer
To be completed data11:char data11_l:integer data11_p:integer data11_t:integer data12:char data12_l:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1283 data12_p:integer
To be completed data12_t:integer data13:char data13_l:integer data13_p:integer data13_t:integer data14:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1284 data14_l:integer
To be completed data14_p:integer data14_t:integer data15:char data15_l:integer data15_p:integer data15_t:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed data16:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1285
To be completed data16_l:integer data16_p:integer data16_t:integer data1_l:integer data1_p:integer data1_t:integer data2:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1286
To be completed data2_l:integer data2_p:integer data2_t:integer data3:char data3_l:integer data3_p:integer data3_t:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1287
To be completed data4:char data4_l:integer data4_p:integer data4_t:integer data5:char data5_l:integer data5_p:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1288
To be completed data5_t:integer data6:char data6_l:integer data6_p:integer data6_t:integer data7:char data7_l:integer
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1289
To be completed data7_p:integer data7_t:integer data8:char data8_l:integer data8_p:integer data8_t:integer data9:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1290
To be completed data9_l:integer data9_p:integer
To be completed
To be completed data9_t:integer scrolltime:integer
To be completed
Scroll Time in Seconds text1:char text10:char text11:char
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1291
To be completed text12:char text13:char text14:char text15:char text16:char text2:char text3:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1292
To be completed text4:char text5:char text6:char text7:char text8:char text9:char title:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1293
To be completed units1:char units10:char units11:char units12:char units13:char units14:char units15:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1294
To be completed units16:char units2:char units3:char units4:char units5:char units6:char units7:char
To be completed
To be completed
To be completed
To be completed
To be completed
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1295
To be completed units8:char units9:char
To be completed
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1296
rocstationparameters
Derived From:
Description:
To be completed
To be completed
Attributes: alarmcode:integer
To be completed
OpenEnterprise Schema alarmdeadband:float
The value that the Flow Rate Per Day (parameter #52) must be above the low alarm value (parameter #9) or below the high alarm value
(parameter #10) before the associated alarm will clear. alarming:integer
If enabled, alarms may be generated and sent to the Alarm Log. 0 =
Disabled, 1 = Enabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1297 arargon:float
Percent of gas present.
OpenEnterprise Schema atmosphericpressure:float
Amount of pressure in psi (lb/in2) or kPa that is added to the static pressure to get a gauge pressure to an absolute pressure. (() atmosphericpressureoption:integer
Indicates whether to calculate the atmospheric pressure or use the entered value. 0 = Calculate Atmospheric Pressure, 1 = Use Entered
Atmospheric Pressure. basedensity:float
Represents the density of a fluid at base conditions in lbm/ft3 or kg/m3.
(() baseorcontractpressure:float
Used to correct the standard volume flow rate to the base volume flow rate. Entered in psi (lb/in2) or kPa. (() baseorcontracttemperature:float
Used to correct the standard volume flow rate to the base volume flow rate. Entered in (F or (C. (() c10h22ndecane:float
Percent of gas present.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1298 c2h6ethane:float
Percent of gas present. c3h8propane:float
Percent of gas present. c4h10ibutane:float
Percent of gas present. c4h10nbutane:float
Percent of gas present. c5h12ipentane:float
Percent of gas present. c5h12npentane:float
Percent of gas present. c6h14nhexane:float
Percent of gas present.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1299
OpenEnterprise Schema c7h16nheptane:float
Percent of gas present. c8h18noctane:float
Percent of gas present. c9h20nnonane:float
Percent of gas present. calculationstandard:integer
Indicates what calculation standard is to be used to calculate the station’s meter runs. 0 = AGA, 1 = ISO. ch4methane:float
Percent of gas present. co2carbondioxide:float
Percent of gas present. cocarbonmonoxide:float
Percent of gas present.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1300
OpenEnterprise Schema compressibilitycalculation:integer
Indicates what to use to calculate the compressibility and supercompressibility of natural gas and other related hydrocarbons. 0 =
AGA Report #8 Detail Method, 1 = AGA Report #8 Gross Method #1, 2
= AGA Report #8 Gross Method #2. editionofcalculations:integer
Indicates what edition of the meter run calculations is to be used for the calculation. 0 = 1992. (() elevation:float
Distance from sea level in feet or meters for the station. (() energyrateperday:float
Energy rate at base conditions in mmBtu/day or GJ/day. energytoday:float
Total accumulation of energy for the current contract day in mmBtu or
GJ. energyyesterday:float
Total accumulation of energy for the previous contract day in mmBtu or
GJ.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1301
OpenEnterprise Schema flowrateperday:float
Volume flow rate at base condition in mft3/day or km3/day. flowtoday:float
Total accumulation of flow for the current contract day in mft3 or km3. flowyesterday:float
Total accumulation of flow for the previous contract day in mft3 or km3. gasquality:integer
Indicates if the gas quality for the station will be live or constant. 0 =
Constant Gas Quality, 1 = Live Gas Quality gravityoption:integer
Indicates whether to calculate the gravity or use the entered value. 0 =
Calculate Gravity, 1 = Use Entered Gravity. h2hydrogen:float
Percent of gas present. h2owater:float
Percent of gas present.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1302 h2shydrogensulfide:float
Percent of gas present.
OpenEnterprise Schema heatingvalue:float
Gas property indicating how much energy it takes to heat the gas based upon a per-unit mass or volume basis. For English units, either Btu/lbm or Btu/ft3 are used and for Metric units, either MJ/kg or MJ/m3. (() heatingvaluetype:integer
Indicates what the type of calculated or entered Heating Value is. 0 =
Dry, 1 = Wet, 2 = As Delivered. heavygasc10h22ndecane:float
Percent of decane believed to be present in the composite heavy gas. heavygasc6h14nhexane:float
Percent of hexane believed to be present in the composite heavy gas. heavygasc7h16nheptane:float
Percent of heptane believed to be present in the composite heavy gas. heavygasc8h18noctane:float
Percent of octane believed to be present in the composite heavy gas.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1303
OpenEnterprise Schema heavygasc9h20nnonane:float
Percent of nonane believed to be present in the composite heavy gas. heavygasoption:integer
Indicates whether to separate Heavy Gas Percent (C6+) (parameter
#46) into individual components in the percentages configured in parameters #47-51 and write to gas components hexane and heavier
(parameters #34-38). 0 = C6+ not used, 1 = C6+ used. heavygaspercentc6:float
Percent of gas that is a composite of hydrocarbons hexane and heavier.
Values for C6+ should be written to this parameter. hehelium:float
Percent of gas present. highalarmflow:float
Alarm value for High Alarm in mft3/day or km3/day. historysegment:integer
The history segment that the station will use for storing history. 0 = No history stored, 1 ( 10 = history segment to be used. latitude:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1304
Latitude of station in degrees. (()
OpenEnterprise Schema localgravitationalacceleration:float
Local value of gravity at the station in ft/sec2 or m/sec2. (() lowalarmflow:float
Alarm value for Low Alarm in mft3/day or km3/day. massrateperday:float
To be completed masstoday:float
Total accumulation of mass since the last contract hour in mlb or tonnes. massyesterday:float
Total accumulation of mass for the previous contract day in mlb or tonnes. n2nitrogen:float
Percent of gas present. normalizationtype:integer
Indicates if the gas composition is adjusted to 100% by modifying the
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1305
OpenEnterprise Schema methane or using normalization. 0 = Methane Adjust, 1 = Normalize
Gas o2oxygen:float
Percent of gas present. specificgravitygr:float
Real gas relative density. (() srbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled. srbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled. units:integer
Indicates what engineering units the process variables, inputs, and calculation should be. 0 = English Units, 1 = Metric Units.
Represents the compressibility at base conditions. (~) zb:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1306 zs:float
OpenEnterprise Schema
Represents the compressibility at standard conditions. (~)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1307
rocstationparameters
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: alarmcode:integer
To be completed alarmdeadband:float
The value that the Flow Rate Per Day (parameter #52) must be above the low alarm value (parameter #9) or below the high alarm value
(parameter #10) before the associated alarm will clear. alarming:integer arargon:float
If enabled, alarms may be generated and sent to the Alarm Log. 0 =
Disabled, 1 = Enabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1308
Percent of gas present.
OpenEnterprise Schema atmosphericpressure:float
Amount of pressure in psi (lb/in2) or kPa that is added to the static pressure to get a gauge pressure to an absolute pressure. (() atmosphericpressureoption:integer
Indicates whether to calculate the atmospheric pressure or use the entered value. 0 = Calculate Atmospheric Pressure, 1 = Use Entered
Atmospheric Pressure. basedensity:float
Represents the density of a fluid at base conditions in lbm/ft3 or kg/m3.
(() baseorcontractpressure:float
Used to correct the standard volume flow rate to the base volume flow rate. Entered in psi (lb/in2) or kPa. (() baseorcontracttemperature:float
Used to correct the standard volume flow rate to the base volume flow rate. Entered in (F or (C. (() c10h22ndecane:float
Percent of gas present.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1309 c2h6ethane:float
Percent of gas present. c3h8propane:float
Percent of gas present. c4h10ibutane:float
Percent of gas present. c4h10nbutane:float
Percent of gas present. c5h12ipentane:float
Percent of gas present. c5h12npentane:float
Percent of gas present. c6h14nhexane:float
Percent of gas present.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1310
OpenEnterprise Schema c7h16nheptane:float
Percent of gas present. c8h18noctane:float
Percent of gas present. c9h20nnonane:float
Percent of gas present. calculationstandard:integer
Indicates what calculation standard is to be used to calculate the station’s meter runs. 0 = AGA, 1 = ISO. ch4methane:float
Percent of gas present. co2carbondioxide:float
Percent of gas present. cocarbonmonoxide:float
Percent of gas present.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1311
OpenEnterprise Schema compressibilitycalculation:integer
Indicates what to use to calculate the compressibility and supercompressibility of natural gas and other related hydrocarbons. 0 =
AGA Report #8 Detail Method, 1 = AGA Report #8 Gross Method #1, 2
= AGA Report #8 Gross Method #2. editionofcalculations:integer
Indicates what edition of the meter run calculations is to be used for the calculation. 0 = 1992. (() elevation:float
Distance from sea level in feet or meters for the station. (() energyrateperday:float
Energy rate at base conditions in mmBtu/day or GJ/day. energytoday:float
Total accumulation of energy for the current contract day in mmBtu or
GJ. energyyesterday:float
Total accumulation of energy for the previous contract day in mmBtu or
GJ.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1312
OpenEnterprise Schema flowrateperday:float
Volume flow rate at base condition in mft3/day or km3/day. flowtoday:float
Total accumulation of flow for the current contract day in mft3 or km3. flowyesterday:float
Total accumulation of flow for the previous contract day in mft3 or km3. gasquality:integer
Indicates if the gas quality for the station will be live or constant. 0 =
Constant Gas Quality, 1 = Live Gas Quality gravityoption:integer
Indicates whether to calculate the gravity or use the entered value. 0 =
Calculate Gravity, 1 = Use Entered Gravity. h2hydrogen:float
Percent of gas present. h2owater:float
Percent of gas present.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1313 h2shydrogensulfide:float
Percent of gas present.
OpenEnterprise Schema heatingvalue:float
Gas property indicating how much energy it takes to heat the gas based upon a per-unit mass or volume basis. For English units, either Btu/lbm or Btu/ft3 are used and for Metric units, either MJ/kg or MJ/m3. (() heatingvaluetype:integer
Indicates what the type of calculated or entered Heating Value is. 0 =
Dry, 1 = Wet, 2 = As Delivered. heavygasc10h22ndecane:float
Percent of decane believed to be present in the composite heavy gas. heavygasc6h14nhexane:float
Percent of hexane believed to be present in the composite heavy gas. heavygasc7h16nheptane:float
Percent of heptane believed to be present in the composite heavy gas. heavygasc8h18noctane:float
Percent of octane believed to be present in the composite heavy gas.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1314
OpenEnterprise Schema heavygasc9h20nnonane:float
Percent of nonane believed to be present in the composite heavy gas. heavygasoption:integer
Indicates whether to separate Heavy Gas Percent (C6+) (parameter
#46) into individual components in the percentages configured in parameters #47-51 and write to gas components hexane and heavier
(parameters #34-38). 0 = C6+ not used, 1 = C6+ used. heavygaspercentc6:float
Percent of gas that is a composite of hydrocarbons hexane and heavier.
Values for C6+ should be written to this parameter. hehelium:float
Percent of gas present. highalarmflow:float
Alarm value for High Alarm in mft3/day or km3/day. historysegment:integer
The history segment that the station will use for storing history. 0 = No history stored, 1 ( 10 = history segment to be used. latitude:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1315
Latitude of station in degrees. (()
OpenEnterprise Schema localgravitationalacceleration:float
Local value of gravity at the station in ft/sec2 or m/sec2. (() lowalarmflow:float
Alarm value for Low Alarm in mft3/day or km3/day. massrateperday:float
To be completed masstoday:float
Total accumulation of mass since the last contract hour in mlb or tonnes. massyesterday:float
Total accumulation of mass for the previous contract day in mlb or tonnes. n2nitrogen:float
Percent of gas present. normalizationtype:integer
Indicates if the gas composition is adjusted to 100% by modifying the
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1316
OpenEnterprise Schema methane or using normalization. 0 = Methane Adjust, 1 = Normalize
Gas o2oxygen:float
Percent of gas present. specificgravitygr:float
Real gas relative density. (() srbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled. srbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled. units:integer
Indicates what engineering units the process variables, inputs, and calculation should be. 0 = English Units, 1 = Metric Units.
Represents the compressibility at base conditions. (~) zb:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1317 zs:float
OpenEnterprise Schema
Represents the compressibility at standard conditions. (~)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1318
rocstring
OpenEnterprise Schema
Derived From:
Description:
StringSignal_table
Each entry represents a Value Parameter (specified TLP format) of a Roc
Point. These entries are required (in addition to the Roc Point) for
OpenEnterprise Reports, Historical logging and Calculations.
Attributes: deviceid:char
The DeviceId field of the device nameoverride:bool
To be completed parameternumber:integer
Roc ParameterNumber pointinalarm:bool
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1319
OpenEnterprise Schema
Indicates if the RocPoint is in alarm. pointnumber:integer
Roc PointNumber pointtype:integer
Roc PointType pushvalue:bool
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1320
rocsystemparameters
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char name:char value:char
To be completed
To be completed
To be completed
To be completed valuetype:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1321
rocsystemparametersaccessarea
Derived From:
Description:
To be completed
To be completed
Attributes: accessareaconfig:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1322
rocsystemparametersalarmpriority
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: alarmpriority:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1323
rocsystemparametersbool
Derived From:
Description:
To be completed
To be completed
Attributes: boolvalue:bool
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1324
rocsystemparametersdriver
Derived From:
Description:
To be completed
To be completed
Attributes: rocdriver:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1325
rocsystemparametersinteger
Derived From:
Description:
To be completed
To be completed
Attributes: integervalue:integer
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1326
rocsystemparametersplantarea
Derived From:
Description:
To be completed
To be completed
Attributes: plantarea:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1327
OpenEnterprise Schema
rocsystemparametersportparameters
Derived From:
Description:
To be completed
To be completed
Attributes: rocportparameters:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1328
rocsystemparametersschedule
Derived From:
Description:
To be completed
To be completed
Attributes: rocschedule:char
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1329
rocsystemparametersstring
Derived From:
Description:
Attributes:
No attributes extend this table.
To be completed
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1330
roctime
OpenEnterprise Schema
Derived From: Time_table
Description: Each entry represents a Value Parameter (specified TLP format) of a Roc
Point. These entries are required (in addition to the Roc Point) for
OpenEnterprise Reports, Historical logging and Calculations.
Attributes: deviceid:char
The DeviceId field of the device nameoverride:bool
To be completed parameternumber:integer
Roc ParameterNumber pointinalarm:bool
Indicates if the RocPoint is in alarm.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1331 pointnumber:integer
Roc PointNumber pointtype:integer
Roc PointType pushvalue:bool
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1332
rocturbinemeterrunconfiguration
Derived From:
Description:
To be completed
To be completed
Attributes: alarmcode:integer
To be completed
OpenEnterprise Schema alarmdeadband:float
The value that the Flow Rate Per Day (Point Type 116, parameter #0) must be above the low alarm value (parameter #7) or below the high alarm value (parameter #8) before the associated alarm will clear. alarming:integer
If enabled, alarms may be generated and sent to the Alarm Log. 0 =
Disabled, 1 = Enabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1333
OpenEnterprise Schema calibrationpressure:float
Pressure mass meter was calibrated at in PSIA or kPa. This parameter is only applicable when mass has been selected for the Meter Input
Type (parameter #49) and the Mass Pressure Compensation Option
(parameter #50) or Density Pressure Compensation Option (parameter
#51) has been enabled. calibrationweightsgravitationalacceleration:float
Used to calculate Fpwl(static). Entered in ft/sec2 or m/sec2. (@) highalarmflow:float
Alarm value for High Alarm in mft3/day or km3/day. kfactor1:float kfactor10:float
This is the linear meter constant (K-Factor) in pulses/ft3 or pulses/m3 for the associated frequency in Hz (parameter #26).
This is the linear meter constant (K-Factor) in pulses/ft3 or pulses/m3 for the associated frequency in Hz (parameter #44). kfactor10frequency:float
Frequency in Hz that corresponds with K-Factor 1 (parameter #43). kfactor11:float
This is the linear meter constant (K-Factor) in pulses/ft3 or pulses/m3 for
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1334
OpenEnterprise Schema the associated frequency in Hz (parameter #46). kfactor11frequency:float
Frequency in Hz that corresponds with K-Factor 1 (parameter #45). kfactor12:float
This is the linear meter constant (K-Factor) in pulses/ft3 or pulses/m3 for the associated frequency in Hz (parameter #48). kfactor12frequency:float
Frequency in Hz that corresponds with K-Factor 1 (parameter #47). kfactor1frequency:float
Frequency in Hz that corresponds with K-Factor 1 (parameter #25). kfactor2:float
This is the linear meter constant (K-Factor) in pulses/ft3 or pulses/m3 for the associated frequency in Hz (parameter #28). kfactor2frequency:float
Frequency in Hz that corresponds with K-Factor 1 (parameter #27). kfactor3:float
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1335
OpenEnterprise Schema
This is the linear meter constant (K-Factor) in pulses/ft3 or pulses/m3 for the associated frequency in Hz (parameter #30). kfactor3frequency:float
Frequency in Hz that corresponds with K-Factor 1 (parameter #29). kfactor4:float
This is the linear meter constant (K-Factor) in pulses/ft3 or pulses/m3 for the associated frequency in Hz (parameter #32). kfactor4frequency:float
Frequency in Hz that corresponds with K-Factor 1 (parameter #31). kfactor5:float
This is the linear meter constant (K-Factor) in pulses/ft3 or pulses/m3 for the associated frequency in Hz (parameter #34). kfactor5frequency:float
Frequency in Hz that corresponds with K-Factor 1 (parameter #33). kfactor6:float
This is the linear meter constant (K-Factor) in pulses/ft3 or pulses/m3 for the associated frequency in Hz (parameter #36).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1336
OpenEnterprise Schema kfactor6frequency:float
Frequency in Hz that corresponds with K-Factor 1 (parameter #35). kfactor7:float
This is the linear meter constant (K-Factor) in pulses/ft3 or pulses/m3 for the associated frequency in Hz (parameter #38). kfactor7frequency:float
Frequency in Hz that corresponds with K-Factor 1 (parameter #37). kfactor8:float
This is the linear meter constant (K-Factor) in pulses/ft3 or pulses/m3 for the associated frequency in Hz (parameter #40). kfactor8frequency:float
Frequency in Hz that corresponds with K-Factor 1 (parameter #39). kfactor9:float
This is the linear meter constant (K-Factor) in pulses/ft3 or pulses/m3 for the associated frequency in Hz (parameter #42). kfactor9frequency:float
Frequency in Hz that corresponds with K-Factor 1 (parameter #41).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1337
OpenEnterprise Schema kfactoroption:integer
To be completed lowalarmflow:float
Alarm value for Low Alarm in mft3/day or km3/day. lowflowcutoff:float
This is the cutoff point for the uncorrected flow rate if it is not obtained from a pulse input. If the uncorrected flow rate input is equal to or below this value, the uncorrected flow rate value (parameter #14) will be set to zero. If the uncorrected flow rate is obtained from a pulse input, all pulses are considered flow and this value is meaningless. masspressurecompensation:integer
Indicates whether the mass input requires compensation for pressure effect on the Coriolis tube. This parameter is only applicable when mass has been selected for the Meter Input Type (parameter #49). 0 = Mass pressure compensation disabled, 1 = Mass pressure compensation enabled. meterinputtype:integer
To be completed noflowtime:integer
Amount of time in seconds without a pulse before the meter is considered not to have flow.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1338
OpenEnterprise Schema pointdescription:char
Description for specific Meter Run. Values must be printable ASCII characters. pressureeffectmasscompensationcoefficient:float
Pressure correction coefficient for mass in percent per psi or percent per bar. This value is supplied by the manufacturer for the given model mass meter. This parameter is only applicable when mass has been selected for the Meter Input Type (parameter #49) and the Mass
Pressure Compensation Option (parameter #50) has been enabled. speedofsoundoption:integer
Indicates the status of the speed of sound calculation. If enabled, the calculated value of the speed of sound is stored in point type116, parameter 33. 0 = Disabled, 1 = Enabled. spstaticpressurepf:float
Static pressure in psi (lb/in2) or kPa. (()(() sptlp:char sptlp_l:integer
Indicates what is being used to get the SP (parameter #15).
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1339 sptlp_p:integer
To be completed
OpenEnterprise Schema sptlp_t:integer
To be completed srbxonclear:integer
Indicates a SRBX alarm is desired if an alarm condition clears. 0 =
SRBX on Clear Disabled, 1 = SRBX on Clear Enabled. srbxonset:integer
Indicates a SRBX alarm is desired if an alarm condition occurs. 0 =
SRBX on Set Disabled, 1 = SRBX on Set Enabled. statickfactor:float
This is the linear meter constant (K-Factor) in pulses/ft3 or pulses/m3. (() staticpressuredeadweightcalibrator:integer
Expand the volume flow equation to include the local gravitational correction for the deadweight calibrator on Static Pressure (Fpwl(static)).
0 = Do Not Use, 1 = Use. (@) staticpressureunits:integer
Indicates whether the static pressure is in gauge or absolute pressure units. 0 = Gauge, 1 = Absolute.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1340
OpenEnterprise Schema stationnumber:integer
Indicates what station meter run is a part of. tmptemperaturetf:float
Temperature in (F or (C. (()(() tmptlp:char tmptlp_l:integer
Indicates what is being used to get the TMP (parameter #17).
To be completed tmptlp_p:integer tmptlp_t:integer
To be completed
To be completed uncorrectedflowrate:float
This is the uncorrected flow rate in mft3/day or km3/day. (()(()
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1341
OpenEnterprise Schema uncorrectedflowratetlp:char
This indicates what is being used to get the pulses from the turbine and the Uncorrected Flow Rate (parameter #13). uncorrectedflowratetlp_l:integer
To be completed uncorrectedflowratetlp_p:integer
To be completed uncorrectedflowratetlp_t:integer
To be completed usercorrectionfactor:float
Variable multiplied through the volume flow equation to allow the user to modify the flow (Fuc).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1342
rocturbinemeterrunvalues
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: calculatedspeedofsound:float
Speed of Sound calculated per AGA10 in feet/second or meters/second.
Value will only be written if the speed of sound calculation is enabled in point type 115, parameter 23. compressibilitymultiplier:float
Represents the compressibility factor. (()(() density:float
Represents the density of a fluid at flowing conditions in lbm/ft3 or kg/m3. (() energyaccumulated:float
Total accumulation of energy for the meter run in mmBtu or GJ. The
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1343
OpenEnterprise Schema
1,000,000.0 rollover is to ensure that energy accuracy is not lost due to the significant digits of a float data type. energymonth:float
Total accumulation of energy for the current month in mmBtu or GJ. energyprevmonth:float
Total accumulation of energy for the previous month in mmBtu or GJ. energyrateperday:float
Energy rate at base conditions in mmBtu/day or GJ/day. energyrateperhour:float
Energy rate at base conditions in Btu/hour or MJ/hour. energytoday:float
Total accumulation of energy for the current contract day in mmBtu or
GJ. energyyesterday:float
Total accumulation of energy for the previous contract day in mmBtu or
GJ.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1344
OpenEnterprise Schema flowaccumulated:float
Total accumulation of flow for the meter run in mft3 or km3. The
1,000,000.0 rollover is to ensure that flow accuracy is not lost due to the significant digits of a float data type. flowmonth:float
Total accumulation of flow for the current month in mft3 or km3. flowprevmonth:float
Total accumulation of flow for the previous month in mft3 or km3. flowrateperday:float
To be completed flowrateperhour:float
Volume flow rate at base conditions in ft3/hour or m3/hour. (() flowtoday:float
Total accumulation of flow for the current contract day in mft3 or km3. flowyesterday:float
Total accumulation of flow for the previous contract day in mft3 or km3.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1345 fpwl:float
OpenEnterprise Schema
Represents the local gravitational correction for the deadweight tester static pressure standard. (@) massaccumulated:float
Total accumulation of mass for the meter run in mlb or tonnes. The
1,000,000.0 rollover is to ensure that accuracy is not lost due to the significant digits of a float data type. massmonth:float
Total accumulation of mass for the current month in mlb or tonnes. masspreviousmonth:float
Total accumulation of mass for the previous month in mlb or tonnes. massrateperday:float
To be completed massrateperhour:float
Mass flow rate in lb/hr or kg/hr. masstoday:float
Total accumulation of mass since the last contract hour in mlb or tonnes.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1346
OpenEnterprise Schema massyesterday:float
Total accumulation of mass for the previous contract day in mlb or tonnes. measuredspeedofsound:float
To be completed minutesaccumulated:float
Total accumulation of flowing minutes for the meter run. The
1,000,000.0 rollover is to ensure that flow minutes accuracy is not lost due to the significant digits of a float data type. minutesmonth:float
Total accumulation of flowing minutes for the current month. minutesprevmonth:float
Total accumulation of flowing minutes for the previous month. minutestoday:float
Total accumulation of flowing minutes for the current contract day. minutesyesterday:float
Total accumulation of flowing minutes for the previous contract day.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1347
OpenEnterprise Schema multipliervalue:float
Represents the product of the pressure multiplier, the temperature multiplier and the compressibility multiplier. pressuremultiplier:float
Represents the pressure factor. (()(() pulsesaccumulated:integer
Represents the number of pulses for this meter run today. Not used if uncorrected flow rate is not configured for a pulse input point. temperaturemultiplier:float
Represents the flowing temperature factor. (()(() uncorrectedaccumulated:float
Total accumulation of uncorrected flow for the meter run in mft3 or km3.
The 1,000,000.0 rollover is to ensure that uncorrected flow accuracy is not lost due to the significant digits of a float data type. uncorrectedmonth:float
Total accumulation of uncorrected flow for the current month in mft3 or km3.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1348
OpenEnterprise Schema uncorrectedprevmonth:float
Total accumulation of uncorrected flow for the previous month in mft3 or km3. uncorrectedtoday:float
Total accumulation of uncorrected flow for the current contract day in mft3 or km3. uncorrectedyesterday:float
Total accumulation of uncorrected flow for the previous contract day in mft3 or km3. zf1:float
Represents the compressibility at upstream flowing conditions. (~)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1349
roctypes
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char
To be completed logonsendpasswordversion:float
To be completed opcode0type:integer
To be completed opcode120type:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1350 opcode130type:integer
To be completed opcode6type:integer
To be completed protocoltype:char
To be completed rocdescription:char
To be completed rocextratype:char
To be completed rocopcode6type:integer
To be completed roctypeid:integer
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1351
OpenEnterprise Schema
rocusercconfiguration
Derived From:
Description:
To be completed
To be completed
Attributes: programautorestartcounter:integer
If the program commits an illegal instruction while running, the program will be killed and restarted. If this occurs, this parameter will be incremented. programclear:integer
Clear the User C++ program from memory. If program is currently running, it will remain running. Only the disk space will be cleared.
0 = No clear program
1 = Clear program programdescription:char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1352
To be completed
OpenEnterprise Schema programdiskspaceused:integer
The amount of flash disk space the program occupies. programdramused:integer
The amount of RAM space the program consumes. programenable:integer
Enables User C++ Program.
0 = Stop Program
1 = Start Program programentrypoint:integer
Program entry point in memory, used internally for debugging. programhandle:integer
Program handle, used internally for debugging. programlibraryversion:char
The library version the program was linked with.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1353
OpenEnterprise Schema programstatus:integer
The status of the program
0x00 = Program empty
0x01 = Program loaded
0x02 = Program running
0x03 = Library version error
0x8X = If the most significant bit is set, an internal error resulted programtimedatestamp:datetime
The time and date stamp the User C++ program was created (number of seconds since Jan. 1, 1970) programtimedatestampdstoffset:integer
To be completed programversionstring:char
The version string for the User C++ program.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1354
rocuserdefinedpoint
Derived From:
Description:
Attributes:
No attributes extend this table.
To be completed
To be completed
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1355
rocuserprogramconfiguration
OpenEnterprise Schema
Derived From:
Description:
To be completed
To be completed
Attributes: hostdramfree:integer
The amount of DRAM available for User C++ Programs. hostdramused:integer
The amount of DRAM consumed by User C++ Programs. hostlibraryversion:char
To be completed hostsramfree:integer
The amount of SRAM available for User Defined Points.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1356
OpenEnterprise Schema hostsramused:integer
The amount of SRAM consumed by User Defined Points.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1357
rocversion
Derived From:
Description:
To be completed
To be completed
Attributes: accessarea:char roctypeid:integer
To be completed
To be completed rocversionid:integer
To be completed version:char
To be completed
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema
Reference Guide
D301521X412
24-Feb-2010 - Page 1358
rocwriteclock
OpenEnterprise Schema
Derived From:
Description:
Attributes:
No attributes extend this table.
To be completed
Used by the Roc RDI to write the current time to the Roc device. A single entry in this table will be automatically created for each RocDevice. No additional entries are allowed.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1359
routine
OpenEnterprise Schema
Derived From:
Description: objects
Defines Routines which govern how Alarm messages will be processed by the Paging Server
Attributes: absolutedisabled : bool
If set to TRUE, disables this Routine. alarmactiongroup:char
References alarmresponseactiongroup alarmpatterngroup:char
References patterngroup newactiondisabled:bool
If set to TRUE, any new action for this Routine is disabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1360
OpenEnterprise Schema
runsqlscript
Derived From:
Description: objects
The RunSqlScript table is used to execute an Sql statement on demand.
Typically, it will be initiated by a custom OEMenus pick action added to a
GraphWorX display.
As part of the database build, a single object is created in this table: insert into RunSqlScript_table (name) values ‘RunSqlScript1’);.
All custom pick actions will be configured to update this single object.
Attributes: disable : bool default FALSE
When set to TRUE, disables the SQLScript. Default value is FALSE. errortext : char
Any errors that occur will be recorded here.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1361
OpenEnterprise Schema journalupdate : bool
If set to TRUE then journal messages will be generated to indicate that an attempt is being made to execute the script, and then to indicate whether the script was executed successfully or not. lastruntime: datetime
The last time that an SQL script was run. lastsqlscript : char
Contains the last SQL script that was run. sqlscript : char
The SQL statement to be executed. When its value changes, the SQL statement will be executed. Can contain one or more DML statements.
Multiple DML statements must be separated by semi-colons. status : integer default 0
A value of 1 indicates that an SQL script is being run. It is recommended that any buttons that use the SqlScript table be disabled when status is
1.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1362
runsqlscripterroralarmcondition
OpenEnterprise Schema
Derived From: alarmcondition
Description: An alarm is generated from an object in this table if the errortext attribute for an object in the RunSQLScript table contains a non-Null value. There will normally be only one object in the table.
Attributes: name : char References RunSQLScript table not Null
Contains a reference to the SQLScript object from the RunSQLScript table.
The default name is 'RunSQLScript1'.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1363
runtimeexception
Derived From:
Description:
OpenEnterprise Schema exception
This class deals with run-time exceptions in the database. It contains an integer value, relating to the error, and a description of the error.
Attributes: text : char
This string describes the exception that has occurred.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1364
scheduleevents
OpenEnterprise Schema
Derived From:
Description:
The events used by a scheduler pattern to define a trigger, control curve or on/off pattern.
<Base Table>
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. assocschedule : char references SchedulePattern
The name of the pattern that this event is part of. This is a foreign key reference to the schedulepattern table. eventat : integer
The number of seconds from the start of the pattern to this event.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1365 id : integer
OpenEnterprise Schema
This unique id of this object. This Auto-ID attribute is the primary key for this table. value : float
The value associated with this event, for a trigger the value will always be ignored. For control curves and on/off schedules the value will be set in the target attribute of the target object. Valid values for on/off schedules are 0 and 1.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1366
schedulepattern
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
The overview item for scheduler patterns. The pattern events are described in the scheduleevents table.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. currentlocker : char
Override user name that allows a locked object to be unlocked. locked : bool locker : char
This attribute will be set to true if any of the configuration tools are currently editing this object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1367
OpenEnterprise Schema
The name of the user who is currently editing this object. maxscale : integer
See minscale. minscale : integer
The minimum scale to be shown by the configuration tool when displaying this pattern. Together with the maxscale attribute this attribute describes the range of the y-axis in the configuration tool. patterntype : integer
The type of pattern attached to this diary.
0 = None.
1 = Trigger.
2 = Control curve.
3 = On/Off pattern.
All other values are invalid. schedulename : char
The unique name of this pattern. scheduleperiod : integer
The length of time in seconds that this pattern covers
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1368
schemahelp
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
The SchemaHelp table enables OpenEnterprise to manage Schema help.
When no help topic is available for a table, it is not included in this table. If this is the case, when a user selects the table from the Dabase Explorer and selects the Help option on the context menu, OpenEnterprise is able to display a clear message explaining that no help exists for the selected table or attribute. It also enables project schema help files to be used by creating entries in this table naming the new tables and their attributes, together with the name of the project help file.
Attributes: attributes : char context : char
A CSV list of the attributes of the table that have corresponding entries in the help file.
The name of the help topic that covers the table. This is used because the OpenEnterprise Schema help file ignores both views and the '_table' extension on table names to improve readability and simplify presentation. description : char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1369
OpenEnterprise Schema
Included for future use. Currently has no value. filename : char tablename : char Primary Key
The name of the table for which there exists a help topic in the
OpenEnterprise Schema help file.
The help file name to call when this table is selected and the Help context menu is invoked within Database Explorer. This enables project specific help files to be created and used by creating an entry for each of the project specific tables in the SchemaHelp table, with the name of the project help file here.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1370
securityreplication
OpenEnterprise Schema
Derived From: <Base Table>
Description: This table provides the OpenEnterprise Replication component
(OEReplication.exe) with information that enables it to synchronize security configuration on OpenEnterprise Servers over an IP network.
Attributes: copyaccessarea : Bool default TRUE
Indicates whether the contents of the AccessAreaConfig, and
AccessArea tables should be replicated to the target database. copyaccessprivileges : Bool default TRUE
Indicates whether any changes in access privileges will be applied to the target database. copytoken : Bool default TRUE
Indicates whether information in the Token, TokenAccess, TokenGroup and TokenGroupAccess tables should be replicated to the target database.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1371
OpenEnterprise Schema copyusers : Bool default TRUE
Indicates whether User and security group information should be replicated to the target database. If the CopyUsers attribute is set to
FALSE then this also automatically prevents replication of access area, tokens and access privileges. This is because all of these are dependent in some way upon the list of users and groups being consistent in the source and target databases. dataservice : char Primary Key
The data service to which the security configuration information is to be replicated. deletetargetaccessareas : Bool default FALSE
If additional access area configuration exists in the target database then this attribute is used to indicate if that additional configuration should be deleted. This will apply to records in the AccessAreaConfig and the
AccessArea tables. deletetargettokens : Bool default FALSE
If additional token configuration exists in the target database, then this attribute can be used to indicate that the additional configuration should be deleted. This applies to records in the token, tokengroup, tokenaccess and tokengroupaccess tables. deletetargetusers : Bool default FALSE
If extra users, (or groups) exist in the target database, then this attribute can be used to dictate whether those additional users are deleted by the
OE Replication Component
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1372
selfusernotes
OpenEnterprise Schema
Derived From:
Description: usernotes
This table shows all of the user notes that are addressed to the currently logged on user and have also been sent by the current user. Therefore, this is always a subset of the usernotes table.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. acknowledged : bool default TRUE
If this value is FALSE, the object is in a state of not being acknowledged. addtodataset : char
Reserved for internal use.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1373 alarminhibit : bool
OpenEnterprise Schema
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. alarmpriority : integer
This is the alarm priority of an alarmed note. alarmtime : datetime
This is the time at which an alarm will be generated in the
AlarmSummary corresponding to this note. alarmtimedstoffset : 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. 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. calloutarea : char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1374
OpenEnterprise Schema
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 default TRUE
If this value is FALSE, the object has not been cleared from the alarmsummary table. createtime : datetime
This is the date and time at which this note was created. createtimedstoffset : 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. currentalarmprecedence : integer default -1
This attribute takes the highest precedence from the current set of alarms associated with this object. If no alarms are active, the attribute is set to 1. currentdstoffset : integer
This attribute is used to describe the number of minute that should be
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1375
OpenEnterprise Schema adjusted in the date time in order to cater for local Daylight Saving Time. currentlocker : char
Override user name that allows a locked object to be unlocked. dataset : char
This is a misnamed attribute that, in fact, contains a list of id values from the logcontrol table. The list is, actually, a set of streams. These are required in order to implement stream management. The list of streams controls which historical streams this object is enabled with. Those streams not listed in the string will have this signal object disabled.
When this attribute is set, the old list of logcontrol references are disabled. These are contained in the lastdataset attribute. Then the new lists references are enabled (stored in dataset). And finally, the dataset attribute is copied to the lastdataset attribute. description : char
The description field should be used to meaningfully describe the purpose of this object. display : char
This is the name of a display that is associated with this object in the objects table. dstoffset : integer
This is the daylight saving time offset, in minutes, applicable to the timestamp attribute value.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1376
OpenEnterprise Schema emergencyprocedures : char
This is a description of what procedures should be carried out to resolve a problem on the system. This is associated with alarm notes. expirytime : datetime
This is the time when the note will automatically be removed. This is relevant for the Expiry notes and Alarm notes. expirytimedstoffset : 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. hasnotes : bool default FALSE
Determines whether notes are supported by this object. lastdataset : char
This is a misnamed attribute that, in fact, contains a list of id values from the logcontrol table. The list is, actually, a set of historical streams.
These are required in order to implement stream management. The list of streams controls which historical streams this signal is enabled with.
When this attribute is set, the old list of logcontrol references are disabled. These are contained in the lastdataset attribute. Then the new list are enabled (stored in dataset). And finally, the dataset attribute is copied to the lastdataset attribute lastnotetype : integer8
This is a reserved attribute. Do not use.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1377 locked : bool locker : char message : char name : char nextid : integer notesdiary : char
OpenEnterprise Schema
This attribute will be set to true if any of the configuration tools are currently editing this object.
The name of the user who is currently editing this object.
This is the message that is to be conveyed.
The name of the object. The name attribute is the primary key of the table.
This is an internal value used to automatically generate a primary key value for new notes objects.
For either an Alarmed Note or an Expiry Note, a diary entry is generated in order to deal with the timing of when the alarm should be generated or when the note should be removed (expired).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1378
OpenEnterprise Schema notetype : integer8
The notetype attribute will describe whether the note is a standard note an expiry note or an alarm note. occurrencetime : datetime
This is the date and time at which an alarm was generated upon this object. occurrencetimedstoffset : 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. operator : char
The operator who performed the last database transaction on this object. personnel : char plantarea: char printer : char
This is a string describing the people that this message is relevant to.
This attribute will usually be used to describe the physical location of whatever the derived class references.
This is the name of the printer to which the alarms associated with this object will be printed to.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1379
OpenEnterprise Schema questionable : integer
Details if the data associated with the object is questionable. recipient : char
This is the name of the person who will receive this note. 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. sender : char
This is the name of the person who sent this note. subject : char
This is the subject of the note that should briefly summarise the contents of the note. suppress : bool suppressed : bool Default FALSE
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1380
OpenEnterprise Schema
An indication that one or more of the object's alarm conditions is currently suppressed. Read only. suppressiongroup : integer
This is an integer reference to the suppression group table. timezone : char
The timezone refers to an entry in the timezones table. Using this allows the logging of time values across time zones. tobescheduled : array of ToBeScheduled
This is an array of references to the ToBeScheduled table. They are used in conjunction with the notesdiary attribute.to connect this note object with the scheduling system. totalalarmednotes : integer
This is the total number of notes that are of type alarm. An alarm note will be given a time period, during which it is just a standard note. When this time runs out, it generates an alarm and still remains a note. totalallnotes : integer
This is the total number of notes on the system. totalexpirynotes : integer
This is the number of notes on the system that are of type expiry. These will be removed from the system after a stipulated period of time.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1381
OpenEnterprise Schema totalnotes : integer default 0
If the object supports notes this will describe the number of notes associated with the object. totalstandardnotes : integer
This is the total number of notes on the system that are of type standard.
They have to be manually deleted from the system. triggeralarm : bool
Setting this value to TRUE causes an alarm to be generated for the note, if notetype is of type expiry. triggerexpiry : bool
Setting this value to TRUE causes the timer associated with the note to expire. A subsequent action will depend upon how the alarm is generated. type : integer8 unread : bool
The type is, currently, one of three types. It can be either user notes signal notes or object notes.
If this value is true, then the note has not been read by anybody on the system. The Notes Client application will set this to false when it deems that a user has read a note.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1382
OpenEnterprise Schema userref : char worktype : char
This is a foreign key reference to a users object. worklocation : char
This is a description of the area this note is associated with. workstation : char
The workstation from which the last database update on this object was performed.
This is a description of the type of work being carried out that this note is referring to.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1383
senderusernotes
OpenEnterprise Schema
Derived From: usernotes
Description: This table shows all of the user notes that have been created by the currently logged on user. Therefore, this is always a subset of the usernotes table.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. acknowledged : bool default TRUE
If this value is FALSE, the object is in a state of not being acknowledged. addtodataset : char
Reserved for internal use. alarminhibit : bool
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1384
OpenEnterprise Schema
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. alarmpriority : integer
This is the alarm priority of an alarmed note. alarmtime : datetime
This is the time at which an alarm will be generated in the
AlarmSummary corresponding to this note. alarmtimedstoffset : 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. 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. 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
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1385
OpenEnterprise Schema 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 default TRUE
If this value is FALSE, the object has not been cleared from the alarmsummary table. createtime : datetime
This is the date and time at which this note was created. createtimedstoffset : 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. currentalarmprecedence : integer default -1
This attribute takes the highest precedence from the current set of alarms associated with this object. If no alarms are active, the attribute is set to 1. currentdstoffset : 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.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1386
OpenEnterprise Schema currentlocker : char
Override user name that allows a locked object to be unlocked. dataset : char
This is a misnamed attribute that, in fact, contains a list of id values from the logcontrol table. The list is, actually, a set of streams. These are required in order to implement stream management. The list of streams controls which historical streams this object is enabled with. Those streams not listed in the string will have this signal object disabled.
When this attribute is set, the old list of logcontrol references are disabled. These are contained in the lastdataset attribute. Then the new lists references are enabled (stored in dataset). And finally, the dataset attribute is copied to the lastdataset attribute. description : char
The description field should be used to meaningfully describe the purpose of this object. display : char
This is the name of a display that is associated with this object in the objects table. dstoffset : integer
This is the daylight saving time offset, in minutes, applicable to the timestamp attribute value.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1387
OpenEnterprise Schema emergencyprocedures : char
This is a description of what procedures should be carried out to resolve a problem on the system. This is associated with alarm notes. expirytime : datetime
This is the time when the note will automatically be removed. This is relevant for the Expiry notes and Alarm notes. expirytimedstoffset : 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. hasnotes : bool default FALSE
Determines whether notes are supported by this object. lastdataset : char
This is a misnamed attribute that, in fact, contains a list of id values from the logcontrol table. The list is, actually, a set of historical streams.
These are required in order to implement stream management. The list of streams controls which historical streams this signal is enabled with.
When this attribute is set, the old list of logcontrol references are disabled. These are contained in the lastdataset attribute. Then the new list are enabled (stored in dataset). And finally, the dataset attribute is copied to the lastdataset attribute lastnotetype : integer8
This is a reserved attribute. Do not use.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1388 locked : bool
OpenEnterprise Schema
This attribute will be set to true if any of the configuration tools are currently editing this object. locker : char message : char name : char nextid : integer notesdiary : char
The name of the user who is currently editing this object.
This is the message that is to be conveyed.
The name of the object. The name attribute is the primary key of the table.
This is an internal value used to automatically generate a primary key value for new notes objects.
For either an Alarmed Note or an Expiry Note, a diary entry is generated in order to deal with the timing of when the alarm should be generated or when the note should be removed (expired). notetype : integer8
The notetype attribute will describe whether the note is a standard note
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1389 an expiry note or an alarm note.
OpenEnterprise Schema occurrencetime : datetime
This is the date and time at which an alarm was generated upon this object. occurrencetimedstoffset : 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. operator : char
The operator who performed the last database transaction on this object. personnel : char plantarea: char printer : char
This is a string describing the people that this message is relevant to.
This attribute will usually be used to describe the physical location of whatever the derived class references.
This is the name of the printer to which the alarms associated with this object will be printed to.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1390
OpenEnterprise Schema questionable : integer
Details if the data associated with the object is questionable. recipient : char
This is the name of the person who will receive this note. 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. sender : char
This is the name of the person who sent this note. subject : char suppress : bool
This is the subject of the note that should briefly summarise the contents of the note. suppressed : bool Default FALSE
An indication that one or more of the object's alarm conditions is
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1391 currently suppressed. Read only.
OpenEnterprise Schema suppressiongroup : integer
This is an integer reference to the suppression group table. timezone : char
The timezone refers to an entry in the timezones table. Using this allows the logging of time values across time zones. tobescheduled : array of ToBeScheduled
This is an array of references to the ToBeScheduled table. They are used in conjunction with the notesdiary attribute.to connect this note object with the scheduling system. totalalarmednotes : integer
This is the total number of notes that are of type alarm. An alarm note will be given a time period, during which it is just a standard note. When this time runs out, it generates an alarm and still remains a note. totalallnotes : integer
This is the total number of notes on the system. totalexpirynotes : integer
This is the number of notes on the system that are of type expiry. These will be removed from the system after a stipulated period of time.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1392
OpenEnterprise Schema totalnotes : integer default 0
If the object supports notes this will describe the number of notes associated with the object. totalstandardnotes : integer
This is the total number of notes on the system that are of type standard.
They have to be manually deleted from the system. triggeralarm : bool
Setting this value to TRUE causes an alarm to be generated for the note, if notetype is of type expiry. triggerexpiry : bool
Setting this value to TRUE causes the timer associated with the note to expire. A subsequent action will depend upon how the alarm is generated. type : integer8 unread : bool
The type is, currently, one of three types. It can be either user notes signal notes or object notes.
If this value is true, then the note has not been read by anybody on the system. The Notes Client application will set this to false when it deems that a user has read a note.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1393
OpenEnterprise Schema userref : char worktype : char
This is a foreign key reference to a users object. worklocation : char
This is a description of the area this note is associated with. workstation : char
The workstation from which the last database update on this object was performed.
This is a description of the type of work being carried out that this note is referring to.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1394
OpenEnterprise Schema
signal
Derived From:
Description: dvi_datum
This table is the base table for OpenEnterprise signals. The information in this table should be generic to OpenEnterprise database. Device specific information should be in a separate table, derived from this table.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. acknowledged : bool default TRUE
This is set to FALSE if an unacknowledged alarm exists for this signal. addtodataset :
Reserved for internal use.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1395
OpenEnterprise Schema alarmcondition : alarmcondition
This is an array of alarmcondition objects that are applied to this signal. alarminhibit : bool
Setting this to TRUE will prevent any of the Alarm Conditions associated with this object from generating an entry in the alarmsummary table when the condition is met. attribute : char
This is part of the signal name after it has been split up. Signals are in
<DEVICE>:<BASE>.<EXT>.<ATTRIBUTE> format. The attribute is taken from the <ATTRIBUTE> position. 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.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1396
OpenEnterprise Schema base : char
This is part of the signal name after it has been split up. Signals are in
<DEVICE>:<BASE>.<EXT>.<ATTRIBUTE> format. The base is taken from the <BASE> position. 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. changemask : integer
This is the bit setting indicating the type of change that is to be set in the
RTU. For instance, the inhibit status value or questionable state. cleared : bool default TRUE
This is set to FALSE if an uncleared alarm exists for this signal.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1397
OpenEnterprise Schema controlinhibit : bool
The signal value is prevented from being updated by the device that it is located in. currentalarmprecedence : integer default -1
This attribute takes the highest precedence from the current set of alarms associated with this object. If no alarms are active, the attribute is set to 1. currentdstoffset : 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. currentlocker : char
Override user name that allows a locked object to be unlocked. dataset : char
This is a misnamed attribute that, in fact, contains a list of id values from the logcontrol table. The list is, actually, a set of streams. These are required in order to implement stream management. The list of streams controls which streams this signal is enabled with. Those streams not listed in the string will have this signal object disabled.
When this attribute is set, the old list of logcontrol references are
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1398
OpenEnterprise Schema disabled. These are contained in the lastdataset attribute. Then the new list are enabled (stored in dataset). And finally, the dataset attribute is copied to the lastdataset attribute. defaultvalue :
This value will be used at database start-up to set the associated signal's value and readvalue. No default value. description : char
This is a textual description of the signal. display : char
This is the workstation display that is associated with this signal. dstoffset : integer
This is the daylight saving time, in minutes. extension : char
This is part of the signal name after it has been split up. Signals are in
<DEVICE>:<BASE>.<EXT>.<ATTRIBUTE> format. The extension is taken from the <EXT> position.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1399
OpenEnterprise Schema hasnotes : bool default FALSE
This boolean attribute determines if any notes have been attached to this signal. A value of TRUE indicates that there are. inalarm : bool
Reflects the in-alarm status of the signal. CL updates the InAlarm value based on the current value of the Cleared attribute. lastdataset : char
This is a misnamed attribute that, in fact, contains a list of id values from the logcontrol table. The list is, actually, a set of streams. These are required in order to implement stream management. The list of streams controls which streams this signal is enabled with.
When this attribute is set, the old list of logcontrol references are disabled. These are contained in the lastdataset attribute. Then the new list are enabled (stored in dataset). And finally, the dataset attribute is copied to the lastdataset attribute. lastoverridevalue :
The last override value set by the user (or the value existing when an override was enabled). Used to restore the override value following a database restart.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1400
OpenEnterprise Schema lastreadvalue :
The last value read from the RTU. This will be updated using the readvalue attribute whilst an override is enabled. This value will be copied into value and readvalue when an override is cancelled. locked : bool
This attribute will be set to true if any of the configuration tools are currently editing this object. locker : char
The name of the user who is currently editing this object. manualinhibit : bool
If this attribute is set to TRUE, an operator cannot update the signal value themselves. occurrencetime : datetime
This is the date and time when the signal value was last updated from the field.
For NW3000 and ControlWave signals:-
• RBE collection– the occurrencetime is the timestamp taken from the ERM generated at the RTU.
• Template collection – the occurrencetime is updated to the
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1401
OpenEnterprise Schema current system time when the rdi detects the signal value is different from the last reported to the database (time stamped at rdi3000)
• Forcepoll collection – the occurrencetime is updated to current system time when the BSAP RDB request is successfully processed (time stamped at rdi3000)
• Remote Alarm Report collection – the occurrencetime is
updated to the timestamp in the remote alarm report. occurrencetimedstoffset : 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. operator : char
The operator who performed the last database transaction on this object. plantarea : char
This is usually a geographical location of a site and an area within it. printer : char
This is the name of the printer to which the alarms associated with this object will be printed to.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1402
OpenEnterprise Schema questionable : integer
The questionable flag is positioned at the signal table level but the handler for this is implemented at the specific device level (several derived tables further down the hierarchy). It determines if the value associated with this signal is safe.
The questionable attribute is a 32 bit binary number. The following bits are set for signals from Bristol-Babcock RTUs: -
Bit 0 - RTU Questionable Data
Bit 1 - Data Collection Failure
Bit 2 - RTU Offline
Bit 3 - Nan correction for analog signals
Bit 4 - Unused
Bit 5 - Version Mismatch
Bit 16 - Signal override is in force
A value of 0 (zero) indicates good quality. readchangemask : integer
This bit mask is used by the device to inform the database of value changes. readtrigger : integer
The readtrigger is updated by the RDI in order to indicate that one or more attributes have been updated. resetalarmstatistics : bool
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1403
OpenEnterprise Schema
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. suppress : bool
When set to TRUE all alarm conditions associated with the signal are suppressed. suppressed : bool Default FALSE
An indication that one or more of the signal alarm conditions is currently suppressed. Read only. suppressiongroup : integer
This, optional attribute, references a suppressiongroup object. The suppression group may be suppressed or unsuppressed using this reference. timezone : char
The timezone refers to an entry in the timezones table. Using this allows the logging of time values across time zones.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1404
OpenEnterprise Schema totalnotes : integer default 0
This is the total number of notes associated with this signal object. updatemask : integer
When a value from the device is received, this mask indicates the type of update that has occurred. valueoverride : bool
Set to true to enable a signal value override. Set to false to cancel an override. Default value false. workstation : char
The workstation from which the last database update on this object was performed. writeoverride : bool
This attribute must be set to TRUE if you wish to alter the value being read from an remote device. This attribute will automatically be set back to FALSE after the value attribute has been altered.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1405
signalattributetrigger
Derived From:
Description:
OpenEnterprise Schema attributetrigger
This is the base table for all signal triggers. Instances of the derived tables from this table will be created in order to produce a valid link. This table provides the information of the Primary Key of the object to link to but the derived tables provide the attribute and table.
Attributes: name : char
This is the name of the signal object that is being actively linked to in order to produce triggers for calculations.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1406
signalextension
OpenEnterprise Schema
Derived From:
Description:
Attributes:
No attributes extend this table.
signal
This is a special database table that has been introduced in order to allow the signal table to be expanded upon on a per system basis.
Before the initial step on including the alltables.sql
file during the database build process, you may modify the signalextension.sql file and append any extra attributes that you believe are necessary for your system.
Remember, once you include the alltables.sql file, the database structure has been created and should not be modified.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1407
signalnotes
OpenEnterprise Schema
Derived From:
Description: notes
This table will create a note that will be associated with any object derived from the signal table.
Attributes: signalref : char references signal
This is a foreign key reference to a signal object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1408
signalsuppressiongroup
OpenEnterprise Schema
Derived From:
Description: suppressiongroup
This table defines a signal that will be used as an anchor to trigger the suppression of all the conditions in the list of alarmconditions in suppressiongroup.
Attributes: name : char references signal
This is a foreign key reference to the Master Signal of the Suppression
Group. References the signal table..
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1409
sqlprocedure
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
The sqlprocedure table is used to store strings of SQL statements that can be called by clients through the Client API. Here, commonly used SQL statements will be stored along with a unique name, used to reference the statement.
Attributes: name : char text : char
This is the primary key of the sqlprocedure table and must therefore be uniquely named within this table.
This is a text string that can be used to instigate an SQL query. It may contain parameters that have to be passed when instigating the SQL statement.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1410
stringsignal
OpenEnterprise Schema
Derived From:
Description: signalextension
This table is derived from the signalextension table and is used to define strings. The device specific fields should be defined in the derived tables.
Attributes: defaultvalue : char
This value will be used at database start-up to set the associated signals value and readvalue. No default value. lastoverridevalue : char
The last override value set by the user (or the value existing when an override was enabled). Used to restore the override value following a database restart. lastreadvalue : char
The last value read from the RTU. This will be updated using the readvalue attribute whilst an override is enabled. This value will be copied into value and readvalue when an override is cancelled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1411 readvalue : char
OpenEnterprise Schema
This is the value last read from the device. value : char
This is the value available, for change, to clients.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1412
stringsignaltrigger
Derived From:
Description:
OpenEnterprise Schema signalattributetrigger
This table is used to create triggers upon value changes in the StringSignal table and other derived tables.
Attributes: readvalue : char
This attribute is used as an active link to the StringSignal table where the readvalue attribute is monitored. When the readvalue attribute of the
StringSignal changes, this attribute changes. As a result, the trigger is set and the calculation is executed.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1413
suppressiongroup
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
A signal suppression group can suppress a whole set of alarmconditon objects. A suppressed alarm condition will still generate an alarm if it meets the correct condition but suppressed alarms are not displayed at the workstation.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. alarmcondition : alarmcondition
This is an array of alarmcondition objects that are associated with this suppression group. description : char
A descriptive piece of text mainly used for human interpretation within client applications.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1414
OpenEnterprise Schema groupnumber : integer
A unique number associated with each suppressiongroup object in the table. groupstate: integer
An integer value that indicates the current suppression state of the group. Has the following values:
0 = Group not suppressed
1 = Group suppressed
2 = Group suppressed due to delay period timer groupstatetext: char
A textual representation of the GroupState attribute:
‘Not Suppressed’
‘Suppressed’
‘Suppressed by timer’ groupsuppressed : bool
States whether the group is currently suppressed or not.
SUPPRESSED = TRUE
UNSUPPRESSED = FALSE
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1415
suppressiongroupdelaytimer
OpenEnterprise Schema
Derived From:
Description: oetimer
This table is used to manage timed suppression for any Suppression
Groups configured in the SuppressionGroup table.
Attributes: suppressiongroup : integer
A reference to the SuppressionGroup table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1416
suppressiongrouplookup
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
Used to handle the association of alarm conditions with Suppression
Groups.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. alarmcondition : integer
A foreign key, referencing the alarmcondition table ID number that is associated with the suppression group indicated by the suppressiongroup attribute. conditiontype: char
A string that is used by the suppression group configuration tool to determine the ‘type’ of an alarm condition that has been associated with a suppression group, and therefore which view it should appear in within the 'Associated Alarm Conditions' dialog.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1417
OpenEnterprise Schema lastalarmcondition : integer Hidden
Used internally by OpenEnterprise. Read only. lastsuppressiongroup : integer Hidden
Used internally by OpenEnterprise. Read only. sourcename: char
The primary key value of the signal or object that is related to an alarm condition that is associated with a suppression group. suppressiongroup : integer Not Null
Foreign key, referencing the suppressiongroup table. Indicates a
Suppression Group to which the alarm condition belongs.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1418
suspendedthread
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
This table is used to view the currently suspended threads in the database.
None of the data in the table may be altered. It is used for debugging purposes.
Attributes: class : char id : integer line : integer
This is the name of the class that the thread will be suspended within.
This is the primary key and unique identifier of the object within the table.
This is the line number within the routine that the thread should be suspended. routine : char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1419
OpenEnterprise Schema
This is the routine name within the class that the thread will be suspended within.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1420
table_privileges
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This is a system table that defines what level of access users have to which particular tables. The grantee is the user who has been assigned these particular privileges.
Attributes: alter_grantable : bool alter_priv : bool
Setting this to TRUE gives the user the ability to alter the table with commands such as ALTER TABLE. delete_grantable : bool
Setting this to TRUE allows this user to pass the delete privilege to other users upon this table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1421 delete_priv : bool
OpenEnterprise Schema
Setting this to TRUE gives the user the ability to remove objects from the table with the DELETE command. execute_grantable : bool
Setting this to TRUE allows this user to pass the alter execute to other users upon this table. execute_priv : bool
Setting this to TRUE allows the user to run CL from the SQL Client, using the SEND command. grantee : char
The user that has the privileges within this object available to them.
The user that assigned these privileges to the grantee. grantor : char index_grantable : bool
Setting this to TRUE allows this user to pass the index privilege to other users upon this table. index_priv : bool
Setting this to TRUE allows the user to create indexes upon this table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1422
OpenEnterprise Schema insert_grantable : bool
Setting this to TRUE allows this user to pass the insert privilege to other users upon this table. insert_priv : bool
Setting this to TRUE allows the user to add objects to this table using the INSERT command. references_grantable : bool
Setting this to TRUE allows this user to pass the insert privilege to other users upon this table. references_priv : bool
Setting this to TRUE allows the user to generate Foreign Key references to this table. select_grantable : bool
Setting this to TRUE allows this user to pass the select privilege to other users upon this table. select_priv : bool
Setting this to TRUE allows the user to retrieve information from this table using the SELECT command.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1423
OpenEnterprise Schema table_name : char
The name of the table that these privileges have been set upon. update_grantable : bool
Setting this to TRUE allows this user to pass the update privilege to other users upon this table. update_priv : bool
Setting this to TRUE gives the user the ability to change attribute in the table with the UPDATE command.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1424
tablegroups
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
Used by the Grant Revoke security configuration tool. It lists tables in functional area groups. The group list is displayed by the configuration tool, enabling easier identification and selection of the tables for which users or user groups may require read/write privileges.
Attributes: name:Char tables:Char
The name of the group of tables linked by functional area.
A comma-separated list of the tables belonging to a certain functional group.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1425
tables
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
This is a system table that contains a single object for each table in the database. Information such as the primary key, base table name and depth in the hierarchy can be found.
Attributes: depth : integer
This is the number of tables that this table is derived from. A value of 0 means this table is a base table. derived_from : char
This is the name of the table that this table immediately derives from. If the table is a base table this value will be NULL. name : char
This is the name given to the table and is also the primary key of the tables table. Therefore, all tables must be defined with a unique name.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1426 owner : char
OpenEnterprise Schema
This is the name of the user who created the table. If no user is logged on the value is SYSTEM. persistence : bool
This determines whether a table is, by default, persistent or transient.
Persistent tables store their data to disk when a user carries out a save into operation. Individual attributes in the table may overwrite the persistence assigned by specifying persistent or transient in the creation of the attribute. pk_index : char
This is the name of the index defining the primary key. system : bool
This determines if the table is a base schema table or if it is an extension to the schema. A value of TRUE applies to tables such as integer or attributes. The majority of tables are non-system tables. type : integer
This attribute determines if the table is a table, a built-in type, a domain or a view. This is needed because built-in types and domains are stored in a similar manner to the tables. Built-in types such as bool may not be accessed as other tables but are used in table definitions. 0 = table, 1 = built-in type, 2 = domain, 3 = view.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1427
tcpconnection
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
This is a class that allows a CL program access to the TCP connections to the database.
Attributes: id : integer
This is the primary key attribute of this table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1428
tcpserver
Derived From:
Description:
OpenEnterprise Schema
<Base Table>
This class will allow access to the TCP sockets. The state of the socket may be monitored and operations upon it carried out.
Attributes: id : integer
This is the primary key attribute of this table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1429
telephonenumber
OpenEnterprise Schema
Derived From:
Description: objects
This table is used by the Paging Server to send messages to Alarm
Recipients. As its name suggests, it contains actual telephone numbers, referenced by the Alarm Paging Recipient table.
Attributes: delaybetweendialups:integer
The delay period before re-dialling a failed connection. externalnumber:char
The external number that the Paging Server should dial to notify the alarm recipient. outsideline: char
The number that needs to be entered to get an outside line e.g. '9' postconnectdelay:integer
Number of units to wait after a connection is made before sending data
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1430 to the external number.
OpenEnterprise Schema predisconnectdelay:integer
Number of units to wait before disconnecting from the external number. preexternalnumberdelay:integer
A period of units to wait before dialling the external number after the
Outside line number is dialled. preoutsidelinedelay : integer
The number of units to wait before dialling an outside line. redialattempts:integer
Number of re-dial attempts to make, in the event of a failed connection.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1431
time
OpenEnterprise Schema
Derived From:
Description: signal
This table defines the time signals. Device specific fields should be defined in the derived tables.
Attributes: defaultvalue : datetime
This value will be used at database start-up to set the associated signals value and readvalue. No default value. lastoverridevalue : datetime
The last override value set by the user (or the value existing when an override was enabled). Used to restore the override value following a database restart. lastreadvalue : datetime
The last value read from the RTU. This will be updated using the readvalue attribute whilst an override is enabled. This value will be copied into value and readvalue when an override is cancelled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1432
OpenEnterprise Schema readvalue : datetime
This is the string value of the signal most recently received from the device. readvaluedstoffset : 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. value : datetime
This is the string value that is accessible to client processes. They will set this value. valuedstoffset : 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.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1433
timedarchive
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table is used to allow archive files to be generated for historical data sets on a timed basis, instead of or as well as the standard auto archiving functionality provided by the oelogdata table.
The OE Scheduler must be running for timed archive functionality to work.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. archivestarttime : datetime
The earliest time, in UCT at which the archive file creation will occur.
This is really used as a starting point for the creation of archive files for this table entry. archivestarttimedstoffset : integer
The DST Offset applicable to the value of the archivestarttime attribute.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1434
OpenEnterprise Schema control : integer
The historical group (oelogcontrol) to which the timed archive table entry relates. description : char
An optional textual description of the timed archive instance. diary : char references Diary
In order to handle timed archiving of history files a diary entry needs to be established. This is a reference to that object. The values for the diary are taken from many of the attributes in this object. id : integer
The unique primary key value for the timed archive table entry. See
Appendix A for more information. offsetday : integer8 default 0
The daily offset within the repeatinterval at which the archive file will be created. This is applicable to any archive schedule greater than daily.
Permitted values for a weekly schedule are 1 (Sunday) to 7 (Saturday), and for a monthly or yearly schedule they are 1 to 31. offsethour : integer8 default 0
The hourly offset within the repeatinterval at which the archive file will be created. This is applicable to any archive schedule greater than hourly.
Permitted values are 1 to 24.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1435
OpenEnterprise Schema offsetminute : integer8 default 0
The minute offset within the repeatinterval at which the archive file will be created. This is applicable to any archive schedule greater than a minute. Permitted values are 1 to 60. offsetmonth : integer8 default 0
The monthly offset within the repeatinterval at which the archive file will be created. This is applicable to a yearly archive schedule only.
Permitted values are 1, (indicating January) to 12 (indicating December) offsetseconds : integer8 default 0
An offset in seconds within the repeatinterval at which the archive file will be created. Applicable to all archive schedules, with a permitted range of 1 to 60. rate : char
This is the collection rate of the archive file. Examples of such rates are:
0s, 600s, 3600s, 1m. If the rate is post-fixed by an s then the duration in seconds. If the rate is post-fixed by a m then the duration is in months. repeatinterval : integer
A compulsory field defining the archive schedule for the timed archive table entry. The following values are currently permitted.
0 = a one-shot schedule.
1 = a daily schedule.
2 = a weekly schedule.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1436
3 = a monthly schedule.
OpenEnterprise Schema
4 = a yearly schedule.
5 = a specific weekday on which the archive will be produced.
6 = that the archive will be produced at the end of each week.
7 = that the archive file will be produced at the end of each month.
8 = a minute schedule.
9 = a five minutes schedule.
10 = an hourly schedule. tobescheduled : integer references ToBeScheduled
When the diary triggers, the tobescheduled object reference is used in order to determine what action should be carried out. In this case the doarchive will be set to TRUE.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1437
timer
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This class is used to generate timers. Various attributes are associated with the timer to allow for repeating timers and the configuration of a duration. All OpenEnterprise timers should be derived from oetimer which is derived from this base class.
Attributes: active : bool continuous : bool counter : integer
This indicates if the timer is actually running at the moment. A value of
FALSE indicates that it is not.
Setting the continuous flag to TRUE, will automatically re-start the timer when it completes (or activates).
This is the number of times that the timer has been activated since it was created.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1438
OpenEnterprise Schema id : integer
This is the primary key of the timer. interval : integer
This attribute defines the number of tick to occur before the timer activates. Each tick length is determined by the ticktime attribute. ticktime : integer default 1
This attribute defines the length of each tick, in microseconds.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1439
timezones
OpenEnterprise Schema
Derived From:
Description:
<Base Table>
This table is used to record each timezone that is supported by the
OpenEnterprise system.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. offsetfromuct : integer
This is the number of minutes from Universal Central Time (UCT) that the timezone, specified in name, is set. For example, EST would be -
300. timezone : char
This attribute is the Primary Key and describes the time zone of the object. For example: GMT 10:00 -6:00, GMT +07:00, GMT, etc.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1440
tobescheduled
OpenEnterprise Schema
Derived From: <Base Table>
Description: Each entry in this table constitutes a Scheduled Action object. Each
Scheduled Action object contains within its attributes the information necessary to locate one or more targeted trigger objects, and to write a given value to a specified attribute of that object. Actions will be performed by the Scheduler on the expiry of a diary or a scheduled event within a pattern used by the diary.
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 description of the Scheduled Action object. This is usually created by the CL (Database Command Language), which takes the name of the
Diary, Calculation or Timed archive and parses it to form a suitable description. id : integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1441
OpenEnterprise Schema
The unique id number of this Scheduled Action object. This Auto-ID attribute is the primary key for this table. lasttrigger : integer
This attribute is used to track the last trigger state applied when using toggle mode for a trigger pattern. The next trigger value applied will be the logical inverse of the current state. This attribute serves no purpose for control curves or on/off patterns. tableentry : char
A comma separated list of the attribute name(s) that will identify the object(s) to be updated by the Scheduler. If one object is to be updated this is usually the primary key for the target table, but several objects may be updated by specifying an attribute that has the same value for a number of objects in the target table (e.g. all realanalog signals with a devicename of CW1). tableentryvalue : char
A comma separated list of attribute values. The number of values specified must match the number of attributes specified in the tableentry attribute. Each value is paired with the corresponding attribute and the combination is used to define which object(s) the Scheduler triggers. tablename : char
The name of the table that this Scheduled Action object operates on.
This table name is used when constructing the trigger transaction. Any valid table name can be specified (i.e. one that exists in the OE
Database). triggeroffname : char
The name of the attribute to be triggered by an off event. This attribute
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1442
OpenEnterprise Schema serves no purpose for control curves. triggeroffvalue : char
The value to be written into the attribute defined by triggeroffname when an off event occurs. This attribute serves no purpose for control curves. triggeronname : char
The name of the attribute to be triggered by an on event. This attribute name is also used for control curve events. triggeronvalue : char
The value to be written into the attribute defined by triggeronname when an on event occurs. This attribute serves no purpose for control curves. usesthisinfo : char references Diary
This is a reference back to the diary object that is associated with this
Scheduled Action object. A Scheduled Action object must reference a
Diary object in this field.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1443
token
OpenEnterprise Schema
Derived From:
Description:
The Token table will store all Security Tokens configured for the system. A full list of the supported application tokens will be provided through a new
SQL load file TokenLoad.sql, which will be automatically loaded when the standard DefaultLoad.sql file, is included. In addition default wildcard tokens for File, OPC Item and Custom tokens will be defined.
Aside from the standard Access Area functionality, the CL script for this table will ensure that Application Tokens cannot be deleted.
<Base Table>
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. component : char
Only applicable to application tokens. The name of the OE Component to which the token relates. description : char
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1444
OpenEnterprise Schema
A string that provides a more detailed description of the Token. itemid: integer
Only applicable to application tokens, and matching the itemid allocated within the OE Workstation based string resource DLLs apsec.dll and apsec1.dll. name : char not null
The name of the token. type : integer8 not null
The following constants, indicating the type of security token will be defined for use with the Token Table.
FILE_TOKEN = 1
OPCITEM_TOKEN = 2
APPLICATION_TOKEN = 3
CUSTOM_TOKEN = 4
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1445
tokenaccess
OpenEnterprise Schema
Derived From:
Description:
The TokenAccess table will be used to associate Users and Security
Groups with entries in the Token table.
In order to provide a starting point for configuration, the wildcard File, OPC
Item and Custom Token entries within the Token table are automatically allocated to the Default User within the TokenLoad.sql load file.
<Base Table>
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. exclude : bool not null
If true, this Token is excluded from the user it references. name : char not null references users
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1446
Associates a user with this Token.
OpenEnterprise Schema tokenname : char not null
The name of the Token, which must correspond to an entry in the token table. tokentype : integer8 not null
The Token Type, as per the definition of the Token within the token table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1447
tokengroup
OpenEnterprise Schema
Derived From: The Token Group table will be used to store collections of Tokens, (as defined within the Token table), to which Users and Groups can be assigned access, thus simplifying the configuration process. All application token groups will be created through entries in the TokenLoad.sql SQL load file, and will be marked as none delete-able.
Description: <Base Table>
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. description : char
An optional description field, which can be used to define the purpose of the Token Group. name : char
The name of the Token Group.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1448 tokens: char
OpenEnterprise Schema
A comma separated list of the Tokens that constitute the Token Group, of the form token name, token type |,token name, token type, .|.
If this value is NULL, then we are (probably) dealing with an application token group. OpenEnterprise currently supports a number of Application
Token Groups, (through the Iconics Security Server). Each Group consists of the application tokens specific to a particular OE Component, e.g. OE Alarm Client, OE Graphics, OE Trend Client etc.
If a Token Group entry is found with the Tokens attribute set to NULL, then this will generally indicate that we are dealing with an application token group. In this case all entries within the Token table with a component attribute value identical to the name of the TokenGroup entry will be considered a member of that Token Group.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1449
tokengroupaccess
OpenEnterprise Schema
Derived From:
Description:
This table is used to associate Users and Security Groups with entries in the TokenGroup table.
<Base_Table>
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. exclude : bool not null
Indicates whether the TokenGroup is in the User or Groups Include or
Exclude list. name : char not null references users
The name of the User or Group to which the Token Group association applies. tokengroup : char not null references tokengroup
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1450
OpenEnterprise Schema
Standard Access Area attribute, used to provide object based database security.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1451
triggersqlprocedure
OpenEnterprise Schema
Derived From:
Description: objects
The TriggerSqlProcedure table is used to execute Sql statements on a timed basis.
Attributes: disable : bool default FALSE
When set to TRUE, disables the SQLScript. Default value is FALSE. errortext : char
Any errors that occur will be recorded here. lastruntime: datetime
The last time that this triggered SQL script was run. nexttrigger : datetime
When the nexttrigger time is passed, the Sql statement will be executed.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1452
OpenEnterprise Schema offsetinsecs : integer
The scheduled offset for the repeat interval in seconds. Used to schedule the execution of the Sql.
Example 1 - If a script must be scheduled once every 5 minutes, at 15 seconds past the minute, the periodInMins and offsetInSecs will be set to 5 and 15 respectively.
Example 2 - If a script must be scheduled once per day, at 7am (UTC), the periodInMins and offsetInSecs will be set to 1440 and 25200 respectively. periodinmins : integer
The scheduled repeat interval in minutes. Used to schedule the execution of the Sql.
Example 1 - If a script must be scheduled once every 5 minutes, at 15 seconds past the minute, the periodInMins and offsetInSecs will be set to 5 and 15 respectively.
Example 2 - If a script must be scheduled once per day, at 7am (UTC), the periodInMins and offsetInSecs will be set to 1440 and 25200 respectively. sqlscript : char
The SQL statement to be executed. When its value changes, the SQL statement will be executed. Can contain one or more DML statements.
Multiple DML statements must be separated by semi-colons. triggeratstartup : bool
Determines whether the SQL procedure will run when the
OpenEnterprise session begins. TRUE = SQL procedure will run at startup.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1453
OpenEnterprise Schema triggertimer : integer
Foreign key, referencing the TriggerSqlProcedureTimer table. A separate object will exist in the TriggerSqlProcedureTimer table for each configured TriggerSqlProcedure object. This timer object will be automatically created by the insertion of the TriggerSqlProcedure object.
The timer's ticktime will be set to 1 second and the interval created dynamically to reflect the next delivery time of the object.
If the TriggerSqlProcedure object is disabled, the associated timer object will also be disabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1454
OpenEnterprise Schema
triggersqlprocedureerroralarmcondition
Derived From:
Description: alarmcondition
An alarm is generated for any object in this table if the errortext attribute for a related object in the TriggerSQLProcedure table contains a non-Null valuel.
Attributes: name : char
Contains a reference to an object from the TriggerSQLScript table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1455
triggersqlproceduretimer
Derived From:
Description:
OpenEnterprise Schema oetimer
The TriggerSqlProcedureTimer table is used to time the execution of Sql statements created in the TriggerSqlProcedure table.
A separate object will exist in this table for each configured
TriggerSqlProcedure object and will be automatically created by the insertion of the TriggerSqlProcedure object.
The timer's ticktime will be set to 1 second and the interval created dynamically to reflect the next delivery time of the object. If the
TriggerSqlProcedure object is disabled, the associated timer object will also be disabled.
Attributes: name : char
A foreign key that references an object in the triggersqlprocedure table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1456
udpmsg
Derived From:
Description:
OpenEnterprise Schema
This class provides a way of writing a message to a UDP port.
<Base Table>
Attributes: id : integer
This is the primary key attribute of this table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1457
udpport
Derived From:
Description:
OpenEnterprise Schema
The UdpPort class provides the CL programmer with an interface to UDP sockets.
<Base Table>
Attributes: id : integer
This is the primary key attribute of this table.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1458
useraccess
OpenEnterprise Schema
Derived From:
Description:
View onto users
This view is used by the Security Manager and Security Configuration Tool in order to read and manipulate security configuration information.
Note: all users will require SELECT privilege to this view.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. accountdisabled : bool default FALSE
Allows this users account to be disabled, meaning that the user cannot log on to the OpenEnterprise system. accountdisabledtime : datetime
Contains the UCT time at which the user account was disabled.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1459
OpenEnterprise Schema accountdisabledtimedstoffset : integer
The DST offset applicable to the value of the accountdisabledtime. accountlockedout : bool default FALSE
Allows a users account to be locked out. This is similar to account disabled, but is generally set as a result of consecutive log on failures for a user, rather than directly. If an account is locked out, that user cannot log on to the OpenEnterprise system. autologoutappliedperconnection : bool default FALSE
This attribute indicates whether auto log out functionality is applied on a per Connection or per Workstation basis. This allows all connections from a host computer to be handled together when dealing with auto log out functionality.
FALSE= per workstation
TRUE = per connection autologoutinactivity : integer
Defines an inactivity period, in minutes, after which the user will automatically be logged off from the database.
Activity on a connection(s) is defined as a query or transaction being defined on the database. autologoutlength : integer
Defines a fixed period, in minutes, for which the user is allowed to be logged on to a database, regardless of any database activity for the
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1460
OpenEnterprise Schema connection(s). After this period the user will be automatically logged off, and an appropriate journal message will be generated. cannotchangepassword : bool default FALSE
If set to TRUE then the user is not permitted to change their password. enableautologoutfixed : bool default FALSE
If set to TRUE then a fixed period auto log out applies for the User or members of the Group. enableautologoutinactivity : bool default FALSE
If set to TRUE then an inactivity auto log out period applies for the User or members of the Group. enablefailedlogincount : bool default FALSE
If set then following consecutive failed Login attempts the Users Account will be Locked Out. enablelockoutperiod : bool default FALSE
If set to TRUE then an Account Lockout period is applied for the User or members of the Group. enablelogoffoedfile : bool default FALSE
Indicates whether the value held in the LogOffOEDFile attribute should be used. FALSE = Don't use, TRUE = Use.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1461
OpenEnterprise Schema enablelogonoedfile : bool default FALSE
Indicates whether the value held in the LogOnOEDFile attribute should be used. FALSE = Don't use, TRUE = Use. enablemaximumpasswordlength : bool default FALSE
If set to TRUE then a maximum password length should be applied for the User or members of the Group. enableminimumpasswordage : bool default FALSE
If set to TRUE then a minimum password age applies for the User or members of the Group. enableminimumpasswordlength : bool default FALSE
If set to TRUE then a minimum password length should be applied for the User or members of the Group. enablepasswordexpireoe : bool default FALSE
This attribute is used to control whether any ClientAPI will be refused log on for the user if their password has expired.
If set to FALSE then the user will be permitted to log on, for ClientAPI connections, if the users password has expired, but an appropriate journal message will be generated
Note that previously this attribute was used to enable or disable password expiry functionality for ClientAPI connections for a user.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1462
OpenEnterprise Schema enablepasswordexpirepoly : bool default FALSE
This attribute is used to control whether any none ClientAPI, e.g. ODBC,
SQLC etc will be refused log on for the user if their password has expired.
If set to FALSE then the user will be permitted to log on, for all none
ClientAPI connections, if the users password has expired, but an appropriate journal message will be generated
Note that previously this attribute was used to enable or disable password expiry functionality for all none ClientAPI connections for a user. enablepasswordexpiry : bool
If set to TRUE then a password expiry applies for the User or members of the Group. enablepasswordexpirywarning: bool
If set to TRUE then a warning will be generated as password expiry nears for the User or members of the Group. encryptedpassword : char
A UCT date and time at which the users password will expire. This is updated automatically whenever the password is changed and/or the maximumpasswordage attribute is changed. It can also be set manually if required.
If the value of this attribute is NULL then password expiry is disabled for
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1463 the user.
OpenEnterprise Schema expirytime : datetime
A UCT date and time at which the users password will expire. This is updated automatically whenever the password is changed and/or the maximumpasswordage attribute is changed. It can also be set manually if required.
If the value of this attribute is NULL then password expiry is disabled for the user. expirytimedstoffset : integer
The DST Offset applicable to the expirytime attribute value. expirywarningtime : datetime
An absolute time, prior to a password expiring, at which the user is warned of the impending expiry. This is used by the OE Security
Manager to provide a means of warning the user in advance of the password expiry.
If NULL, then no warning period is configured, and therefore no indication of an impending password expiry is given. expirywarningtimedays : integer
The number of days before a password expiry at which a User will be warned of that impending expiry.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1464 fullname : char
OpenEnterprise Schema
An optional attribute value allowing greater granularity on the identity of the user. isadminuser : bool default FALSE
Used to define the user as an Iconics administrative user. This is used by the OE Security Manager to perform a privileged log on to the Iconics
Security Server, and apply any configuration changes automatically. lastloggedin : datetime
Indicates in UCT the time at which the user last logged on to the
OpenEnterprise system. lastloggedindstoffset : datetime
The DST offset applicable to the value of the lastloggedin attribute value. lastpasswordchange : datetime
The UCT time at which the last password change occurred for the user. lastpasswordchangedstoffset : datetime
The DST Offset applicable to the value of the LastPasswordChange attribute value. lockedouttime : datetime
The UCT time at which the account lockout occurred.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1465
OpenEnterprise Schema lockedouttimedstoffset : integer
The DST offset applicable to value of the lockedouttime attribute. lockoutduration : integer
The length of time in minutes for which the account will remain locked out. If this attribute value is NULL or 0 then the lockout is permanent. logoffoedfile : char
If the user or user group has a special logged off .OED (OpenEnterprise
Desktop) file configured, this is a string defining the path and filename of the .OED file. It is loaded when the user logs off. logonattemptfailures : integer
This field is incremented by the OE Security Manager each time a user fails to log on to the OpenEnterprise system, generally because of an invalid password for instance. This attribute value in conjunction with the numberoflogonfailurespermitted attribute is then used to determine whether the users account should be locked out.
On a successful log in for the user this attribute value is reset to 0. logonoedfile : char
If the user or user group has a special logged on .OED (OpenEnterprise
Desktop) file configured, this is a string defining the path and filename of the .OED file. It is loaded when the user logs on.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1466
OpenEnterprise Schema maximumpasswordage : integer
Defines the length of time, in days after a password has been changed before that password is deemed to have expired. Changes of this value will automatically cause the expirytime attribute to be updated. maximumpasswordlength : integer
Indicates the maximum permitted length of the (unencrypted) password for the user. maximumusernamelength : integer
A shared attribute used to define the maximum permitted length for a users name. minimumpasswordage : integer
The minimum number of days after a password change has occurred, for a user before they are permitted to change the password again. minimumpasswordlength : integer
Indicates the minimum permitted length of the (unencrypted) password, for the user. minimumusernamelength : integer
A shared attribute used to define the minimum permitted length for a users name. mustchangepassword : bool default FALSE
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1467
OpenEnterprise Schema
If set to TRUE then the user is expected to change their password the next time they log on to the system.
A log on attempt will not be refused if this attribute is set for the user, but an appropriate journal message will be generated to indicate that the user is expected to change their password.
Once a user has changed their password this attribute value is reset to
FALSE. name : char
Primary Key. User name. numberlogonfailurespermitted : integer
Defines the number of consecutive log on failures for the user, before that users account is locked out. numberoftimesloggedin : integer
The total number of times that the user has been logged on to the
OpenEnterprise system. parentgroup : char references Users
The name of the Security Group to which the User belongs.
CL will ensure that this attribute only ever contains a valid Group definition, and to prevent this attribute being set for any entry within the
Users table whose Type attribute is set to IS_GROUP, since a Group may not belong to another Group.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1468 plantarea : char type : Integer
OpenEnterprise Schema
This is the name of the Plant Area that the user is associated with.
Indicates if the entry is for a User or Group. The values are defined by integer constants which are defined in the constants.cl file as:
0 = IS_USER
1 = IS_GROUP
2 = IS_DEFAULTGROUP
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1469
userconfig
OpenEnterprise Schema
Derived From:
Description:
View onto users
This is a view that is used by the Security Configuration Tool in order to manipulate user information.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. accountdisabled : bool default FALSE
Allows this users account to be disabled, meaning that the user cannot log on to the OpenEnterprise system. accountlockedout : bool default FALSE
Allows a users account to be locked out. This is similar to account disabled, but is generally set as a result of consecutive log on failures for a user, rather than directly. If an account is locked out, that user cannot log on to the OpenEnterprise system.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1470
OpenEnterprise Schema autologoutappliedperconnection : bool default FALSE
This attribute indicates whether auto log out functionality is applied on a per Connection or per Workstation basis. This allows all connections from a host computer to be handled together when dealing with auto log out functionality.
FALSE= per workstation
TRUE = per connection autologoutinactivity : integer
Defines an inactivity period, in minutes, after which the user will automatically be logged off from the database.
Activity on a connection(s) is defined as a query or transaction being defined on the database. autologoutlength : integer
Defines a fixed period, in minutes, for which the user is allowed to be logged on to a database, regardless of any database activity for the connection(s). After this period the user will be automatically logged off, and an appropriate journal message will be generated. cannotchangepassword : bool default FALSE
If set to TRUE then the user is not permitted to change their password. description : char
The user specified description of this object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1471
OpenEnterprise Schema enableautologoutfixed : bool default FALSE
If set to TRUE then a fixed period auto log out applies for the User or members of the Group. enableautologoutinactivity : bool default FALSE
If set to TRUE then an inactivity auto log out period applies for the User or members of the Group. enablefailedlogincount : bool default FALSE
If set then following consecutive failed Login attempts the Users Account will be Locked Out. enablelockoutperiod : bool default FALSE
If set to TRUE then an Account Lockout period is applied for the User or members of the Group. enablelogoffoedfile : bool default FALSE
Indicates whether the value held in the LogOffOEDFile attribute should be used. FALSE = Don't use, TRUE = Use. enablelogonoedfile : bool default FALSE
Indicates whether the value held in the LogOnOEDFile attribute should be used. FALSE = Don't use, TRUE = Use. enablemaximumpasswordlength : bool default FALSE
If set to TRUE then a maximum password length should be applied for
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1472 the User or members of the Group.
OpenEnterprise Schema enableminimumpasswordage : bool default FALSE
If set to TRUE then a minimum password age applies for the User or members of the Group. enableminimumpasswordlength : bool default FALSE
If set to TRUE then a minimum password length should be applied for the User or members of the Group. enablepasswordexpireoe : bool default FALSE
This attribute is used to control whether any ClientAPI will be refused log on for the user if their password has expired.
If set to FALSE then the user will be permitted to log on, for ClientAPI connections, if the users password has expired, but an appropriate journal message will be generated
Note that previously this attribute was used to enable or disable password expiry functionality for ClientAPI connections for a user. enablepasswordexpirepoly : bool default FALSE
This attribute is used to control whether any none ClientAPI, e.g. ODBC,
SQLC etc will be refused log on for the user if their password has expired.
If set to FALSE then the user will be permitted to log on, for all none
ClientAPI connections, if the users password has expired, but an
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1473
OpenEnterprise Schema appropriate journal message will be generated
Note that previously this attribute was used to enable or disable password expiry functionality for all none ClientAPI connections for a user. enablepasswordexpiry : bool
If set to TRUE then a password expiry applies for the User or members of the Group. enablepasswordexpirywarning: bool
If set to TRUE then a warning will be generated as password expiry nears for the User or members of the Group. encryptedpassword : char
A UCT date and time at which the users password will expire. This is updated automatically whenever the password is changed and/or the maximumpasswordage attribute is changed. It can also be set manually if required.
If the value of this attribute is NULL then password expiry is disabled for the user. expirytime : datetime
A UCT date and time at which the users password will expire. This is updated automatically whenever the password is changed and/or the maximumpasswordage attribute is changed. It can also be set manually if required.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1474
OpenEnterprise Schema
If the value of this attribute is NULL then password expiry is disabled for the user. expirywarningtime : datetime
An absolute time, prior to a password expiring, at which the user is warned of the impending expiry. This is used by the OE Security
Manager to provide a means of warning the user in advance of the password expiry.
If NULL, then no warning period is configured, and therefore no indication of an impending password expiry is given. expirywarningtimedays : integer
The number of days before a password expiry at which a User will be warned of that impending expiry. fullname : char
An optional attribute value allowing greater granularity on the identity of the user. isadminuser : bool default FALSE
Used to define the user as an Iconics administrative user. This is used by the OE Security Manager to perform a privileged log on to the Iconics
Security Server, and apply any configuration changes automatically. lastpasswordchange : datetime
The UCT time at which the last password change occurred for the user.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1475
OpenEnterprise Schema lockoutduration : integer
The length of time in minutes for which the account will remain locked out. If this attribute value is NULL or 0 then the lockout is permanent. logoffoedfile : char
If the user or user group has a special logged off .OED (OpenEnterprise
Desktop) file configured, this is a string defining the path and filename of the .OED file. It is loaded when the user logs off. logonoedfile : char
If the user or user group has a special logged on .OED (OpenEnterprise
Desktop) file configured, this is a string defining the path and filename of the .OED file. It is loaded when the user logs on. maximumpasswordage : integer
Defines the length of time, in days after a password has been changed before that password is deemed to have expired. Changes of this value will automatically cause the expirytime attribute to be updated. maximumpasswordlength : integer
Indicates the maximum permitted length of the (unencrypted) password for the user. maximumusernamelength : integer
A shared attribute used to define the maximum permitted length for a users name.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1476
OpenEnterprise Schema minimumpasswordage : integer
The minimum number of days after a password change has occurred, for a user before they are permitted to change the password again. minimumpasswordlength : integer
Indicates the minimum permitted length of the (unencrypted) password, for the user. minimumusernamelength : integer
A shared attribute used to define the minimum permitted length for a users name. mustchangepassword : bool default FALSE
If set to TRUE then the user is expected to change their password the next time they log on to the system.
A log on attempt will not be refused if this attribute is set for the user, but an appropriate journal message will be generated to indicate that the user is expected to change their password. name : char
Once a user has changed their password this attribute value is reset to
FALSE.
Primary Key. User name.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1477
OpenEnterprise Schema numberlogonfailurespermitted : integer
Defines the number of consecutive log on failures for the user, before that users account is locked out. parentgroup : char references Users
The name of the Security Group to which the User belongs.
CL will ensure that this attribute only ever contains a valid Group definition, and to prevent this attribute being set for any entry within the
Users table whose Type attribute is set to IS_GROUP, since a Group may not belong to another Group. password : char type : Integer
This attribute is only available if security has been included into the directory. The database configuration file can either include nosecurity.sql or security.sql. This attribute, if implemented, contains the confidential password for each user.
Indicates if the entry is for a User or Group. The values are defined by integer constants which are defined in the constants.cl file as:
0 = IS_USER
1 = IS_GROUP
2 = IS_DEFAULTGROUP
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1478
usergroups
Derived From:
Description:
Attributes:
No attributes extend this table.
<Base Table>
RESERVED FOR FUTURE USE
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1479
userlockout
OpenEnterprise Schema
Derived From: This view is used by the Security Manager in order to provide lock out functionality when users are prevented from logging onto the system because of multiple unsuccessful login attempts, etc.
All users will require both SELECT and UPDATE privileges upon this view.
Description: View onto users
Attributes: logonattemptfailures : integer
This field is incremented by the OE Security Manager each time a user fails to log on to the OpenEnterprise system, generally because of an invalid password for instance. This attribute value in conjunction with the numberoflogonfailurespermitted attribute is then used to determine whether the users account should be locked out.
On a successful log in for the user this attribute value is reset to 0. name : char
Primary Key. User name.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1480
usernotes
Derived From:
Description:
OpenEnterprise Schema notes
This table will create a note that will be associated with any object derived from the users table.
Attributes: userref : char
This is a foreign key reference to a users object.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1481
users
OpenEnterprise Schema
Derived From:
Description:
Objects
This table stores a list of all valid users of the system and details about those
Attributes: accountdisabled:bool
Allows the user’s account to be disabled, meaning that the user cannot log on to the OpenEnterprise system. accountdisabledtime:datetime
Contains the UCT time at which the user account was disabled. accountdisabledtimedstoffset:integer
The DST offset applicable to the value of the accountdisabledtime. accountlockedout:bool
Allows a user’s account to be locked out. This is similar to account disabled, but is generally set as a result of consecutive log on failures for
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1482
OpenEnterprise Schema a user, rather than directly. If an account is locked out, that user cannot log on to the OpenEnterprise system. autologoutappliedperconnection:bool
If set to TRUE autologout functionality for periods of inactivity is applied on a database connection basis – meaning whether or not a query has been instigated at the Workstation after a period defined by autologoutinactivity. autologoutinactivity:integer
Defines an inactivity period, in minutes, after which the user will automatically be logged off from the database. Activity on a connection(s) is defined as a query or transaction being defined on the database. autologoutlength:integer
Defines a fixed period, in minutes, for which the user is allowed to be logged on to a database, regardless of any database activity for the connection(s). After this period the user will be automatically logged off, and an appropriate journal message will be generated. cannotchangepassword:bool
If set to TRUE then the user is not permitted to change their password. enableautologoutfixed:bool
If set to TRUE then a fixed period auto log out applies for the User or members of the Group.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1483
OpenEnterprise Schema enableautologoutinactivity:bool
If set to TRUE then an inactivity auto log out period applies for the User or members of the Group. enableautologoutoe:bool
If set to TRUE enables users to be automatically logged after a fixed period or a period of inactivity at the Workstation. enableautologoutpoly:bool
When set to TRUE enables users to be automatically logged out after a fixed period or a period of inactivity enablefailedlogincount:bool
If set then following consecutive failed Login attempts the Users Account will be Locked Out. enablelockoutperiod:bool
If set to TRUE then an Account Lockout period is applied for the User or members of the Group. enablelogoffoedfile:bool
Indicates whether the value held in the LogOffOEDFile attribute should be used. FALSE = Don't use, TRUE = Use. enablelogonoedfile:bool
Indicates whether the value held in the LogOnOEDFile attribute should
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1484
OpenEnterprise Schema be used. FALSE = Don't use, TRUE = Use. enablemaximumpasswordlength:bool
If set to TRUE then a maximum password length should be applied for the User or members of the Group. enableminimumpasswordage:bool
If set to TRUE then a minimum password age applies for the User or members of the Group. enableminimumpasswordlength:bool
If set to TRUE then a minimum password length should be applied for the User or members of the Group. enablepasswordexpireoe:bool
This attribute is used to control whether any ClientAPI will be refused log on for the user if their password has expired.
If set to FALSE then the user will be permitted to log on, for ClientAPI connections, if the users password has expired, but an appropriate journal message will be generated
Note that previously this attribute was used to enable or disable password expiry functionality for ClientAPI connections for a user. enablepasswordexpirepoly:bool
This attribute is used to control whether any none ClientAPI, e.g. ODBC,
SQLC etc. will be refused log on for the user if their password has expired.
If set to FALSE then the user will be permitted to log on, for all none
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1485
OpenEnterprise Schema
ClientAPI connections, if the users password has expired, but an appropriate journal message will be generated
Note that previously this attribute was used to enable or disable password expiry functionality for all none ClientAPI connections for a user. enablepasswordexpiry:bool
If set to TRUE then a password expiry applies for the User or members of the Group. enablepasswordexpirywarning:bool
The number of days before a password expiry at which a User will be warned of that impending expiry. encryptedpassword:char
An encrypted version of the password. This is used by the OE Security
Manager in its maintenance of the security system. expirytime:datetime
A UCT date and time at which the users password will expire. This is updated automatically whenever the password is changed and/or the maximumpasswordage attribute is changed. It can also be set manually if required.
If the value of this attribute is NULL then password expiry is disabled for the user. expirytimedstoffset:integer
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1486
OpenEnterprise Schema
The DST Offset applicable to the expirytime attribute value. expirywarningtime:datetime
An absolute time, prior to a password expiring, at which the user is warned of the impending expiry. This is used by the OE Security
Manager to provide a means of warning the user in advance of the password expiry.
If NULL, then no warning period is configured, and therefore no indication of an impending password expiry is given. expirywarningtimedays:integer
The number of days before a password expiry at which a User will be warned of that impending expiry. expirywarningtimedstoffset:integer
The DST Offset applicable to the value of the existing expirywarningtime attribute. fullname:char
An optional attribute value allowing greater granularity on the identity of the user. isadminuser:bool
Used to define the user as an Iconics administrative user. This is used by the OE Security Manager to perform a privileged log on to the Iconics
Security Server, and apply any configuration changes automatically.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1487
OpenEnterprise Schema lastloggedin:datetime
Indicates in UCT the time at which the user last logged on to the
OpenEnterprise system. lastloggedindstoffset:integer
To be completed lastparentgroup:char
To be completed lastpasswordchange:datetime
The UCT time at which the last password change occurred for the user. lastpasswordchangedstoffset:integer
The DST Offset applicable to the value of the LastPasswordChange attribute value. lockedouttime:datetime
The UCT time at which the account lockout occurred. lockedouttimedstoffset:integer
The DST offset applicable to value of the lockedouttime attribute.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1488
OpenEnterprise Schema lockoutduration:integer
The length of time in minutes for which the account will remain locked out. If this attribute value is NULL or 0 then the lockout is permanent. lockouttimer:integer
A reference to the timer used to manage any lock out duration functionality for the user. logoffoedfile:char
If the user or user group has a special logged off .OED (OpenEnterprise
Desktop) file configured, this is a string defining the path and filename of the .OED file. It is loaded when the user logs off. logonattemptfailures:integer
This field is incremented by the OE Security Manager each time a user fails to logon to the OpenEnterprise system, generally because of an invalid password for instance. This attribute value in conjunction with the numberoflogonfailurespermitted attribute is then used to determine whether the users account should be locked out. On a successful log in for the user this attribute value is reset to 0. logonoedfile:char
If the user or user group has a special logged on .OED (OpenEnterprise
Desktop) file configured, this is a string defining the path and filename of the .OED file. It is loaded when the user logs on. maximumpasswordage:integer
Defines the length of time, in days after a password has been changed before that password is deemed to have expired. Changes of this value
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1489
OpenEnterprise Schema will automatically cause the expirytime attribute to be updated. maximumpasswordlength:integer
Indicates the maximum permitted length of the (unencrypted) password for the user. maximumusernamelength:integer
A shared attribute used to define the maximum permitted length for a users name. minimumpasswordage:integer
The minimum number of days after a password change has occurred, for a user before they are permitted to change the password again. minimumpasswordlength:integer
Indicates the minimum permitted length of the (unencrypted) password, for the user. minimumusernamelength:integer
A shared attribute used to define the minimum permitted length for a users name. mustchangepassword:bool
If set to TRUE then the user is expected to change their password the next time they log on to the system. A log on attempt will not be refused if this attribute is set for the user, but an appropriate journal message will be generated to indicate that the user is expected to change their
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1490
OpenEnterprise Schema password. Once a user has changed their password this attribute value is reset to FALSE. numberlogonfailurespermitted:integer
Defines the number of consecutive log on failures for the user, before that users account is locked out. numberoftimesloggedin:integer
The total number of times that the user has been logged on to the
OpenEnterprise system. parentgroup:char
The name of the Security Group to which the User belongs. CL will ensure that this attribute only ever contains a valid Group definition, and to prevent this attribute being set for any entry within the Users table whose Type attribute is set to IS_GROUP, since a Group may not belong to another Group. password:char
This attribute is only available if security has been included into the directory. The database configuration file can either include nosecurity.sql or security.sql. This attribute, if implemented, contains the confidential password for each user. totaltimeloggedin:datetime
Holds the total time that a user has been logged on to the
OpenEnterprise system. This attribute is updated each time the user logs off from OpenEnterprise. type:integer8
Indicates if the entry is for a User or Group. The values are defined by integer constants which are defined in the constants.cl file as:
0 = IS_USER
1 = IS_GROUP
2 = IS_DEFAULTGROUP
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1491
OpenEnterprise Schema
usersnameonly
Derived From:
Description:
<Base Table>
This table is used to provide clients with the ability to query the database for all users without also having the ability to obtain the passwords. It is kept up to date with the users table by CL.
There is also a usersnameonly view, which is actually a view on the users table, containing the accessarea, name and type attributes.
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. name : char Primary Key
Allows this users account to be disabled, meaning that the user cannot log on to the OpenEnterprise system.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1492
views
Derived From:
Description:
OpenEnterprise Schema
Tables
The definitions of all views in the database. Views are created on security enabled OpenEnterprise SCADA systems to implement Workstation security by basing the created view on the logged in user and the Access
Areas allowed to that user (see accessarea). All Workstation components should fetch data from these Views, and not the original tables. This is one reason why OpenEnterprise Workstation HMI components are referred to as Views (e.g. 'Alarm View', 'Trend View' etc). Views drop the '_table' extension, and are all displayed in the Database Explorer as if they were base tables.
Attributes: value : char
The SQL string that defines the view.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1493
workstation
OpenEnterprise Schema
Derived From:
Description:
The workstation table is used to manage and generically handle multiple database connections from the same computer, for the purposes of user account management and journalling.
An entry in this table will be created automatically when the first socket connection from a workstation/computer occurs to a database, although entries can be created manually if required.
<Base Table>
Attributes: accessarea : char
The access area to which this object belongs. Used with security enabled views to restrict access for unauthorised users. connected : bool default FALSE
Indicates whether any connections exist for the workstation table entry. connectiontime : datetime
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1494
OpenEnterprise Schema
Indicates the UCT time that the first database connection from the workstation occurred. connectiontimedstoffset : integer
The DST offset applicable to the value of the connectiontime attribute value. ipaddress : char
The IP Address in standard nnn.nnn.nnn.nnn format. e.g. 101.100.0.68.
This is the primary key column for the Workstation table. lastusername : char references users
Indicates the previous user of the workstation, and is used predominantly for journalling. loggedon : bool default FALSE
Indicates whether a user is currently logged on to the workstation. logoff : bool default FALSE
An input field allowing a user to log off all database connections for a single workstation. name : char
The name of the workstation connection, if available. This is obtained via the env attribute value of the dataconnection table, or can be manually defined if required.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1495
OpenEnterprise Schema numberofconnections : integer default 0
The number of current database connections for the workstation. userchangetime : datetime
The UCT time of the last change of user, (either log on or off) for the workstation. userchangetimedstoffset : integer
The DST offset applicable to the value of the userchangetime attribute value. username : char references users
The current user of the workstation.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1496
3 Appendices
OpenEnterprise Schema
Appendix B – Security Enabled Views
To enable object based security OpenEnterprise makes use of security enabled views to filter items by access area. An access area is a notional grouping of data that allows access to objects to be limited. Each object in the database is allocated an access area, and users are then associated with access areas.
Using the
table a user can be associated with one or more access areas. When a new user is created, the application
CL
will automatically add an association between that user and the access area ALL. If no access area is specified for object inserted into the database then the application CL will ensure that this object is assigned to access area ALL.
When a new access area object is inserted into the
accessareaconfig table, the application CL will
add a new association between that access area and the user SYSTEM. This ensures that the
SYSTEM user can see all objects in the database.
Using security enabled views it is not possible to allow a user to have write access to one object in a table, but only read access to all other objects.
By default the OpenEnterprise schema build file alltables. sql
includes the file views_security.sql, this file enables security enabled views. To disable this functionality it is necessary to replace this include with views_nosecurity.sql.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1497
OpenEnterprise Schema
Appendix A – Auto-IDPrimary Keys
For some tables the primary key attribute, id, is auto-generated in the
CL
“on create” handler for that table. As all primary key attributes are defined as “not null” it is necessary to specify a value for theid attribute when inserting an object into such a table. To avoid conflicts with existing objects the id attribute must always be set to 0.
For example: insert into tobescheduled (accessarea, id, description, tablename, tableentry, tableentryvalue, triggeronname, triggeronvalue, triggeroffname, triggeroffvalue, usesthisinfo) values ('ALL', 0,
'ControlCurveTest1', 'oeschedulertest_table', 'id', '1', 'value', '0', 'value', '0',
'ControlCurveTestDiary1')
To enable the allocation of auto-id attributes two hidden attributes nextid and quantity are included in each such table. To ensure correct operation of the auto-id functionality, these attributes must not have their value changed.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010 - Page 1498
4 Glossary
OpenEnterprise Schema
C
CL: Command Language: Object oriented programming language that manipulates table values when database transactions occur, providing functionality and database integrity.
D
DML: Data Manipulation Language. Sql statement that makes one or more database object changes but does not make any schema changes.
S
QL: Structured Query Language. A language used by relational databases to query, update, and manage data.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010
5 Index
A abcomplex ................................................... 3 abdevice ...................................................... 5 abdevicehealthalarmcondition................... 10 abdigital ..................................................... 11 abdriver ..................................................... 12 abintegeranalog ........................................ 16 abnetwork.................................................. 17 abpolllist .................................................... 19 abrealanalog ............................................. 22 accessarea ................................................ 24 accessareaconfig ...................................... 26 accessareaconfigforuser ........................... 28 adminuser.................................................. 30 alarmcondition ........................................... 31 alarmconditionlookup ................................ 39 alarminhibitalarmcondition ........................ 41 alarminhibitstatealarmcondition ................ 42 alarmmailformat ........................................ 43 alarmpagingformat .................................... 44 alarmpagingrecipient................................. 46 alarmpattern .............................................. 48 alarmpriorityblock ...................................... 51 alarmrecipient............................................ 57 alarmredirection ........................................ 59 alarmredirectiontimer ................................ 63 alarmresponseaction................................. 64 alarmresponseactionemail ........................ 66 alarmresponseactiongroup........................ 67 alarmsummary .......................................... 68 alarmsuppressiontimer.............................. 82
Appendix A – Auto-ID Primary Keys ..... 1704
Appendix B – Security Enabled Views.. 1703 arbitrator .................................................... 84 archivebackupitem .................................... 85 archivebackupset ...................................... 87
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema archivecatalogue....................................... 89 archivefile.................................................. 94 archiveindex.............................................. 96 attributes ................................................... 98 attributetrigger......................................... 101 auto-idprimary keys............................... 1704 autologouttimer ....................................... 105
B backupline............................................... 109 backuplinestats ....................................... 115 binarysignal............................................. 118 breakpoint ............................................... 120 bsapline................................................... 122
C calculation ............................................... 128 calculationcallbacktimer .......................... 133 calculationstatusalarmcondition.............. 134 calendarevents........................................ 136 calendareventsfordiary ........................... 138 clcontrol................................................... 140 column_privileges ................................... 141 connection_config ................................... 144 controlcurve ............................................ 146 currentuser.............................................. 148
D databasereplication................................. 150 databasetimestatus................................. 153 dataconnection........................................ 156 dataquery ................................................ 162 dataquerymonitor .................................... 165 dataservice.............................................. 167 datetimearchiveindex .............................. 169 dbcontrol ................................................. 171 devicestatscallbacktimer ......................... 173 diary ........................................................ 174 digital....................................................... 181 digitalalarmcondition ............................... 184 digitalchangetonullalarmcondition........... 185 digitaldelayalarmcondition ...................... 186
Reference Guide
D301521X412
24-Feb-2010 - Page 1500 digitaldelaytimer ...................................... 187 digitalsignaltrigger ................................... 188 digitalstatealarmcondition........................ 189 dstinformation.......................................... 190 dsttimer.................................................... 192 dvi_datum................................................ 194 dvi_device ............................................... 197 dvi_driver................................................. 202 dvi_network ............................................. 205 dvi_region................................................ 207 dvi_remote_driver ................................... 208 dvi_schedule ........................................... 210
E emailserver.............................................. 212 eventhistory ............................................. 215 eventlog................................................... 226 eventperiods............................................ 237 eventreplication ....................................... 240 exception ................................................. 243 exceptionhandler..................................... 244 exclusions................................................ 245 expirywarningtime ................................... 246
F ftpserver .................................................. 247
G groups ..................................................... 249
I indexattrs................................................. 251 indexes .................................................... 253 integeranalog .......................................... 255 integeranalogalarmcondition ................... 258 integeranalogchangetonullalarmcondition259 integeranalogchangevaluealarmcondition260 integeranalogdeviationalarmcondition .... 261 integeranalogequalsalarmcondition ........ 262 integeranaloglimitalarmcondition ............ 263 integeranalograteofchangealarmcondition265 integeranalogsignalalarmcondition ......... 267 integeranalogsignaltrigger....................... 269
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema integerarchiveindex................................. 270 ipline........................................................ 272
J journalalarmcondition.............................. 274 journalcontrol .......................................... 275 journalequalalarmcondition..................... 277 journalrangealarmcondition .................... 278 journaltask............................................... 280
K klaxon...................................................... 284
L line........................................................... 288 localdigital ............................................... 292 localintegeranalog................................... 294 localmultidigital2...................................... 296 localmultidigital3...................................... 298 localmultidigital4...................................... 299 localrealanalog........................................ 300 localstringsignal ...................................... 302 localtimesignal ........................................ 304 lockouttimer............................................. 306 logaccess ................................................ 307 logarchive................................................ 310 logcolumn................................................ 314 logcontrol ................................................ 317 logdata .................................................... 322
Logextract ............................................... 328 loghistory......................................... 331, 333
Logobject ................................................ 335 logworker ................................................ 336
M mailformat ............................................... 338 memoryalarmcondition ........................... 339 memorymonitor ....................................... 340 memorymonitorcallbacktimer .................. 342 multidigital2 ............................................. 343 multidigital3 ............................................. 345 multidigital4 ............................................. 346 multistatedigitalalarmcondition................ 347
Reference Guide
D301521X412
24-Feb-2010 - Page 1501
N notes........................................................ 349 notesalarmcondition ................................ 355 nw3000alarmprioritymap......................... 356 nw3000analogpolllist............................... 357 nw3000archive ........................................ 358 nw3000audit ............................................ 360 nw3000device ......................................... 362 nw3000devicecommunicationalarmcondition
............................................................. 385 nw3000devicestatusalarmcondition ........ 386 nw3000deviceversionalarmcondition ...... 387 nw3000digital .......................................... 388 nw3000digitalalarmcondition................... 393 nw3000digitalpolllist ................................ 394 nw3000driver........................................... 395 nw3000network ....................................... 407 nw3000polllist.......................................... 409 nw3000questionablealarmcondition........ 413 nw3000realanalog................................... 415 nw3000realanalogalarmcondition ........... 426 nw3000rollingscantimer .......................... 427 nw3000string ........................................... 428 nw3000stringpolllist................................. 431 nw3000stringsignal ................................. 428
O objectnotes .............................................. 432 objects ..................................................... 433 objectsextension ..................................... 440 objectsuppressiongroup .......................... 441 oelogaccess ............................................ 442 oelogarchive ............................................ 443 oelogcolumn ............................................ 445 oelogcontrol............................................. 447 oelogdata................................................. 448 oelogdataextension ................................. 452 oelogextract............................................. 454 oelogworker............................................. 455 oeprinter .................................................. 456 oeprinteralarmcondition........................... 460
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema oeprintergroup......................................... 461 oeprintergroupalarmcondition ................. 464 oeprinterrelationship ....................... 465, 467 oetimer .................................................... 469 opcdevice................................................ 471 opcdriver ................................................. 473 opcgroup ................................................. 475 opcitemdigital .......................................... 478 opcitemintegeranalog ............................. 481 opcitemrealanalog................................... 484 opcitemstring........................................... 487 opcserver ................................................ 490
OpenEnterprise Schema Introduction......... 1
P pattern..................................................... 493 patterngroup............................................ 494 plantarea ................................................. 495 publishedreport ....................................... 497 publishedreporttoaliaslookup .................. 502
Q questionablealarmcondition .................... 504 questionableequalsalarmcondition ......... 505 questionablerangealarmcondition........... 506
R realanalog ............................................... 507 realanalogalarmcondition........................ 510 realanalogchangetonullalarmcondition ... 511 realanalogchangevaluealarmcondition ... 512 realanalogdeviationalarmcondition ......... 513 realanalogequalsalarmcondition ............. 514 realanaloglimitalarmcondition ................. 515 realanalograteofchangealarmcondition... 517 realanalogsignalalarmcondition .............. 519 realanalogsignaltrigger ........................... 521 realarchiveindex...................................... 522 recipient .................................................. 524 recipientassociations............................... 526 recipientgroup ......................................... 528 recipientusernotes................................... 529
Reference Guide
D301521X412
24-Feb-2010 - Page 1502 redundancy ............................................. 542 redundancyalarmconditiona .................... 546 redundancyalarmconditionb .................... 547 remotedataservice................................... 548 remotedataservicealarmcondition ........... 551 remotedataservicetimer........................... 552 remotedigital............................................ 553 remoterealanalog .................................... 554 report ....................................................... 555 reportalarmcondition ............................... 561 reportcreation .......................................... 562 reportequalsalarmcondition..................... 566 reportformat............................................. 567 reportformatalarmcondition ..................... 572 reportformatequalsalarmcondition .......... 573 reportformatrangealarmcondition............ 574 reportformattorecipientlookup ................. 575 reportrangealarmcondition ...................... 577 reportrecipient ......................................... 578 reportrecipientalarmcondition.................. 580 reportrecipientemail................................. 581 reportrecipientequalsalarmcondition ....... 582 reportrecipientfilecopy ............................. 583 reportrecipientftpcopy.............................. 585 reportrecipientrangealarmcondition ........ 587 reportschedule ........................................ 588 reportschedulealarmcondition ................. 591 reportscheduleequalsalarmcondition ...... 592 reportscheduler ....................................... 593 reportschedulerangealarmcondition........ 597 reportscheduletimed................................ 598 reportschedulevaluechange .................... 602 reporttemplate ......................................... 605 reporttoaliaslookup.................................. 607 reporttoformatlookup ............................... 610 reporttoschedulelookup........................... 612 rocacinputoutputmodule.......................... 614 rocadvancedpulsemodule ....................... 622 rocalarmcondition.................................... 640 rocalarmlog ............................................. 641
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema rocbasedatum ......................................... 647 rocblmuserlistparameters ....................... 650 rocchannel .............................................. 652 rocchannelalarmcondition....................... 662 rocchannelset.......................................... 663 rocchannelsetalarmcondition .................. 665 rocchannelsetallocation .......................... 666 rocchanneltypes...................................... 668 rocchartuserlistparameters ..................... 669 roccheckconfiguration ............................. 672 rocdatatypes ........................................... 678 rocdevice................................................. 680 rocdevicealarmcondition ......................... 697 rocdevicechannelcomms ........................ 699 rocdevicecommsroute............................. 701 rocdeviceipcomms .................................. 711 rocdigital.................................................. 713 rocdriver .................................................. 717 rocdriveralarmcondition .......................... 725 rocds800configuration ............................ 726 rocenhancedcommmoduleconfiguration. 734 rocenumeratedvaluedescriptions............ 738 rocenumeratedvaluedescriptions2.......... 741 rocenumeratedvaluedescriptions3.......... 743 rocerrorcodelog....................................... 745 roceventlog ............................................. 748 rocexpandedioinformation ...................... 755 rochartparameters................................... 758 rochistorylog............................................ 799 rochistorypoint......................................... 803 rochistorysegmentconfiguration.............. 810 rocinformationforuserdefinedpoints ........ 814 rocinternetconfigurationparameters ........ 816 rocjournaltypes................................ 820, 822 roclicensekeyinformation ........................ 824 roclinkparameterroctypeversion.............. 827 roclogon .................................................. 829 roclogonparameters ................................ 830 rocmodbuseventalarmandhistory............ 837 rocmodbusmastermodemconfiguration .. 859
Reference Guide
D301521X412
24-Feb-2010 - Page 1503 rocmodbusmastertable............................ 862 rocmodbusregistertotlpmapping.............. 888 rocnetwork............................................... 912 rocoedbfieldtypes .................................... 913 rocorificemeterrunconfiguration .............. 914 rocorificemeterrunvalues......................... 923 rocparameterpattern................................ 931 rocparameterpatternpoint........................ 933 rocparameters ......................................... 935 rocplusanaloginputs ................................ 941 rocplusanalogoutputs .............................. 949 rocplusclock ............................................ 953 rocpluscommports................................... 956 rocplusconfigurableopcode ..................... 967 rocplusdiscreteinputs .............................. 995 rocplusdiscreteoutputs ............................ 999 rocplusfstparameters............................. 1005 rocplusfstregistertags ............................ 1012 rocplushistorypoint ................................ 1015 rocplusmodbusconfigurationparameters1018 rocplusmultivariablesensor.................... 1025 rocpluspidcontrolparameters................. 1037 rocpluspowercontrolparameters............ 1052 rocpluspulseinputs ................................ 1057 rocplusrtd............................................... 1063 rocplussoftpointparameters................... 1070 rocplussystemanaloginputs................... 1078 rocplussystemvariables......................... 1083 rocplusthermocouple............................. 1095 rocplususerdefineddatatypes ................ 1099 rocpoint.................................................. 1101 rocpointalarmcondition .......................... 1106 rocpointtypes ......................................... 1108 rocpointwritetimeout .............................. 1112 rocportparameters................................. 1113 rocprotocoltypes.................................... 1119 rocreadalarmdata .................................. 1120 rocreadclock .......................................... 1126 rocreadconfigurableopcodedata ........... 1129 rocreadeventdata .................................. 1131
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema rocreadhistorydata ................................ 1137 rocreadhistorypointsconfig.................... 1139 rocreadpointparameters........................ 1143 rocreadspecifiedparameters ................. 1145 rocreadusertemplatedata...................... 1146 rocrealanalog ........................................ 1150 rocrequest ............................................. 1154 rocrequesttypes .................................... 1158 rocsamplerodorizorparameters............. 1160 rocschedule........................................... 1163 rocschedulestatistics............................. 1166 rocsecuritygroupconfiguration............... 1170 rocsmartiomoduleinformation800 ......... 1174 rocstandardagaflowcalculationvalues ... 1177 rocstandardagaflowparameters ............ 1189 rocstandardanaloginputcalibrationparameters
.......................................................... 1200 rocstandardanaloginputs ...................... 1204 rocstandardanalogoutputs .................... 1211 rocstandardbatteryparameters.............. 1213 rocstandardclock................................... 1216 rocstandardcommports ......................... 1219 rocstandardconfigurableopcode ........... 1226 rocstandarddiscreteinputs..................... 1254 rocstandarddiscreteoutputs .................. 1258 rocstandardextrarunparameters ........... 1261 rocstandardflags ................................... 1266 rocstandardfstparameters ..................... 1274 rocstandardhistorypoint ........................ 1279 rocstandardlocaldisplaypanel ............... 1281 rocstandardlogonsecuritiesparameters. 1284 rocstandardmetercalibrationandsampler1286 rocstandardmeterconfigurationparameters
.......................................................... 1290 rocstandardmeterflowvalues................. 1309 rocstandardmodbusconfigurationparameters
.......................................................... 1323 rocstandardmodbusfunctiontables........ 1327 rocstandardmodbusspecialfunctiontable1344 rocstandardmoduleinformation ............. 1362 rocstandardmultivariablesensor............ 1368
Reference Guide
D301521X412
24-Feb-2010 - Page 1504 rocstandardpidcontrolparameters ......... 1377 rocstandardpidparameters .................... 1387 rocstandardpowercontrolparameters .... 1396 rocstandardpulseinputs ......................... 1400 rocstandardreadgeneralupdate ............. 1405 rocstandardreadpointers ....................... 1407 rocstandardreadsysteminformation....... 1411 rocstandardrevisioninformation ............. 1414 rocstandardrunparameters.................... 1416 rocstandardsoftpointparameters ........... 1437 rocstandardsystemvariables ................. 1441 rocstandardtankparameters .................. 1446 rocstandarduserdefineddatatypes......... 1451 rocstandarduserlistparameters ............. 1453 rocstationparameters .................. 1469, 1481 rocstring................................................. 1493 rocsystemparameters............................ 1495 rocsystemparametersaccessarea ......... 1497 rocsystemparametersalarmpriority........ 1498 rocsystemparametersbool..................... 1499 rocsystemparametersdriver................... 1500 rocsystemparametersinteger................. 1501 rocsystemparametersplantarea ............ 1502 rocsystemparametersportparameters ... 1503 rocsystemparametersschedule ............. 1504 rocsystemparametersstring................... 1505 roctime................................................... 1506 rocturbinemeterrunconfiguration ........... 1508 rocturbinemeterrunvalues ..................... 1520 roctypes................................................. 1528 rocusercconfiguration............................ 1531 rocuserdefinedpoint............................... 1535 rocuserprogramconfiguration ................ 1536 rocversion.............................................. 1538 rocwriteclock ......................................... 1540 routine ................................................... 1541 runsqlscript ............................................ 1543 runsqlscripterroralarmcondition............. 1546 runtimeexception................................... 1547
S
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
OpenEnterprise Schema scheduleevents ..................................... 1548 schedulepattern .................................... 1550 schemahelp........................................... 1553
Security Enabled Views ........................ 1703 securityreplication ................................. 1555
Selfusernotes ........................................ 1558
Senderusernotes................................... 1571 signal..................................................... 1584 signalattributetrigger ............................. 1596 signalextension ..................................... 1597 signalnotes............................................ 1598 signalsuppressiongroup ........................ 1599 sqlprocedure ......................................... 1600 stringsignal............................................ 1602
Stringsignaltrigger ................................. 1604 suppressiongroup ................................. 1605 suppressiongroupdelaytimer................. 1608 suppressiongrouplookup....................... 1609
Suspendedthread.................................. 1611
T table_privileges ..................................... 1613 tablegroups ........................................... 1617 tables .................................................... 1618 tcpconnection........................................ 1621 tcpserver ............................................... 1622 telephonenumber .................................. 1623 time ....................................................... 1625 timedarchive.......................................... 1627 timer ...................................................... 1632 timezones.............................................. 1634 tobescheduled....................................... 1636 token ..................................................... 1640 tokenaccess .......................................... 1642 tokengroup ............................................ 1644 tokengroupaccess................................. 1646 triggersqlprocedure ............................... 1648 triggersqlprocedureerroralarmcondition 1651 triggersqlproceduretimer ....................... 1652
U udpmsg ................................................. 1654
Reference Guide
D301521X412
24-Feb-2010 - Page 1505 udpport .................................................. 1655 useraccess ............................................ 1656 userconfig.............................................. 1668 usergroups ............................................ 1679 userlockout ............................................ 1680 usernotes............................................... 1682 users.............................................. 561, 1683 usersnameonly ...................................... 1695
V views ..................................................... 1703
W workstation ............................................ 1698
OpenEnterprise Schema
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D301521X412
24-Feb-2010
OpenEnterprise Schema
DISCLAIMER
Bristol, Inc., Bristol Babcock Ltd, Bristol Canada, BBI SA de CV and the Flow Computer Division , are wholly owned subsidiaries of Emerson Electric Co. doing business as Remote Automation Solutions (“RAS”), a division of Emerson Process Management. ROC, FloBoss, ROCLINK, Bristol, Bristol Babcock, ControlWave, TeleFlow and
Helicoid are trademarks of RAS. AMS, PlantWeb and the PlantWeb logo are marks of Emerson Electric Co. The Emerson logo is a trademark and service mark of the
Emerson Electric Co. All other marks are property of their respective owners.
The contents of this publication are presented for informational purposes only. While every effort has been made to ensure informational accuracy, they are not to be construed as warranties or guarantees, express or implied, regarding the products or services described herein or their use or applicability. RAS reserves the right to modify or improve the designs or specifications of such products at any time without notice. All sales are governed by RAS’ terms and conditions which are available upon request. RAS does not assume responsibility for the selection, use or maintenance of any product. Responsibility for proper selection, use and maintenance of any RAS product remains solely with the purchaser and end-user.
Engineered and supported by:
Remote Automation Solutions,
Blackpole Road, Worcester, WR3 8YB, UK
Registered office: Meridian East, Leicester, LE19 1UX
Registered in England and Wales, Registration No. 00671801
VAT Reg No. GB 705 353 652
Emerson Process Management
Remote Automation Solutions
1100 Buckingham St
Watertown, CT 06795
T 1 (860) 945 2200
F 1 (860) 945 2278 www.EmersonProcess.com/Remote [email protected]
Emerson Process Management
Remote Automation Solutions
Blackpole Road
Worcester, WR3 8YB
T 44 (0) 1905 856848
F 44 (0) 1905 856930 www.EmersonProcess.com/Remote [email protected]
© 2010 Remote Automation Solutions, division of Emerson Process Management. All rights reserved.
advertisement
Key Features
- Centralized data management
- Real-time data access
- Customizable dashboards
- Automated alarms and notifications
- Remote access and control
- Scalable architecture
- Integration with other systems
Related manuals
Frequently Answers and Questions
What are the benefits of using OpenEnterprise Schema?
What is the cost of OpenEnterprise Schema?
How do I get started with OpenEnterprise Schema?
advertisement