Analog table details

accessFlag

displayname

This flag is used by easy eXtended Operator Station (ezXOS) to determine whether or not someone is modifying a table through the Advanced Database Editor (ADE). If so, no one else can have access to modify it.

alertList

alertTypeAna

A structure of information about fields associated with the Email Alarm Notification application. Some of the fields in the structure are described below.

alertList.alertGrp

alertGroupslot

The name of the alertGroup record containing the Controllers and/or Administrators who will receive messages about alarms associated with this point.

alertList.almType

oas_boolean_t

Are the alarms associated with this point AVEVA Enterprise SCADA-related?

alertList.enable

oas_boolean_t

Enable the record for email alarm notification?

alertList.enStates

bool14

The types of alarms that will generate email messages.

almLimitSet

alarmlimitsetslot

The name of the alarmlimitset record to use for the alternative set of alarm limits.

Alter_units

egutext

The destination units.

anain

anainput

A structure of information about an analog input. Some of the fields in the structure are described below.

anain.type

analogtype

This field indicates type of the analog input data.

anain.iospec.external

pntIOSpec

This field indicates the analog input data coordinates.

anain.iospec.pollGroup

longstring

A text string that may consist of multiple comma-separated values to define the frequency poll groups to which the point belongs.

anain.iospec.rtudd

analog_rtudd

This field is used in configuring the retrieval of an analog point's history from a Remote Terminal Unit (RTU).

anain.excdeadband

unsigned int

Modifications of this field will trigger a virtual function named DOWNLOAD. Individual protocols may implement protocol-specific functionality for this download command, while the default behavior is for no action to be taken.

anain.pdmtyp

pdmtype

The pulse duration meter type.

anaout

anaoutput

This field indicates a structure of information about an analog output. Some of the fields in the structure are described below.

anaout.iospec.external

pntIOSpec

The analog output data coordinates.

applyLFilter

oas_boolean_t

Apply a filter to the telemetry/calculated values to smooth out brief fluctuations?

assetId.assetIdComment

string32

A string used for customer-specific purposes.

assetId.assetIdDesc

string32

A string used for customer-specific purposes.

assetId.assetIdLoc

string32

A string that uniquely identifies the device for asset-management purposes.

avg

averages

This field shows a structure of information about averaging data. Some of the fields in the structure are described below.

avg.doit

oas_boolean_t

Perform data averaging on this point?

avg.hour.current

anaDatatype

Current hourly data average

avg.day.current

anaDatatype

Current daily data average

avg.month.current

anaDatatype

Current monthly data average

avg.shift.current

anaDatatype

Current shift data average

avg.hour.previous

anaDatatype

Previous hourly data average

avg.day.previous

anaDatatype

Previous daily data average

avg.month.previous

anaDatatype

Previous monthly data average

avg.shift.previous

anaDatatype

Previous shift data average

avg.sum

double

Working summation

ave.wt

double

Number of entries/weights

cmdfail

oas_boolean_t

Did the last command fail?

cmd_time

internaltime

Last time a command was issued to this device

commandOrder

int

The order in which the system issues a command against the point if it belongs to a multiControlGroup record.

controlscan.external

IOspecString

The control scan external input/output specifier.

controlscan.freq

unsigned int

The delay in seconds between each control scan.

controlscan.interval

unsigned int

The control scan duration.

creep

pntcreep

This field shows a structure of information about creep alarming. Some of the fields in the structure are described below.

creep.doit

oas_boolean_t

Does creep detection alarming occur for the device?

creep.devlim

float

The maximum deviation value, in engineering units, that is allowed before a creep alarm occurs.

creep.lstdev

float

This field shows the creep setpoint. This is automatically set on startup, and upon creep level violation.

curspt

anaDatatype

This field shows the analog’s current setpoint value in engineering units.

curval

anaDatatype

Analog’s current value

dataset

doas_dset_slot

This field indicates the dataset to which the record is assigned. Datasets are used to associate the record with the privileges assigned for each system mode. Once a record is assigned to a dataset value, the dataset can only be changed to a value for which the system has a privilege record.

