Rate table details

acccur

double

Current accumulator value.

This field is typically used to process pulse input values from a field device to calculate a rate value. However, when the point is set to be a calculated point, this field can be written to by a process (or manually) and have the same effect.

Writing to this field will trigger the rate value (currate) to be calculated automatically, when the Input Type (intype) is set to Pulse input, and Point Type (pointtype) is set to calculated.

In order for the rate calculation to work correctly, the Roll-over value (rollover) and Time between rate calculations (rate_period) need to be configured on the rate point. Refer to Rate table.

accessFlag

displayname

This flag is used by the easy eXtended Operator Station (ezXOS) to determine whether a table is being modified through the Advanced Database Editor (ADE). If the flag is set, access to the table is denied.

accin

anainput

This field provides a structure of information about an analog input.

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.

anain

anainput

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

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

analogtype

Data type of the analog input data.

anain.iospec.external

IOspecString

Coordinate numbers for the analog input.

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

pdmtype

Pulse duration meter type.

applyLFilter

oas_boolean_t

Applies a filter to telemetered/calculated values that smooths out brief fluctuations.

Alter_dunits

egutext

For an accumulator value, the units that appear in the dest field of the unitConv record that you want to associated with this rate record.

Alter_runits

egutext

For a rate value, the units that appear in the dest field of the unitConv record that you want to associated with this rate record.

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

internaltime

Time of last rollup.

avg.x.sum

double

Working summation.

ave.x.wt

double

Number of entries/weights.

creep

pntcreep

This field provides a structure of information about creep alarms. 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

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

creep.lstdev

float

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

currate

anaDatatype

Current rate.

description

pntdescription

Description of this rate record, up to 47 characters in length

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.

dunits

egutext

Units for accumulated quantity

enable_procdb

oas_boolean_t

Associate the point with a processing deadband?

engr

engrunits

Analog engineering units structure

engr.egumin

float

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

engr.egumax

float

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

engr.rawmin

float

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

engr.rawmax

float

Instrument’s raw upper operating limits.

engr.scaleraw

oas_boolean_t

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

filterConstant

float

A constant that determines the effect of data- fluctuation smoothing on rate value.

flag

flags

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

gas

gasflo

Gas flow calculation structure that is used for gas-type rate inputs.

gas.k

float

The gas scaling factor if scaling a gas flow rate.

gas.pressno

analogslot

The associated pressure analog record for this rate point.

gas.tempno

analogslot

The associated temperature analog record for this rate point.

group

groupslot

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

hilo

pnthilow

This field provides a structure of information about alarm checking, inhibits, and deadband. Some of the fields in the structure are described below.

hilo.insf_enab

oas_boolean_t

Does the associated remote have high or low instrument failure checking enabled?

hilo.InstrFail_deadband

double

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

hilo.dead

float

This field provides the deadband amount, in engineering units, by which the device must return towards normal after crossing the HiHi or LoLo alarm limit before it is technically out of that alarm state.

hilo.deltatime

long

The time interval over which the system should calculate the Rate Of Change (ROC).

hilo.doithi

oas_boolean_t

Does high alarming occur for the device?

hilo.doithihi

oas_boolean_t

Does high-high alarming occur for the device?

hilo.doitlo

oas_boolean_t

Does low alarming occur for the device?

hilo.doitlolo

oas_boolean_t

Does low-low alarming occur for the device?

hilo.doituhi

oas_boolean_t

Enable a user-defined high alarm limit.

hilo.uhi

float

The user-defined high alarm limit.

hilo.doitulo

oas_boolean_t

Enable a user-defined low alarm limit.

hilo.ulo

float

The user-defined low alarm limit.

hilo.lolim

float

Lowest value allowed for the device before a low alarm occurs.

hilo.hilim

float

Highest value allowed for the device before a high alarm occurs.

hilo.lololim

float

Lowest value allowed for the device before a low-low alarm occurs.

hilo.hihilim

float

Highest value allowed for the device before a high-high alarm occurs.

hilo.doitroc

oas_boolean_t

Does ROC alarming occur for the device?

hilo.negroclim

float

The maximum, negative allowable ROC (Engineering Units [EGUs] per second).

hilo.rateReasonEnable

oas_boolean_t

Enable the point for Rate Reasonability checking?

hilo.rateReasonHoldoffOverride

float

The value used in the equation that determines whether or not the system should cancel alarm suppression because of a large spike in a reported flow rate.

hilo.rateReasonHoldoffTime

long

The length of time in minutes that the system should suppress a generated alarm.

hilo.rateReasonLimit

float

The limit that the Rate Reasonability application compares against the point's incoming flow rate.

hilo.rocval

float

Rate of change (per second)

hilo.roclim

float

Highest rate that the value for the device is allowed to change by before a ROC alarm occurs.

hilo.timeofchange

internaltime

Updates if new curval != old curval.

hilo.flattimeout

unsigned short

Flat line alm timeout value (min).

hilo.doitflat

oas_boolean_t

Enable flat line alarm checking.

hilo.inFlatState

oas_boolean_t

Currently in a flat line alarm state.

hilo.bracketstate

almBracketState

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

hilo.doitBracketNeg

oas_boolean_t

Enable a negative bracket alarm.

hilo.bracketLimitNeg

float

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

hilo.doitBracketPos

oas_boolean_t

Enable a positive bracket alarm.

hilo.bracketLimitPos

float

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

intg

integration

This field provides the integration block structure. Some of the fields in the structure are described below.

intg.doit

oas_boolean_t

Are integrations enabled?

intg.hour.current

double

Current hourly integration total.

intg.day.current

double

Current daily integration total.

intg.month.current

double

Current monthly integration total.

intg.shift.current

double

Current shift integration total.

intg.hour.previous

double

Previous hourly integration total.

intg.day.previous

double

Previous daily integration total.

intg.month.previous

double

Previous monthly integration total.

intg.shift.previous

double

Previous shift integration total.

intg.scale

float

Scale factor for integration.

intype

rateintype

Type of remote data input.

last

double

Last raw accumulator reading.

lastKrunchTime

internaltime

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

mappingFlag

unsigned Int

The 32-bit integer value used to map this point to a non-AVEVA Enterprise SCADA system.

maxalmpark

unsigned int

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

mf

double

Meter factor to apply to the accumulator value.

name

pntname

This field shows the unique name of this rate record. The name can be up to 15 characters in length.

nsmooth

bufferrange

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

onoffdelay

onoffdelaytype

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

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.

pointtype

pointtype_enum

Type of point

poltime

internaltime

Time of last processing

procdb

double

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

ptnum

unsiged char

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

rate_last

double

Last raw accumulator value for rate calculation.

rate_period

int

Minimum time in seconds required to calculate rate.

rate_time

internaltime

Time of last rate calculation.

repDeadband

float

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

repLastAccSent

double

Last replicated accumulator value

repLastRateSent

double

Last replicated rate value

rollover

double

Hardware accumulator roll over value.

rtu

remoteslot

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

runits

egutext

Rate units

scale

double

Scale factor to apply to the accumulator value.

shortDesc

stn_str32

A brief description of the record.

station

stationslot

The name of the associated station record.

subtype

ratesubtype

The rate subtype.

sw

oas_boolean_t

Is the software accumulator enabled?

When the software accumulator is enabled, accur represents a software accumulator that rolls over at one million, rather than representing the accumulator value at the remote.

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.

timestamp

internaltime

Time of last input data processing.

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.

water_cnstnt

float

The water scaling factor that converts the raw input value to the appropriate EGU value

wellunit

pntname

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