Reading status codes

Reading status codes describe reading errors, estimation results, and other conditions. IEE typically assigns these status codes automatically. However, not all estimation routines have a default reading status. Add or update reading statuses manually using the Editing and Estimation tools.

IEE contains two special reading statuses that denote intervals missing data: MISSING and EMPTY. The following discussion describes the effect of MISSING and EMPTY intervals on interval statistics such as Min and Max:

MISSING denotes an interval that IEE marked as missing from the collection system or from whatever source IEE imported the data. IEE saves this Missing interval to the operational database with whatever value (usually 0.0) that is specified in the import. Thus, the reading exists in the database, and its only special property is that one of its interval statuses is marked as MISSING.

EMPTY denotes a gap in the data. Whenever external sources (such as a web service call that requests interval data) or an internal component (such as graphing or validation) requests data from the reading API, IEE returns a stream of continuous intervals. In the case that there is a gap in the interval data (where no readings exist in the database for one or more time stamps), the API creates fake intervals as place-holders and marks them as EMPTY.

When computing statistics, such as max and min, which are shown on graphs, KVA reports, and the validation report:

IEE ignores intervals marked with an EMPTY status.
IEE does not ignore intervals marked with a MISSING status.
IEE calculations are based on the total number of reads available, not the total number of reads expected.

Termination conditions and exclude conditions are simply a context specific name for interval statuses. Any valid status can be used as a termination or exclude condition. Termination conditions signal when a request for data should terminate while exclude conditions signal when a specific channel’s data should be ignored.

For example, you can request data for the formula "A:1 + B:1" and instruct the UCE to terminate the request if there are any alarm statuses in channel B:1 by using a termination condition. Using ALARM as an exclude condition allows you to compute "A:1 + B:1" and exclude any intervals from channel B:1 with that status. The following lists show the interval statuses. Using the Name field of the Status object specifies the statuses.

Select one of the following links to view the corresponding status codes:

Reading Status Codes A - G

Table 28 Reading status codes A - G
ReadingStatusID	Label	Description
Added	ADD	Added Interval (Data Correction)
Aggregated	AGG	Aggregated Interval
Alarm	AL	Alarm
Backcast	BCA	Backcast Data
Backup1	BK1	From Backup Data Source 1
Backup2	BK2	From Backup Data Source 2
Backup3	BK3	From Backup Data Source 3
Backup4	BK4	From Backup Data Source 4
Backup5	BK5	From Backup Data Source 5
Backup6	BK6	From Backup Data Source 6
Backup7	BK7	From Backup Data Source 7
Backup8	BK8	From Backup Data Source 8
Backup9	BK9	From Backup Data Source 9
Battery	BAT	Battery Error
Chopped	CHP	Data Chopped for Conversion
Clock	CLK	The meter recorded this interval while a non-fatal clock error was occurring. Re-initialization may be necessary to correct this clock setting.
Configerror	CE	Configuration Error
CRC	CRC	Checksum Error. The data for this interval was not properly recorded by the meter.
Customer	CUS	Customer Issue (customer read, locked gate, not home, etc.)
Data	DAT	Data Issue (long interval, short interval, merged intervals, etc.)
Deleted	DLT	Deleted
Delta	DEL	Delta Overflow
Detect	DET	Photo Detect Error
Disconn	DIS	Battery Disconnected
DST	DST	The meter recorded this interval while in daylight saving time (DST).
Duplicate	DUP	Duplicate read
Edited	ED	Interval was Edited
Emitter	EMI	Photo Emitter Error
Empty	EMP	Empty; no data in the database for this interval
EmptyContributor	EC	At least one contributor had empty data
Energy	EN	Energy Type (Register Changed)
Equipment	EQ	Equipment issue (broken meter, wrong meter, etc.)
ESTBasicGap	BG	Basic Gap Estimation
ESTFailed	ESF	Estimation Failed
ESTHistorical	HIS	Historical Estimation
Estimated	EST	Estimated Interval (Data Correction)
ESTLinearINT	LIN	Linear Interpolation Estimation
ESTLoadProfile	LP	Load Profile Estimation
ESTLoadShape	ELS	Load Shaping Estimation
ESTNeeded	ESN	Estimation Needed
ESTUnscaled	EUS	Estimated intervals that have not been scaled to match register channel consumption
Excluded	EX	Excluded Data
Failed	FV	Failed Validation or Bad Read
Forecast	FCA	Forecast Data
FrontEnd	FE	Front End Error
Gap	GAP	Data that was identified as Missing or Empty is marked with the Gap status after it is estimated. This shows that the data was estimated because the original read was absent or marked as missing.