description

description

A description of this analog point, up to 47 characters in length.

devtmr

unsigned short

The maximum number of seconds allowed to elapse, between a command to the setpoint and its response, before the command is considered to have failed.

displayOrder

int

This field is used for display purposes. It would only be used if the nomination information were being represented on a station template object. It is only relevant to systems that have this optional software component. Unless you specifically use the Display Framework, the value is not used.

The default value is 0.

dnAlarmLimits

alarmlimitslot

The alarmlimit record containing up to 10 alarm limits to download to the RTU via setpoint commands (protocol-specific).

dnAlarmLimitsEnable

oas_boolean_t

Enable the download of up to 10 alarm limits contained in an alarmlimit record to the RTU via setpoint commands (protocol-specific).

enable_procdb

oas_boolean_t

Associate the point with a processing deadband?

filterConstant

float

A constant that determines the effect of data-fluctuation smoothing on analog inputs.

flag

flags

For information on the flag structure, see Flag structure details.

group

groupslot

This field shows the group that this point is associated with for alarming.

highCutoff.enable

oas_boolean_t

Enable the high cutoff limit?

highCutoff.limit

float

The high cutoff limit.

highCutoff.replacement

float

The high cutoff replacement value.

hilow

pnthilow

A structure of information about alarm checking, and deadband. Some of the fields in the structure are described below.

hilow.insf_enab

oas_boolean_t

Should the associated remote should check for high or low instrument failure?

hilow.InstrFail_deadband

double

The deadband value to apply to the instrument’s lower and upper raw operating limits (iengr.egumin and iengr.egumax, respectively).

hilow.dead

float

The amount, in engineering units, by which the device must return towards normal after crossing the high or low alarm limit before it is technically out of an alarm state.

hilow.doit

oas_boolean_t

Does high/low alarming occur for this device?

hilow.doithi

oas_boolean_t

Does high alarming occur for the device?

hilow.doithihi

oas_boolean_t

Does high-high alarming occur for the device?

hilow.doitlo

oas_boolean_t

Does low alarming occur for the device?

hilow.doitlolo

oas_boolean_t

Does low-low alarming occur for the device?

hilow.lolim

float

This field shows the lowest value allowed for the device before a low alarm occurs.

hilow.hilim

float

This field shows the highest value allowed for the device before a high alarm occurs.

hilow.doitdoit

oas_boolean_t

Does high-high/low-low alarming occur for the device?

hilow.lololim

float

This fields shows the lowest value allowed for the device before a low-low alarm occurs.

hilow.hihilim

float

This field shows the highest value allowed for the device before a high-high alarm occurs.

hilow.doitroc

oas_boolean_t

Does rate-of-change (ROC) alarming occur for the devices?

hilow.deltatime

long

The time interval over which the system should calculate the rate of change.

hilow.lastval

float

The value at the last poll for rate-of-change calculation.

hilow.negroclim

float

The maximum, negative allowable ROC (EGUs per second).

hilow.roclim

float

This field shows the highest rate that the value for the device is allowed to change by before a ROC alarm occurs.

hilow.roc_method_used

ROC_method

The type of ROC alarming to use.

hilow.rocval

float

Rate of change (per second).

hilow.timeofchange

internaltime

Updates if new curval != old curval.

hilow.flattimeout

unsigned short

Flat line alm timeout value (min).

hilow.doitflat

oas_boolean_t

Enable flat line alarm checking.

hilow.inFlatState

oas_boolean_t

Currently in a flat line alarm state.

hilow.doituhi

oas_boolean_t

Enable a user-defined high alarm limit.

hilow.uhi

float

The user-defined high alarm limit.

hilow.doitulo

oas_boolean_t

Enable a user-defined low alarm limit.

hilow.ulo

float

The user-defined low alarm limit.

hilow.setpdoit

oas_boolean_t

Enable the setpoint creep alarm.

hilow.setCreeplim

float

When the current value of an analog point deviates this much beyond the commanded setpoint, the system generates an alarm.

hilow.bracketstate

almBracketState

The state of the bracket alarm. The values align with the enumeration almBracketState.

hilow.doitBracketNeg

oas_boolean_t

Enable a negative bracket alarm.

hilow.bracketLimitNeg

float

The amount to which the current value can drop below the reference value without generating an alarm.

hilow.doitBracketPos

oas_boolean_t

Enable a positive bracket alarm.

hilow.bracketLimitPos

float

The amount to which the current value can exceed the reference value without generating an alarm.

iengr

engrunits

This field is a structure of information about the engineering units that are associated with an analog input. The fields in the structure are described below.

iengr.scaleraw

oas_boolean_t

Convert the raw data from an analog input into engineering units?

iengr.rawmin

float

This field shows the instrument’s raw lower operating limits.

iengr.rawmax

float

Instrument’s raw upper operating limits.

iengr.egumin

float

Lowest value the instrument is capable of measuring, in engineering units.

iengr.egumax

float

Highest value the instrument is capable of measuring, in engineering units.

ignore_cmd_feedback

oas_boolean_t

When selected, no command warning tags will be placed on the point and no command timeout alarms will generated after the command is successfully sent to the remote device. The settings for fields devtmr, tolerance, and lgcmsc will be ignored.

input

oas_boolean_t

Are there analog input coordinates for this devices?

interlock.anaenable

oas_boolean_t

Enable the triggering of a Control Interlock when interlock.anastate matches the flag.msgtxt field of interlock.anaslot.

interlock.anaslot

analogslot

The name of the analog point whose flag.msgtxt field is used to determine whether or not a Control Interlock is triggered.

interlock.anastate

msgstring

The interlock analog state string.

interlock.multistaenable

oas_boolean_t

Enable the triggering of a Control Interlock when interlock.multistastate matches the flag.msgtxt field of interlock.multistaslot.

interlock.multistaslot

multistateslot

The name of the multistate point whose flag.msgtxt field is used to determine whether or not a Control Interlock is triggered.

interlock.multistastate

msgstring

The interlock multistate state string.

interlock.staenable

oas_boolean_t

Enable the triggering of a Control Interlock when interlock.stastate matches the flag.msgtxt field of interlock.staslot.

interlock.staslot

statusslot

The name of the status point whose flag.msgtxt field is used to determine whether or not a Control Interlock is triggered.

interlock.stastate

msgstring

The interlock status state string.

interlock.warn

oas_boolean_t

Should Controllers receive a command confirmation dialog box when they attempt to issue a command?

isCriticalPoint

oas_boolean_t

Is this a critical point?

Note: This field is related to the Critical Alarms feature. Refer to Critical Alarms for more information.

lastKrunchTime

internaltime

Records the last time that the point was "krunched" (that is, the last time that gen* [genrem, gensta, genrat, or genana] was run. These routines are run when a point’s current value is changed.)

lgcmsc

oas_boolean_t

Should a "success" command be logged when a Controller-commanded change of state occurs?

limit

float

The cutoff limit value.

lowCutoff.enable

oas_boolean_t

Enable the low cutoff limit?

lowCutoff.limit

float

The low cutoff limit.

lowCutoff.replacement

float

The low cutoff replacement value.

maxalmpark

unsigned int

The maximum allowable park time for alarms associated with this point.

name

pntname

The unique name of this analog record. The name can be up to 32 characters in length.

nsmooth

bufferrange

The number of readings that the Jitter Smoothing application should use in calculating the arithmetic mean.

onoffdelay

ontologically

A structure of information about the on- and off-delay time in seconds for various alarm levels.

pntcnd_ptstale1

statusslot

Use a status point as a Sub-Remote Status Indicator stale point?

pointClass

configenumslot

The Point Class category contains multiple configuration enumerations used for categorical configuration of points.

pointSubClass

configenumslot

Point Sub Class is a configurable enumeration category used for categorical configurations, but you cannot use this for configurable alarms and events.

procdb

double

The processing deadband that the system uses to determine whether or not it should process a new value.

ptnum

unsigned char

This field represents the record’s slot number in the database.

oengr

engrunits