Reading Status Codes H - O

Table 29 Reading status codes H - O
ReadingStatusID	Label	Description
Harmonic	HA	Harmonic Distortion
HighLowLimit	HL	High/Low Usage Check Validation
IOBoard	IO	IO Board Error
Irregular	IRR	Irregular Interval (short or long)
ITolerance	ITO	Interval Tolerance
KVARHCheck	KVH	KVARH Check Validation
Leak	LK	Gas Leak
Limit	LI	Data Out of High/Low Limits
Load	LD	The meter closed this interval because of a received external IO signal.
Location	LOC	Premise Issue (cannot find premise, wrong route, bad address, etc.)
LowBatt	LB	Low Battery
Malfunction	MAL	Program Malfunction
ManAccepted	MA	Manually Accepted Validation
Measure	MES	Measurement Error
Memory	MEM	ROM/RAM Checksum Error / Memory Error / Self-Check Error
Missing	MI	Missing Data or Lapse in Data
Modem	MOD	Modem Error
NV	NV	Not Validated
OptionBoard	OB	Option Board Error
Other	OT	Other
Overload	OV	Overload Error. The meter's Load Profile pulse count for this interval overflowed the upper limit of allowed pulses, and the pulse-count per interval needs to be reduced.

Reading Status Codes P - Z

Table 30 Reading status codes P - Z
ReadingStatusID	Label	Description
Parity	PA	Parity Error
Passed	PV	Passed Validation, Accepted, or Good Read
PFLimit	PF	Power Factor Limit Validation
Phase	PH	Phase Loss Error
Potential	POT	Low Loss Potential
Power	PO	Meter experienced an outage to its power supply during this interval
PowerRestored	PR	Reading data restored from previous version
Primary	PRI	From Primary Data Source
Pulse	PU	Pulse Overflow
Replaced	RPL	Replaced Interval (Data Correction)
Reprog	REP	Meter Reprogrammed
ReservedFAM1	RS1	Reserved for Future Use
Reset	RE	Reset Occurred
Restored	RES	Restored
Rotation	ROG	Reverse Rotation Error
ScaledUsingTBU	SBU	Scaled using Total Billed Usage
Sedited	SED	Status Edited
Spike	SPI	Spike Tolerance Validation
SSync	SSE	Slave Synch Error
StartRead	STR	Start Register Reading
System	SYS	External System has Gotten Out of Synch
TAdjusted	TAD	The meter's clock was adjusted by time synchronization during this interval.
Tamper	TAM	Tampered Interval
TamperGeneral	TMF	Meter has been tampered with (tilt, line cut, meter thrown on lawn, and so on.)
Test	TE	The meter was in test mode during this interval.
Threat	THT	Animal or Human threat (dog, gun, alligator, and so on.)
Tilt	TLT	Tilt
TimeReset	TR	Time Reset Occurred
TotalBilledUsage	TBU	Total Billed Usage
TOU	TOU	TOU Error
TTolerance	TTO	Time Tolerance
UnProg	UP	Unprogrammed Error
UsageLimit	UL	Usage Limit Validation
UsageTol	UTO	Usage Tolerance Validation
UsrDefined1	UD1	User Defined 1
UsrDefined2	UD2	User Defined 2
UsrDefined3	UD3	User Defined 3
UsrDefined4	UD4	User Defined 4
UsrDefined5	UD5	User Defined 5
UsrDefined6	UD6	User Defined 6
UsrDefined7	UD7	User Defined 7
UsrDefined8	UD8	User Defined 8
UsrDefined9	UD9	User Defined 9
VEESet1FV	FV1	Validation Set 1, Failed
VEESet1MA	MA1	Validation Set 1, Manually Failed
VEESet1NV	NV1	Validation Set 1, Not Validated
VEESet1PV	PV1	Validation Set 1, Passed
VEESet1WV	WV1	Validation Set 1, Warning
VEESet2FV	FV2	Validation Set 2, Failed
VEESet2MA	MA2	Validation Set 2, Manually Failed
VEESet2NV	NV2	Validation Set 2, Not Validated
VEESet2PV	PV2	Validation Set 2, Passed
VEESet2WV	WV2	Validation Set 2, Warning
VEESet3FV	FV3	Validation Set 3, Failed
VEESet3MA	MA3	Validation Set 3, Manually Failed
VEESet3NV	NV3	Validation Set 3, Not Validated
VEESet3PV	PV3	Validation Set 3, Passed
VEESet3WV	WV3	Validation Set 3, Warning
Warning	WV	Warning in Validation
WatchDog	WD	Watchdog Time-out/error