A structure of information about the engineering units that are associated with an analog output. The fields in the structure are described below.

oengr.scaleraw

oas_boolean_t

Should the raw data to an analog output be converted into engineering units?

oengr.rawmin

float

The instrument’s raw lower operating limit.

oengr.rawmax

float

The instrument’s raw upper operating limit.

oengr.egumin

float

The lowest value the instrument is capable of achieving, in engineering units.

oengr.egumax

float

The highest value the instrument is capable of achieving, in engineering units.

otype

analogtype

This field shows the type of analog output for this device.

output

oas_boolean_t

Are there analog output coordinates for this device?

pointtype

pointtype_enum

This field shows the type of analog point: telemetered, calculated, or manual entry.

prevval

double

Raw filtered value from the previous poll scan, used in the filtering calculation

qualityBit

qualitybit_enum

This field is used to configure a quality bit number for the point.

replacement

float

The cutoff replacement value.

rtu

remoteslot

Name of the remote that is associated with this field device.

repDeadband

float

The analog value is replicated to other hosts, by using the function subscription ANALOGRT, whenever the value moves beyond the deadband.

repLastSent

double

Last value that was replicated.

rve.alarmOnRuleFail

oas_boolean_t

Enables the generation of alarms if a rule in the rule set is violated.

rve.eventOnRuleFail

oas_boolean_t

Enables the generation of events if a rule in the rule set is violated.

rve.ruleEnabled

oas_boolean_t

Enables checking of the selected rule set when a point is commanded.

rve.ruleFailSeverity

sev_enum

The severity associated with alarms generated by RVE. The default severity is "high".

rve.ruleSet

rverulesetslot

The name of the associated rveruleset record.

rve.timeout

int

The number of milliseconds to allow RVE rule checking to complete.

setpointRampEnabled

oas_boolean_t

Enable the Setpoint Ramping application?

setpointRampMinimumTotalTime

int

The minimum amount of time that the Setpoint Ramping process must last.

shortDesc

stn_str32

A brief description of the record.

sptlolim

float

The lowest setpoint that the system allows a Controller to issue.

spthilim

float

Highest setpoint that the system allows a Controller to issue.

stateInhCfg.inh_inst_attr

oas_boolean_t

Specifies whether to inhibit instrument fail as attribute alarming.

stateInhibit

stateInhibits

A structure of information about the states on which to inhibit alarms.

station

stationslot

The name of the associated station record.

timestamp

internaltime

Time of the last input data processing

timeout

Secondtimerslot

Secondtimer slot number that is associated with this point for command failure detection.

tolerance

float

When a setpoint is commanded to a certain value the setpoint value must reach that value plus or minus the tolerance amount, in engineering units, before the command timeout period elapses, in order for the command to be considered successful.

TrendIndicator.Enabled

oas_boolean_t

Enable Trend Indicator Value calculation.

TrendIndicator.HighSpeedCoefficient

float

High speed coefficient for calculation.

TrendIndicator.LowSpeedCoefficient

float

Low speed coefficient for calculation.

TrendIndicator.Scale

float

Scaling factor for calculation.

TrendIndicator.Value

float

Current trend indicator value.

TrendIndicatorImage.FileName

displayname

The Trend Indicator image for current trend value.

TrendIndicatorImage.Set

trendIndicatorImageSet

The name of the trendIndicatorImageSet record that will be used to calculate the Trend Indicator image.

units

egutext

This field is a text string describing the engineering units that this point measures.

upAlarmLimits

alarmlimitslot

The alarmlimit record containing up to 10 alarm limits to upload from the RTU via setpoint commands (protocol-specific).

upAlarmLimitsEnable

oas_boolean_t

Enable the upload of up to 10 alarm limits contained in an alarmlimit record from the RTU via setpoint commands (protocol-specific).

useAlmLimitSet

oas_boolean_t

Enable alternative alarm limits.

useDeviceDQ

oas_boolean_t

When enabled, downstream krunch processes will base freshness on the data quality of the point when krunching the current value of the point.

wellunit

pntname

This field is used by Display Framework, a separately acquired product.